Chris@152: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
Chris@152: 
Chris@152: /*
Chris@152:     Sonic Visualiser
Chris@152:     An audio file viewer and annotation editor.
Chris@152:     Centre for Digital Music, Queen Mary, University of London.
Chris@152:     This file copyright 2006 Chris Cannam.
Chris@152:     
Chris@152:     This program is free software; you can redistribute it and/or
Chris@152:     modify it under the terms of the GNU General Public License as
Chris@152:     published by the Free Software Foundation; either version 2 of the
Chris@152:     License, or (at your option) any later version.  See the file
Chris@152:     COPYING included with this distribution for more information.
Chris@152: */
Chris@152: 
Chris@152: #ifndef _FFT_CACHE_H_
Chris@152: #define _FFT_CACHE_H_
Chris@152: 
Chris@152: #include <cstdlib>
Chris@152: #include <cmath>
Chris@152: 
Chris@152: #include <stdint.h>
Chris@152: 
Chris@152: class FFTCache
Chris@152: {
Chris@152: public:
Chris@152:     virtual ~FFTCache() { }
Chris@152: 
Chris@152:     virtual size_t getWidth() const = 0;
Chris@152:     virtual size_t getHeight() const = 0;
Chris@152: 	
Chris@152:     virtual void resize(size_t width, size_t height) = 0;
Chris@152:     virtual void reset() = 0; // zero-fill or 1-fill as appropriate without changing size
Chris@152: 	
Chris@152:     virtual float getMagnitudeAt(size_t x, size_t y) const = 0;
Chris@152:     virtual float getNormalizedMagnitudeAt(size_t x, size_t y) const = 0;
Chris@152:     virtual float getMaximumMagnitudeAt(size_t x) const = 0;
Chris@152:     virtual float getPhaseAt(size_t x, size_t y) const = 0;
Chris@152: 
Chris@152:     virtual void getValuesAt(size_t x, size_t y, float &real, float &imaginary) const = 0;
Chris@152: 
Chris@152:     virtual bool haveSetColumnAt(size_t x) const = 0;
Chris@152: 
Chris@152:     // may modify argument arrays
Chris@152:     virtual void setColumnAt(size_t x, float *mags, float *phases, float factor) = 0;
Chris@152: 
Chris@152:     // may modify argument arrays
Chris@152:     virtual void setColumnAt(size_t x, float *reals, float *imags) = 0;
Chris@152: 
Chris@152:     virtual void suspend() { }
Chris@152: 
Chris@152: protected:
Chris@152:     FFTCache() { }
Chris@152: };
Chris@152: 
Chris@152: 
Chris@152: /**
Chris@152:  * For the in-memory FFT cache, we would like to cache magnitude with
Chris@152:  * enough resolution to have gain applied afterwards and determine
Chris@152:  * whether something is a peak or not, and also cache phase rather
Chris@152:  * than only phase-adjusted frequency so that we don't have to
Chris@152:  * recalculate if switching between phase and magnitude displays.  At
Chris@152:  * the same time, we don't want to take up too much memory.  It's not
Chris@152:  * expected to be accurate enough to be used as input for DSP or
Chris@152:  * resynthesis code.
Chris@152:  *
Chris@152:  * This implies probably 16 bits for a normalized magnitude and at
Chris@152:  * most 16 bits for phase.
Chris@152:  *
Chris@152:  * Each column's magnitudes are expected to be stored normalized
Chris@152:  * to [0,1] with respect to the column, so the normalization
Chris@152:  * factor should be calculated before all values in a column, and
Chris@152:  * set appropriately.
Chris@152:  */
Chris@152: 
Chris@152: class FFTMemoryCache : public FFTCache
Chris@152: {
Chris@152: public:
Chris@152:     FFTMemoryCache(); // of size zero, call resize() before using
Chris@152:     virtual ~FFTMemoryCache();
Chris@152: 	
Chris@152:     virtual size_t getWidth() const { return m_width; }
Chris@152:     virtual size_t getHeight() const { return m_height; }
Chris@152: 	
Chris@152:     virtual void resize(size_t width, size_t height);
Chris@152:     virtual void reset(); // zero-fill or 1-fill as appropriate without changing size
Chris@152:     
Chris@152:     virtual float getMagnitudeAt(size_t x, size_t y) const {
Chris@152:         return getNormalizedMagnitudeAt(x, y) * m_factor[x];
Chris@152:     }
Chris@152:     
Chris@152:     virtual float getNormalizedMagnitudeAt(size_t x, size_t y) const {
Chris@152:         return float(m_magnitude[x][y]) / 65535.0;
Chris@152:     }
Chris@152:     
Chris@152:     virtual float getMaximumMagnitudeAt(size_t x) const {
Chris@152:         return m_factor[x];
Chris@152:     }
Chris@152:     
Chris@152:     virtual float getPhaseAt(size_t x, size_t y) const {
Chris@152:         int16_t i = (int16_t)m_phase[x][y];
Chris@152:         return (float(i) / 32767.0) * M_PI;
Chris@152:     }
Chris@152:     
Chris@152:     virtual void getValuesAt(size_t x, size_t y, float &real, float &imag) const {
Chris@152:         float mag = getMagnitudeAt(x, y);
Chris@152:         float phase = getPhaseAt(x, y);
Chris@152:         real = mag * cosf(phase);
Chris@152:         imag = mag * sinf(phase);
Chris@152:     }
Chris@152: 
Chris@152:     virtual void setNormalizationFactor(size_t x, float factor) {
Chris@152:         if (x < m_width) m_factor[x] = factor;
Chris@152:     }
Chris@152:     
Chris@152:     virtual void setMagnitudeAt(size_t x, size_t y, float mag) {
Chris@152:          // norm factor must already be set
Chris@152:         setNormalizedMagnitudeAt(x, y, mag / m_factor[x]);
Chris@152:     }
Chris@152:     
Chris@152:     virtual void setNormalizedMagnitudeAt(size_t x, size_t y, float norm) {
Chris@152:         if (x < m_width && y < m_height) {
Chris@152:             m_magnitude[x][y] = uint16_t(norm * 65535.0);
Chris@152:         }
Chris@152:     }
Chris@152:     
Chris@152:     virtual void setPhaseAt(size_t x, size_t y, float phase) {
Chris@152:         // phase in range -pi -> pi
Chris@152:         if (x < m_width && y < m_height) {
Chris@152:             m_phase[x][y] = uint16_t(int16_t((phase * 32767) / M_PI));
Chris@152:         }
Chris@152:     }
Chris@152:     
Chris@152:     virtual bool haveSetColumnAt(size_t) const {
Chris@152:         return true;
Chris@152:     }
Chris@152: 
Chris@152:     virtual void setColumnAt(size_t x, float *mags, float *phases, float factor) {
Chris@152:         setNormalizationFactor(x, factor);
Chris@152:         for (size_t y = 0; y < m_height; ++y) {
Chris@152:             setMagnitudeAt(x, y, mags[y]);
Chris@152:             setPhaseAt(x, y, phases[y]);
Chris@152:         }
Chris@152:     }
Chris@152: 
Chris@152:     virtual void setColumnAt(size_t x, float *reals, float *imags);
Chris@152: 
Chris@152: private:
Chris@152:     size_t m_width;
Chris@152:     size_t m_height;
Chris@152:     uint16_t **m_magnitude;
Chris@152:     uint16_t **m_phase;
Chris@152:     float *m_factor;
Chris@152: 
Chris@152:     void resize(uint16_t **&, size_t, size_t);
Chris@152: };
Chris@152: 
Chris@152: #endif