Class SonicAudioProcessor
- java.lang.Object
-
- com.google.android.exoplayer2.audio.SonicAudioProcessor
-
- All Implemented Interfaces:
AudioProcessor
public final class SonicAudioProcessor extends Object implements AudioProcessor
AnAudioProcessorthat uses the Sonic library to modify audio speed/pitch/sample rate.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.google.android.exoplayer2.audio.AudioProcessor
AudioProcessor.AudioFormat, AudioProcessor.UnhandledAudioFormatException
-
-
Field Summary
Fields Modifier and Type Field Description static intSAMPLE_RATE_NO_CHANGEIndicates that the output sample rate should be the same as the input.-
Fields inherited from interface com.google.android.exoplayer2.audio.AudioProcessor
EMPTY_BUFFER
-
-
Constructor Summary
Constructors Constructor Description SonicAudioProcessor()Creates a new Sonic audio processor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AudioProcessor.AudioFormatconfigure(AudioProcessor.AudioFormat inputAudioFormat)Configures the processor to process input audio with the specified format.voidflush()Clears any buffered data and pending output.longgetMediaDuration(long playoutDuration)Returns the media duration corresponding to the specified playout duration, taking speed adjustment into account.ByteBuffergetOutput()Returns a buffer containing processed output data between its position and limit.booleanisActive()Returns whether the processor is configured and will process input buffers.booleanisEnded()Returns whether this processor will return no more output fromAudioProcessor.getOutput()until it has beenAudioProcessor.flush()ed and more input has been queued.voidqueueEndOfStream()Queues an end of stream signal.voidqueueInput(ByteBuffer inputBuffer)Queues audio data between the position and limit of the inputbufferfor processing.voidreset()Resets the processor to its unconfigured state, releasing any resources.voidsetOutputSampleRateHz(int sampleRateHz)Sets the sample rate for output audio, in Hertz.voidsetPitch(float pitch)Sets the target playback pitch.voidsetSpeed(float speed)Sets the target playback speed.
-
-
-
Field Detail
-
SAMPLE_RATE_NO_CHANGE
public static final int SAMPLE_RATE_NO_CHANGE
Indicates that the output sample rate should be the same as the input.- See Also:
- Constant Field Values
-
-
Method Detail
-
setSpeed
public void setSpeed(float speed)
Sets the target playback speed. This method may only be called after draining data through the processor. The value returned byisActive()may change, and the processor must beflushedbefore queueing more data.- Parameters:
speed- The target factor by which playback should be sped up.
-
setPitch
public void setPitch(float pitch)
Sets the target playback pitch. This method may only be called after draining data through the processor. The value returned byisActive()may change, and the processor must beflushedbefore queueing more data.- Parameters:
pitch- The target pitch.
-
setOutputSampleRateHz
public void setOutputSampleRateHz(int sampleRateHz)
Sets the sample rate for output audio, in Hertz. PassSAMPLE_RATE_NO_CHANGEto output audio at the same sample rate as the input. After calling this method, callconfigure(AudioFormat)to configure the processor with the new sample rate.- Parameters:
sampleRateHz- The sample rate for output audio, in Hertz.- See Also:
configure(AudioFormat)
-
getMediaDuration
public long getMediaDuration(long playoutDuration)
Returns the media duration corresponding to the specified playout duration, taking speed adjustment into account.The scaling performed by this method will use the actual playback speed achieved by the audio processor, on average, since it was last flushed. This may differ very slightly from the target playback speed.
- Parameters:
playoutDuration- The playout duration to scale.- Returns:
- The corresponding media duration, in the same units as
duration.
-
configure
public AudioProcessor.AudioFormat configure(AudioProcessor.AudioFormat inputAudioFormat) throws AudioProcessor.UnhandledAudioFormatException
Description copied from interface:AudioProcessorConfigures the processor to process input audio with the specified format. After calling this method, callAudioProcessor.isActive()to determine whether the audio processor is active. Returns the configured output audio format if this instance is active.After calling this method, it is necessary to
AudioProcessor.flush()the processor to apply the new configuration. Before applying the new configuration, it is safe to queue input and get output in the old input/output formats. CallAudioProcessor.queueEndOfStream()when no more input will be supplied in the old input format.- Specified by:
configurein interfaceAudioProcessor- Parameters:
inputAudioFormat- The format of audio that will be queued after the next call toAudioProcessor.flush().- Returns:
- The configured output audio format if this instance is
active. - Throws:
AudioProcessor.UnhandledAudioFormatException- Thrown if the specified format can't be handled as input.
-
isActive
public boolean isActive()
Description copied from interface:AudioProcessorReturns whether the processor is configured and will process input buffers.- Specified by:
isActivein interfaceAudioProcessor
-
queueInput
public void queueInput(ByteBuffer inputBuffer)
Description copied from interface:AudioProcessorQueues audio data between the position and limit of the inputbufferfor processing.buffermust 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 byAudioProcessor.getOutput().- Specified by:
queueInputin interfaceAudioProcessor- Parameters:
inputBuffer- The input buffer to process.
-
queueEndOfStream
public void queueEndOfStream()
Description copied from interface:AudioProcessorQueues an end of stream signal. After this method has been called,AudioProcessor.queueInput(ByteBuffer)may not be called until after the next call toAudioProcessor.flush(). CallingAudioProcessor.getOutput()will return any remaining output data. Multiple calls may be required to read all of the remaining output data.AudioProcessor.isEnded()will returntrueonce all remaining output data has been read.- Specified by:
queueEndOfStreamin interfaceAudioProcessor
-
getOutput
public ByteBuffer getOutput()
Description copied from interface:AudioProcessorReturns 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:
getOutputin interfaceAudioProcessor- Returns:
- A buffer containing processed output data between its position and limit.
-
isEnded
public boolean isEnded()
Description copied from interface:AudioProcessorReturns whether this processor will return no more output fromAudioProcessor.getOutput()until it has beenAudioProcessor.flush()ed and more input has been queued.- Specified by:
isEndedin interfaceAudioProcessor
-
flush
public void flush()
Description copied from interface:AudioProcessorClears any buffered data and pending output. If the audio processor is active, also prepares the audio processor to receive a new stream of input in the last configured (pending) format.- Specified by:
flushin interfaceAudioProcessor
-
reset
public void reset()
Description copied from interface:AudioProcessorResets the processor to its unconfigured state, releasing any resources.- Specified by:
resetin interfaceAudioProcessor
-
-