Mercurial > hg > auditok

annotate README.md @ 3:364eeb8e8bd2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
README.md, typos fixes
author Amine Sehili <amine.sehili@gmail.com>
date Tue, 22 Sep 2015 10:49:57 +0200
parents edee860b9f61
children 31c97510b16b
rev   line source
amine@2 1 AUDIo TOKenizer
amine@2 2 ===============
amine@2 3
amine@2 4 `auditok` is an Audio Activity Detection library that wan be used with online data (i.e. microphone) or with audio files.
amine@2 5
amine@2 6 Requirements
amine@2 7 ------------
amine@2 8 `auditok` uses [PyAudio](http://people.csail.mit.edu/hubert/pyaudio/) for audio acquisition and playback.
amine@2 9 If installed, numpy will be privileged for math operations on vectors.
amine@2 10
amine@2 11 Installation
amine@2 12 ------------
amine@2 13 pip install auditok
amine@2 14
amine@2 15 Demos
amine@2 16 -----
amine@2 17 This code reads data from the microphone and plays back whatever it detects.
amine@3 18
amine@2 19 python demos/echo.py
amine@2 20
amine@2 21 `echo.py` accepts two arguments: energy threshold (default=45) and duration in seconds (default=10):
amine@2 22
amine@2 23 python demos/echo.py 50 15
amine@2 24
amine@2 25 If only one argument is given it will be used for energy. Other demos are in /demos.
amine@2 26
amine@2 27 Documentation
amine@2 28 -------------
amine@2 29
amine@2 30 Check out a quick start and the API documentation [here](http://amsehili.github.io/auditok/pdoc/)
amine@2 31
amine@2 32 Contribution
amine@2 33 ------------
amine@2 34 Contributions are very appreciated !
amine@2 35
amine@2 36 License
amine@2 37 -------
amine@2 38 `auditok` is published under the GNU General Public License Version 3.
amine@2 39
amine@2 40 Author
amine@2 41 ------
amine@2 42 Amine Sehili (<amine.sehili@gmail.com>)
amine@2 43