annotate data/model/WritableWaveFileModel.h @ 1077:ec6e7f0f3f5b

Comment
author Chris Cannam
date Wed, 10 Jun 2015 13:09:14 +0100
parents 0fd3661bcfff
children 9f4505ac9072
rev   line source
Chris@175 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
Chris@175 2
Chris@175 3 /*
Chris@175 4 Sonic Visualiser
Chris@175 5 An audio file viewer and annotation editor.
Chris@175 6 Centre for Digital Music, Queen Mary, University of London.
Chris@202 7 This file copyright 2006 QMUL.
Chris@175 8
Chris@175 9 This program is free software; you can redistribute it and/or
Chris@175 10 modify it under the terms of the GNU General Public License as
Chris@175 11 published by the Free Software Foundation; either version 2 of the
Chris@175 12 License, or (at your option) any later version. See the file
Chris@175 13 COPYING included with this distribution for more information.
Chris@175 14 */
Chris@175 15
Chris@175 16 #ifndef _WRITABLE_WAVE_FILE_MODEL_H_
Chris@175 17 #define _WRITABLE_WAVE_FILE_MODEL_H_
Chris@175 18
Chris@175 19 #include "WaveFileModel.h"
Chris@175 20
Chris@175 21 class WavFileWriter;
Chris@175 22 class WavFileReader;
Chris@175 23
Chris@179 24 class WritableWaveFileModel : public RangeSummarisableTimeValueModel
Chris@175 25 {
Chris@175 26 Q_OBJECT
Chris@175 27
Chris@175 28 public:
Chris@1040 29 WritableWaveFileModel(sv_samplerate_t sampleRate, int channels, QString path = "");
Chris@175 30 ~WritableWaveFileModel();
Chris@175 31
Chris@188 32 /**
Chris@188 33 * Call addSamples to append a block of samples to the end of the
Chris@188 34 * file. Caller should also call setCompletion to update the
Chris@188 35 * progress of this file, if it has a known end point, and should
Chris@188 36 * call setCompletion(100) when the file has been written.
Chris@188 37 */
Chris@1038 38 virtual bool addSamples(float **samples, sv_frame_t count);
Chris@175 39
Chris@175 40 bool isOK() const;
Chris@175 41 bool isReady(int *) const;
Chris@175 42
Chris@188 43 virtual void setCompletion(int completion); // percentage
Chris@188 44 virtual int getCompletion() const { return m_completion; }
Chris@188 45
Chris@179 46 const ZoomConstraint *getZoomConstraint() const {
Chris@179 47 static PowerOfSqrtTwoZoomConstraint zc;
Chris@179 48 return &zc;
Chris@179 49 }
Chris@179 50
Chris@1038 51 sv_frame_t getFrameCount() const;
Chris@929 52 int getChannelCount() const { return m_channels; }
Chris@1040 53 sv_samplerate_t getSampleRate() const { return m_sampleRate; }
Chris@175 54
Chris@175 55 float getValueMinimum() const { return -1.0f; }
Chris@175 56 float getValueMaximum() const { return 1.0f; }
Chris@175 57
Chris@1038 58 virtual sv_frame_t getStartFrame() const { return m_startFrame; }
Chris@1038 59 virtual sv_frame_t getEndFrame() const { return m_startFrame + getFrameCount(); }
Chris@175 60
Chris@1038 61 void setStartFrame(sv_frame_t startFrame);
Chris@175 62
Chris@1038 63 virtual sv_frame_t getData(int channel, sv_frame_t start, sv_frame_t count,
Chris@300 64 float *buffer) const;
Chris@175 65
Chris@1038 66 virtual sv_frame_t getData(int channel, sv_frame_t start, sv_frame_t count,
Chris@300 67 double *buffer) const;
Chris@175 68
Chris@1038 69 virtual sv_frame_t getData(int fromchannel, int tochannel,
Chris@1038 70 sv_frame_t start, sv_frame_t count,
Chris@363 71 float **buffer) const;
Chris@363 72
Chris@929 73 virtual int getSummaryBlockSize(int desired) const;
Chris@377 74
Chris@1038 75 virtual void getSummaries(int channel, sv_frame_t start, sv_frame_t count,
Chris@929 76 RangeBlock &ranges, int &blockSize) const;
Chris@300 77
Chris@1038 78 virtual Range getSummary(int channel, sv_frame_t start, sv_frame_t count) const;
Chris@175 79
Chris@345 80 QString getTypeName() const { return tr("Writable Wave File"); }
Chris@345 81
Chris@175 82 virtual void toXml(QTextStream &out,
Chris@175 83 QString indent = "",
Chris@175 84 QString extraAttributes = "") const;
Chris@175 85
Chris@175 86 protected:
Chris@175 87 WaveFileModel *m_model;
Chris@175 88 WavFileWriter *m_writer;
Chris@175 89 WavFileReader *m_reader;
Chris@1040 90 sv_samplerate_t m_sampleRate;
Chris@929 91 int m_channels;
Chris@1038 92 sv_frame_t m_frameCount;
Chris@1038 93 sv_frame_t m_startFrame;
Chris@188 94 int m_completion;
Chris@175 95 };
Chris@175 96
Chris@175 97 #endif
Chris@175 98