Changeset ac4a6b8


Ignore:
Timestamp:
Jan 4, 2014, 12:14:00 AM (11 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, pitchshift, sampler, timestretch, yinfft+
Children:
6d509c3
Parents:
8e21476
Message:

README.md: improve

File:
1 edited

Legend:

Unmodified
Added
Removed

  • README.md

    r8e21476 rac4a6b8  
    2727found in the results.
    2828
     29Python module
     30-------------
     31
     32A python module to access the library functions is also provided. Please see
     33the file `python/README` for more information on how to use it.
     34
     35Examples tools
     36--------------
     37
     38A few simple command line tools are included along with the library:
     39
     40 - `aubioonset` outputs the time stamp of detected note onsets
     41 - `aubiopitch` attempts to identify a fundamental frequency, or pitch, for
     42   each frame of the input sound
     43 - `aubiomfcc` computes Mel-frequency Cepstrum Coefficients
     44 - `aubiotrack` outputs the time stamp of detected beats
     45 - `aubionotes` emits midi-like notes, with an onset, a pitch, and a duration
     46 - `aubioquiet` extracts quiet and loud regions
     47
     48Additionaly, the python module comes with the following script:
     49
     50 - `aubiocut` slices sound files at onset or beat timestamps
    2951
    3052Implementation and Design Basics
    3153--------------------------------
    3254
    33 The library is written in C and is optimised for speed and portability. A
    34 python module to access the library functions is also provided. A few simple
    35 applications are included along with the library:
    36 
    37  - `aubioonset` outputs the time stamp of detected note onsets
    38  - `aubiotempo` does the same for the tempo
    39  - `aubionotes` emits midi-like notes, with an onset, a pitch, and a duration
    40  - `aubiocut` slices an input sound and cuts it in several smaller files, sliced
    41    at each detected onset or beat
    42  - `aubiopitch` attempts to identify a fundamental frequency, or pitch, for each
    43    frame of the input sound
     55The library is written in C and is optimised for speed and portability.
    4456
    4557The C API is designed in the following way:
    … …  
    5567in the `new_` methods, whereas free operations are done in the `del_` methods.
    5668
     69The latest version of the documentation can be found at:
     70
     71  http://aubio.org/documentation
    5772
    5873Installation and Build Instructions
    … …  
    7186
    7287aubio compiles on Linux, Mac OS X, Cygwin, and iPhone.
    73 
    7488
    7589Credits and Publications
Note: See TracChangeset for help on using the changeset viewer.