From: Paul Brossier Date: Fri, 26 Aug 2016 22:42:32 +0000 (+0200) Subject: doc/index.rst: clean up and add some external links X-Git-Tag: 0.4.4~243 X-Git-Url: https://git.aubio.org/?a=commitdiff_plain;h=a96413e4208b35ccffe2a6fa4e2147beb4154f4e;p=aubio.git doc/index.rst: clean up and add some external links --- diff --git a/doc/index.rst b/doc/index.rst index 709f329e..a1cdbef5 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -10,6 +10,9 @@ aubio features include segmenting a sound file before each of its attacks, performing pitch detection, tapping the beat and producing midi streams from live audio. +Features +======== + aubio provide several algorithms and routines, including: - several onset detection methods @@ -27,88 +30,66 @@ aubio provide several algorithms and routines, including: The name aubio comes from *audio* with a typo: some errors are likely to be found in the results. -Python module -------------- - -A python module to access the library functions is also provided. Please see -the file ``python/README`` for more information on how to use it. - -Examples tools --------------- - -A few simple command line tools are included along with the library: - - - ``aubioonset`` outputs the time stamp of detected note onsets - - ``aubiopitch`` attempts to identify a fundamental frequency, or pitch, for - each frame of the input sound - - ``aubiomfcc`` computes Mel-frequency Cepstrum Coefficients - - ``aubiotrack`` outputs the time stamp of detected beats - - ``aubionotes`` emits midi-like notes, with an onset, a pitch, and a duration - - ``aubioquiet`` extracts quiet and loud regions - -Additionally, the python module comes with the following script: - - - ``aubiocut`` slices sound files at onset or beat timestamps - -C API basics ------------- - -The library is written in C and is optimised for speed and portability. - -The C API is designed in the following way: - -.. code-block:: c - - aubio_something_t * new_aubio_something(void * args); - audio_something_do(aubio_something_t * t, void * args); - smpl_t aubio_something_get_a_parameter(aubio_something_t * t); - uint_t aubio_something_set_a_parameter(aubio_something_t * t, smpl_t a_parameter); - void del_aubio_something(aubio_something_t * t); - -For performance and real-time operation, no memory allocation or freeing take -place in the ``_do`` methods. Instead, memory allocation should always take place -in the ``new_`` methods, whereas free operations are done in the ``del_`` methods. - -.. code-block:: bash +Content +======= - ./waf configure - ./waf build - sudo ./waf install +.. toctree:: + :maxdepth: 2 -aubio compiles on Linux, Mac OS X, Cygwin, and iPhone. + installing + cli + python_module -Documentation -------------- +Project pages +============= -- Manual pages: http://aubio.org/documentation -- API documentation: http://aubio.org/doc/latest/ +* `Project homepage`_: https://aubio.org +* `aubio on github`_: https://github.com/aubio/aubio +* `aubio on pypi`_: https://pypi.python.org/pypi/aubio +* `API documentation`_: https://aubio.org/doc/latest/ +* `Mailing lists`_: https://lists.aubio.org -Contribute ----------- +.. _Project homepage: https://aubio.org +.. _aubio on github: https://github.com/aubio/aubio +.. _aubio on pypi: https://pypi.python.org/pypi/aubio +.. _api documentation: https://aubio.org/doc/latest/ +.. _Mailing lists: https://lists.aubio.org/ -- Issue Tracker: https://github.com/piem/aubio/issues -- Source Code: https://github.com/piem/aubio +Current status +============== -Contact info ------------- +.. image:: https://travis-ci.org/aubio/aubio.svg?branch=master + :target: https://travis-ci.org/aubio/aubio + :alt: Travis build status -The home page of this project can be found at: http://aubio.org/ +.. image:: https://ci.appveyor.com/api/projects/status/f3lhy3a57rkgn5yi?svg=true + :target: https://ci.appveyor.com/project/piem/aubio/ + :alt: Appveyor build status -Questions, comments, suggestions, and contributions are welcome. Use the -mailing list: . +.. image:: https://landscape.io/github/aubio/aubio/master/landscape.svg?style=flat + :target: https://landscape.io/github/aubio/aubio/master + :alt: Landscape code health -To subscribe to the list, use the mailman form: -http://lists.aubio.org/listinfo/aubio-user/ +.. image:: http://readthedocs.org/projects/aubio/badge/?version=latest + :target: http://aubio.readthedocs.io/en/latest/?badge=latest + :alt: Documentation status -Alternatively, feel free to contact directly the author. +* `Travis Continuous integration page `_ +* `Appveyor Continuous integration page `_ +* `ReadTheDocs documentation `_ +Copyright and License +===================== -Contents --------- +Copyright © 2003-2016 Paul Brossier -.. toctree:: - :maxdepth: 2 +aubio is a `free `_ and `open source +`_ software; **you** can +redistribute it and/or modify it under the terms of the `GNU +`_ `General Public License +`_ as published by the `Free Software +Foundation `_, either version 3 of the License, or (at your +option) any later version. - download - installing - python_module +.. Note:: aubio is not MIT or BSD licensed. Contact the author if you need it + in your commercial product.