annotate README.md @ 266:d04675d44928 tip master

Refer to SDK from Github
author Chris Cannam <cannam@all-day-breakfast.com>
date Wed, 02 Jun 2021 14:41:26 +0100
parents 508a0b5fe1fa
children
rev   line source
c@229 1
c@229 2 QM Vamp Plugins
c@229 3 ===============
c@229 4
c@229 5 Audio feature extraction plugins in [Vamp format](https://vamp-plugins.org/)
c@229 6 from the [Centre for Digital Music](http://c4dm.eecs.qmul.ac.uk) at
c@229 7 Queen Mary, University of London.
c@229 8
c@229 9
c@229 10 Plugins included
c@229 11 ----------------
c@229 12
c@229 13 This plugin set includes the following plugins:
c@229 14
c@229 15 * Note onset detector
c@229 16
c@229 17 * Beat tracker and tempo estimator
c@229 18
c@229 19 * Key estimator and tonal change detector
c@229 20
c@229 21 * Adaptive multi-resolution FFT spectrogram
c@229 22
c@229 23 * Polyphonic note transcription estimator
c@229 24
c@229 25 * Segmenter, to divide a track into a consistent sequence of segments
c@229 26
c@229 27 * Timbral and rhythmic similarity between audio tracks
c@229 28
c@229 29 * Wavelet scalogram (discrete wavelet transform)
c@229 30
c@229 31 * Chromagram, constant-Q spectrogram, and MFCC calculation plugins
c@229 32
c@229 33 For full details about the plugins, with references, please see
c@229 34
c@229 35 https://vamp-plugins.org/plugin-doc/qm-vamp-plugins.html
c@229 36
c@229 37
c@229 38 Changes for this release
c@229 39 ------------------------
c@229 40
c@229 41 See the CHANGELOG.md file included.
c@229 42
c@229 43
c@229 44 Compiling the plugins
c@229 45 ---------------------
c@229 46
c@229 47 Ready-to-use binary builds of these plugins are provided for common
c@229 48 platforms, but it's also possible to build them from source code.
c@229 49
c@229 50 To compile your own from source, first run `./repoint install` to
c@229 51 gather the necessary library code, and then
c@229 52
c@229 53 - Linux: `make -f build/linux/Makefile.linux64`
c@229 54
c@229 55 - Mac: `make -f build/osx/Makefile.osx`
c@229 56
c@229 57 - Windows (MSVC): Use the solution `build/msvc/QMVampPlugins.sln`
c@229 58
c@229 59
cannam@230 60 Licence
c@229 61 -------
c@229 62
c@229 63 These plugins are provided under the terms of the GNU General Public
c@229 64 License. You may install and use the plugin binaries without fee for
c@229 65 any purpose commercial or non-commercial. You may also modify and
c@229 66 redistribute the plugins in source or binary form, provided you comply
c@229 67 with the terms given by the GNU General Public License. See the file
c@229 68 COPYING for more details.
c@229 69
c@229 70 Further copyrights apply to the qm-dsp library used in these
c@229 71 plugins. See the README for that library for details.
c@229 72
c@229 73 If you wish to use this code in a proprietary application or product
c@229 74 for which the terms of the GPL are not appropriate, please contact QM
c@229 75 Innovation https://www.qminnovation.co.uk/ for licensing terms.
c@229 76
cannam@253 77 Copyright (c) 2006-2020 Queen Mary, University of London.