|
amine@32
|
1 auditok, an AUDIo TOKenization tool
|
|
amine@32
|
2 ===================================
|
|
amine@23
|
3
|
|
amine@32
|
4 .. image:: https://travis-ci.org/amsehili/auditok.svg?branch=master
|
|
amine@32
|
5 :target: https://travis-ci.org/amsehili/auditok
|
|
amine@37
|
6
|
|
amine@37
|
7 .. image:: https://readthedocs.org/projects/auditok/badge/?version=latest
|
|
amine@38
|
8 :target: http://auditok.readthedocs.org/en/latest/?badge=latest
|
|
amine@38
|
9 :alt: Documentation Status
|
|
amine@32
|
10
|
|
amine@53
|
11 `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
|
12
|
|
amine@35
|
13 The latest version of this documentation can be found at `Readthedocs <http://auditok.readthedocs.org/en/latest/>`_.
|
|
amine@32
|
14
|
|
amine@32
|
15 Requirements
|
|
amine@32
|
16 ------------
|
|
amine@32
|
17
|
|
amine@32
|
18 `auditok` can be used with standard Python!
|
|
amine@32
|
19
|
|
amine@39
|
20 However, if you want more features, the following packages are needed:
|
|
amine@32
|
21
|
|
amine@50
|
22 - `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
|
23
|
|
amine@50
|
24 - `PyAudio <http://people.csail.mit.edu/hubert/pyaudio/>`_ : read audio data from the microphone and play back detections.
|
|
amine@32
|
25
|
|
amine@50
|
26 - `matplotlib <http://matplotlib.org/>`_ : plot audio signal and detections (see figures above).
|
|
amine@32
|
27
|
|
amine@50
|
28 - `numpy <http://www.numpy.org>`_ : required by matplotlib. Also used for math operations instead of standard python if available.
|
|
amine@32
|
29
|
|
amine@53
|
30 - Optionally, you can use `sox` or `[p]arecord` for data acquisition and feed `auditok` using a pipe.
|
|
amine@32
|
31
|
|
amine@32
|
32 Installation
|
|
amine@32
|
33 ------------
|
|
amine@32
|
34
|
|
amine@53
|
35 Install with pip:
|
|
amine@53
|
36
|
|
amine@32
|
37 .. code:: bash
|
|
amine@32
|
38
|
|
amine@50
|
39 sudo pip install auditok
|
|
amine@50
|
40
|
|
amine@50
|
41 or install the latest version on Github:
|
|
amine@50
|
42
|
|
amine@50
|
43 .. code:: bash
|
|
amine@50
|
44
|
|
amine@32
|
45 git clone https://github.com/amsehili/auditok.git
|
|
amine@32
|
46 cd auditok
|
|
amine@32
|
47 sudo python setup.py install
|
|
amine@32
|
48
|
|
amine@32
|
49 Getting started
|
|
amine@32
|
50 ---------------
|
|
amine@32
|
51
|
|
amine@23
|
52 .. toctree::
|
|
amine@23
|
53 :titlesonly:
|
|
amine@35
|
54 :maxdepth: 2
|
|
amine@23
|
55
|
|
amine@32
|
56 Command-line Usage Guide <cmdline.rst>
|
|
amine@32
|
57 API Tutorial <apitutorial.rst>
|
|
amine@23
|
58
|
|
amine@35
|
59 API Reference
|
|
amine@35
|
60 -------------
|
|
amine@35
|
61
|
|
amine@35
|
62 .. toctree::
|
|
amine@35
|
63 :maxdepth: 3
|
|
amine@35
|
64
|
|
amine@35
|
65 auditok.core <core.rst>
|
|
amine@35
|
66 auditok.util <util.rst>
|
|
amine@35
|
67 auditok.io <io.rst>
|
|
amine@35
|
68 auditok.dataset <dataset.rst>
|
|
amine@23
|
69
|
|
amine@23
|
70 Indices and tables
|
|
amine@23
|
71 ==================
|
|
amine@23
|
72 * :ref:`genindex`
|
|
amine@23
|
73 * :ref:`modindex`
|
|
amine@23
|
74 * :ref:`search`
|
