AudioTrack.h revision ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6
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: 7389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum { 7489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project MUTE = 0x00000001 7589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 7699e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten uint32_t flags; // 0 or MUTE 77ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten audio_format_t format; // but AUDIO_FORMAT_PCM_8_BIT -> AUDIO_FORMAT_PCM_16_BIT 78e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten // accessed directly by WebKit ANP callback 790d255b2d9061ba31f13ada3fc0f7e51916407176Jean-Michel Trivi int channelCount; // will be removed in the future, do not use 8099e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten 8199e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten size_t frameCount; // number of sample frames corresponding to size; 8299e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten // on input it is the number of frames desired, 8399e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten // on output is the number of frames actually filled 8499e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten 8599e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten size_t size; // input/output in byte units 8689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project union { 8789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void* raw; 88362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten short* i16; // signed 16-bit 89362c4e697d8e9c034e964ac7b40227e054491547Glenn 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 9489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* As a convenience, if a callback is supplied, a handler thread 9589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * is automatically created with the appropriate priority. This thread 9699e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * invokes the callback when a new buffer becomes available or various conditions occur. 9789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 9889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 9989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * event: type of event notified (see enum AudioTrack::event_type). 10089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * user: Pointer to context for use by the callback receiver. 10189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * info: Pointer to optional parameter according to event type: 10289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_MORE_DATA: pointer to AudioTrack::Buffer struct. The callback must not write 10399e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * more bytes than indicated by 'size' field and update 'size' if fewer bytes are 10499e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * written. 10589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_UNDERRUN: unused. 10689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_LOOP_END: pointer to an int indicating the number of loops remaining. 107362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * - EVENT_MARKER: pointer to an uint32_t containing the marker position in frames. 108362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * - EVENT_NEW_POS: pointer to an uint32_t containing the new position in frames. 10989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_BUFFER_END: 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 11933005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh */ 12033005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh 12133005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh static status_t getMinFrameCount(int* frameCount, 122fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten audio_stream_type_t streamType = AUDIO_STREAM_DEFAULT, 12333005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh uint32_t sampleRate = 0); 12433005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh 12589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Constructs an uninitialized AudioTrack. No connection with 12689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * AudioFlinger takes place. 12789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 12889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioTrack(); 12989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 130ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten /* Creates an AudioTrack object and registers it with AudioFlinger. 13189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Once created, the track needs to be started before it can be used. 13289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Unspecified values are set to the audio hardware's current 13389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * values. 13489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 13589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 13689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 13789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * streamType: Select the type of audio stream this track is attached to 138fce7a473248381cc83a01855f92581077d3c9ee2Dima Zavin * (e.g. AUDIO_STREAM_MUSIC). 13989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * sampleRate: Track sampling rate in Hz. 140fce7a473248381cc83a01855f92581077d3c9ee2Dima Zavin * format: Audio format (e.g AUDIO_FORMAT_PCM_16_BIT for signed 14189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 16 bits per sample). 14228b76b334f92a15a2be3cc9e2f7d229a3275d1acGlenn Kasten * channelMask: Channel mask. 143d8d6185c978c9b27ca69e7791785e0983ed9e8b8Eric Laurent * frameCount: Minimum size of track PCM buffer in frames. This defines the 144ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten * application's contribution to the 145d8d6185c978c9b27ca69e7791785e0983ed9e8b8Eric Laurent * latency of the track. The actual size selected by the AudioTrack could be 146d8d6185c978c9b27ca69e7791785e0983ed9e8b8Eric Laurent * larger if the requested size is not compatible with current audio HAL 1473acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten * latency. Zero means to use a default value. 1480ca3cf94c0dfc173ad7886ae162c4b67067539f6Eric Laurent * flags: See comments on audio_output_flags_t in <system/audio.h>. 14989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * cbf: Callback function. If not null, this function is called periodically 150ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten * to provide new PCM data. 151362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * user: Context for use by the callback receiver. 15289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * notificationFrames: The callback function is called each time notificationFrames PCM 153362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * frames have been consumed from track input buffer. 154362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * sessionId: Specific session ID, or zero to use default. 1554a4a0959bca78e03e3c3f486ba17829c28314d8cGlenn Kasten * threadCanCallJava: Whether callbacks are made from an attached thread and thus can call JNI. 1564a4a0959bca78e03e3c3f486ba17829c28314d8cGlenn Kasten * If not present in parameter list, then fixed at false. 15789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 15889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 159fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten AudioTrack( audio_stream_type_t streamType, 16089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t sampleRate = 0, 161e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten audio_format_t format = AUDIO_FORMAT_DEFAULT, 16228b76b334f92a15a2be3cc9e2f7d229a3275d1acGlenn Kasten audio_channel_mask_t channelMask = 0, 16389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int frameCount = 0, 1640ca3cf94c0dfc173ad7886ae162c4b67067539f6Eric Laurent audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE, 165a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten callback_t cbf = NULL, 166a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten void* user = NULL, 167be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int notificationFrames = 0, 1684a4a0959bca78e03e3c3f486ba17829c28314d8cGlenn Kasten int sessionId = 0); 16989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 170c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber // DEPRECATED 171c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber explicit AudioTrack( int streamType, 172c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber uint32_t sampleRate = 0, 173c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber int format = AUDIO_FORMAT_DEFAULT, 174c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber int channelMask = 0, 175c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber int frameCount = 0, 1760ca3cf94c0dfc173ad7886ae162c4b67067539f6Eric Laurent uint32_t flags = (uint32_t) AUDIO_OUTPUT_FLAG_NONE, 177c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber callback_t cbf = 0, 178c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber void* user = 0, 179c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber int notificationFrames = 0, 180ea7939a079b3600cab955760839b021326f8cfc3Glenn Kasten int sessionId = 0); 181c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber 18289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Creates an audio track and registers it with AudioFlinger. With this constructor, 183362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * the PCM data to be rendered by AudioTrack is passed in a shared memory buffer 18489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * identified by the argument sharedBuffer. This prototype is for static buffer playback. 185362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * PCM data must be present in memory before the AudioTrack is started. 186362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * The write() and flush() methods are not supported in this case. 187362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * It is recommended to pass a callback function to be notified of playback end by an 18889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * EVENT_UNDERRUN event. 18989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 19089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 191fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten AudioTrack( audio_stream_type_t streamType, 19289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t sampleRate = 0, 193e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten audio_format_t format = AUDIO_FORMAT_DEFAULT, 19428b76b334f92a15a2be3cc9e2f7d229a3275d1acGlenn Kasten audio_channel_mask_t channelMask = 0, 19589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project const sp<IMemory>& sharedBuffer = 0, 1960ca3cf94c0dfc173ad7886ae162c4b67067539f6Eric Laurent audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE, 197a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten callback_t cbf = NULL, 198a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten void* user = NULL, 199be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int notificationFrames = 0, 2004a4a0959bca78e03e3c3f486ba17829c28314d8cGlenn Kasten int sessionId = 0); 20189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 20289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Terminates the AudioTrack and unregisters it from AudioFlinger. 203362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * Also destroys all resources associated with the AudioTrack. 20489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 20589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project ~AudioTrack(); 20689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 20789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 20889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Initialize an uninitialized AudioTrack. 20989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 210362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * - NO_ERROR: successful initialization 211362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * - INVALID_OPERATION: AudioTrack is already initialized 21228b76b334f92a15a2be3cc9e2f7d229a3275d1acGlenn Kasten * - BAD_VALUE: invalid parameter (channelMask, format, sampleRate...) 21389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_INIT: audio server or audio hardware not initialized 214ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten */ 215fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten status_t set(audio_stream_type_t streamType = AUDIO_STREAM_DEFAULT, 21689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t sampleRate = 0, 217e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten audio_format_t format = AUDIO_FORMAT_DEFAULT, 21828b76b334f92a15a2be3cc9e2f7d229a3275d1acGlenn Kasten audio_channel_mask_t channelMask = 0, 21989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int frameCount = 0, 2200ca3cf94c0dfc173ad7886ae162c4b67067539f6Eric Laurent audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE, 221a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten callback_t cbf = NULL, 222a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten void* user = NULL, 22389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int notificationFrames = 0, 22489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project const sp<IMemory>& sharedBuffer = 0, 225be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent bool threadCanCallJava = false, 226ea7939a079b3600cab955760839b021326f8cfc3Glenn Kasten int sessionId = 0); 22789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 22889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 22989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Result of constructing the AudioTrack. This must be checked 230362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * before using any AudioTrack API (except for set()), because using 23189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * an uninitialized AudioTrack produces undefined results. 23289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * See set() method above for possible return codes. 23389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 23489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t initCheck() const; 23589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 236362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Returns this track's estimated latency in milliseconds. 23789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * This includes the latency due to AudioTrack buffer size, AudioMixer (if any) 23889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and audio hardware driver. 23989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 24089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t latency() const; 24189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 24299e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten /* getters, see constructors and set() */ 24389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 244fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten audio_stream_type_t streamType() const; 245e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten audio_format_t format() const; 24689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int channelCount() const; 24789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t frameCount() const; 248b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten 249b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten /* Return channelCount * (bit depth per channel / 8). 250b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten * channelCount is determined from channelMask, and bit depth comes from format. 251b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten */ 252b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten size_t frameSize() const; 253b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten 25489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<IMemory>& sharedBuffer(); 25589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 25689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 25789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* After it's created the track is not active. Call start() to 25889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * make it active. If set, the callback will start being called. 25989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 26089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void start(); 26189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 26289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Stop a track. If set, the callback will cease being called and 26389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * obtainBuffer returns STOPPED. Note that obtainBuffer() still works 26489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and will fill up buffers until the pool is exhausted. 26589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 26689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void stop(); 26789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project bool stopped() const; 26889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 269362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Flush a stopped track. All pending buffers are discarded. 270362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * This function has no effect if the track is not stopped. 27189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 27289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void flush(); 27389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 27489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Pause a track. If set, the callback will cease being called and 27589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * obtainBuffer returns STOPPED. Note that obtainBuffer() still works 27689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and will fill up buffers until the pool is exhausted. 27789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 27889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void pause(); 27989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 280362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Mute or unmute this track. 281362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * While muted, the callback, if set, is still called. 28289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 28389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void mute(bool); 28489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project bool muted() const; 28589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 286362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Set volume for this track, mostly used for games' sound effects 287362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * left and right volumes. Levels must be >= 0.0 and <= 1.0. 28889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 289be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent status_t setVolume(float left, float right); 290a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten void getVolume(float* left, float* right) const; 29189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 292362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Set the send level for this track. An auxiliary effect should be attached 293362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * to the track with attachEffect(). Level must be >= 0.0 and <= 1.0. 294be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent */ 2952beeb50b1bba9e92f6cacfeca37fe9fa9d36ead1Eric Laurent status_t setAuxEffectSendLevel(float level); 296a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten void getAuxEffectSendLevel(float* level) const; 297be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent 298ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten /* Set sample rate for this track in Hz, mostly used for games' sound effects 29989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 300573266210fb2b2e7d86fbd46d0dfe16763611d91Eric Laurent status_t setSampleRate(int sampleRate); 301a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten uint32_t getSampleRate() const; 30289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 30389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Enables looping and sets the start and end points of looping. 30489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 30589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 30689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 30789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * loopStart: loop start expressed as the number of PCM frames played since AudioTrack start. 30889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * loopEnd: loop end expressed as the number of PCM frames played since AudioTrack start. 309362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * loopCount: number of loops to execute. Calling setLoop() with loopCount == 0 cancels any 310362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * pending or active loop. loopCount = -1 means infinite looping. 31189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 31289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * For proper operation the following condition must be respected: 31389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * (loopEnd-loopStart) <= framecount() 31489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 31589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setLoop(uint32_t loopStart, uint32_t loopEnd, int loopCount); 31689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 317362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Sets marker position. When playback reaches the number of frames specified, a callback with 318362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * event type EVENT_MARKER is called. Calling setMarkerPosition with marker == 0 cancels marker 319362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * notification callback. 32085ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten * If the AudioTrack has been opened with no callback function associated, the operation will 32185ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten * fail. 32289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 32389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 32489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 32589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * marker: marker position expressed in frames. 32689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 32789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 32889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 32989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioTrack has no callback installed. 33089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 33189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setMarkerPosition(uint32_t marker); 332a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten status_t getMarkerPosition(uint32_t *marker) const; 33389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 33489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 335362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Sets position update period. Every time the number of frames specified has been played, 336362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * a callback with event type EVENT_NEW_POS is called. 337362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * Calling setPositionUpdatePeriod with updatePeriod == 0 cancels new position notification 338362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * callback. 33985ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten * If the AudioTrack has been opened with no callback function associated, the operation will 34085ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten * fail. 34189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 34289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 34389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 34489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * updatePeriod: position update notification period expressed in frames. 34589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 34689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 34789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 34889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioTrack has no callback installed. 34989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 35089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setPositionUpdatePeriod(uint32_t updatePeriod); 351a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten status_t getPositionUpdatePeriod(uint32_t *updatePeriod) const; 35289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 35389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Sets playback head position within AudioTrack buffer. The new position is specified 354362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * in number of frames. 35589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * This method must be called with the AudioTrack in paused or stopped state. 356362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * Note that the actual position set is <position> modulo the AudioTrack buffer size in frames. 357362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * Therefore using this method makes sense only when playing a "static" audio buffer 35889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * as opposed to streaming. 35989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * The getPosition() method on the other hand returns the total number of frames played since 36089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * playback start. 36189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 36289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 36389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 36489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * position: New playback head position within AudioTrack buffer. 36589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 36689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 36789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 36889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioTrack is not stopped. 36985ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten * - BAD_VALUE: The specified position is beyond the number of frames present in AudioTrack 37085ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten * buffer 37189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 37289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setPosition(uint32_t position); 37389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t getPosition(uint32_t *position); 37489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 375362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Forces AudioTrack buffer full condition. When playing a static buffer, this method avoids 37689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * rewriting the buffer before restarting playback after a stop. 37789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * This method must be called with the AudioTrack in paused or stopped state. 37889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 37989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 38089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 38189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioTrack is not stopped. 38289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 38389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t reload(); 38489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 385362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Returns a handle on the audio output used by this AudioTrack. 386c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * 387c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Parameters: 388c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * none. 389c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * 390c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Returned value: 391c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * handle on audio hardware output 392c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent */ 393c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent audio_io_handle_t getOutput(); 394c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent 395362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Returns the unique session ID associated with this track. 396be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 397be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Parameters: 398be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * none. 399be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 400be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Returned value: 401362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * AudioTrack session ID. 402be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent */ 403a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten int getSessionId() const; 404be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent 405362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Attach track auxiliary output to specified effect. Use effectId = 0 406be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * to detach track from effect. 407be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 408be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Parameters: 409be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 410be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * effectId: effectId obtained from AudioEffect::id(). 411be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 412be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Returned status (from utils/Errors.h) can be: 413be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * - NO_ERROR: successful operation 414be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * - INVALID_OPERATION: the effect is not an auxiliary effect. 415be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * - BAD_VALUE: The specified effect ID is invalid 416be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent */ 417be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent status_t attachAuxEffect(int effectId); 418be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent 419362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Obtains a buffer of "frameCount" frames. The buffer must be 42099e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * filled entirely, and then released with releaseBuffer(). 42199e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * If the track is stopped, obtainBuffer() returns 422362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * STOPPED instead of NO_ERROR as long as there are buffers available, 42389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * at which point NO_MORE_BUFFERS is returned. 424ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten * Buffers will be returned until the pool 42589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * is exhausted, at which point obtainBuffer() will either block 42689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * or return WOULD_BLOCK depending on the value of the "blocking" 42789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * parameter. 42899e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * 42999e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * Interpretation of waitCount: 43099e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * +n limits wait time to n * WAIT_PERIOD_MS, 43199e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * -1 causes an (almost) infinite wait time, 43299e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * 0 non-blocking. 43389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 43489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 43589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum { 436335787fe43596f38ea2fa50b24c54d0823a3fb1dGlenn Kasten NO_MORE_BUFFERS = 0x80000001, // same name in AudioFlinger.h, ok to be different value 43789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project STOPPED = 1 43889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 43989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 44089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t obtainBuffer(Buffer* audioBuffer, int32_t waitCount); 44199e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten 44299e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten /* Release a filled buffer of "frameCount" frames for AudioFlinger to process. */ 44389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void releaseBuffer(Buffer* audioBuffer); 44489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 44589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* As a convenience we provide a write() interface to the audio buffer. 44699e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * This is implemented on top of obtainBuffer/releaseBuffer. For best 44799e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * performance use callbacks. Returns actual number of bytes written >= 0, 44899e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * or one of the following negative status codes: 44999e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * INVALID_OPERATION AudioTrack is configured for shared buffer mode 45099e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * BAD_VALUE size is invalid 45199e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * STOPPED AudioTrack was stopped during the write 45299e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * NO_MORE_BUFFERS when obtainBuffer() returns same 45399e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * or any other error code returned by IAudioTrack::start() or restoreTrack_l(). 45489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 45589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project ssize_t write(const void* buffer, size_t size); 45689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 45789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* 45889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Dumps the state of an audio track. 45989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 46089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t dump(int fd, const Vector<String16>& args) const; 46189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 4624ff14bae91075eb274eb1c2975982358946e7e63John Grossmanprotected: 46389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* copying audio tracks is not allowed */ 46489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioTrack(const AudioTrack& other); 46589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioTrack& operator = (const AudioTrack& other); 46689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 46789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* a small internal class to handle the callback */ 46889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project class AudioTrackThread : public Thread 46989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project { 47089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project public: 47189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioTrackThread(AudioTrack& receiver, bool bCanCallJava = false); 4723acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten 4733acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten // Do not call Thread::requestExitAndWait() without first calling requestExit(). 4743acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten // Thread::requestExitAndWait() is not virtual, and the implementation doesn't do enough. 4753acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten virtual void requestExit(); 4763acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten 4773acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten void pause(); // suspend thread from execution at next loop boundary 4783acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten void resume(); // allow thread to execute, if not requested to exit 4793acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten 48089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project private: 48189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project friend class AudioTrack; 48289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project virtual bool threadLoop(); 48389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioTrack& mReceiver; 484a997e7a7c5aa2fc7e95316218316f8b7b98786baGlenn Kasten ~AudioTrackThread(); 4853acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten Mutex mMyLock; // Thread::mLock is private 4863acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten Condition mMyCond; // Thread::mThreadExitedCondition is private 4873acbd053c842e76e1a40fc8a0bf62de87eebf00fGlenn Kasten bool mPaused; // whether thread is currently paused 48889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 48989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 49099e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten // body of AudioTrackThread::threadLoop() 49189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project bool processAudioBuffer(const sp<AudioTrackThread>& thread); 492ea7939a079b3600cab955760839b021326f8cfc3Glenn Kasten 493fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten status_t createTrack_l(audio_stream_type_t streamType, 49434f1d8ecd23169a5f299937e3aaf1bd7937578a0Eric Laurent uint32_t sampleRate, 495e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten audio_format_t format, 49628b76b334f92a15a2be3cc9e2f7d229a3275d1acGlenn Kasten audio_channel_mask_t channelMask, 49734f1d8ecd23169a5f299937e3aaf1bd7937578a0Eric Laurent int frameCount, 4980ca3cf94c0dfc173ad7886ae162c4b67067539f6Eric Laurent audio_output_flags_t flags, 49934f1d8ecd23169a5f299937e3aaf1bd7937578a0Eric Laurent const sp<IMemory>& sharedBuffer, 500291f4d505aff81969e6666049d3cc3446f836af2Glenn Kasten audio_io_handle_t output); 5011703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent void flush_l(); 5021703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent status_t setLoop_l(uint32_t loopStart, uint32_t loopEnd, int loopCount); 5031703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent audio_io_handle_t getOutput_l(); 5041703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent status_t restoreTrack_l(audio_track_cblk_t*& cblk, bool fromStart); 5059a2aaf927e56a4b4acab23ef16b3f133a9f48a63Glenn Kasten bool stopped_l() const { return !mActive; } 50689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 50789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<IAudioTrack> mAudioTrack; 50889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<IMemory> mCblkMemory; 50989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<AudioTrackThread> mAudioTrackThread; 51089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 51189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project float mVolume[2]; 512be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent float mSendLevel; 51389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mFrameCount; 51489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 51589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project audio_track_cblk_t* mCblk; 516e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten audio_format_t mFormat; 517fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten audio_stream_type_t mStreamType; 51889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint8_t mChannelCount; 51989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint8_t mMuted; 5200d255b2d9061ba31f13ada3fc0f7e51916407176Jean-Michel Trivi uint8_t mReserved; 52128b76b334f92a15a2be3cc9e2f7d229a3275d1acGlenn Kasten audio_channel_mask_t mChannelMask; 52289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t mStatus; 52389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mLatency; 52489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 5259a2aaf927e56a4b4acab23ef16b3f133a9f48a63Glenn Kasten bool mActive; // protected by mLock 52689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 52799e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten callback_t mCbf; // callback handler for events, or NULL 528ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten void* mUserData; // for client callback handler 529ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten 530ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten // for notification APIs 53185ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten uint32_t mNotificationFramesReq; // requested number of frames between each 53285ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten // notification callback 53385ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten uint32_t mNotificationFramesAct; // actual number of frames between each 53485ab62c4b433df3f1a9826bed1c9bec07a86c750Glenn Kasten // notification callback 53589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<IMemory> mSharedBuffer; 53689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int mLoopCount; 53789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mRemainingFrames; 538ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten uint32_t mMarkerPosition; // in frames 5392c22aeb65e801f663a754d043062f85e49f77739Jean-Michel Trivi bool mMarkerReached; 540ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten uint32_t mNewPosition; // in frames 541ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten uint32_t mUpdatePeriod; // in frames 542ad2f6dbe14e601ae69f3697bc17106f9fd7d59d6Glenn Kasten 543cd07594333cbe8b2c86c6609cce01a74d6cc33f8Jean-Michel Trivi bool mFlushed; // FIXME will be made obsolete by making flush() synchronous 5440ca3cf94c0dfc173ad7886ae162c4b67067539f6Eric Laurent audio_output_flags_t mFlags; 545be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int mSessionId; 5462beeb50b1bba9e92f6cacfeca37fe9fa9d36ead1Eric Laurent int mAuxEffectId; 5479a2aaf927e56a4b4acab23ef16b3f133a9f48a63Glenn Kasten mutable Mutex mLock; 548cfe2ba6b01a258e39f9c215ffc7b750e0b68f708Eric Laurent status_t mRestoreStatus; 5494ff14bae91075eb274eb1c2975982358946e7e63John Grossman bool mIsTimed; 550879135196fd1c97deefc538c888037c56c2879a7Glenn Kasten int mPreviousPriority; // before start() 551a636433cbd09c0708b85f337ef45c0cdef3bcb4dGlenn Kasten SchedPolicy mPreviousSchedulingGroup; 55289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; 55389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 5544ff14bae91075eb274eb1c2975982358946e7e63John Grossmanclass TimedAudioTrack : public AudioTrack 5554ff14bae91075eb274eb1c2975982358946e7e63John Grossman{ 5564ff14bae91075eb274eb1c2975982358946e7e63John Grossmanpublic: 5574ff14bae91075eb274eb1c2975982358946e7e63John Grossman TimedAudioTrack(); 5584ff14bae91075eb274eb1c2975982358946e7e63John Grossman 5594ff14bae91075eb274eb1c2975982358946e7e63John Grossman /* allocate a shared memory buffer that can be passed to queueTimedBuffer */ 5604ff14bae91075eb274eb1c2975982358946e7e63John Grossman status_t allocateTimedBuffer(size_t size, sp<IMemory>* buffer); 5614ff14bae91075eb274eb1c2975982358946e7e63John Grossman 5624ff14bae91075eb274eb1c2975982358946e7e63John Grossman /* queue a buffer obtained via allocateTimedBuffer for playback at the 563c3ae93f21280859086ae371428ffd32f39e76d50Glenn Kasten given timestamp. PTS units are microseconds on the media time timeline. 5644ff14bae91075eb274eb1c2975982358946e7e63John Grossman The media time transform (set with setMediaTimeTransform) set by the 5654ff14bae91075eb274eb1c2975982358946e7e63John Grossman audio producer will handle converting from media time to local time 5664ff14bae91075eb274eb1c2975982358946e7e63John Grossman (perhaps going through the common time timeline in the case of 5674ff14bae91075eb274eb1c2975982358946e7e63John Grossman synchronized multiroom audio case) */ 5684ff14bae91075eb274eb1c2975982358946e7e63John Grossman status_t queueTimedBuffer(const sp<IMemory>& buffer, int64_t pts); 5694ff14bae91075eb274eb1c2975982358946e7e63John Grossman 5704ff14bae91075eb274eb1c2975982358946e7e63John Grossman /* define a transform between media time and either common time or 5714ff14bae91075eb274eb1c2975982358946e7e63John Grossman local time */ 5724ff14bae91075eb274eb1c2975982358946e7e63John Grossman enum TargetTimeline {LOCAL_TIME, COMMON_TIME}; 5734ff14bae91075eb274eb1c2975982358946e7e63John Grossman status_t setMediaTimeTransform(const LinearTransform& xform, 5744ff14bae91075eb274eb1c2975982358946e7e63John Grossman TargetTimeline target); 5754ff14bae91075eb274eb1c2975982358946e7e63John Grossman}; 57689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 57789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; // namespace android 57889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 57989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#endif // ANDROID_AUDIOTRACK_H 580