WideSampleSequence.h

Go to the documentation of this file.

/**********************************************************************
 
Audacity: A Digital Audio Editor
 
WideSampleSequence.h
 
Paul Licameli split from SampleFrame.h
 
**********************************************************************/
#ifndef __AUDACITY_WIDE_SAMPLE_SEQUENCE_
#define __AUDACITY_WIDE_SAMPLE_SEQUENCE_
 
#include "AudioGraphChannel.h"
#include "SampleCount.h"
#include "SampleFormat.h"
 
class WideSampleSequence;
 
class MIXER_API WideSampleSequence
   : public AudioGraph::Channel
{
public:
   virtual ~WideSampleSequence();
 
 
   virtual size_t NChannels() const = 0;
 
   virtual float GetChannelGain(int channel) const = 0;
 
 
   bool GetFloats(size_t iChannel, size_t nBuffers,
      float *const buffers[], sampleCount start, size_t len,
      bool backwards = false, fillFormat fill = FillFormat::fillZero,
      bool mayThrow = true, sampleCount* pNumWithinClips = nullptr) const;
 
 
   virtual bool DoGet(
      size_t iChannel, size_t nBuffers, const samplePtr buffers[],
      sampleFormat format, sampleCount start, size_t len, bool backward,
      fillFormat fill = FillFormat::fillZero, bool mayThrow = true,
      // Report how many samples were copied from within clips, rather than
      // filled according to fillFormat; but these were not necessarily one
      // contiguous range.
      sampleCount* pNumWithinClips = nullptr) const = 0;
 
   virtual double GetStartTime() const = 0;
   virtual double GetEndTime() const = 0;
   virtual double GetRate() const = 0;
 
 
   sampleCount TimeToLongSamples(double t0) const;
 
   double LongSamplesToTime(sampleCount pos) const;
 
   double SnapToSample(double t) const;
 
   virtual sampleFormat WidestEffectiveFormat() const = 0;
 
   virtual bool HasTrivialEnvelope() const = 0;
 
 
   virtual void GetEnvelopeValues(
      double* buffer, size_t bufferLen, double t0, bool backwards) const = 0;
};
 
#endif