README.md

   1 aubio
   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://ci.appveyor.com/api/projects/status/f3lhy3a57rkgn5yi?svg=true)](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 [![Documentation Status](https://readthedocs.org/projects/aubio/badge/?version=latest)](http://aubio.readthedocs.io/en/latest/?badge=latest "Documentation status")
   8 [![Commits since last release](https://img.shields.io/github/commits-since/aubio/aubio/0.4.4.svg)](https://github.com/aubio/aubio "Commits since last release")
   9
  10 aubio is a library to label music and sounds. It listens to audio signals and
  11 attempts to detect events. For instance, when a drum is hit, at which frequency
  12 is a note, or at what tempo is a rhythmic melody.
  13
  14 Its features include segmenting a sound file before each of its attacks,
  15 performing pitch detection, tapping the beat and producing midi streams from
  16 live audio.
  17
  18 aubio provide several algorithms and routines, including:
  19
  20   - several onset detection methods
  21   - different pitch detection methods
  22   - tempo tracking and beat detection
  23   - MFCC (mel-frequency cepstrum coefficients)
  24   - FFT and phase vocoder
  25   - up/down-sampling
  26   - digital filters (low pass, high pass, and more)
  27   - spectral filtering
  28   - transient/steady-state separation
  29   - sound file and audio devices read and write access
  30   - various mathematics utilities for music applications
  31
  32 The name aubio comes from _audio_ with a typo: some errors are likely to be
  33 found in the results.
  34
  35 Python module
  36 -------------
  37
  38 A python module to access the library functions is also provided. Please see
  39 the file [`python/README.md`](python/README.md) for more information on how to
  40 use it.
  41
  42 Examples tools
  43 --------------
  44
  45 A few simple command line tools are included along with the library:
  46
  47  - `aubioonset` outputs the time stamp of detected note onsets
  48  - `aubiopitch` attempts to identify a fundamental frequency, or pitch, for
  49    each frame of the input sound
  50  - `aubiomfcc` computes Mel-frequency Cepstrum Coefficients
  51  - `aubiotrack` outputs the time stamp of detected beats
  52  - `aubionotes` emits midi-like notes, with an onset, a pitch, and a duration
  53  - `aubioquiet` extracts quiet and loud regions
  54
  55 Additionally, the python module comes with the following script:
  56
  57  - `aubiocut` slices sound files at onset or beat timestamps
  58
  59 The latest version of the documentation can be found at:
  60
  61   https://aubio.org/documentation
  62
  63 Build Instructions
  64 ------------------
  65
  66 aubio compiles on Linux, Mac OS X, Windows, Cygwin, and iOS.
  67
  68 To compile aubio, you should be able to simply run:
  69
  70     make
  71
  72 To compile the python module:
  73
  74     ./setup.py build
  75
  76 See also the [manual](https://aubio.org/manual/latest/) for more information
  77 about [installing aubio](https://aubio.org/manual/latest/installing.html).
  78
  79 Credits and Publications
  80 ------------------------
  81
  82 This library gathers music signal processing algorithms designed at the Centre
  83 for Digital Music and elsewhere. This software project was developed along the
  84 research I did at the Centre for Digital Music, Queen Mary, University of
  85 London. Most of this C code was written by myself, starting from published
  86 papers and existing code. The header files of each algorithm contains brief
  87 descriptions and references to the corresponding papers.
  88
  89 Special thanks go Juan Pablo Bello, Chris Duxbury, Samer Abdallah, Alain de
  90 Cheveigne for their help and publications. Also many thanks to Miguel Ramirez
  91 and Nicolas Wack for their bug fixing.
  92
  93 Substantial informations about the algorithms and their evaluation are gathered
  94 in:
  95
  96   - Paul Brossier, _[Automatic annotation of musical audio for interactive
  97     systems](https://aubio.org/phd)_, PhD thesis, Centre for Digital music,
  98 Queen Mary University of London, London, UK, 2006.
  99
 100 Additional results obtained with this software were discussed in the following
 101 papers:
 102
 103   - P. M. Brossier and J. P. Bello and M. D. Plumbley, [Real-time temporal
 104     segmentation of note objects in music signals](https://aubio.org/articles/brossier04fastnotes.pdf),
 105 in _Proceedings of the International Computer Music Conference_, 2004, Miami,
 106 Florida, ICMA
 107
 108   -  P. M. Brossier and J. P. Bello and M. D. Plumbley, [Fast labelling of note
 109      objects in music signals] (https://aubio.org/articles/brossier04fastnotes.pdf),
 110 in _Proceedings of the International Symposium on Music Information Retrieval_,
 111 2004, Barcelona, Spain
 112
 113
 114 Contact Info and Mailing List
 115 -----------------------------
 116
 117 The home page of this project can be found at: https://aubio.org/
 118
 119 Questions, comments, suggestions, and contributions are welcome. Use the
 120 mailing list: <aubio-user@aubio.org>.
 121
 122 To subscribe to the list, use the mailman form:
 123 https://lists.aubio.org/listinfo/aubio-user/
 124
 125 Alternatively, feel free to contact directly the author.
 126
 127
 128 Copyright and License Information
 129 ---------------------------------
 130
 131 Copyright (C) 2003-2016 Paul Brossier <piem@aubio.org>
 132
 133 aubio is free software: you can redistribute it and/or modify it under the
 134 terms of the GNU General Public License as published by the Free Software
 135 Foundation, either version 3 of the License, or (at your option) any later
 136 version.