AudioTrack.h revision 2fc14730e4697a6f456b4631549c9981f6b0b115
189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project/* 289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Copyright (C) 2007 The Android Open Source Project 389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * you may not use this file except in compliance with the License. 689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * You may obtain a copy of the License at 789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 1089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 1189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 1289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * See the License for the specific language governing permissions and 1489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * limitations under the License. 1589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 1689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 1789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#ifndef ANDROID_AUDIOTRACK_H 1889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#define ANDROID_AUDIOTRACK_H 1989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 20a636433cbd09c0708b85f337ef45c0cdef3bcb4dGlenn Kasten#include <cutils/sched_policy.h> 219f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten#include <media/AudioSystem.h> 229f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten#include <media/IAudioTrack.h> 2389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <utils/threads.h> 2489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectnamespace android { 2689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project// ---------------------------------------------------------------------------- 2889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectclass audio_track_cblk_t; 30e3aa659e9cee7df5c12a80d285cc29ab3b2cbb39Glenn Kastenclass AudioTrackClientProxy; 319f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kastenclass StaticAudioTrackClientProxy; 3289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 3389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project// ---------------------------------------------------------------------------- 3489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 359f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kastenclass AudioTrack : public RefBase 3689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project{ 3789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectpublic: 3889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum channel_index { 3989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project MONO = 0, 4089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project LEFT = 0, 4189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project RIGHT = 1 4289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 4389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 449f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* Events used by AudioTrack callback function (callback_t). 45ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten * Keep in sync with frameworks/base/media/java/android/media/AudioTrack.java NATIVE_EVENT_*. 4689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 4789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum event_type { 48083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten EVENT_MORE_DATA = 0, // Request to write more data to buffer. 49083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten // If this event is delivered but the callback handler 50083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten // does not want to write more data, the handler must explicitly 51083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten // ignore the event by setting frameCount to zero. 52083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten EVENT_UNDERRUN = 1, // Buffer underrun occurred. 5385ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten EVENT_LOOP_END = 2, // Sample loop end was reached; playback restarted from 5485ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten // loop start if loop count was not 0. 5585ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten EVENT_MARKER = 3, // Playback head is at the specified marker position 5685ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten // (See setMarkerPosition()). 5785ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten EVENT_NEW_POS = 4, // Playback head is at a new position 5885ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten // (See setPositionUpdatePeriod()). 599f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten EVENT_BUFFER_END = 5, // Playback head is at the end of the buffer. 609f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // Not currently used by android.media.AudioTrack. 619f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten EVENT_NEW_IAUDIOTRACK = 6, // IAudioTrack was re-created, either due to re-routing and 629f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // voluntary invalidation by mediaserver, or mediaserver crash. 63ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald EVENT_STREAM_END = 7, // Sent after all the buffers queued in AF and HW are played 64ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald // back (after stop is called) 6589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 6689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 6799e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten /* Client should declare Buffer on the stack and pass address to obtainBuffer() 6899e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * and releaseBuffer(). See also callback_t for EVENT_MORE_DATA. 6989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 7089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 7189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project class Buffer 7289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project { 7389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project public: 749f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // FIXME use m prefix 7599e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten size_t frameCount; // number of sample frames corresponding to size; 7699e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten // on input it is the number of frames desired, 7799e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten // on output is the number of frames actually filled 78fb1fdc9d6603aa228362e7349451f6455c9849c2Glenn Kasten // (currently ignored, but will make the primary field in future) 7999e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten 809f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten size_t size; // input/output in bytes == frameCount * frameSize 81fb1fdc9d6603aa228362e7349451f6455c9849c2Glenn Kasten // on output is the number of bytes actually filled 829f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // FIXME this is redundant with respect to frameCount, 839f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // and TRANSFER_OBTAIN mode is broken for 8-bit data 849f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // since we don't define the frame format 859f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 8689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project union { 8789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void* raw; 889f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten short* i16; // signed 16-bit 899f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten int8_t* i8; // unsigned 8-bit, offset by 0x80 9089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 9189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 9289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 9389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* As a convenience, if a callback is supplied, a handler thread 9489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * is automatically created with the appropriate priority. This thread 9599e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * invokes the callback when a new buffer becomes available or various conditions occur. 9689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 9789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 9889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * event: type of event notified (see enum AudioTrack::event_type). 9989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * user: Pointer to context for use by the callback receiver. 10089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * info: Pointer to optional parameter according to event type: 10189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_MORE_DATA: pointer to AudioTrack::Buffer struct. The callback must not write 10299e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * more bytes than indicated by 'size' field and update 'size' if fewer bytes are 10399e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * written. 10489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_UNDERRUN: unused. 10589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_LOOP_END: pointer to an int indicating the number of loops remaining. 1069f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * - EVENT_MARKER: pointer to const uint32_t containing the marker position in frames. 1079f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * - EVENT_NEW_POS: pointer to const uint32_t containing the new position in frames. 10889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_BUFFER_END: unused. 1099f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * - EVENT_NEW_IAUDIOTRACK: unused. 11089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 11189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 112d217a8c4632b3e3065f8c2a26b9ce4dc4c97171fGlenn Kasten typedef void (*callback_t)(int event, void* user, void *info); 11389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 11433005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh /* Returns the minimum frame count required for the successful creation of 11533005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh * an AudioTrack object. 11633005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh * Returned status (from utils/Errors.h) can be: 11733005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh * - NO_ERROR: successful operation 11833005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh * - NO_INIT: audio server or audio hardware not initialized 1196ca126d5c83386941c5cb9600099e5510e4430d6Glenn Kasten * - BAD_VALUE: unsupported configuration 12033005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh */ 12133005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh 1229f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten static status_t getMinFrameCount(size_t* frameCount, 1239f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten audio_stream_type_t streamType, 1249f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t sampleRate); 1259f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 1269f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* How data is transferred to AudioTrack 1279f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten */ 1289f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten enum transfer_type { 1299f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten TRANSFER_DEFAULT, // not specified explicitly; determine from the other parameters 1309f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten TRANSFER_CALLBACK, // callback EVENT_MORE_DATA 1319f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten TRANSFER_OBTAIN, // FIXME deprecated: call obtainBuffer() and releaseBuffer() 1329f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten TRANSFER_SYNC, // synchronous write() 1339f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten TRANSFER_SHARED, // shared memory 1349f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten }; 13533005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh 13689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Constructs an uninitialized AudioTrack. No connection with 137083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * AudioFlinger takes place. Use set() after this. 13889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 13989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioTrack(); 14089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 141ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten /* Creates an AudioTrack object and registers it with AudioFlinger. 14289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Once created, the track needs to be started before it can be used. 143083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * Unspecified values are set to appropriate default values. 144083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * With this constructor, the track is configured for streaming mode. 145083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * Data to be rendered is supplied by write() or by the callback EVENT_MORE_DATA. 1469f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Intermixing a combination of write() and non-ignored EVENT_MORE_DATA is not allowed. 14789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 14889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 14989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 15089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * streamType: Select the type of audio stream this track is attached to 151fce7a473248381cc83a01855f92581077d3c9ee2Dima Zavin * (e.g. AUDIO_STREAM_MUSIC). 1529f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * sampleRate: Data source sampling rate in Hz. 153fce7a473248381cc83a01855f92581077d3c9ee2Dima Zavin * format: Audio format (e.g AUDIO_FORMAT_PCM_16_BIT for signed 15489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 16 bits per sample). 15528b76b334f92a15a2be3cc9e2f7d229a3275d1acGlenn Kasten * channelMask: Channel mask. 156d8d6185c978c9b27ca69e7791785e0983ed9e8b8Eric Laurent * frameCount: Minimum size of track PCM buffer in frames. This defines the 157ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten * application's contribution to the 158d8d6185c978c9b27ca69e7791785e0983ed9e8b8Eric Laurent * latency of the track. The actual size selected by the AudioTrack could be 159d8d6185c978c9b27ca69e7791785e0983ed9e8b8Eric Laurent * larger if the requested size is not compatible with current audio HAL 160083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * configuration. Zero means to use a default value. 1610ca3cf94c0dfc173ad7886ae162c4b67067539f6Eric Laurent * flags: See comments on audio_output_flags_t in <system/audio.h>. 16289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * cbf: Callback function. If not null, this function is called periodically 163083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * to provide new data and inform of marker, position updates, etc. 164362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * user: Context for use by the callback receiver. 16589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * notificationFrames: The callback function is called each time notificationFrames PCM 166362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * frames have been consumed from track input buffer. 1679f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * This is expressed in units of frames at the initial source sample rate. 168362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * sessionId: Specific session ID, or zero to use default. 1699f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * transferType: How data is transferred to AudioTrack. 1709f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * threadCanCallJava: Not present in parameter list, and so is fixed at false. 17189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 17289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 173fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten AudioTrack( audio_stream_type_t streamType, 174743732236ab84e94168378cdb293964861b1ed00Glenn Kasten uint32_t sampleRate, 175743732236ab84e94168378cdb293964861b1ed00Glenn Kasten audio_format_t format, 176743732236ab84e94168378cdb293964861b1ed00Glenn Kasten audio_channel_mask_t, 17789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int frameCount = 0, 1780ca3cf94c0dfc173ad7886ae162c4b67067539f6Eric Laurent audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE, 179a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten callback_t cbf = NULL, 180a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten void* user = NULL, 181be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int notificationFrames = 0, 1829f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten int sessionId = 0, 183ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald transfer_type transferType = TRANSFER_DEFAULT, 184ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald const audio_offload_info_t *offloadInfo = NULL); 18589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 186083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten /* Creates an audio track and registers it with AudioFlinger. 187083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * With this constructor, the track is configured for static buffer mode. 188083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * The format must not be 8-bit linear PCM. 189083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * Data to be rendered is passed in a shared memory buffer 190083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * identified by the argument sharedBuffer, which must be non-0. 191083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * The memory should be initialized to the desired data before calling start(). 1924bae3649d504d590a546717a8e49f96a30d9a745Glenn Kasten * The write() method is not supported in this case. 193362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * It is recommended to pass a callback function to be notified of playback end by an 19489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * EVENT_UNDERRUN event. 19589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 19689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 197fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten AudioTrack( audio_stream_type_t streamType, 198743732236ab84e94168378cdb293964861b1ed00Glenn Kasten uint32_t sampleRate, 199743732236ab84e94168378cdb293964861b1ed00Glenn Kasten audio_format_t format, 200743732236ab84e94168378cdb293964861b1ed00Glenn Kasten audio_channel_mask_t channelMask, 201743732236ab84e94168378cdb293964861b1ed00Glenn Kasten const sp<IMemory>& sharedBuffer, 2020ca3cf94c0dfc173ad7886ae162c4b67067539f6Eric Laurent audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE, 203a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten callback_t cbf = NULL, 204a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten void* user = NULL, 205be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int notificationFrames = 0, 2069f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten int sessionId = 0, 207ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald transfer_type transferType = TRANSFER_DEFAULT, 208ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald const audio_offload_info_t *offloadInfo = NULL); 20989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 21089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Terminates the AudioTrack and unregisters it from AudioFlinger. 211362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * Also destroys all resources associated with the AudioTrack. 21289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 2132799d743ee2ae5a25fe869a7f9c052acc029559fGlenn Kastenprotected: 2142799d743ee2ae5a25fe869a7f9c052acc029559fGlenn Kasten virtual ~AudioTrack(); 2152799d743ee2ae5a25fe869a7f9c052acc029559fGlenn Kastenpublic: 21689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2179f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* Initialize an AudioTrack that was created using the AudioTrack() constructor. 2189f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Don't call set() more than once, or after the AudioTrack() constructors that take parameters. 21989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 220362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * - NO_ERROR: successful initialization 221362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * - INVALID_OPERATION: AudioTrack is already initialized 22228b76b334f92a15a2be3cc9e2f7d229a3275d1acGlenn Kasten * - BAD_VALUE: invalid parameter (channelMask, format, sampleRate...) 22389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_INIT: audio server or audio hardware not initialized 224083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * If sharedBuffer is non-0, the frameCount parameter is ignored and 225083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * replaced by the shared buffer's total allocated size in frame units. 2269f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * 2279f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Parameters not listed in the AudioTrack constructors above: 2289f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * 2299f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * threadCanCallJava: Whether callbacks are made from an attached thread and thus can call JNI. 230ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten */ 231743732236ab84e94168378cdb293964861b1ed00Glenn Kasten status_t set(audio_stream_type_t streamType, 232743732236ab84e94168378cdb293964861b1ed00Glenn Kasten uint32_t sampleRate, 233743732236ab84e94168378cdb293964861b1ed00Glenn Kasten audio_format_t format, 234743732236ab84e94168378cdb293964861b1ed00Glenn Kasten audio_channel_mask_t channelMask, 23589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int frameCount = 0, 2360ca3cf94c0dfc173ad7886ae162c4b67067539f6Eric Laurent audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE, 237a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten callback_t cbf = NULL, 238a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten void* user = NULL, 23989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int notificationFrames = 0, 24089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project const sp<IMemory>& sharedBuffer = 0, 241be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent bool threadCanCallJava = false, 2429f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten int sessionId = 0, 243ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald transfer_type transferType = TRANSFER_DEFAULT, 244ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald const audio_offload_info_t *offloadInfo = NULL); 24589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 24689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Result of constructing the AudioTrack. This must be checked 247362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * before using any AudioTrack API (except for set()), because using 24889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * an uninitialized AudioTrack produces undefined results. 24989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * See set() method above for possible return codes. 25089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 25101437b7cdaecf53acb46b50ff8b5d86b9d36eb20Glenn Kasten status_t initCheck() const { return mStatus; } 25289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 253362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Returns this track's estimated latency in milliseconds. 25489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * This includes the latency due to AudioTrack buffer size, AudioMixer (if any) 25589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and audio hardware driver. 25689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 257c9b2e20f7c9a71e07ef398152709c76079decbcdGlenn Kasten uint32_t latency() const { return mLatency; } 25889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 25999e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten /* getters, see constructors and set() */ 26089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 26101437b7cdaecf53acb46b50ff8b5d86b9d36eb20Glenn Kasten audio_stream_type_t streamType() const { return mStreamType; } 26201437b7cdaecf53acb46b50ff8b5d86b9d36eb20Glenn Kasten audio_format_t format() const { return mFormat; } 263b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten 2649f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* Return frame size in bytes, which for linear PCM is 2659f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * channelCount * (bit depth per channel / 8). 266b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten * channelCount is determined from channelMask, and bit depth comes from format. 267083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * For non-linear formats, the frame size is typically 1 byte. 268b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten */ 2699f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten size_t frameSize() const { return mFrameSize; } 270b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten 2719f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t channelCount() const { return mChannelCount; } 27201437b7cdaecf53acb46b50ff8b5d86b9d36eb20Glenn Kasten uint32_t frameCount() const { return mFrameCount; } 27301437b7cdaecf53acb46b50ff8b5d86b9d36eb20Glenn Kasten 274083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten /* Return the static buffer specified in constructor or set(), or 0 for streaming mode */ 27501437b7cdaecf53acb46b50ff8b5d86b9d36eb20Glenn Kasten sp<IMemory> sharedBuffer() const { return mSharedBuffer; } 27689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 27789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* After it's created the track is not active. Call start() to 27889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * make it active. If set, the callback will start being called. 279083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * If the track was previously paused, volume is ramped up over the first mix buffer. 28089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 281b1a270d1e926fb9a01b4265a7675ed0c2c8f4868Richard Fitzgerald status_t start(); 28289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 283083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten /* Stop a track. 284083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * In static buffer mode, the track is stopped immediately. 2859f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * In streaming mode, the callback will cease being called. Note that obtainBuffer() still 2869f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * works and will fill up buffers until the pool is exhausted, and then will return WOULD_BLOCK. 2879f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * In streaming mode the stop does not occur immediately: any data remaining in the buffer 288083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * is first drained, mixed, and output, and only then is the track marked as stopped. 28989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 29089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void stop(); 29189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project bool stopped() const; 29289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2934bae3649d504d590a546717a8e49f96a30d9a745Glenn Kasten /* Flush a stopped or paused track. All previously buffered data is discarded immediately. 2944bae3649d504d590a546717a8e49f96a30d9a745Glenn Kasten * This has the effect of draining the buffers without mixing or output. 2954bae3649d504d590a546717a8e49f96a30d9a745Glenn Kasten * Flush is intended for streaming mode, for example before switching to non-contiguous content. 2964bae3649d504d590a546717a8e49f96a30d9a745Glenn Kasten * This function is a no-op if the track is not stopped or paused, or uses a static buffer. 29789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 29889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void flush(); 29989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 300083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten /* Pause a track. After pause, the callback will cease being called and 3019f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * obtainBuffer returns WOULD_BLOCK. Note that obtainBuffer() still works 30289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and will fill up buffers until the pool is exhausted. 303083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * Volume is ramped down over the next mix buffer following the pause request, 304083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * and then the track is marked as paused. It can be resumed with ramp up by start(). 30589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 30689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void pause(); 30789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 308362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Set volume for this track, mostly used for games' sound effects 309362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * left and right volumes. Levels must be >= 0.0 and <= 1.0. 310b1c0993b215c5c3eebd1c6bafc22bba23d57a70bGlenn Kasten * This is the older API. New applications should use setVolume(float) when possible. 31189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 312be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent status_t setVolume(float left, float right); 313b1c0993b215c5c3eebd1c6bafc22bba23d57a70bGlenn Kasten 314b1c0993b215c5c3eebd1c6bafc22bba23d57a70bGlenn Kasten /* Set volume for all channels. This is the preferred API for new applications, 315b1c0993b215c5c3eebd1c6bafc22bba23d57a70bGlenn Kasten * especially for multi-channel content. 316b1c0993b215c5c3eebd1c6bafc22bba23d57a70bGlenn Kasten */ 317b1c0993b215c5c3eebd1c6bafc22bba23d57a70bGlenn Kasten status_t setVolume(float volume); 31889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 319362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Set the send level for this track. An auxiliary effect should be attached 320362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * to the track with attachEffect(). Level must be >= 0.0 and <= 1.0. 321be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent */ 3222beeb50b1bba9e92f6cacfeca37fe9fa9d36ead1Eric Laurent status_t setAuxEffectSendLevel(float level); 323a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten void getAuxEffectSendLevel(float* level) const; 324be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent 3259f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* Set source sample rate for this track in Hz, mostly used for games' sound effects 32689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 3273b16c766d1ae2cfd8487e8ffb2b23936fc0a8e17Glenn Kasten status_t setSampleRate(uint32_t sampleRate); 3283b16c766d1ae2cfd8487e8ffb2b23936fc0a8e17Glenn Kasten 3299f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* Return current source sample rate in Hz, or 0 if unknown */ 330a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten uint32_t getSampleRate() const; 33189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 33289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Enables looping and sets the start and end points of looping. 333083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * Only supported for static buffer mode. 33489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 33589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 33689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 3379c6745f128648f6e0144b74ee593911a9fa10d51Glenn Kasten * loopStart: loop start in frames relative to start of buffer. 3389c6745f128648f6e0144b74ee593911a9fa10d51Glenn Kasten * loopEnd: loop end in frames relative to start of buffer. 339362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * loopCount: number of loops to execute. Calling setLoop() with loopCount == 0 cancels any 3409c6745f128648f6e0144b74ee593911a9fa10d51Glenn Kasten * pending or active loop. loopCount == -1 means infinite looping. 34189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 34289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * For proper operation the following condition must be respected: 3439c6745f128648f6e0144b74ee593911a9fa10d51Glenn Kasten * loopCount != 0 implies 0 <= loopStart < loopEnd <= frameCount(). 3449c6745f128648f6e0144b74ee593911a9fa10d51Glenn Kasten * 3459c6745f128648f6e0144b74ee593911a9fa10d51Glenn Kasten * If the loop period (loopEnd - loopStart) is too small for the implementation to support, 3469f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * setLoop() will return BAD_VALUE. loopCount must be >= -1. 3479c6745f128648f6e0144b74ee593911a9fa10d51Glenn Kasten * 34889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 34989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setLoop(uint32_t loopStart, uint32_t loopEnd, int loopCount); 35089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 351362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Sets marker position. When playback reaches the number of frames specified, a callback with 352362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * event type EVENT_MARKER is called. Calling setMarkerPosition with marker == 0 cancels marker 353083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * notification callback. To set a marker at a position which would compute as 0, 3549f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * a workaround is to the set the marker at a nearby position such as ~0 or 1. 35585ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten * If the AudioTrack has been opened with no callback function associated, the operation will 35685ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten * fail. 35789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 35889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 35989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 360083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * marker: marker position expressed in wrapping (overflow) frame units, 361083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * like the return value of getPosition(). 36289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 36389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 36489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 36589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioTrack has no callback installed. 36689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 36789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setMarkerPosition(uint32_t marker); 368a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten status_t getMarkerPosition(uint32_t *marker) const; 36989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 370362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Sets position update period. Every time the number of frames specified has been played, 371362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * a callback with event type EVENT_NEW_POS is called. 372362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * Calling setPositionUpdatePeriod with updatePeriod == 0 cancels new position notification 373362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * callback. 37485ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten * If the AudioTrack has been opened with no callback function associated, the operation will 37585ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten * fail. 376083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * Extremely small values may be rounded up to a value the implementation can support. 37789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 37889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 37989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 38089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * updatePeriod: position update notification period expressed in frames. 38189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 38289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 38389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 38489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioTrack has no callback installed. 38589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 38689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setPositionUpdatePeriod(uint32_t updatePeriod); 387a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten status_t getPositionUpdatePeriod(uint32_t *updatePeriod) const; 38889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 3899c6745f128648f6e0144b74ee593911a9fa10d51Glenn Kasten /* Sets playback head position. 3909c6745f128648f6e0144b74ee593911a9fa10d51Glenn Kasten * Only supported for static buffer mode. 3919c6745f128648f6e0144b74ee593911a9fa10d51Glenn Kasten * 39289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 39389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 3949c6745f128648f6e0144b74ee593911a9fa10d51Glenn Kasten * position: New playback head position in frames relative to start of buffer. 3959c6745f128648f6e0144b74ee593911a9fa10d51Glenn Kasten * 0 <= position <= frameCount(). Note that end of buffer is permitted, 3969c6745f128648f6e0144b74ee593911a9fa10d51Glenn Kasten * but will result in an immediate underrun if started. 39789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 39889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 39989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 400083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * - INVALID_OPERATION: the AudioTrack is not stopped or paused, or is streaming mode. 40185ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten * - BAD_VALUE: The specified position is beyond the number of frames present in AudioTrack 40285ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten * buffer 40389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 40489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setPosition(uint32_t position); 405083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten 406083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten /* Return the total number of frames played since playback start. 407083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * The counter will wrap (overflow) periodically, e.g. every ~27 hours at 44.1 kHz. 408083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * It is reset to zero by flush(), reload(), and stop(). 4099f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * 4109f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Parameters: 4119f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * 4129f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * position: Address where to return play head position. 4139f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * 4149f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Returned status (from utils/Errors.h) can be: 4159f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * - NO_ERROR: successful operation 4169f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * - BAD_VALUE: position is NULL 417083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten */ 4189f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten status_t getPosition(uint32_t *position) const; 41989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 4209c6745f128648f6e0144b74ee593911a9fa10d51Glenn Kasten /* For static buffer mode only, this returns the current playback position in frames 42102de89293b74ab1e9a77ce2367c5c499ab038968Glenn Kasten * relative to start of buffer. It is analogous to the position units used by 4229c6745f128648f6e0144b74ee593911a9fa10d51Glenn Kasten * setLoop() and setPosition(). After underrun, the position will be at end of buffer. 4239c6745f128648f6e0144b74ee593911a9fa10d51Glenn Kasten */ 4249c6745f128648f6e0144b74ee593911a9fa10d51Glenn Kasten status_t getBufferPosition(uint32_t *position); 4259c6745f128648f6e0144b74ee593911a9fa10d51Glenn Kasten 426362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Forces AudioTrack buffer full condition. When playing a static buffer, this method avoids 42789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * rewriting the buffer before restarting playback after a stop. 42889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * This method must be called with the AudioTrack in paused or stopped state. 429083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * Not allowed in streaming mode. 43089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 43189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 43289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 433083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * - INVALID_OPERATION: the AudioTrack is not stopped or paused, or is streaming mode. 43489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 43589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t reload(); 43689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 437362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Returns a handle on the audio output used by this AudioTrack. 438c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * 439c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Parameters: 440c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * none. 441c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * 442c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Returned value: 443c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * handle on audio hardware output 444c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent */ 445c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent audio_io_handle_t getOutput(); 446c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent 447362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Returns the unique session ID associated with this track. 448be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 449be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Parameters: 450be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * none. 451be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 452be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Returned value: 453362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * AudioTrack session ID. 454be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent */ 45501437b7cdaecf53acb46b50ff8b5d86b9d36eb20Glenn Kasten int getSessionId() const { return mSessionId; } 456be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent 457362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Attach track auxiliary output to specified effect. Use effectId = 0 458be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * to detach track from effect. 459be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 460be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Parameters: 461be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 462be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * effectId: effectId obtained from AudioEffect::id(). 463be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 464be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Returned status (from utils/Errors.h) can be: 465be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * - NO_ERROR: successful operation 466be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * - INVALID_OPERATION: the effect is not an auxiliary effect. 467be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * - BAD_VALUE: The specified effect ID is invalid 468be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent */ 469be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent status_t attachAuxEffect(int effectId); 470be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent 4719f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* Obtains a buffer of up to "audioBuffer->frameCount" empty slots for frames. 4729f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * After filling these slots with data, the caller should release them with releaseBuffer(). 4739f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * If the track buffer is not full, obtainBuffer() returns as many contiguous 4749f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * [empty slots for] frames as are available immediately. 4759f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * If the track buffer is full and track is stopped, obtainBuffer() returns WOULD_BLOCK 4769f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * regardless of the value of waitCount. 4779f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * If the track buffer is full and track is not stopped, obtainBuffer() blocks with a 4789f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * maximum timeout based on waitCount; see chart below. 479ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten * Buffers will be returned until the pool 48089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * is exhausted, at which point obtainBuffer() will either block 4819f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * or return WOULD_BLOCK depending on the value of the "waitCount" 48289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * parameter. 4839f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Each sample is 16-bit signed PCM. 48499e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * 485083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * obtainBuffer() and releaseBuffer() are deprecated for direct use by applications, 486083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * which should use write() or callback EVENT_MORE_DATA instead. 487083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten * 48899e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * Interpretation of waitCount: 48999e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * +n limits wait time to n * WAIT_PERIOD_MS, 49099e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * -1 causes an (almost) infinite wait time, 49199e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * 0 non-blocking. 49205d499958e4030938ed77a924ebdd9899f36752eGlenn Kasten * 49305d499958e4030938ed77a924ebdd9899f36752eGlenn Kasten * Buffer fields 49405d499958e4030938ed77a924ebdd9899f36752eGlenn Kasten * On entry: 49505d499958e4030938ed77a924ebdd9899f36752eGlenn Kasten * frameCount number of frames requested 49605d499958e4030938ed77a924ebdd9899f36752eGlenn Kasten * After error return: 49705d499958e4030938ed77a924ebdd9899f36752eGlenn Kasten * frameCount 0 49805d499958e4030938ed77a924ebdd9899f36752eGlenn Kasten * size 0 49922eb4e239fbe9103568147d566d7482e480350b8Glenn Kasten * raw undefined 50005d499958e4030938ed77a924ebdd9899f36752eGlenn Kasten * After successful return: 50105d499958e4030938ed77a924ebdd9899f36752eGlenn Kasten * frameCount actual number of frames available, <= number requested 50205d499958e4030938ed77a924ebdd9899f36752eGlenn Kasten * size actual number of bytes available 50305d499958e4030938ed77a924ebdd9899f36752eGlenn Kasten * raw pointer to the buffer 50489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 50589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 5069f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* FIXME Deprecated public API for TRANSFER_OBTAIN mode */ 5079f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten status_t obtainBuffer(Buffer* audioBuffer, int32_t waitCount) 5089f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten __attribute__((__deprecated__)); 50989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 5109f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kastenprivate: 51102de89293b74ab1e9a77ce2367c5c499ab038968Glenn Kasten /* If nonContig is non-NULL, it is an output parameter that will be set to the number of 5129f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * additional non-contiguous frames that are available immediately. 5139f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * FIXME We could pass an array of Buffers instead of only one Buffer to obtainBuffer(), 5149f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * in case the requested amount of frames is in two or more non-contiguous regions. 5159f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * FIXME requested and elapsed are both relative times. Consider changing to absolute time. 5169f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten */ 5179f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten status_t obtainBuffer(Buffer* audioBuffer, const struct timespec *requested, 5189f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten struct timespec *elapsed = NULL, size_t *nonContig = NULL); 5199f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kastenpublic: 52099e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten 521ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald//EL_FIXME to be reconciled with new obtainBuffer() return codes and control block proxy 522ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald// enum { 523ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald// NO_MORE_BUFFERS = 0x80000001, // same name in AudioFlinger.h, ok to be different value 524ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald// TEAR_DOWN = 0x80000002, 525ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald// STOPPED = 1, 526ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald// STREAM_END_WAIT, 527ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald// STREAM_END 528ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald// }; 529ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald 5309f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* Release a filled buffer of "audioBuffer->frameCount" frames for AudioFlinger to process. */ 5319f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // FIXME make private when obtainBuffer() for TRANSFER_OBTAIN is removed 53289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void releaseBuffer(Buffer* audioBuffer); 53389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 53489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* As a convenience we provide a write() interface to the audio buffer. 5359f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Input parameter 'size' is in byte units. 53699e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * This is implemented on top of obtainBuffer/releaseBuffer. For best 53799e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * performance use callbacks. Returns actual number of bytes written >= 0, 53899e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * or one of the following negative status codes: 53902de89293b74ab1e9a77ce2367c5c499ab038968Glenn Kasten * INVALID_OPERATION AudioTrack is configured for static buffer or streaming mode 54099e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * BAD_VALUE size is invalid 5419f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * WOULD_BLOCK when obtainBuffer() returns same, or 5429f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * AudioTrack was stopped during the write 54399e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * or any other error code returned by IAudioTrack::start() or restoreTrack_l(). 54489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 54589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project ssize_t write(const void* buffer, size_t size); 54689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 54789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* 54889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Dumps the state of an audio track. 54989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 5509f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten status_t dump(int fd, const Vector<String16>& args) const; 5519f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 5529f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* 5539f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Return the total number of frames which AudioFlinger desired but were unavailable, 5549f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * and thus which resulted in an underrun. Reset to zero by stop(). 5559f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten */ 5569f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t getUnderrunFrames() const; 55789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 558ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald /* Get the flags */ 559ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald audio_output_flags_t getFlags() const { return mFlags; } 560ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald 561ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald /* Set parameters - only possible when using direct output */ 562ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald status_t setParameters(const String8& keyValuePairs); 563ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald 564ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald /* Get parameters */ 565ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald String8 getParameters(const String8& keys); 566ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald 5674ff14bae91075eb274eb1c2975982358946e7e63John Grossmanprotected: 56889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* copying audio tracks is not allowed */ 56989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioTrack(const AudioTrack& other); 57089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioTrack& operator = (const AudioTrack& other); 57189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 57289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* a small internal class to handle the callback */ 57389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project class AudioTrackThread : public Thread 57489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project { 57589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project public: 57689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioTrackThread(AudioTrack& receiver, bool bCanCallJava = false); 5773acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten 5783acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten // Do not call Thread::requestExitAndWait() without first calling requestExit(). 5793acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten // Thread::requestExitAndWait() is not virtual, and the implementation doesn't do enough. 5803acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten virtual void requestExit(); 5813acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten 5823acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten void pause(); // suspend thread from execution at next loop boundary 5833acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten void resume(); // allow thread to execute, if not requested to exit 5849f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten void pauseConditional(); 5859f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // like pause(), but only if prior resume() wasn't latched 5863acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten 58789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project private: 58889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project friend class AudioTrack; 58989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project virtual bool threadLoop(); 5909f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten AudioTrack& mReceiver; 5919f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten virtual ~AudioTrackThread(); 5923acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten Mutex mMyLock; // Thread::mLock is private 5933acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten Condition mMyCond; // Thread::mThreadExitedCondition is private 5943acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten bool mPaused; // whether thread is currently paused 5959f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten bool mResumeLatch; // whether next pauseConditional() will be a nop 59689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 59789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 59899e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten // body of AudioTrackThread::threadLoop() 5999f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // returns the maximum amount of time before we would like to run again, where: 6009f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // 0 immediately 6019f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // > 0 no later than this many nanoseconds from now 6029f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // NS_WHENEVER still active but no particular deadline 6039f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // NS_INACTIVE inactive so don't run again until re-started 6049f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // NS_NEVER never again 6059f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten static const nsecs_t NS_WHENEVER = -1, NS_INACTIVE = -2, NS_NEVER = -3; 6069f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten nsecs_t processAudioBuffer(const sp<AudioTrackThread>& thread); 607ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald status_t processStreamEnd(int32_t waitCount); 608ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald 609ea7939a079b3600cab955760839b021326f8cfc3Glenn Kasten 610d5ed6e88a9bea1879e41d7defaf1edea7c09f554Glenn Kasten // caller must hold lock on mLock for all _l methods 611ad3af3305f024bcbbd55c894a4995e449498e1baRichard Fitzgerald 612fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten status_t createTrack_l(audio_stream_type_t streamType, 61334f1d8ecd23169a5f299937e3aaf1bd7937578a0Eric Laurent uint32_t sampleRate, 614e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten audio_format_t format, 615e33054eb968cbf8ccaee1b0ff0301403902deed6Glenn Kasten size_t frameCount, 6160ca3cf94c0dfc173ad7886ae162c4b67067539f6Eric Laurent audio_output_flags_t flags, 61734f1d8ecd23169a5f299937e3aaf1bd7937578a0Eric Laurent const sp<IMemory>& sharedBuffer, 6189f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten audio_io_handle_t output, 6199f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten size_t epoch); 6204bae3649d504d590a546717a8e49f96a30d9a745Glenn Kasten 6219f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // can only be called when mState != STATE_ACTIVE 6221703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent void flush_l(); 6234bae3649d504d590a546717a8e49f96a30d9a745Glenn Kasten 6249f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten void setLoop_l(uint32_t loopStart, uint32_t loopEnd, int loopCount); 6251703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent audio_io_handle_t getOutput_l(); 62689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 6279f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // FIXME enum is faster than strcmp() for parameter 'from' 6289f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten status_t restoreTrack_l(const char *from); 6299f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 630b1a270d1e926fb9a01b4265a7675ed0c2c8f4868Richard Fitzgerald bool isOffloaded() const 631b1a270d1e926fb9a01b4265a7675ed0c2c8f4868Richard Fitzgerald { return (mFlags & AUDIO_OUTPUT_FLAG_COMPRESS_OFFLOAD) != 0; } 632b1a270d1e926fb9a01b4265a7675ed0c2c8f4868Richard Fitzgerald 6339f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // may be changed if IAudioTrack is re-created 63489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<IAudioTrack> mAudioTrack; 63589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<IMemory> mCblkMemory; 6369f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten audio_track_cblk_t* mCblk; // re-load after mLock.unlock() 63789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 6389f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten sp<AudioTrackThread> mAudioTrackThread; 63989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project float mVolume[2]; 640be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent float mSendLevel; 641e3aa659e9cee7df5c12a80d285cc29ab3b2cbb39Glenn Kasten uint32_t mSampleRate; 642b603744e96b07b1d5bf745bde593fb2c025cefcfGlenn Kasten size_t mFrameCount; // corresponds to current IAudioTrack 643b603744e96b07b1d5bf745bde593fb2c025cefcfGlenn Kasten size_t mReqFrameCount; // frame count to request the next time a new 644b603744e96b07b1d5bf745bde593fb2c025cefcfGlenn Kasten // IAudioTrack is needed 64589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 64622eb4e239fbe9103568147d566d7482e480350b8Glenn Kasten 6479f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // constant after constructor or set() 64860a839204713e0f8258d082af83262b1eb33a6c3Glenn Kasten audio_format_t mFormat; // as requested by client, not forced to 16-bit 649fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten audio_stream_type_t mStreamType; 650e4756fe3a387615acb63c6a05788c8db9b5786cbGlenn Kasten uint32_t mChannelCount; 65128b76b334f92a15a2be3cc9e2f7d229a3275d1acGlenn Kasten audio_channel_mask_t mChannelMask; 6529f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten transfer_type mTransfer; 65383a0382dc17364567667a4e6135db43f5bd92efcGlenn Kasten 6549f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // mFrameSize is equal to mFrameSizeAF for non-PCM or 16-bit PCM data. For 8-bit PCM data, it's 6559f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // twice as large as mFrameSize because data is expanded to 16-bit before it's stored in buffer. 65683a0382dc17364567667a4e6135db43f5bd92efcGlenn Kasten size_t mFrameSize; // app-level frame size 65783a0382dc17364567667a4e6135db43f5bd92efcGlenn Kasten size_t mFrameSizeAF; // AudioFlinger frame size 65883a0382dc17364567667a4e6135db43f5bd92efcGlenn Kasten 65989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t mStatus; 66089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 6619f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // can change dynamically when IAudioTrack invalidated 6629f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t mLatency; // in ms 6639f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 6649f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // Indicates the current track state. Protected by mLock. 6659f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten enum State { 6669f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten STATE_ACTIVE, 6679f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten STATE_STOPPED, 6689f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten STATE_PAUSED, 669b1a270d1e926fb9a01b4265a7675ed0c2c8f4868Richard Fitzgerald STATE_PAUSED_STOPPING, 6709f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten STATE_FLUSHED, 671b1a270d1e926fb9a01b4265a7675ed0c2c8f4868Richard Fitzgerald STATE_STOPPING, 6729f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten } mState; 67389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 6746ca126d5c83386941c5cb9600099e5510e4430d6Glenn Kasten // for client callback handler 67599e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten callback_t mCbf; // callback handler for events, or NULL 6766ca126d5c83386941c5cb9600099e5510e4430d6Glenn Kasten void* mUserData; 677ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten 678ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten // for notification APIs 67985ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten uint32_t mNotificationFramesReq; // requested number of frames between each 6809f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // notification callback, 6819f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // at initial source sample rate 68285ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten uint32_t mNotificationFramesAct; // actual number of frames between each 6839f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // notification callback, 6849f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // at initial source sample rate 6852fc14730e4697a6f456b4631549c9981f6b0b115Glenn Kasten bool mRefreshRemaining; // processAudioBuffer() should refresh 6862fc14730e4697a6f456b4631549c9981f6b0b115Glenn Kasten // mRemainingFrames and mRetryOnPartialBuffer 6879f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 6889f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // These are private to processAudioBuffer(), and are not protected by a lock 6899f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t mRemainingFrames; // number of frames to request in obtainBuffer() 6909f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten bool mRetryOnPartialBuffer; // sleep and retry after partial obtainBuffer() 691b1a270d1e926fb9a01b4265a7675ed0c2c8f4868Richard Fitzgerald uint32_t mObservedSequence; // last observed value of mSequence 6929f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 69389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<IMemory> mSharedBuffer; 6949f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t mLoopPeriod; // in frames, zero means looping is disabled 695083d1c1492d496960d5b28f4664ff02101736677Glenn Kasten uint32_t mMarkerPosition; // in wrapping (overflow) frame units 6962c22aeb65e801f663a754d043062f85e49f77739Jean-Michel Trivi bool mMarkerReached; 697ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten uint32_t mNewPosition; // in frames 6989f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t mUpdatePeriod; // in frames, zero means no EVENT_NEW_POS 699ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten 7000ca3cf94c0dfc173ad7886ae162c4b67067539f6Eric Laurent audio_output_flags_t mFlags; 701be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int mSessionId; 7022beeb50b1bba9e92f6cacfeca37fe9fa9d36ead1Eric Laurent int mAuxEffectId; 703d5ed6e88a9bea1879e41d7defaf1edea7c09f554Glenn Kasten 7049a2aaf927e56a4b4acab23ef16b3f133a9f48a63Glenn Kasten mutable Mutex mLock; 705d5ed6e88a9bea1879e41d7defaf1edea7c09f554Glenn Kasten 7064ff14bae91075eb274eb1c2975982358946e7e63John Grossman bool mIsTimed; 707879135196fd1c97deefc538c888037c56c2879a7Glenn Kasten int mPreviousPriority; // before start() 708a636433cbd09c0708b85f337ef45c0cdef3bcb4dGlenn Kasten SchedPolicy mPreviousSchedulingGroup; 709a07f17ca46db04c9d5d9e7d6b2878db59ca2b9eaGlenn Kasten bool mAwaitBoost; // thread should wait for priority boost before running 7109f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 7119f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // The proxy should only be referenced while a lock is held because the proxy isn't 7129f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // multi-thread safe, especially the SingleStateQueue part of the proxy. 7139f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // An exception is that a blocking ClientProxy::obtainBuffer() may be called without a lock, 7149f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // provided that the caller also holds an extra reference to the proxy and shared memory to keep 7159f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // them around in case they are replaced during the obtainBuffer(). 7169f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten sp<StaticAudioTrackClientProxy> mStaticProxy; // for type safety only 7179f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten sp<AudioTrackClientProxy> mProxy; // primary owner of the memory 7189f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 7199f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten bool mInUnderrun; // whether track is currently in underrun state 720d054c32443a493513ab63529b0c8b1aca290278cGlenn Kasten String8 mName; // server's name for this IAudioTrack 7219f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 7229f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kastenprivate: 7239f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten class DeathNotifier : public IBinder::DeathRecipient { 7249f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten public: 7259f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten DeathNotifier(AudioTrack* audioTrack) : mAudioTrack(audioTrack) { } 7269f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten protected: 7279f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten virtual void binderDied(const wp<IBinder>& who); 7289f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten private: 7299f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten const wp<AudioTrack> mAudioTrack; 7309f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten }; 7319f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 7329f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten sp<DeathNotifier> mDeathNotifier; 7339f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t mSequence; // incremented for each new IAudioTrack attempt 734b1a270d1e926fb9a01b4265a7675ed0c2c8f4868Richard Fitzgerald audio_io_handle_t mOutput; // cached output io handle 73589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; 73689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 7374ff14bae91075eb274eb1c2975982358946e7e63John Grossmanclass TimedAudioTrack : public AudioTrack 7384ff14bae91075eb274eb1c2975982358946e7e63John Grossman{ 7394ff14bae91075eb274eb1c2975982358946e7e63John Grossmanpublic: 7404ff14bae91075eb274eb1c2975982358946e7e63John Grossman TimedAudioTrack(); 7414ff14bae91075eb274eb1c2975982358946e7e63John Grossman 7424ff14bae91075eb274eb1c2975982358946e7e63John Grossman /* allocate a shared memory buffer that can be passed to queueTimedBuffer */ 7434ff14bae91075eb274eb1c2975982358946e7e63John Grossman status_t allocateTimedBuffer(size_t size, sp<IMemory>* buffer); 7444ff14bae91075eb274eb1c2975982358946e7e63John Grossman 7454ff14bae91075eb274eb1c2975982358946e7e63John Grossman /* queue a buffer obtained via allocateTimedBuffer for playback at the 746c3ae93f21280859086ae371428ffd32f39e76d50Glenn Kasten given timestamp. PTS units are microseconds on the media time timeline. 7474ff14bae91075eb274eb1c2975982358946e7e63John Grossman The media time transform (set with setMediaTimeTransform) set by the 7484ff14bae91075eb274eb1c2975982358946e7e63John Grossman audio producer will handle converting from media time to local time 7494ff14bae91075eb274eb1c2975982358946e7e63John Grossman (perhaps going through the common time timeline in the case of 7504ff14bae91075eb274eb1c2975982358946e7e63John Grossman synchronized multiroom audio case) */ 7514ff14bae91075eb274eb1c2975982358946e7e63John Grossman status_t queueTimedBuffer(const sp<IMemory>& buffer, int64_t pts); 7524ff14bae91075eb274eb1c2975982358946e7e63John Grossman 7534ff14bae91075eb274eb1c2975982358946e7e63John Grossman /* define a transform between media time and either common time or 7544ff14bae91075eb274eb1c2975982358946e7e63John Grossman local time */ 7554ff14bae91075eb274eb1c2975982358946e7e63John Grossman enum TargetTimeline {LOCAL_TIME, COMMON_TIME}; 7564ff14bae91075eb274eb1c2975982358946e7e63John Grossman status_t setMediaTimeTransform(const LinearTransform& xform, 7574ff14bae91075eb274eb1c2975982358946e7e63John Grossman TargetTimeline target); 7584ff14bae91075eb274eb1c2975982358946e7e63John Grossman}; 75989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 76089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; // namespace android 76189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 76289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#endif // ANDROID_AUDIOTRACK_H 763