
QM Vamp Plugins
===============

Vamp audio feature extraction plugins from the Centre for Digital
Music at Queen Mary, University of London.

Version 1.7.1.

This project:

    https://code.soundsoftware.ac.uk/projects/qm-vamp-plugins

About Vamp plugins:

    http://www.vamp-plugins.org/

About C4DM:

    http://c4dm.eecs.qmul.ac.uk/


About This Release
==================

This is mostly a bugfix and build-system update release. The principal
new feature since the previous 1.7 release is the addition of some new
parameters to the BeatTracker plugin.


Build Dependencies
==================

This code depends on the qm-dsp library:

    https://code.soundsoftware.ac.uk/projects/qm-dsp

If you have cloned this code from the Mercurial repository hosted at
SoundSoftware, you should have got qm-dsp as well as a subdirectory
(as it is listed as a Mercurial subrepository). Otherwise, you should
clone that repository inside the working copy of this one before
building.


Plugins Included
================

This plugin set includes the following plugins:

   * Note onset detector

   * Beat tracker and tempo estimator

   * Key estimator and tonal change detector

   * Adaptive multi-resolution FFT spectrogram

   * Polyphonic note transcription estimator

   * Segmenter, to divide a track into a consistent sequence of segments

   * Timbral and rhythmic similarity between audio tracks

   * Wavelet scalogram (discrete wavelet transform)

   * Chromagram, constant-Q spectrogram, and MFCC calculation plugins

For full details about the plugins, with references, please see

  http://vamp-plugins.org/plugin-doc/qm-vamp-plugins.html


License
=======

These plugins are provided under the terms of the GNU General Public
License.  You may install and use the plugin binaries without fee for
any purpose commercial or non-commercial.  You may also modify and
redistribute the plugins in source or binary form, provided you comply
with the terms given by the GNU General Public License.  See the file
COPYING for more details.

If you wish to use these plugins in a proprietary application or
product for which the terms of the GPL are not appropriate, please
contact the Centre for Digital Music at Queen Mary, University of
London for further licensing terms.

Copyright (c) 2006-2015 Queen Mary, University of London.


To Install
==========

Installation depends on your operating system and (on Windows) whether
you are installing a 32- or 64-bit version of the plugin set.

    OS/X    -> Copy qm-vamp-plugins.dylib, qm-vamp-plugins.cat and
               qm-vamp-plugins.n3 to $HOME/Library/Audio/Plug-Ins/Vamp/
               or /Library/Audio/Plug-Ins/Vamp/

    Linux   -> Copy qm-vamp-plugins.so, qm-vamp-plugins.cat and
               qm-vamp-plugins.n3 to $HOME/vamp/ or /usr/local/lib/vamp/
               or /usr/lib/vamp/

    32-bit Windows with 32-bit plugin set, or
    64-bit Windows with 64-bit plugin set
            -> Copy qm-vamp-plugins.dll, qm-vamp-plugins.cat and
               qm-vamp-plugins.n3 to C:\Program Files\Vamp Plugins\

    64-bit Windows with 32-bit plugin set
            -> Copy qm-vamp-plugins.dll, qm-vamp-plugins.cat and
               qm-vamp-plugins.n3 to C:\Program Files\Vamp Plugins (x86)\

