annotate build/general/README.txt @ 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 90c943d79943
children
rev   line source
c@213 1
c@213 2 QM Vamp Plugins
c@213 3 ===============
c@213 4
c@213 5 Vamp audio feature extraction plugins from the Centre for Digital
c@213 6 Music at Queen Mary, University of London.
c@213 7
c@213 8 Version 1.7.1.
c@213 9
c@213 10 This project:
c@213 11
c@213 12 https://code.soundsoftware.ac.uk/projects/qm-vamp-plugins
c@213 13
c@213 14 About Vamp plugins:
c@213 15
c@213 16 http://www.vamp-plugins.org/
c@213 17
c@213 18 About C4DM:
c@213 19
c@213 20 http://c4dm.eecs.qmul.ac.uk/
c@213 21
c@213 22
c@213 23 About This Release
c@213 24 ==================
c@213 25
c@213 26 This is mostly a bugfix and build-system update release. The principal
c@213 27 new feature since the previous 1.7 release is the addition of some new
c@213 28 parameters to the BeatTracker plugin.
c@213 29
c@213 30
c@213 31 Build Dependencies
c@213 32 ==================
c@213 33
c@213 34 This code depends on the qm-dsp library:
c@213 35
c@213 36 https://code.soundsoftware.ac.uk/projects/qm-dsp
c@213 37
c@213 38 If you have cloned this code from the Mercurial repository hosted at
c@213 39 SoundSoftware, you should have got qm-dsp as well as a subdirectory
c@213 40 (as it is listed as a Mercurial subrepository). Otherwise, you should
c@213 41 clone that repository inside the working copy of this one before
c@213 42 building.
c@213 43
c@213 44
c@213 45 Plugins Included
c@213 46 ================
c@213 47
c@213 48 This plugin set includes the following plugins:
c@213 49
c@213 50 * Note onset detector
c@213 51
c@213 52 * Beat tracker and tempo estimator
c@213 53
c@213 54 * Key estimator and tonal change detector
c@213 55
c@213 56 * Adaptive multi-resolution FFT spectrogram
c@213 57
c@213 58 * Polyphonic note transcription estimator
c@213 59
c@213 60 * Segmenter, to divide a track into a consistent sequence of segments
c@213 61
c@213 62 * Timbral and rhythmic similarity between audio tracks
c@213 63
c@213 64 * Wavelet scalogram (discrete wavelet transform)
c@213 65
c@213 66 * Chromagram, constant-Q spectrogram, and MFCC calculation plugins
c@213 67
c@213 68 For full details about the plugins, with references, please see
c@213 69
c@213 70 http://vamp-plugins.org/plugin-doc/qm-vamp-plugins.html
c@213 71
c@213 72
c@213 73 License
c@213 74 =======
c@213 75
c@213 76 These plugins are provided under the terms of the GNU General Public
c@213 77 License. You may install and use the plugin binaries without fee for
c@213 78 any purpose commercial or non-commercial. You may also modify and
c@213 79 redistribute the plugins in source or binary form, provided you comply
c@213 80 with the terms given by the GNU General Public License. See the file
c@213 81 COPYING for more details.
c@213 82
c@213 83 If you wish to use these plugins in a proprietary application or
c@213 84 product for which the terms of the GPL are not appropriate, please
c@213 85 contact the Centre for Digital Music at Queen Mary, University of
c@213 86 London for further licensing terms.
c@213 87
c@213 88 Copyright (c) 2006-2015 Queen Mary, University of London.
c@213 89
c@213 90
c@213 91 To Install
c@213 92 ==========
c@213 93
c@213 94 Installation depends on your operating system and (on Windows) whether
c@213 95 you are installing a 32- or 64-bit version of the plugin set.
c@213 96
c@213 97 OS/X -> Copy qm-vamp-plugins.dylib, qm-vamp-plugins.cat and
c@213 98 qm-vamp-plugins.n3 to $HOME/Library/Audio/Plug-Ins/Vamp/
c@213 99 or /Library/Audio/Plug-Ins/Vamp/
c@213 100
c@213 101 Linux -> Copy qm-vamp-plugins.so, qm-vamp-plugins.cat and
c@213 102 qm-vamp-plugins.n3 to $HOME/vamp/ or /usr/local/lib/vamp/
c@213 103 or /usr/lib/vamp/
c@213 104
c@213 105 32-bit Windows with 32-bit plugin set, or
c@213 106 64-bit Windows with 64-bit plugin set
c@213 107 -> Copy qm-vamp-plugins.dll, qm-vamp-plugins.cat and
c@213 108 qm-vamp-plugins.n3 to C:\Program Files\Vamp Plugins\
c@213 109
c@213 110 64-bit Windows with 32-bit plugin set
c@213 111 -> Copy qm-vamp-plugins.dll, qm-vamp-plugins.cat and
c@213 112 qm-vamp-plugins.n3 to C:\Program Files\Vamp Plugins (x86)\
c@213 113