Changeset 633400d for README.md


Ignore:
Timestamp:
Dec 5, 2018, 10:34:39 PM (5 years ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/cnn, feature/crepe, feature/pitchshift, feature/timestretch, fix/ffmpeg5, master
Children:
283a619a
Parents:
5b46bc3 (diff), f19db54 (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 feature/pitchshift

File:
1 edited

Legend:

Unmodified
Added
Removed

  • README.md

    r5b46bc3 r633400d  
    1 aubio library
    2 =============
     1aubio
     2=====
     3
     4[![Travis build status](https://travis-ci.org/aubio/aubio.svg?branch=master)](https://travis-ci.org/aubio/aubio "Travis build status")
     5[![Appveyor build status](https://img.shields.io/appveyor/ci/piem/aubio/master.svg)](https://ci.appveyor.com/project/piem/aubio "Appveyor build status")
     6[![Landscape code health](https://landscape.io/github/aubio/aubio/master/landscape.svg?style=flat)](https://landscape.io/github/aubio/aubio/master "Landscape code health")
     7[![Commits since last release](https://img.shields.io/github/commits-since/aubio/aubio/latest.svg)](https://github.com/aubio/aubio "Commits since last release")
     8
     9[![Documentation](https://readthedocs.org/projects/aubio/badge/?version=latest)](http://aubio.readthedocs.io/en/latest/?badge=latest "Latest documentation")
     10[![DOI](https://zenodo.org/badge/396389.svg)](https://zenodo.org/badge/latestdoi/396389)
    311
    412aubio is a library to label music and sounds. It listens to audio signals and
    … …  
    2129  - spectral filtering
    2230  - transient/steady-state separation
    23   - sound file and audio devices read and write access
     31  - sound file read and write access
    2432  - various mathematics utilities for music applications
    2533
    … …  
    3038-------------
    3139
    32 A python module to access the library functions is also provided. Please see
    33 the file [`python/README.md`](python/README.md) for more information on how to
    34 use it.
     40A python module for aubio is provided. For more information on how to use it,
     41please see the file [`python/README.md`](python/README.md) and the
     42[manual](https://aubio.org/manual/latest/) .
    3543
    36 Examples tools
    37 --------------
     44Tools
     45-----
    3846
    39 A few simple command line tools are included along with the library:
     47The python module comes with the following command line tools:
     48
     49 - `aubio` extracts informations from sound files
     50 - `aubiocut` slices sound files at onset or beat timestamps
     51
     52Additional command line tools are included along with the library:
    4053
    4154 - `aubioonset` outputs the time stamp of detected note onsets
    … …  
    4760 - `aubioquiet` extracts quiet and loud regions
    4861
    49 Additionally, the python module comes with the following script:
     62Documentation
     63-------------
    5064
    51  - `aubiocut` slices sound files at onset or beat timestamps
    52 
    53 Implementation and Design 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     aubio_something_t * new_aubio_something (void * args);
    61     audio_something_do (aubio_something_t * t, void * args);
    62     smpl_t aubio_something_get_a_parameter (aubio_something_t *t);
    63     uint_t aubio_something_set_a_parameter (aubio_something_t *t, smpl_t a_parameter);
    64     void del_aubio_something (aubio_something_t * t);
    65 
    66 For performance and real-time operation, no memory allocation or freeing take
    67 place in the `_do` methods. Instead, memory allocation should always take place
    68 in the `new_` methods, whereas free operations are done in the `del_` methods.
     65  - [manual](https://aubio.org/manual/latest/), generated with sphinx
     66  - [developer documentation](https://aubio.org/doc/latest/), generated with Doxygen
    6967
    7068The latest version of the documentation can be found at:
    … …  
    7573------------------
    7674
    77 A number of distributions already include aubio. Check your favorite package
    78 management system, or have a look at the [download
    79 page](https://aubio.org/download).
     75aubio compiles on Linux, Mac OS X, Windows, Cygwin, and iOS.
    8076
    81 aubio uses [waf](https://waf.io/) to configure, compile, and test the source:
     77To compile aubio, you should be able to simply run:
    8278
    83     ./waf configure
    84     ./waf build
     79    make
    8580
    86 If waf is not found in the directory, you can download and install it with:
     81To compile the python module:
    8782
    88     make getwaf
     83    ./setup.py build
    8984
    90 aubio compiles on Linux, Mac OS X, Cygwin, and iOS.
     85See the [manual](https://aubio.org/manual/latest/) for more information about
     86[installing aubio](https://aubio.org/manual/latest/installing.html).
    9187
    92 Installation
    93 ------------
     88Citation
     89--------
    9490
    95 To install aubio library and headers on your system, use:
     91Please use the DOI link above to cite this release in your publications. For
     92more information, see also the [about
     93page](https://aubio.org/manual/latest/about.html) in [aubio
     94manual](https://aubio.org/manual/latest/).
    9695
    97     sudo ./waf install
    98 
    99 To uninstall:
    100 
    101     sudo ./waf uninstall
    102 
    103 If you don't have root access to install libaubio on your system, you can use
    104 libaubio without installing libaubio either by setting `LD_LIBRARY_PATH`, or by
    105 copying it to `~/lib`.
    106 
    107 On Linux, you should be able to set `LD_LIBRARY_PATH` with:
    108 
    109     $ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$PWD/build/src
    110 
    111 On Mac OS X, a copy or a symlink can be made in `~/lib`:
    112 
    113     $ mkdir -p ~/lib
    114     $ ln -sf $PWD/build/src/libaubio*.dylib ~/lib/
    115 
    116 Note on Mac OS X systems older than El Capitan (10.11), the `DYLD_LIBRARY_PATH`
    117 variable can be set as follows:
    118 
    119     $ export DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:$PWD/build/src
    120 
    121 Credits and Publications
    122 ------------------------
    123 
    124 This library gathers music signal processing algorithms designed at the Centre
    125 for Digital Music and elsewhere. This software project was developed along the
    126 research I did at the Centre for Digital Music, Queen Mary, University of
    127 London. Most of this C code was written by myself, starting from published
    128 papers and existing code. The header files of each algorithm contains brief
    129 descriptions and references to the corresponding papers.
    130 
    131 Special thanks go Juan Pablo Bello, Chris Duxbury, Samer Abdallah, Alain de
    132 Cheveigne for their help and publications. Also many thanks to Miguel Ramirez
    133 and Nicolas Wack for their bug fixing.
    134 
    135 Substantial informations about the algorithms and their evaluation are gathered
    136 in:
    137 
    138   - Paul Brossier, _[Automatic annotation of musical audio for interactive
    139     systems](https://aubio.org/phd)_, PhD thesis, Centre for Digital music,
    140 Queen Mary University of London, London, UK, 2006.
    141 
    142 Additional results obtained with this software were discussed in the following
    143 papers:
    144 
    145   - P. M. Brossier and J. P. Bello and M. D. Plumbley, [Real-time temporal
    146     segmentation of note objects in music signals](https://aubio.org/articles/brossier04fastnotes.pdf),
    147 in _Proceedings of the International Computer Music Conference_, 2004, Miami,
    148 Florida, ICMA
    149 
    150   -  P. M. Brossier and J. P. Bello and M. D. Plumbley, [Fast labelling of note
    151      objects in music signals] (https://aubio.org/articles/brossier04fastnotes.pdf),
    152 in _Proceedings of the International Symposium on Music Information Retrieval_,
    153 2004, Barcelona, Spain
    154 
    155 
    156 Contact Info and Mailing List
    157 -----------------------------
     96Homepage
     97--------
    15898
    15999The home page of this project can be found at: https://aubio.org/
    160100
    161 Questions, comments, suggestions, and contributions are welcome. Use the
    162 mailing list: <aubio-user@aubio.org>.
    163 
    164 To subscribe to the list, use the mailman form:
    165 http://lists.aubio.org/listinfo/aubio-user/
    166 
    167 Alternatively, feel free to contact directly the author.
    168 
    169 
    170 Copyright and License Information
    171 ---------------------------------
    172 
    173 Copyright (C) 2003-2013 Paul Brossier <piem@aubio.org>
     101License
     102-------
    174103
    175104aubio is free software: you can redistribute it and/or modify it under the
    … …  
    177106Foundation, either version 3 of the License, or (at your option) any later
    178107version.
     108
     109Contributing
     110------------
     111
     112Patches are welcome: please fork the latest git repository and create a feature
     113branch. Submitted requests should pass all continuous integration tests.
Note: See TracChangeset for help on using the changeset viewer.