#include <juce_AudioTransportSource.h>

Inheritance diagram for juce::AudioTransportSource:

Public Member Functions
	AudioTransportSource ()
	~AudioTransportSource () override
void	setSource (PositionableAudioSource newSource, int readAheadBufferSize=0, TimeSliceThread readAheadThread=nullptr, double sourceSampleRateToCorrectFor=0.0, int maxNumChannels=2)
void	setPosition (double newPosition)
double	getCurrentPosition () const
double	getLengthInSeconds () const
bool	hasStreamFinished () const noexcept
void	start ()
void	stop ()
bool	isPlaying () const noexcept
void	setGain (float newGain) noexcept
float	getGain () const noexcept
void	prepareToPlay (int samplesPerBlockExpected, double sampleRate) override
void	releaseResources () override
void	getNextAudioBlock (const AudioSourceChannelInfo &) override
void	setNextReadPosition (int64 newPosition) override
int64	getNextReadPosition () const override
int64	getTotalLength () const override
bool	isLooping () const override
Public Member Functions inherited from juce::PositionableAudioSource
	~PositionableAudioSource () override=default
virtual void	setLooping (bool shouldLoop)
Public Member Functions inherited from juce::AudioSource
virtual	~AudioSource ()=default
Public Member Functions inherited from juce::ChangeBroadcaster
	ChangeBroadcaster () noexcept
virtual	~ChangeBroadcaster ()
void	addChangeListener (ChangeListener *listener)
void	removeChangeListener (ChangeListener *listener)
void	removeAllChangeListeners ()
void	sendChangeMessage ()
void	sendSynchronousChangeMessage ()
void	dispatchPendingMessages ()

Private Member Functions
void	releaseMasterResources ()

Private Attributes
PositionableAudioSource *	source = nullptr
ResamplingAudioSource *	resamplerSource = nullptr
BufferingAudioSource *	bufferingSource = nullptr
PositionableAudioSource *	positionableSource = nullptr
AudioSource *	masterSource = nullptr
CriticalSection	callbackLock
float	gain = 1.0f
float	lastGain = 1.0f
std::atomic< bool >	playing { false }
std::atomic< bool >	stopped { true }
double	sampleRate = 44100.0
double	sourceSampleRate = 0
int	blockSize = 128
int	readAheadBufferSize = 0
bool	isPrepared = false

Additional Inherited Members
Protected Member Functions inherited from juce::PositionableAudioSource
	PositionableAudioSource ()=default
Protected Member Functions inherited from juce::AudioSource
	AudioSource ()=default

Detailed Description

An AudioSource that takes a PositionableAudioSource and allows it to be played, stopped, started, etc.

This can also be told use a buffer and background thread to read ahead, and if can correct for different sample-rates.

You may want to use one of these along with an AudioSourcePlayer and AudioIODevice to control playback of an audio file.

See also: AudioSource, AudioSourcePlayer

@tags{Audio}

Constructor & Destructor Documentation

◆ AudioTransportSource()

juce::AudioTransportSource::AudioTransportSource ( )

Creates an AudioTransportSource. After creating one of these, use the setSource() method to select an input source.

◆ ~AudioTransportSource()

juce::AudioTransportSource::~AudioTransportSource ( )

override

Destructor.

Member Function Documentation

◆ getCurrentPosition()

double juce::AudioTransportSource::getCurrentPosition ( ) const

Returns the position that the next data block will be read from This is a time in seconds.

◆ getGain()

float juce::AudioTransportSource::getGain ( ) const

inlinenoexcept

Returns the current gain setting.

See also: setGain

◆ getLengthInSeconds()

double juce::AudioTransportSource::getLengthInSeconds ( ) const

Returns the stream's length in seconds.

◆ getNextAudioBlock()

void juce::AudioTransportSource::getNextAudioBlock ( const AudioSourceChannelInfo & info )

overridevirtual

Implementation of the AudioSource method.

Implements juce::AudioSource.

◆ getNextReadPosition()

int64 juce::AudioTransportSource::getNextReadPosition ( ) const

overridevirtual

Implements the PositionableAudioSource method.

Implements juce::PositionableAudioSource.

◆ getTotalLength()

int64 juce::AudioTransportSource::getTotalLength ( ) const

overridevirtual

Implements the PositionableAudioSource method.

Implements juce::PositionableAudioSource.

◆ hasStreamFinished()

bool juce::AudioTransportSource::hasStreamFinished ( ) const

noexcept

Returns true if the player has stopped because its input stream ran out of data.

◆ isLooping()

bool juce::AudioTransportSource::isLooping ( ) const

overridevirtual

Implements the PositionableAudioSource method.

Implements juce::PositionableAudioSource.

◆ isPlaying()

bool juce::AudioTransportSource::isPlaying ( ) const

inlinenoexcept

Returns true if it's currently playing.

◆ prepareToPlay()

void juce::AudioTransportSource::prepareToPlay	(	int	samplesPerBlockExpected,
		double	sampleRate )

overridevirtual

Implementation of the AudioSource method.

Implements juce::AudioSource.

◆ releaseMasterResources()

void juce::AudioTransportSource::releaseMasterResources ( )

private

◆ releaseResources()

void juce::AudioTransportSource::releaseResources ( )

overridevirtual

Implementation of the AudioSource method.

Implements juce::AudioSource.

◆ setGain()

void juce::AudioTransportSource::setGain ( float newGain )

noexcept

Changes the gain to apply to the output.

Parameters

newGain a factor by which to multiply the outgoing samples, so 1.0 = 0dB, 0.5 = -6dB, 2.0 = 6dB, etc.

◆ setNextReadPosition()

void juce::AudioTransportSource::setNextReadPosition ( int64 newPosition )

overridevirtual

Implements the PositionableAudioSource method.

Implements juce::PositionableAudioSource.

◆ setPosition()

void juce::AudioTransportSource::setPosition ( double newPosition )

Changes the current playback position in the source stream.

The next time the getNextAudioBlock() method is called, this is the time from which it'll read data.

Parameters

newPosition the new playback position in seconds

See also: getCurrentPosition

◆ setSource()

void juce::AudioTransportSource::setSource	(	PositionableAudioSource *	newSource,
		int	readAheadBufferSize = 0,
		TimeSliceThread *	readAheadThread = nullptr,
		double	sourceSampleRateToCorrectFor = 0.0,
		int	maxNumChannels = 2 )

Sets the reader that is being used as the input source.

This will stop playback, reset the position to 0 and change to the new reader.

The source passed in will not be deleted by this object, so must be managed by the caller.

Parameters

newSource	the new input source to use. This may be a nullptr
readAheadBufferSize	a size of buffer to use for reading ahead. If this is zero, no reading ahead will be done; if it's greater than zero, a BufferingAudioSource will be used to do the reading-ahead. If you set a non-zero value here, you'll also need to set the readAheadThread parameter.
readAheadThread	if you set readAheadBufferSize to a non-zero value, then you'll also need to supply this TimeSliceThread object for the background reader to use. The thread object must not be deleted while the AudioTransport source is still using it.
sourceSampleRateToCorrectFor	if this is non-zero, it specifies the sample rate of the source, and playback will be sample-rate adjusted to maintain playback at the correct pitch. If this is 0, no sample-rate adjustment will be performed
maxNumChannels	the maximum number of channels that may need to be played

◆ start()

void juce::AudioTransportSource::start ( )

Starts playing (if a source has been selected).

If it starts playing, this will send a message to any ChangeListeners that are registered with this object.

◆ stop()

void juce::AudioTransportSource::stop ( )

Stops playing.

If it's actually playing, this will send a message to any ChangeListeners that are registered with this object.

Member Data Documentation

◆ blockSize

int juce::AudioTransportSource::blockSize = 128

private

◆ bufferingSource

BufferingAudioSource* juce::AudioTransportSource::bufferingSource = nullptr

private

◆ callbackLock

CriticalSection juce::AudioTransportSource::callbackLock

private

◆ gain

float juce::AudioTransportSource::gain = 1.0f

private

◆ isPrepared

bool juce::AudioTransportSource::isPrepared = false

private

◆ lastGain

float juce::AudioTransportSource::lastGain = 1.0f

private

◆ masterSource

AudioSource* juce::AudioTransportSource::masterSource = nullptr

private

◆ playing

std::atomic<bool> juce::AudioTransportSource::playing { false }

private

◆ positionableSource

PositionableAudioSource* juce::AudioTransportSource::positionableSource = nullptr

private

◆ readAheadBufferSize

int juce::AudioTransportSource::readAheadBufferSize = 0

private

◆ resamplerSource

ResamplingAudioSource* juce::AudioTransportSource::resamplerSource = nullptr

private

◆ sampleRate

double juce::AudioTransportSource::sampleRate = 44100.0

private

◆ source

PositionableAudioSource* juce::AudioTransportSource::source = nullptr

private

◆ sourceSampleRate

double juce::AudioTransportSource::sourceSampleRate = 0

private

◆ stopped

std::atomic<bool> juce::AudioTransportSource::stopped { true }

private

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

/home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_audio_devices/sources/juce_AudioTransportSource.h
/home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_audio_devices/sources/juce_AudioTransportSource.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AudioTransportSource()

◆ ~AudioTransportSource()

Member Function Documentation

◆ getCurrentPosition()

◆ getGain()

◆ getLengthInSeconds()

◆ getNextAudioBlock()

◆ getNextReadPosition()

◆ getTotalLength()

◆ hasStreamFinished()

◆ isLooping()

◆ isPlaying()

◆ prepareToPlay()

◆ releaseMasterResources()

◆ releaseResources()

◆ setGain()

◆ setNextReadPosition()

◆ setPosition()

◆ setSource()

◆ start()

◆ stop()

Member Data Documentation

◆ blockSize

◆ bufferingSource

◆ callbackLock

◆ gain

◆ isPrepared

◆ lastGain

◆ masterSource

◆ playing

◆ positionableSource

◆ readAheadBufferSize

◆ resamplerSource

◆ sampleRate

◆ source

◆ sourceSampleRate

◆ stopped