From 0c1860391ab0fab4ea62689d919a2ea4f3e91fbc Mon Sep 17 00:00:00 2001 From: Paul Brossier Date: Wed, 21 Nov 2018 16:41:09 +0100 Subject: [PATCH] [doc] rewrite description, add built with and documentation sections to python/README.md --- python/README.md | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 58 insertions(+), 4 deletions(-) diff --git a/python/README.md b/python/README.md index 4bbbd3b6..91534b69 100644 --- a/python/README.md +++ b/python/README.md @@ -1,7 +1,61 @@ -Python aubio module -=================== - -This module wraps the aubio library for Python using the numpy module. +aubio +===== + +aubio is a collection of tools for music and audio analysis. + +This package integrates the aubio library with [NumPy] to provide a set of +efficient tools to process and analyse audio signals, including: + +- read audio from any media file, including videos and remote streams +- high quality phase vocoder, spectral filterbanks, and linear filters +- Mel-Frequency Cepstrum Coefficients and standard spectral descriptors +- detection of note attacks (onset) +- pitch tracking (fundamental frequency estimation) +- beat detection and tempo tracking + +aubio works with both Python 2 and Python 3. + +Built with +---------- + +The core of aubio is written in C for portability and speed. In addition to +[NumPy], aubio can be optionally built to use one or more of the following +libraries: + +- media file reading: + + - [ffmpeg](https://ffmpeg.org) / [avcodec](https://libav.org) to decode and + read audio from almost any format, + - [libsndfile](http://www.mega-nerd.com/libsndfile/) to read audio from + uncompressed sound files, + - [libsamplerate](http://www.mega-nerd.com/SRC/) to re-sample audio signals + - [CoreAudio](https://developer.apple.com/reference/coreaudio) to read all + media files supported natively on macOS, iOS, and tvOS. + +- hardware acceleration: + + - [Atlas](http://math-atlas.sourceforge.net/) and + [Blas](https://en.wikipedia.org/wiki/Basic_Linear_Algebra_Subprograms), + for accelerated vector and matrix computations, + - [fftw3](http://fftw.org), to compute fast Fourier Transforms of any size. + - [Accelerate](https://developer.apple.com/reference/accelerate) for + hardware accelerated FFT and matrix computations on macOs and iOS, + - [Intel IPP](https://software.intel.com/en-us/intel-ipp), accelerated + vector computation and FFT implementation, + +Documentation +------------- + +- [module documentation][doc_python] +- [installation][doc_python_install] +- [aubio manual][manual] +- [aubio homepage][homepage] + +[manual]: https://aubio.org/manual/latest/ +[doc_python]: https://aubio.org/manual/latest/python.html +[doc_python_install]: https://aubio.org/manual/latest/python_module.html +[homepage]: https://aubio.org +[NumPy]: https://www.numpy.org Finding some inspiration ------------------------ -- 2.11.0