Mercurial > hg > svcore

diff data/model/ReadOnlyWaveFileModel.h @ 1522:b7cb203ee344

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merge from branch import-audio-data
author Chris Cannam
date Wed, 12 Sep 2018 15:57:49 +0100
parents b7042aaecebe
children d93e34684da7
line wrap: on
line diff
--- a/data/model/ReadOnlyWaveFileModel.h	Tue Sep 04 11:31:35 2018 +0100
+++ b/data/model/ReadOnlyWaveFileModel.h	Wed Sep 12 15:57:49 2018 +0100
@@ -36,8 +36,20 @@
     Q_OBJECT
 
 public:
+    /**
+     * Construct a WaveFileModel from a source path and optional
+     * resampling target rate
+     */
     ReadOnlyWaveFileModel(FileSource source, sv_samplerate_t targetRate = 0);
+
+    /**
+     * Construct a WaveFileModel from a source path using an existing
+     * AudioFileReader. The model does not take ownership of the
+     * AudioFileReader, which remains managed by the caller and must
+     * outlive the model.
+     */
     ReadOnlyWaveFileModel(FileSource source, AudioFileReader *reader);
+    
     ~ReadOnlyWaveFileModel();
 
     bool isOK() const;