|
c@116
|
1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
|
|
c@116
|
2 /*
|
|
c@116
|
3 Constant-Q library
|
|
c@116
|
4 Copyright (c) 2013-2014 Queen Mary, University of London
|
|
c@116
|
5
|
|
c@116
|
6 Permission is hereby granted, free of charge, to any person
|
|
c@116
|
7 obtaining a copy of this software and associated documentation
|
|
c@116
|
8 files (the "Software"), to deal in the Software without
|
|
c@116
|
9 restriction, including without limitation the rights to use, copy,
|
|
c@116
|
10 modify, merge, publish, distribute, sublicense, and/or sell copies
|
|
c@116
|
11 of the Software, and to permit persons to whom the Software is
|
|
c@116
|
12 furnished to do so, subject to the following conditions:
|
|
c@116
|
13
|
|
c@116
|
14 The above copyright notice and this permission notice shall be
|
|
c@116
|
15 included in all copies or substantial portions of the Software.
|
|
c@116
|
16
|
|
c@116
|
17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
c@116
|
18 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
c@116
|
19 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
c@116
|
20 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
|
|
c@116
|
21 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
|
|
c@116
|
22 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
c@116
|
23 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
c@116
|
24
|
|
c@116
|
25 Except as contained in this notice, the names of the Centre for
|
|
c@116
|
26 Digital Music; Queen Mary, University of London; and Chris Cannam
|
|
c@116
|
27 shall not be used in advertising or otherwise to promote the sale,
|
|
c@116
|
28 use or other dealings in this Software without prior written
|
|
c@116
|
29 authorization.
|
|
c@116
|
30 */
|
|
c@116
|
31
|
|
c@116
|
32 #ifndef CONSTANTQ_H
|
|
c@116
|
33 #define CONSTANTQ_H
|
|
c@116
|
34
|
|
c@116
|
35 #include "CQBase.h"
|
|
c@127
|
36 #include "CQParameters.h"
|
|
c@116
|
37 #include "CQKernel.h"
|
|
c@116
|
38
|
|
c@116
|
39 class Resampler;
|
|
c@116
|
40 class FFTReal;
|
|
c@116
|
41
|
|
c@116
|
42 /**
|
|
c@116
|
43 * Calculate a complex sparse constant-Q representation from
|
|
c@116
|
44 * time-domain input.
|
|
c@116
|
45 *
|
|
c@116
|
46 * For a real (magnitude-only) or interpolated representation, see
|
|
c@116
|
47 * CQSpectrogram.
|
|
c@116
|
48 */
|
|
c@116
|
49 class ConstantQ : public CQBase
|
|
c@116
|
50 {
|
|
c@116
|
51 public:
|
|
c@127
|
52 ConstantQ(CQParameters params);
|
|
c@116
|
53 virtual ~ConstantQ();
|
|
c@116
|
54
|
|
c@116
|
55 virtual double getSampleRate() const { return m_sampleRate; }
|
|
c@116
|
56 virtual int getBinsPerOctave() const { return m_binsPerOctave; }
|
|
c@116
|
57 virtual int getOctaves() const { return m_octaves; }
|
|
c@116
|
58 virtual int getTotalBins() const { return m_octaves * m_binsPerOctave; }
|
|
c@116
|
59 virtual int getColumnHop() const { return m_p.fftHop / m_p.atomsPerFrame; }
|
|
c@116
|
60 virtual int getLatency() const { return m_outputLatency; }
|
|
c@116
|
61 virtual double getMaxFrequency() const { return m_p.maxFrequency; }
|
|
c@116
|
62 virtual double getMinFrequency() const;
|
|
c@116
|
63 virtual double getBinFrequency(int bin) const;
|
|
c@116
|
64
|
|
c@116
|
65 /**
|
|
c@116
|
66 * Given a series of time-domain samples, return a series of
|
|
c@116
|
67 * constant-Q columns. Any samples left over (that did not fit
|
|
c@116
|
68 * into a constant-Q processing block) are saved for the next call
|
|
c@116
|
69 * to process or getRemainingBlocks.
|
|
c@116
|
70 *
|
|
c@116
|
71 * Each column contains a series of constant-Q bin values ordered
|
|
c@116
|
72 * from highest to lowest frequency.
|
|
c@116
|
73 *
|
|
c@116
|
74 * Columns are of variable height: each will contain at least
|
|
c@116
|
75 * getBinsPerOctave() values, because the highest-frequency octave
|
|
c@116
|
76 * is always present, but a second octave (if requested) will
|
|
c@116
|
77 * appear only in alternate columns, a third octave only in every
|
|
c@116
|
78 * fourth column, and so on.
|
|
c@116
|
79 *
|
|
c@116
|
80 * If you need a format in which all columns are of equal height
|
|
c@116
|
81 * and every bin contains a value, use CQInterpolated instead of
|
|
c@116
|
82 * ConstantQ.
|
|
c@116
|
83 */
|
|
c@116
|
84 ComplexBlock process(const RealSequence &);
|
|
c@116
|
85
|
|
c@116
|
86 /**
|
|
c@116
|
87 * Return the remaining constant-Q columns following the end of
|
|
c@116
|
88 * processing. Any buffered input is padded so as to ensure that
|
|
c@116
|
89 * all input provided to process() will have been returned.
|
|
c@116
|
90 */
|
|
c@116
|
91 ComplexBlock getRemainingOutput();
|
|
c@116
|
92
|
|
c@116
|
93 private:
|
|
c@127
|
94 const CQParameters m_inparams;
|
|
c@127
|
95 const double m_sampleRate;
|
|
c@127
|
96 const double m_maxFrequency;
|
|
c@127
|
97 const double m_minFrequency;
|
|
c@127
|
98 const int m_binsPerOctave;
|
|
c@127
|
99
|
|
c@116
|
100 int m_octaves;
|
|
c@116
|
101 CQKernel *m_kernel;
|
|
c@116
|
102 CQKernel::Properties m_p;
|
|
c@116
|
103 int m_bigBlockSize;
|
|
c@116
|
104
|
|
c@116
|
105 std::vector<Resampler *> m_decimators;
|
|
c@116
|
106 std::vector<RealSequence> m_buffers;
|
|
c@116
|
107
|
|
c@116
|
108 int m_outputLatency;
|
|
c@116
|
109
|
|
c@116
|
110 FFTReal *m_fft;
|
|
c@116
|
111
|
|
c@116
|
112 void initialise();
|
|
c@116
|
113 ComplexBlock processOctaveBlock(int octave);
|
|
c@116
|
114 };
|
|
c@116
|
115
|
|
c@116
|
116 #endif
|
|
c@116
|
117
|
