AudioRecord.h revision 4d74828fc0f6c13d49a36147a4250bcfa8ad0a47
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 29a3f1fa308728976fc9ca1b4f37d26e633b32b9acGlenn Kastenclass 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 static const int DEFAULT_SAMPLE_RATE = 8000; 3989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 4089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Events used by AudioRecord callback function (callback_t). 4102e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten * Keep in sync with frameworks/base/media/java/android/media/AudioRecord.java NATIVE_EVENT_*. 4289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 4389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum event_type { 4402e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten EVENT_MORE_DATA = 0, // Request to read more data from PCM buffer. 45c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten EVENT_OVERRUN = 1, // PCM buffer overrun occurred. 4689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project EVENT_MARKER = 2, // Record head is at the specified marker position 4789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project // (See setMarkerPosition()). 48c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent EVENT_NEW_POS = 3, // Record head is at a new position 4989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project // (See setPositionUpdatePeriod()). 509f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten EVENT_NEW_IAUDIORECORD = 4, // IAudioRecord was re-created, either due to re-routing and 519f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // voluntary invalidation by mediaserver, or mediaserver crash. 5289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 5389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 54c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten /* Client should declare Buffer on the stack and pass address to obtainBuffer() 55c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * and releaseBuffer(). See also callback_t for EVENT_MORE_DATA. 5689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 5789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 5889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project class Buffer 5989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project { 6089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project public: 619f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // FIXME use m prefix 62c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten size_t frameCount; // number of sample frames corresponding to size; 63c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten // on input it is the number of frames available, 64c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten // on output is the number of frames actually drained 65c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten 669f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten size_t size; // input/output in bytes == frameCount * frameSize 679f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // FIXME this is redundant with respect to frameCount, 689f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // and TRANSFER_OBTAIN mode is broken for 8-bit data 699f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // since we don't define the frame format 709f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 7189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project union { 7289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void* raw; 73c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten short* i16; // signed 16-bit 74c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten int8_t* i8; // unsigned 8-bit, offset by 0x80 7589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 7689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 7789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 7889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* As a convenience, if a callback is supplied, a handler thread 7989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * is automatically created with the appropriate priority. This thread 80c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * invokes the callback when a new buffer becomes ready or various conditions occur. 8189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 8289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 8389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * event: type of event notified (see enum AudioRecord::event_type). 8489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * user: Pointer to context for use by the callback receiver. 8589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * info: Pointer to optional parameter according to event type: 8689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_MORE_DATA: pointer to AudioRecord::Buffer struct. The callback must not read 87c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * more bytes than indicated by 'size' field and update 'size' if fewer bytes are 88c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * consumed. 8989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_OVERRUN: unused. 90955e78180ac6111c54f50930b0c4c12395e86cf7Glenn Kasten * - EVENT_MARKER: pointer to const uint32_t containing the marker position in frames. 91955e78180ac6111c54f50930b0c4c12395e86cf7Glenn Kasten * - EVENT_NEW_POS: pointer to const uint32_t containing the new position in frames. 929f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * - EVENT_NEW_IAUDIORECORD: unused. 9389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 9489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 9589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project typedef void (*callback_t)(int event, void* user, void *info); 9689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 9715304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh /* Returns the minimum frame count required for the successful creation of 9815304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh * an AudioRecord object. 9915304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh * Returned status (from utils/Errors.h) can be: 10015304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh * - NO_ERROR: successful operation 10115304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh * - NO_INIT: audio server or audio hardware not initialized 10215304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh * - BAD_VALUE: unsupported configuration 10315304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh */ 10415304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh 105e33054eb968cbf8ccaee1b0ff0301403902deed6Glenn Kasten static status_t getMinFrameCount(size_t* frameCount, 10615304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh uint32_t sampleRate, 10758f30210ea540b6ce5aa6a46330cd3499483cb97Glenn Kasten audio_format_t format, 108dd8104cc5367262f0e5f13df4e79f131e8d560bbGlenn Kasten audio_channel_mask_t channelMask); 10915304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh 1109f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* How data is transferred from AudioRecord 1119f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten */ 1129f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten enum transfer_type { 1139f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten TRANSFER_DEFAULT, // not specified explicitly; determine from other parameters 1149f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten TRANSFER_CALLBACK, // callback EVENT_MORE_DATA 1159f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten TRANSFER_OBTAIN, // FIXME deprecated: call obtainBuffer() and releaseBuffer() 1169f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten TRANSFER_SYNC, // synchronous read() 1179f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten }; 1189f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 11989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Constructs an uninitialized AudioRecord. No connection with 1209f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * AudioFlinger takes place. Use set() after this. 12189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 12289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioRecord(); 12389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 124c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten /* Creates an AudioRecord object and registers it with AudioFlinger. 12589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Once created, the track needs to be started before it can be used. 1269f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Unspecified values are set to appropriate default values. 12789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 12889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 12989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 1309f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * inputSource: Select the audio input to record from (e.g. AUDIO_SOURCE_DEFAULT). 1319f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * sampleRate: Data sink sampling rate in Hz. 132fce7a473248381cc83a01855f92581077d3c9ee2Dima Zavin * format: Audio format (e.g AUDIO_FORMAT_PCM_16_BIT for signed 13389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 16 bits per sample). 1344d74828fc0f6c13d49a36147a4250bcfa8ad0a47Glenn Kasten * channelMask: Channel mask, such that audio_is_input_channel(channelMask) is true. 135c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * frameCount: Minimum size of track PCM buffer in frames. This defines the 136c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * application's contribution to the 137c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * latency of the track. The actual size selected by the AudioRecord could 138c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * be larger if the requested size is not compatible with current audio HAL 139c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * latency. Zero means to use a default value. 14089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * cbf: Callback function. If not null, this function is called periodically 1419f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * to consume new PCM data and inform of marker, position updates, etc. 14202e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten * user: Context for use by the callback receiver. 14389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * notificationFrames: The callback function is called each time notificationFrames PCM 14489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * frames are ready in record track output buffer. 14502e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten * sessionId: Not yet supported. 1469f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * transferType: How data is transferred from AudioRecord. 1479f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * threadCanCallJava: Not present in parameter list, and so is fixed at false. 14889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 14989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 150eba51fb3a361f67a6a64d5a16eba6084fe27d60eGlenn Kasten AudioRecord(audio_source_t inputSource, 1514d74828fc0f6c13d49a36147a4250bcfa8ad0a47Glenn Kasten uint32_t sampleRate, 1524d74828fc0f6c13d49a36147a4250bcfa8ad0a47Glenn Kasten audio_format_t format, 1534d74828fc0f6c13d49a36147a4250bcfa8ad0a47Glenn Kasten audio_channel_mask_t channelMask, 15489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int frameCount = 0, 155a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten callback_t cbf = NULL, 156a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten void* user = NULL, 157be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int notificationFrames = 0, 1589f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten int sessionId = 0, 1599f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten transfer_type transferType = TRANSFER_DEFAULT); 16089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 16189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Terminates the AudioRecord and unregisters it from AudioFlinger. 16202e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten * Also destroys all resources associated with the AudioRecord. 16389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 164e2ffd5b583da9d30d96710b0e8879e90b2b51d30Glenn Kastenprotected: 165e2ffd5b583da9d30d96710b0e8879e90b2b51d30Glenn Kasten virtual ~AudioRecord(); 166e2ffd5b583da9d30d96710b0e8879e90b2b51d30Glenn Kastenpublic: 16789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 1689f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* Initialize an AudioRecord that was created using the AudioRecord() constructor. 1699f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Don't call set() more than once, or after an AudioRecord() constructor that takes parameters. 17089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 17189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful intialization 1729f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * - INVALID_OPERATION: AudioRecord is already initialized or record device is already in use 173c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * - BAD_VALUE: invalid parameter (channels, format, sampleRate...) 17489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_INIT: audio server or audio hardware not initialized 17589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - PERMISSION_DENIED: recording is not allowed for the requesting process 1769f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * 1779f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Parameters not listed in the AudioRecord constructors above: 1789f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * 1799f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * threadCanCallJava: Whether callbacks are made from an attached thread and thus can call JNI. 180c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten */ 1814d74828fc0f6c13d49a36147a4250bcfa8ad0a47Glenn Kasten status_t set(audio_source_t inputSource, 1824d74828fc0f6c13d49a36147a4250bcfa8ad0a47Glenn Kasten uint32_t sampleRate, 1834d74828fc0f6c13d49a36147a4250bcfa8ad0a47Glenn Kasten audio_format_t format, 1844d74828fc0f6c13d49a36147a4250bcfa8ad0a47Glenn Kasten audio_channel_mask_t channelMask, 18589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int frameCount = 0, 186a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten callback_t cbf = NULL, 187a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten void* user = NULL, 18889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int notificationFrames = 0, 189be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent bool threadCanCallJava = false, 1909f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten int sessionId = 0, 1919f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten transfer_type transferType = TRANSFER_DEFAULT); 19289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 19389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Result of constructing the AudioRecord. This must be checked 194c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * before using any AudioRecord API (except for set()), because using 19589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * an uninitialized AudioRecord produces undefined results. 19689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * See set() method above for possible return codes. 19789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 1989f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten status_t initCheck() const { return mStatus; } 19989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 200c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten /* Returns this track's estimated latency in milliseconds. 201c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * This includes the latency due to AudioRecord buffer size, 20289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and audio hardware driver. 20389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 2049f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t latency() const { return mLatency; } 20589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 20602e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten /* getters, see constructor and set() */ 20789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2089f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten audio_format_t format() const { return mFormat; } 2099f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t channelCount() const { return mChannelCount; } 2109f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten size_t frameCount() const { return mFrameCount; } 2119f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten size_t frameSize() const { return mFrameSize; } 2129f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten audio_source_t inputSource() const { return mInputSource; } 21389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 21489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* After it's created the track is not active. Call start() to 21589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * make it active. If set, the callback will start being called. 216c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * If event is not AudioSystem::SYNC_EVENT_NONE, the capture start will be delayed until 217a011e35b22f95f558d81dc9c94b68b1465c4661dEric Laurent * the specified event occurs on the specified trigger session. 21889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 219a011e35b22f95f558d81dc9c94b68b1465c4661dEric Laurent status_t start(AudioSystem::sync_event_t event = AudioSystem::SYNC_EVENT_NONE, 220a011e35b22f95f558d81dc9c94b68b1465c4661dEric Laurent int triggerSession = 0); 22189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2229f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* Stop a track. If set, the callback will cease being called. Note that obtainBuffer() still 2239f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * works and will drain buffers until the pool is exhausted, and then will return WOULD_BLOCK. 22489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 225d64cd233eef39430561c1e1df423336a199cc5d7Glenn Kasten void stop(); 22689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project bool stopped() const; 22789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2289f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* Return the sink sample rate for this record track in Hz. 2299f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Unlike AudioTrack, the sample rate is const after initialization, so doesn't need a lock. 23089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 2319f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t getSampleRate() const { return mSampleRate; } 23289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 23389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Sets marker position. When record reaches the number of frames specified, 23489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * a callback with event type EVENT_MARKER is called. Calling setMarkerPosition 235c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * with marker == 0 cancels marker notification callback. 2369f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * To set a marker at a position which would compute as 0, 2379f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * a workaround is to the set the marker at a nearby position such as ~0 or 1. 238c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * If the AudioRecord has been opened with no callback function associated, 23989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * the operation will fail. 24089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 24189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 24289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 2439f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * marker: marker position expressed in wrapping (overflow) frame units, 2449f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * like the return value of getPosition(). 24589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 24689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 24789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 24889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioRecord has no callback installed. 24989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 25089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setMarkerPosition(uint32_t marker); 251606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten status_t getMarkerPosition(uint32_t *marker) const; 25289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 253c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent /* Sets position update period. Every time the number of frames specified has been recorded, 254c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * a callback with event type EVENT_NEW_POS is called. 255c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Calling setPositionUpdatePeriod with updatePeriod == 0 cancels new position notification 256c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * callback. 25789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * If the AudioRecord has been opened with no callback function associated, 25889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * the operation will fail. 2599f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Extremely small values may be rounded up to a value the implementation can support. 26089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 26189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 26289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 26389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * updatePeriod: position update notification period expressed in frames. 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 setPositionUpdatePeriod(uint32_t updatePeriod); 270606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten status_t getPositionUpdatePeriod(uint32_t *updatePeriod) const; 27189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2729f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* Return the total number of frames recorded since recording started. 2739f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * The counter will wrap (overflow) periodically, e.g. every ~27 hours at 44.1 kHz. 2749f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * It is reset to zero by stop(). 27589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 27689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 27789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 2789f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * position: Address where to return record head position. 27989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 28089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 28189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 28289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - BAD_VALUE: position is NULL 28389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 284606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten status_t getPosition(uint32_t *position) const; 28589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 286c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten /* Returns a handle on the audio input used by this AudioRecord. 287c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * 288c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Parameters: 289c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * none. 290c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * 291c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Returned value: 292c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * handle on audio hardware input 293c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent */ 294606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten audio_io_handle_t getInput() const; 295c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent 296c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten /* Returns the audio session ID associated with this AudioRecord. 297be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 298be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Parameters: 299be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * none. 300be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 301be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Returned value: 302be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * AudioRecord session ID. 3039f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * 3049f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * No lock needed because session ID doesn't change after first set(). 305be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent */ 3069f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten int getSessionId() const { return mSessionId; } 3079f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 3089f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* Obtains a buffer of up to "audioBuffer->frameCount" full frames. 3099f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * After draining these frames of data, the caller should release them with releaseBuffer(). 3109f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * If the track buffer is not empty, obtainBuffer() returns as many contiguous 3119f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * full frames as are available immediately. 3129f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * If the track buffer is empty and track is stopped, obtainBuffer() returns WOULD_BLOCK 3139f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * regardless of the value of waitCount. 3149f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * If the track buffer is empty and track is not stopped, obtainBuffer() blocks with a 3159f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * maximum timeout based on waitCount; see chart below. 316c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * Buffers will be returned until the pool 31789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * is exhausted, at which point obtainBuffer() will either block 3189f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * or return WOULD_BLOCK depending on the value of the "waitCount" 31989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * parameter. 320c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * 3219f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * obtainBuffer() and releaseBuffer() are deprecated for direct use by applications, 3229f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * which should use read() or callback EVENT_MORE_DATA instead. 3239f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * 324c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * Interpretation of waitCount: 325c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * +n limits wait time to n * WAIT_PERIOD_MS, 326c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * -1 causes an (almost) infinite wait time, 327c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * 0 non-blocking. 3289f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * 3299f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Buffer fields 3309f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * On entry: 3319f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * frameCount number of frames requested 3329f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * After error return: 3339f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * frameCount 0 3349f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * size 0 3359f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * raw undefined 3369f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * After successful return: 3379f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * frameCount actual number of frames available, <= number requested 3389f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * size actual number of bytes available 3399f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * raw pointer to the buffer 34089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 34189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 3429f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* FIXME Deprecated public API for TRANSFER_OBTAIN mode */ 3439f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten status_t obtainBuffer(Buffer* audioBuffer, int32_t waitCount) 3449f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten __attribute__((__deprecated__)); 34589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 3469f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kastenprivate: 3479f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* New internal API. 3489f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * If nonContig is non-NULL, it is an output parameter that will be set to the number of 3499f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * additional non-contiguous frames that are available immediately. 3509f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * FIXME We could pass an array of Buffers instead of only one Buffer to obtainBuffer(), 3519f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * in case the requested amount of frames is in two or more non-contiguous regions. 3529f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * FIXME requested and elapsed are both relative times. Consider changing to absolute time. 3539f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten */ 3549f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten status_t obtainBuffer(Buffer* audioBuffer, const struct timespec *requested, 3559f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten struct timespec *elapsed = NULL, size_t *nonContig = NULL); 3569f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kastenpublic: 357c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten 3589f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* Release an emptied buffer of "audioBuffer->frameCount" frames for AudioFlinger to re-fill. */ 3599f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // FIXME make private when obtainBuffer() for TRANSFER_OBTAIN is removed 36089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void releaseBuffer(Buffer* audioBuffer); 36189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 36289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* As a convenience we provide a read() interface to the audio buffer. 3639f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Input parameter 'size' is in byte units. 3649f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * This is implemented on top of obtainBuffer/releaseBuffer. For best 3659f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * performance use callbacks. Returns actual number of bytes read >= 0, 3669f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * or a negative status code. 36789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 36889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project ssize_t read(void* buffer, size_t size); 36989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 370c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten /* Return the number of input frames lost in the audio driver since the last call of this 371417c27304c67057779693007a7bc08e4dd80c262Glenn Kasten * function. Audio driver is expected to reset the value to 0 and restart counting upon 372417c27304c67057779693007a7bc08e4dd80c262Glenn Kasten * returning the current value by this function call. Such loss typically occurs when the 373417c27304c67057779693007a7bc08e4dd80c262Glenn Kasten * user space process is blocked longer than the capacity of audio driver buffers. 374c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * Units: the number of input audio frames. 37505bca2fde53bfe3063d2a0a877f2b6bfdd6052cfEric Laurent */ 376606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten unsigned int getInputFramesLost() const; 37705bca2fde53bfe3063d2a0a877f2b6bfdd6052cfEric Laurent 37889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectprivate: 379c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten /* copying audio record objects is not allowed */ 38089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioRecord(const AudioRecord& other); 38189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioRecord& operator = (const AudioRecord& other); 38289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 38389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* a small internal class to handle the callback */ 38468337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten class AudioRecordThread : public Thread 38589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project { 38689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project public: 38768337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten AudioRecordThread(AudioRecord& receiver, bool bCanCallJava = false); 38868337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten 38968337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten // Do not call Thread::requestExitAndWait() without first calling requestExit(). 39068337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten // Thread::requestExitAndWait() is not virtual, and the implementation doesn't do enough. 39168337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten virtual void requestExit(); 39268337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten 39368337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten void pause(); // suspend thread from execution at next loop boundary 39468337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten void resume(); // allow thread to execute, if not requested to exit 3959f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten void pauseConditional(); 3969f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // like pause(), but only if prior resume() wasn't latched 39768337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten 39889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project private: 39989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project friend class AudioRecord; 40089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project virtual bool threadLoop(); 4019f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten AudioRecord& mReceiver; 40268337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten virtual ~AudioRecordThread(); 40368337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten Mutex mMyLock; // Thread::mLock is private 40468337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten Condition mMyCond; // Thread::mThreadExitedCondition is private 40568337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten bool mPaused; // whether thread is currently paused 4069f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten bool mResumeLatch; // whether next pauseConditional() will be a nop 40789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 40889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 40968337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten // body of AudioRecordThread::threadLoop() 4109f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // returns the maximum amount of time before we would like to run again, where: 4119f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // 0 immediately 4129f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // > 0 no later than this many nanoseconds from now 4139f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // NS_WHENEVER still active but no particular deadline 4149f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // NS_INACTIVE inactive so don't run again until re-started 4159f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // NS_NEVER never again 4169f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten static const nsecs_t NS_WHENEVER = -1, NS_INACTIVE = -2, NS_NEVER = -3; 4179f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten nsecs_t processAudioBuffer(const sp<AudioRecordThread>& thread); 4189f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 4199f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // caller must hold lock on mLock for all _l methods 4201703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent status_t openRecord_l(uint32_t sampleRate, 42158f30210ea540b6ce5aa6a46330cd3499483cb97Glenn Kasten audio_format_t format, 422e33054eb968cbf8ccaee1b0ff0301403902deed6Glenn Kasten size_t frameCount, 4239f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten audio_io_handle_t input, 4249f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten size_t epoch); 4259f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 4261703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent audio_io_handle_t getInput_l(); 4279f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 4289f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // FIXME enum is faster than strcmp() for parameter 'from' 4299f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten status_t restoreRecord_l(const char *from); 43089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 43168337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten sp<AudioRecordThread> mAudioRecordThread; 432606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten mutable Mutex mLock; 43389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 4349f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // Current client state: false = stopped, true = active. Protected by mLock. If more states 4359f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // are added, consider changing this to enum State { ... } mState as in AudioTrack. 4369f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten bool mActive; 43789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 43802e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten // for client callback handler 439c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten callback_t mCbf; // callback handler for events, or NULL 4409f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten void* mUserData; // for client callback handler 44102e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten 44202e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten // for notification APIs 4439f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t mNotificationFrames; // frames between each notification callback 4449f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten bool mRefreshRemaining; // processAudioBuffer() should refresh next 2 4459f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 4469f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // These are private to processAudioBuffer(), and are not protected by a lock 4479f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t mRemainingFrames; // number of frames to request in obtainBuffer() 4489f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten bool mRetryOnPartialBuffer; // sleep and retry after partial obtainBuffer() 4499f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten int mObservedSequence; // last observed value of mSequence 4509f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 4519f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t mMarkerPosition; // in wrapping (overflow) frame units 4527d563247cdac0509009d579bbf849157d47c38a9Jean-Michel Trivi bool mMarkerReached; 45302e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten uint32_t mNewPosition; // in frames 4549f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t mUpdatePeriod; // in frames, zero means no EVENT_NEW_POS 4559f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 4569f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten status_t mStatus; 45702e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten 45802e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten // constant after constructor or set() 459e3aa659e9cee7df5c12a80d285cc29ab3b2cbb39Glenn Kasten uint32_t mSampleRate; 460e33054eb968cbf8ccaee1b0ff0301403902deed6Glenn Kasten size_t mFrameCount; 46102e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten audio_format_t mFormat; 4629f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t mChannelCount; 46383a0382dc17364567667a4e6135db43f5bd92efcGlenn Kasten size_t mFrameSize; // app-level frame size == AudioFlinger frame size 46402e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten audio_source_t mInputSource; 4659f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t mLatency; // in ms 466624a7fcb377f2a40109c16de5109ae8ea1f67a69Glenn Kasten audio_channel_mask_t mChannelMask; 467be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int mSessionId; 4689f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten transfer_type mTransfer; 4699f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 4709f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten audio_io_handle_t mInput; // returned by AudioSystem::getInput() 47102e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten 47202e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten // may be changed if IAudioRecord object is re-created 47302e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten sp<IAudioRecord> mAudioRecord; 47402e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten sp<IMemory> mCblkMemory; 4759f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten audio_track_cblk_t* mCblk; // re-load after mLock.unlock() 47602e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten 4779f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten int mPreviousPriority; // before start() 478a636433cbd09c0708b85f337ef45c0cdef3bcb4dGlenn Kasten SchedPolicy mPreviousSchedulingGroup; 4799f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 4809f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // The proxy should only be referenced while a lock is held because the proxy isn't 4819f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // multi-thread safe. 4829f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // An exception is that a blocking ClientProxy::obtainBuffer() may be called without a lock, 4839f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // provided that the caller also holds an extra reference to the proxy and shared memory to keep 4849f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten sp<AudioRecordClientProxy> mProxy; 4859f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 4869f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten bool mInOverrun; // whether recorder is currently in overrun state 4879f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 4889f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kastenprivate: 4899f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten class DeathNotifier : public IBinder::DeathRecipient { 4909f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten public: 4919f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten DeathNotifier(AudioRecord* audioRecord) : mAudioRecord(audioRecord) { } 4929f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten protected: 4939f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten virtual void binderDied(const wp<IBinder>& who); 4949f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten private: 4959f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten const wp<AudioRecord> mAudioRecord; 4969f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten }; 4979f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 4989f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten sp<DeathNotifier> mDeathNotifier; 4999f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t mSequence; // incremented for each new IAudioRecord attempt 50089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; 50189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 50289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; // namespace android 50389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 5049f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten#endif // ANDROID_AUDIORECORD_H 505