An AudioSource that takes a PositionableAudioSource and allows it to be played, stopped, started, etc. More...
#include <juce_AudioTransportSource.h>
Public Member Functions | |
AudioTransportSource () | |
Creates an AudioTransportSource. More... | |
~AudioTransportSource () override | |
Destructor. More... | |
void | addChangeListener (ChangeListener *listener) |
Registers a listener to receive change callbacks from this broadcaster. More... | |
void | dispatchPendingMessages () |
If a change message has been sent but not yet dispatched, this will call sendSynchronousChangeMessage() to make the callback immediately. More... | |
double | getCurrentPosition () const |
Returns the position that the next data block will be read from This is a time in seconds. More... | |
float | getGain () const noexcept |
Returns the current gain setting. More... | |
double | getLengthInSeconds () const |
Returns the stream's length in seconds. More... | |
void | getNextAudioBlock (const AudioSourceChannelInfo &) override |
Implementation of the AudioSource method. More... | |
int64 | getNextReadPosition () const override |
Implements the PositionableAudioSource method. More... | |
int64 | getTotalLength () const override |
Implements the PositionableAudioSource method. More... | |
bool | hasStreamFinished () const noexcept |
Returns true if the player has stopped because its input stream ran out of data. More... | |
bool | isLooping () const override |
Implements the PositionableAudioSource method. More... | |
bool | isPlaying () const noexcept |
Returns true if it's currently playing. More... | |
void | prepareToPlay (int samplesPerBlockExpected, double sampleRate) override |
Implementation of the AudioSource method. More... | |
void | releaseResources () override |
Implementation of the AudioSource method. More... | |
void | removeAllChangeListeners () |
Removes all listeners from the list. More... | |
void | removeChangeListener (ChangeListener *listener) |
Unregisters a listener from the list. More... | |
void | sendChangeMessage () |
Causes an asynchronous change message to be sent to all the registered listeners. More... | |
void | sendSynchronousChangeMessage () |
Sends a synchronous change message to all the registered listeners. More... | |
void | setGain (float newGain) noexcept |
Changes the gain to apply to the output. More... | |
virtual void | setLooping (bool shouldLoop) |
Tells the source whether you'd like it to play in a loop. More... | |
void | setNextReadPosition (int64 newPosition) override |
Implements the PositionableAudioSource method. More... | |
void | setPosition (double newPosition) |
Changes the current playback position in the source stream. More... | |
void | 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. More... | |
void | start () |
Starts playing (if a source has been selected). More... | |
void | stop () |
Stops playing. More... | |
Private Member Functions | |
void | callListeners () |
void | releaseMasterResources () |
Private Attributes | |
std::atomic< bool > | anyListeners { false } |
int | blockSize = 128 |
ChangeBroadcasterCallback | broadcastCallback |
BufferingAudioSource * | bufferingSource = nullptr |
CriticalSection | callbackLock |
ListenerList< ChangeListener > | changeListeners |
float | gain = 1.0f |
bool | isPrepared = false |
float | lastGain = 1.0f |
AudioSource * | masterSource = nullptr |
std::atomic< bool > | playing { false } |
PositionableAudioSource * | positionableSource = nullptr |
int | readAheadBufferSize = 0 |
ResamplingAudioSource * | resamplerSource = nullptr |
double | sampleRate = 44100.0 |
PositionableAudioSource * | source = nullptr |
double | sourceSampleRate = 0 |
std::atomic< bool > | stopped { true } |
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.
@tags{Audio}
juce::AudioTransportSource::AudioTransportSource | ( | ) |
Creates an AudioTransportSource.
After creating one of these, use the setSource() method to select an input source.
|
override |
Destructor.
|
inherited |
Registers a listener to receive change callbacks from this broadcaster.
Trying to add a listener that's already on the list will have no effect.
|
privateinherited |
|
inherited |
If a change message has been sent but not yet dispatched, this will call sendSynchronousChangeMessage() to make the callback immediately.
For thread-safety reasons, you must only call this method on the main message thread.
double juce::AudioTransportSource::getCurrentPosition | ( | ) | const |
Returns the position that the next data block will be read from This is a time in seconds.
|
inlinenoexcept |
Returns the current gain setting.
double juce::AudioTransportSource::getLengthInSeconds | ( | ) | const |
Returns the stream's length in seconds.
|
overridevirtual |
Implementation of the AudioSource method.
Implements juce::AudioSource.
|
overridevirtual |
Implements the PositionableAudioSource method.
Implements juce::PositionableAudioSource.
|
overridevirtual |
Implements the PositionableAudioSource method.
Implements juce::PositionableAudioSource.
|
noexcept |
Returns true if the player has stopped because its input stream ran out of data.
|
overridevirtual |
Implements the PositionableAudioSource method.
Implements juce::PositionableAudioSource.
|
inlinenoexcept |
Returns true if it's currently playing.
|
overridevirtual |
Implementation of the AudioSource method.
Implements juce::AudioSource.
|
private |
|
overridevirtual |
Implementation of the AudioSource method.
Implements juce::AudioSource.
|
inherited |
Removes all listeners from the list.
|
inherited |
Unregisters a listener from the list.
If the listener isn't on the list, this won't have any effect.
|
inherited |
Causes an asynchronous change message to be sent to all the registered listeners.
The message will be delivered asynchronously by the main message thread, so this method will return immediately. To call the listeners synchronously use sendSynchronousChangeMessage().
Referenced by juce::SelectedItemSet< SelectableItemType >::changed().
|
inherited |
Sends a synchronous change message to all the registered listeners.
This will immediately call all the listeners that are registered. For thread-safety reasons, you must only call this method on the main message thread.
Referenced by juce::SelectedItemSet< SelectableItemType >::changed().
|
noexcept |
Changes the gain to apply to the output.
newGain | a factor by which to multiply the outgoing samples, so 1.0 = 0dB, 0.5 = -6dB, 2.0 = 6dB, etc. |
|
inlinevirtualinherited |
Tells the source whether you'd like it to play in a loop.
Reimplemented in juce::MemoryAudioSource, and juce::AudioFormatReaderSource.
References juce::ignoreUnused().
|
overridevirtual |
Implements the PositionableAudioSource method.
Implements juce::PositionableAudioSource.
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.
newPosition | the new playback position in seconds |
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.
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 |
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.
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.
|
privateinherited |
|
private |
|
privateinherited |
|
private |
|
private |
|
privateinherited |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |
|
private |