Conda

<object data="https://anaconda.org/yaafe/yaafe/badges/installer/conda.svg" type="image/svg+xml">conda</object>

Yaafe can be easily install with conda. To install this package with conda run:

conda install -c https://conda.anaconda.org/yaafe yaafe

Docker

Yaafe can also be install through Docker.

Get the official Yaafe image from Yaafe repository on Docker Hub:

docker pull yaafe/yaafe
docker tag yaafe yaafe/yaafe

or build it from the sources directory:

docker build --tag=yaafe .

Following both of the method above, you then have a docker image tagged as yaafe. The yaafe command is the entrypoint for that docker image so you can run 'yaafe' from the command line through docker run yaafe. For example:

docker run -it yaafe --help
docker run -it yaafe --volume=$(pwd):/wd  --workdir=/wd -c resources/featureplan -r 16000 --resample resources/yaafe_check.wav

On Linux, it can be usefull to create an alias for it:

alias yaafe='docker run -it --rm=true --volume=$(pwd):/wd  --workdir=/wd yaafe'

You could then simply run:

yaafe --help
yaafe -l

et voilà !

If you need to set the docker user as the current user on the host, you could try to run docker with the -u $(id -u):$(id -g) option

docker run -it --rm=true --volume=$(pwd):/wd  --workdir=/wd -u $(id -u):$(id -g) yaafe -c resources/featureplan -o h5 -r 16000 --resample resources/yaafe_check.wav

Last but not least, the entry-point for the yaafe docker image is smart :

• every command that start with a dash - will be pass as options to the yaafe command inside the docker container

• every command that does not start with a dash will be treated as a regular command. For example:

  docker run -it yaafe /bin/bash
  

will give you access to a bash terminal inside the docker. And

docker run -it yaafe yaafe-engine --help

will launch the yaafe-engine batch processing tool.

From sources

Yaafe source code should compile on linux and MacOsX platform, and uses CMake as compilation tool. Yaafe requires third-party libraries to enable specific features. Some of these libraries 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

export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$DEST_DIR/lib

export MATLABPATH=$MATLABPATH:$DEST_DIR/matlab