AudioTrack.h revision a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51
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 6189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Create Buffer on the stack and pass it to obtainBuffer() 6289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and releaseBuffer(). 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 }; 7189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t flags; 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 7589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project size_t frameCount; 7689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project size_t size; 7789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project union { 7889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void* raw; 79362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten short* i16; // signed 16-bit 80362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten int8_t* i8; // unsigned 8-bit, offset by 0x80 8189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 8289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 8389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 8489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 8589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* As a convenience, if a callback is supplied, a handler thread 8689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * is automatically created with the appropriate priority. This thread 87362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * invokes the callback when a new buffer becomes available or an underrun condition occurs. 8889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 8989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 9089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * event: type of event notified (see enum AudioTrack::event_type). 9189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * user: Pointer to context for use by the callback receiver. 9289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * info: Pointer to optional parameter according to event type: 9389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_MORE_DATA: pointer to AudioTrack::Buffer struct. The callback must not write 9489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * more bytes than indicated by 'size' field and update 'size' if less bytes are 9589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * written. 9689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_UNDERRUN: unused. 9789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_LOOP_END: pointer to an int indicating the number of loops remaining. 98362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * - EVENT_MARKER: pointer to an uint32_t containing the marker position in frames. 99362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * - EVENT_NEW_POS: pointer to an uint32_t containing the new position in frames. 10089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_BUFFER_END: unused. 10189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 10289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 103d217a8c4632b3e3065f8c2a26b9ce4dc4c97171fGlenn Kasten typedef void (*callback_t)(int event, void* user, void *info); 10489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 10533005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh /* Returns the minimum frame count required for the successful creation of 10633005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh * an AudioTrack object. 10733005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh * Returned status (from utils/Errors.h) can be: 10833005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh * - NO_ERROR: successful operation 10933005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh * - NO_INIT: audio server or audio hardware not initialized 11033005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh */ 11133005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh 11233005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh static status_t getMinFrameCount(int* frameCount, 113fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten audio_stream_type_t streamType = AUDIO_STREAM_DEFAULT, 11433005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh uint32_t sampleRate = 0); 11533005a932c60a0780fe9b7307d5988df3d9f6c26Chia-chi Yeh 11689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Constructs an uninitialized AudioTrack. No connection with 11789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * AudioFlinger takes place. 11889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 11989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioTrack(); 12089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 12189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Creates an audio track and registers it with AudioFlinger. 12289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Once created, the track needs to be started before it can be used. 12389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Unspecified values are set to the audio hardware's current 12489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * values. 12589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 12689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 12789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 12889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * streamType: Select the type of audio stream this track is attached to 129fce7a473248381cc83a01855f92581077d3c9ee2Dima Zavin * (e.g. AUDIO_STREAM_MUSIC). 13089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * sampleRate: Track sampling rate in Hz. 131fce7a473248381cc83a01855f92581077d3c9ee2Dima Zavin * format: Audio format (e.g AUDIO_FORMAT_PCM_16_BIT for signed 13289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 16 bits per sample). 1330d255b2d9061ba31f13ada3fc0f7e51916407176Jean-Michel Trivi * channelMask: Channel mask: see audio_channels_t. 13489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * frameCount: Total size of track PCM buffer in frames. This defines the 13589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * latency of the track. 13689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * flags: Reserved for future use. 13789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * cbf: Callback function. If not null, this function is called periodically 13889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * to request new PCM data. 139362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * user: Context for use by the callback receiver. 14089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * notificationFrames: The callback function is called each time notificationFrames PCM 141362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * frames have been consumed from track input buffer. 142362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * sessionId: Specific session ID, or zero to use default. 14389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 14489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 145fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten AudioTrack( audio_stream_type_t streamType, 14689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t sampleRate = 0, 147e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten audio_format_t format = AUDIO_FORMAT_DEFAULT, 1480d255b2d9061ba31f13ada3fc0f7e51916407176Jean-Michel Trivi int channelMask = 0, 14989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int frameCount = 0, 15089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t flags = 0, 151a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten callback_t cbf = NULL, 152a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten void* user = NULL, 153be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int notificationFrames = 0, 154be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int sessionId = 0); 15589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 156c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber // DEPRECATED 157c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber explicit AudioTrack( int streamType, 158c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber uint32_t sampleRate = 0, 159c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber int format = AUDIO_FORMAT_DEFAULT, 160c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber int channelMask = 0, 161c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber int frameCount = 0, 162c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber uint32_t flags = 0, 163c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber callback_t cbf = 0, 164c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber void* user = 0, 165c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber int notificationFrames = 0, 166c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber int sessionId = 0); 167c813985abd8ba61e999b3505f6a332574f87a1beAndreas Huber 16889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Creates an audio track and registers it with AudioFlinger. With this constructor, 169362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * the PCM data to be rendered by AudioTrack is passed in a shared memory buffer 17089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * identified by the argument sharedBuffer. This prototype is for static buffer playback. 171362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * PCM data must be present in memory before the AudioTrack is started. 172362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * The write() and flush() methods are not supported in this case. 173362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * It is recommended to pass a callback function to be notified of playback end by an 17489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * EVENT_UNDERRUN event. 17589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 17689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 177fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten AudioTrack( audio_stream_type_t streamType, 17889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t sampleRate = 0, 179e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten audio_format_t format = AUDIO_FORMAT_DEFAULT, 1800d255b2d9061ba31f13ada3fc0f7e51916407176Jean-Michel Trivi int channelMask = 0, 18189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project const sp<IMemory>& sharedBuffer = 0, 18289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t flags = 0, 183a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten callback_t cbf = NULL, 184a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten void* user = NULL, 185be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int notificationFrames = 0, 186be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int sessionId = 0); 18789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 18889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Terminates the AudioTrack and unregisters it from AudioFlinger. 189362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * Also destroys all resources associated with the AudioTrack. 19089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 19189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project ~AudioTrack(); 19289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 19389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 19489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Initialize an uninitialized AudioTrack. 19589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 196362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * - NO_ERROR: successful initialization 197362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * - INVALID_OPERATION: AudioTrack is already initialized 198c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * - BAD_VALUE: invalid parameter (channels, format, sampleRate...) 19989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_INIT: audio server or audio hardware not initialized 20089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * */ 201fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten status_t set(audio_stream_type_t streamType = AUDIO_STREAM_DEFAULT, 20289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t sampleRate = 0, 203e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten audio_format_t format = AUDIO_FORMAT_DEFAULT, 2040d255b2d9061ba31f13ada3fc0f7e51916407176Jean-Michel Trivi int channelMask = 0, 20589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int frameCount = 0, 20689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t flags = 0, 207a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten callback_t cbf = NULL, 208a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten void* user = NULL, 20989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int notificationFrames = 0, 21089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project const sp<IMemory>& sharedBuffer = 0, 211be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent bool threadCanCallJava = false, 212be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int sessionId = 0); 21389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 21489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 21589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Result of constructing the AudioTrack. This must be checked 216362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * before using any AudioTrack API (except for set()), because using 21789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * an uninitialized AudioTrack produces undefined results. 21889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * See set() method above for possible return codes. 21989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 22089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t initCheck() const; 22189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 222362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Returns this track's estimated latency in milliseconds. 22389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * This includes the latency due to AudioTrack buffer size, AudioMixer (if any) 22489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and audio hardware driver. 22589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 22689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t latency() const; 22789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 22889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* getters, see constructor */ 22989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 230fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten audio_stream_type_t streamType() const; 231e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten audio_format_t format() const; 23289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int channelCount() const; 23389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t frameCount() const; 234b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten 235b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten /* Return channelCount * (bit depth per channel / 8). 236b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten * channelCount is determined from channelMask, and bit depth comes from format. 237b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten */ 238b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten size_t frameSize() const; 239b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten 24089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<IMemory>& sharedBuffer(); 24189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 24289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 24389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* After it's created the track is not active. Call start() to 24489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * make it active. If set, the callback will start being called. 24589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 24689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void start(); 24789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 24889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Stop a track. If set, the callback will cease being called and 24989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * obtainBuffer returns STOPPED. Note that obtainBuffer() still works 25089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and will fill up buffers until the pool is exhausted. 25189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 25289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void stop(); 25389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project bool stopped() const; 25489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 255362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Flush a stopped track. All pending buffers are discarded. 256362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * This function has no effect if the track is not stopped. 25789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 25889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void flush(); 25989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 26089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Pause a track. If set, the callback will cease being called and 26189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * obtainBuffer returns STOPPED. Note that obtainBuffer() still works 26289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and will fill up buffers until the pool is exhausted. 26389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 26489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void pause(); 26589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 266362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Mute or unmute this track. 267362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * While muted, the callback, if set, is still called. 26889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 26989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void mute(bool); 27089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project bool muted() const; 27189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 272362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Set volume for this track, mostly used for games' sound effects 273362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * left and right volumes. Levels must be >= 0.0 and <= 1.0. 27489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 275be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent status_t setVolume(float left, float right); 276a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten void getVolume(float* left, float* right) const; 27789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 278362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Set the send level for this track. An auxiliary effect should be attached 279362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * to the track with attachEffect(). Level must be >= 0.0 and <= 1.0. 280be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent */ 2812beeb50b1bba9e92f6cacfeca37fe9fa9d36ead1Eric Laurent status_t setAuxEffectSendLevel(float level); 282a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten void getAuxEffectSendLevel(float* level) const; 283be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent 284362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Set sample rate for this track, mostly used for games' sound effects 28589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 286573266210fb2b2e7d86fbd46d0dfe16763611d91Eric Laurent status_t setSampleRate(int sampleRate); 287a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten uint32_t getSampleRate() const; 28889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 28989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Enables looping and sets the start and end points of looping. 29089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 29189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 29289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 29389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * loopStart: loop start expressed as the number of PCM frames played since AudioTrack start. 29489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * loopEnd: loop end expressed as the number of PCM frames played since AudioTrack start. 295362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * loopCount: number of loops to execute. Calling setLoop() with loopCount == 0 cancels any 296362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * pending or active loop. loopCount = -1 means infinite looping. 29789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 29889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * For proper operation the following condition must be respected: 29989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * (loopEnd-loopStart) <= framecount() 30089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 30189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setLoop(uint32_t loopStart, uint32_t loopEnd, int loopCount); 302a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten status_t getLoop(uint32_t *loopStart, uint32_t *loopEnd, int *loopCount) const; 30389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 304362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Sets marker position. When playback reaches the number of frames specified, a callback with 305362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * event type EVENT_MARKER is called. Calling setMarkerPosition with marker == 0 cancels marker 306362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * notification callback. 30789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * If the AudioTrack has been opened with no callback function associated, the operation will fail. 30889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 30989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 31089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 31189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * marker: marker position expressed in frames. 31289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 31389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 31489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 31589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioTrack has no callback installed. 31689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 31789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setMarkerPosition(uint32_t marker); 318a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten status_t getMarkerPosition(uint32_t *marker) const; 31989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 32089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 321362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Sets position update period. Every time the number of frames specified has been played, 322362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * a callback with event type EVENT_NEW_POS is called. 323362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * Calling setPositionUpdatePeriod with updatePeriod == 0 cancels new position notification 324362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * callback. 32589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * If the AudioTrack has been opened with no callback function associated, the operation will fail. 32689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 32789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 32889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 32989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * updatePeriod: position update notification period expressed in frames. 33089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 33189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 33289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 33389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioTrack has no callback installed. 33489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 33589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setPositionUpdatePeriod(uint32_t updatePeriod); 336a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten status_t getPositionUpdatePeriod(uint32_t *updatePeriod) const; 33789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 33889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Sets playback head position within AudioTrack buffer. The new position is specified 339362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * in number of frames. 34089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * This method must be called with the AudioTrack in paused or stopped state. 341362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * Note that the actual position set is <position> modulo the AudioTrack buffer size in frames. 342362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * Therefore using this method makes sense only when playing a "static" audio buffer 34389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * as opposed to streaming. 34489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * The getPosition() method on the other hand returns the total number of frames played since 34589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * playback start. 34689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 34789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 34889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 34989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * position: New playback head position within AudioTrack buffer. 35089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 35189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 35289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 35389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioTrack is not stopped. 354362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * - BAD_VALUE: The specified position is beyond the number of frames present in AudioTrack buffer 35589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 35689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setPosition(uint32_t position); 35789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t getPosition(uint32_t *position); 35889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 359362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Forces AudioTrack buffer full condition. When playing a static buffer, this method avoids 36089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * rewriting the buffer before restarting playback after a stop. 36189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * This method must be called with the AudioTrack in paused or stopped state. 36289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 36389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 36489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 36589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioTrack is not stopped. 36689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 36789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t reload(); 36889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 369362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Returns a handle on the audio output used by this AudioTrack. 370c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * 371c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Parameters: 372c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * none. 373c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * 374c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Returned value: 375c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * handle on audio hardware output 376c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent */ 377c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent audio_io_handle_t getOutput(); 378c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent 379362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Returns the unique session ID associated with this track. 380be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 381be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Parameters: 382be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * none. 383be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 384be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Returned value: 385362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * AudioTrack session ID. 386be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent */ 387a5224f319e2ba4b51ddb4287705ccf8d4b8ecc51Glenn Kasten int getSessionId() const; 388be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent 389362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Attach track auxiliary output to specified effect. Use effectId = 0 390be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * to detach track from effect. 391be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 392be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Parameters: 393be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 394be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * effectId: effectId obtained from AudioEffect::id(). 395be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 396be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Returned status (from utils/Errors.h) can be: 397be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * - NO_ERROR: successful operation 398be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * - INVALID_OPERATION: the effect is not an auxiliary effect. 399be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * - BAD_VALUE: The specified effect ID is invalid 400be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent */ 401be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent status_t attachAuxEffect(int effectId); 402be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent 403362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten /* Obtains a buffer of "frameCount" frames. The buffer must be 40489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * filled entirely. If the track is stopped, obtainBuffer() returns 405362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * STOPPED instead of NO_ERROR as long as there are buffers available, 40689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * at which point NO_MORE_BUFFERS is returned. 40789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Buffers will be returned until the pool (buffercount()) 40889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * is exhausted, at which point obtainBuffer() will either block 40989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * or return WOULD_BLOCK depending on the value of the "blocking" 41089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * parameter. 41189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 41289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 41389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum { 414335787fe43596f38ea2fa50b24c54d0823a3fb1dGlenn Kasten NO_MORE_BUFFERS = 0x80000001, // same name in AudioFlinger.h, ok to be different value 41589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project STOPPED = 1 41689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 41789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 41889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t obtainBuffer(Buffer* audioBuffer, int32_t waitCount); 41989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void releaseBuffer(Buffer* audioBuffer); 42089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 42189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* As a convenience we provide a write() interface to the audio buffer. 42289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * This is implemented on top of lockBuffer/unlockBuffer. For best 423362c4e697d8e9c034e964ac7b40227e054491547Glenn Kasten * performance use callbacks. Return actual number of bytes written. 42489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 42589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 42689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project ssize_t write(const void* buffer, size_t size); 42789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 42889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* 42989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Dumps the state of an audio track. 43089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 43189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t dump(int fd, const Vector<String16>& args) const; 43289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 43389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectprivate: 43489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* copying audio tracks is not allowed */ 43589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioTrack(const AudioTrack& other); 43689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioTrack& operator = (const AudioTrack& other); 43789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 43889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* a small internal class to handle the callback */ 43989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project class AudioTrackThread : public Thread 44089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project { 44189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project public: 44289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioTrackThread(AudioTrack& receiver, bool bCanCallJava = false); 44389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project private: 44489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project friend class AudioTrack; 44589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project virtual bool threadLoop(); 44689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project virtual status_t readyToRun(); 44789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project virtual void onFirstRef(); 44889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioTrack& mReceiver; 44989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project Mutex mLock; 45089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 45189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 45289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project bool processAudioBuffer(const sp<AudioTrackThread>& thread); 453fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten status_t createTrack_l(audio_stream_type_t streamType, 45434f1d8ecd23169a5f299937e3aaf1bd7937578a0Eric Laurent uint32_t sampleRate, 455e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten audio_format_t format, 4560d255b2d9061ba31f13ada3fc0f7e51916407176Jean-Michel Trivi uint32_t channelMask, 45734f1d8ecd23169a5f299937e3aaf1bd7937578a0Eric Laurent int frameCount, 45834f1d8ecd23169a5f299937e3aaf1bd7937578a0Eric Laurent uint32_t flags, 45934f1d8ecd23169a5f299937e3aaf1bd7937578a0Eric Laurent const sp<IMemory>& sharedBuffer, 460d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent audio_io_handle_t output, 461d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent bool enforceFrameCount); 4621703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent void flush_l(); 4631703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent status_t setLoop_l(uint32_t loopStart, uint32_t loopEnd, int loopCount); 4641703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent audio_io_handle_t getOutput_l(); 4651703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent status_t restoreTrack_l(audio_track_cblk_t*& cblk, bool fromStart); 4669a2aaf927e56a4b4acab23ef16b3f133a9f48a63Glenn Kasten bool stopped_l() const { return !mActive; } 46789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 46889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<IAudioTrack> mAudioTrack; 46989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<IMemory> mCblkMemory; 47089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<AudioTrackThread> mAudioTrackThread; 47189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 47289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project float mVolume[2]; 473be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent float mSendLevel; 47489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mFrameCount; 47589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 47689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project audio_track_cblk_t* mCblk; 477e1c3962e268ffc12bfd1bd9ea84da1f135f36960Glenn Kasten audio_format_t mFormat; 478fff6d715a8db0daf08a50634f242c40268de3d49Glenn Kasten audio_stream_type_t mStreamType; 47989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint8_t mChannelCount; 48089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint8_t mMuted; 4810d255b2d9061ba31f13ada3fc0f7e51916407176Jean-Michel Trivi uint8_t mReserved; 4820d255b2d9061ba31f13ada3fc0f7e51916407176Jean-Michel Trivi uint32_t mChannelMask; 48389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t mStatus; 48489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mLatency; 48589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 4869a2aaf927e56a4b4acab23ef16b3f133a9f48a63Glenn Kasten bool mActive; // protected by mLock 48789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 48889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project callback_t mCbf; 48989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void* mUserData; 490d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent uint32_t mNotificationFramesReq; // requested number of frames between each notification callback 491d1b449aad6c087a69f5ec66b7facb2845b73f1cbEric Laurent uint32_t mNotificationFramesAct; // actual number of frames between each notification callback 49289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<IMemory> mSharedBuffer; 49389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int mLoopCount; 49489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mRemainingFrames; 49589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mMarkerPosition; 4962c22aeb65e801f663a754d043062f85e49f77739Jean-Michel Trivi bool mMarkerReached; 49789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mNewPosition; 49889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mUpdatePeriod; 499cd07594333cbe8b2c86c6609cce01a74d6cc33f8Jean-Michel Trivi bool mFlushed; // FIXME will be made obsolete by making flush() synchronous 500c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent uint32_t mFlags; 501be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int mSessionId; 5022beeb50b1bba9e92f6cacfeca37fe9fa9d36ead1Eric Laurent int mAuxEffectId; 5039a2aaf927e56a4b4acab23ef16b3f133a9f48a63Glenn Kasten mutable Mutex mLock; 504cfe2ba6b01a258e39f9c215ffc7b750e0b68f708Eric Laurent status_t mRestoreStatus; 505879135196fd1c97deefc538c888037c56c2879a7Glenn Kasten int mPreviousPriority; // before start() 506879135196fd1c97deefc538c888037c56c2879a7Glenn Kasten int mPreviousSchedulingGroup; 50789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; 50889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 50989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 51089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; // namespace android 51189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 51289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#endif // ANDROID_AUDIOTRACK_H 513