README.md

Python aubio module

This module wraps the aubio library for Python using the numpy module.

Using the Python aubio module

After installing python-aubio, you will be able to import the aubio module:

$ python
[...]
>>> import aubio
>>> help(aubio.miditofreq)

Finding some inspiration

Some examples are available in the python/demos directory. These scripts are small programs written in python and using python-aubio.

For instance, demo_source.py reads a media file.

$ ./python/demos/demo_source.py /path/to/sound/sample.wav

and demo_timestretch_online.py stretches the original file into a new one:

$ ./python/demo/demo_timestretch_online.py loop.wav stretched_loop.wav 0.92`

Note: you might need to install additional modules to run some of the demos. Some demos use matplotlib to draw plots, others use PySoundCard to play and record sounds.

Testing the Python module

Python tests are in python/tests and use the nose2 python package.

To run the all the python tests, use the script:

$ ./python/tests/run_all_tests

Each test script can also be called one at a time. For instance:

$ ./python/tests/test_note2midi.py -v

Install in a virtualenv

You should be able to install python-aubio directly from the top source directory of aubio.

First, create a virtualenv to hold the required python module:

$ virtualenv pyaubio
$ source pyaubio/bin/activate

Now install and build the python extension using:

$ pip install .

Install requirements

Before compiling this module, you must have compiled libaubio.

A simple way to do this is with pip:

$ pip install -r requirements.txt

For more information about how this module works, please refer to the [Python/C API Reference Manual] (http://docs.python.org/c-api/index.html) and the Numpy/C API Reference.

Compiling python aubio

To build the aubio Python module, run the following command from the top source directory of aubio:

$ ./setup.py build

Note: if libaubio was previously built using waf, the script will use it. Otherwise, the entire library will be built inside the python extension.

To find out more about setup.py options:

$ ./setup.py --help

Installing

To install the Python module:

$ ./setup.py install

Alternatively, you may want to use the Python module without installing it by setting your PYTHONPATH, for instance as follows:

$ export PYTHONPATH=$PYTHONPATH:$PWD/`ls -rtd build/lib.* | head -1`:$PWD/tests