AudioTrack.h revision d8d6185c978c9b27ca69e7791785e0983ed9e8b8
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> 3189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <utils/threads.h> 3289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 3389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectnamespace android { 3489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 3589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project// ---------------------------------------------------------------------------- 3689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 3789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectclass audio_track_cblk_t; 3889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 3989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project// ---------------------------------------------------------------------------- 4089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 41b68a91a70bc8d0d18e7404e14443d4e4020b3635Glenn Kastenclass AudioTrack : virtual public RefBase 4289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project{ 4389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectpublic: 4489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum channel_index { 4589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project MONO = 0, 4689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project LEFT = 0, 4789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project RIGHT = 1 4889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 4989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 5089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Events used by AudioTrack callback function (audio_track_cblk_t). 5189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 5289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum event_type { 5389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project EVENT_MORE_DATA = 0, // Request to write more data to PCM buffer. 5489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project EVENT_UNDERRUN = 1, // PCM buffer underrun occured. 5589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project EVENT_LOOP_END = 2, // Sample loop end was reached; playback restarted from loop start if loop count was not 0. 5689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project EVENT_MARKER = 3, // Playback head is at the specified marker position (See setMarkerPosition()). 5789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project EVENT_NEW_POS = 4, // Playback head is at a new position (See setPositionUpdatePeriod()). 5889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project EVENT_BUFFER_END = 5 // Playback head is at the end of the buffer. 5989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 6089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 6199e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten /* Client should declare Buffer on the stack and pass address to obtainBuffer() 6299e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * and releaseBuffer(). See also callback_t for EVENT_MORE_DATA. 6389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 6489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 6589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project class Buffer 6689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project { 6789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project public: 6889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum { 6989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project MUTE = 0x00000001 7089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 7199e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten uint32_t flags; // 0 or MUTE 72e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten audio_format_t format; // but AUDIO_FORMAT_PCM_8_BIT -> AUDIO_FORMAT_PCM_16_BIT 73e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten // accessed directly by WebKit ANP callback 740d255b2d9061ba31f13ada3fc0f7e51916407176Jean-Michel Trivi int channelCount; // will be removed in the future, do not use 7599e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten 7699e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten size_t frameCount; // number of sample frames corresponding to size; 7799e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten // on input it is the number of frames desired, 7899e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten // on output is the number of frames actually filled 7999e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten 8099e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten size_t size; // input/output in byte units 8189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project union { 8289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void* raw; 83362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten short* i16; // signed 16-bit 84362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten int8_t* i8; // unsigned 8-bit, offset by 0x80 8589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 8689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 8789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 8889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 8989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* As a convenience, if a callback is supplied, a handler thread 9089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * is automatically created with the appropriate priority. This thread 9199e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * invokes the callback when a new buffer becomes available or various conditions occur. 9289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 9389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 9489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * event: type of event notified (see enum AudioTrack::event_type). 9589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * user: Pointer to context for use by the callback receiver. 9689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * info: Pointer to optional parameter according to event type: 9789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_MORE_DATA: pointer to AudioTrack::Buffer struct. The callback must not write 9899e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * more bytes than indicated by 'size' field and update 'size' if fewer bytes are 9999e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * written. 10089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_UNDERRUN: unused. 10189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_LOOP_END: pointer to an int indicating the number of loops remaining. 102362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * - EVENT_MARKER: pointer to an uint32_t containing the marker position in frames. 103362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * - EVENT_NEW_POS: pointer to an uint32_t containing the new position in frames. 10489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_BUFFER_END: unused. 10589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 10689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 107d217a8c4632b3e3065f8c2a26b9ce4dc4c97171fGlenn Kasten typedef void (*callback_t)(int event, void* user, void *info); 10889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 10933005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh /* Returns the minimum frame count required for the successful creation of 11033005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh * an AudioTrack object. 11133005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh * Returned status (from utils/Errors.h) can be: 11233005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh * - NO_ERROR: successful operation 11333005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh * - NO_INIT: audio server or audio hardware not initialized 11433005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh */ 11533005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh 11633005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh static status_t getMinFrameCount(int* frameCount, 117fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten audio_stream_type_t streamType = AUDIO_STREAM_DEFAULT, 11833005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh uint32_t sampleRate = 0); 11933005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh 12089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Constructs an uninitialized AudioTrack. No connection with 12189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * AudioFlinger takes place. 12289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 12389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioTrack(); 12489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 12589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Creates an audio track and registers it with AudioFlinger. 12689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Once created, the track needs to be started before it can be used. 12789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Unspecified values are set to the audio hardware's current 12889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * values. 12989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 13089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 13189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 13289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * streamType: Select the type of audio stream this track is attached to 133fce7a473248381cc83a01855f92581077d3c9ee2Dima Zavin * (e.g. AUDIO_STREAM_MUSIC). 13489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * sampleRate: Track sampling rate in Hz. 135fce7a473248381cc83a01855f92581077d3c9ee2Dima Zavin * format: Audio format (e.g AUDIO_FORMAT_PCM_16_BIT for signed 13689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 16 bits per sample). 1370d255b2d9061ba31f13ada3fc0f7e51916407176Jean-Michel Trivi * channelMask: Channel mask: see audio_channels_t. 138d8d6185c978c9b27ca69e7791785e0983ed9e8b8Eric Laurent * frameCount: Minimum size of track PCM buffer in frames. This defines the 139d8d6185c978c9b27ca69e7791785e0983ed9e8b8Eric Laurent * latency of the track. The actual size selected by the AudioTrack could be 140d8d6185c978c9b27ca69e7791785e0983ed9e8b8Eric Laurent * larger if the requested size is not compatible with current audio HAL 141d8d6185c978c9b27ca69e7791785e0983ed9e8b8Eric Laurent * latency. 14289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * flags: Reserved for future use. 14389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * cbf: Callback function. If not null, this function is called periodically 14489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * to request new PCM data. 145362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * user: Context for use by the callback receiver. 14689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * notificationFrames: The callback function is called each time notificationFrames PCM 147362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * frames have been consumed from track input buffer. 148362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * sessionId: Specific session ID, or zero to use default. 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, 1540d255b2d9061ba31f13ada3fc0f7e51916407176Jean-Michel Trivi int channelMask = 0, 15589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int frameCount = 0, 15689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t flags = 0, 157a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten callback_t cbf = NULL, 158a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten void* user = NULL, 159be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int notificationFrames = 0, 160be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int sessionId = 0); 16189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 162c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber // DEPRECATED 163c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber explicit AudioTrack( int streamType, 164c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber uint32_t sampleRate = 0, 165c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber int format = AUDIO_FORMAT_DEFAULT, 166c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber int channelMask = 0, 167c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber int frameCount = 0, 168c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber uint32_t flags = 0, 169c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber callback_t cbf = 0, 170c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber void* user = 0, 171c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber int notificationFrames = 0, 172c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber int sessionId = 0); 173c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber 17489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Creates an audio track and registers it with AudioFlinger. With this constructor, 175362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * the PCM data to be rendered by AudioTrack is passed in a shared memory buffer 17689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * identified by the argument sharedBuffer. This prototype is for static buffer playback. 177362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * PCM data must be present in memory before the AudioTrack is started. 178362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * The write() and flush() methods are not supported in this case. 179362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * It is recommended to pass a callback function to be notified of playback end by an 18089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * EVENT_UNDERRUN event. 18189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 18289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 183fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten AudioTrack( audio_stream_type_t streamType, 18489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t sampleRate = 0, 185e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten audio_format_t format = AUDIO_FORMAT_DEFAULT, 1860d255b2d9061ba31f13ada3fc0f7e51916407176Jean-Michel Trivi int channelMask = 0, 18789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project const sp<IMemory>& sharedBuffer = 0, 18889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t flags = 0, 189a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten callback_t cbf = NULL, 190a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten void* user = NULL, 191be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int notificationFrames = 0, 192be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int sessionId = 0); 19389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 19489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Terminates the AudioTrack and unregisters it from AudioFlinger. 195362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * Also destroys all resources associated with the AudioTrack. 19689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 19789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project ~AudioTrack(); 19889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 19989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 20089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Initialize an uninitialized AudioTrack. 20189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 202362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * - NO_ERROR: successful initialization 203362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * - INVALID_OPERATION: AudioTrack is already initialized 204c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * - BAD_VALUE: invalid parameter (channels, format, sampleRate...) 20589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_INIT: audio server or audio hardware not initialized 20689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * */ 207fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten status_t set(audio_stream_type_t streamType = AUDIO_STREAM_DEFAULT, 20889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t sampleRate = 0, 209e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten audio_format_t format = AUDIO_FORMAT_DEFAULT, 2100d255b2d9061ba31f13ada3fc0f7e51916407176Jean-Michel Trivi int channelMask = 0, 21189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int frameCount = 0, 21289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t flags = 0, 213a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten callback_t cbf = NULL, 214a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten void* user = NULL, 21589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int notificationFrames = 0, 21689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project const sp<IMemory>& sharedBuffer = 0, 217be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent bool threadCanCallJava = false, 218be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int sessionId = 0); 21989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 22089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 22189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Result of constructing the AudioTrack. This must be checked 222362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * before using any AudioTrack API (except for set()), because using 22389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * an uninitialized AudioTrack produces undefined results. 22489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * See set() method above for possible return codes. 22589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 22689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t initCheck() const; 22789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 228362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Returns this track's estimated latency in milliseconds. 22989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * This includes the latency due to AudioTrack buffer size, AudioMixer (if any) 23089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and audio hardware driver. 23189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 23289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t latency() const; 23389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 23499e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten /* getters, see constructors and set() */ 23589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 236fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten audio_stream_type_t streamType() const; 237e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten audio_format_t format() const; 23889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int channelCount() const; 23989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t frameCount() const; 240b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten 241b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten /* Return channelCount * (bit depth per channel / 8). 242b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten * channelCount is determined from channelMask, and bit depth comes from format. 243b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten */ 244b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten size_t frameSize() const; 245b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten 24689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<IMemory>& sharedBuffer(); 24789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 24889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 24989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* After it's created the track is not active. Call start() to 25089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * make it active. If set, the callback will start being called. 25189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 25289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void start(); 25389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 25489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Stop 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 stop(); 25989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project bool stopped() const; 26089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 261362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Flush a stopped track. All pending buffers are discarded. 262362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * This function has no effect if the track is not stopped. 26389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 26489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void flush(); 26589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 26689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Pause a track. If set, the callback will cease being called and 26789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * obtainBuffer returns STOPPED. Note that obtainBuffer() still works 26889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and will fill up buffers until the pool is exhausted. 26989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 27089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void pause(); 27189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 272362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Mute or unmute this track. 273362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * While muted, the callback, if set, is still called. 27489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 27589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void mute(bool); 27689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project bool muted() const; 27789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 278362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Set volume for this track, mostly used for games' sound effects 279362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * left and right volumes. Levels must be >= 0.0 and <= 1.0. 28089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 281be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent status_t setVolume(float left, float right); 282a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten void getVolume(float* left, float* right) const; 28389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 284362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Set the send level for this track. An auxiliary effect should be attached 285362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * to the track with attachEffect(). Level must be >= 0.0 and <= 1.0. 286be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent */ 2872beeb50b1bba9e92f6cacfeca37fe9fa9d36ead1Eric Laurent status_t setAuxEffectSendLevel(float level); 288a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten void getAuxEffectSendLevel(float* level) const; 289be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent 290362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Set sample rate for this track, mostly used for games' sound effects 29189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 292573266210fb2b2e7d86fbd46d0dfe16763611d91Eric Laurent status_t setSampleRate(int sampleRate); 293a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten uint32_t getSampleRate() const; 29489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 29589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Enables looping and sets the start and end points of looping. 29689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 29789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 29889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 29989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * loopStart: loop start expressed as the number of PCM frames played since AudioTrack start. 30089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * loopEnd: loop end expressed as the number of PCM frames played since AudioTrack start. 301362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * loopCount: number of loops to execute. Calling setLoop() with loopCount == 0 cancels any 302362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * pending or active loop. loopCount = -1 means infinite looping. 30389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 30489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * For proper operation the following condition must be respected: 30589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * (loopEnd-loopStart) <= framecount() 30689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 30789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setLoop(uint32_t loopStart, uint32_t loopEnd, int loopCount); 30889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 309362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Sets marker position. When playback reaches the number of frames specified, a callback with 310362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * event type EVENT_MARKER is called. Calling setMarkerPosition with marker == 0 cancels marker 311362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * notification callback. 31289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * If the AudioTrack has been opened with no callback function associated, the operation will fail. 31389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 31489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 31589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 31689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * marker: marker position expressed in frames. 31789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 31889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 31989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 32089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioTrack has no callback installed. 32189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 32289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setMarkerPosition(uint32_t marker); 323a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten status_t getMarkerPosition(uint32_t *marker) const; 32489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 32589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 326362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Sets position update period. Every time the number of frames specified has been played, 327362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * a callback with event type EVENT_NEW_POS is called. 328362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * Calling setPositionUpdatePeriod with updatePeriod == 0 cancels new position notification 329362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * callback. 33089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * If the AudioTrack has been opened with no callback function associated, the operation will fail. 33189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 33289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 33389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 33489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * updatePeriod: position update notification period expressed in frames. 33589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 33689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 33789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 33889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioTrack has no callback installed. 33989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 34089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setPositionUpdatePeriod(uint32_t updatePeriod); 341a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten status_t getPositionUpdatePeriod(uint32_t *updatePeriod) const; 34289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 34389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Sets playback head position within AudioTrack buffer. The new position is specified 344362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * in number of frames. 34589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * This method must be called with the AudioTrack in paused or stopped state. 346362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * Note that the actual position set is <position> modulo the AudioTrack buffer size in frames. 347362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * Therefore using this method makes sense only when playing a "static" audio buffer 34889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * as opposed to streaming. 34989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * The getPosition() method on the other hand returns the total number of frames played since 35089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * playback start. 35189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 35289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 35389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 35489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * position: New playback head position within AudioTrack buffer. 35589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 35689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 35789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 35889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioTrack is not stopped. 359362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * - BAD_VALUE: The specified position is beyond the number of frames present in AudioTrack buffer 36089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 36189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setPosition(uint32_t position); 36289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t getPosition(uint32_t *position); 36389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 364362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Forces AudioTrack buffer full condition. When playing a static buffer, this method avoids 36589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * rewriting the buffer before restarting playback after a stop. 36689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * This method must be called with the AudioTrack in paused or stopped state. 36789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 36889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 36989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 37089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioTrack is not stopped. 37189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 37289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t reload(); 37389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 374362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Returns a handle on the audio output used by this AudioTrack. 375c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * 376c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Parameters: 377c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * none. 378c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * 379c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Returned value: 380c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * handle on audio hardware output 381c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent */ 382c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent audio_io_handle_t getOutput(); 383c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent 384362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Returns the unique session ID associated with this track. 385be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 386be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Parameters: 387be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * none. 388be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 389be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Returned value: 390362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * AudioTrack session ID. 391be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent */ 392a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten int getSessionId() const; 393be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent 394362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Attach track auxiliary output to specified effect. Use effectId = 0 395be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * to detach track from effect. 396be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 397be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Parameters: 398be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 399be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * effectId: effectId obtained from AudioEffect::id(). 400be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 401be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Returned status (from utils/Errors.h) can be: 402be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * - NO_ERROR: successful operation 403be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * - INVALID_OPERATION: the effect is not an auxiliary effect. 404be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * - BAD_VALUE: The specified effect ID is invalid 405be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent */ 406be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent status_t attachAuxEffect(int effectId); 407be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent 408362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Obtains a buffer of "frameCount" frames. The buffer must be 40999e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * filled entirely, and then released with releaseBuffer(). 41099e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * If the track is stopped, obtainBuffer() returns 411362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * STOPPED instead of NO_ERROR as long as there are buffers available, 41289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * at which point NO_MORE_BUFFERS is returned. 41389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Buffers will be returned until the pool (buffercount()) 41489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * is exhausted, at which point obtainBuffer() will either block 41589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * or return WOULD_BLOCK depending on the value of the "blocking" 41689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * parameter. 41799e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * 41899e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * Interpretation of waitCount: 41999e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * +n limits wait time to n * WAIT_PERIOD_MS, 42099e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * -1 causes an (almost) infinite wait time, 42199e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * 0 non-blocking. 42289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 42389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 42489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum { 425335787fe43596f38ea2fa50b24c54d0823a3fb1dGlenn Kasten NO_MORE_BUFFERS = 0x80000001, // same name in AudioFlinger.h, ok to be different value 42689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project STOPPED = 1 42789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 42889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 42989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t obtainBuffer(Buffer* audioBuffer, int32_t waitCount); 43099e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten 43199e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten /* Release a filled buffer of "frameCount" frames for AudioFlinger to process. */ 43289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void releaseBuffer(Buffer* audioBuffer); 43389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 43489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* As a convenience we provide a write() interface to the audio buffer. 43599e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * This is implemented on top of obtainBuffer/releaseBuffer. For best 43699e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * performance use callbacks. Returns actual number of bytes written >= 0, 43799e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * or one of the following negative status codes: 43899e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * INVALID_OPERATION AudioTrack is configured for shared buffer mode 43999e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * BAD_VALUE size is invalid 44099e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * STOPPED AudioTrack was stopped during the write 44199e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * NO_MORE_BUFFERS when obtainBuffer() returns same 44299e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten * or any other error code returned by IAudioTrack::start() or restoreTrack_l(). 44389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 44489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project ssize_t write(const void* buffer, size_t size); 44589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 44689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* 44789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Dumps the state of an audio track. 44889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 44989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t dump(int fd, const Vector<String16>& args) const; 45089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 4514ff14bae91075eb274eb1c2975982358946e7e63John Grossmanprotected: 45289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* copying audio tracks is not allowed */ 45389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioTrack(const AudioTrack& other); 45489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioTrack& operator = (const AudioTrack& other); 45589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 45689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* a small internal class to handle the callback */ 45789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project class AudioTrackThread : public Thread 45889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project { 45989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project public: 46089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioTrackThread(AudioTrack& receiver, bool bCanCallJava = false); 46189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project private: 46289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project friend class AudioTrack; 46389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project virtual bool threadLoop(); 46489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project virtual status_t readyToRun(); 46589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project virtual void onFirstRef(); 46689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioTrack& mReceiver; 46789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 46889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 46999e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten // body of AudioTrackThread::threadLoop() 47089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project bool processAudioBuffer(const sp<AudioTrackThread>& thread); 471fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten status_t createTrack_l(audio_stream_type_t streamType, 47234f1d8ecd23169a5f299937e3aaf1bd7937578a0Eric Laurent uint32_t sampleRate, 473e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten audio_format_t format, 4740d255b2d9061ba31f13ada3fc0f7e51916407176Jean-Michel Trivi uint32_t channelMask, 47534f1d8ecd23169a5f299937e3aaf1bd7937578a0Eric Laurent int frameCount, 47634f1d8ecd23169a5f299937e3aaf1bd7937578a0Eric Laurent uint32_t flags, 47734f1d8ecd23169a5f299937e3aaf1bd7937578a0Eric Laurent const sp<IMemory>& sharedBuffer, 478d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent audio_io_handle_t output, 479d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent bool enforceFrameCount); 4801703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent void flush_l(); 4811703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent status_t setLoop_l(uint32_t loopStart, uint32_t loopEnd, int loopCount); 4821703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent audio_io_handle_t getOutput_l(); 4831703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent status_t restoreTrack_l(audio_track_cblk_t*& cblk, bool fromStart); 4849a2aaf927e56a4b4acab23ef16b3f133a9f48a63Glenn Kasten bool stopped_l() const { return !mActive; } 48589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 48689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<IAudioTrack> mAudioTrack; 48789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<IMemory> mCblkMemory; 48889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<AudioTrackThread> mAudioTrackThread; 48989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 49089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project float mVolume[2]; 491be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent float mSendLevel; 49289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mFrameCount; 49389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 49489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project audio_track_cblk_t* mCblk; 495e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten audio_format_t mFormat; 496fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten audio_stream_type_t mStreamType; 49789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint8_t mChannelCount; 49889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint8_t mMuted; 4990d255b2d9061ba31f13ada3fc0f7e51916407176Jean-Michel Trivi uint8_t mReserved; 5000d255b2d9061ba31f13ada3fc0f7e51916407176Jean-Michel Trivi uint32_t mChannelMask; 50189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t mStatus; 50289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mLatency; 50389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 5049a2aaf927e56a4b4acab23ef16b3f133a9f48a63Glenn Kasten bool mActive; // protected by mLock 50589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 50699e53b86eebb605b70dd7591b89bf61a9414ed0eGlenn Kasten callback_t mCbf; // callback handler for events, or NULL 50789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void* mUserData; 508d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent uint32_t mNotificationFramesReq; // requested number of frames between each notification callback 509d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent uint32_t mNotificationFramesAct; // actual number of frames between each notification callback 51089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<IMemory> mSharedBuffer; 51189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int mLoopCount; 51289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mRemainingFrames; 51389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mMarkerPosition; 5142c22aeb65e801f663a754d043062f85e49f77739Jean-Michel Trivi bool mMarkerReached; 51589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mNewPosition; 51689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mUpdatePeriod; 517cd07594333cbe8b2c86c6609cce01a74d6cc33f8Jean-Michel Trivi bool mFlushed; // FIXME will be made obsolete by making flush() synchronous 518c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent uint32_t mFlags; 519be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int mSessionId; 5202beeb50b1bba9e92f6cacfeca37fe9fa9d36ead1Eric Laurent int mAuxEffectId; 5219a2aaf927e56a4b4acab23ef16b3f133a9f48a63Glenn Kasten mutable Mutex mLock; 522cfe2ba6b01a258e39f9c215ffc7b750e0b68f708Eric Laurent status_t mRestoreStatus; 5234ff14bae91075eb274eb1c2975982358946e7e63John Grossman bool mIsTimed; 524879135196fd1c97deefc538c888037c56c2879a7Glenn Kasten int mPreviousPriority; // before start() 525879135196fd1c97deefc538c888037c56c2879a7Glenn Kasten int mPreviousSchedulingGroup; 52689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; 52789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 5284ff14bae91075eb274eb1c2975982358946e7e63John Grossmanclass TimedAudioTrack : public AudioTrack 5294ff14bae91075eb274eb1c2975982358946e7e63John Grossman{ 5304ff14bae91075eb274eb1c2975982358946e7e63John Grossmanpublic: 5314ff14bae91075eb274eb1c2975982358946e7e63John Grossman TimedAudioTrack(); 5324ff14bae91075eb274eb1c2975982358946e7e63John Grossman 5334ff14bae91075eb274eb1c2975982358946e7e63John Grossman /* allocate a shared memory buffer that can be passed to queueTimedBuffer */ 5344ff14bae91075eb274eb1c2975982358946e7e63John Grossman status_t allocateTimedBuffer(size_t size, sp<IMemory>* buffer); 5354ff14bae91075eb274eb1c2975982358946e7e63John Grossman 5364ff14bae91075eb274eb1c2975982358946e7e63John Grossman /* queue a buffer obtained via allocateTimedBuffer for playback at the 5374ff14bae91075eb274eb1c2975982358946e7e63John Grossman given timestamp. PTS units a microseconds on the media time timeline. 5384ff14bae91075eb274eb1c2975982358946e7e63John Grossman The media time transform (set with setMediaTimeTransform) set by the 5394ff14bae91075eb274eb1c2975982358946e7e63John Grossman audio producer will handle converting from media time to local time 5404ff14bae91075eb274eb1c2975982358946e7e63John Grossman (perhaps going through the common time timeline in the case of 5414ff14bae91075eb274eb1c2975982358946e7e63John Grossman synchronized multiroom audio case) */ 5424ff14bae91075eb274eb1c2975982358946e7e63John Grossman status_t queueTimedBuffer(const sp<IMemory>& buffer, int64_t pts); 5434ff14bae91075eb274eb1c2975982358946e7e63John Grossman 5444ff14bae91075eb274eb1c2975982358946e7e63John Grossman /* define a transform between media time and either common time or 5454ff14bae91075eb274eb1c2975982358946e7e63John Grossman local time */ 5464ff14bae91075eb274eb1c2975982358946e7e63John Grossman enum TargetTimeline {LOCAL_TIME, COMMON_TIME}; 5474ff14bae91075eb274eb1c2975982358946e7e63John Grossman status_t setMediaTimeTransform(const LinearTransform& xform, 5484ff14bae91075eb274eb1c2975982358946e7e63John Grossman TargetTimeline target); 5494ff14bae91075eb274eb1c2975982358946e7e63John Grossman}; 55089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 55189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; // namespace android 55289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 55389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#endif // ANDROID_AUDIOTRACK_H 554