Build status

• Branch master :
• Branch dev :

Install

Yaafe source code should compile on linux and MacOsX platform, and uses CMake as compilation tool. Yaafe requires thirdparty libraries to enable specific features. Some of these library may already be available on your system.

The argtable library is required.

Depending on optional features you want to use, other librairies may be used:

• libsndfile: enable reading WAV files format (highly recommanded)
• libmpg123: enable reading MP3 audio files
• HDF5 >= 1.8: enable H5 output format
• liblapack: enable some audio features (LSF)
• FFTW3: use FFTW instead of Eigen for FFT computations (pay attention to licensing issues when linking with the GPL FFTW3 library).

To use the yaafe script you need Python >= 2.5, and the numpy package.

Once previous libraries are installed (some may have been locally installed in <lib-path>), you can compile with the following steps:

git submodule init  # to prepare Eigen code under the externals directory
git submodule update
mkdir build
cd build
ccmake -DCMAKE_PREFIX_PATH=<lib-path> -DCMAKE_INSTALL_PREFIX=<install-path> ..
make
make install

Several options can control Yaafe compilation. More details can be found at:

http://yaafe.sourceforge.net/manual/install.html

Environment

To easily use Yaafe, you should set the following environment vars:

export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$DEST_DIR/lib

On MacOSX replace LD_LIBRARY_PATH by DYLD_FALLBACK_LIBRARY_PATH

If you use Matlab, you can set your MATLABPATH var:

export MATLABPATH=$MATLABPATH:$DEST_DIR/matlab

Documentation

Documentation is also available online: http://yaafe.sourceforge.net/

To build documentation, you need Sphinx. Before building documentation, you should set your environment correctly so that sphinx builds documentation with automatic features documentation.

To build documentation, just run make doc in the ``build` directory. Documentation is built in doc/html directory.

License

YAAFE is released under the version 3 of the GNU Lesser General Public License. Read COPYING and COPYING.LESSER for more details. The user should also read DISCLAIMER before linking with optional libraries which have different license policy.

Support

To get help with YAAFE, use the mailing-list yaafe-users@lists.sourceforge.net (registration at https://lists.sourceforge.net/lists/listinfo/yaafe-users ).

Credits

Yaafe was first developed at Telecom Paristech / AAO Team. It uses several great open-source projects like Eigen, Smarc, libsndfile, mpg123, HDF5.

If you want to cite Yaafe in a publication, please see CITATION.