AudioRecord.h revision dd8104cc5367262f0e5f13df4e79f131e8d560bb
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 /* These are static methods to control the system-wide AudioFlinger 7689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * only privileged processes can have access to them 7789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 7889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 7989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project// static status_t setMasterMute(bool mute); 8089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 8189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* As a convenience, if a callback is supplied, a handler thread 8289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * is automatically created with the appropriate priority. This thread 8389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * invokes the callback when a new buffer becomes ready or an overrun condition occurs. 8489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 8589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 8689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * event: type of event notified (see enum AudioRecord::event_type). 8789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * user: Pointer to context for use by the callback receiver. 8889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * info: Pointer to optional parameter according to event type: 8989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_MORE_DATA: pointer to AudioRecord::Buffer struct. The callback must not read 9089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * more bytes than indicated by 'size' field and update 'size' if less bytes are 9189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * read. 9289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_OVERRUN: unused. 9389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_MARKER: pointer to an uin32_t containing the marker position in frames. 9489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_NEW_POS: pointer to an uin32_t containing the new position in frames. 9589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 9689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 9789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project typedef void (*callback_t)(int event, void* user, void *info); 9889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 9915304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh /* Returns the minimum frame count required for the successful creation of 10015304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh * an AudioRecord object. 10115304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh * Returned status (from utils/Errors.h) can be: 10215304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh * - NO_ERROR: successful operation 10315304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh * - NO_INIT: audio server or audio hardware not initialized 10415304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh * - BAD_VALUE: unsupported configuration 10515304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh */ 10615304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh 10715304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh static status_t getMinFrameCount(int* frameCount, 10815304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh uint32_t sampleRate, 10958f30210ea540b6ce5aa6a46330cd3499483cb97Glenn Kasten audio_format_t format, 110dd8104cc5367262f0e5f13df4e79f131e8d560bbGlenn Kasten audio_channel_mask_t channelMask); 11115304d601cbf83be6519ca53e1a26b97d50d0192Chia-chi Yeh 11289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Constructs an uninitialized AudioRecord. No connection with 11389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * AudioFlinger takes place. 11489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 11589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioRecord(); 11689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 11789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Creates an AudioRecord track and registers it with AudioFlinger. 11889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Once created, the track needs to be started before it can be used. 11989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Unspecified values are set to the audio hardware's current 12089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * values. 12189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 12289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 12389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 124c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * inputSource: Select the audio input to record to (e.g. AUDIO_SOURCE_DEFAULT). 12589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * sampleRate: Track sampling rate in Hz. 126fce7a473248381cc83a01855f92581077d3c9ee2Dima Zavin * format: Audio format (e.g AUDIO_FORMAT_PCM_16_BIT for signed 12789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 16 bits per sample). 12802e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten * channelMask: Channel mask. 12989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * frameCount: Total size of track PCM buffer in frames. This defines the 13089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * latency of the track. 13189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * cbf: Callback function. If not null, this function is called periodically 13289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * to provide new PCM data. 13302e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten * user: Context for use by the callback receiver. 13489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * notificationFrames: The callback function is called each time notificationFrames PCM 13589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * frames are ready in record track output buffer. 13602e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten * sessionId: Not yet supported. 13789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 13889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 139eba51fb3a361f67a6a64d5a16eba6084fe27d60eGlenn Kasten AudioRecord(audio_source_t inputSource, 14089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t sampleRate = 0, 14158f30210ea540b6ce5aa6a46330cd3499483cb97Glenn Kasten audio_format_t format = AUDIO_FORMAT_DEFAULT, 142624a7fcb377f2a40109c16de5109ae8ea1f67a69Glenn Kasten audio_channel_mask_t channelMask = AUDIO_CHANNEL_IN_MONO, 14389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int frameCount = 0, 144a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten callback_t cbf = NULL, 145a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten void* user = NULL, 146be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int notificationFrames = 0, 147be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int sessionId = 0); 14889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 14989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 15089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Terminates the AudioRecord and unregisters it from AudioFlinger. 15102e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten * Also destroys all resources associated with the AudioRecord. 15289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 15389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project ~AudioRecord(); 15489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 15589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 15689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Initialize an uninitialized AudioRecord. 15789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 15889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful intialization 15989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: AudioRecord is already intitialized or record device is already in use 160c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * - BAD_VALUE: invalid parameter (channels, format, sampleRate...) 16189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_INIT: audio server or audio hardware not initialized 16289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - PERMISSION_DENIED: recording is not allowed for the requesting process 16389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * */ 164eba51fb3a361f67a6a64d5a16eba6084fe27d60eGlenn Kasten status_t set(audio_source_t inputSource = AUDIO_SOURCE_DEFAULT, 16589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t sampleRate = 0, 16658f30210ea540b6ce5aa6a46330cd3499483cb97Glenn Kasten audio_format_t format = AUDIO_FORMAT_DEFAULT, 167624a7fcb377f2a40109c16de5109ae8ea1f67a69Glenn Kasten audio_channel_mask_t channelMask = AUDIO_CHANNEL_IN_MONO, 16889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int frameCount = 0, 169a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten callback_t cbf = NULL, 170a0d68338a88c2ddb4502f95017b546d603ef1ec7Glenn Kasten void* user = NULL, 17189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int notificationFrames = 0, 172be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent bool threadCanCallJava = false, 173be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int sessionId = 0); 17489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 17589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 17689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Result of constructing the AudioRecord. This must be checked 17789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * before using any AudioRecord API (except for set()), using 17889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * an uninitialized AudioRecord produces undefined results. 17989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * See set() method above for possible return codes. 18089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 18189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t initCheck() const; 18289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 18389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Returns this track's latency in milliseconds. 18489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * This includes the latency due to AudioRecord buffer size 18589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and audio hardware driver. 18689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 18789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t latency() const; 18889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 18902e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten /* getters, see constructor and set() */ 19089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 19158f30210ea540b6ce5aa6a46330cd3499483cb97Glenn Kasten audio_format_t format() const; 19289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int channelCount() const; 19389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t frameCount() const; 194b9980659501d0428d65d8292f3c32da69d37fbd2Glenn Kasten size_t frameSize() const; 195eba51fb3a361f67a6a64d5a16eba6084fe27d60eGlenn Kasten audio_source_t inputSource() const; 19689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 19789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 19889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* After it's created the track is not active. Call start() to 19989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * make it active. If set, the callback will start being called. 200a011e35b22f95f558d81dc9c94b68b1465c4661dEric Laurent * if event is not AudioSystem::SYNC_EVENT_NONE, the capture start will be delayed until 201a011e35b22f95f558d81dc9c94b68b1465c4661dEric Laurent * the specified event occurs on the specified trigger session. 20289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 203a011e35b22f95f558d81dc9c94b68b1465c4661dEric Laurent status_t start(AudioSystem::sync_event_t event = AudioSystem::SYNC_EVENT_NONE, 204a011e35b22f95f558d81dc9c94b68b1465c4661dEric Laurent int triggerSession = 0); 20589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 20689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Stop a track. If set, the callback will cease being called and 20789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * obtainBuffer returns STOPPED. Note that obtainBuffer() still works 20889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and will fill up buffers until the pool is exhausted. 20989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 21089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t stop(); 21189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project bool stopped() const; 21289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 213573266210fb2b2e7d86fbd46d0dfe16763611d91Eric Laurent /* get sample rate for this record track 21489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 215606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten uint32_t getSampleRate() const; 21689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 21789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Sets marker position. When record reaches the number of frames specified, 21889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * a callback with event type EVENT_MARKER is called. Calling setMarkerPosition 219c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * with marker == 0 cancels marker notification callback. 220c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * If the AudioRecord has been opened with no callback function associated, 22189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * the operation will fail. 22289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 22389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 22489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 22589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * marker: marker position expressed in frames. 22689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 22789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 22889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 22989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioRecord has no callback installed. 23089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 23189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setMarkerPosition(uint32_t marker); 232606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten status_t getMarkerPosition(uint32_t *marker) const; 23389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 23489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 235c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent /* Sets position update period. Every time the number of frames specified has been recorded, 236c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * a callback with event type EVENT_NEW_POS is called. 237c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Calling setPositionUpdatePeriod with updatePeriod == 0 cancels new position notification 238c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * callback. 23989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * If the AudioRecord has been opened with no callback function associated, 24089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * the operation will fail. 24189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 24289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 24389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 24489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * updatePeriod: position update notification period expressed in frames. 24589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 24689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 24789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 24889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioRecord has no callback installed. 24989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 25089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setPositionUpdatePeriod(uint32_t updatePeriod); 251606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten status_t getPositionUpdatePeriod(uint32_t *updatePeriod) const; 25289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 25389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 25402e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten /* Gets record head position. The position is the total number of frames 255c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * recorded since record start. 25689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 25789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 25889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 25989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * position: Address where to return record head position within AudioRecord buffer. 26089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 26189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 26289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 26389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - BAD_VALUE: position is NULL 26489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 265606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten status_t getPosition(uint32_t *position) const; 26689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 267c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent /* returns a handle on the audio input used by this AudioRecord. 268c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * 269c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Parameters: 270c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * none. 271c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * 272c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Returned value: 273c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * handle on audio hardware input 274c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent */ 275606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten audio_io_handle_t getInput() const; 276c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent 27702e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten /* returns the audio session ID associated with this AudioRecord. 278be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 279be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Parameters: 280be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * none. 281be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 282be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Returned value: 283be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * AudioRecord session ID. 284be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent */ 285606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten int getSessionId() const; 286be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent 28789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* obtains a buffer of "frameCount" frames. The buffer must be 28889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * filled entirely. If the track is stopped, obtainBuffer() returns 289417c27304c67057779693007a7bc08e4dd80c262Glenn Kasten * STOPPED instead of NO_ERROR as long as there are buffers available, 29089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * at which point NO_MORE_BUFFERS is returned. 29189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Buffers will be returned until the pool (buffercount()) 29289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * is exhausted, at which point obtainBuffer() will either block 29389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * or return WOULD_BLOCK depending on the value of the "blocking" 29489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * parameter. 29589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 29689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 29789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum { 29889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project NO_MORE_BUFFERS = 0x80000001, 29989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project STOPPED = 1 30089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 30189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 30289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t obtainBuffer(Buffer* audioBuffer, int32_t waitCount); 30389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void releaseBuffer(Buffer* audioBuffer); 30489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 30589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 30689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* As a convenience we provide a read() interface to the audio buffer. 307417c27304c67057779693007a7bc08e4dd80c262Glenn Kasten * This is implemented on top of obtainBuffer/releaseBuffer. 30889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 30989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project ssize_t read(void* buffer, size_t size); 31089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 311417c27304c67057779693007a7bc08e4dd80c262Glenn Kasten /* Return the amount of input frames lost in the audio driver since the last call of this 312417c27304c67057779693007a7bc08e4dd80c262Glenn Kasten * function. Audio driver is expected to reset the value to 0 and restart counting upon 313417c27304c67057779693007a7bc08e4dd80c262Glenn Kasten * returning the current value by this function call. Such loss typically occurs when the 314417c27304c67057779693007a7bc08e4dd80c262Glenn Kasten * user space process is blocked longer than the capacity of audio driver buffers. 31505bca2fde53bfe3063d2a0a877f2b6bfdd6052cfEric Laurent * Unit: the number of input audio frames 31605bca2fde53bfe3063d2a0a877f2b6bfdd6052cfEric Laurent */ 317606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten unsigned int getInputFramesLost() const; 31805bca2fde53bfe3063d2a0a877f2b6bfdd6052cfEric Laurent 31989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectprivate: 32089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* copying audio tracks is not allowed */ 32189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioRecord(const AudioRecord& other); 32289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioRecord& operator = (const AudioRecord& other); 32389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 32489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* a small internal class to handle the callback */ 32589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project class ClientRecordThread : public Thread 32689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project { 32789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project public: 32889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project ClientRecordThread(AudioRecord& receiver, bool bCanCallJava = false); 32989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project private: 33089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project friend class AudioRecord; 33189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project virtual bool threadLoop(); 3326dbc1359f778575d09d6da722b060a6d72c2e7c5Glenn Kasten virtual status_t readyToRun(); 33389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project virtual void onFirstRef() {} 33489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioRecord& mReceiver; 33589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 33689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 33789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project bool processAudioBuffer(const sp<ClientRecordThread>& thread); 3381703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent status_t openRecord_l(uint32_t sampleRate, 33958f30210ea540b6ce5aa6a46330cd3499483cb97Glenn Kasten audio_format_t format, 340624a7fcb377f2a40109c16de5109ae8ea1f67a69Glenn Kasten audio_channel_mask_t channelMask, 34134f1d8ecd23169a5f299937e3aaf1bd7937578a0Eric Laurent int frameCount, 3426100d2d60517ff33ed8eb35d0b7ea63cde0831c9Eric Laurent audio_io_handle_t input); 3431703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent audio_io_handle_t getInput_l(); 3441703cdfee717b1b312bf8979816a9e2f16a82e5dEric Laurent status_t restoreRecord_l(audio_track_cblk_t*& cblk); 34589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 34689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<ClientRecordThread> mClientRecordThread; 3476dbc1359f778575d09d6da722b060a6d72c2e7c5Glenn Kasten status_t mReadyToRun; 348606ee61616efdba4696ae591ad10a4be33d8c946Glenn Kasten mutable Mutex mLock; 3496dbc1359f778575d09d6da722b060a6d72c2e7c5Glenn Kasten Condition mCondition; 35089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 35189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project volatile int32_t mActive; 35289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 35302e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten // for client callback handler 35489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project callback_t mCbf; 35589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void* mUserData; 35602e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten 35702e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten // for notification APIs 35889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mNotificationFrames; 35989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mRemainingFrames; 36002e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten uint32_t mMarkerPosition; // in frames 3617d563247cdac0509009d579bbf849157d47c38a9Jean-Michel Trivi bool mMarkerReached; 36202e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten uint32_t mNewPosition; // in frames 36302e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten uint32_t mUpdatePeriod; // in ms 36402e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten 36502e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten // constant after constructor or set() 36602e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten uint32_t mFrameCount; 36702e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten audio_format_t mFormat; 36802e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten uint8_t mChannelCount; 36902e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten audio_source_t mInputSource; 37002e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten status_t mStatus; 37102e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten uint32_t mLatency; 372624a7fcb377f2a40109c16de5109ae8ea1f67a69Glenn Kasten audio_channel_mask_t mChannelMask; 37302e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten audio_io_handle_t mInput; // returned by AudioSystem::getInput() 374be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int mSessionId; 37502e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten 37602e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten // may be changed if IAudioRecord object is re-created 37702e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten sp<IAudioRecord> mAudioRecord; 37802e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten sp<IMemory> mCblkMemory; 37902e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten audio_track_cblk_t* mCblk; 38002e84eaff54414e9f10c0f605152728a682c6874Glenn Kasten 381879135196fd1c97deefc538c888037c56c2879a7Glenn Kasten int mPreviousPriority; // before start() 382a636433cbd09c0708b85f337ef45c0cdef3bcb4dGlenn Kasten SchedPolicy mPreviousSchedulingGroup; 38389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; 38489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 38589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; // namespace android 38689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 38789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#endif /*AUDIORECORD_H_*/ 388