AudioGraphSource.h

Go to the documentation of this file.

/**********************************************************************
 
  Audacity: A Digital Audio Editor
 
  @file AudioGraphSource.h
  @brief abstract producer of sample streams, taking Buffers as external context
 
  Dominic Mazzoni
  Vaughan Johnson
 
  Paul Licameli split from PerTrackEffect.h
 
**********************************************************************/
 
#ifndef __AUDACITY_AUDIO_GRAPH_SOURCE__
#define __AUDACITY_AUDIO_GRAPH_SOURCE__
 
#include <optional>
 
class sampleCount;
 
namespace AudioGraph {
 
class Buffers;
 
class AUDIO_GRAPH_API Source {
public:
   using Buffers = AudioGraph::Buffers;
 
   virtual ~Source();
 
   virtual bool AcceptsBuffers(const Buffers &buffers) const = 0;
   virtual bool AcceptsBlockSize(size_t blockSize) const = 0;
 
 
   virtual std::optional<size_t> Acquire(Buffers &data, size_t bound) = 0;
 
 
   virtual sampleCount Remaining() const = 0;
 
 
   virtual bool Release() = 0;
 
   virtual bool Terminates() const;
};
 
}
#endif