amine@32: auditok, an AUDIo TOKenization tool
amine@32: ===================================
amine@23: 
amine@32: .. image:: https://travis-ci.org/amsehili/auditok.svg?branch=master
amine@32:     :target: https://travis-ci.org/amsehili/auditok
amine@37:     
amine@37: .. image:: https://readthedocs.org/projects/auditok/badge/?version=latest
amine@38:     :target: http://auditok.readthedocs.org/en/latest/?badge=latest
amine@38:     :alt: Documentation Status
amine@32: 
amine@53: `auditok` is an **Audio Activity Detection** tool that can process online data (read from an audio device or from standard input) as well as audio files. It can be used as a command line program and offers an easy to use API.
amine@32: 
amine@35: The latest version of this documentation can be found at `Readthedocs <http://auditok.readthedocs.org/en/latest/>`_.
amine@32: 
amine@32: Requirements
amine@32: ------------
amine@32: 
amine@32: `auditok` can be used with standard Python!
amine@32: 
amine@39: However, if you want more features, the following packages are needed:
amine@32: 
amine@50: - `Pydub <https://github.com/jiaaro/pydub>`_ : read audio files in popular audio formats (ogg, mp3, etc.) or extract audio from a video file.
amine@32: 
amine@50: - `PyAudio <http://people.csail.mit.edu/hubert/pyaudio/>`_ : read audio data from the microphone and play back detections.
amine@32: 
amine@50: - `matplotlib <http://matplotlib.org/>`_ : plot audio signal and detections (see figures above).
amine@32: 
amine@50: - `numpy <http://www.numpy.org>`_ : required by matplotlib. Also used for math operations instead of standard python if available.
amine@32: 
amine@53: - Optionally, you can use `sox` or `[p]arecord` for data acquisition and feed `auditok` using a pipe.
amine@32: 
amine@32: Installation
amine@32: ------------
amine@32: 
amine@53: Install with pip:
amine@53: 
amine@32: .. code:: bash
amine@32: 
amine@50:     sudo pip install auditok
amine@50: 
amine@50: or install the latest version on Github:
amine@50: 
amine@50: .. code:: bash
amine@50: 
amine@32:     git clone https://github.com/amsehili/auditok.git
amine@32:     cd auditok
amine@32:     sudo python setup.py install
amine@32: 
amine@32: Getting started
amine@32: ---------------
amine@32: 
amine@23: .. toctree::
amine@23:     :titlesonly:
amine@35:     :maxdepth: 2
amine@23: 
amine@32:        Command-line Usage Guide <cmdline.rst>
amine@32:        API Tutorial <apitutorial.rst>
amine@23: 
amine@35: API Reference
amine@35: -------------
amine@35: 
amine@35: .. toctree::
amine@35:     :maxdepth: 3
amine@35: 
amine@35:        auditok.core <core.rst>
amine@35:        auditok.util <util.rst>
amine@35:        auditok.io <io.rst>
amine@35:        auditok.dataset <dataset.rst>
amine@23: 
amine@23: Indices and tables
amine@23: ==================
amine@23: * :ref:`genindex`
amine@23: * :ref:`modindex`
amine@23: * :ref:`search`