Changeset 0c18603 for python


Ignore:
Timestamp:
Nov 21, 2018, 4:41:09 PM (8 months ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master
Children:
e6a07fe
Parents:
4da317c
Message:

[doc] rewrite description, add built with and documentation sections to python/README.md

File:
1 edited

Legend:

Unmodified
Added
Removed
  • python/README.md

    r4da317c r0c18603  
    1 Python aubio module
    2 ===================
     1aubio
     2=====
    33
    4 This module wraps the aubio library for Python using the numpy module.
     4aubio is a collection of tools for music and audio analysis.
     5
     6This package integrates the aubio library with [NumPy] to provide a set of
     7efficient tools to process and analyse audio signals, including:
     8
     9- read audio from any media file, including videos and remote streams
     10- high quality phase vocoder, spectral filterbanks, and linear filters
     11- Mel-Frequency Cepstrum Coefficients and standard spectral descriptors
     12- detection of note attacks (onset)
     13- pitch tracking (fundamental frequency estimation)
     14- beat detection and tempo tracking
     15
     16aubio works with both Python 2 and Python 3.
     17
     18Built with
     19----------
     20
     21The core of aubio is written in C for portability and speed. In addition to
     22[NumPy], aubio can be optionally built to use one or more of the following
     23libraries:
     24
     25- media file reading:
     26
     27    - [ffmpeg](https://ffmpeg.org) / [avcodec](https://libav.org) to decode and
     28      read audio from almost any format,
     29    - [libsndfile](http://www.mega-nerd.com/libsndfile/) to read audio from
     30      uncompressed sound files,
     31    - [libsamplerate](http://www.mega-nerd.com/SRC/) to re-sample audio signals
     32    - [CoreAudio](https://developer.apple.com/reference/coreaudio) to read all
     33      media files supported natively on macOS, iOS, and tvOS.
     34
     35- hardware acceleration:
     36
     37    - [Atlas](http://math-atlas.sourceforge.net/) and
     38      [Blas](https://en.wikipedia.org/wiki/Basic_Linear_Algebra_Subprograms),
     39      for accelerated vector and matrix computations,
     40    - [fftw3](http://fftw.org), to compute fast Fourier Transforms of any size.
     41    - [Accelerate](https://developer.apple.com/reference/accelerate) for
     42      hardware accelerated FFT and matrix computations on macOs and iOS,
     43    - [Intel IPP](https://software.intel.com/en-us/intel-ipp), accelerated
     44      vector computation and FFT implementation,
     45
     46Documentation
     47-------------
     48
     49- [module documentation][doc_python]
     50- [installation][doc_python_install]
     51- [aubio manual][manual]
     52- [aubio homepage][homepage]
     53
     54[manual]: https://aubio.org/manual/latest/
     55[doc_python]: https://aubio.org/manual/latest/python.html
     56[doc_python_install]: https://aubio.org/manual/latest/python_module.html
     57[homepage]: https://aubio.org
     58[NumPy]: https://www.numpy.org
    559
    660Finding some inspiration
Note: See TracChangeset for help on using the changeset viewer.