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 _DENSE_THREE_DIMENSIONAL_MODEL_H_
lbajardsilogic@0: #define _DENSE_THREE_DIMENSIONAL_MODEL_H_
lbajardsilogic@0: 
lbajardsilogic@0: #include "Model.h"
lbajardsilogic@0: #include "base/ZoomConstraint.h"
lbajardsilogic@0: 
lbajardsilogic@0: #include <QMutex>
lbajardsilogic@0: #include <vector>
lbajardsilogic@0: 
lbajardsilogic@0: class DenseThreeDimensionalModel : public Model
lbajardsilogic@0: {
lbajardsilogic@0:     Q_OBJECT
lbajardsilogic@0: 
lbajardsilogic@0: public:
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Return the number of sample frames covered by each column of bins.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual size_t getResolution() const = 0;
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Return the number of columns of bins in the model.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual size_t getWidth() const = 0;
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Return the number of bins in each column.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual size_t getHeight() const = 0; 
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Return the minimum permissible value in each bin.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual float getMinimumLevel() const = 0;
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Return the maximum permissible value in each bin.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual float getMaximumLevel() const = 0;
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Return true if there are data available for the given column.
lbajardsilogic@0:      * This should return true only if getColumn(column) would not
lbajardsilogic@0:      * have to do any substantial work to calculate its return values.
lbajardsilogic@0:      * If this function returns false, it may still be possible to
lbajardsilogic@0:      * retrieve the column, but its values may have to be calculated.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual bool isColumnAvailable(size_t column) const = 0;
lbajardsilogic@0: 
lbajardsilogic@0:     typedef std::vector<float> Column;
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Get data from the given column of bin values.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual void getColumn(size_t column, Column &result) const = 0;
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Get the single data point from the n'th bin of the given column.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual float getValueAt(size_t column, size_t n) const = 0;
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Get the name of a given bin (i.e. a label to associate with
lbajardsilogic@0:      * that bin across all columns).
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual QString getBinName(size_t n) const = 0;
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Utility function to query whether a given bin is greater than
lbajardsilogic@0:      * its (vertical) neighbours.
lbajardsilogic@0:      */
lbajardsilogic@0:     bool isLocalPeak(size_t x, size_t y) {
lbajardsilogic@0:         float value = getValueAt(x, y);
lbajardsilogic@0:         if (y > 0 && value < getValueAt(x, y - 1)) return false;
lbajardsilogic@0:         if (y < getHeight() - 1 && value < getValueAt(x, y + 1)) return false;
lbajardsilogic@0:         return true;
lbajardsilogic@0:     }
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Utility function to query whether a given bin is greater than a
lbajardsilogic@0:      * certain threshold.
lbajardsilogic@0:      */
lbajardsilogic@0:     bool isOverThreshold(size_t x, size_t y, float threshold) {
lbajardsilogic@0:         return getValueAt(x, y) > threshold;
lbajardsilogic@0:     }
lbajardsilogic@0: 
lbajardsilogic@0:     virtual int getCompletion() const = 0;
lbajardsilogic@0: 
lbajardsilogic@0: protected:
lbajardsilogic@0:     DenseThreeDimensionalModel() { }
lbajardsilogic@0: };
lbajardsilogic@0: 
lbajardsilogic@0: #endif