annotate data/model/FFTModel.h @ 1744:b92bdcd4954b by-id

Update FFT model to ById
author Chris Cannam
date Tue, 02 Jul 2019 11:49:28 +0100
parents 78fe29adfd16
children 6d6740b075c3
rev   line source
Chris@152 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
Chris@152 2
Chris@152 3 /*
Chris@152 4 Sonic Visualiser
Chris@152 5 An audio file viewer and annotation editor.
Chris@152 6 Centre for Digital Music, Queen Mary, University of London.
Chris@152 7 This file copyright 2006 Chris Cannam.
Chris@152 8
Chris@152 9 This program is free software; you can redistribute it and/or
Chris@152 10 modify it under the terms of the GNU General Public License as
Chris@152 11 published by the Free Software Foundation; either version 2 of the
Chris@152 12 License, or (at your option) any later version. See the file
Chris@152 13 COPYING included with this distribution for more information.
Chris@152 14 */
Chris@152 15
Chris@1086 16 #ifndef FFT_MODEL_H
Chris@1086 17 #define FFT_MODEL_H
Chris@152 18
Chris@152 19 #include "DenseThreeDimensionalModel.h"
Chris@1090 20 #include "DenseTimeValueModel.h"
Chris@1090 21
Chris@1090 22 #include "base/Window.h"
Chris@152 23
Chris@1270 24 #include <bqfft/FFT.h>
Chris@1326 25 #include <bqvec/Allocators.h>
Chris@1091 26
Chris@275 27 #include <set>
Chris@1091 28 #include <vector>
Chris@1091 29 #include <complex>
Chris@275 30
Chris@254 31 /**
Chris@254 32 * An implementation of DenseThreeDimensionalModel that makes FFT data
Chris@387 33 * derived from a DenseTimeValueModel available as a generic data
Chris@1090 34 * grid.
Chris@254 35 */
Chris@152 36 class FFTModel : public DenseThreeDimensionalModel
Chris@152 37 {
Chris@247 38 Q_OBJECT
Chris@247 39
Chris@1092 40 //!!! threading requirements?
Chris@1092 41 //!!! doubles? since we're not caching much
Chris@1092 42
Chris@152 43 public:
Chris@254 44 /**
Chris@254 45 * Construct an FFT model derived from the given
Chris@254 46 * DenseTimeValueModel, with the given window parameters and FFT
Chris@254 47 * size (which may exceed the window size, for zero-padded FFTs).
Chris@254 48 *
Chris@254 49 * If the model has multiple channels use only the given channel,
Chris@254 50 * unless the channel is -1 in which case merge all available
Chris@254 51 * channels.
Chris@254 52 */
Chris@1744 53 FFTModel(ModelId model, // a DenseTimeValueModel
Chris@152 54 int channel,
Chris@152 55 WindowType windowType,
Chris@929 56 int windowSize,
Chris@929 57 int windowIncrement,
Chris@1090 58 int fftSize);
Chris@152 59 ~FFTModel();
Chris@152 60
Chris@152 61 // DenseThreeDimensionalModel and Model methods:
Chris@152 62 //
Chris@1580 63 int getWidth() const override;
Chris@1580 64 int getHeight() const override;
Chris@1580 65 float getValueAt(int x, int y) const override { return getMagnitudeAt(x, y); }
Chris@1744 66 bool isOK() const override;
Chris@1580 67 sv_frame_t getStartFrame() const override { return 0; }
Chris@1725 68 sv_frame_t getTrueEndFrame() const override {
Chris@1038 69 return sv_frame_t(getWidth()) * getResolution() + getResolution();
Chris@152 70 }
Chris@1744 71 sv_samplerate_t getSampleRate() const override;
Chris@1580 72 int getResolution() const override { return m_windowIncrement; }
Chris@1090 73 virtual int getYBinCount() const { return getHeight(); }
Chris@1580 74 float getMinimumLevel() const override { return 0.f; } // Can't provide
Chris@1580 75 float getMaximumLevel() const override { return 1.f; } // Can't provide
Chris@1580 76 Column getColumn(int x) const override; // magnitudes
Chris@1200 77 virtual Column getPhases(int x) const;
Chris@1580 78 QString getBinName(int n) const override;
Chris@1580 79 bool shouldUseLogValueScale() const override { return true; }
Chris@1744 80 int getCompletion() const override;
Chris@1090 81 virtual QString getError() const { return ""; } //!!!???
Chris@1090 82 virtual sv_frame_t getFillExtent() const { return getEndFrame(); }
Chris@1679 83 QString toDelimitedDataString(QString, DataExportOptions,
Chris@1679 84 sv_frame_t, sv_frame_t) const override {
Chris@1679 85 return "";
Chris@1679 86 }
Chris@152 87
Chris@1090 88 // FFTModel methods:
Chris@1090 89 //
Chris@1090 90 int getChannel() const { return m_channel; }
Chris@1090 91 WindowType getWindowType() const { return m_windowType; }
Chris@1090 92 int getWindowSize() const { return m_windowSize; }
Chris@1090 93 int getWindowIncrement() const { return m_windowIncrement; }
Chris@1090 94 int getFFTSize() const { return m_fftSize; }
Chris@1200 95
Chris@1200 96 //!!! review which of these are ever actually called
Chris@1090 97
Chris@1090 98 float getMagnitudeAt(int x, int y) const;
Chris@1090 99 float getMaximumMagnitudeAt(int x) const;
Chris@1090 100 float getPhaseAt(int x, int y) const;
Chris@1090 101 void getValuesAt(int x, int y, float &real, float &imaginary) const;
Chris@1090 102 bool getMagnitudesAt(int x, float *values, int minbin = 0, int count = 0) const;
Chris@1090 103 bool getPhasesAt(int x, float *values, int minbin = 0, int count = 0) const;
Chris@1090 104 bool getValuesAt(int x, float *reals, float *imaginaries, int minbin = 0, int count = 0) const;
Chris@478 105
Chris@275 106 /**
Chris@275 107 * Calculate an estimated frequency for a stable signal in this
Chris@275 108 * bin, using phase unwrapping. This will be completely wrong if
Chris@275 109 * the signal is not stable here.
Chris@275 110 */
Chris@1045 111 virtual bool estimateStableFrequency(int x, int y, double &frequency);
Chris@275 112
Chris@275 113 enum PeakPickType
Chris@275 114 {
Chris@275 115 AllPeaks, /// Any bin exceeding its immediate neighbours
Chris@275 116 MajorPeaks, /// Peaks picked using sliding median window
Chris@275 117 MajorPitchAdaptivePeaks /// Bigger window for higher frequencies
Chris@275 118 };
Chris@275 119
Chris@929 120 typedef std::set<int> PeakLocationSet; // bin
Chris@1045 121 typedef std::map<int, double> PeakSet; // bin -> freq
Chris@275 122
Chris@275 123 /**
Chris@275 124 * Return locations of peak bins in the range [ymin,ymax]. If
Chris@275 125 * ymax is zero, getHeight()-1 will be used.
Chris@275 126 */
Chris@929 127 virtual PeakLocationSet getPeaks(PeakPickType type, int x,
Chris@1191 128 int ymin = 0, int ymax = 0) const;
Chris@275 129
Chris@275 130 /**
Chris@275 131 * Return locations and estimated stable frequencies of peak bins.
Chris@275 132 */
Chris@929 133 virtual PeakSet getPeakFrequencies(PeakPickType type, int x,
Chris@1191 134 int ymin = 0, int ymax = 0) const;
Chris@273 135
Chris@1580 136 QString getTypeName() const override { return tr("FFT"); }
Chris@345 137
Chris@1744 138 private:
Chris@1744 139 FFTModel(const FFTModel &) =delete;
Chris@1744 140 FFTModel &operator=(const FFTModel &) =delete;
Chris@360 141
Chris@1744 142 const ModelId m_model; // a DenseTimeValueModel
Chris@1090 143 int m_channel;
Chris@1090 144 WindowType m_windowType;
Chris@1090 145 int m_windowSize;
Chris@1090 146 int m_windowIncrement;
Chris@1090 147 int m_fftSize;
Chris@1090 148 Window<float> m_windower;
Chris@1270 149 mutable breakfastquay::FFT m_fft;
Chris@1090 150
Chris@1040 151 int getPeakPickWindowSize(PeakPickType type, sv_samplerate_t sampleRate,
Chris@1576 152 int bin, double &dist) const;
Chris@1091 153
Chris@1091 154 std::pair<sv_frame_t, sv_frame_t> getSourceSampleRange(int column) const {
Chris@1091 155 sv_frame_t startFrame = m_windowIncrement * sv_frame_t(column);
Chris@1091 156 sv_frame_t endFrame = startFrame + m_windowSize;
Chris@1091 157 // Cols are centred on the audio sample (e.g. col 0 is centred at sample 0)
Chris@1091 158 startFrame -= m_windowSize / 2;
Chris@1091 159 endFrame -= m_windowSize / 2;
Chris@1091 160 return { startFrame, endFrame };
Chris@1091 161 }
Chris@1091 162
Chris@1326 163 typedef std::vector<float, breakfastquay::StlAllocator<float>> fvec;
Chris@1326 164 typedef std::vector<std::complex<float>,
Chris@1326 165 breakfastquay::StlAllocator<std::complex<float>>> cvec;
Chris@1326 166
Chris@1371 167 const cvec &getFFTColumn(int column) const; // returns ref for immediate use only
Chris@1326 168 fvec getSourceSamples(int column) const;
Chris@1326 169 fvec getSourceData(std::pair<sv_frame_t, sv_frame_t>) const;
Chris@1326 170 fvec getSourceDataUncached(std::pair<sv_frame_t, sv_frame_t>) const;
Chris@1093 171
Chris@1094 172 struct SavedSourceData {
Chris@1094 173 std::pair<sv_frame_t, sv_frame_t> range;
Chris@1326 174 fvec data;
Chris@1094 175 };
Chris@1094 176 mutable SavedSourceData m_savedData;
Chris@1371 177
Chris@1093 178 struct SavedColumn {
Chris@1093 179 int n;
Chris@1326 180 cvec col;
Chris@1093 181 };
Chris@1371 182 mutable std::vector<SavedColumn> m_cached;
Chris@1371 183 mutable size_t m_cacheWriteIndex;
Chris@1093 184 size_t m_cacheSize;
Chris@152 185 };
Chris@152 186
Chris@152 187 #endif