comparison data/fileio/AudioFileReader.h @ 1313:ff9697592bef 3.0-integration

Add gapless preference to prefs dialog; much work on audio read tests

     Q_OBJECT
 
 public:
     virtual ~AudioFileReader() { }
 
+    /**
+     * Return true if the file was opened successfully and no error
+     * has subsequently occurred.
+     */
     bool isOK() const { return (m_channelCount > 0); }
 
+    /**
+     * If isOK() is false, return an error string.
+     */
     virtual QString getError() const { return ""; }
 
+    /**
+     * Return the number of audio sample frames (i.e. samples per
+     * channel) in the file.
+     */
     sv_frame_t getFrameCount() const { return m_frameCount; }
+
+    /**
+     * Return the number of channels in the file.
+     */
     int getChannelCount() const { return m_channelCount; }
+
+    /**
+     * Return the samplerate at which the file is being read. This is
+     * the rate requested when the file was opened, which may differ
+     * from the native rate of the file (in which case the file will
+     * be resampled as it is read).
+     */
     sv_samplerate_t getSampleRate() const { return m_sampleRate; }
 
-    virtual sv_samplerate_t getNativeRate() const { return m_sampleRate; } // if resampled
+    /**
+     * Return the native samplerate of the file. This will differ from
+     * getSampleRate() if the file is being resampled because it was
+     * requested to open at a different rate from native.
+     */
+    virtual sv_samplerate_t getNativeRate() const { return m_sampleRate; }
 
     /**
      * Return the location of the audio data in the reader (as passed
      * in to the FileSource constructor, for example).
      */

      *
      * The subclass implementations of this function must be
      * thread-safe -- that is, safe to call from multiple threads with
      * different arguments on the same object at the same time.
      */
-    virtual std::vector<float> getInterleavedFrames(sv_frame_t start, sv_frame_t count) const = 0;
+    virtual std::vector<float> getInterleavedFrames(sv_frame_t start,
+                                                    sv_frame_t count) const = 0;
 
     /**
      * Return de-interleaved samples for count frames from index
      * start.  Implemented in this class (it calls
      * getInterleavedFrames and de-interleaves).  The resulting vector
      * will contain getChannelCount() sample blocks of count samples
      * each (or fewer if end of file is reached).
      */
-    virtual std::vector<std::vector<float> > getDeInterleavedFrames(sv_frame_t start, sv_frame_t count) const;
+    virtual std::vector<std::vector<float> > getDeInterleavedFrames(sv_frame_t start,
+                                                                    sv_frame_t count) const;
 
     // only subclasses that do not know exactly how long the audio
     // file is until it's been completely decoded should implement this
     virtual int getDecodeCompletion() const { return 100; } // %