Changeset a96413e for doc/index.rst


Ignore:
Timestamp:
Aug 27, 2016, 12:42:32 AM (3 years ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master, pitchshift, sampler, timestretch, yinfft+
Children:
e523483
Parents:
d44763f
Message:

doc/index.rst: clean up and add some external links

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/index.rst

    rd44763f ra96413e  
    1010performing pitch detection, tapping the beat and producing midi streams from
    1111live audio.
     12
     13Features
     14========
    1215
    1316aubio provide several algorithms and routines, including:
     
    2831found in the results.
    2932
    30 Python module
    31 -------------
    32 
    33 A python module to access the library functions is also provided. Please see
    34 the file ``python/README`` for more information on how to use it.
    35 
    36 Examples tools
    37 --------------
    38 
    39 A few simple command line tools are included along with the library:
    40 
    41  - ``aubioonset`` outputs the time stamp of detected note onsets
    42  - ``aubiopitch`` attempts to identify a fundamental frequency, or pitch, for
    43    each frame of the input sound
    44  - ``aubiomfcc`` computes Mel-frequency Cepstrum Coefficients
    45  - ``aubiotrack`` outputs the time stamp of detected beats
    46  - ``aubionotes`` emits midi-like notes, with an onset, a pitch, and a duration
    47  - ``aubioquiet`` extracts quiet and loud regions
    48 
    49 Additionally, the python module comes with the following script:
    50 
    51  - ``aubiocut`` slices sound files at onset or beat timestamps
    52 
    53 C API basics
    54 ------------
    55 
    56 The library is written in C and is optimised for speed and portability.
    57 
    58 The C API is designed in the following way:
    59 
    60 .. code-block:: c
    61 
    62     aubio_something_t * new_aubio_something(void * args);
    63     audio_something_do(aubio_something_t * t, void * args);
    64     smpl_t aubio_something_get_a_parameter(aubio_something_t * t);
    65     uint_t aubio_something_set_a_parameter(aubio_something_t * t, smpl_t a_parameter);
    66     void del_aubio_something(aubio_something_t * t);
    67 
    68 For performance and real-time operation, no memory allocation or freeing take
    69 place in the ``_do`` methods. Instead, memory allocation should always take place
    70 in the ``new_`` methods, whereas free operations are done in the ``del_`` methods.
    71 
    72 .. code-block:: bash
    73 
    74     ./waf configure
    75     ./waf build
    76     sudo ./waf install
    77 
    78 aubio compiles on Linux, Mac OS X, Cygwin, and iPhone.
    79 
    80 Documentation
    81 -------------
    82 
    83 - Manual pages: http://aubio.org/documentation
    84 - API documentation: http://aubio.org/doc/latest/
    85 
    86 Contribute
    87 ----------
    88 
    89 - Issue Tracker: https://github.com/piem/aubio/issues
    90 - Source Code: https://github.com/piem/aubio
    91 
    92 Contact info
    93 ------------
    94 
    95 The home page of this project can be found at: http://aubio.org/
    96 
    97 Questions, comments, suggestions, and contributions are welcome. Use the
    98 mailing list: <aubio-user@aubio.org>.
    99 
    100 To subscribe to the list, use the mailman form:
    101 http://lists.aubio.org/listinfo/aubio-user/
    102 
    103 Alternatively, feel free to contact directly the author.
    104 
    105 
    106 Contents
    107 --------
     33Content
     34=======
    10835
    10936.. toctree::
    11037   :maxdepth: 2
    11138
    112    download
    11339   installing
     40   cli
    11441   python_module
     42
     43Project pages
     44=============
     45
     46* `Project homepage`_: https://aubio.org
     47* `aubio on github`_: https://github.com/aubio/aubio
     48* `aubio on pypi`_: https://pypi.python.org/pypi/aubio
     49* `API documentation`_: https://aubio.org/doc/latest/
     50* `Mailing lists`_: https://lists.aubio.org
     51
     52.. _Project homepage: https://aubio.org
     53.. _aubio on github: https://github.com/aubio/aubio
     54.. _aubio on pypi: https://pypi.python.org/pypi/aubio
     55.. _api documentation: https://aubio.org/doc/latest/
     56.. _Mailing lists: https://lists.aubio.org/
     57
     58Current status
     59==============
     60
     61.. image:: https://travis-ci.org/aubio/aubio.svg?branch=master
     62   :target: https://travis-ci.org/aubio/aubio
     63   :alt: Travis build status
     64
     65.. image:: https://ci.appveyor.com/api/projects/status/f3lhy3a57rkgn5yi?svg=true
     66   :target: https://ci.appveyor.com/project/piem/aubio/
     67   :alt: Appveyor build status
     68
     69.. image:: https://landscape.io/github/aubio/aubio/master/landscape.svg?style=flat
     70   :target: https://landscape.io/github/aubio/aubio/master
     71   :alt: Landscape code health
     72
     73.. image:: http://readthedocs.org/projects/aubio/badge/?version=latest
     74   :target: http://aubio.readthedocs.io/en/latest/?badge=latest
     75   :alt: Documentation status
     76
     77* `Travis Continuous integration page <https://travis-ci.org/aubio/aubio>`_
     78* `Appveyor Continuous integration page <https://ci.appveyor.com/project/piem/aubio>`_
     79* `ReadTheDocs documentation <http://aubio.readthedocs.io/en/latest/>`_
     80
     81Copyright and License
     82=====================
     83
     84Copyright © 2003-2016 Paul Brossier <piem@aubio.org>
     85
     86aubio is a `free <http://www.debian.org/intro/free>`_ and `open source
     87<http://www.opensource.org/docs/definition.php>`_ software; **you** can
     88redistribute it and/or modify it under the terms of the `GNU
     89<http://www.gnu.org/>`_ `General Public License
     90<https://www.gnu.org/licenses/gpl.html>`_ as published by the `Free Software
     91Foundation <https://fsf.org>`_, either version 3 of the License, or (at your
     92option) any later version.
     93
     94.. Note:: aubio is not MIT or BSD licensed. Contact the author if you need it
     95  in your commercial product.
Note: See TracChangeset for help on using the changeset viewer.