AudioRecord.h revision 955e78180ac6111c54f50930b0c4c12395e86cf7
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 1789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#ifndef AUDIORECORD_H_ 1889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#define AUDIORECORD_H_ 1989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 20868a6a357018e5872e064b7a13a9b891e2078962Glenn Kasten#include <binder/IMemory.h> 21868a6a357018e5872e064b7a13a9b891e2078962Glenn Kasten#include <cutils/sched_policy.h> 22868a6a357018e5872e064b7a13a9b891e2078962Glenn Kasten#include <media/AudioSystem.h> 2389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <media/IAudioRecord.h> 24868a6a357018e5872e064b7a13a9b891e2078962Glenn Kasten#include <system/audio.h> 2589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <utils/RefBase.h> 2689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <utils/Errors.h> 2789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <utils/threads.h> 2889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectnamespace android { 3089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 31a3f1fa308728976fc9ca1b4f37d26e633b32b9acGlenn Kastenclass audio_track_cblk_t; 32a3f1fa308728976fc9ca1b4f37d26e633b32b9acGlenn Kasten 3389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project// ---------------------------------------------------------------------------- 3489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 35a0a98ca6ec9b599af79a597cb7c5350b61a77624Eric Laurentclass AudioRecord : virtual public RefBase 3689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project{ 3789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectpublic: 3889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 3989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project static const int DEFAULT_SAMPLE_RATE = 8000; 4089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 4189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Events used by AudioRecord callback function (callback_t). 4202e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten * Keep in sync with frameworks/base/media/java/android/media/AudioRecord.java NATIVE_EVENT_*. 4389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 4489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum event_type { 4502e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten EVENT_MORE_DATA = 0, // Request to read more data from PCM buffer. 4689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project EVENT_OVERRUN = 1, // PCM buffer overrun occured. 4789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project EVENT_MARKER = 2, // Record head is at the specified marker position 4889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project // (See setMarkerPosition()). 49c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent EVENT_NEW_POS = 3, // Record head is at a new position 5089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project // (See setPositionUpdatePeriod()). 5189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 5289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 5389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Create Buffer on the stack and pass it to obtainBuffer() 5489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and releaseBuffer(). 5589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 5689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 5789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project class Buffer 5889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project { 5989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project public: 6089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum { 6189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project MUTE = 0x00000001 6289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 6389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t flags; 6489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int channelCount; 6558f30210ea540b6ce5aa6a46330cd3499483cb97Glenn Kasten audio_format_t format; 6689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project size_t frameCount; 6702e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten size_t size; // total size in bytes == frameCount * frameSize 6889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project union { 6989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void* raw; 7089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project short* i16; 7189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int8_t* i8; 7289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 7389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 7489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 7589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* As a convenience, if a callback is supplied, a handler thread 7689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * is automatically created with the appropriate priority. This thread 7789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * invokes the callback when a new buffer becomes ready or an overrun condition occurs. 7889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 7989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 8089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * event: type of event notified (see enum AudioRecord::event_type). 8189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * user: Pointer to context for use by the callback receiver. 8289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * info: Pointer to optional parameter according to event type: 8389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_MORE_DATA: pointer to AudioRecord::Buffer struct. The callback must not read 8489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * more bytes than indicated by 'size' field and update 'size' if less bytes are 8589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * read. 8689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_OVERRUN: unused. 87955e78180ac6111c54f50930b0c4c12395e86cf7Glenn Kasten * - EVENT_MARKER: pointer to const uint32_t containing the marker position in frames. 88955e78180ac6111c54f50930b0c4c12395e86cf7Glenn Kasten * - EVENT_NEW_POS: pointer to const uint32_t containing the new position in frames. 8989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 9089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 9189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project typedef void (*callback_t)(int event, void* user, void *info); 9289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 9315304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh /* Returns the minimum frame count required for the successful creation of 9415304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh * an AudioRecord object. 9515304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh * Returned status (from utils/Errors.h) can be: 9615304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh * - NO_ERROR: successful operation 9715304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh * - NO_INIT: audio server or audio hardware not initialized 9815304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh * - BAD_VALUE: unsupported configuration 9915304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh */ 10015304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh 10115304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh static status_t getMinFrameCount(int* frameCount, 10215304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh uint32_t sampleRate, 10358f30210ea540b6ce5aa6a46330cd3499483cb97Glenn Kasten audio_format_t format, 104dd8104cc5367262f0e5f13df4e79f131e8d560bbGlenn Kasten audio_channel_mask_t channelMask); 10515304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh 10689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Constructs an uninitialized AudioRecord. No connection with 10789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * AudioFlinger takes place. 10889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 10989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioRecord(); 11089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 11189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Creates an AudioRecord track and registers it with AudioFlinger. 11289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Once created, the track needs to be started before it can be used. 11389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Unspecified values are set to the audio hardware's current 11489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * values. 11589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 11689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 11789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 118c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * inputSource: Select the audio input to record to (e.g. AUDIO_SOURCE_DEFAULT). 11989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * sampleRate: Track sampling rate in Hz. 120fce7a473248381cc83a01855f92581077d3c9ee2Dima Zavin * format: Audio format (e.g AUDIO_FORMAT_PCM_16_BIT for signed 12189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 16 bits per sample). 12202e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten * channelMask: Channel mask. 12389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * frameCount: Total size of track PCM buffer in frames. This defines the 12489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * latency of the track. 12589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * cbf: Callback function. If not null, this function is called periodically 12689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * to provide new PCM data. 12702e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten * user: Context for use by the callback receiver. 12889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * notificationFrames: The callback function is called each time notificationFrames PCM 12989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * frames are ready in record track output buffer. 13002e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten * sessionId: Not yet supported. 13189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 13289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 133eba51fb3a361f67a6a64d5a16eba6084fe27d60eGlenn Kasten AudioRecord(audio_source_t inputSource, 13489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t sampleRate = 0, 13558f30210ea540b6ce5aa6a46330cd3499483cb97Glenn Kasten audio_format_t format = AUDIO_FORMAT_DEFAULT, 136624a7fcb377f2a40109c16de5109ae8ea1f67a69Glenn Kasten audio_channel_mask_t channelMask = AUDIO_CHANNEL_IN_MONO, 13789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int frameCount = 0, 138a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten callback_t cbf = NULL, 139a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten void* user = NULL, 140be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int notificationFrames = 0, 141be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int sessionId = 0); 14289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 14389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 14489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Terminates the AudioRecord and unregisters it from AudioFlinger. 14502e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten * Also destroys all resources associated with the AudioRecord. 14689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 14789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project ~AudioRecord(); 14889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 14989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 15089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Initialize an uninitialized AudioRecord. 15189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 15289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful intialization 15389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: AudioRecord is already intitialized or record device is already in use 154c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * - BAD_VALUE: invalid parameter (channels, format, sampleRate...) 15589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_INIT: audio server or audio hardware not initialized 15689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - PERMISSION_DENIED: recording is not allowed for the requesting process 15789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * */ 158eba51fb3a361f67a6a64d5a16eba6084fe27d60eGlenn Kasten status_t set(audio_source_t inputSource = AUDIO_SOURCE_DEFAULT, 15989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t sampleRate = 0, 16058f30210ea540b6ce5aa6a46330cd3499483cb97Glenn Kasten audio_format_t format = AUDIO_FORMAT_DEFAULT, 161624a7fcb377f2a40109c16de5109ae8ea1f67a69Glenn Kasten audio_channel_mask_t channelMask = AUDIO_CHANNEL_IN_MONO, 16289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int frameCount = 0, 163a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten callback_t cbf = NULL, 164a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten void* user = NULL, 16589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int notificationFrames = 0, 166be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent bool threadCanCallJava = false, 167be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int sessionId = 0); 16889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 16989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 17089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Result of constructing the AudioRecord. This must be checked 17189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * before using any AudioRecord API (except for set()), using 17289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * an uninitialized AudioRecord produces undefined results. 17389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * See set() method above for possible return codes. 17489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 17589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t initCheck() const; 17689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 17789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Returns this track's latency in milliseconds. 17889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * This includes the latency due to AudioRecord buffer size 17989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and audio hardware driver. 18089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 18189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t latency() const; 18289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 18302e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten /* getters, see constructor and set() */ 18489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 18558f30210ea540b6ce5aa6a46330cd3499483cb97Glenn Kasten audio_format_t format() const; 18689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int channelCount() const; 18789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t frameCount() const; 188b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten size_t frameSize() const; 189eba51fb3a361f67a6a64d5a16eba6084fe27d60eGlenn Kasten audio_source_t inputSource() const; 19089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 19189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 19289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* After it's created the track is not active. Call start() to 19389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * make it active. If set, the callback will start being called. 194a011e35b22f95f558d81dc9c94b68b1465c4661dEric Laurent * if event is not AudioSystem::SYNC_EVENT_NONE, the capture start will be delayed until 195a011e35b22f95f558d81dc9c94b68b1465c4661dEric Laurent * the specified event occurs on the specified trigger session. 19689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 197a011e35b22f95f558d81dc9c94b68b1465c4661dEric Laurent status_t start(AudioSystem::sync_event_t event = AudioSystem::SYNC_EVENT_NONE, 198a011e35b22f95f558d81dc9c94b68b1465c4661dEric Laurent int triggerSession = 0); 19989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 20089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Stop a track. If set, the callback will cease being called and 20189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * obtainBuffer returns STOPPED. Note that obtainBuffer() still works 20289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and will fill up buffers until the pool is exhausted. 20389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 204d64cd233eef39430561c1e1df423336a199cc5d7Glenn Kasten void stop(); 20589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project bool stopped() const; 20689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 207573266210fb2b2e7d86fbd46d0dfe16763611d91Eric Laurent /* get sample rate for this record track 20889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 209606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten uint32_t getSampleRate() const; 21089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 21189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Sets marker position. When record reaches the number of frames specified, 21289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * a callback with event type EVENT_MARKER is called. Calling setMarkerPosition 213c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * with marker == 0 cancels marker notification callback. 214c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * If the AudioRecord has been opened with no callback function associated, 21589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * the operation will fail. 21689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 21789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 21889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 21989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * marker: marker position expressed in frames. 22089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 22189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 22289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 22389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioRecord has no callback installed. 22489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 22589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setMarkerPosition(uint32_t marker); 226606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten status_t getMarkerPosition(uint32_t *marker) const; 22789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 22889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 229c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent /* Sets position update period. Every time the number of frames specified has been recorded, 230c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * a callback with event type EVENT_NEW_POS is called. 231c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Calling setPositionUpdatePeriod with updatePeriod == 0 cancels new position notification 232c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * callback. 23389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * If the AudioRecord has been opened with no callback function associated, 23489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * the operation will fail. 23589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 23689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 23789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 23889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * updatePeriod: position update notification period expressed in frames. 23989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 24089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 24189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 24289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioRecord has no callback installed. 24389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 24489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setPositionUpdatePeriod(uint32_t updatePeriod); 245606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten status_t getPositionUpdatePeriod(uint32_t *updatePeriod) const; 24689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 24789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 24802e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten /* Gets record head position. The position is the total number of frames 249c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * recorded since record start. 25089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 25189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 25289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 25389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * position: Address where to return record head position within AudioRecord buffer. 25489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 25589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 25689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 25789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - BAD_VALUE: position is NULL 25889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 259606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten status_t getPosition(uint32_t *position) const; 26089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 261c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent /* returns a handle on the audio input used by this AudioRecord. 262c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * 263c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Parameters: 264c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * none. 265c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * 266c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Returned value: 267c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * handle on audio hardware input 268c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent */ 269606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten audio_io_handle_t getInput() const; 270c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent 27102e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten /* returns the audio session ID associated with this AudioRecord. 272be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 273be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Parameters: 274be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * none. 275be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 276be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Returned value: 277be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * AudioRecord session ID. 278be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent */ 279606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten int getSessionId() const; 280be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent 28189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* obtains a buffer of "frameCount" frames. The buffer must be 28289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * filled entirely. If the track is stopped, obtainBuffer() returns 283417c27304c67057779693007a7bc08e4dd80c262Glenn Kasten * STOPPED instead of NO_ERROR as long as there are buffers available, 28489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * at which point NO_MORE_BUFFERS is returned. 28589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Buffers will be returned until the pool (buffercount()) 28689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * is exhausted, at which point obtainBuffer() will either block 28789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * or return WOULD_BLOCK depending on the value of the "blocking" 28889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * parameter. 28989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 29089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 29189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum { 29289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project NO_MORE_BUFFERS = 0x80000001, 29389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project STOPPED = 1 29489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 29589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 29689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t obtainBuffer(Buffer* audioBuffer, int32_t waitCount); 29789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void releaseBuffer(Buffer* audioBuffer); 29889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 29989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 30089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* As a convenience we provide a read() interface to the audio buffer. 301417c27304c67057779693007a7bc08e4dd80c262Glenn Kasten * This is implemented on top of obtainBuffer/releaseBuffer. 30289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 30389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project ssize_t read(void* buffer, size_t size); 30489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 305417c27304c67057779693007a7bc08e4dd80c262Glenn Kasten /* Return the amount of input frames lost in the audio driver since the last call of this 306417c27304c67057779693007a7bc08e4dd80c262Glenn Kasten * function. Audio driver is expected to reset the value to 0 and restart counting upon 307417c27304c67057779693007a7bc08e4dd80c262Glenn Kasten * returning the current value by this function call. Such loss typically occurs when the 308417c27304c67057779693007a7bc08e4dd80c262Glenn Kasten * user space process is blocked longer than the capacity of audio driver buffers. 30905bca2fde53bfe3063d2a0a877f2b6bfdd6052cfEric Laurent * Unit: the number of input audio frames 31005bca2fde53bfe3063d2a0a877f2b6bfdd6052cfEric Laurent */ 311606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten unsigned int getInputFramesLost() const; 31205bca2fde53bfe3063d2a0a877f2b6bfdd6052cfEric Laurent 31389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectprivate: 31489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* copying audio tracks is not allowed */ 31589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioRecord(const AudioRecord& other); 31689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioRecord& operator = (const AudioRecord& other); 31789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 31889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* a small internal class to handle the callback */ 31968337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten class AudioRecordThread : public Thread 32089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project { 32189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project public: 32268337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten AudioRecordThread(AudioRecord& receiver, bool bCanCallJava = false); 32368337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten 32468337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten // Do not call Thread::requestExitAndWait() without first calling requestExit(). 32568337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten // Thread::requestExitAndWait() is not virtual, and the implementation doesn't do enough. 32668337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten virtual void requestExit(); 32768337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten 32868337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten void pause(); // suspend thread from execution at next loop boundary 32968337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten void resume(); // allow thread to execute, if not requested to exit 33068337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten 33189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project private: 33289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project friend class AudioRecord; 33389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project virtual bool threadLoop(); 33489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioRecord& mReceiver; 33568337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten virtual ~AudioRecordThread(); 33668337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten Mutex mMyLock; // Thread::mLock is private 33768337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten Condition mMyCond; // Thread::mThreadExitedCondition is private 33868337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten bool mPaused; // whether thread is currently paused 33989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 34089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 34168337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten // body of AudioRecordThread::threadLoop() 34268337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten bool processAudioBuffer(const sp<AudioRecordThread>& thread); 34368337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten 3441703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent status_t openRecord_l(uint32_t sampleRate, 34558f30210ea540b6ce5aa6a46330cd3499483cb97Glenn Kasten audio_format_t format, 346624a7fcb377f2a40109c16de5109ae8ea1f67a69Glenn Kasten audio_channel_mask_t channelMask, 34734f1d8ecd23169a5f299937e3aaf1bd7937578a0Eric Laurent int frameCount, 3486100d2d60517ff33ed8eb35d0b7ea63cde0831c9Eric Laurent audio_io_handle_t input); 3491703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent audio_io_handle_t getInput_l(); 3501703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent status_t restoreRecord_l(audio_track_cblk_t*& cblk); 35189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 35268337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten sp<AudioRecordThread> mAudioRecordThread; 353606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten mutable Mutex mLock; 35489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 35568337edf595a0c345ba4b8adcd4f1e541a1d7eb7Glenn Kasten bool mActive; // protected by mLock 35689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 35702e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten // for client callback handler 35889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project callback_t mCbf; 35989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void* mUserData; 36002e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten 36102e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten // for notification APIs 36289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mNotificationFrames; 36389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mRemainingFrames; 36402e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten uint32_t mMarkerPosition; // in frames 3657d563247cdac0509009d579bbf849157d47c38a9Jean-Michel Trivi bool mMarkerReached; 36602e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten uint32_t mNewPosition; // in frames 36702e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten uint32_t mUpdatePeriod; // in ms 36802e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten 36902e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten // constant after constructor or set() 37002e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten uint32_t mFrameCount; 37102e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten audio_format_t mFormat; 37202e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten uint8_t mChannelCount; 37302e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten audio_source_t mInputSource; 37402e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten status_t mStatus; 37502e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten uint32_t mLatency; 376624a7fcb377f2a40109c16de5109ae8ea1f67a69Glenn Kasten audio_channel_mask_t mChannelMask; 37702e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten audio_io_handle_t mInput; // returned by AudioSystem::getInput() 378be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int mSessionId; 37902e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten 38002e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten // may be changed if IAudioRecord object is re-created 38102e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten sp<IAudioRecord> mAudioRecord; 38202e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten sp<IMemory> mCblkMemory; 38302e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten audio_track_cblk_t* mCblk; 38402e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten 385879135196fd1c97deefc538c888037c56c2879a7Glenn Kasten int mPreviousPriority; // before start() 386a636433cbd09c0708b85f337ef45c0cdef3bcb4dGlenn Kasten SchedPolicy mPreviousSchedulingGroup; 38789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; 38889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 38989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; // namespace android 39089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 39189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#endif /*AUDIORECORD_H_*/ 392