lbajardsilogic@0: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
lbajardsilogic@0: 
lbajardsilogic@0: /*
lbajardsilogic@0:     Sonic Visualiser
lbajardsilogic@0:     An audio file viewer and annotation editor.
lbajardsilogic@0:     Centre for Digital Music, Queen Mary, University of London.
lbajardsilogic@0:     This file copyright 2006 Chris Cannam and QMUL.
lbajardsilogic@0:     
lbajardsilogic@0:     This program is free software; you can redistribute it and/or
lbajardsilogic@0:     modify it under the terms of the GNU General Public License as
lbajardsilogic@0:     published by the Free Software Foundation; either version 2 of the
lbajardsilogic@0:     License, or (at your option) any later version.  See the file
lbajardsilogic@0:     COPYING included with this distribution for more information.
lbajardsilogic@0: */
lbajardsilogic@0: 
lbajardsilogic@0: #ifndef _EDITABLE_DENSE_THREE_DIMENSIONAL_MODEL_H_
lbajardsilogic@0: #define _EDITABLE_DENSE_THREE_DIMENSIONAL_MODEL_H_
lbajardsilogic@0: 
lbajardsilogic@0: #include "DenseThreeDimensionalModel.h"
lbajardsilogic@0: 
lbajardsilogic@0: class EditableDenseThreeDimensionalModel : public DenseThreeDimensionalModel
lbajardsilogic@0: {
lbajardsilogic@0:     Q_OBJECT
lbajardsilogic@0: 
lbajardsilogic@0: public:
lbajardsilogic@0:     EditableDenseThreeDimensionalModel(size_t sampleRate,
lbajardsilogic@0: 				       size_t resolution,
lbajardsilogic@0: 				       size_t yBinCount,
lbajardsilogic@0: 				       bool notifyOnAdd = true);
lbajardsilogic@0: 
lbajardsilogic@0:     virtual bool isOK() const;
lbajardsilogic@0: 
lbajardsilogic@0:     virtual size_t getSampleRate() const;
lbajardsilogic@0:     virtual size_t getStartFrame() const;
lbajardsilogic@0:     virtual size_t getEndFrame() const;
lbajardsilogic@0: 
lbajardsilogic@0:     virtual Model *clone() const;
lbajardsilogic@0:     
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Return the number of sample frames covered by each set of bins.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual size_t getResolution() const;
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Set the number of sample frames covered by each set of bins.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual void setResolution(size_t sz);
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Return the number of columns.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual size_t getWidth() const;
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Return the number of bins in each set of bins.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual size_t getHeight() const; 
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Set the number of bins in each set of bins.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual void setHeight(size_t sz);
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Return the minimum value of the value in each bin.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual float getMinimumLevel() const;
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Set the minimum value of the value in a bin.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual void setMinimumLevel(float sz);
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Return the maximum value of the value in each bin.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual float getMaximumLevel() const;
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Set the maximum value of the value in a bin.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual void setMaximumLevel(float sz);
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Return true if there are data available for the given column.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual bool isColumnAvailable(size_t x) const { return x < getWidth(); }
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Get the set of bin values at the given column.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual void getColumn(size_t x, Column &) const;
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Get a single value, from the n'th bin of the given column.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual float getValueAt(size_t x, size_t n) const;
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Set the entire set of bin values at the given column.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual void setColumn(size_t x, const Column &values);
lbajardsilogic@0: 
lbajardsilogic@0:     virtual QString getBinName(size_t n) const;
lbajardsilogic@0:     virtual void setBinName(size_t n, QString);
lbajardsilogic@0:     virtual void setBinNames(std::vector<QString> names);
lbajardsilogic@0: 
lbajardsilogic@0:     virtual void setCompletion(int completion);
lbajardsilogic@0:     virtual int getCompletion() const { return m_completion; }
lbajardsilogic@0: 
lbajardsilogic@0:     virtual void toXml(QTextStream &out,
lbajardsilogic@0:                        QString indent = "",
lbajardsilogic@0:                        QString extraAttributes = "") const;
lbajardsilogic@0: 
lbajardsilogic@0:     virtual QString toXmlString(QString indent = "",
lbajardsilogic@0: 				QString extraAttributes = "") const;
lbajardsilogic@0: 
lbajardsilogic@0: protected:
lbajardsilogic@0:     typedef std::vector<Column> ValueMatrix;
lbajardsilogic@0:     ValueMatrix m_data;
lbajardsilogic@0: 
lbajardsilogic@0:     std::vector<QString> m_binNames;
lbajardsilogic@0: 
lbajardsilogic@0:     size_t m_sampleRate;
lbajardsilogic@0:     size_t m_resolution;
lbajardsilogic@0:     size_t m_yBinCount;
lbajardsilogic@0:     float m_minimum;
lbajardsilogic@0:     float m_maximum;
lbajardsilogic@0:     bool m_haveExtents;
lbajardsilogic@0:     bool m_notifyOnAdd;
lbajardsilogic@0:     long m_sinceLastNotifyMin;
lbajardsilogic@0:     long m_sinceLastNotifyMax;
lbajardsilogic@0:     int m_completion;
lbajardsilogic@0: 
lbajardsilogic@0:     mutable QMutex m_mutex;
lbajardsilogic@0: };
lbajardsilogic@0: 
lbajardsilogic@0: #endif