Chris@58: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */ Chris@0: Chris@0: /* Chris@59: Sonic Visualiser Chris@59: An audio file viewer and annotation editor. Chris@59: Centre for Digital Music, Queen Mary, University of London. Chris@59: This file copyright 2006 Chris Cannam. Chris@0: Chris@59: This program is free software; you can redistribute it and/or Chris@59: modify it under the terms of the GNU General Public License as Chris@59: published by the Free Software Foundation; either version 2 of the Chris@59: License, or (at your option) any later version. See the file Chris@59: COPYING included with this distribution for more information. Chris@0: */ Chris@0: Chris@30: #ifndef _SPECTROGRAM_LAYER_H_ Chris@30: #define _SPECTROGRAM_LAYER_H_ Chris@0: Chris@0: #include "base/Layer.h" Chris@0: #include "base/Window.h" Chris@71: #include "base/RealTime.h" Chris@92: #include "base/Thread.h" Chris@0: #include "model/PowerOfSqrtTwoZoomConstraint.h" Chris@0: #include "model/DenseTimeValueModel.h" Chris@0: Chris@0: #include Chris@0: #include Chris@95: #include Chris@95: #include Chris@0: Chris@0: #include Chris@0: Chris@0: class View; Chris@0: class QPainter; Chris@0: class QImage; Chris@0: class QPixmap; Chris@0: class QTimer; Chris@85: class FFTCacheBase; Chris@0: Chris@0: /** Chris@0: * SpectrogramLayer represents waveform data (obtained from a Chris@0: * DenseTimeValueModel) in spectrogram form. Chris@0: */ Chris@0: Chris@0: class SpectrogramLayer : public Layer, Chris@31: public PowerOfSqrtTwoZoomConstraint Chris@0: { Chris@0: Q_OBJECT Chris@0: Chris@0: public: Chris@37: enum Configuration { FullRangeDb, MelodicRange, MelodicPeaks }; Chris@0: Chris@44: SpectrogramLayer(Configuration = FullRangeDb); Chris@0: ~SpectrogramLayer(); Chris@0: Chris@0: virtual const ZoomConstraint *getZoomConstraint() const { return this; } Chris@0: virtual const Model *getModel() const { return m_model; } Chris@44: virtual void paint(View *v, QPainter &paint, QRect rect) const; Chris@0: Chris@44: virtual int getVerticalScaleWidth(View *v, QPainter &) const; Chris@44: virtual void paintVerticalScale(View *v, QPainter &paint, QRect rect) const; Chris@0: Chris@77: virtual bool getCrosshairExtents(View *, QPainter &, QPoint cursorPos, Chris@77: std::vector &extents) const; Chris@77: virtual void paintCrosshairs(View *, QPainter &, QPoint) const; Chris@77: Chris@44: virtual QString getFeatureDescription(View *v, QPoint &) const; Chris@0: Chris@44: virtual bool snapToFeatureFrame(View *v, int &frame, Chris@28: size_t &resolution, Chris@28: SnapType snap) const; Chris@13: Chris@0: void setModel(const DenseTimeValueModel *model); Chris@0: Chris@0: virtual PropertyList getProperties() const; Chris@87: virtual QString getPropertyLabel(const PropertyName &) const; Chris@0: virtual PropertyType getPropertyType(const PropertyName &) const; Chris@0: virtual QString getPropertyGroupName(const PropertyName &) const; Chris@0: virtual int getPropertyRangeAndValue(const PropertyName &, Chris@0: int *min, int *max) const; Chris@0: virtual QString getPropertyValueLabel(const PropertyName &, Chris@0: int value) const; Chris@0: virtual void setProperty(const PropertyName &, int value); Chris@0: Chris@0: /** Chris@0: * Specify the channel to use from the source model. Chris@0: * A value of -1 means to mix all available channels. Chris@0: * The default is channel 0. Chris@0: */ Chris@0: void setChannel(int); Chris@0: int getChannel() const; Chris@0: Chris@0: void setWindowSize(size_t); Chris@0: size_t getWindowSize() const; Chris@0: Chris@97: void setWindowHopLevel(size_t percent); Chris@97: size_t getWindowHopLevel() const; Chris@0: Chris@0: void setWindowType(WindowType type); Chris@0: WindowType getWindowType() const; Chris@0: Chris@0: /** Chris@0: * Set the gain multiplier for sample values in this view prior to Chris@0: * FFT calculation. Chris@0: * Chris@0: * The default is 1.0. Chris@0: */ Chris@0: void setGain(float gain); Chris@0: float getGain() const; Chris@0: Chris@37: /** Chris@37: * Set the threshold for sample values to be shown in the FFT, Chris@37: * in voltage units. Chris@37: * Chris@37: * The default is 0.0. Chris@37: */ Chris@37: void setThreshold(float threshold); Chris@37: float getThreshold() const; Chris@37: Chris@37: void setMinFrequency(size_t); Chris@37: size_t getMinFrequency() const; Chris@37: Chris@0: void setMaxFrequency(size_t); // 0 -> no maximum Chris@0: size_t getMaxFrequency() const; Chris@0: Chris@37: enum ColourScale { Chris@37: LinearColourScale, Chris@37: MeterColourScale, Chris@37: dBColourScale, Chris@37: PhaseColourScale Chris@37: }; Chris@0: Chris@0: /** Chris@0: * Specify the scale for sample levels. See WaveformLayer for Chris@0: * details of meter and dB scaling. The default is dBColourScale. Chris@0: */ Chris@0: void setColourScale(ColourScale); Chris@0: ColourScale getColourScale() const; Chris@0: Chris@35: enum FrequencyScale { Chris@35: LinearFrequencyScale, Chris@35: LogFrequencyScale Chris@35: }; Chris@0: Chris@0: /** Chris@0: * Specify the scale for the y axis. Chris@0: */ Chris@0: void setFrequencyScale(FrequencyScale); Chris@0: FrequencyScale getFrequencyScale() const; Chris@0: Chris@37: enum BinDisplay { Chris@37: AllBins, Chris@37: PeakBins, Chris@37: PeakFrequencies Chris@35: }; Chris@35: Chris@35: /** Chris@35: * Specify the processing of frequency bins for the y axis. Chris@35: */ Chris@37: void setBinDisplay(BinDisplay); Chris@37: BinDisplay getBinDisplay() const; Chris@35: Chris@36: void setNormalizeColumns(bool n); Chris@36: bool getNormalizeColumns() const; Chris@36: Chris@0: enum ColourScheme { DefaultColours, WhiteOnBlack, BlackOnWhite, Chris@71: RedOnBlue, YellowOnBlack, BlueOnBlack, Rainbow }; Chris@0: Chris@0: void setColourScheme(ColourScheme scheme); Chris@0: ColourScheme getColourScheme() const; Chris@0: Chris@9: /** Chris@9: * Specify the colourmap rotation for the colour scale. Chris@9: */ Chris@9: void setColourRotation(int); Chris@9: int getColourRotation() const; Chris@9: Chris@0: virtual VerticalPosition getPreferredFrameCountPosition() const { Chris@0: return PositionTop; Chris@0: } Chris@0: Chris@15: virtual bool isLayerOpaque() const { return true; } Chris@15: Chris@44: float getYForFrequency(View *v, float frequency) const; Chris@44: float getFrequencyForY(View *v, int y) const; Chris@42: Chris@0: virtual int getCompletion() const; Chris@0: Chris@101: virtual bool getValueExtents(float &min, float &max, Chris@101: bool &logarithmic, QString &unit) const; Chris@101: Chris@101: virtual bool getDisplayExtents(float &min, float &max) const; Chris@79: Chris@6: virtual QString toXmlString(QString indent = "", Chris@6: QString extraAttributes = "") const; Chris@6: Chris@11: void setProperties(const QXmlAttributes &attributes); Chris@11: Chris@47: virtual void setLayerDormant(const View *v, bool dormant); Chris@29: Chris@94: virtual bool isLayerScrollable(const View *v) const { return false; } Chris@94: Chris@0: protected slots: Chris@0: void cacheInvalid(); Chris@0: void cacheInvalid(size_t startFrame, size_t endFrame); Chris@0: Chris@0: void fillTimerTimedOut(); Chris@0: Chris@0: protected: Chris@104: typedef float fftsample; Chris@104: Chris@0: const DenseTimeValueModel *m_model; // I do not own this Chris@0: Chris@35: int m_channel; Chris@35: size_t m_windowSize; Chris@35: WindowType m_windowType; Chris@97: size_t m_windowHopLevel; Chris@35: float m_gain; Chris@37: float m_threshold; Chris@35: int m_colourRotation; Chris@37: size_t m_minFrequency; Chris@35: size_t m_maxFrequency; Chris@35: ColourScale m_colourScale; Chris@35: ColourScheme m_colourScheme; Chris@77: QColor m_crosshairColour; Chris@35: FrequencyScale m_frequencyScale; Chris@37: BinDisplay m_binDisplay; Chris@36: bool m_normalizeColumns; Chris@0: Chris@38: enum { NO_VALUE = 0 }; // colour index for unused pixels Chris@38: Chris@86: class ColourMap Chris@86: { Chris@86: public: Chris@86: QColor getColour(unsigned char index) const { Chris@86: return m_colours[index]; Chris@86: } Chris@86: Chris@86: void setColour(unsigned char index, QColor colour) { Chris@86: m_colours[index] = colour; Chris@86: } Chris@86: Chris@86: private: Chris@86: QColor m_colours[256]; Chris@86: }; Chris@86: Chris@86: ColourMap m_colourMap; Chris@85: FFTCacheBase *m_cache; Chris@86: FFTCacheBase *m_writeCache; Chris@31: bool m_cacheInvalid; Chris@31: Chris@92: class CacheFillThread : public Thread Chris@0: { Chris@0: public: Chris@0: CacheFillThread(SpectrogramLayer &layer) : Chris@0: m_layer(layer), m_fillExtent(0) { } Chris@0: Chris@0: size_t getFillExtent() const { return m_fillExtent; } Chris@0: size_t getFillCompletion() const { return m_fillCompletion; } Chris@0: virtual void run(); Chris@0: Chris@0: protected: Chris@0: SpectrogramLayer &m_layer; Chris@0: size_t m_fillExtent; Chris@0: size_t m_fillCompletion; Chris@0: }; Chris@0: Chris@0: void fillCache(); Chris@0: Chris@95: struct PixmapCache Chris@95: { Chris@95: QPixmap pixmap; Chris@95: QRect validArea; Chris@95: long startFrame; Chris@95: size_t zoomLevel; Chris@95: }; Chris@95: typedef std::map ViewPixmapCache; Chris@95: void invalidatePixmapCaches(); Chris@95: void invalidatePixmapCaches(size_t startFrame, size_t endFrame); Chris@95: mutable ViewPixmapCache m_pixmapCaches; Chris@95: mutable QImage m_drawBuffer; Chris@95: Chris@0: QWaitCondition m_condition; Chris@0: mutable QMutex m_mutex; Chris@0: Chris@0: CacheFillThread *m_fillThread; Chris@0: QTimer *m_updateTimer; Chris@44: mutable size_t m_candidateFillStartFrame; Chris@0: size_t m_lastFillExtent; Chris@0: bool m_exiting; Chris@0: Chris@90: void setColourmap(); Chris@90: void rotateColourmap(int distance); Chris@0: Chris@38: void fillCacheColumn(int column, Chris@104: fftsample *inputBuffer, Chris@104: fftwf_complex *outputBuffer, Chris@104: fftwf_plan plan, Chris@9: size_t windowSize, Chris@9: size_t windowIncrement, Chris@86: float *workbuffer, Chris@104: const Window &windower) Chris@0: const; Chris@0: Chris@38: static float calculateFrequency(size_t bin, Chris@38: size_t windowSize, Chris@38: size_t windowIncrement, Chris@38: size_t sampleRate, Chris@38: float previousPhase, Chris@38: float currentPhase, Chris@38: bool &steadyState); Chris@38: Chris@38: unsigned char getDisplayValue(float input) const; Chris@40: float getInputForDisplayValue(unsigned char uc) const; Chris@40: Chris@40: int getColourScaleWidth(QPainter &) const; Chris@40: Chris@40: float getEffectiveMinFrequency() const; Chris@40: float getEffectiveMaxFrequency() const; Chris@38: Chris@0: struct LayerRange { Chris@0: long startFrame; Chris@0: int zoomLevel; Chris@0: size_t modelStart; Chris@0: size_t modelEnd; Chris@0: }; Chris@44: bool getXBinRange(View *v, int x, float &windowMin, float &windowMax) const; Chris@44: bool getYBinRange(View *v, int y, float &freqBinMin, float &freqBinMax) const; Chris@0: Chris@44: bool getYBinSourceRange(View *v, int y, float &freqMin, float &freqMax) const; Chris@44: bool getAdjustedYBinSourceRange(View *v, int x, int y, Chris@35: float &freqMin, float &freqMax, Chris@35: float &adjFreqMin, float &adjFreqMax) const; Chris@44: bool getXBinSourceRange(View *v, int x, RealTime &timeMin, RealTime &timeMax) const; Chris@44: bool getXYBinSourceRange(View *v, int x, int y, float &min, float &max, Chris@38: float &phaseMin, float &phaseMax) const; Chris@0: Chris@0: size_t getWindowIncrement() const { Chris@97: if (m_windowHopLevel == 0) return m_windowSize; Chris@97: else if (m_windowHopLevel == 1) return (m_windowSize * 3) / 4; Chris@97: else return m_windowSize / (1 << (m_windowHopLevel - 1)); Chris@0: } Chris@0: }; Chris@0: Chris@0: #endif