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 CQSPECTROGRAM_H Chris@366: #define CQSPECTROGRAM_H Chris@366: Chris@366: #include "ConstantQ.h" Chris@366: Chris@366: /** Chris@366: * Calculate a dense constant-Q magnitude spectrogram from time-domain Chris@366: * input. The input of each \ref process call is a single frame of Chris@366: * time-domain samples; the output is a series of fixed-height Chris@366: * columns. See \ref process for details. Chris@366: * Chris@366: * If you need the full complex-valued constant-Q output, you must use Chris@366: * the \ref ConstantQ class instead. Chris@366: */ Chris@366: class CQSpectrogram : public CQBase Chris@366: { Chris@366: public: Chris@366: enum Interpolation { Chris@366: /// leave empty cells as zero Chris@366: InterpolateZeros, Chris@366: /// replace empty cells with a repeat of the previous column Chris@366: InterpolateHold, Chris@366: /// perform linear interpolation between consecutive time cells Chris@366: InterpolateLinear, Chris@366: }; Chris@366: Chris@366: /** Chris@366: * Construct a Constant-Q magnitude spectrogram object using the Chris@366: * given transform parameters. Chris@366: */ Chris@366: CQSpectrogram(CQParameters params, Interpolation interpolation); Chris@366: virtual ~CQSpectrogram(); Chris@366: Chris@366: // CQBase methods, see CQBase.h for documentation Chris@366: virtual bool isValid() const { return m_cq.isValid(); } Chris@366: virtual double getSampleRate() const { return m_cq.getSampleRate(); } Chris@366: virtual int getBinsPerOctave() const { return m_cq.getBinsPerOctave(); } Chris@366: virtual int getOctaves() const { return m_cq.getOctaves(); } Chris@366: virtual int getTotalBins() const { return m_cq.getTotalBins(); } Chris@366: virtual int getColumnHop() const { return m_cq.getColumnHop(); } Chris@366: virtual int getLatency() const { return m_cq.getLatency(); } Chris@366: virtual double getMaxFrequency() const { return m_cq.getMaxFrequency(); } Chris@366: virtual double getMinFrequency() const { return m_cq.getMinFrequency(); } Chris@366: virtual double getBinFrequency(double bin) const { return m_cq.getBinFrequency(bin); } Chris@366: Chris@366: /** Chris@366: * Given a series of time-domain samples, return a series of Chris@366: * constant-Q magnitude columns. Any samples left over (that did Chris@366: * not fit into a constant-Q processing block) are saved for the Chris@366: * next call 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 value Chris@366: * magnitudes, ordered from highest to lowest frequency. Chris@366: * Chris@366: * The columns are all of the same height, but they might not all Chris@366: * be populated, depending on the interpolation mode: in Chris@366: * InterpolateZeros mode, the lower octaves (which are spaced more Chris@366: * widely in the raw constant-Q than the highest octave) will Chris@366: * contain zeros for the undefined values, but in the other Chris@366: * interpolation modes every cell will be filled. Chris@366: * Chris@366: * To obtain raw, complex constant-Q bin values, use the ConstantQ Chris@366: * class. Chris@366: */ Chris@366: RealBlock process(const RealSequence &); Chris@366: Chris@366: /** Chris@366: * Return the remaining constant-Q magnitude columns following the Chris@366: * end of processing. Any buffered input is padded so as to ensure Chris@366: * that all input provided to process() will have been returned. Chris@366: */ Chris@366: RealBlock getRemainingOutput(); Chris@366: Chris@366: private: Chris@366: ConstantQ m_cq; Chris@366: Interpolation m_interpolation; Chris@366: Chris@366: RealBlock m_buffer; Chris@366: RealBlock postProcess(const ComplexBlock &, bool insist); Chris@366: RealBlock fetchHold(bool insist); Chris@366: RealBlock fetchLinear(bool insist); Chris@366: RealBlock linearInterpolated(const RealBlock &, int, int); Chris@366: RealColumn m_prevColumn; Chris@366: }; Chris@366: Chris@366: #endif