Chris@366: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */ Chris@366: /* Chris@366: Constant-Q library Chris@366: Copyright (c) 2013-2014 Queen Mary, University of London Chris@366: Chris@366: Permission is hereby granted, free of charge, to any person Chris@366: obtaining a copy of this software and associated documentation Chris@366: files (the "Software"), to deal in the Software without Chris@366: restriction, including without limitation the rights to use, copy, Chris@366: modify, merge, publish, distribute, sublicense, and/or sell copies Chris@366: of the Software, and to permit persons to whom the Software is Chris@366: furnished to do so, subject to the following conditions: Chris@366: Chris@366: The above copyright notice and this permission notice shall be Chris@366: included in all copies or substantial portions of the Software. Chris@366: Chris@366: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, Chris@366: EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF Chris@366: MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND Chris@366: NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY Chris@366: CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF Chris@366: CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION Chris@366: WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Chris@366: Chris@366: Except as contained in this notice, the names of the Centre for Chris@366: Digital Music; Queen Mary, University of London; and Chris Cannam Chris@366: shall not be used in advertising or otherwise to promote the sale, Chris@366: use or other dealings in this Software without prior written Chris@366: authorization. Chris@366: */ Chris@366: Chris@366: #ifndef CONSTANTQ_H Chris@366: #define CONSTANTQ_H Chris@366: Chris@366: #include "CQBase.h" Chris@366: #include "CQParameters.h" Chris@366: #include "CQKernel.h" Chris@366: Chris@366: class Resampler; Chris@366: class FFTReal; Chris@366: Chris@366: /** Chris@366: * Calculate a complex sparse constant-Q representation from Chris@366: * time-domain input. The input of each \ref process call is a single Chris@366: * frame of time-domain samples; the output is a series of columns of Chris@366: * varying height. See \ref process for details. Chris@366: * Chris@366: * For a real (magnitude-only) interpolated dense representation, see Chris@366: * CQSpectrogram. Chris@366: */ Chris@366: class ConstantQ : public CQBase Chris@366: { Chris@366: public: Chris@366: /** Chris@366: * Construct a complex Constant-Q transform object using the given Chris@366: * transform parameters. Chris@366: */ Chris@366: ConstantQ(CQParameters params); Chris@366: virtual ~ConstantQ(); Chris@366: Chris@366: // CQBase methods, see CQBase.h for documentation Chris@366: virtual bool isValid() const { return m_kernel && m_kernel->isValid(); } Chris@366: virtual double getSampleRate() const { return m_sampleRate; } Chris@366: virtual int getBinsPerOctave() const { return m_binsPerOctave; } Chris@366: virtual int getOctaves() const { return m_octaves; } Chris@366: virtual int getTotalBins() const { return m_octaves * m_binsPerOctave; } Chris@366: virtual int getColumnHop() const { return m_p.fftHop / m_p.atomsPerFrame; } Chris@366: virtual int getLatency() const { return m_outputLatency; } Chris@366: virtual double getMaxFrequency() const { return m_p.maxFrequency; } Chris@366: virtual double getMinFrequency() const; Chris@366: virtual double getBinFrequency(double bin) const; // bin may be nonintegral Chris@366: Chris@366: /** Chris@366: * Given a series of time-domain samples, return a series of Chris@366: * constant-Q columns. Any samples left over (that did not fit Chris@366: * into a constant-Q processing block) are saved for the next call Chris@366: * to process or getRemainingBlocks. Chris@366: * Chris@366: * The input is assumed to be a single frame of time-domain sample Chris@366: * values, such that consecutive calls to \ref process receive Chris@366: * contiguous frames from the source signal. Each frame may be of Chris@366: * any length in samples. Chris@366: * Chris@366: * Each output column contains a series of constant-Q bin values Chris@366: * ordered from highest to lowest frequency. Chris@366: * Chris@366: * Output columns are of varying height: each will contain at Chris@366: * least getBinsPerOctave() values, because the highest-frequency Chris@366: * octave is always present, but a second octave (if requested) Chris@366: * will appear only in alternate columns, a third octave only in Chris@366: * every fourth column, and so on. Chris@366: * Chris@366: * If you need a format in which all columns are of equal height Chris@366: * and every bin contains a value, use \ref CQSpectrogram instead Chris@366: * of ConstantQ. Chris@366: */ Chris@366: ComplexBlock process(const RealSequence &); Chris@366: Chris@366: /** Chris@366: * Return the remaining constant-Q columns following the end of Chris@366: * processing. Any buffered input is padded so as to ensure that Chris@366: * all input provided to process() will have been returned. Chris@366: */ Chris@366: ComplexBlock getRemainingOutput(); Chris@366: Chris@366: private: Chris@366: const CQParameters m_inparams; Chris@366: const double m_sampleRate; Chris@366: const double m_maxFrequency; Chris@366: const double m_minFrequency; Chris@366: const int m_binsPerOctave; Chris@366: Chris@366: int m_octaves; Chris@366: CQKernel *m_kernel; Chris@366: CQKernel::Properties m_p; Chris@366: int m_bigBlockSize; Chris@366: Chris@366: std::vector m_decimators; Chris@366: std::vector m_buffers; Chris@366: Chris@366: int m_outputLatency; Chris@366: Chris@366: FFTReal *m_fft; Chris@366: Chris@366: void initialise(); Chris@366: ComplexBlock processOctaveBlock(int octave); Chris@366: }; Chris@366: Chris@366: #endif Chris@366: