|
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@32
|
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@32
|
22 - `Pydub <https://github.com/jiaaro/pydub>`_ : read audio files of popular audio formats (ogg, mp3, etc.) or extract audio from a video file
|
|
amine@32
|
23
|
|
amine@32
|
24 - `PyAudio <http://people.csail.mit.edu/hubert/pyaudio/>`_ : read audio data from the microphone and play back detections
|
|
amine@32
|
25
|
|
amine@32
|
26 - `matplotlib <http://matplotlib.org/>`_ : plot audio signal and detections (see figures above)
|
|
amine@32
|
27
|
|
amine@32
|
28 - `numpy <http://www.numpy.org>`_ : required by matplotlib. Also used for math operations instead of standard python if available
|
|
amine@32
|
29
|
|
amine@32
|
30 - Optionally, you can use **sox** or **parecord** for data acquisition and feed **auditok** using a pipe.
|
|
amine@32
|
31
|
|
amine@32
|
32 Installation
|
|
amine@32
|
33 ------------
|
|
amine@32
|
34
|
|
amine@32
|
35 .. code:: bash
|
|
amine@32
|
36
|
|
amine@32
|
37 git clone https://github.com/amsehili/auditok.git
|
|
amine@32
|
38 cd auditok
|
|
amine@32
|
39 sudo python setup.py install
|
|
amine@32
|
40
|
|
amine@32
|
41
|
|
amine@35
|
42
|
|
amine@32
|
43 Getting started
|
|
amine@32
|
44 ---------------
|
|
amine@32
|
45
|
|
amine@23
|
46 .. toctree::
|
|
amine@23
|
47 :titlesonly:
|
|
amine@35
|
48 :maxdepth: 2
|
|
amine@23
|
49
|
|
amine@32
|
50 Command-line Usage Guide <cmdline.rst>
|
|
amine@32
|
51 API Tutorial <apitutorial.rst>
|
|
amine@23
|
52
|
|
amine@23
|
53
|
|
amine@35
|
54 API Reference
|
|
amine@35
|
55 -------------
|
|
amine@35
|
56
|
|
amine@35
|
57 .. toctree::
|
|
amine@35
|
58 :maxdepth: 3
|
|
amine@35
|
59
|
|
amine@35
|
60 auditok.core <core.rst>
|
|
amine@35
|
61 auditok.util <util.rst>
|
|
amine@35
|
62 auditok.io <io.rst>
|
|
amine@35
|
63 auditok.dataset <dataset.rst>
|
|
amine@23
|
64
|
|
amine@23
|
65
|
|
amine@23
|
66 Indices and tables
|
|
amine@23
|
67 ==================
|
|
amine@23
|
68 * :ref:`genindex`
|
|
amine@23
|
69 * :ref:`modindex`
|
|
amine@23
|
70 * :ref:`search`
|
|
amine@23
|
71
|
|
amine@23
|
72
|
|
amine@23
|
73
|
