Mercurial > hg > qm-vamp-plugins
changeset 229:c218537c34b9
Rejig docs
| author | Chris Cannam <c.cannam@qmul.ac.uk> |
|---|---|
| date | Fri, 24 May 2019 11:31:00 +0100 |
| parents | 0a393a99f29b |
| children | e713abed48e5 |
| files | .hgignore BUILD.txt CHANGELOG.md README.md README.txt repoint-lock.json repoint-project.json |
| diffstat | 7 files changed, 145 insertions(+), 139 deletions(-) [+] |
line wrap: on
line diff
--- a/.hgignore Tue May 21 13:24:58 2019 +0100 +++ b/.hgignore Fri May 24 11:31:00 2019 +0100 @@ -14,3 +14,5 @@ .vs *.db test/tmp +lib/ +*.orig
--- a/BUILD.txt Tue May 21 13:24:58 2019 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,46 +0,0 @@ - -Compiling the QM Vamp Plugins -============================= - -You will need: - - * Command-line compiler tools (for Windows this means MinGW) - * The Vamp Plugin SDK (http://vamp-plugins.org/) - - -Compiling for Linux -------------------- - -Run - -$ make -f build/linux/Makefile.linux64 - -(or Makefile.linux32 for a 32-bit build) - -If the Vamp Plugin SDK headers are not found, edit the Makefile to add -their location as a -I include flag in CXXFLAGS. - - -Compiling for OS/X ------------------- - -Make sure the Vamp Plugin SDK has been compiled in a directory -neighbouring this one (i.e. it lives in ../vamp-plugin-sdk). Run - -$ make -f build/osx/Makefile.osx - - -Compiling for Windows ---------------------- - -Currently only MinGW builds are supported. The Makefile has only been -tested for cross-compiles (from Linux) but it will probably work -building natively too... - -Make sure the Vamp Plugin SDK has been compiled in a directory -neighbouring this one (i.e. it lives in ../vamp-plugin-sdk). Run - -$ gmake -f build/mingw32/Makefile.mingw32 - - -
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/CHANGELOG.md Fri May 24 11:31:00 2019 +0100 @@ -0,0 +1,61 @@ + +QM Vamp Plugins v1.7.1 (September 2015) +--------------------------------------- + + - Improve output format of segmenter + - Add parameters to tempo tracker + - Bug fixes and build-system updates + + +QM Vamp Plugins v1.7 (April 2011) +--------------------------------- + + - Re-release with source code under GPL + + +QM Vamp Plugins v1.6.1 (October 2009) +------------------------------------- + + - Fix failure to smooth onset detection function correctly, which + caused onset and beat trackers occasionally to miss onsets or find + spurious ones + + +QM Vamp Plugins v1.6 (July 2009) +-------------------------------- + + - Add the Adaptive Spectrogram plugin + - Add the Polyphonic Transcription plugin + - Add the Wavelet Scalogram plugin + - Add the Bar and Beat Tracker plugin + - Add a new method for the beat tracker + + +QM Vamp Plugins v1.5 (December 2008) +------------------------------------ + + - Reliability and performance improvements + + +QM Vamp Plugins v1.4 (February 2008) +------------------------------------ + + - Add Segmenter plugin + - Add Similarity plugin + - Add MFCC plugin + - Add key-strength plot output to Key Detector plugin + + +QM Vamp Plugins v1.3 (December 2007) +------------------------------------ + + - Minor bugfix release + + +QM Vamp Plugins v1.2 (September 2007) +------------------------------------- + + - First external release + - Including: Onset Detector, Beat Tracker, Key Detector, Chromagram, + Constant-Q Spectrogram, and Tonal-Change Detector +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.md Fri May 24 11:31:00 2019 +0100 @@ -0,0 +1,77 @@ + +QM Vamp Plugins +=============== + +Audio feature extraction plugins in [Vamp format](https://vamp-plugins.org/) +from the [Centre for Digital Music](http://c4dm.eecs.qmul.ac.uk) at +Queen Mary, University of London. + + +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 + + https://vamp-plugins.org/plugin-doc/qm-vamp-plugins.html + + +Changes for this release +------------------------ + +See the CHANGELOG.md file included. + + +Compiling the plugins +--------------------- + +Ready-to-use binary builds of these plugins are provided for common +platforms, but it's also possible to build them from source code. + +To compile your own from source, first run `./repoint install` to +gather the necessary library code, and then + + - Linux: `make -f build/linux/Makefile.linux64` + + - Mac: `make -f build/osx/Makefile.osx` + + - Windows (MSVC): Use the solution `build/msvc/QMVampPlugins.sln` + + +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. + +Further copyrights apply to the qm-dsp library used in these +plugins. See the README for that library for details. + +If you wish to use this code in a proprietary application or product +for which the terms of the GPL are not appropriate, please contact QM +Innovation https://www.qminnovation.co.uk/ for licensing terms. + +Copyright (c) 2006-2019 Queen Mary, University of London.
--- a/README.txt Tue May 21 13:24:58 2019 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,89 +0,0 @@ - -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 will need to run: - - $ ./repoint install - -to install the necessary dependencies. - - -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-2016 Queen Mary, University of London.
--- a/repoint-lock.json Tue May 21 13:24:58 2019 +0100 +++ b/repoint-lock.json Fri May 24 11:31:00 2019 +0100 @@ -1,10 +1,10 @@ { "libraries": { "vamp-plugin-sdk": { - "pin": "b650289c47b4" + "pin": "62987b6d6a3b" }, "qm-dsp": { - "pin": "04c2ac91c16a" + "pin": "a155483de9caf6fe0f26ac59df602e9b9d51d6b8" } } }