Chris@175: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
Chris@175: 
Chris@175: /*
Chris@175:     Sonic Visualiser
Chris@175:     An audio file viewer and annotation editor.
Chris@175:     Centre for Digital Music, Queen Mary, University of London.
Chris@202:     This file copyright 2006 QMUL.
Chris@175:     
Chris@175:     This program is free software; you can redistribute it and/or
Chris@175:     modify it under the terms of the GNU General Public License as
Chris@175:     published by the Free Software Foundation; either version 2 of the
Chris@175:     License, or (at your option) any later version.  See the file
Chris@175:     COPYING included with this distribution for more information.
Chris@175: */
Chris@175: 
Chris@175: #ifndef _WRITABLE_WAVE_FILE_MODEL_H_
Chris@175: #define _WRITABLE_WAVE_FILE_MODEL_H_
Chris@175: 
Chris@175: #include "WaveFileModel.h"
Chris@175: 
Chris@175: class WavFileWriter;
Chris@175: class WavFileReader;
Chris@175: 
Chris@179: class WritableWaveFileModel : public RangeSummarisableTimeValueModel
Chris@175: {
Chris@175:     Q_OBJECT
Chris@175: 
Chris@175: public:
Chris@175:     WritableWaveFileModel(size_t sampleRate, size_t channels, QString path = "");
Chris@175:     ~WritableWaveFileModel();
Chris@175: 
Chris@188:     /**
Chris@188:      * Call addSamples to append a block of samples to the end of the
Chris@188:      * file.  Caller should also call setCompletion to update the
Chris@188:      * progress of this file, if it has a known end point, and should
Chris@188:      * call setCompletion(100) when the file has been written.
Chris@188:      */
Chris@175:     virtual bool addSamples(float **samples, size_t count);
Chris@175:     
Chris@175:     bool isOK() const;
Chris@175:     bool isReady(int *) const;
Chris@175: 
Chris@188:     virtual void setCompletion(int completion); // percentage
Chris@188:     virtual int getCompletion() const { return m_completion; }
Chris@188: 
Chris@179:     const ZoomConstraint *getZoomConstraint() const {
Chris@179:         static PowerOfSqrtTwoZoomConstraint zc;
Chris@179:         return &zc;
Chris@179:     }
Chris@179: 
Chris@175:     size_t getFrameCount() const;
Chris@175:     size_t getChannelCount() const { return m_channels; }
Chris@175:     size_t getSampleRate() const { return m_sampleRate; }
Chris@175: 
Chris@175:     virtual Model *clone() const;
Chris@175: 
Chris@175:     float getValueMinimum() const { return -1.0f; }
Chris@175:     float getValueMaximum() const { return  1.0f; }
Chris@175: 
Chris@300:     virtual size_t getStartFrame() const { return m_startFrame; }
Chris@300:     virtual size_t getEndFrame() const { return m_startFrame + getFrameCount(); }
Chris@175: 
Chris@300:     void setStartFrame(size_t startFrame);
Chris@175: 
Chris@300:     virtual size_t getData(int channel, size_t start, size_t count,
Chris@300:                            float *buffer) const;
Chris@175: 
Chris@300:     virtual size_t getData(int channel, size_t start, size_t count,
Chris@300:                            double *buffer) const;
Chris@175: 
Chris@363:     virtual size_t getData(size_t fromchannel, size_t tochannel,
Chris@363:                            size_t start, size_t count,
Chris@363:                            float **buffer) const;
Chris@363: 
Chris@377:     virtual size_t getSummaryBlockSize(size_t desired) const;
Chris@377: 
Chris@300:     virtual void getSummaries(size_t channel, size_t start, size_t count,
Chris@300:                               RangeBlock &ranges, size_t &blockSize) const;
Chris@300: 
Chris@300:     virtual Range getSummary(size_t channel, size_t start, size_t count) const;
Chris@175: 
Chris@345:     QString getTypeName() const { return tr("Writable Wave File"); }
Chris@345: 
Chris@175:     virtual void toXml(QTextStream &out,
Chris@175:                        QString indent = "",
Chris@175:                        QString extraAttributes = "") const;
Chris@175: 
Chris@175: protected:
Chris@175:     WaveFileModel *m_model;
Chris@175:     WavFileWriter *m_writer;
Chris@175:     WavFileReader *m_reader;
Chris@175:     size_t m_sampleRate;
Chris@175:     size_t m_channels;
Chris@175:     size_t m_frameCount;
Chris@300:     size_t m_startFrame;
Chris@188:     int m_completion;
Chris@175: };
Chris@175: 
Chris@175: #endif
Chris@175: