Chris@147: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
Chris@147: 
Chris@147: /*
Chris@147:     Sonic Visualiser
Chris@147:     An audio file viewer and annotation editor.
Chris@147:     Centre for Digital Music, Queen Mary, University of London.
Chris@147:     This file copyright 2006 Chris Cannam.
Chris@147:     
Chris@147:     This program is free software; you can redistribute it and/or
Chris@147:     modify it under the terms of the GNU General Public License as
Chris@147:     published by the Free Software Foundation; either version 2 of the
Chris@147:     License, or (at your option) any later version.  See the file
Chris@147:     COPYING included with this distribution for more information.
Chris@147: */
Chris@147: 
Chris@147: #ifndef _DENSE_THREE_DIMENSIONAL_MODEL_H_
Chris@147: #define _DENSE_THREE_DIMENSIONAL_MODEL_H_
Chris@147: 
Chris@147: #include "base/Model.h"
Chris@147: #include "base/ZoomConstraint.h"
Chris@147: 
Chris@147: #include <QMutex>
Chris@147: #include <vector>
Chris@147: 
Chris@147: class DenseThreeDimensionalModel : public Model,
Chris@147: 				   virtual public ZoomConstraint,
Chris@147: 				   virtual public QObject
Chris@147: {
Chris@147:     Q_OBJECT
Chris@147: 
Chris@147: public:
Chris@147:     //!!! need to reconcile terminology -- windowSize here, resolution in sparse models
Chris@147:     DenseThreeDimensionalModel(size_t sampleRate,
Chris@147: 			       size_t windowSize,
Chris@147: 			       size_t yBinCount,
Chris@147: 			       bool notifyOnAdd = true);
Chris@147: 
Chris@147:     virtual bool isOK() const;
Chris@147: 
Chris@147:     virtual size_t getSampleRate() const;
Chris@147:     virtual size_t getStartFrame() const;
Chris@147:     virtual size_t getEndFrame() const;
Chris@147: 
Chris@147:     virtual Model *clone() const;
Chris@147:     
Chris@147: 
Chris@147:     /**
Chris@147:      * Return the number of sample frames covered by each set of bins.
Chris@147:      */
Chris@147:     virtual size_t getWindowSize() const;
Chris@147: 
Chris@147:     /**
Chris@147:      * Set the number of sample frames covered by each set of bins.
Chris@147:      */
Chris@147:     virtual void setWindowSize(size_t sz);
Chris@147: 
Chris@147:     /**
Chris@147:      * Return the number of bins in each set of bins.
Chris@147:      */
Chris@147:     virtual size_t getYBinCount() const; 
Chris@147: 
Chris@147:     /**
Chris@147:      * Set the number of bins in each set of bins.
Chris@147:      */
Chris@147:     virtual void setYBinCount(size_t sz);
Chris@147: 
Chris@147:     /**
Chris@147:      * Return the minimum value of the value in each bin.
Chris@147:      */
Chris@147:     virtual float getMinimumLevel() const;
Chris@147: 
Chris@147:     /**
Chris@147:      * Set the minimum value of the value in a bin.
Chris@147:      */
Chris@147:     virtual void setMinimumLevel(float sz);
Chris@147: 
Chris@147:     /**
Chris@147:      * Return the maximum value of the value in each bin.
Chris@147:      */
Chris@147:     virtual float getMaximumLevel() const;
Chris@147: 
Chris@147:     /**
Chris@147:      * Set the maximum value of the value in a bin.
Chris@147:      */
Chris@147:     virtual void setMaximumLevel(float sz);
Chris@147: 
Chris@147:     typedef std::vector<float> BinValueSet;
Chris@147: 
Chris@147:     /**
Chris@147:      * Get the set of bin values at the given sample frame (i.e. the
Chris@147:      * windowStartFrame/getWindowSize()'th set of bins).
Chris@147:      */
Chris@147:     virtual void getBinValues(long windowStartFrame, BinValueSet &result) const;
Chris@147: 
Chris@147:     /**
Chris@147:      * Get a single value, the one at the n'th bin of the set of bins
Chris@147:      * starting at the given sample frame.
Chris@147:      */
Chris@147:     virtual float getBinValue(long windowStartFrame, size_t n) const;
Chris@147: 
Chris@147:     /**
Chris@147:      * Set the entire set of bin values at the given sample frame.
Chris@147:      */
Chris@147:     virtual void setBinValues(long windowStartFrame, const BinValueSet &values);
Chris@147: 
Chris@147:     virtual QString getBinName(size_t n) const;
Chris@147:     virtual void setBinName(size_t n, QString);
Chris@147:     virtual void setBinNames(std::vector<QString> names);
Chris@147: 
Chris@147:     virtual void setCompletion(int completion);
Chris@147:     virtual int getCompletion() const { return m_completion; }
Chris@147: 
Chris@147:     virtual void toXml(QTextStream &out,
Chris@147:                        QString indent = "",
Chris@147:                        QString extraAttributes = "") const;
Chris@147: 
Chris@147:     virtual QString toXmlString(QString indent = "",
Chris@147: 				QString extraAttributes = "") const;
Chris@147: 
Chris@147: protected:
Chris@147:     typedef std::vector<BinValueSet> ValueMatrix;
Chris@147:     ValueMatrix m_data;
Chris@147: 
Chris@147:     std::vector<QString> m_binNames;
Chris@147: 
Chris@147:     size_t m_sampleRate;
Chris@147:     size_t m_windowSize;
Chris@147:     size_t m_yBinCount;
Chris@147:     float m_minimum;
Chris@147:     float m_maximum;
Chris@147:     bool m_notifyOnAdd;
Chris@147:     long m_sinceLastNotifyMin;
Chris@147:     long m_sinceLastNotifyMax;
Chris@147:     int m_completion;
Chris@147: 
Chris@147:     mutable QMutex m_mutex;
Chris@147: };
Chris@147: 
Chris@147: #endif