changeset 182:9c52dac85835

Update README and adjust locations of INSTALL files to reflect the fact that this repo is not a binary distribution
author Chris Cannam <c.cannam@qmul.ac.uk>
date Mon, 21 Mar 2016 19:49:36 +0000
parents 0243d1e2c82f
children 258939b7c810
files INSTALL_linux.txt INSTALL_linux64.txt INSTALL_osx.txt INSTALL_win32.txt README.txt build/general/README.txt build/linux/INSTALL_linux.txt build/linux/INSTALL_linux64.txt build/mingw32/INSTALL_win32.txt build/osx/INSTALL_osx.txt
diffstat 10 files changed, 195 insertions(+), 107 deletions(-) [+]
line wrap: on
line diff
--- a/INSTALL_linux.txt	Wed Feb 10 21:50:35 2016 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,21 +0,0 @@
-
-QM Vamp Plugins
-===============
-
-To Install
-==========
-
-This package contains plugins compiled for Linux on 32-bit x86.
-
-To install them, copy the following files:
-
-   qm-vamp-plugins.so
-   qm-vamp-plugins.cat
-   qm-vamp-plugins.n3
-
-to one of the following directories:
-
-   /usr/local/lib/vamp/
-   /usr/lib/vamp/
-   $HOME/vamp/
-
--- a/INSTALL_linux64.txt	Wed Feb 10 21:50:35 2016 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,21 +0,0 @@
-
-QM Vamp Plugins
-===============
-
-To Install
-==========
-
-This package contains plugins compiled for Linux on 64-bit processors.
-
-To install them, copy the following files:
-
-   qm-vamp-plugins.so
-   qm-vamp-plugins.cat
-   qm-vamp-plugins.n3
-
-to one of the following directories:
-
-   /usr/local/lib/vamp/
-   /usr/lib/vamp/
-   $HOME/vamp/
-
--- a/INSTALL_osx.txt	Wed Feb 10 21:50:35 2016 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,20 +0,0 @@
-
-QM Vamp Plugins
-===============
-
-To Install
-==========
-
-This package contains plugins for the Apple Mac OS/X operating system.
-
-To install them, copy the files
-
-   qm-vamp-plugins.dylib
-   qm-vamp-plugins.cat
-   qm-vamp-plugins.n3
-
-to either
-
-   /Library/Audio/Plug-Ins/Vamp/      (for plugins to be available to all users)
-   $HOME/Library/Audio/Plug-Ins/Vamp/ (for plugins to be available to you only)
-
--- a/INSTALL_win32.txt	Wed Feb 10 21:50:35 2016 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,23 +0,0 @@
-
-QM Vamp Plugins
-===============
-
-To Install
-==========
-
-This package contains plugins for Win32 systems (Windows XP, Vista).
-
-To install them, copy the files
-
-   qm-vamp-plugins.dll
-   qm-vamp-plugins.cat
-   qm-vamp-plugins.n3
-
-into the folder
-
-   "C:\Program Files\Vamp Plugins\"
-
-You may also install them elsewhere, if you set the VAMP_PATH environment
-variable to a semicolon-separated list of the folders in which plugins
-may be found.  e.g., "C:\My Plugins;C:\Program Files\Vamp Plugins".
-
--- a/README.txt	Wed Feb 10 21:50:35 2016 +0000
+++ b/README.txt	Mon Mar 21 19:49:36 2016 +0000
@@ -85,25 +85,4 @@
 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.
-
-    Win 32  -> Copy qm-vamp-plugins.dll, qm-vamp-plugins.cat and
-               qm-vamp-plugins.n3 to C:\Program Files\Vamp Plugins\
-
-    Win 64  -> Copy qm-vamp-plugins.dll, qm-vamp-plugins.cat and
-               qm-vamp-plugins.n3 to C:\Program Files\Vamp Plugins (x86)\
-
-    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/
-
+Copyright (c) 2006-2016 Queen Mary, University of London.
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/build/general/README.txt	Mon Mar 21 19:49:36 2016 +0000
@@ -0,0 +1,109 @@
+
+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.
+
+    Win 32  -> Copy qm-vamp-plugins.dll, qm-vamp-plugins.cat and
+               qm-vamp-plugins.n3 to C:\Program Files\Vamp Plugins\
+
+    Win 64  -> Copy qm-vamp-plugins.dll, qm-vamp-plugins.cat and
+               qm-vamp-plugins.n3 to C:\Program Files\Vamp Plugins (x86)\
+
+    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/
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/build/linux/INSTALL_linux.txt	Mon Mar 21 19:49:36 2016 +0000
@@ -0,0 +1,21 @@
+
+QM Vamp Plugins
+===============
+
+To Install
+==========
+
+This package contains plugins compiled for Linux on 32-bit x86.
+
+To install them, copy the following files:
+
+   qm-vamp-plugins.so
+   qm-vamp-plugins.cat
+   qm-vamp-plugins.n3
+
+to one of the following directories:
+
+   /usr/local/lib/vamp/
+   /usr/lib/vamp/
+   $HOME/vamp/
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/build/linux/INSTALL_linux64.txt	Mon Mar 21 19:49:36 2016 +0000
@@ -0,0 +1,21 @@
+
+QM Vamp Plugins
+===============
+
+To Install
+==========
+
+This package contains plugins compiled for Linux on 64-bit processors.
+
+To install them, copy the following files:
+
+   qm-vamp-plugins.so
+   qm-vamp-plugins.cat
+   qm-vamp-plugins.n3
+
+to one of the following directories:
+
+   /usr/local/lib/vamp/
+   /usr/lib/vamp/
+   $HOME/vamp/
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/build/mingw32/INSTALL_win32.txt	Mon Mar 21 19:49:36 2016 +0000
@@ -0,0 +1,23 @@
+
+QM Vamp Plugins
+===============
+
+To Install
+==========
+
+This package contains plugins for Win32 systems (Windows XP, Vista).
+
+To install them, copy the files
+
+   qm-vamp-plugins.dll
+   qm-vamp-plugins.cat
+   qm-vamp-plugins.n3
+
+into the folder
+
+   "C:\Program Files\Vamp Plugins\"
+
+You may also install them elsewhere, if you set the VAMP_PATH environment
+variable to a semicolon-separated list of the folders in which plugins
+may be found.  e.g., "C:\My Plugins;C:\Program Files\Vamp Plugins".
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/build/osx/INSTALL_osx.txt	Mon Mar 21 19:49:36 2016 +0000
@@ -0,0 +1,20 @@
+
+QM Vamp Plugins
+===============
+
+To Install
+==========
+
+This package contains plugins for the Apple Mac OS/X operating system.
+
+To install them, copy the files
+
+   qm-vamp-plugins.dylib
+   qm-vamp-plugins.cat
+   qm-vamp-plugins.n3
+
+to either
+
+   /Library/Audio/Plug-Ins/Vamp/      (for plugins to be available to all users)
+   $HOME/Library/Audio/Plug-Ins/Vamp/ (for plugins to be available to you only)
+