annotate README.md @ 448:d3b3f07cce2a

Further notes
author Chris Cannam <c.cannam@qmul.ac.uk>
date Thu, 23 May 2019 17:19:31 +0100
parents 20e6297c8394
children d20dafd127b3
rev   line source
c@447 1
c@447 2 QM-DSP library
c@447 3 ==============
c@447 4
c@447 5 This is a C++ library of functions for Digital Signal Processing and
c@447 6 Music Informatics purposes developed at Queen Mary, University of
c@447 7 London.
c@447 8
c@447 9 It is used by [QM Vamp Plugins](http://isophonics.net/QMVampPlugins)
c@447 10 amongst other things.
c@447 11
c@448 12 Despite the assertive name "qm-dsp", it is not "the official QM DSP
c@448 13 library", just one library for DSP that happens to have been written
c@448 14 at QM. It got this name because nothing else was using it at the time.
c@448 15
c@447 16
c@447 17 Compiling the library
c@447 18 ---------------------
c@447 19
c@447 20 - Linux: `make -f build/linux/Makefile.linux64`
c@447 21
c@447 22 - Mac: `make -f build/osx/Makefile.osx`
c@447 23
c@447 24 - Windows (MSVC): Use the project file `build/msvc/QMDSP.vcxproj`
c@447 25
c@447 26 To build and run unit tests as well, add the `test` target to your
c@447 27 Make invocation, e.g. `make -f build/linux/Makefile.linux64
c@447 28 test`. Tests require the Boost library.
c@447 29
c@447 30
c@448 31 Licence
c@447 32 -------
c@447 33
c@447 34 This program is free software; you can redistribute it and/or modify
c@447 35 it under the terms of the GNU General Public License as published by
c@447 36 the Free Software Foundation; either version 2 of the License, or (at
c@447 37 your option) any later version. See the file COPYING included with
c@447 38 this distribution for more information.
c@447 39
c@447 40 This code is Copyright (c) 2006-2019 Queen Mary, University of London,
c@447 41 with the following exceptions:
c@447 42
c@447 43 - `ext/kissfft` - Copyright (c) 2003-2010 Mark Borgerding
c@447 44
c@447 45 - `maths/pca/pca.c` - Fionn Murtagh, from StatLib, used with permission
c@447 46
c@447 47 - `maths/Polyfit.h` - by Allen Miller, David J Taylor and others;
c@447 48 also for Delphi in the the JEDI Math Library, under the Mozilla Public
c@447 49 License
c@447 50
c@447 51 - `thread/BlockAllocator.h` - derived from FSB Allocator by Juha
c@447 52 Nieminen, under a BSD-style license
c@447 53
c@447 54 See individual files for further authorship details.
c@447 55
c@447 56 If you wish to use this code in a proprietary application or product
c@447 57 for which the terms of the GPL are not appropriate, please contact QM
c@447 58 Innovation https://www.qminnovation.co.uk/ for licensing terms.