Vamp plugin for MusicIP fingerprinting and audio lookup using libofa
====================================================================

This Vamp audio analysis plugin uses the OFA audio fingerprinting
library from MusicIP (http://www.musicip.com/) to calculate a
fingerprint from its audio input, and attempt to identify it as a
known track in the MusicDNS database.

It has two outputs: the audio fingerprint produced by libofa (returned
as the label of a single output feature at time zero), and the PUID of
the audio recording as retrieved from the MusicIP MusicDNS servers.

If the PUID cannot be retrieved -- because the recording is unknown,
the MusicDNS servers could not be contacted, the plugin's hardcoded
MusicIP client ID was rejected or has exceeded its usage limit, or for
any other reason -- then only the fingerprint is returned.

To build this plugin you will need the OFA (audio fingerprinting),
CURL (network retrieval) and Expat (XML parser) libraries, as well as
the Vamp plugin SDK.  The plugin does no real work itself, it just
glues these libraries together.  It has only been tested on Linux.  No
binaries are provided; you'll have to build it yourself (or find them
somewhere else).

For more information about Vamp plugins, see:

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

This plugin was cobbled together by Chris Cannam in 2007.


Licensing
=========

This plugin code is under a "new-style BSD" license, as follows.  Note
that the libraries that the plugin requires are published under more
restrictive licenses, so you will need to ensure you comply with those.
  
    Permission is hereby granted, free of charge, to any person
    obtaining a copy of this software and associated documentation
    files (the "Software"), to deal in the Software without
    restriction, including without limitation the rights to use, copy,
    modify, merge, publish, distribute, sublicense, and/or sell copies
    of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be
    included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
    NONINFRINGEMENT. IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR
    ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
    CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Except as contained in this notice, the name of Chris Cannam
    shall not be used in advertising or otherwise to promote the sale,
    use or other dealings in this Software without prior written
    authorization.