AudioRecord.h revision 050677873c10d4da308ac222f8533c96cca3207e
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> 223f0c902beb53a245c9db35e871607dba05b8d391Andy Hung#include <media/AudioTimestamp.h> 2389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <media/IAudioRecord.h> 2490e8a97dd5c9d391d7a2ea6a2290ed976f928379Andy Hung#include <media/Modulo.h> 2589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <utils/threads.h> 2689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectnamespace android { 2889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 299f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten// ---------------------------------------------------------------------------- 309f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 3101d3acba9de861cb2b718338e787cff3566fc5ecGlenn Kastenstruct audio_track_cblk_t; 32e3aa659e9cee7df5c12a80d285cc29ab3b2cbb39Glenn Kastenclass AudioRecordClientProxy; 33a3f1fa308728976fc9ca1b4f37d26e633b32b9acGlenn Kasten 3489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project// ---------------------------------------------------------------------------- 3589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 369f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kastenclass AudioRecord : public RefBase 3789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project{ 3889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectpublic: 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 { 442b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten EVENT_MORE_DATA = 0, // Request to read available data from buffer. 452b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten // If this event is delivered but the callback handler 462b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten // does not want to read the available data, the handler must 4717ea1351633d4f5e4f9eafd0778eb8b59fa30f10Glenn Kasten // explicitly ignore the event by setting frameCount to zero. 482b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten EVENT_OVERRUN = 1, // Buffer overrun occurred. 4989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project EVENT_MARKER = 2, // Record head is at the specified marker position 5089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project // (See setMarkerPosition()). 51c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent EVENT_NEW_POS = 3, // Record head is at a new position 5289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project // (See setPositionUpdatePeriod()). 539f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten EVENT_NEW_IAUDIORECORD = 4, // IAudioRecord was re-created, either due to re-routing and 549f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // voluntary invalidation by mediaserver, or mediaserver crash. 5589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 5689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 5717ea1351633d4f5e4f9eafd0778eb8b59fa30f10Glenn Kasten /* Client should declare a Buffer and pass address to obtainBuffer() 58c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * and releaseBuffer(). See also callback_t for EVENT_MORE_DATA. 5989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 6089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 6189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project class Buffer 6289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project { 6389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project public: 649f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // FIXME use m prefix 65c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten size_t frameCount; // number of sample frames corresponding to size; 66a5017872000a938667c76d760a866547c3719d09Glenn Kasten // on input to obtainBuffer() it is the number of frames desired 6717ea1351633d4f5e4f9eafd0778eb8b59fa30f10Glenn Kasten // on output from obtainBuffer() it is the number of available 6817ea1351633d4f5e4f9eafd0778eb8b59fa30f10Glenn Kasten // frames to be read 6917ea1351633d4f5e4f9eafd0778eb8b59fa30f10Glenn Kasten // on input to releaseBuffer() it is currently ignored 70c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten 719f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten size_t size; // input/output in bytes == frameCount * frameSize 7217ea1351633d4f5e4f9eafd0778eb8b59fa30f10Glenn Kasten // on input to obtainBuffer() it is ignored 7317ea1351633d4f5e4f9eafd0778eb8b59fa30f10Glenn Kasten // on output from obtainBuffer() it is the number of available 7417ea1351633d4f5e4f9eafd0778eb8b59fa30f10Glenn Kasten // bytes to be read, which is frameCount * frameSize 7517ea1351633d4f5e4f9eafd0778eb8b59fa30f10Glenn Kasten // on input to releaseBuffer() it is the number of bytes to 7617ea1351633d4f5e4f9eafd0778eb8b59fa30f10Glenn Kasten // release 7717ea1351633d4f5e4f9eafd0778eb8b59fa30f10Glenn Kasten // FIXME This is redundant with respect to frameCount. Consider 7817ea1351633d4f5e4f9eafd0778eb8b59fa30f10Glenn Kasten // removing size and making frameCount the primary field. 799f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 8089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project union { 8189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void* raw; 82c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten short* i16; // signed 16-bit 83c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten int8_t* i8; // unsigned 8-bit, offset by 0x80 8417ea1351633d4f5e4f9eafd0778eb8b59fa30f10Glenn Kasten // input to obtainBuffer(): unused, output: pointer to buffer 8589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 8689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 8789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 8889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* As a convenience, if a callback is supplied, a handler thread 8989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * is automatically created with the appropriate priority. This thread 902b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten * invokes the callback when a new buffer becomes available or various conditions occur. 9189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 9289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 9389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * event: type of event notified (see enum AudioRecord::event_type). 9489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * user: Pointer to context for use by the callback receiver. 9589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * info: Pointer to optional parameter according to event type: 9689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_MORE_DATA: pointer to AudioRecord::Buffer struct. The callback must not read 97f59497bd3c190e087202043de5450ef06e92b27dGlenn Kasten * more bytes than indicated by 'size' field and update 'size' if 98f59497bd3c190e087202043de5450ef06e92b27dGlenn Kasten * fewer bytes are consumed. 9989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_OVERRUN: unused. 100955e78180ac6111c54f50930b0c4c12395e86cf7Glenn Kasten * - EVENT_MARKER: pointer to const uint32_t containing the marker position in frames. 101955e78180ac6111c54f50930b0c4c12395e86cf7Glenn Kasten * - EVENT_NEW_POS: pointer to const uint32_t containing the new position in frames. 1029f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * - EVENT_NEW_IAUDIORECORD: unused. 10389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 10489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 10589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project typedef void (*callback_t)(int event, void* user, void *info); 10689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 10715304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh /* Returns the minimum frame count required for the successful creation of 10815304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh * an AudioRecord object. 10915304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh * Returned status (from utils/Errors.h) can be: 11015304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh * - NO_ERROR: successful operation 11115304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh * - NO_INIT: audio server or audio hardware not initialized 11215304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh * - BAD_VALUE: unsupported configuration 1132b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten * frameCount is guaranteed to be non-zero if status is NO_ERROR, 1142b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten * and is undefined otherwise. 115f5e837e3c7d4b1cee3b18d740bf7d07f4d1ddc1cGlenn Kasten * FIXME This API assumes a route, and so should be deprecated. 11615304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh */ 11715304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh 118e33054eb968cbf8ccaee1b0ff0301403902deed6Glenn Kasten static status_t getMinFrameCount(size_t* frameCount, 11915304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh uint32_t sampleRate, 12058f30210ea540b6ce5aa6a46330cd3499483cb97Glenn Kasten audio_format_t format, 121dd8104cc5367262f0e5f13df4e79f131e8d560bbGlenn Kasten audio_channel_mask_t channelMask); 12215304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh 1239f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* How data is transferred from AudioRecord 1249f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten */ 1259f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten enum transfer_type { 1262b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten TRANSFER_DEFAULT, // not specified explicitly; determine from the other parameters 1279f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten TRANSFER_CALLBACK, // callback EVENT_MORE_DATA 1280f5d69123490bb3c4fe26129dfd23e21ce184c88Glenn Kasten TRANSFER_OBTAIN, // call obtainBuffer() and releaseBuffer() 1299f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten TRANSFER_SYNC, // synchronous read() 1309f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten }; 1319f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 13289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Constructs an uninitialized AudioRecord. No connection with 1339f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * AudioFlinger takes place. Use set() after this. 134be71aa29a3c86d2e01cd17839d2a72ab09a1bce5Svet Ganov * 135be71aa29a3c86d2e01cd17839d2a72ab09a1bce5Svet Ganov * Parameters: 136be71aa29a3c86d2e01cd17839d2a72ab09a1bce5Svet Ganov * 137be71aa29a3c86d2e01cd17839d2a72ab09a1bce5Svet Ganov * opPackageName: The package name used for app ops. 13889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 139be71aa29a3c86d2e01cd17839d2a72ab09a1bce5Svet Ganov AudioRecord(const String16& opPackageName); 14089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 141c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten /* Creates an AudioRecord object and registers it with AudioFlinger. 14289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Once created, the track needs to be started before it can be used. 1439f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Unspecified values are set to appropriate default values. 14489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 14589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 14689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 1479f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * inputSource: Select the audio input to record from (e.g. AUDIO_SOURCE_DEFAULT). 1487fd0422fbd17af3b24eb04421d37fce50f3826e2Glenn Kasten * sampleRate: Data sink sampling rate in Hz. Zero means to use the source sample rate. 149fce7a473248381cc83a01855f92581077d3c9ee2Dima Zavin * format: Audio format (e.g AUDIO_FORMAT_PCM_16_BIT for signed 15089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 16 bits per sample). 1514d74828fc0f6c13d49a36147a4250bcfa8ad0a47Glenn Kasten * channelMask: Channel mask, such that audio_is_input_channel(channelMask) is true. 152be71aa29a3c86d2e01cd17839d2a72ab09a1bce5Svet Ganov * opPackageName: The package name used for app ops. 153c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * frameCount: Minimum size of track PCM buffer in frames. This defines the 154c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * application's contribution to the 155c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * latency of the track. The actual size selected by the AudioRecord could 156c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * be larger if the requested size is not compatible with current audio HAL 157c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * latency. Zero means to use a default value. 15889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * cbf: Callback function. If not null, this function is called periodically 15917ea1351633d4f5e4f9eafd0778eb8b59fa30f10Glenn Kasten * to consume new data in TRANSFER_CALLBACK mode 16017ea1351633d4f5e4f9eafd0778eb8b59fa30f10Glenn Kasten * and inform of marker, position updates, etc. 16102e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten * user: Context for use by the callback receiver. 16289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * notificationFrames: The callback function is called each time notificationFrames PCM 16389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * frames are ready in record track output buffer. 16402e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten * sessionId: Not yet supported. 1659f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * transferType: How data is transferred from AudioRecord. 16627f7b2a8fe899565487d8a326676a5f7d0a05a37Glenn Kasten * flags: See comments on audio_input_flags_t in <system/audio.h> 167d198b85a163330b03e7507c9e8bfeb5f4d958a6cGlenn Kasten * pAttributes: If not NULL, supersedes inputSource for use case selection. 1689f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * threadCanCallJava: Not present in parameter list, and so is fixed at false. 16989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 17089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 171eba51fb3a361f67a6a64d5a16eba6084fe27d60eGlenn Kasten AudioRecord(audio_source_t inputSource, 1724d74828fc0f6c13d49a36147a4250bcfa8ad0a47Glenn Kasten uint32_t sampleRate, 1734d74828fc0f6c13d49a36147a4250bcfa8ad0a47Glenn Kasten audio_format_t format, 1744d74828fc0f6c13d49a36147a4250bcfa8ad0a47Glenn Kasten audio_channel_mask_t channelMask, 175be71aa29a3c86d2e01cd17839d2a72ab09a1bce5Svet Ganov const String16& opPackageName, 176bce50bfc3846ab008bafa75c5d3f29fd7b5395f7Glenn Kasten size_t frameCount = 0, 177a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten callback_t cbf = NULL, 178a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten void* user = NULL, 179838b3d8bafa4a781e277870dee4e0390165cff52Glenn Kasten uint32_t notificationFrames = 0, 180d848eb48c121c119e8ba7583efc75415fe102570Glenn Kasten audio_session_t sessionId = AUDIO_SESSION_ALLOCATE, 18127f7b2a8fe899565487d8a326676a5f7d0a05a37Glenn Kasten transfer_type transferType = TRANSFER_DEFAULT, 182caf7f48a0ef558689d39aafd187c1571ff4128b4Eric Laurent audio_input_flags_t flags = AUDIO_INPUT_FLAG_NONE, 1834cb668392ee0433462251afbee109405c6efacc8Jean-Michel Trivi int uid = -1, 1844cb668392ee0433462251afbee109405c6efacc8Jean-Michel Trivi pid_t pid = -1, 185caf7f48a0ef558689d39aafd187c1571ff4128b4Eric Laurent const audio_attributes_t* pAttributes = NULL); 18689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 18789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Terminates the AudioRecord and unregisters it from AudioFlinger. 18802e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten * Also destroys all resources associated with the AudioRecord. 18989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 190e2ffd5b583da9d30d96710b0e8879e90b2b51d30Glenn Kastenprotected: 191e2ffd5b583da9d30d96710b0e8879e90b2b51d30Glenn Kasten virtual ~AudioRecord(); 192e2ffd5b583da9d30d96710b0e8879e90b2b51d30Glenn Kastenpublic: 19389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 1949f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* Initialize an AudioRecord that was created using the AudioRecord() constructor. 1959f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Don't call set() more than once, or after an AudioRecord() constructor that takes parameters. 196bfd318402924414fbde4d31c9d23cc423f10b630Glenn Kasten * set() is not multi-thread safe. 19789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 19889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful intialization 1999f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * - INVALID_OPERATION: AudioRecord is already initialized or record device is already in use 2002b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten * - BAD_VALUE: invalid parameter (channelMask, format, sampleRate...) 20189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_INIT: audio server or audio hardware not initialized 20289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - PERMISSION_DENIED: recording is not allowed for the requesting process 2032b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten * If status is not equal to NO_ERROR, don't call any other APIs on this AudioRecord. 2049f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * 2059f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Parameters not listed in the AudioRecord constructors above: 2069f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * 2079f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * threadCanCallJava: Whether callbacks are made from an attached thread and thus can call JNI. 208c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten */ 2094d74828fc0f6c13d49a36147a4250bcfa8ad0a47Glenn Kasten status_t set(audio_source_t inputSource, 2104d74828fc0f6c13d49a36147a4250bcfa8ad0a47Glenn Kasten uint32_t sampleRate, 2114d74828fc0f6c13d49a36147a4250bcfa8ad0a47Glenn Kasten audio_format_t format, 2124d74828fc0f6c13d49a36147a4250bcfa8ad0a47Glenn Kasten audio_channel_mask_t channelMask, 213bce50bfc3846ab008bafa75c5d3f29fd7b5395f7Glenn Kasten size_t frameCount = 0, 214a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten callback_t cbf = NULL, 215a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten void* user = NULL, 216838b3d8bafa4a781e277870dee4e0390165cff52Glenn Kasten uint32_t notificationFrames = 0, 217be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent bool threadCanCallJava = false, 218d848eb48c121c119e8ba7583efc75415fe102570Glenn Kasten audio_session_t sessionId = AUDIO_SESSION_ALLOCATE, 21927f7b2a8fe899565487d8a326676a5f7d0a05a37Glenn Kasten transfer_type transferType = TRANSFER_DEFAULT, 220caf7f48a0ef558689d39aafd187c1571ff4128b4Eric Laurent audio_input_flags_t flags = AUDIO_INPUT_FLAG_NONE, 2214cb668392ee0433462251afbee109405c6efacc8Jean-Michel Trivi int uid = -1, 2224cb668392ee0433462251afbee109405c6efacc8Jean-Michel Trivi pid_t pid = -1, 223caf7f48a0ef558689d39aafd187c1571ff4128b4Eric Laurent const audio_attributes_t* pAttributes = NULL); 22489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2252b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten /* Result of constructing the AudioRecord. This must be checked for successful initialization 226c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * before using any AudioRecord API (except for set()), because using 22789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * an uninitialized AudioRecord produces undefined results. 22889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * See set() method above for possible return codes. 22989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 2309f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten status_t initCheck() const { return mStatus; } 23189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 232c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten /* Returns this track's estimated latency in milliseconds. 23317ea1351633d4f5e4f9eafd0778eb8b59fa30f10Glenn Kasten * This includes the latency due to AudioRecord buffer size, resampling if applicable, 23489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and audio hardware driver. 23589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 2369f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t latency() const { return mLatency; } 23789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 23802e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten /* getters, see constructor and set() */ 23989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2409f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten audio_format_t format() const { return mFormat; } 2419f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t channelCount() const { return mChannelCount; } 2429f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten size_t frameCount() const { return mFrameCount; } 2439f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten size_t frameSize() const { return mFrameSize; } 244caf7f48a0ef558689d39aafd187c1571ff4128b4Eric Laurent audio_source_t inputSource() const { return mAttributes.source; } 24589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 24689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* After it's created the track is not active. Call start() to 24789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * make it active. If set, the callback will start being called. 248c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * If event is not AudioSystem::SYNC_EVENT_NONE, the capture start will be delayed until 249a011e35b22f95f558d81dc9c94b68b1465c4661dEric Laurent * the specified event occurs on the specified trigger session. 25089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 251a011e35b22f95f558d81dc9c94b68b1465c4661dEric Laurent status_t start(AudioSystem::sync_event_t event = AudioSystem::SYNC_EVENT_NONE, 252d848eb48c121c119e8ba7583efc75415fe102570Glenn Kasten audio_session_t triggerSession = AUDIO_SESSION_NONE); 25389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2542b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten /* Stop a track. The callback will cease being called. Note that obtainBuffer() still 2559f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * works and will drain buffers until the pool is exhausted, and then will return WOULD_BLOCK. 25689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 257d64cd233eef39430561c1e1df423336a199cc5d7Glenn Kasten void stop(); 25889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project bool stopped() const; 25989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2609f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* Return the sink sample rate for this record track in Hz. 2617fd0422fbd17af3b24eb04421d37fce50f3826e2Glenn Kasten * If specified as zero in constructor or set(), this will be the source sample rate. 2629f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Unlike AudioTrack, the sample rate is const after initialization, so doesn't need a lock. 26389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 2649f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t getSampleRate() const { return mSampleRate; } 26589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 26689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Sets marker position. When record reaches the number of frames specified, 26789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * a callback with event type EVENT_MARKER is called. Calling setMarkerPosition 268c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * with marker == 0 cancels marker notification callback. 2699f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * To set a marker at a position which would compute as 0, 2702b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten * a workaround is to set the marker at a nearby position such as ~0 or 1. 271c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * If the AudioRecord has been opened with no callback function associated, 27289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * the operation will fail. 27389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 27489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 27589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 2769f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * marker: marker position expressed in wrapping (overflow) frame units, 2779f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * like the return value of getPosition(). 27889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 27989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 28089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 28189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioRecord has no callback installed. 28289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 28389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setMarkerPosition(uint32_t marker); 284606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten status_t getMarkerPosition(uint32_t *marker) const; 28589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 286c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent /* Sets position update period. Every time the number of frames specified has been recorded, 287c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * a callback with event type EVENT_NEW_POS is called. 288c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Calling setPositionUpdatePeriod with updatePeriod == 0 cancels new position notification 289c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * callback. 29089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * If the AudioRecord has been opened with no callback function associated, 29189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * the operation will fail. 2929f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Extremely small values may be rounded up to a value the implementation can support. 29389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 29489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 29589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 29689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * updatePeriod: position update notification period expressed in frames. 29789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 29889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 29989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 30089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioRecord has no callback installed. 30189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 30289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setPositionUpdatePeriod(uint32_t updatePeriod); 303606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten status_t getPositionUpdatePeriod(uint32_t *updatePeriod) const; 30489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 3059f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten /* Return the total number of frames recorded since recording started. 3069f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * The counter will wrap (overflow) periodically, e.g. every ~27 hours at 44.1 kHz. 3079f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * It is reset to zero by stop(). 30889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 30989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 31089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 3119f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * position: Address where to return record head position. 31289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 31389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 31489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 31589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - BAD_VALUE: position is NULL 31689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 317606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten status_t getPosition(uint32_t *position) const; 31889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 3193f0c902beb53a245c9db35e871607dba05b8d391Andy Hung /* Return the record timestamp. 3203f0c902beb53a245c9db35e871607dba05b8d391Andy Hung * 3213f0c902beb53a245c9db35e871607dba05b8d391Andy Hung * Parameters: 3223f0c902beb53a245c9db35e871607dba05b8d391Andy Hung * timestamp: A pointer to the timestamp to be filled. 3233f0c902beb53a245c9db35e871607dba05b8d391Andy Hung * 3243f0c902beb53a245c9db35e871607dba05b8d391Andy Hung * Returned status (from utils/Errors.h) can be: 3253f0c902beb53a245c9db35e871607dba05b8d391Andy Hung * - NO_ERROR: successful operation 3263f0c902beb53a245c9db35e871607dba05b8d391Andy Hung * - BAD_VALUE: timestamp is NULL 3273f0c902beb53a245c9db35e871607dba05b8d391Andy Hung */ 3283f0c902beb53a245c9db35e871607dba05b8d391Andy Hung status_t getTimestamp(ExtendedTimestamp *timestamp); 3293f0c902beb53a245c9db35e871607dba05b8d391Andy Hung 330c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten /* Returns a handle on the audio input used by this AudioRecord. 331c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * 332c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Parameters: 333c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * none. 334c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * 335c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Returned value: 336c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * handle on audio hardware input 337c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent */ 33832860f77787f41abac08afdfc2592272ccc31bcbGlenn Kasten// FIXME The only known public caller is frameworks/opt/net/voip/src/jni/rtp/AudioGroup.cpp 33932860f77787f41abac08afdfc2592272ccc31bcbGlenn Kasten audio_io_handle_t getInput() const __attribute__((__deprecated__)) 34032860f77787f41abac08afdfc2592272ccc31bcbGlenn Kasten { return getInputPrivate(); } 34132860f77787f41abac08afdfc2592272ccc31bcbGlenn Kastenprivate: 34232860f77787f41abac08afdfc2592272ccc31bcbGlenn Kasten audio_io_handle_t getInputPrivate() const; 34332860f77787f41abac08afdfc2592272ccc31bcbGlenn Kastenpublic: 344c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent 345c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten /* Returns the audio session ID associated with this AudioRecord. 346be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 347be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Parameters: 348be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * none. 349be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 350be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Returned value: 351be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * AudioRecord session ID. 3529f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * 3539f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * No lock needed because session ID doesn't change after first set(). 354be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent */ 355d848eb48c121c119e8ba7583efc75415fe102570Glenn Kasten audio_session_t getSessionId() const { return mSessionId; } 3569f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 35717ea1351633d4f5e4f9eafd0778eb8b59fa30f10Glenn Kasten /* Public API for TRANSFER_OBTAIN mode. 35817ea1351633d4f5e4f9eafd0778eb8b59fa30f10Glenn Kasten * Obtains a buffer of up to "audioBuffer->frameCount" full frames. 3599f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * After draining these frames of data, the caller should release them with releaseBuffer(). 3609f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * If the track buffer is not empty, obtainBuffer() returns as many contiguous 3619f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * full frames as are available immediately. 362551b5355d34aa42890811fc3606d3b63429296cdGlenn Kasten * 363551b5355d34aa42890811fc3606d3b63429296cdGlenn Kasten * If nonContig is non-NULL, it is an output parameter that will be set to the number of 364551b5355d34aa42890811fc3606d3b63429296cdGlenn Kasten * additional non-contiguous frames that are predicted to be available immediately, 365551b5355d34aa42890811fc3606d3b63429296cdGlenn Kasten * if the client were to release the first frames and then call obtainBuffer() again. 366551b5355d34aa42890811fc3606d3b63429296cdGlenn Kasten * This value is only a prediction, and needs to be confirmed. 367551b5355d34aa42890811fc3606d3b63429296cdGlenn Kasten * It will be set to zero for an error return. 368551b5355d34aa42890811fc3606d3b63429296cdGlenn Kasten * 3699f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * If the track buffer is empty and track is stopped, obtainBuffer() returns WOULD_BLOCK 3709f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * regardless of the value of waitCount. 3719f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * If the track buffer is empty and track is not stopped, obtainBuffer() blocks with a 3729f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * maximum timeout based on waitCount; see chart below. 373c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * Buffers will be returned until the pool 37489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * is exhausted, at which point obtainBuffer() will either block 3759f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * or return WOULD_BLOCK depending on the value of the "waitCount" 37689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * parameter. 377c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * 378c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * Interpretation of waitCount: 379c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * +n limits wait time to n * WAIT_PERIOD_MS, 380c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * -1 causes an (almost) infinite wait time, 381c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * 0 non-blocking. 3829f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * 3839f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Buffer fields 3849f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * On entry: 3859f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * frameCount number of frames requested 38617ea1351633d4f5e4f9eafd0778eb8b59fa30f10Glenn Kasten * size ignored 38717ea1351633d4f5e4f9eafd0778eb8b59fa30f10Glenn Kasten * raw ignored 3889f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * After error return: 3899f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * frameCount 0 3909f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * size 0 3919f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * raw undefined 3929f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * After successful return: 3939f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * frameCount actual number of frames available, <= number requested 3949f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * size actual number of bytes available 3959f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * raw pointer to the buffer 39689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 39789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 398551b5355d34aa42890811fc3606d3b63429296cdGlenn Kasten status_t obtainBuffer(Buffer* audioBuffer, int32_t waitCount, 399551b5355d34aa42890811fc3606d3b63429296cdGlenn Kasten size_t *nonContig = NULL); 40089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 401466dc8ed6ca6b7f585104806c48613dd34e608c9Paul McLean // Explicit Routing 402466dc8ed6ca6b7f585104806c48613dd34e608c9Paul McLean /** 403466dc8ed6ca6b7f585104806c48613dd34e608c9Paul McLean * TODO Document this method. 404466dc8ed6ca6b7f585104806c48613dd34e608c9Paul McLean */ 405466dc8ed6ca6b7f585104806c48613dd34e608c9Paul McLean status_t setInputDevice(audio_port_handle_t deviceId); 406466dc8ed6ca6b7f585104806c48613dd34e608c9Paul McLean 407466dc8ed6ca6b7f585104806c48613dd34e608c9Paul McLean /** 408466dc8ed6ca6b7f585104806c48613dd34e608c9Paul McLean * TODO Document this method. 409466dc8ed6ca6b7f585104806c48613dd34e608c9Paul McLean */ 410466dc8ed6ca6b7f585104806c48613dd34e608c9Paul McLean audio_port_handle_t getInputDevice(); 411296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent 412296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent /* Returns the ID of the audio device actually used by the input to which this AudioRecord 413296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent * is attached. 414296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent * A value of AUDIO_PORT_HANDLE_NONE indicates the AudioRecord is not attached to any input. 415296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent * 416296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent * Parameters: 417296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent * none. 418296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent */ 419296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent audio_port_handle_t getRoutedDeviceId(); 420296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent 421296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent /* Add an AudioDeviceCallback. The caller will be notified when the audio device 422296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent * to which this AudioRecord is routed is updated. 423296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent * Replaces any previously installed callback. 424296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent * Parameters: 425296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent * callback: The callback interface 426296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent * Returns NO_ERROR if successful. 427296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent * INVALID_OPERATION if the same callback is already installed. 428296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent * NO_INIT or PREMISSION_DENIED if AudioFlinger service is not reachable 429296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent * BAD_VALUE if the callback is NULL 430296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent */ 431296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent status_t addAudioDeviceCallback( 432296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent const sp<AudioSystem::AudioDeviceCallback>& callback); 433296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent 434296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent /* remove an AudioDeviceCallback. 435296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent * Parameters: 436296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent * callback: The callback interface 437296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent * Returns NO_ERROR if successful. 438296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent * INVALID_OPERATION if the callback is not installed 439296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent * BAD_VALUE if the callback is NULL 440296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent */ 441296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent status_t removeAudioDeviceCallback( 442296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent const sp<AudioSystem::AudioDeviceCallback>& callback); 443296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent 4449f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kastenprivate: 44502de89293b74ab1e9a77ce2367c5c499ab038968Glenn Kasten /* If nonContig is non-NULL, it is an output parameter that will be set to the number of 446551b5355d34aa42890811fc3606d3b63429296cdGlenn Kasten * additional non-contiguous frames that are predicted to be available immediately, 447551b5355d34aa42890811fc3606d3b63429296cdGlenn Kasten * if the client were to release the first frames and then call obtainBuffer() again. 448551b5355d34aa42890811fc3606d3b63429296cdGlenn Kasten * This value is only a prediction, and needs to be confirmed. 449551b5355d34aa42890811fc3606d3b63429296cdGlenn Kasten * It will be set to zero for an error return. 4509f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * FIXME We could pass an array of Buffers instead of only one Buffer to obtainBuffer(), 4519f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * in case the requested amount of frames is in two or more non-contiguous regions. 4529f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * FIXME requested and elapsed are both relative times. Consider changing to absolute time. 4539f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten */ 4549f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten status_t obtainBuffer(Buffer* audioBuffer, const struct timespec *requested, 4559f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten struct timespec *elapsed = NULL, size_t *nonContig = NULL); 4569f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kastenpublic: 457c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten 458d8772b24079b61018b455e602f3030284c30c7f5Glenn Kasten /* Public API for TRANSFER_OBTAIN mode. 459d8772b24079b61018b455e602f3030284c30c7f5Glenn Kasten * Release an emptied buffer of "audioBuffer->frameCount" frames for AudioFlinger to re-fill. 460d8772b24079b61018b455e602f3030284c30c7f5Glenn Kasten * 461d8772b24079b61018b455e602f3030284c30c7f5Glenn Kasten * Buffer fields: 462d8772b24079b61018b455e602f3030284c30c7f5Glenn Kasten * frameCount currently ignored but recommend to set to actual number of frames consumed 463d8772b24079b61018b455e602f3030284c30c7f5Glenn Kasten * size actual number of bytes consumed, must be multiple of frameSize 464d8772b24079b61018b455e602f3030284c30c7f5Glenn Kasten * raw ignored 465d8772b24079b61018b455e602f3030284c30c7f5Glenn Kasten */ 4665014c94c1bbac4a4284576b0015ba75145237593Glenn Kasten void releaseBuffer(const Buffer* audioBuffer); 46789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 46889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* As a convenience we provide a read() interface to the audio buffer. 4699f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * Input parameter 'size' is in byte units. 4709f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * This is implemented on top of obtainBuffer/releaseBuffer. For best 4719f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten * performance use callbacks. Returns actual number of bytes read >= 0, 4726ca126d5c83386941c5cb9600099e5510e4430d6Glenn Kasten * or one of the following negative status codes: 4736ca126d5c83386941c5cb9600099e5510e4430d6Glenn Kasten * INVALID_OPERATION AudioRecord is configured for streaming mode 4746ca126d5c83386941c5cb9600099e5510e4430d6Glenn Kasten * BAD_VALUE size is invalid 4756ca126d5c83386941c5cb9600099e5510e4430d6Glenn Kasten * WOULD_BLOCK when obtainBuffer() returns same, or 4766ca126d5c83386941c5cb9600099e5510e4430d6Glenn Kasten * AudioRecord was stopped during the read 4776ca126d5c83386941c5cb9600099e5510e4430d6Glenn Kasten * or any other error code returned by IAudioRecord::start() or restoreRecord_l(). 4783622cdff65f34a99d2f55936a895387ad41510ceGlenn Kasten * Default behavior is to only return when all data has been transferred. Set 'blocking' to 4793622cdff65f34a99d2f55936a895387ad41510ceGlenn Kasten * false for the method to return immediately without waiting to try multiple times to read 4803622cdff65f34a99d2f55936a895387ad41510ceGlenn Kasten * the full content of the buffer. 48189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 4823622cdff65f34a99d2f55936a895387ad41510ceGlenn Kasten ssize_t read(void* buffer, size_t size, bool blocking = true); 48389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 484c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten /* Return the number of input frames lost in the audio driver since the last call of this 485417c27304c67057779693007a7bc08e4dd80c262Glenn Kasten * function. Audio driver is expected to reset the value to 0 and restart counting upon 486417c27304c67057779693007a7bc08e4dd80c262Glenn Kasten * returning the current value by this function call. Such loss typically occurs when the 487417c27304c67057779693007a7bc08e4dd80c262Glenn Kasten * user space process is blocked longer than the capacity of audio driver buffers. 488c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten * Units: the number of input audio frames. 4895f972c031d4061f4f037c9fda1ea4bd9b6a756cdGlenn Kasten * FIXME The side-effect of resetting the counter may be incompatible with multi-client. 4905f972c031d4061f4f037c9fda1ea4bd9b6a756cdGlenn Kasten * Consider making it more like AudioTrack::getUnderrunFrames which doesn't have side effects. 49105bca2fde53bfe3063d2a0a877f2b6bfdd6052cfEric Laurent */ 4925f972c031d4061f4f037c9fda1ea4bd9b6a756cdGlenn Kasten uint32_t getInputFramesLost() const; 49305bca2fde53bfe3063d2a0a877f2b6bfdd6052cfEric Laurent 494050677873c10d4da308ac222f8533c96cca3207eEric Laurent /* Get the flags */ 495050677873c10d4da308ac222f8533c96cca3207eEric Laurent audio_input_flags_t getFlags() const { AutoMutex _l(mLock); return mFlags; } 496050677873c10d4da308ac222f8533c96cca3207eEric Laurent 49789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectprivate: 498c28c03b0b819d705522929852ecdb5a8bb50b13bGlenn Kasten /* copying audio record objects is not allowed */ 49989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioRecord(const AudioRecord& other); 50089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioRecord& operator = (const AudioRecord& other); 50189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 50289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* a small internal class to handle the callback */ 50368337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten class AudioRecordThread : public Thread 50489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project { 50589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project public: 50668337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten AudioRecordThread(AudioRecord& receiver, bool bCanCallJava = false); 50768337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten 50868337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten // Do not call Thread::requestExitAndWait() without first calling requestExit(). 50968337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten // Thread::requestExitAndWait() is not virtual, and the implementation doesn't do enough. 51068337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten virtual void requestExit(); 51168337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten 51268337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten void pause(); // suspend thread from execution at next loop boundary 51368337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten void resume(); // allow thread to execute, if not requested to exit 514803b3e558022c6d0eb069308339dc84e6e8035dcAndy Hung void wake(); // wake to handle changed notification conditions. 51568337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten 51689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project private: 5175a6cd224d07c05b496b6aca050ce5ecf96f125afGlenn Kasten void pauseInternal(nsecs_t ns = 0LL); 5185a6cd224d07c05b496b6aca050ce5ecf96f125afGlenn Kasten // like pause(), but only used internally within thread 5195a6cd224d07c05b496b6aca050ce5ecf96f125afGlenn Kasten 52089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project friend class AudioRecord; 52189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project virtual bool threadLoop(); 5229f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten AudioRecord& mReceiver; 52368337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten virtual ~AudioRecordThread(); 52468337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten Mutex mMyLock; // Thread::mLock is private 52568337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten Condition mMyCond; // Thread::mThreadExitedCondition is private 5265a6cd224d07c05b496b6aca050ce5ecf96f125afGlenn Kasten bool mPaused; // whether thread is requested to pause at next loop entry 5275a6cd224d07c05b496b6aca050ce5ecf96f125afGlenn Kasten bool mPausedInt; // whether thread internally requests pause 5285a6cd224d07c05b496b6aca050ce5ecf96f125afGlenn Kasten nsecs_t mPausedNs; // if mPausedInt then associated timeout, otherwise ignored 529803b3e558022c6d0eb069308339dc84e6e8035dcAndy Hung bool mIgnoreNextPausedInt; // skip any internal pause and go immediately 530803b3e558022c6d0eb069308339dc84e6e8035dcAndy Hung // to processAudioBuffer() as state may have changed 531803b3e558022c6d0eb069308339dc84e6e8035dcAndy Hung // since pause time calculated. 53289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 53389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 53468337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten // body of AudioRecordThread::threadLoop() 5359f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // returns the maximum amount of time before we would like to run again, where: 5369f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // 0 immediately 5379f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // > 0 no later than this many nanoseconds from now 5389f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // NS_WHENEVER still active but no particular deadline 5399f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // NS_INACTIVE inactive so don't run again until re-started 5409f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // NS_NEVER never again 5419f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten static const nsecs_t NS_WHENEVER = -1, NS_INACTIVE = -2, NS_NEVER = -3; 5427c7be1e05634d96d08210efb4bdeb012ffba440dGlenn Kasten nsecs_t processAudioBuffer(); 5439f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 5449f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // caller must hold lock on mLock for all _l methods 5452b2165c75790050810460c8de3f414876bce4c0eGlenn Kasten 54690e8a97dd5c9d391d7a2ea6a2290ed976f928379Andy Hung status_t openRecord_l(const Modulo<uint32_t> &epoch, const String16& opPackageName); 5479f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 5489f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // FIXME enum is faster than strcmp() for parameter 'from' 5499f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten status_t restoreRecord_l(const char *from); 55089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 55168337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten sp<AudioRecordThread> mAudioRecordThread; 552606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten mutable Mutex mLock; 55389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 5549f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // Current client state: false = stopped, true = active. Protected by mLock. If more states 5559f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // are added, consider changing this to enum State { ... } mState as in AudioTrack. 5569f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten bool mActive; 55789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 55802e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten // for client callback handler 559d2027336b45f524a196403d351ec317782793792Glenn Kasten callback_t mCbf; // callback handler for events, or NULL 5606ca126d5c83386941c5cb9600099e5510e4430d6Glenn Kasten void* mUserData; 56102e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten 56202e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten // for notification APIs 5637cd9cf70e36ad4b8eb12e24f9adbbe6fd69edebdGlenn Kasten uint32_t mNotificationFramesReq; // requested number of frames between each 5647cd9cf70e36ad4b8eb12e24f9adbbe6fd69edebdGlenn Kasten // notification callback 5657410591dad836434c72ddee66680802708b70c10Glenn Kasten // as specified in constructor or set() 5667cd9cf70e36ad4b8eb12e24f9adbbe6fd69edebdGlenn Kasten uint32_t mNotificationFramesAct; // actual number of frames between each 5677cd9cf70e36ad4b8eb12e24f9adbbe6fd69edebdGlenn Kasten // notification callback 5682fc14730e4697a6f456b4631549c9981f6b0b115Glenn Kasten bool mRefreshRemaining; // processAudioBuffer() should refresh 5692fc14730e4697a6f456b4631549c9981f6b0b115Glenn Kasten // mRemainingFrames and mRetryOnPartialBuffer 5709f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 5719f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // These are private to processAudioBuffer(), and are not protected by a lock 5729f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t mRemainingFrames; // number of frames to request in obtainBuffer() 5739f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten bool mRetryOnPartialBuffer; // sleep and retry after partial obtainBuffer() 5748ff50e7526d24aca11713006933b8dcb64ef6be9Glenn Kasten uint32_t mObservedSequence; // last observed value of mSequence 5759f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 57690e8a97dd5c9d391d7a2ea6a2290ed976f928379Andy Hung Modulo<uint32_t> mMarkerPosition; // in wrapping (overflow) frame units 5777d563247cdac0509009d579bbf849157d47c38a9Jean-Michel Trivi bool mMarkerReached; 57890e8a97dd5c9d391d7a2ea6a2290ed976f928379Andy Hung Modulo<uint32_t> mNewPosition; // in frames 579d2027336b45f524a196403d351ec317782793792Glenn Kasten uint32_t mUpdatePeriod; // in frames, zero means no EVENT_NEW_POS 5809f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 5819f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten status_t mStatus; 58202e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten 583be71aa29a3c86d2e01cd17839d2a72ab09a1bce5Svet Ganov String16 mOpPackageName; // The package name used for app ops. 584be71aa29a3c86d2e01cd17839d2a72ab09a1bce5Svet Ganov 585b3b2e23fcf7e050710d23b82a6682c0f3d869b69Glenn Kasten size_t mFrameCount; // corresponds to current IAudioRecord, value is 586b3b2e23fcf7e050710d23b82a6682c0f3d869b69Glenn Kasten // reported back by AudioFlinger to the client 587b3b2e23fcf7e050710d23b82a6682c0f3d869b69Glenn Kasten size_t mReqFrameCount; // frame count to request the first or next time 588b3b2e23fcf7e050710d23b82a6682c0f3d869b69Glenn Kasten // a new IAudioRecord is needed, non-decreasing 589b3b2e23fcf7e050710d23b82a6682c0f3d869b69Glenn Kasten 5903f0c902beb53a245c9db35e871607dba05b8d391Andy Hung int64_t mFramesRead; // total frames read. reset to zero after 5913f0c902beb53a245c9db35e871607dba05b8d391Andy Hung // the start() following stop(). It is not 5923f0c902beb53a245c9db35e871607dba05b8d391Andy Hung // changed after restoring the track. 5933f0c902beb53a245c9db35e871607dba05b8d391Andy Hung int64_t mFramesReadServerOffset; // An offset to server frames read due to 5943f0c902beb53a245c9db35e871607dba05b8d391Andy Hung // restoring AudioRecord, or stop/start. 59502e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten // constant after constructor or set() 596e3aa659e9cee7df5c12a80d285cc29ab3b2cbb39Glenn Kasten uint32_t mSampleRate; 59702e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten audio_format_t mFormat; 5989f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t mChannelCount; 59983a0382dc17364567667a4e6135db43f5bd92efcGlenn Kasten size_t mFrameSize; // app-level frame size == AudioFlinger frame size 6009f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t mLatency; // in ms 601624a7fcb377f2a40109c16de5109ae8ea1f67a69Glenn Kasten audio_channel_mask_t mChannelMask; 60258883a0cbbde53579461ef7d9a639b4ac45cb55eGlenn Kasten 60358883a0cbbde53579461ef7d9a639b4ac45cb55eGlenn Kasten audio_input_flags_t mFlags; // same as mOrigFlags, except for bits that may 60458883a0cbbde53579461ef7d9a639b4ac45cb55eGlenn Kasten // be denied by client or server, such as 60558883a0cbbde53579461ef7d9a639b4ac45cb55eGlenn Kasten // AUDIO_INPUT_FLAG_FAST. mLock must be 60658883a0cbbde53579461ef7d9a639b4ac45cb55eGlenn Kasten // held to read or write those bits reliably. 60758883a0cbbde53579461ef7d9a639b4ac45cb55eGlenn Kasten audio_input_flags_t mOrigFlags; // as specified in constructor or set(), const 60858883a0cbbde53579461ef7d9a639b4ac45cb55eGlenn Kasten 609d848eb48c121c119e8ba7583efc75415fe102570Glenn Kasten audio_session_t mSessionId; 6109f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten transfer_type mTransfer; 6119f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 612d776ac63ce9c013c9626226e43f7db606e035838Glenn Kasten // Next 5 fields may be changed if IAudioRecord is re-created, but always != 0 613d776ac63ce9c013c9626226e43f7db606e035838Glenn Kasten // provided the initial set() was successful 61402e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten sp<IAudioRecord> mAudioRecord; 61502e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten sp<IMemory> mCblkMemory; 6169f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten audio_track_cblk_t* mCblk; // re-load after mLock.unlock() 617d776ac63ce9c013c9626226e43f7db606e035838Glenn Kasten sp<IMemory> mBufferMemory; 61838e905b3cbba4da443d799b16999989781afc6d8Glenn Kasten audio_io_handle_t mInput; // returned by AudioSystem::getInput() 61902e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten 6209f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten int mPreviousPriority; // before start() 621a636433cbd09c0708b85f337ef45c0cdef3bcb4dGlenn Kasten SchedPolicy mPreviousSchedulingGroup; 62228f1351369682801e1bb40a835bdae3c97b73c1cGlenn Kasten bool mAwaitBoost; // thread should wait for priority boost before running 6239f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 6249f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // The proxy should only be referenced while a lock is held because the proxy isn't 6259f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // multi-thread safe. 6269f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // An exception is that a blocking ClientProxy::obtainBuffer() may be called without a lock, 6279f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten // provided that the caller also holds an extra reference to the proxy and shared memory to keep 6286ca126d5c83386941c5cb9600099e5510e4430d6Glenn Kasten // them around in case they are replaced during the obtainBuffer(). 6299f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten sp<AudioRecordClientProxy> mProxy; 6309f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 6319f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten bool mInOverrun; // whether recorder is currently in overrun state 6329f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 6339f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kastenprivate: 6349f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten class DeathNotifier : public IBinder::DeathRecipient { 6359f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten public: 6369f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten DeathNotifier(AudioRecord* audioRecord) : mAudioRecord(audioRecord) { } 6379f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten protected: 6389f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten virtual void binderDied(const wp<IBinder>& who); 6399f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten private: 6409f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten const wp<AudioRecord> mAudioRecord; 6419f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten }; 6429f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten 6439f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten sp<DeathNotifier> mDeathNotifier; 6449f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten uint32_t mSequence; // incremented for each new IAudioRecord attempt 6454cb668392ee0433462251afbee109405c6efacc8Jean-Michel Trivi int mClientUid; 6464cb668392ee0433462251afbee109405c6efacc8Jean-Michel Trivi pid_t mClientPid; 647caf7f48a0ef558689d39aafd187c1571ff4128b4Eric Laurent audio_attributes_t mAttributes; 648466dc8ed6ca6b7f585104806c48613dd34e608c9Paul McLean 649466dc8ed6ca6b7f585104806c48613dd34e608c9Paul McLean // For Device Selection API 650466dc8ed6ca6b7f585104806c48613dd34e608c9Paul McLean // a value of AUDIO_PORT_HANDLE_NONE indicated default (AudioPolicyManager) routing. 651466dc8ed6ca6b7f585104806c48613dd34e608c9Paul McLean audio_port_handle_t mSelectedDeviceId; 652296fb13dd9b5e90d6a05cce897c3b1e7914a478aEric Laurent sp<AudioSystem::AudioDeviceCallback> mDeviceCallback; 65389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; 65489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 65589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; // namespace android 65689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 6579f80dd223d83d9bb9077fb6baee056cee4eaf7e5Glenn Kasten#endif // ANDROID_AUDIORECORD_H 658