com.google.android.exoplayer2.audio

Class TeeAudioProcessor

java.lang.Object

com.google.android.exoplayer2.audio.TeeAudioProcessor

All Implemented Interfaces:

AudioProcessor

public final class TeeAudioProcessor
extends java.lang.Object
implements AudioProcessor

Audio processor that outputs its input unmodified and also outputs its input to a given sink. This is intended to be used for diagnostics and debugging.

This audio processor can be inserted into the audio processor chain to access audio data before/after particular processing steps have been applied. For example, to get audio output after playback speed adjustment and silence skipping have been applied it is necessary to pass a custom DefaultAudioSink.AudioProcessorChain when creating the audio sink, and include this audio processor after all other audio processors.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TeeAudioProcessor.AudioBufferSink A sink for audio buffers handled by the audio processor.
static class	TeeAudioProcessor.WavFileAudioBufferSink A sink for audio buffers that writes output audio as .wav files with a given path prefix.

Nested classes/interfaces inherited from interface com.google.android.exoplayer2.audio.AudioProcessor

AudioProcessor.UnhandledFormatException

Field Summary

Fields inherited from interface com.google.android.exoplayer2.audio.AudioProcessor

EMPTY_BUFFER

Constructor Summary

Constructors

Constructor and Description
TeeAudioProcessor(TeeAudioProcessor.AudioBufferSink audioBufferSink) Creates a new tee audio processor, sending incoming data to the given TeeAudioProcessor.AudioBufferSink.

Method Summary

Modifier and Type	Method and Description
boolean	configure(int sampleRateHz, int channelCount, int encoding) Configures the processor to process input audio with the specified format and returns whether to AudioProcessor.flush() it.
void	flush() Clears any state in preparation for receiving a new stream of input buffers.
java.nio.ByteBuffer	getOutput() Returns a buffer containing processed output data between its position and limit.
int	getOutputChannelCount() Returns the number of audio channels in the data output by the processor.
int	getOutputEncoding() Returns the audio encoding used in the data output by the processor.
int	getOutputSampleRateHz() Returns the sample rate of audio output by the processor, in hertz.
boolean	isActive() Returns whether the processor is configured and will process input buffers.
boolean	isEnded() Returns whether this processor will return no more output from AudioProcessor.getOutput() until it has been AudioProcessor.flush()ed and more input has been queued.
void	queueEndOfStream() Queues an end of stream signal.
void	queueInput(java.nio.ByteBuffer buffer) Queues audio data between the position and limit of the input buffer for processing.
void	reset() Resets the processor to its unconfigured state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TeeAudioProcessor

public TeeAudioProcessor(TeeAudioProcessor.AudioBufferSink audioBufferSink)

Creates a new tee audio processor, sending incoming data to the given TeeAudioProcessor.AudioBufferSink.

Parameters:

audioBufferSink - The audio buffer sink that will receive input queued to this audio processor.

Method Detail

configure

public boolean configure(int sampleRateHz,
                         int channelCount,
                         @C.Encoding
                         int encoding)
                  throws AudioProcessor.UnhandledFormatException

Description copied from interface: AudioProcessor

Configures the processor to process input audio with the specified format and returns whether to AudioProcessor.flush() it. After calling this method, if the processor is active, AudioProcessor.getOutputSampleRateHz(), AudioProcessor.getOutputChannelCount() and AudioProcessor.getOutputEncoding() return its output format.

Specified by:

configure in interface AudioProcessor

Parameters:

sampleRateHz - The sample rate of input audio in Hz.

channelCount - The number of interleaved channels in input audio.

encoding - The encoding of input audio.

Returns:

Whether to AudioProcessor.flush() the processor.

Throws:

AudioProcessor.UnhandledFormatException - Thrown if the specified format can't be handled as input.

isActive

public boolean isActive()

Description copied from interface: AudioProcessor

Returns whether the processor is configured and will process input buffers.

Specified by:

isActive in interface AudioProcessor

getOutputChannelCount

public int getOutputChannelCount()

Description copied from interface: AudioProcessor

Returns the number of audio channels in the data output by the processor. The value may change as a result of calling AudioProcessor.configure(int, int, int) and is undefined if the instance is not active.

Specified by:

getOutputChannelCount in interface AudioProcessor

getOutputEncoding

public int getOutputEncoding()

Description copied from interface: AudioProcessor

Returns the audio encoding used in the data output by the processor. The value may change as a result of calling AudioProcessor.configure(int, int, int) and is undefined if the instance is not active.

Specified by:

getOutputEncoding in interface AudioProcessor

getOutputSampleRateHz

public int getOutputSampleRateHz()

Description copied from interface: AudioProcessor

Returns the sample rate of audio output by the processor, in hertz. The value may change as a result of calling AudioProcessor.configure(int, int, int) and is undefined if the instance is not active.

Specified by:

getOutputSampleRateHz in interface AudioProcessor

queueInput

public void queueInput(java.nio.ByteBuffer buffer)

Description copied from interface: AudioProcessor

Queues audio data between the position and limit of the input buffer for processing. buffer must be a direct byte buffer with native byte order. Its contents are treated as read-only. Its position will be advanced by the number of bytes consumed (which may be zero). The caller retains ownership of the provided buffer. Calling this method invalidates any previous buffer returned by AudioProcessor.getOutput().

Specified by:

queueInput in interface AudioProcessor

Parameters:

buffer - The input buffer to process.

queueEndOfStream

public void queueEndOfStream()

Description copied from interface: AudioProcessor

Queues an end of stream signal. After this method has been called, AudioProcessor.queueInput(ByteBuffer) may not be called until after the next call to AudioProcessor.flush(). Calling AudioProcessor.getOutput() will return any remaining output data. Multiple calls may be required to read all of the remaining output data. AudioProcessor.isEnded() will return true once all remaining output data has been read.

Specified by:

queueEndOfStream in interface AudioProcessor

getOutput

public java.nio.ByteBuffer getOutput()

Description copied from interface: AudioProcessor

Returns a buffer containing processed output data between its position and limit. The buffer will always be a direct byte buffer with native byte order. Calling this method invalidates any previously returned buffer. The buffer will be empty if no output is available.

Specified by:

getOutput in interface AudioProcessor

Returns:

A buffer containing processed output data between its position and limit.

isEnded

public boolean isEnded()

Description copied from interface: AudioProcessor

Returns whether this processor will return no more output from AudioProcessor.getOutput() until it has been AudioProcessor.flush()ed and more input has been queued.

Specified by:

isEnded in interface AudioProcessor

flush

public void flush()

Description copied from interface: AudioProcessor

Clears any state in preparation for receiving a new stream of input buffers.

Specified by:

flush in interface AudioProcessor

reset

public void reset()

Description copied from interface: AudioProcessor

Resets the processor to its unconfigured state.

Specified by:

reset in interface AudioProcessor