BufferingAudioReader Class Reference

An AudioFormatReader that uses a background thread to pre-read data from another reader. More...

Inheritance diagram for BufferingAudioReader:

Public Member Functions

 BufferingAudioReader (AudioFormatReader *sourceReader, TimeSliceThread &timeSliceThread, int samplesToBuffer)
 Creates a reader. More...
 
 ~BufferingAudioReader ()
 
void setReadTimeout (int timeoutMilliseconds) noexcept
 Sets a number of milliseconds that the reader can block for in its readSamples() method before giving up and returning silence. More...
 
bool readSamples (int **destSamples, int numDestChannels, int startOffsetInDestBuffer, int64 startSampleInFile, int numSamples) override
 Subclasses must implement this method to perform the low-level read operation. More...
 
- Public Member Functions inherited from AudioFormatReader
virtual ~AudioFormatReader ()
 Destructor. More...
 
const StringgetFormatName () const noexcept
 Returns a description of what type of format this is. More...
 
bool read (int *const *destSamples, int numDestChannels, int64 startSampleInSource, int numSamplesToRead, bool fillLeftoverChannelsWithCopies)
 Reads samples from the stream. More...
 
void read (AudioSampleBuffer *buffer, int startSampleInDestBuffer, int numSamples, int64 readerStartSample, bool useReaderLeftChan, bool useReaderRightChan)
 Fills a section of an AudioSampleBuffer from this reader. More...
 
virtual void readMaxLevels (int64 startSample, int64 numSamples, Range< float > *results, int numChannelsToRead)
 Finds the highest and lowest sample levels from a section of the audio stream. More...
 
virtual void readMaxLevels (int64 startSample, int64 numSamples, float &lowestLeft, float &highestLeft, float &lowestRight, float &highestRight)
 Finds the highest and lowest sample levels from a section of the audio stream. More...
 
int64 searchForLevel (int64 startSample, int64 numSamplesToSearch, double magnitudeRangeMinimum, double magnitudeRangeMaximum, int minimumConsecutiveSamples)
 Scans the source looking for a sample whose magnitude is in a specified range. More...
 
virtual AudioChannelSet getChannelLayout ()
 Get the channel layout of the audio stream. More...
 

Additional Inherited Members

- Public Attributes inherited from AudioFormatReader
double sampleRate = 0
 The sample-rate of the stream. More...
 
unsigned int bitsPerSample = 0
 The number of bits per sample, e.g. More...
 
int64 lengthInSamples = 0
 The total number of samples in the audio stream. More...
 
unsigned int numChannels = 0
 The total number of channels in the audio stream. More...
 
bool usesFloatingPointData = false
 Indicates whether the data is floating-point or fixed. More...
 
StringPairArray metadataValues
 A set of metadata values that the reader has pulled out of the stream. More...
 
InputStreaminput
 The input stream, for use by subclasses. More...
 
- Protected Member Functions inherited from AudioFormatReader
 AudioFormatReader (InputStream *sourceStream, const String &formatName)
 Creates an AudioFormatReader object. More...
 
- Static Protected Member Functions inherited from AudioFormatReader
static void clearSamplesBeyondAvailableLength (int **destSamples, int numDestChannels, int startOffsetInDestBuffer, int64 startSampleInFile, int &numSamples, int64 fileLengthInSamples)
 Used by AudioFormatReader subclasses to clear any parts of the data blocks that lie beyond the end of their available length. More...
 

Detailed Description

An AudioFormatReader that uses a background thread to pre-read data from another reader.

See also
AudioFormatReader

Constructor & Destructor Documentation

◆ BufferingAudioReader()

BufferingAudioReader::BufferingAudioReader ( AudioFormatReader sourceReader,
TimeSliceThread timeSliceThread,
int  samplesToBuffer 
)

Creates a reader.

Parameters
sourceReaderthe source reader to wrap. This BufferingAudioReader takes ownership of this object and will delete it later when no longer needed
timeSliceThreadthe thread that should be used to do the background reading. Make sure that the thread you supply is running, and won't be deleted while the reader object still exists.
samplesToBufferthe total number of samples to buffer ahead.

◆ ~BufferingAudioReader()

BufferingAudioReader::~BufferingAudioReader ( )

Member Function Documentation

◆ setReadTimeout()

void BufferingAudioReader::setReadTimeout ( int  timeoutMilliseconds)
noexcept

Sets a number of milliseconds that the reader can block for in its readSamples() method before giving up and returning silence.

A value of less that 0 means "wait forever". The default timeout is 0.

◆ readSamples()

bool BufferingAudioReader::readSamples ( int **  destSamples,
int  numDestChannels,
int  startOffsetInDestBuffer,
int64  startSampleInFile,
int  numSamples 
)
overridevirtual

Subclasses must implement this method to perform the low-level read operation.

Callers should use read() instead of calling this directly.

Parameters
destSamplesthe array of destination buffers to fill. Some of these pointers may be null
numDestChannelsthe number of items in the destSamples array. This value is guaranteed not to be greater than the number of channels that this reader object contains
startOffsetInDestBufferthe number of samples from the start of the dest data at which to begin writing
startSampleInFilethe number of samples into the source data at which to begin reading. This value is guaranteed to be >= 0.
numSamplesthe number of samples to read

Implements AudioFormatReader.


The documentation for this class was generated from the following file: