AudioTrackpublic class AudioTrack extends Object The AudioTrack class manages and plays a single audio resource for Java applications.
It allows streaming of PCM audio buffers to the audio sink for playback. This is
achieved by "pushing" the data to the AudioTrack object using one of the
{@link #write(byte[], int, int)}, {@link #write(short[], int, int)},
and {@link #write(float[], int, int, int)} methods.
An AudioTrack instance can operate under two modes: static or streaming.
In Streaming mode, the application writes a continuous stream of data to the AudioTrack, using
one of the {@code write()} methods. These are blocking and return when the data has been
transferred from the Java layer to the native layer and queued for playback. The streaming
mode is most useful when playing blocks of audio data that for instance are:
- too big to fit in memory because of the duration of the sound to play,
- too big to fit in memory because of the characteristics of the audio data
(high sampling rate, bits per sample ...)
- received or generated while previously queued audio is playing.
The static mode should be chosen when dealing with short sounds that fit in memory and
that need to be played with the smallest latency possible. The static mode will
therefore be preferred for UI and game sounds that are played often, and with the
smallest overhead possible.
Upon creation, an AudioTrack object initializes its associated audio buffer.
The size of this buffer, specified during the construction, determines how long an AudioTrack
can play before running out of data.
For an AudioTrack using the static mode, this size is the maximum size of the sound that can
be played from it.
For the streaming mode, data will be written to the audio sink in chunks of
sizes less than or equal to the total buffer size.
AudioTrack is not final and thus permits subclasses, but such use is not recommended. |
Fields Summary |
---|
private static final float | GAIN_MINMinimum value for a linear gain or auxiliary effect level.
This value must be exactly equal to 0.0f; do not change it. | private static final float | GAIN_MAXMaximum value for a linear gain or auxiliary effect level.
This value must be greater than or equal to 1.0f. | private static final int | SAMPLE_RATE_HZ_MINMinimum value for sample rate | private static final int | SAMPLE_RATE_HZ_MAXMaximum value for sample rate | private static final int | CHANNEL_COUNT_MAXMaximum value for AudioTrack channel count | public static final int | PLAYSTATE_STOPPEDindicates AudioTrack state is stopped | public static final int | PLAYSTATE_PAUSEDindicates AudioTrack state is paused | public static final int | PLAYSTATE_PLAYINGindicates AudioTrack state is playing | public static final int | MODE_STATICCreation mode where audio data is transferred from Java to the native layer
only once before the audio starts playing. | public static final int | MODE_STREAMCreation mode where audio data is streamed from Java to the native layer
as the audio is playing. | public static final int | STATE_UNINITIALIZEDState of an AudioTrack that was not successfully initialized upon creation. | public static final int | STATE_INITIALIZEDState of an AudioTrack that is ready to be used. | public static final int | STATE_NO_STATIC_DATAState of a successfully initialized AudioTrack that uses static data,
but that hasn't received that data yet. | public static final int | SUCCESSDenotes a successful operation. | public static final int | ERRORDenotes a generic operation failure. | public static final int | ERROR_BAD_VALUEDenotes a failure due to the use of an invalid value. | public static final int | ERROR_INVALID_OPERATIONDenotes a failure due to the improper use of a method. | private static final int | ERROR_NATIVESETUP_AUDIOSYSTEM | private static final int | ERROR_NATIVESETUP_INVALIDCHANNELMASK | private static final int | ERROR_NATIVESETUP_INVALIDFORMAT | private static final int | ERROR_NATIVESETUP_INVALIDSTREAMTYPE | private static final int | ERROR_NATIVESETUP_NATIVEINITFAILED | private static final int | NATIVE_EVENT_MARKEREvent id denotes when playback head has reached a previously set marker. | private static final int | NATIVE_EVENT_NEW_POSEvent id denotes when previously set update period has elapsed during playback. | private static final String | TAG | public static final int | WRITE_BLOCKINGThe write mode indicating the write operation will block until all data has been written,
to be used in {@link #write(ByteBuffer, int, int)} | public static final int | WRITE_NON_BLOCKINGThe write mode indicating the write operation will return immediately after
queuing as much audio data for playback as possible without blocking, to be used in
{@link #write(ByteBuffer, int, int)}. | private int | mStateIndicates the state of the AudioTrack instance. | private int | mPlayStateIndicates the play state of the AudioTrack instance. | private final Object | mPlayStateLockLock to make sure mPlayState updates are reflecting the actual state of the object. | private int | mNativeBufferSizeInBytesSizes of the native audio buffer. | private int | mNativeBufferSizeInFrames | private NativeEventHandlerDelegate | mEventHandlerDelegateHandler for events coming from the native code. | private final android.os.Looper | mInitializationLooperLooper associated with the thread that creates the AudioTrack instance. | private int | mSampleRateThe audio data source sampling rate in Hz. | private int | mChannelCountThe number of audio output channels (1 is mono, 2 is stereo). | private int | mChannelsThe audio channel mask. | private int | mStreamTypeThe type of the audio stream to play. See
{@link AudioManager#STREAM_VOICE_CALL}, {@link AudioManager#STREAM_SYSTEM},
{@link AudioManager#STREAM_RING}, {@link AudioManager#STREAM_MUSIC},
{@link AudioManager#STREAM_ALARM}, {@link AudioManager#STREAM_NOTIFICATION}, and
{@link AudioManager#STREAM_DTMF}. | private final AudioAttributes | mAttributes | private int | mDataLoadModeThe way audio is consumed by the audio sink, streaming or static. | private int | mChannelConfigurationThe current audio channel configuration. | private int | mAudioFormatThe encoding of the audio samples. | private int | mSessionIdAudio session ID | private final com.android.internal.app.IAppOpsService | mAppOpsReference to the app-ops service. | private long | mNativeTrackInJavaObjAccessed by native methods: provides access to C++ AudioTrack object. | private long | mJniDataAccessed by native methods: provides access to the JNI data (i.e. resources used by
the native AudioTrack object, but not stored in it). | private static final int | SUPPORTED_OUT_CHANNELS |
Constructors Summary |
---|
public AudioTrack(int streamType, int sampleRateInHz, int channelConfig, int audioFormat, int bufferSizeInBytes, int mode)Class constructor.
this(streamType, sampleRateInHz, channelConfig, audioFormat,
bufferSizeInBytes, mode, AudioSystem.AUDIO_SESSION_ALLOCATE);
| public AudioTrack(int streamType, int sampleRateInHz, int channelConfig, int audioFormat, int bufferSizeInBytes, int mode, int sessionId)Class constructor with audio session. Use this constructor when the AudioTrack must be
attached to a particular audio session. The primary use of the audio session ID is to
associate audio effects to a particular instance of AudioTrack: if an audio session ID
is provided when creating an AudioEffect, this effect will be applied only to audio tracks
and media players in the same session and not to the output mix.
When an AudioTrack is created without specifying a session, it will create its own session
which can be retrieved by calling the {@link #getAudioSessionId()} method.
If a non-zero session ID is provided, this AudioTrack will share effects attached to this
session
with all other media players or audio tracks in the same session, otherwise a new session
will be created for this track if none is supplied.
// mState already == STATE_UNINITIALIZED
this((new AudioAttributes.Builder())
.setLegacyStreamType(streamType)
.build(),
(new AudioFormat.Builder())
.setChannelMask(channelConfig)
.setEncoding(audioFormat)
.setSampleRate(sampleRateInHz)
.build(),
bufferSizeInBytes,
mode, sessionId);
| public AudioTrack(AudioAttributes attributes, AudioFormat format, int bufferSizeInBytes, int mode, int sessionId)Class constructor with {@link AudioAttributes} and {@link AudioFormat}.
// mState already == STATE_UNINITIALIZED
if (attributes == null) {
throw new IllegalArgumentException("Illegal null AudioAttributes");
}
if (format == null) {
throw new IllegalArgumentException("Illegal null AudioFormat");
}
// remember which looper is associated with the AudioTrack instantiation
Looper looper;
if ((looper = Looper.myLooper()) == null) {
looper = Looper.getMainLooper();
}
int rate = 0;
if ((format.getPropertySetMask() & AudioFormat.AUDIO_FORMAT_HAS_PROPERTY_SAMPLE_RATE) != 0)
{
rate = format.getSampleRate();
} else {
rate = AudioSystem.getPrimaryOutputSamplingRate();
if (rate <= 0) {
rate = 44100;
}
}
int channelMask = AudioFormat.CHANNEL_OUT_FRONT_LEFT | AudioFormat.CHANNEL_OUT_FRONT_RIGHT;
if ((format.getPropertySetMask() & AudioFormat.AUDIO_FORMAT_HAS_PROPERTY_CHANNEL_MASK) != 0)
{
channelMask = format.getChannelMask();
}
int encoding = AudioFormat.ENCODING_DEFAULT;
if ((format.getPropertySetMask() & AudioFormat.AUDIO_FORMAT_HAS_PROPERTY_ENCODING) != 0) {
encoding = format.getEncoding();
}
audioParamCheck(rate, channelMask, encoding, mode);
mStreamType = AudioSystem.STREAM_DEFAULT;
audioBuffSizeCheck(bufferSizeInBytes);
mInitializationLooper = looper;
IBinder b = ServiceManager.getService(Context.APP_OPS_SERVICE);
mAppOps = IAppOpsService.Stub.asInterface(b);
mAttributes = (new AudioAttributes.Builder(attributes).build());
if (sessionId < 0) {
throw new IllegalArgumentException("Invalid audio session ID: "+sessionId);
}
int[] session = new int[1];
session[0] = sessionId;
// native initialization
int initResult = native_setup(new WeakReference<AudioTrack>(this), mAttributes,
mSampleRate, mChannels, mAudioFormat,
mNativeBufferSizeInBytes, mDataLoadMode, session);
if (initResult != SUCCESS) {
loge("Error code "+initResult+" when initializing AudioTrack.");
return; // with mState == STATE_UNINITIALIZED
}
mSessionId = session[0];
if (mDataLoadMode == MODE_STATIC) {
mState = STATE_NO_STATIC_DATA;
} else {
mState = STATE_INITIALIZED;
}
|
Methods Summary |
---|
public int | attachAuxEffect(int effectId)Attaches an auxiliary effect to the audio track. A typical auxiliary
effect is a reverberation effect which can be applied on any sound source
that directs a certain amount of its energy to this effect. This amount
is defined by setAuxEffectSendLevel().
{@see #setAuxEffectSendLevel(float)}.
After creating an auxiliary effect (e.g.
{@link android.media.audiofx.EnvironmentalReverb}), retrieve its ID with
{@link android.media.audiofx.AudioEffect#getId()} and use it when calling
this method to attach the audio track to the effect.
To detach the effect from the audio track, call this method with a
null effect id.
if (mState == STATE_UNINITIALIZED) {
return ERROR_INVALID_OPERATION;
}
return native_attachAuxEffect(effectId);
| private void | audioBuffSizeCheck(int audioBufferSize)
// NB: this section is only valid with PCM data.
// To update when supporting compressed formats
int frameSizeInBytes;
if (AudioFormat.isEncodingLinearPcm(mAudioFormat)) {
frameSizeInBytes = mChannelCount
* (AudioFormat.getBytesPerSample(mAudioFormat));
} else {
frameSizeInBytes = 1;
}
if ((audioBufferSize % frameSizeInBytes != 0) || (audioBufferSize < 1)) {
throw new IllegalArgumentException("Invalid audio buffer size.");
}
mNativeBufferSizeInBytes = audioBufferSize;
mNativeBufferSizeInFrames = audioBufferSize / frameSizeInBytes;
| private void | audioParamCheck(int sampleRateInHz, int channelConfig, int audioFormat, int mode)
// Convenience method for the constructor's parameter checks.
// This is where constructor IllegalArgumentException-s are thrown
// postconditions:
// mChannelCount is valid
// mChannels is valid
// mAudioFormat is valid
// mSampleRate is valid
// mDataLoadMode is valid
//--------------
// sample rate, note these values are subject to change
if (sampleRateInHz < SAMPLE_RATE_HZ_MIN || sampleRateInHz > SAMPLE_RATE_HZ_MAX) {
throw new IllegalArgumentException(sampleRateInHz
+ "Hz is not a supported sample rate.");
}
mSampleRate = sampleRateInHz;
//--------------
// channel config
mChannelConfiguration = channelConfig;
switch (channelConfig) {
case AudioFormat.CHANNEL_OUT_DEFAULT: //AudioFormat.CHANNEL_CONFIGURATION_DEFAULT
case AudioFormat.CHANNEL_OUT_MONO:
case AudioFormat.CHANNEL_CONFIGURATION_MONO:
mChannelCount = 1;
mChannels = AudioFormat.CHANNEL_OUT_MONO;
break;
case AudioFormat.CHANNEL_OUT_STEREO:
case AudioFormat.CHANNEL_CONFIGURATION_STEREO:
mChannelCount = 2;
mChannels = AudioFormat.CHANNEL_OUT_STEREO;
break;
default:
if (!isMultichannelConfigSupported(channelConfig)) {
// input channel configuration features unsupported channels
throw new IllegalArgumentException("Unsupported channel configuration.");
}
mChannels = channelConfig;
mChannelCount = Integer.bitCount(channelConfig);
}
//--------------
// audio format
if (audioFormat == AudioFormat.ENCODING_DEFAULT) {
audioFormat = AudioFormat.ENCODING_PCM_16BIT;
}
if (!AudioFormat.isValidEncoding(audioFormat)) {
throw new IllegalArgumentException("Unsupported audio encoding.");
}
mAudioFormat = audioFormat;
//--------------
// audio load mode
if (((mode != MODE_STREAM) && (mode != MODE_STATIC)) ||
((mode != MODE_STREAM) && !AudioFormat.isEncodingLinearPcm(mAudioFormat))) {
throw new IllegalArgumentException("Invalid mode.");
}
mDataLoadMode = mode;
| private static float | clampGainOrLevel(float gainOrLevel)
if (Float.isNaN(gainOrLevel)) {
throw new IllegalArgumentException();
}
if (gainOrLevel < GAIN_MIN) {
gainOrLevel = GAIN_MIN;
} else if (gainOrLevel > GAIN_MAX) {
gainOrLevel = GAIN_MAX;
}
return gainOrLevel;
| protected void | finalize()
native_finalize();
| public void | flush()Flushes the audio data currently queued for playback. Any data that has
not been played back will be discarded. No-op if not stopped or paused,
or if the track's creation mode is not {@link #MODE_STREAM}.
if (mState == STATE_INITIALIZED) {
// flush the data in native layer
native_flush();
}
| public int | getAudioFormat()Returns the configured audio data format. See {@link AudioFormat#ENCODING_PCM_16BIT}
and {@link AudioFormat#ENCODING_PCM_8BIT}.
return mAudioFormat;
| public int | getAudioSessionId()Returns the audio session ID.
return mSessionId;
| public int | getChannelConfiguration()Returns the configured channel configuration.
See {@link AudioFormat#CHANNEL_OUT_MONO}
and {@link AudioFormat#CHANNEL_OUT_STEREO}.
return mChannelConfiguration;
| public int | getChannelCount()Returns the configured number of channels.
return mChannelCount;
| public int | getLatency()Returns this track's estimated latency in milliseconds. This includes the latency due
to AudioTrack buffer size, AudioMixer (if any) and audio hardware driver.
DO NOT UNHIDE. The existing approach for doing A/V sync has too many problems. We need
a better solution.
return native_get_latency();
| public static float | getMaxVolume()Returns the maximum gain value, which is greater than or equal to 1.0.
Gain values greater than the maximum will be clamped to the maximum.
The word "volume" in the API name is historical; this is actually a gain.
expressed as a linear multiplier on sample values, where a maximum value of 1.0
corresponds to a gain of 0 dB (sample values left unmodified).
return GAIN_MAX;
| public static int | getMinBufferSize(int sampleRateInHz, int channelConfig, int audioFormat)Returns the minimum buffer size required for the successful creation of an AudioTrack
object to be created in the {@link #MODE_STREAM} mode. Note that this size doesn't
guarantee a smooth playback under load, and higher values should be chosen according to
the expected frequency at which the buffer will be refilled with additional data to play.
For example, if you intend to dynamically set the source sample rate of an AudioTrack
to a higher value than the initial source sample rate, be sure to configure the buffer size
based on the highest planned sample rate.
int channelCount = 0;
switch(channelConfig) {
case AudioFormat.CHANNEL_OUT_MONO:
case AudioFormat.CHANNEL_CONFIGURATION_MONO:
channelCount = 1;
break;
case AudioFormat.CHANNEL_OUT_STEREO:
case AudioFormat.CHANNEL_CONFIGURATION_STEREO:
channelCount = 2;
break;
default:
if ((channelConfig & SUPPORTED_OUT_CHANNELS) != channelConfig) {
// input channel configuration features unsupported channels
loge("getMinBufferSize(): Invalid channel configuration.");
return ERROR_BAD_VALUE;
} else {
channelCount = Integer.bitCount(channelConfig);
}
}
if (!AudioFormat.isValidEncoding(audioFormat)) {
loge("getMinBufferSize(): Invalid audio format.");
return ERROR_BAD_VALUE;
}
// sample rate, note these values are subject to change
if ( (sampleRateInHz < SAMPLE_RATE_HZ_MIN) || (sampleRateInHz > SAMPLE_RATE_HZ_MAX) ) {
loge("getMinBufferSize(): " + sampleRateInHz + " Hz is not a supported sample rate.");
return ERROR_BAD_VALUE;
}
int size = native_get_min_buff_size(sampleRateInHz, channelCount, audioFormat);
if (size <= 0) {
loge("getMinBufferSize(): error querying hardware");
return ERROR;
}
else {
return size;
}
| public static float | getMinVolume()Returns the minimum gain value, which is the constant 0.0.
Gain values less than 0.0 will be clamped to 0.0.
The word "volume" in the API name is historical; this is actually a linear gain.
return GAIN_MIN;
| protected int | getNativeFrameCount()Returns the "native frame count", derived from the bufferSizeInBytes specified at
creation time and converted to frame units.
If track's creation mode is {@link #MODE_STATIC},
it is equal to the specified bufferSizeInBytes converted to frame units.
If track's creation mode is {@link #MODE_STREAM},
it is typically greater than or equal to the specified bufferSizeInBytes converted to frame
units; it may be rounded up to a larger value if needed by the target device implementation.
return native_get_native_frame_count();
| public static int | getNativeOutputSampleRate(int streamType)Returns the output sample rate in Hz for the specified stream type.
return native_get_output_sample_rate(streamType);
| public int | getNotificationMarkerPosition()Returns marker position expressed in frames.
return native_get_marker_pos();
| public int | getPlayState()Returns the playback state of the AudioTrack instance.
synchronized (mPlayStateLock) {
return mPlayState;
}
| public int | getPlaybackHeadPosition()Returns the playback head position expressed in frames.
Though the "int" type is signed 32-bits, the value should be reinterpreted as if it is
unsigned 32-bits. That is, the next position after 0x7FFFFFFF is (int) 0x80000000.
This is a continuously advancing counter. It will wrap (overflow) periodically,
for example approximately once every 27:03:11 hours:minutes:seconds at 44.1 kHz.
It is reset to zero by flush(), reload(), and stop().
return native_get_position();
| public int | getPlaybackRate()Returns the current playback rate in Hz.
return native_get_playback_rate();
| public int | getPositionNotificationPeriod()Returns the notification update period expressed in frames.
Zero means that no position update notifications are being delivered.
return native_get_pos_update_period();
| public int | getSampleRate()Returns the configured audio data sample rate in Hz
return mSampleRate;
| public int | getState()Returns the state of the AudioTrack instance. This is useful after the
AudioTrack instance has been created to check if it was initialized
properly. This ensures that the appropriate resources have been acquired.
return mState;
| public int | getStreamType()Returns the type of audio stream this AudioTrack is configured for.
Compare the result against {@link AudioManager#STREAM_VOICE_CALL},
{@link AudioManager#STREAM_SYSTEM}, {@link AudioManager#STREAM_RING},
{@link AudioManager#STREAM_MUSIC}, {@link AudioManager#STREAM_ALARM},
{@link AudioManager#STREAM_NOTIFICATION}, or {@link AudioManager#STREAM_DTMF}.
return mStreamType;
| public boolean | getTimestamp(AudioTimestamp timestamp)Poll for a timestamp on demand.
If you need to track timestamps during initial warmup or after a routing or mode change,
you should request a new timestamp once per second until the reported timestamps
show that the audio clock is stable.
Thereafter, query for a new timestamp approximately once every 10 seconds to once per minute.
Calling this method more often is inefficient.
It is also counter-productive to call this method more often than recommended,
because the short-term differences between successive timestamp reports are not meaningful.
If you need a high-resolution mapping between frame position and presentation time,
consider implementing that at application level, based on low-resolution timestamps.
The audio data at the returned position may either already have been
presented, or may have not yet been presented but is committed to be presented.
It is not possible to request the time corresponding to a particular position,
or to request the (fractional) position corresponding to a particular time.
If you need such features, consider implementing them at application level.
if (timestamp == null) {
throw new IllegalArgumentException();
}
// It's unfortunate, but we have to either create garbage every time or use synchronized
long[] longArray = new long[2];
int ret = native_get_timestamp(longArray);
if (ret != SUCCESS) {
return false;
}
timestamp.framePosition = longArray[0];
timestamp.nanoTime = longArray[1];
return true;
| private static boolean | isMultichannelConfigSupported(int channelConfig)Convenience method to check that the channel configuration (a.k.a channel mask) is supported
// check for unsupported channels
if ((channelConfig & SUPPORTED_OUT_CHANNELS) != channelConfig) {
loge("Channel configuration features unsupported channels");
return false;
}
final int channelCount = Integer.bitCount(channelConfig);
if (channelCount > CHANNEL_COUNT_MAX) {
loge("Channel configuration contains too many channels " +
channelCount + ">" + CHANNEL_COUNT_MAX);
return false;
}
// check for unsupported multichannel combinations:
// - FL/FR must be present
// - L/R channels must be paired (e.g. no single L channel)
final int frontPair =
AudioFormat.CHANNEL_OUT_FRONT_LEFT | AudioFormat.CHANNEL_OUT_FRONT_RIGHT;
if ((channelConfig & frontPair) != frontPair) {
loge("Front channels must be present in multichannel configurations");
return false;
}
final int backPair =
AudioFormat.CHANNEL_OUT_BACK_LEFT | AudioFormat.CHANNEL_OUT_BACK_RIGHT;
if ((channelConfig & backPair) != 0) {
if ((channelConfig & backPair) != backPair) {
loge("Rear channels can't be used independently");
return false;
}
}
final int sidePair =
AudioFormat.CHANNEL_OUT_SIDE_LEFT | AudioFormat.CHANNEL_OUT_SIDE_RIGHT;
if ((channelConfig & sidePair) != 0
&& (channelConfig & sidePair) != sidePair) {
loge("Side channels can't be used independently");
return false;
}
return true;
| private boolean | isRestricted()
try {
final int usage = AudioAttributes.usageForLegacyStreamType(mStreamType);
final int mode = mAppOps.checkAudioOperation(AppOpsManager.OP_PLAY_AUDIO, usage,
Process.myUid(), ActivityThread.currentPackageName());
return mode != AppOpsManager.MODE_ALLOWED;
} catch (RemoteException e) {
return false;
}
| private static void | logd(java.lang.String msg)
Log.d(TAG, msg);
| private static void | loge(java.lang.String msg)
Log.e(TAG, msg);
| private final native int | native_attachAuxEffect(int effectId)
| private final native void | native_finalize()
| private final native void | native_flush()
| private final native int | native_get_latency()
| private final native int | native_get_marker_pos()
| private static final native int | native_get_min_buff_size(int sampleRateInHz, int channelConfig, int audioFormat)
| private final native int | native_get_native_frame_count()
| private static final native int | native_get_output_sample_rate(int streamType)
| private final native int | native_get_playback_rate()
| private final native int | native_get_pos_update_period()
| private final native int | native_get_position()
| private final native int | native_get_timestamp(long[] longArray)
| private final native void | native_pause()
| private final native void | native_release()
| private final native int | native_reload_static()
| private final native int | native_setAuxEffectSendLevel(float level)
| private final native void | native_setVolume(float leftVolume, float rightVolume)
| private final native int | native_set_loop(int start, int end, int loopCount)
| private final native int | native_set_marker_pos(int marker)
| private final native int | native_set_playback_rate(int sampleRateInHz)
| private final native int | native_set_pos_update_period(int updatePeriod)
| private final native int | native_set_position(int position)
| private final native int | native_setup(java.lang.Object audiotrack_this, java.lang.Object attributes, int sampleRate, int channelMask, int audioFormat, int buffSizeInBytes, int mode, int[] sessionId)
| private final native void | native_start()
| private final native void | native_stop()
| private final native int | native_write_byte(byte[] audioData, int offsetInBytes, int sizeInBytes, int format, boolean isBlocking)
| private final native int | native_write_float(float[] audioData, int offsetInFloats, int sizeInFloats, int format, boolean isBlocking)
| private final native int | native_write_native_bytes(java.lang.Object audioData, int positionInBytes, int sizeInBytes, int format, boolean blocking)
| private final native int | native_write_short(short[] audioData, int offsetInShorts, int sizeInShorts, int format)
| public void | pause()Pauses the playback of the audio data. Data that has not been played
back will not be discarded. Subsequent calls to {@link #play} will play
this data back. See {@link #flush()} to discard this data.
if (mState != STATE_INITIALIZED) {
throw new IllegalStateException("pause() called on uninitialized AudioTrack.");
}
//logd("pause()");
// pause playback
synchronized(mPlayStateLock) {
native_pause();
mPlayState = PLAYSTATE_PAUSED;
}
| public void | play()Starts playing an AudioTrack.
If track's creation mode is {@link #MODE_STATIC}, you must have called write() prior.
if (mState != STATE_INITIALIZED) {
throw new IllegalStateException("play() called on uninitialized AudioTrack.");
}
if (isRestricted()) {
setVolume(0);
}
synchronized(mPlayStateLock) {
native_start();
mPlayState = PLAYSTATE_PLAYING;
}
| private static void | postEventFromNative(java.lang.Object audiotrack_ref, int what, int arg1, int arg2, java.lang.Object obj)
//logd("Event posted from the native side: event="+ what + " args="+ arg1+" "+arg2);
AudioTrack track = (AudioTrack)((WeakReference)audiotrack_ref).get();
if (track == null) {
return;
}
NativeEventHandlerDelegate delegate = track.mEventHandlerDelegate;
if (delegate != null) {
Handler handler = delegate.getHandler();
if (handler != null) {
Message m = handler.obtainMessage(what, arg1, arg2, obj);
handler.sendMessage(m);
}
}
| public void | release()Releases the native AudioTrack resources.
// even though native_release() stops the native AudioTrack, we need to stop
// AudioTrack subclasses too.
try {
stop();
} catch(IllegalStateException ise) {
// don't raise an exception, we're releasing the resources.
}
native_release();
mState = STATE_UNINITIALIZED;
| public int | reloadStaticData()Notifies the native resource to reuse the audio data already loaded in the native
layer, that is to rewind to start of buffer.
The track's creation mode must be {@link #MODE_STATIC}.
if (mDataLoadMode == MODE_STREAM || mState != STATE_INITIALIZED) {
return ERROR_INVALID_OPERATION;
}
return native_reload_static();
| public int | setAuxEffectSendLevel(float level)Sets the send level of the audio track to the attached auxiliary effect
{@link #attachAuxEffect(int)}. Effect levels
are clamped to the closed interval [0.0, max] where
max is the value of {@link #getMaxVolume}.
A value of 0.0 results in no effect, and a value of 1.0 is full send.
By default the send level is 0.0f, so even if an effect is attached to the player
this method must be called for the effect to be applied.
Note that the passed level value is a linear scalar. UI controls should be scaled
logarithmically: the gain applied by audio framework ranges from -72dB to at least 0dB,
so an appropriate conversion from linear UI input x to level is:
x == 0 -> level = 0
0 < x <= R -> level = 10^(72*(x-R)/20/R)
if (isRestricted()) {
return SUCCESS;
}
if (mState == STATE_UNINITIALIZED) {
return ERROR_INVALID_OPERATION;
}
level = clampGainOrLevel(level);
int err = native_setAuxEffectSendLevel(level);
return err == 0 ? SUCCESS : ERROR;
| public int | setLoopPoints(int startInFrames, int endInFrames, int loopCount)Sets the loop points and the loop count. The loop can be infinite.
Similarly to setPlaybackHeadPosition,
the track must be stopped or paused for the loop points to be changed,
and must use the {@link #MODE_STATIC} mode.
if (mDataLoadMode == MODE_STREAM || mState == STATE_UNINITIALIZED ||
getPlayState() == PLAYSTATE_PLAYING) {
return ERROR_INVALID_OPERATION;
}
if (loopCount == 0) {
; // explicitly allowed as an exception to the loop region range check
} else if (!(0 <= startInFrames && startInFrames < mNativeBufferSizeInFrames &&
startInFrames < endInFrames && endInFrames <= mNativeBufferSizeInFrames)) {
return ERROR_BAD_VALUE;
}
return native_set_loop(startInFrames, endInFrames, loopCount);
| public int | setNotificationMarkerPosition(int markerInFrames)Sets the position of the notification marker. At most one marker can be active.
if (mState == STATE_UNINITIALIZED) {
return ERROR_INVALID_OPERATION;
}
return native_set_marker_pos(markerInFrames);
| public int | setPlaybackHeadPosition(int positionInFrames)Sets the playback head position.
The track must be stopped or paused for the position to be changed,
and must use the {@link #MODE_STATIC} mode.
if (mDataLoadMode == MODE_STREAM || mState == STATE_UNINITIALIZED ||
getPlayState() == PLAYSTATE_PLAYING) {
return ERROR_INVALID_OPERATION;
}
if (!(0 <= positionInFrames && positionInFrames <= mNativeBufferSizeInFrames)) {
return ERROR_BAD_VALUE;
}
return native_set_position(positionInFrames);
| public void | setPlaybackPositionUpdateListener(android.media.AudioTrack$OnPlaybackPositionUpdateListener listener)Sets the listener the AudioTrack notifies when a previously set marker is reached or
for each periodic playback head position update.
Notifications will be received in the same thread as the one in which the AudioTrack
instance was created.
setPlaybackPositionUpdateListener(listener, null);
| public void | setPlaybackPositionUpdateListener(android.media.AudioTrack$OnPlaybackPositionUpdateListener listener, android.os.Handler handler)Sets the listener the AudioTrack notifies when a previously set marker is reached or
for each periodic playback head position update.
Use this method to receive AudioTrack events in the Handler associated with another
thread than the one in which you created the AudioTrack instance.
if (listener != null) {
mEventHandlerDelegate = new NativeEventHandlerDelegate(this, listener, handler);
} else {
mEventHandlerDelegate = null;
}
| public int | setPlaybackRate(int sampleRateInHz)Sets the playback sample rate for this track. This sets the sampling rate at which
the audio data will be consumed and played back
(as set by the sampleRateInHz parameter in the
{@link #AudioTrack(int, int, int, int, int, int)} constructor),
not the original sampling rate of the
content. For example, setting it to half the sample rate of the content will cause the
playback to last twice as long, but will also result in a pitch shift down by one octave.
The valid sample rate range is from 1 Hz to twice the value returned by
{@link #getNativeOutputSampleRate(int)}.
if (mState != STATE_INITIALIZED) {
return ERROR_INVALID_OPERATION;
}
if (sampleRateInHz <= 0) {
return ERROR_BAD_VALUE;
}
return native_set_playback_rate(sampleRateInHz);
| public int | setPositionNotificationPeriod(int periodInFrames)Sets the period for the periodic notification event.
if (mState == STATE_UNINITIALIZED) {
return ERROR_INVALID_OPERATION;
}
return native_set_pos_update_period(periodInFrames);
| protected void | setState(int state)Sets the initialization state of the instance. This method was originally intended to be used
in an AudioTrack subclass constructor to set a subclass-specific post-initialization state.
However, subclasses of AudioTrack are no longer recommended, so this method is obsolete.
mState = state;
| public int | setStereoVolume(float leftGain, float rightGain)Sets the specified left and right output gain values on the AudioTrack.
Gain values are clamped to the closed interval [0.0, max] where
max is the value of {@link #getMaxVolume}.
A value of 0.0 results in zero gain (silence), and
a value of 1.0 means unity gain (signal unchanged).
The default value is 1.0 meaning unity gain.
The word "volume" in the API name is historical; this is actually a linear gain.
if (isRestricted()) {
return SUCCESS;
}
if (mState == STATE_UNINITIALIZED) {
return ERROR_INVALID_OPERATION;
}
leftGain = clampGainOrLevel(leftGain);
rightGain = clampGainOrLevel(rightGain);
native_setVolume(leftGain, rightGain);
return SUCCESS;
| public int | setVolume(float gain)Sets the specified output gain value on all channels of this track.
Gain values are clamped to the closed interval [0.0, max] where
max is the value of {@link #getMaxVolume}.
A value of 0.0 results in zero gain (silence), and
a value of 1.0 means unity gain (signal unchanged).
The default value is 1.0 meaning unity gain.
This API is preferred over {@link #setStereoVolume}, as it
more gracefully scales down to mono, and up to multi-channel content beyond stereo.
The word "volume" in the API name is historical; this is actually a linear gain.
return setStereoVolume(gain, gain);
| public void | stop()Stops playing the audio data.
When used on an instance created in {@link #MODE_STREAM} mode, audio will stop playing
after the last buffer that was written has been played. For an immediate stop, use
{@link #pause()}, followed by {@link #flush()} to discard audio data that hasn't been played
back yet.
if (mState != STATE_INITIALIZED) {
throw new IllegalStateException("stop() called on uninitialized AudioTrack.");
}
// stop playing
synchronized(mPlayStateLock) {
native_stop();
mPlayState = PLAYSTATE_STOPPED;
}
| public int | write(byte[] audioData, int offsetInBytes, int sizeInBytes)Writes the audio data to the audio sink for playback (streaming mode),
or copies audio data for later playback (static buffer mode).
In streaming mode, will block until all data has been written to the audio sink.
In static buffer mode, copies the data to the buffer starting at offset 0.
Note that the actual playback of this data might occur after this function
returns. This function is thread safe with respect to {@link #stop} calls,
in which case all of the specified data might not be written to the audio sink.
if (mState == STATE_UNINITIALIZED || mAudioFormat == AudioFormat.ENCODING_PCM_FLOAT) {
return ERROR_INVALID_OPERATION;
}
if ( (audioData == null) || (offsetInBytes < 0 ) || (sizeInBytes < 0)
|| (offsetInBytes + sizeInBytes < 0) // detect integer overflow
|| (offsetInBytes + sizeInBytes > audioData.length)) {
return ERROR_BAD_VALUE;
}
int ret = native_write_byte(audioData, offsetInBytes, sizeInBytes, mAudioFormat,
true /*isBlocking*/);
if ((mDataLoadMode == MODE_STATIC)
&& (mState == STATE_NO_STATIC_DATA)
&& (ret > 0)) {
// benign race with respect to other APIs that read mState
mState = STATE_INITIALIZED;
}
return ret;
| public int | write(short[] audioData, int offsetInShorts, int sizeInShorts)Writes the audio data to the audio sink for playback (streaming mode),
or copies audio data for later playback (static buffer mode).
In streaming mode, will block until all data has been written to the audio sink.
In static buffer mode, copies the data to the buffer starting at offset 0.
Note that the actual playback of this data might occur after this function
returns. This function is thread safe with respect to {@link #stop} calls,
in which case all of the specified data might not be written to the audio sink.
if (mState == STATE_UNINITIALIZED || mAudioFormat == AudioFormat.ENCODING_PCM_FLOAT) {
return ERROR_INVALID_OPERATION;
}
if ( (audioData == null) || (offsetInShorts < 0 ) || (sizeInShorts < 0)
|| (offsetInShorts + sizeInShorts < 0) // detect integer overflow
|| (offsetInShorts + sizeInShorts > audioData.length)) {
return ERROR_BAD_VALUE;
}
int ret = native_write_short(audioData, offsetInShorts, sizeInShorts, mAudioFormat);
if ((mDataLoadMode == MODE_STATIC)
&& (mState == STATE_NO_STATIC_DATA)
&& (ret > 0)) {
// benign race with respect to other APIs that read mState
mState = STATE_INITIALIZED;
}
return ret;
| public int | write(float[] audioData, int offsetInFloats, int sizeInFloats, int writeMode)Writes the audio data to the audio sink for playback (streaming mode),
or copies audio data for later playback (static buffer mode).
In static buffer mode, copies the data to the buffer starting at offset 0,
and the write mode is ignored.
In streaming mode, the blocking behavior will depend on the write mode.
Note that the actual playback of this data might occur after this function
returns. This function is thread safe with respect to {@link #stop} calls,
in which case all of the specified data might not be written to the audio sink.
if (mState == STATE_UNINITIALIZED) {
Log.e(TAG, "AudioTrack.write() called in invalid state STATE_UNINITIALIZED");
return ERROR_INVALID_OPERATION;
}
if (mAudioFormat != AudioFormat.ENCODING_PCM_FLOAT) {
Log.e(TAG, "AudioTrack.write(float[] ...) requires format ENCODING_PCM_FLOAT");
return ERROR_INVALID_OPERATION;
}
if ((writeMode != WRITE_BLOCKING) && (writeMode != WRITE_NON_BLOCKING)) {
Log.e(TAG, "AudioTrack.write() called with invalid blocking mode");
return ERROR_BAD_VALUE;
}
if ( (audioData == null) || (offsetInFloats < 0 ) || (sizeInFloats < 0)
|| (offsetInFloats + sizeInFloats < 0) // detect integer overflow
|| (offsetInFloats + sizeInFloats > audioData.length)) {
Log.e(TAG, "AudioTrack.write() called with invalid array, offset, or size");
return ERROR_BAD_VALUE;
}
int ret = native_write_float(audioData, offsetInFloats, sizeInFloats, mAudioFormat,
writeMode == WRITE_BLOCKING);
if ((mDataLoadMode == MODE_STATIC)
&& (mState == STATE_NO_STATIC_DATA)
&& (ret > 0)) {
// benign race with respect to other APIs that read mState
mState = STATE_INITIALIZED;
}
return ret;
| public int | write(java.nio.ByteBuffer audioData, int sizeInBytes, int writeMode)Writes the audio data to the audio sink for playback (streaming mode),
or copies audio data for later playback (static buffer mode).
In static buffer mode, copies the data to the buffer starting at its 0 offset, and the write
mode is ignored.
In streaming mode, the blocking behavior will depend on the write mode.
if (mState == STATE_UNINITIALIZED) {
Log.e(TAG, "AudioTrack.write() called in invalid state STATE_UNINITIALIZED");
return ERROR_INVALID_OPERATION;
}
if ((writeMode != WRITE_BLOCKING) && (writeMode != WRITE_NON_BLOCKING)) {
Log.e(TAG, "AudioTrack.write() called with invalid blocking mode");
return ERROR_BAD_VALUE;
}
if ( (audioData == null) || (sizeInBytes < 0) || (sizeInBytes > audioData.remaining())) {
Log.e(TAG, "AudioTrack.write() called with invalid size (" + sizeInBytes + ") value");
return ERROR_BAD_VALUE;
}
int ret = 0;
if (audioData.isDirect()) {
ret = native_write_native_bytes(audioData,
audioData.position(), sizeInBytes, mAudioFormat,
writeMode == WRITE_BLOCKING);
} else {
ret = native_write_byte(NioUtils.unsafeArray(audioData),
NioUtils.unsafeArrayOffset(audioData) + audioData.position(),
sizeInBytes, mAudioFormat,
writeMode == WRITE_BLOCKING);
}
if ((mDataLoadMode == MODE_STATIC)
&& (mState == STATE_NO_STATIC_DATA)
&& (ret > 0)) {
// benign race with respect to other APIs that read mState
mState = STATE_INITIALIZED;
}
if (ret > 0) {
audioData.position(audioData.position() + ret);
}
return ret;
|
|