Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

Tree [bcdcb9] master /
History



File Date Author Commit
cmake-modules 2011-11-07 Benoit Mathieu Benoit Mathieu [8654f6] initial import, published version 0.63
doc 2011-11-07 Benoit Mathieu Benoit Mathieu [851489] fix last release date
externals 2011-11-07 Benoit Mathieu Benoit Mathieu [8654f6] initial import, published version 0.63
matlab 2011-11-07 Benoit Mathieu Benoit Mathieu [8654f6] initial import, published version 0.63
resources 2011-11-07 Benoit Mathieu Benoit Mathieu [8654f6] initial import, published version 0.63
src_cpp 2013-04-20 Benoit Mathieu Benoit Mathieu [bcdcb9] fix uninitialized reads when using MelMaxFreq =...
src_python 2011-11-07 Benoit Mathieu Benoit Mathieu [3f6ba2] fix MelSpectrum docstring
.gitignore 2011-11-07 Benoit Mathieu Benoit Mathieu [8654f6] initial import, published version 0.63
CMakeLists.txt 2011-11-07 Benoit Mathieu Benoit Mathieu [d1a7c1] change version to 0.64, update changelog
COPYING 2011-11-07 Benoit Mathieu Benoit Mathieu [8654f6] initial import, published version 0.63
COPYING.LESSER 2011-11-07 Benoit Mathieu Benoit Mathieu [8654f6] initial import, published version 0.63
DISCLAIMER 2011-11-07 Benoit Mathieu Benoit Mathieu [8654f6] initial import, published version 0.63
README 2011-11-07 Benoit Mathieu Benoit Mathieu [8654f6] initial import, published version 0.63
install.sh 2011-11-07 Benoit Mathieu Benoit Mathieu [8654f6] initial import, published version 0.63
yaafe-config.cmake 2011-11-07 Benoit Mathieu Benoit Mathieu [8654f6] initial import, published version 0.63

Read Me

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 <http://argtable.sourceforge.net/>`_ library is required.

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

* `libsndfile <http://www.mega-nerd.com/libsndfile/>`_: enable reading WAV files format (highly recommanded)
* `libmpg123 <http://http://www.mpg123.de/api/>`_: enable reading MP3 audio files
* `HDF5 <http://www.hdfgroup.org/HDF5/>`_ >= 1.8: enable H5 output format
* `liblapack <http://www.netlib.org/lapack/>`_: enable some audio features (LSF)
* `FFTW3 <http://www.fftw.org/>`_: use FFTW instead of Eigen for FFT computations (pay attention to licensing issues when linking with the GPL FFTW3 library).

To use the *yaafe.py* 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:

 1. mkdir build
 2. cd build
 3. ccmake -DCMAKE_PREFIX_PATH=<lib-path> -DCMAKE_INSTALL_PREFIX=<install-path> ..
 4. make
 5. make install

Several options can control Yaafe compilation. More details can be found at:
   https://yaafe.sourceforge.net/manual/install.html


Environment
===========

You *must* set your YAAFE_PATH environment var to the "yaafe_extensions" dir so that yaafe can find available features.
export YAAFE_PATH=$DEST_DIR/yaafe_extensions

To easily use Yaafe, you should set the following environment vars:
export PATH=$PATH:$DEST_DIR/bin
# on MacOsX replace LD_LIBRARY_PATH => DYLD_LIBRARY_PATH
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$DEST_DIR/lib
export PYTHONPATH=$PYTHONPATH:$DEST_DIR/python_packages

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 ) or contact the main author at
benoit.mathieu@telecom-paristech.fr .