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.
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 _RANGE_SUMMARISABLE_TIME_VALUE_MODEL_H_
lbajardsilogic@0: #define _RANGE_SUMMARISABLE_TIME_VALUE_MODEL_H_
lbajardsilogic@0: 
lbajardsilogic@0: #include <QObject>
lbajardsilogic@0: 
lbajardsilogic@0: #include "DenseTimeValueModel.h"
lbajardsilogic@0: #include "base/ZoomConstraint.h"
lbajardsilogic@0: 
lbajardsilogic@0: /**
lbajardsilogic@0:  * Base class for models containing dense two-dimensional data (value
lbajardsilogic@0:  * against time) that may be meaningfully represented in a zoomed view
lbajardsilogic@0:  * using min/max range summaries.  Audio waveform data is an obvious
lbajardsilogic@0:  * example: think "peaks and minima" for "ranges".
lbajardsilogic@0:  */
lbajardsilogic@0: 
lbajardsilogic@0: class RangeSummarisableTimeValueModel : public DenseTimeValueModel
lbajardsilogic@0: {
lbajardsilogic@0:     Q_OBJECT
lbajardsilogic@0: 
lbajardsilogic@0: public:
lbajardsilogic@0:     struct Range
lbajardsilogic@0:     {
lbajardsilogic@0:         float min;
lbajardsilogic@0:         float max;
lbajardsilogic@0:         float absmean;
lbajardsilogic@0:         Range()  { min = 0.f, max = 0.f , absmean = 0.f;}
lbajardsilogic@0:         Range(const Range &r) 
lbajardsilogic@0: 			{ min = r.min, max = r.max, absmean = r.absmean; }
lbajardsilogic@0:         Range(float min_, float max_, float absmean_) 
lbajardsilogic@0: 			{ min = min_, max = max_, absmean = absmean_; }
lbajardsilogic@0:     };
lbajardsilogic@0: 
lbajardsilogic@0:     typedef std::vector<Range> RangeBlock;
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Return ranges between the given start and end frames,
lbajardsilogic@0:      * summarised at the given block size.  ((end - start + 1) /
lbajardsilogic@0:      * blockSize) ranges should ideally be returned.
lbajardsilogic@0:      *
lbajardsilogic@0:      * If the given block size is not supported by this model
lbajardsilogic@0:      * (according to its zoom constraint), also modify the blockSize
lbajardsilogic@0:      * parameter so as to return the block size that was actually
lbajardsilogic@0:      * obtained.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual void getRanges(size_t channel, size_t start, size_t end,
lbajardsilogic@0:                            RangeBlock &ranges,
lbajardsilogic@0:                            size_t &blockSize) const = 0;
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Return the range between the given start and end frames,
lbajardsilogic@0:      * summarised at a block size equal to the distance between start
lbajardsilogic@0:      * and end frames.
lbajardsilogic@0:      */
lbajardsilogic@0:     virtual Range getRange(size_t channel, size_t start, size_t end) const = 0;
lbajardsilogic@0: };
lbajardsilogic@0: 
lbajardsilogic@0: #endif
lbajardsilogic@0: