Changeset 155cc10 for doc/index.rst


Ignore:
Timestamp:
Mar 10, 2017, 2:26:32 PM (7 years ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, sampler
Children:
ee8a57c
Parents:
00d0275 (diff), 67b6618 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.
Message:

Merge branch 'master' into awhitening

File:
1 edited

Legend:

Unmodified
Added
Removed

  • doc/index.rst

    r00d0275 r155cc10  
    1 aubio documentation
    2 ===================
     1Welcome
     2=======
    33
    4 aubio is a collection of algorithms and tools to label music and sounds. It
    5 listens to audio signals and attempts to detect events. For instance, when a
    6 drum is hit, at which frequency is a note, or at what tempo is a rhythmic
    7 melody.
     4aubio is a collection of algorithms and tools to label and transform music and
     5sounds. It scans or `listens` to audio signals and attempts to detect musical
     6events. For instance, when a drum is hit, at which frequency is a note, or at
     7what tempo is a rhythmic melody.
    88
    9 Its features include segmenting a sound file before each of its attacks,
     9aubio features include segmenting a sound file before each of its attacks,
    1010performing pitch detection, tapping the beat and producing midi streams from
    1111live audio.
    1212
    13 aubio provide several algorithms and routines, including:
     13Quick links
     14===========
     15
     16* :ref:`python`
     17* :ref:`manpages`
     18* :ref:`develop`
     19* :ref:`building`
     20
     21.. only:: devel
     22
     23    .. include:: statuslinks.rst
     24
     25Project pages
     26=============
     27
     28* `Project homepage`_: https://aubio.org
     29* `aubio on github`_: https://github.com/aubio/aubio
     30* `aubio on pypi`_: https://pypi.python.org/pypi/aubio
     31* `Doxygen documentation`_: https://aubio.org/doc/latest/
     32* `Mailing lists`_: https://lists.aubio.org
     33
     34.. _Project homepage: https://aubio.org
     35.. _aubio on github: https://github.com/aubio/aubio
     36.. _aubio on pypi: https://pypi.python.org/pypi/aubio
     37.. _Doxygen documentation: https://aubio.org/doc/latest/
     38.. _Mailing lists: https://lists.aubio.org/
     39
     40* `Travis Continuous integration page <https://travis-ci.org/aubio/aubio>`_
     41* `Appveyor Continuous integration page <https://ci.appveyor.com/project/piem/aubio>`_
     42* `Landscape python code validation <https://landscape.io/github/aubio/aubio/master>`_
     43* `ReadTheDocs documentation <https://aubio.readthedocs.io/en/latest/>`_
     44
     45Features
     46========
     47
     48aubio provides several algorithms and routines, including:
    1449
    1550- several onset detection methods
    … …  
    2257- spectral filtering
    2358- transient/steady-state separation
    24 - sound file and audio devices read and write access
     59- sound file read and write access
    2560- various mathematics utilities for music applications
    2661
    … …  
    2863found in the results.
    2964
    30 Python module
    31 -------------
     65Copyright
     66=========
    3267
    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.
     68Copyright © 2003-2016 Paul Brossier <piem@aubio.org>
    3569
    36 Examples tools
    37 --------------
     70License
     71=======
    3872
    39 A few simple command line tools are included along with the library:
     73aubio is a `free <http://www.debian.org/intro/free>`_ and `open source
     74<http://www.opensource.org/docs/definition.php>`_ software; **you** can
     75redistribute it and/or modify it under the terms of the `GNU
     76<https://www.gnu.org/>`_ `General Public License
     77<https://www.gnu.org/licenses/gpl.html>`_ as published by the `Free Software
     78Foundation <https://fsf.org>`_, either version 3 of the License, or (at your
     79option) any later version.
    4080
    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
     81.. note::
    4882
    49 Additionally, the python module comes with the following script:
     83   aubio is not MIT or BSD licensed. Contact the author if you need it in your
     84   commercial product.
    5085
    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 --------
     86Content
     87=======
    10888
    10989.. toctree::
    110    :maxdepth: 1
     90   :maxdepth: 2
    11191
    11292   installing
    11393   python_module
     94   cli
     95   develop
Note: See TracChangeset for help on using the changeset viewer.