diff data/model/DenseTimeValueModel.h @ 147:3a13b0d4934e

* Reorganising code base. This revision will not compile.
author Chris Cannam
date Mon, 31 Jul 2006 11:44:37 +0000
parents
children 4b2ea82fd0ed
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/data/model/DenseTimeValueModel.h	Mon Jul 31 11:44:37 2006 +0000
@@ -0,0 +1,76 @@
+/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
+
+/*
+    Sonic Visualiser
+    An audio file viewer and annotation editor.
+    Centre for Digital Music, Queen Mary, University of London.
+    This file copyright 2006 Chris Cannam.
+    
+    This program is free software; you can redistribute it and/or
+    modify it under the terms of the GNU General Public License as
+    published by the Free Software Foundation; either version 2 of the
+    License, or (at your option) any later version.  See the file
+    COPYING included with this distribution for more information.
+*/
+
+#ifndef _DENSE_TIME_VALUE_MODEL_H_
+#define _DENSE_TIME_VALUE_MODEL_H_
+
+#include <QObject>
+
+#include "base/Model.h"
+
+/**
+ * Base class for models containing dense two-dimensional data (value
+ * against time).  For example, audio waveform data.
+ */
+
+class DenseTimeValueModel : public Model,
+			    virtual public QObject
+{
+    Q_OBJECT
+
+public:
+    DenseTimeValueModel();
+
+    /**
+     * Return the minimum possible value found in this model type.
+     * (That is, the minimum that would be valid, not the minimum
+     * actually found in a particular model).
+     */
+    virtual float getValueMinimum() const = 0;
+
+    /**
+     * Return the minimum possible value found in this model type.
+     * (That is, the minimum that would be valid, not the minimum
+     * actually found in a particular model).
+     */
+    virtual float getValueMaximum() const = 0;
+
+    /**
+     * Return the number of distinct channels for this model.
+     */
+    virtual size_t getChannelCount() const = 0;
+
+    /**
+     * Get the specified set of samples from the given channel of the
+     * model in single-precision floating-point format.  Return the
+     * number of samples actually retrieved.
+     * If the channel is given as -1, mix all available channels and
+     * return the result.
+     */
+    virtual size_t getValues(int channel, size_t start, size_t end,
+			     float *buffer) const = 0;
+
+    /**
+     * Get the specified set of samples from the given channel of the
+     * model in double-precision floating-point format.  Return the
+     * number of samples actually retrieved.
+     * If the channel is given as -1, mix all available channels and
+     * return the result.
+     */
+    virtual size_t getValues(int channel, size_t start, size_t end,
+			     double *buffer) const = 0;
+};
+
+#endif