AudioTrack.h revision b929e417853694e37aba1ef4399f188987b709d9
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 2089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <stdint.h> 2189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <sys/types.h> 2289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <media/IAudioFlinger.h> 2489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <media/IAudioTrack.h> 2589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <media/AudioSystem.h> 2689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <utils/RefBase.h> 2889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <utils/Errors.h> 297562408b2261d38415453378b6188f74fda99d88Mathias Agopian#include <binder/IInterface.h> 307562408b2261d38415453378b6188f74fda99d88Mathias Agopian#include <binder/IMemory.h> 31a636433cbd09c0708b85f337ef45c0cdef3bcb4dGlenn Kasten#include <cutils/sched_policy.h> 3289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <utils/threads.h> 3389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 3489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectnamespace android { 3589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 3689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project// ---------------------------------------------------------------------------- 3789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 3889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectclass audio_track_cblk_t; 3989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 4089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project// ---------------------------------------------------------------------------- 4189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 42b68a91a70bc8d0d18e7404e14443d4e4020b3635Glenn Kastenclass AudioTrack : virtual public RefBase 4389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project{ 4489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectpublic: 4589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum channel_index { 4689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project MONO = 0, 4789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project LEFT = 0, 4889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project RIGHT = 1 4989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 5089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 5189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Events used by AudioTrack callback function (audio_track_cblk_t). 52ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten * Keep in sync with frameworks/base/media/java/android/media/AudioTrack.java NATIVE_EVENT_*. 5389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 5489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum event_type { 5589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project EVENT_MORE_DATA = 0, // Request to write more data to PCM buffer. 56ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten EVENT_UNDERRUN = 1, // PCM buffer underrun occurred. 5785ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten EVENT_LOOP_END = 2, // Sample loop end was reached; playback restarted from 5885ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten // loop start if loop count was not 0. 5985ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten EVENT_MARKER = 3, // Playback head is at the specified marker position 6085ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten // (See setMarkerPosition()). 6185ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten EVENT_NEW_POS = 4, // Playback head is at a new position 6285ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten // (See setPositionUpdatePeriod()). 6389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project EVENT_BUFFER_END = 5 // Playback head is at the end of the buffer. 6489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 6589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 6699e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten /* Client should declare Buffer on the stack and pass address to obtainBuffer() 6799e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * and releaseBuffer(). See also callback_t for EVENT_MORE_DATA. 6889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 6989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 7089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project class Buffer 7189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project { 7289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project public: 7399e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten size_t frameCount; // number of sample frames corresponding to size; 7499e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten // on input it is the number of frames desired, 7599e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten // on output is the number of frames actually filled 7699e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten 7799e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten size_t size; // input/output in byte units 7889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project union { 7989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void* raw; 80362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten short* i16; // signed 16-bit 81362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten int8_t* i8; // unsigned 8-bit, offset by 0x80 8289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 8389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 8489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 8589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 8689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* As a convenience, if a callback is supplied, a handler thread 8789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * is automatically created with the appropriate priority. This thread 8899e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * invokes the callback when a new buffer becomes available or various conditions occur. 8989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 9089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 9189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * event: type of event notified (see enum AudioTrack::event_type). 9289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * user: Pointer to context for use by the callback receiver. 9389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * info: Pointer to optional parameter according to event type: 9489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_MORE_DATA: pointer to AudioTrack::Buffer struct. The callback must not write 9599e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * more bytes than indicated by 'size' field and update 'size' if fewer bytes are 9699e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * written. 9789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_UNDERRUN: unused. 9889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_LOOP_END: pointer to an int indicating the number of loops remaining. 99362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * - EVENT_MARKER: pointer to an uint32_t containing the marker position in frames. 100362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * - EVENT_NEW_POS: pointer to an uint32_t containing the new position in frames. 10189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_BUFFER_END: unused. 10289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 10389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 104d217a8c4632b3e3065f8c2a26b9ce4dc4c97171fGlenn Kasten typedef void (*callback_t)(int event, void* user, void *info); 10589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 10633005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh /* Returns the minimum frame count required for the successful creation of 10733005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh * an AudioTrack object. 10833005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh * Returned status (from utils/Errors.h) can be: 10933005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh * - NO_ERROR: successful operation 11033005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh * - NO_INIT: audio server or audio hardware not initialized 11133005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh */ 11233005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh 11333005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh static status_t getMinFrameCount(int* frameCount, 114fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten audio_stream_type_t streamType = AUDIO_STREAM_DEFAULT, 11533005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh uint32_t sampleRate = 0); 11633005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh 11789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Constructs an uninitialized AudioTrack. No connection with 11889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * AudioFlinger takes place. 11989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 12089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioTrack(); 12189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 122ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten /* Creates an AudioTrack object and registers it with AudioFlinger. 12389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Once created, the track needs to be started before it can be used. 12489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Unspecified values are set to the audio hardware's current 12589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * values. 12689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 12789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 12889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 12989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * streamType: Select the type of audio stream this track is attached to 130fce7a473248381cc83a01855f92581077d3c9ee2Dima Zavin * (e.g. AUDIO_STREAM_MUSIC). 13189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * sampleRate: Track sampling rate in Hz. 132fce7a473248381cc83a01855f92581077d3c9ee2Dima Zavin * format: Audio format (e.g AUDIO_FORMAT_PCM_16_BIT for signed 13389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 16 bits per sample). 13428b76b334f92a15a2be3cc9e2f7d229a3275d1acGlenn Kasten * channelMask: Channel mask. 135d8d6185c978c9b27ca69e7791785e0983ed9e8b8Eric Laurent * frameCount: Minimum size of track PCM buffer in frames. This defines the 136ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten * application's contribution to the 137d8d6185c978c9b27ca69e7791785e0983ed9e8b8Eric Laurent * latency of the track. The actual size selected by the AudioTrack could be 138d8d6185c978c9b27ca69e7791785e0983ed9e8b8Eric Laurent * larger if the requested size is not compatible with current audio HAL 1393acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten * latency. Zero means to use a default value. 1400ca3cf94c0dfc173ad7886ae162c4b67067539f6Eric Laurent * flags: See comments on audio_output_flags_t in <system/audio.h>. 14189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * cbf: Callback function. If not null, this function is called periodically 142ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten * to provide new PCM data. 143362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * user: Context for use by the callback receiver. 14489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * notificationFrames: The callback function is called each time notificationFrames PCM 145362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * frames have been consumed from track input buffer. 146362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * sessionId: Specific session ID, or zero to use default. 1474a4a0959bca78e03e3c3f486ba17829c28314d8cGlenn Kasten * threadCanCallJava: Whether callbacks are made from an attached thread and thus can call JNI. 1484a4a0959bca78e03e3c3f486ba17829c28314d8cGlenn Kasten * If not present in parameter list, then fixed at false. 14989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 15089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 151fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten AudioTrack( audio_stream_type_t streamType, 15289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t sampleRate = 0, 153e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten audio_format_t format = AUDIO_FORMAT_DEFAULT, 15428b76b334f92a15a2be3cc9e2f7d229a3275d1acGlenn Kasten audio_channel_mask_t channelMask = 0, 15589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int frameCount = 0, 1560ca3cf94c0dfc173ad7886ae162c4b67067539f6Eric Laurent audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE, 157a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten callback_t cbf = NULL, 158a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten void* user = NULL, 159be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int notificationFrames = 0, 1604a4a0959bca78e03e3c3f486ba17829c28314d8cGlenn Kasten int sessionId = 0); 16189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 16289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Creates an audio track and registers it with AudioFlinger. With this constructor, 163362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * the PCM data to be rendered by AudioTrack is passed in a shared memory buffer 16489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * identified by the argument sharedBuffer. This prototype is for static buffer playback. 165362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * PCM data must be present in memory before the AudioTrack is started. 166362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * The write() and flush() methods are not supported in this case. 167362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * It is recommended to pass a callback function to be notified of playback end by an 16889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * EVENT_UNDERRUN event. 16989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 17089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 171fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten AudioTrack( audio_stream_type_t streamType, 17289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t sampleRate = 0, 173e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten audio_format_t format = AUDIO_FORMAT_DEFAULT, 17428b76b334f92a15a2be3cc9e2f7d229a3275d1acGlenn Kasten audio_channel_mask_t channelMask = 0, 17589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project const sp<IMemory>& sharedBuffer = 0, 1760ca3cf94c0dfc173ad7886ae162c4b67067539f6Eric Laurent audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE, 177a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten callback_t cbf = NULL, 178a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten void* user = NULL, 179be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int notificationFrames = 0, 1804a4a0959bca78e03e3c3f486ba17829c28314d8cGlenn Kasten int sessionId = 0); 18189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 18289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Terminates the AudioTrack and unregisters it from AudioFlinger. 183362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * Also destroys all resources associated with the AudioTrack. 18489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 18589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project ~AudioTrack(); 18689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 18789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 18889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Initialize an uninitialized AudioTrack. 18989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 190362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * - NO_ERROR: successful initialization 191362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * - INVALID_OPERATION: AudioTrack is already initialized 19228b76b334f92a15a2be3cc9e2f7d229a3275d1acGlenn Kasten * - BAD_VALUE: invalid parameter (channelMask, format, sampleRate...) 19389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_INIT: audio server or audio hardware not initialized 194ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten */ 195fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten status_t set(audio_stream_type_t streamType = AUDIO_STREAM_DEFAULT, 19689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t sampleRate = 0, 197e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten audio_format_t format = AUDIO_FORMAT_DEFAULT, 19828b76b334f92a15a2be3cc9e2f7d229a3275d1acGlenn Kasten audio_channel_mask_t channelMask = 0, 19989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int frameCount = 0, 2000ca3cf94c0dfc173ad7886ae162c4b67067539f6Eric Laurent audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE, 201a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten callback_t cbf = NULL, 202a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten void* user = NULL, 20389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int notificationFrames = 0, 20489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project const sp<IMemory>& sharedBuffer = 0, 205be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent bool threadCanCallJava = false, 206ea7939a079b3600cab955760839b021326f8cfc3Glenn Kasten int sessionId = 0); 20789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 20889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 20989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Result of constructing the AudioTrack. This must be checked 210362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * before using any AudioTrack API (except for set()), because using 21189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * an uninitialized AudioTrack produces undefined results. 21289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * See set() method above for possible return codes. 21389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 21489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t initCheck() const; 21589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 216362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Returns this track's estimated latency in milliseconds. 21789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * This includes the latency due to AudioTrack buffer size, AudioMixer (if any) 21889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and audio hardware driver. 21989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 22089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t latency() const; 22189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 22299e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten /* getters, see constructors and set() */ 22389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 224fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten audio_stream_type_t streamType() const; 225e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten audio_format_t format() const; 22689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int channelCount() const; 22789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t frameCount() const; 228b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten 229b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten /* Return channelCount * (bit depth per channel / 8). 230b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten * channelCount is determined from channelMask, and bit depth comes from format. 231b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten */ 232b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten size_t frameSize() const; 233b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten 23489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<IMemory>& sharedBuffer(); 23589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 23689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 23789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* After it's created the track is not active. Call start() to 23889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * make it active. If set, the callback will start being called. 23989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 24089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void start(); 24189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 24289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Stop a track. If set, the callback will cease being called and 24389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * obtainBuffer returns STOPPED. Note that obtainBuffer() still works 24489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and will fill up buffers until the pool is exhausted. 24589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 24689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void stop(); 24789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project bool stopped() const; 24889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 249362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Flush a stopped track. All pending buffers are discarded. 250362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * This function has no effect if the track is not stopped. 25189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 25289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void flush(); 25389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 25489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Pause a track. If set, the callback will cease being called and 25589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * obtainBuffer returns STOPPED. Note that obtainBuffer() still works 25689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and will fill up buffers until the pool is exhausted. 25789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 25889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void pause(); 25989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 260362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Mute or unmute this track. 261362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * While muted, the callback, if set, is still called. 26289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 26389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void mute(bool); 26489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project bool muted() const; 26589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 266362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Set volume for this track, mostly used for games' sound effects 267362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * left and right volumes. Levels must be >= 0.0 and <= 1.0. 268b1c0993b215c5c3eebd1c6bafc22bba23d57a70bGlenn Kasten * This is the older API. New applications should use setVolume(float) when possible. 26989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 270be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent status_t setVolume(float left, float right); 271b1c0993b215c5c3eebd1c6bafc22bba23d57a70bGlenn Kasten 272b1c0993b215c5c3eebd1c6bafc22bba23d57a70bGlenn Kasten /* Set volume for all channels. This is the preferred API for new applications, 273b1c0993b215c5c3eebd1c6bafc22bba23d57a70bGlenn Kasten * especially for multi-channel content. 274b1c0993b215c5c3eebd1c6bafc22bba23d57a70bGlenn Kasten */ 275b1c0993b215c5c3eebd1c6bafc22bba23d57a70bGlenn Kasten status_t setVolume(float volume); 27689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 277362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Set the send level for this track. An auxiliary effect should be attached 278362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * to the track with attachEffect(). Level must be >= 0.0 and <= 1.0. 279be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent */ 2802beeb50b1bba9e92f6cacfeca37fe9fa9d36ead1Eric Laurent status_t setAuxEffectSendLevel(float level); 281a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten void getAuxEffectSendLevel(float* level) const; 282be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent 283ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten /* Set sample rate for this track in Hz, mostly used for games' sound effects 28489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 285573266210fb2b2e7d86fbd46d0dfe16763611d91Eric Laurent status_t setSampleRate(int sampleRate); 286a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten uint32_t getSampleRate() const; 28789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 28889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Enables looping and sets the start and end points of looping. 28989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 29089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 29189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 29289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * loopStart: loop start expressed as the number of PCM frames played since AudioTrack start. 29389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * loopEnd: loop end expressed as the number of PCM frames played since AudioTrack start. 294362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * loopCount: number of loops to execute. Calling setLoop() with loopCount == 0 cancels any 295362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * pending or active loop. loopCount = -1 means infinite looping. 29689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 29789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * For proper operation the following condition must be respected: 29889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * (loopEnd-loopStart) <= framecount() 29989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 30089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setLoop(uint32_t loopStart, uint32_t loopEnd, int loopCount); 30189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 302362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Sets marker position. When playback reaches the number of frames specified, a callback with 303362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * event type EVENT_MARKER is called. Calling setMarkerPosition with marker == 0 cancels marker 304362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * notification callback. 30585ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten * If the AudioTrack has been opened with no callback function associated, the operation will 30685ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten * fail. 30789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 30889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 30989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 31089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * marker: marker position expressed in frames. 31189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 31289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 31389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 31489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioTrack has no callback installed. 31589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 31689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setMarkerPosition(uint32_t marker); 317a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten status_t getMarkerPosition(uint32_t *marker) const; 31889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 31989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 320362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Sets position update period. Every time the number of frames specified has been played, 321362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * a callback with event type EVENT_NEW_POS is called. 322362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * Calling setPositionUpdatePeriod with updatePeriod == 0 cancels new position notification 323362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * callback. 32485ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten * If the AudioTrack has been opened with no callback function associated, the operation will 32585ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten * fail. 32689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 32789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 32889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 32989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * updatePeriod: position update notification period expressed in frames. 33089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 33189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 33289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 33389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioTrack has no callback installed. 33489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 33589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setPositionUpdatePeriod(uint32_t updatePeriod); 336a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten status_t getPositionUpdatePeriod(uint32_t *updatePeriod) const; 33789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 33889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Sets playback head position within AudioTrack buffer. The new position is specified 339362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * in number of frames. 34089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * This method must be called with the AudioTrack in paused or stopped state. 341362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * Note that the actual position set is <position> modulo the AudioTrack buffer size in frames. 342362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * Therefore using this method makes sense only when playing a "static" audio buffer 34389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * as opposed to streaming. 34489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * The getPosition() method on the other hand returns the total number of frames played since 34589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * playback start. 34689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 34789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 34889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 34989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * position: New playback head position within AudioTrack buffer. 35089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 35189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 35289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 35389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioTrack is not stopped. 35485ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten * - BAD_VALUE: The specified position is beyond the number of frames present in AudioTrack 35585ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten * buffer 35689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 35789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setPosition(uint32_t position); 35889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t getPosition(uint32_t *position); 35989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 360362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Forces AudioTrack buffer full condition. When playing a static buffer, this method avoids 36189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * rewriting the buffer before restarting playback after a stop. 36289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * This method must be called with the AudioTrack in paused or stopped state. 36389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 36489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 36589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 36689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioTrack is not stopped. 36789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 36889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t reload(); 36989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 370362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Returns a handle on the audio output used by this AudioTrack. 371c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * 372c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Parameters: 373c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * none. 374c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * 375c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Returned value: 376c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * handle on audio hardware output 377c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent */ 378c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent audio_io_handle_t getOutput(); 379c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent 380362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Returns the unique session ID associated with this track. 381be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 382be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Parameters: 383be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * none. 384be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 385be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Returned value: 386362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * AudioTrack session ID. 387be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent */ 388a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten int getSessionId() const; 389be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent 390362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Attach track auxiliary output to specified effect. Use effectId = 0 391be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * to detach track from effect. 392be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 393be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Parameters: 394be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 395be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * effectId: effectId obtained from AudioEffect::id(). 396be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 397be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Returned status (from utils/Errors.h) can be: 398be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * - NO_ERROR: successful operation 399be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * - INVALID_OPERATION: the effect is not an auxiliary effect. 400be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * - BAD_VALUE: The specified effect ID is invalid 401be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent */ 402be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent status_t attachAuxEffect(int effectId); 403be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent 404362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Obtains a buffer of "frameCount" frames. The buffer must be 40599e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * filled entirely, and then released with releaseBuffer(). 40699e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * If the track is stopped, obtainBuffer() returns 407362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * STOPPED instead of NO_ERROR as long as there are buffers available, 40889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * at which point NO_MORE_BUFFERS is returned. 409ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten * Buffers will be returned until the pool 41089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * is exhausted, at which point obtainBuffer() will either block 41189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * or return WOULD_BLOCK depending on the value of the "blocking" 41289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * parameter. 41399e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * 41499e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * Interpretation of waitCount: 41599e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * +n limits wait time to n * WAIT_PERIOD_MS, 41699e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * -1 causes an (almost) infinite wait time, 41799e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * 0 non-blocking. 41805d499958e4030938ed77a924ebdd9899f36752eGlenn Kasten * 41905d499958e4030938ed77a924ebdd9899f36752eGlenn Kasten * Buffer fields 42005d499958e4030938ed77a924ebdd9899f36752eGlenn Kasten * On entry: 42105d499958e4030938ed77a924ebdd9899f36752eGlenn Kasten * frameCount number of frames requested 42205d499958e4030938ed77a924ebdd9899f36752eGlenn Kasten * After error return: 42305d499958e4030938ed77a924ebdd9899f36752eGlenn Kasten * frameCount 0 42405d499958e4030938ed77a924ebdd9899f36752eGlenn Kasten * size 0 42505d499958e4030938ed77a924ebdd9899f36752eGlenn Kasten * After successful return: 42605d499958e4030938ed77a924ebdd9899f36752eGlenn Kasten * frameCount actual number of frames available, <= number requested 42705d499958e4030938ed77a924ebdd9899f36752eGlenn Kasten * size actual number of bytes available 42805d499958e4030938ed77a924ebdd9899f36752eGlenn Kasten * raw pointer to the buffer 42989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 43089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 43189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum { 432335787fe43596f38ea2fa50b24c54d0823a3fb1dGlenn Kasten NO_MORE_BUFFERS = 0x80000001, // same name in AudioFlinger.h, ok to be different value 43389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project STOPPED = 1 43489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 43589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 43689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t obtainBuffer(Buffer* audioBuffer, int32_t waitCount); 43799e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten 43899e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten /* Release a filled buffer of "frameCount" frames for AudioFlinger to process. */ 43989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void releaseBuffer(Buffer* audioBuffer); 44089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 44189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* As a convenience we provide a write() interface to the audio buffer. 44299e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * This is implemented on top of obtainBuffer/releaseBuffer. For best 44399e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * performance use callbacks. Returns actual number of bytes written >= 0, 44499e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * or one of the following negative status codes: 44599e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * INVALID_OPERATION AudioTrack is configured for shared buffer mode 44699e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * BAD_VALUE size is invalid 44799e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * STOPPED AudioTrack was stopped during the write 44899e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * NO_MORE_BUFFERS when obtainBuffer() returns same 44999e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * or any other error code returned by IAudioTrack::start() or restoreTrack_l(). 45089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 45189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project ssize_t write(const void* buffer, size_t size); 45289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 45389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* 45489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Dumps the state of an audio track. 45589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 45689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t dump(int fd, const Vector<String16>& args) const; 45789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 4584ff14bae91075eb274eb1c2975982358946e7e63John Grossmanprotected: 45989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* copying audio tracks is not allowed */ 46089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioTrack(const AudioTrack& other); 46189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioTrack& operator = (const AudioTrack& other); 46289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 46389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* a small internal class to handle the callback */ 46489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project class AudioTrackThread : public Thread 46589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project { 46689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project public: 46789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioTrackThread(AudioTrack& receiver, bool bCanCallJava = false); 4683acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten 4693acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten // Do not call Thread::requestExitAndWait() without first calling requestExit(). 4703acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten // Thread::requestExitAndWait() is not virtual, and the implementation doesn't do enough. 4713acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten virtual void requestExit(); 4723acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten 4733acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten void pause(); // suspend thread from execution at next loop boundary 4743acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten void resume(); // allow thread to execute, if not requested to exit 4753acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten 47689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project private: 47789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project friend class AudioTrack; 47889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project virtual bool threadLoop(); 47989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioTrack& mReceiver; 480a997e7a7c5aa2fc7e95316218316f8b7b98786baGlenn Kasten ~AudioTrackThread(); 4813acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten Mutex mMyLock; // Thread::mLock is private 4823acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten Condition mMyCond; // Thread::mThreadExitedCondition is private 4833acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten bool mPaused; // whether thread is currently paused 48489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 48589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 48699e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten // body of AudioTrackThread::threadLoop() 48789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project bool processAudioBuffer(const sp<AudioTrackThread>& thread); 488ea7939a079b3600cab955760839b021326f8cfc3Glenn Kasten 489d5ed6e88a9bea1879e41d7defaf1edea7c09f554Glenn Kasten // caller must hold lock on mLock for all _l methods 490fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten status_t createTrack_l(audio_stream_type_t streamType, 49134f1d8ecd23169a5f299937e3aaf1bd7937578a0Eric Laurent uint32_t sampleRate, 492e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten audio_format_t format, 49328b76b334f92a15a2be3cc9e2f7d229a3275d1acGlenn Kasten audio_channel_mask_t channelMask, 49434f1d8ecd23169a5f299937e3aaf1bd7937578a0Eric Laurent int frameCount, 4950ca3cf94c0dfc173ad7886ae162c4b67067539f6Eric Laurent audio_output_flags_t flags, 49634f1d8ecd23169a5f299937e3aaf1bd7937578a0Eric Laurent const sp<IMemory>& sharedBuffer, 497291f4d505aff81969e6666049d3cc3446f836af2Glenn Kasten audio_io_handle_t output); 4981703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent void flush_l(); 4991703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent status_t setLoop_l(uint32_t loopStart, uint32_t loopEnd, int loopCount); 5001703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent audio_io_handle_t getOutput_l(); 5011703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent status_t restoreTrack_l(audio_track_cblk_t*& cblk, bool fromStart); 5029a2aaf927e56a4b4acab23ef16b3f133a9f48a63Glenn Kasten bool stopped_l() const { return !mActive; } 50389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 50489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<IAudioTrack> mAudioTrack; 50589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<IMemory> mCblkMemory; 50689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<AudioTrackThread> mAudioTrackThread; 50789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 50889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project float mVolume[2]; 509be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent float mSendLevel; 51089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mFrameCount; 51189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 512a47f3165f53c8e8fb8907a94de7417e2c3047eebGlenn Kasten audio_track_cblk_t* mCblk; // re-load after mLock.unlock() 513b929e417853694e37aba1ef4399f188987b709d9Glenn Kasten void* mBuffers; // starting address of buffers in shared memory 514e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten audio_format_t mFormat; 515fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten audio_stream_type_t mStreamType; 51689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint8_t mChannelCount; 51789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint8_t mMuted; 5180d255b2d9061ba31f13ada3fc0f7e51916407176Jean-Michel Trivi uint8_t mReserved; 51928b76b334f92a15a2be3cc9e2f7d229a3275d1acGlenn Kasten audio_channel_mask_t mChannelMask; 52089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t mStatus; 52189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mLatency; 52289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 5239a2aaf927e56a4b4acab23ef16b3f133a9f48a63Glenn Kasten bool mActive; // protected by mLock 52489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 52599e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten callback_t mCbf; // callback handler for events, or NULL 526ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten void* mUserData; // for client callback handler 527ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten 528ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten // for notification APIs 52985ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten uint32_t mNotificationFramesReq; // requested number of frames between each 53085ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten // notification callback 53185ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten uint32_t mNotificationFramesAct; // actual number of frames between each 53285ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten // notification callback 53389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<IMemory> mSharedBuffer; 53489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int mLoopCount; 53589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mRemainingFrames; 536ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten uint32_t mMarkerPosition; // in frames 5372c22aeb65e801f663a754d043062f85e49f77739Jean-Michel Trivi bool mMarkerReached; 538ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten uint32_t mNewPosition; // in frames 539ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten uint32_t mUpdatePeriod; // in frames 540ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten 541cd07594333cbe8b2c86c6609cce01a74d6cc33f8Jean-Michel Trivi bool mFlushed; // FIXME will be made obsolete by making flush() synchronous 5420ca3cf94c0dfc173ad7886ae162c4b67067539f6Eric Laurent audio_output_flags_t mFlags; 543be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int mSessionId; 5442beeb50b1bba9e92f6cacfeca37fe9fa9d36ead1Eric Laurent int mAuxEffectId; 545d5ed6e88a9bea1879e41d7defaf1edea7c09f554Glenn Kasten 546d5ed6e88a9bea1879e41d7defaf1edea7c09f554Glenn Kasten // When locking both mLock and mCblk->lock, must lock in this order to avoid deadlock: 547d5ed6e88a9bea1879e41d7defaf1edea7c09f554Glenn Kasten // 1. mLock 548d5ed6e88a9bea1879e41d7defaf1edea7c09f554Glenn Kasten // 2. mCblk->lock 549d5ed6e88a9bea1879e41d7defaf1edea7c09f554Glenn Kasten // It is OK to lock only mCblk->lock. 5509a2aaf927e56a4b4acab23ef16b3f133a9f48a63Glenn Kasten mutable Mutex mLock; 551d5ed6e88a9bea1879e41d7defaf1edea7c09f554Glenn Kasten 5524ff14bae91075eb274eb1c2975982358946e7e63John Grossman bool mIsTimed; 553879135196fd1c97deefc538c888037c56c2879a7Glenn Kasten int mPreviousPriority; // before start() 554a636433cbd09c0708b85f337ef45c0cdef3bcb4dGlenn Kasten SchedPolicy mPreviousSchedulingGroup; 55589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; 55689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 5574ff14bae91075eb274eb1c2975982358946e7e63John Grossmanclass TimedAudioTrack : public AudioTrack 5584ff14bae91075eb274eb1c2975982358946e7e63John Grossman{ 5594ff14bae91075eb274eb1c2975982358946e7e63John Grossmanpublic: 5604ff14bae91075eb274eb1c2975982358946e7e63John Grossman TimedAudioTrack(); 5614ff14bae91075eb274eb1c2975982358946e7e63John Grossman 5624ff14bae91075eb274eb1c2975982358946e7e63John Grossman /* allocate a shared memory buffer that can be passed to queueTimedBuffer */ 5634ff14bae91075eb274eb1c2975982358946e7e63John Grossman status_t allocateTimedBuffer(size_t size, sp<IMemory>* buffer); 5644ff14bae91075eb274eb1c2975982358946e7e63John Grossman 5654ff14bae91075eb274eb1c2975982358946e7e63John Grossman /* queue a buffer obtained via allocateTimedBuffer for playback at the 566c3ae93f21280859086ae371428ffd32f39e76d50Glenn Kasten given timestamp. PTS units are microseconds on the media time timeline. 5674ff14bae91075eb274eb1c2975982358946e7e63John Grossman The media time transform (set with setMediaTimeTransform) set by the 5684ff14bae91075eb274eb1c2975982358946e7e63John Grossman audio producer will handle converting from media time to local time 5694ff14bae91075eb274eb1c2975982358946e7e63John Grossman (perhaps going through the common time timeline in the case of 5704ff14bae91075eb274eb1c2975982358946e7e63John Grossman synchronized multiroom audio case) */ 5714ff14bae91075eb274eb1c2975982358946e7e63John Grossman status_t queueTimedBuffer(const sp<IMemory>& buffer, int64_t pts); 5724ff14bae91075eb274eb1c2975982358946e7e63John Grossman 5734ff14bae91075eb274eb1c2975982358946e7e63John Grossman /* define a transform between media time and either common time or 5744ff14bae91075eb274eb1c2975982358946e7e63John Grossman local time */ 5754ff14bae91075eb274eb1c2975982358946e7e63John Grossman enum TargetTimeline {LOCAL_TIME, COMMON_TIME}; 5764ff14bae91075eb274eb1c2975982358946e7e63John Grossman status_t setMediaTimeTransform(const LinearTransform& xform, 5774ff14bae91075eb274eb1c2975982358946e7e63John Grossman TargetTimeline target); 5784ff14bae91075eb274eb1c2975982358946e7e63John Grossman}; 57989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 58089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; // namespace android 58189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 58289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#endif // ANDROID_AUDIOTRACK_H 583