AudioRecord.h revision 803b3e558022c6d0eb069308339dc84e6e8035dc
189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project/* 289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Copyright (C) 2008 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 179f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten#ifndef ANDROID_AUDIORECORD_H 189f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten#define ANDROID_AUDIORECORD_H 1989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 20868a6a357018e5872e064b7a13a9b891e2078962Glenn Kasten#include <cutils/sched_policy.h> 21868a6a357018e5872e064b7a13a9b891e2078962Glenn Kasten#include <media/AudioSystem.h> 2289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <media/IAudioRecord.h> 2389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <utils/threads.h> 2489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectnamespace android { 2689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 279f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten// ---------------------------------------------------------------------------- 289f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 2901d3acba9de861cb2b718338e787cff3566fc5ecGlenn Kastenstruct audio_track_cblk_t; 30e3aa659e9cee7df5c12a80d285cc29ab3b2cbb39Glenn Kastenclass AudioRecordClientProxy; 31a3f1fa308728976fc9ca1b4f37d26e633b32b9acGlenn Kasten 3289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project// ---------------------------------------------------------------------------- 3389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 349f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kastenclass AudioRecord : public RefBase 3589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project{ 3689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectpublic: 3789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 3889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Events used by AudioRecord callback function (callback_t). 3902e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten * Keep in sync with frameworks/base/media/java/android/media/AudioRecord.java NATIVE_EVENT_*. 4089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 4189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum event_type { 422b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten EVENT_MORE_DATA = 0, // Request to read available data from buffer. 432b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten // If this event is delivered but the callback handler 442b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten // does not want to read the available data, the handler must 452b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten // explicitly 462b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten // ignore the event by setting frameCount to zero. 472b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten EVENT_OVERRUN = 1, // Buffer overrun occurred. 4889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project EVENT_MARKER = 2, // Record head is at the specified marker position 4989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project // (See setMarkerPosition()). 50c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent EVENT_NEW_POS = 3, // Record head is at a new position 5189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project // (See setPositionUpdatePeriod()). 529f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten EVENT_NEW_IAUDIORECORD = 4, // IAudioRecord was re-created, either due to re-routing and 539f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // voluntary invalidation by mediaserver, or mediaserver crash. 5489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 5589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 56c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten /* Client should declare Buffer on the stack and pass address to obtainBuffer() 57c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * and releaseBuffer(). See also callback_t for EVENT_MORE_DATA. 5889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 5989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 6089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project class Buffer 6189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project { 6289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project public: 639f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // FIXME use m prefix 64c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten size_t frameCount; // number of sample frames corresponding to size; 65c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten // on input it is the number of frames available, 66c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten // on output is the number of frames actually drained 676d238e5ecb4c4266bc865a067072a30187e55f97Glenn Kasten // (currently ignored but will make the primary field in future) 68c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten 699f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten size_t size; // input/output in bytes == frameCount * frameSize 702b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten // on output is the number of bytes actually drained 719f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // FIXME this is redundant with respect to frameCount, 729f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // and TRANSFER_OBTAIN mode is broken for 8-bit data 739f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // since we don't define the frame format 749f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 7589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project union { 7689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void* raw; 77c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten short* i16; // signed 16-bit 78c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten int8_t* i8; // unsigned 8-bit, offset by 0x80 7989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 8089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 8189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 8289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* As a convenience, if a callback is supplied, a handler thread 8389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * is automatically created with the appropriate priority. This thread 842b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten * invokes the callback when a new buffer becomes available or various conditions occur. 8589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 8689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 8789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * event: type of event notified (see enum AudioRecord::event_type). 8889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * user: Pointer to context for use by the callback receiver. 8989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * info: Pointer to optional parameter according to event type: 9089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_MORE_DATA: pointer to AudioRecord::Buffer struct. The callback must not read 91f59497bd3c190e087202043de5450ef06e92b27dGlenn Kasten * more bytes than indicated by 'size' field and update 'size' if 92f59497bd3c190e087202043de5450ef06e92b27dGlenn Kasten * fewer bytes are consumed. 9389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_OVERRUN: unused. 94955e78180ac6111c54f50930b0c4c12395e86cf7Glenn Kasten * - EVENT_MARKER: pointer to const uint32_t containing the marker position in frames. 95955e78180ac6111c54f50930b0c4c12395e86cf7Glenn Kasten * - EVENT_NEW_POS: pointer to const uint32_t containing the new position in frames. 969f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * - EVENT_NEW_IAUDIORECORD: unused. 9789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 9889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 9989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project typedef void (*callback_t)(int event, void* user, void *info); 10089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 10115304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh /* Returns the minimum frame count required for the successful creation of 10215304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh * an AudioRecord object. 10315304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh * Returned status (from utils/Errors.h) can be: 10415304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh * - NO_ERROR: successful operation 10515304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh * - NO_INIT: audio server or audio hardware not initialized 10615304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh * - BAD_VALUE: unsupported configuration 1072b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten * frameCount is guaranteed to be non-zero if status is NO_ERROR, 1082b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten * and is undefined otherwise. 109f5e837e3c7d4b1cee3b18d740bf7d07f4d1ddc1cGlenn Kasten * FIXME This API assumes a route, and so should be deprecated. 11015304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh */ 11115304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh 112e33054eb968cbf8ccaee1b0ff0301403902deed6Glenn Kasten static status_t getMinFrameCount(size_t* frameCount, 11315304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh uint32_t sampleRate, 11458f30210ea540b6ce5aa6a46330cd3499483cb97Glenn Kasten audio_format_t format, 115dd8104cc5367262f0e5f13df4e79f131e8d560bbGlenn Kasten audio_channel_mask_t channelMask); 11615304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh 1179f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* How data is transferred from AudioRecord 1189f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten */ 1199f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten enum transfer_type { 1202b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten TRANSFER_DEFAULT, // not specified explicitly; determine from the other parameters 1219f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten TRANSFER_CALLBACK, // callback EVENT_MORE_DATA 1229f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten TRANSFER_OBTAIN, // FIXME deprecated: call obtainBuffer() and releaseBuffer() 1239f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten TRANSFER_SYNC, // synchronous read() 1249f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten }; 1259f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 12689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Constructs an uninitialized AudioRecord. No connection with 1279f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * AudioFlinger takes place. Use set() after this. 12889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 12989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioRecord(); 13089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 131c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten /* Creates an AudioRecord object and registers it with AudioFlinger. 13289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Once created, the track needs to be started before it can be used. 1339f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Unspecified values are set to appropriate default values. 13489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 13589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 13689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 1379f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * inputSource: Select the audio input to record from (e.g. AUDIO_SOURCE_DEFAULT). 1389f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * sampleRate: Data sink sampling rate in Hz. 139fce7a473248381cc83a01855f92581077d3c9ee2Dima Zavin * format: Audio format (e.g AUDIO_FORMAT_PCM_16_BIT for signed 14089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 16 bits per sample). 1414d74828fc0f6c13d49a36147a4250bcfa8ad0a47Glenn Kasten * channelMask: Channel mask, such that audio_is_input_channel(channelMask) is true. 142c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * frameCount: Minimum size of track PCM buffer in frames. This defines the 143c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * application's contribution to the 144c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * latency of the track. The actual size selected by the AudioRecord could 145c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * be larger if the requested size is not compatible with current audio HAL 146c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * latency. Zero means to use a default value. 14789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * cbf: Callback function. If not null, this function is called periodically 1482b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten * to consume new data and inform of marker, position updates, etc. 14902e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten * user: Context for use by the callback receiver. 15089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * notificationFrames: The callback function is called each time notificationFrames PCM 15189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * frames are ready in record track output buffer. 15202e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten * sessionId: Not yet supported. 1539f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * transferType: How data is transferred from AudioRecord. 15427f7b2a8fe899565487d8a326676a5f7d0a05a37Glenn Kasten * flags: See comments on audio_input_flags_t in <system/audio.h> 1559f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * threadCanCallJava: Not present in parameter list, and so is fixed at false. 156caf7f48a0ef558689d39aafd187c1571ff4128b4Eric Laurent * pAttributes: if not NULL, supersedes inputSource for use case selection 15789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 15889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 159eba51fb3a361f67a6a64d5a16eba6084fe27d60eGlenn Kasten AudioRecord(audio_source_t inputSource, 1604d74828fc0f6c13d49a36147a4250bcfa8ad0a47Glenn Kasten uint32_t sampleRate, 1614d74828fc0f6c13d49a36147a4250bcfa8ad0a47Glenn Kasten audio_format_t format, 1624d74828fc0f6c13d49a36147a4250bcfa8ad0a47Glenn Kasten audio_channel_mask_t channelMask, 163bce50bfc3846ab008bafa75c5d3f29fd7b5395f7Glenn Kasten size_t frameCount = 0, 164a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten callback_t cbf = NULL, 165a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten void* user = NULL, 166838b3d8bafa4a781e277870dee4e0390165cff52Glenn Kasten uint32_t notificationFrames = 0, 167aea7ea06394bcb155972d82055d4ea59962e4051Glenn Kasten int sessionId = AUDIO_SESSION_ALLOCATE, 16827f7b2a8fe899565487d8a326676a5f7d0a05a37Glenn Kasten transfer_type transferType = TRANSFER_DEFAULT, 169caf7f48a0ef558689d39aafd187c1571ff4128b4Eric Laurent audio_input_flags_t flags = AUDIO_INPUT_FLAG_NONE, 170caf7f48a0ef558689d39aafd187c1571ff4128b4Eric Laurent const audio_attributes_t* pAttributes = NULL); 17189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 17289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Terminates the AudioRecord and unregisters it from AudioFlinger. 17302e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten * Also destroys all resources associated with the AudioRecord. 17489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 175e2ffd5b583da9d30d96710b0e8879e90b2b51d30Glenn Kastenprotected: 176e2ffd5b583da9d30d96710b0e8879e90b2b51d30Glenn Kasten virtual ~AudioRecord(); 177e2ffd5b583da9d30d96710b0e8879e90b2b51d30Glenn Kastenpublic: 17889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 1799f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* Initialize an AudioRecord that was created using the AudioRecord() constructor. 1809f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Don't call set() more than once, or after an AudioRecord() constructor that takes parameters. 18189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 18289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful intialization 1839f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * - INVALID_OPERATION: AudioRecord is already initialized or record device is already in use 1842b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten * - BAD_VALUE: invalid parameter (channelMask, format, sampleRate...) 18589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_INIT: audio server or audio hardware not initialized 18689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - PERMISSION_DENIED: recording is not allowed for the requesting process 1872b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten * If status is not equal to NO_ERROR, don't call any other APIs on this AudioRecord. 1889f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * 1899f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Parameters not listed in the AudioRecord constructors above: 1909f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * 1919f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * threadCanCallJava: Whether callbacks are made from an attached thread and thus can call JNI. 192c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten */ 1934d74828fc0f6c13d49a36147a4250bcfa8ad0a47Glenn Kasten status_t set(audio_source_t inputSource, 1944d74828fc0f6c13d49a36147a4250bcfa8ad0a47Glenn Kasten uint32_t sampleRate, 1954d74828fc0f6c13d49a36147a4250bcfa8ad0a47Glenn Kasten audio_format_t format, 1964d74828fc0f6c13d49a36147a4250bcfa8ad0a47Glenn Kasten audio_channel_mask_t channelMask, 197bce50bfc3846ab008bafa75c5d3f29fd7b5395f7Glenn Kasten size_t frameCount = 0, 198a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten callback_t cbf = NULL, 199a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten void* user = NULL, 200838b3d8bafa4a781e277870dee4e0390165cff52Glenn Kasten uint32_t notificationFrames = 0, 201be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent bool threadCanCallJava = false, 202aea7ea06394bcb155972d82055d4ea59962e4051Glenn Kasten int sessionId = AUDIO_SESSION_ALLOCATE, 20327f7b2a8fe899565487d8a326676a5f7d0a05a37Glenn Kasten transfer_type transferType = TRANSFER_DEFAULT, 204caf7f48a0ef558689d39aafd187c1571ff4128b4Eric Laurent audio_input_flags_t flags = AUDIO_INPUT_FLAG_NONE, 205caf7f48a0ef558689d39aafd187c1571ff4128b4Eric Laurent const audio_attributes_t* pAttributes = NULL); 20689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2072b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten /* Result of constructing the AudioRecord. This must be checked for successful initialization 208c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * before using any AudioRecord API (except for set()), because using 20989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * an uninitialized AudioRecord produces undefined results. 21089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * See set() method above for possible return codes. 21189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 2129f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten status_t initCheck() const { return mStatus; } 21389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 214c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten /* Returns this track's estimated latency in milliseconds. 215c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * This includes the latency due to AudioRecord buffer size, 21689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and audio hardware driver. 21789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 2189f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t latency() const { return mLatency; } 21989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 22002e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten /* getters, see constructor and set() */ 22189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2229f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten audio_format_t format() const { return mFormat; } 2239f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t channelCount() const { return mChannelCount; } 2249f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten size_t frameCount() const { return mFrameCount; } 2259f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten size_t frameSize() const { return mFrameSize; } 226caf7f48a0ef558689d39aafd187c1571ff4128b4Eric Laurent audio_source_t inputSource() const { return mAttributes.source; } 22789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 22889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* After it's created the track is not active. Call start() to 22989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * make it active. If set, the callback will start being called. 230c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * If event is not AudioSystem::SYNC_EVENT_NONE, the capture start will be delayed until 231a011e35b22f95f558d81dc9c94b68b1465c4661dEric Laurent * the specified event occurs on the specified trigger session. 23289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 233a011e35b22f95f558d81dc9c94b68b1465c4661dEric Laurent status_t start(AudioSystem::sync_event_t event = AudioSystem::SYNC_EVENT_NONE, 234a011e35b22f95f558d81dc9c94b68b1465c4661dEric Laurent int triggerSession = 0); 23589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2362b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten /* Stop a track. The callback will cease being called. Note that obtainBuffer() still 2379f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * works and will drain buffers until the pool is exhausted, and then will return WOULD_BLOCK. 23889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 239d64cd233eef39430561c1e1df423336a199cc5d7Glenn Kasten void stop(); 24089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project bool stopped() const; 24189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2429f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* Return the sink sample rate for this record track in Hz. 2439f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Unlike AudioTrack, the sample rate is const after initialization, so doesn't need a lock. 24489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 2459f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t getSampleRate() const { return mSampleRate; } 24689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2477c6f87856c0880ee39c2107a0fc3c9b41f8c195cGlenn Kasten /* Return the notification frame count. 2487c6f87856c0880ee39c2107a0fc3c9b41f8c195cGlenn Kasten * This is approximately how often the callback is invoked, for transfer type TRANSFER_CALLBACK. 2497c6f87856c0880ee39c2107a0fc3c9b41f8c195cGlenn Kasten */ 2507c6f87856c0880ee39c2107a0fc3c9b41f8c195cGlenn Kasten size_t notificationFrames() const { return mNotificationFramesAct; } 2517c6f87856c0880ee39c2107a0fc3c9b41f8c195cGlenn Kasten 25289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Sets marker position. When record reaches the number of frames specified, 25389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * a callback with event type EVENT_MARKER is called. Calling setMarkerPosition 254c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * with marker == 0 cancels marker notification callback. 2559f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * To set a marker at a position which would compute as 0, 2562b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten * a workaround is to set the marker at a nearby position such as ~0 or 1. 257c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * If the AudioRecord has been opened with no callback function associated, 25889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * the operation will fail. 25989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 26089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 26189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 2629f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * marker: marker position expressed in wrapping (overflow) frame units, 2639f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * like the return value of getPosition(). 26489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 26589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 26689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 26789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioRecord has no callback installed. 26889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 26989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setMarkerPosition(uint32_t marker); 270606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten status_t getMarkerPosition(uint32_t *marker) const; 27189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 272c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent /* Sets position update period. Every time the number of frames specified has been recorded, 273c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * a callback with event type EVENT_NEW_POS is called. 274c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Calling setPositionUpdatePeriod with updatePeriod == 0 cancels new position notification 275c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * callback. 27689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * If the AudioRecord has been opened with no callback function associated, 27789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * the operation will fail. 2789f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Extremely small values may be rounded up to a value the implementation can support. 27989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 28089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 28189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 28289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * updatePeriod: position update notification period expressed in frames. 28389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 28489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 28589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 28689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioRecord has no callback installed. 28789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 28889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setPositionUpdatePeriod(uint32_t updatePeriod); 289606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten status_t getPositionUpdatePeriod(uint32_t *updatePeriod) const; 29089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2919f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* Return the total number of frames recorded since recording started. 2929f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * The counter will wrap (overflow) periodically, e.g. every ~27 hours at 44.1 kHz. 2939f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * It is reset to zero by stop(). 29489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 29589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 29689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 2979f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * position: Address where to return record head position. 29889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 29989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 30089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 30189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - BAD_VALUE: position is NULL 30289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 303606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten status_t getPosition(uint32_t *position) const; 30489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 305c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten /* Returns a handle on the audio input used by this AudioRecord. 306c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * 307c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Parameters: 308c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * none. 309c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * 310c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Returned value: 311c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * handle on audio hardware input 312c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent */ 313606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten audio_io_handle_t getInput() const; 314c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent 315c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten /* Returns the audio session ID associated with this AudioRecord. 316be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 317be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Parameters: 318be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * none. 319be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 320be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Returned value: 321be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * AudioRecord session ID. 3229f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * 3239f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * No lock needed because session ID doesn't change after first set(). 324be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent */ 3259f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten int getSessionId() const { return mSessionId; } 3269f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 3279f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* Obtains a buffer of up to "audioBuffer->frameCount" full frames. 3289f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * After draining these frames of data, the caller should release them with releaseBuffer(). 3299f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * If the track buffer is not empty, obtainBuffer() returns as many contiguous 3309f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * full frames as are available immediately. 3319f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * If the track buffer is empty and track is stopped, obtainBuffer() returns WOULD_BLOCK 3329f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * regardless of the value of waitCount. 3339f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * If the track buffer is empty and track is not stopped, obtainBuffer() blocks with a 3349f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * maximum timeout based on waitCount; see chart below. 335c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * Buffers will be returned until the pool 33689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * is exhausted, at which point obtainBuffer() will either block 3379f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * or return WOULD_BLOCK depending on the value of the "waitCount" 33889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * parameter. 339c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * 3409f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * obtainBuffer() and releaseBuffer() are deprecated for direct use by applications, 3419f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * which should use read() or callback EVENT_MORE_DATA instead. 3429f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * 343c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * Interpretation of waitCount: 344c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * +n limits wait time to n * WAIT_PERIOD_MS, 345c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * -1 causes an (almost) infinite wait time, 346c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * 0 non-blocking. 3479f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * 3489f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Buffer fields 3499f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * On entry: 3509f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * frameCount number of frames requested 3519f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * After error return: 3529f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * frameCount 0 3539f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * size 0 3549f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * raw undefined 3559f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * After successful return: 3569f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * frameCount actual number of frames available, <= number requested 3579f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * size actual number of bytes available 3589f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * raw pointer to the buffer 35989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 36089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 3619f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* FIXME Deprecated public API for TRANSFER_OBTAIN mode */ 3629f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten status_t obtainBuffer(Buffer* audioBuffer, int32_t waitCount) 3639f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten __attribute__((__deprecated__)); 36489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 3659f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kastenprivate: 36602de89293b74ab1e9a77ce2367c5c499ab038968Glenn Kasten /* If nonContig is non-NULL, it is an output parameter that will be set to the number of 3679f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * additional non-contiguous frames that are available immediately. 3689f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * FIXME We could pass an array of Buffers instead of only one Buffer to obtainBuffer(), 3699f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * in case the requested amount of frames is in two or more non-contiguous regions. 3709f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * FIXME requested and elapsed are both relative times. Consider changing to absolute time. 3719f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten */ 3729f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten status_t obtainBuffer(Buffer* audioBuffer, const struct timespec *requested, 3739f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten struct timespec *elapsed = NULL, size_t *nonContig = NULL); 3749f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kastenpublic: 375c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten 3769f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* Release an emptied buffer of "audioBuffer->frameCount" frames for AudioFlinger to re-fill. */ 3779f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // FIXME make private when obtainBuffer() for TRANSFER_OBTAIN is removed 37889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void releaseBuffer(Buffer* audioBuffer); 37989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 38089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* As a convenience we provide a read() interface to the audio buffer. 3819f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Input parameter 'size' is in byte units. 3829f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * This is implemented on top of obtainBuffer/releaseBuffer. For best 3839f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * performance use callbacks. Returns actual number of bytes read >= 0, 3846ca126d5c83386941c5cb9600099e5510e4430d6Glenn Kasten * or one of the following negative status codes: 3856ca126d5c83386941c5cb9600099e5510e4430d6Glenn Kasten * INVALID_OPERATION AudioRecord is configured for streaming mode 3866ca126d5c83386941c5cb9600099e5510e4430d6Glenn Kasten * BAD_VALUE size is invalid 3876ca126d5c83386941c5cb9600099e5510e4430d6Glenn Kasten * WOULD_BLOCK when obtainBuffer() returns same, or 3886ca126d5c83386941c5cb9600099e5510e4430d6Glenn Kasten * AudioRecord was stopped during the read 3896ca126d5c83386941c5cb9600099e5510e4430d6Glenn Kasten * or any other error code returned by IAudioRecord::start() or restoreRecord_l(). 39089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 39189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project ssize_t read(void* buffer, size_t size); 39289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 393c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten /* Return the number of input frames lost in the audio driver since the last call of this 394417c27304c67057779693007a7bc08e4dd80c262Glenn Kasten * function. Audio driver is expected to reset the value to 0 and restart counting upon 395417c27304c67057779693007a7bc08e4dd80c262Glenn Kasten * returning the current value by this function call. Such loss typically occurs when the 396417c27304c67057779693007a7bc08e4dd80c262Glenn Kasten * user space process is blocked longer than the capacity of audio driver buffers. 397c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * Units: the number of input audio frames. 3985f972c031d4061f4f037c9fda1ea4bd9b6a756cdGlenn Kasten * FIXME The side-effect of resetting the counter may be incompatible with multi-client. 3995f972c031d4061f4f037c9fda1ea4bd9b6a756cdGlenn Kasten * Consider making it more like AudioTrack::getUnderrunFrames which doesn't have side effects. 40005bca2fde53bfe3063d2a0a877f2b6bfdd6052cfEric Laurent */ 4015f972c031d4061f4f037c9fda1ea4bd9b6a756cdGlenn Kasten uint32_t getInputFramesLost() const; 40205bca2fde53bfe3063d2a0a877f2b6bfdd6052cfEric Laurent 40389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectprivate: 404c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten /* copying audio record objects is not allowed */ 40589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioRecord(const AudioRecord& other); 40689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioRecord& operator = (const AudioRecord& other); 40789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 40889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* a small internal class to handle the callback */ 40968337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten class AudioRecordThread : public Thread 41089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project { 41189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project public: 41268337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten AudioRecordThread(AudioRecord& receiver, bool bCanCallJava = false); 41368337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten 41468337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten // Do not call Thread::requestExitAndWait() without first calling requestExit(). 41568337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten // Thread::requestExitAndWait() is not virtual, and the implementation doesn't do enough. 41668337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten virtual void requestExit(); 41768337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten 41868337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten void pause(); // suspend thread from execution at next loop boundary 41968337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten void resume(); // allow thread to execute, if not requested to exit 420803b3e558022c6d0eb069308339dc84e6e8035dcAndy Hung void wake(); // wake to handle changed notification conditions. 42168337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten 42289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project private: 4235a6cd224d07c05b496b6aca050ce5ecf96f125afGlenn Kasten void pauseInternal(nsecs_t ns = 0LL); 4245a6cd224d07c05b496b6aca050ce5ecf96f125afGlenn Kasten // like pause(), but only used internally within thread 4255a6cd224d07c05b496b6aca050ce5ecf96f125afGlenn Kasten 42689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project friend class AudioRecord; 42789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project virtual bool threadLoop(); 4289f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten AudioRecord& mReceiver; 42968337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten virtual ~AudioRecordThread(); 43068337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten Mutex mMyLock; // Thread::mLock is private 43168337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten Condition mMyCond; // Thread::mThreadExitedCondition is private 4325a6cd224d07c05b496b6aca050ce5ecf96f125afGlenn Kasten bool mPaused; // whether thread is requested to pause at next loop entry 4335a6cd224d07c05b496b6aca050ce5ecf96f125afGlenn Kasten bool mPausedInt; // whether thread internally requests pause 4345a6cd224d07c05b496b6aca050ce5ecf96f125afGlenn Kasten nsecs_t mPausedNs; // if mPausedInt then associated timeout, otherwise ignored 435803b3e558022c6d0eb069308339dc84e6e8035dcAndy Hung bool mIgnoreNextPausedInt; // skip any internal pause and go immediately 436803b3e558022c6d0eb069308339dc84e6e8035dcAndy Hung // to processAudioBuffer() as state may have changed 437803b3e558022c6d0eb069308339dc84e6e8035dcAndy Hung // since pause time calculated. 43889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 43989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 44068337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten // body of AudioRecordThread::threadLoop() 4419f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // returns the maximum amount of time before we would like to run again, where: 4429f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // 0 immediately 4439f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // > 0 no later than this many nanoseconds from now 4449f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // NS_WHENEVER still active but no particular deadline 4459f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // NS_INACTIVE inactive so don't run again until re-started 4469f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // NS_NEVER never again 4479f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten static const nsecs_t NS_WHENEVER = -1, NS_INACTIVE = -2, NS_NEVER = -3; 4487c7be1e05634d96d08210efb4bdeb012ffba440dGlenn Kasten nsecs_t processAudioBuffer(); 4499f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 4509f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // caller must hold lock on mLock for all _l methods 4512b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten 452ac0bbe16f3eba46b3d8057b66c2aff9101fc6f7dJeff Brown status_t openRecord_l(size_t epoch); 4539f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 4549f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // FIXME enum is faster than strcmp() for parameter 'from' 4559f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten status_t restoreRecord_l(const char *from); 45689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 45768337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten sp<AudioRecordThread> mAudioRecordThread; 458606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten mutable Mutex mLock; 45989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 4609f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // Current client state: false = stopped, true = active. Protected by mLock. If more states 4619f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // are added, consider changing this to enum State { ... } mState as in AudioTrack. 4629f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten bool mActive; 46389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 46402e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten // for client callback handler 465c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten callback_t mCbf; // callback handler for events, or NULL 4666ca126d5c83386941c5cb9600099e5510e4430d6Glenn Kasten void* mUserData; 46702e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten 46802e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten // for notification APIs 4697cd9cf70e36ad4b8eb12e24f9adbbe6fd69edebdGlenn Kasten uint32_t mNotificationFramesReq; // requested number of frames between each 4707cd9cf70e36ad4b8eb12e24f9adbbe6fd69edebdGlenn Kasten // notification callback 4717410591dad836434c72ddee66680802708b70c10Glenn Kasten // as specified in constructor or set() 4727cd9cf70e36ad4b8eb12e24f9adbbe6fd69edebdGlenn Kasten uint32_t mNotificationFramesAct; // actual number of frames between each 4737cd9cf70e36ad4b8eb12e24f9adbbe6fd69edebdGlenn Kasten // notification callback 4742fc14730e4697a6f456b4631549c9981f6b0b115Glenn Kasten bool mRefreshRemaining; // processAudioBuffer() should refresh 4752fc14730e4697a6f456b4631549c9981f6b0b115Glenn Kasten // mRemainingFrames and mRetryOnPartialBuffer 4769f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 4779f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // These are private to processAudioBuffer(), and are not protected by a lock 4789f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t mRemainingFrames; // number of frames to request in obtainBuffer() 4799f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten bool mRetryOnPartialBuffer; // sleep and retry after partial obtainBuffer() 4808ff50e7526d24aca11713006933b8dcb64ef6be9Glenn Kasten uint32_t mObservedSequence; // last observed value of mSequence 4819f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 4829f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t mMarkerPosition; // in wrapping (overflow) frame units 4837d563247cdac0509009d579bbf849157d47c38a9Jean-Michel Trivi bool mMarkerReached; 48402e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten uint32_t mNewPosition; // in frames 4859f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t mUpdatePeriod; // in frames, zero means no EVENT_NEW_POS 4869f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 4879f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten status_t mStatus; 48802e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten 489b3b2e23fcf7e050710d23b82a6682c0f3d869b69Glenn Kasten size_t mFrameCount; // corresponds to current IAudioRecord, value is 490b3b2e23fcf7e050710d23b82a6682c0f3d869b69Glenn Kasten // reported back by AudioFlinger to the client 491b3b2e23fcf7e050710d23b82a6682c0f3d869b69Glenn Kasten size_t mReqFrameCount; // frame count to request the first or next time 492b3b2e23fcf7e050710d23b82a6682c0f3d869b69Glenn Kasten // a new IAudioRecord is needed, non-decreasing 493b3b2e23fcf7e050710d23b82a6682c0f3d869b69Glenn Kasten 49402e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten // constant after constructor or set() 495e3aa659e9cee7df5c12a80d285cc29ab3b2cbb39Glenn Kasten uint32_t mSampleRate; 49602e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten audio_format_t mFormat; 4979f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t mChannelCount; 49883a0382dc17364567667a4e6135db43f5bd92efcGlenn Kasten size_t mFrameSize; // app-level frame size == AudioFlinger frame size 4999f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t mLatency; // in ms 500624a7fcb377f2a40109c16de5109ae8ea1f67a69Glenn Kasten audio_channel_mask_t mChannelMask; 50127f7b2a8fe899565487d8a326676a5f7d0a05a37Glenn Kasten audio_input_flags_t mFlags; 502be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int mSessionId; 5039f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten transfer_type mTransfer; 5049f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 505d776ac63ce9c013c9626226e43f7db606e035838Glenn Kasten // Next 5 fields may be changed if IAudioRecord is re-created, but always != 0 506d776ac63ce9c013c9626226e43f7db606e035838Glenn Kasten // provided the initial set() was successful 50702e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten sp<IAudioRecord> mAudioRecord; 50802e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten sp<IMemory> mCblkMemory; 5099f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten audio_track_cblk_t* mCblk; // re-load after mLock.unlock() 510d776ac63ce9c013c9626226e43f7db606e035838Glenn Kasten sp<IMemory> mBufferMemory; 51138e905b3cbba4da443d799b16999989781afc6d8Glenn Kasten audio_io_handle_t mInput; // returned by AudioSystem::getInput() 51202e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten 5139f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten int mPreviousPriority; // before start() 514a636433cbd09c0708b85f337ef45c0cdef3bcb4dGlenn Kasten SchedPolicy mPreviousSchedulingGroup; 51528f1351369682801e1bb40a835bdae3c97b73c1cGlenn Kasten bool mAwaitBoost; // thread should wait for priority boost before running 5169f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 5179f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // The proxy should only be referenced while a lock is held because the proxy isn't 5189f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // multi-thread safe. 5199f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // An exception is that a blocking ClientProxy::obtainBuffer() may be called without a lock, 5209f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // provided that the caller also holds an extra reference to the proxy and shared memory to keep 5216ca126d5c83386941c5cb9600099e5510e4430d6Glenn Kasten // them around in case they are replaced during the obtainBuffer(). 5229f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten sp<AudioRecordClientProxy> mProxy; 5239f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 5249f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten bool mInOverrun; // whether recorder is currently in overrun state 5259f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 5269f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kastenprivate: 5279f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten class DeathNotifier : public IBinder::DeathRecipient { 5289f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten public: 5299f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten DeathNotifier(AudioRecord* audioRecord) : mAudioRecord(audioRecord) { } 5309f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten protected: 5319f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten virtual void binderDied(const wp<IBinder>& who); 5329f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten private: 5339f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten const wp<AudioRecord> mAudioRecord; 5349f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten }; 5359f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 5369f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten sp<DeathNotifier> mDeathNotifier; 5379f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t mSequence; // incremented for each new IAudioRecord attempt 538caf7f48a0ef558689d39aafd187c1571ff4128b4Eric Laurent audio_attributes_t mAttributes; 53989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; 54089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 54189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; // namespace android 54289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 5439f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten#endif // ANDROID_AUDIORECORD_H 544