AudioRecord.h revision be916aa1267e2e6b1c148f51d11bcbbc79cb864c
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 2089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <stdint.h> 2189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <sys/types.h> 2289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <media/IAudioFlinger.h> 2489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <media/IAudioRecord.h> 2589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <media/AudioTrack.h> 2689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 2789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <utils/RefBase.h> 2889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <utils/Errors.h> 297562408b2261d38415453378b6188f74fda99d88Mathias Agopian#include <binder/IInterface.h> 307562408b2261d38415453378b6188f74fda99d88Mathias Agopian#include <binder/IMemory.h> 3189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <utils/threads.h> 3289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 3389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 3489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectnamespace android { 3589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 3689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project// ---------------------------------------------------------------------------- 3789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 3889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectclass AudioRecord 3989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project{ 4089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectpublic: 4189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 4289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project static const int DEFAULT_SAMPLE_RATE = 8000; 4389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 4489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Events used by AudioRecord callback function (callback_t). 45c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * 4689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * to keep in sync with frameworks/base/media/java/android/media/AudioRecord.java 4789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 4889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum event_type { 4989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project EVENT_MORE_DATA = 0, // Request to reqd more data from PCM buffer. 5089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project EVENT_OVERRUN = 1, // PCM buffer overrun occured. 5189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project EVENT_MARKER = 2, // Record head is at the specified marker position 5289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project // (See setMarkerPosition()). 53c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent EVENT_NEW_POS = 3, // Record head is at a new position 5489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project // (See setPositionUpdatePeriod()). 5589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 5689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 5789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Create Buffer on the stack and pass it to obtainBuffer() 5889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and releaseBuffer(). 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: 6489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum { 6589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project MUTE = 0x00000001 6689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 6789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t flags; 6889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int channelCount; 6989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int format; 7089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project size_t frameCount; 7189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project size_t size; 7289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project union { 7389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void* raw; 7489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project short* i16; 7589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int8_t* i8; 7689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 7789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 7889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 7989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* These are static methods to control the system-wide AudioFlinger 8089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * only privileged processes can have access to them 8189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 8289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 8389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project// static status_t setMasterMute(bool mute); 8489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 8589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* As a convenience, if a callback is supplied, a handler thread 8689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * is automatically created with the appropriate priority. This thread 8789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * invokes the callback when a new buffer becomes ready or an overrun condition occurs. 8889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 8989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 9089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * event: type of event notified (see enum AudioRecord::event_type). 9189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * user: Pointer to context for use by the callback receiver. 9289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * info: Pointer to optional parameter according to event type: 9389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_MORE_DATA: pointer to AudioRecord::Buffer struct. The callback must not read 9489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * more bytes than indicated by 'size' field and update 'size' if less bytes are 9589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * read. 9689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_OVERRUN: unused. 9789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_MARKER: pointer to an uin32_t containing the marker position in frames. 9889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_NEW_POS: pointer to an uin32_t containing the new position in frames. 9989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 10089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 10189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project typedef void (*callback_t)(int event, void* user, void *info); 10289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 10389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Constructs an uninitialized AudioRecord. No connection with 10489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * AudioFlinger takes place. 10589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 10689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioRecord(); 10789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 10889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Creates an AudioRecord track and registers it with AudioFlinger. 10989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Once created, the track needs to be started before it can be used. 11089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Unspecified values are set to the audio hardware's current 11189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * values. 11289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 11389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 11489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 115c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * inputSource: Select the audio input to record to (e.g. AUDIO_SOURCE_DEFAULT). 11689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * sampleRate: Track sampling rate in Hz. 117c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * format: Audio format (e.g AudioSystem::PCM_16_BIT for signed 11889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 16 bits per sample). 119c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * channels: Channel mask: see AudioSystem::audio_channels. 12089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * frameCount: Total size of track PCM buffer in frames. This defines the 12189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * latency of the track. 12289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * flags: A bitmask of acoustic values from enum record_flags. It enables 12389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * AGC, NS, and IIR. 12489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * cbf: Callback function. If not null, this function is called periodically 12589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * to provide new PCM data. 12689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * notificationFrames: The callback function is called each time notificationFrames PCM 12789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * frames are ready in record track output buffer. 12889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * user Context for use by the callback receiver. 12989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 13089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 13189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum record_flags { 13289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project RECORD_AGC_ENABLE = AudioSystem::AGC_ENABLE, 13389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project RECORD_NS_ENABLE = AudioSystem::NS_ENABLE, 13489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project RECORD_IIR_ENABLE = AudioSystem::TX_IIR_ENABLE 13589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 13689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 137f5879c1448cc6aebc51b26d3ec2399d66144f8f4Eric Laurent AudioRecord(int inputSource, 13889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t sampleRate = 0, 13989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int format = 0, 140c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent uint32_t channels = AudioSystem::CHANNEL_IN_MONO, 14189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int frameCount = 0, 14289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t flags = 0, 14389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project callback_t cbf = 0, 14489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void* user = 0, 145be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int notificationFrames = 0, 146be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int sessionId = 0); 14789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 14889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 14989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Terminates the AudioRecord and unregisters it from AudioFlinger. 15089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Also destroys all resources assotiated with the AudioRecord. 15189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 15289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project ~AudioRecord(); 15389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 15489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 15589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Initialize an uninitialized AudioRecord. 15689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 15789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful intialization 15889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: AudioRecord is already intitialized or record device is already in use 159c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * - BAD_VALUE: invalid parameter (channels, format, sampleRate...) 16089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_INIT: audio server or audio hardware not initialized 16189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - PERMISSION_DENIED: recording is not allowed for the requesting process 16289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * */ 163f5879c1448cc6aebc51b26d3ec2399d66144f8f4Eric Laurent status_t set(int inputSource = 0, 16489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t sampleRate = 0, 16589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int format = 0, 166c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent uint32_t channels = AudioSystem::CHANNEL_IN_MONO, 16789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int frameCount = 0, 16889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t flags = 0, 16989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project callback_t cbf = 0, 17089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void* user = 0, 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 18989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* getters, see constructor */ 19089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 19189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int format() const; 19289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int channelCount() const; 193c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent int channels() const; 19489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t frameCount() const; 19589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int frameSize() const; 196f5879c1448cc6aebc51b26d3ec2399d66144f8f4Eric Laurent int inputSource() const; 19789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 19889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 19989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* After it's created the track is not active. Call start() to 20089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * make it active. If set, the callback will start being called. 20189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 20289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t start(); 20389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 20489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Stop a track. If set, the callback will cease being called and 20589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * obtainBuffer returns STOPPED. Note that obtainBuffer() still works 20689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and will fill up buffers until the pool is exhausted. 20789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 20889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t stop(); 20989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project bool stopped() const; 21089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 211573266210fb2b2e7d86fbd46d0dfe16763611d91Eric Laurent /* get sample rate for this record track 21289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 21389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t getSampleRate(); 21489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 21589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Sets marker position. When record reaches the number of frames specified, 21689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * a callback with event type EVENT_MARKER is called. Calling setMarkerPosition 217c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * with marker == 0 cancels marker notification callback. 218c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * If the AudioRecord has been opened with no callback function associated, 21989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * the operation will fail. 22089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 22189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 22289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 22389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * marker: marker position expressed in frames. 22489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 22589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 22689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 22789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioRecord has no callback installed. 22889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 22989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setMarkerPosition(uint32_t marker); 23089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t getMarkerPosition(uint32_t *marker); 23189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 23289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 233c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent /* Sets position update period. Every time the number of frames specified has been recorded, 234c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * a callback with event type EVENT_NEW_POS is called. 235c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Calling setPositionUpdatePeriod with updatePeriod == 0 cancels new position notification 236c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * callback. 23789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * If the AudioRecord has been opened with no callback function associated, 23889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * the operation will fail. 23989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 24089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 24189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 24289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * updatePeriod: position update notification period expressed in frames. 24389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 24489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 24589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 24689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioRecord has no callback installed. 24789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 24889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setPositionUpdatePeriod(uint32_t updatePeriod); 24989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t getPositionUpdatePeriod(uint32_t *updatePeriod); 25089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 25189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 252c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent /* Gets record head position. The position is the total number of frames 253c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * recorded since record start. 25489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 25589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 25689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 25789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * position: Address where to return record head position within AudioRecord buffer. 25889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 25989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 26089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 26189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - BAD_VALUE: position is NULL 26289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 26389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t getPosition(uint32_t *position); 26489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 265c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent /* returns a handle on the audio input used by this AudioRecord. 266c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * 267c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Parameters: 268c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * none. 269c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * 270c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * Returned value: 271c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent * handle on audio hardware input 272c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent */ 2736100d2d60517ff33ed8eb35d0b7ea63cde0831c9Eric Laurent audio_io_handle_t getInput(); 274c2f1f07084818942352c6bbfb36af9b6b330eb4eEric Laurent 275be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent /* returns the audio session ID associated to this AudioRecord. 276be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 277be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Parameters: 278be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * none. 279be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * 280be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * Returned value: 281be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent * AudioRecord session ID. 282be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent */ 283be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int getSessionId(); 284be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent 28589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* obtains a buffer of "frameCount" frames. The buffer must be 28689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * filled entirely. If the track is stopped, obtainBuffer() returns 28789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * STOPPED instead of NO_ERROR as long as there are buffers availlable, 28889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * at which point NO_MORE_BUFFERS is returned. 28989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Buffers will be returned until the pool (buffercount()) 29089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * is exhausted, at which point obtainBuffer() will either block 29189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * or return WOULD_BLOCK depending on the value of the "blocking" 29289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * parameter. 29389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 29489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 29589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum { 29689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project NO_MORE_BUFFERS = 0x80000001, 29789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project STOPPED = 1 29889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 29989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 30089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t obtainBuffer(Buffer* audioBuffer, int32_t waitCount); 30189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void releaseBuffer(Buffer* audioBuffer); 30289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 30389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 30489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* As a convenience we provide a read() interface to the audio buffer. 30589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * This is implemented on top of lockBuffer/unlockBuffer. 30689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 30789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project ssize_t read(void* buffer, size_t size); 30889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 30905bca2fde53bfe3063d2a0a877f2b6bfdd6052cfEric Laurent /* Return the amount of input frames lost in the audio driver since the last call of this function. 31005bca2fde53bfe3063d2a0a877f2b6bfdd6052cfEric Laurent * Audio driver is expected to reset the value to 0 and restart counting upon returning the current value by this function call. 31105bca2fde53bfe3063d2a0a877f2b6bfdd6052cfEric Laurent * Such loss typically occurs when the user space process is blocked longer than the capacity of audio driver buffers. 31205bca2fde53bfe3063d2a0a877f2b6bfdd6052cfEric Laurent * Unit: the number of input audio frames 31305bca2fde53bfe3063d2a0a877f2b6bfdd6052cfEric Laurent */ 31405bca2fde53bfe3063d2a0a877f2b6bfdd6052cfEric Laurent unsigned int getInputFramesLost(); 31505bca2fde53bfe3063d2a0a877f2b6bfdd6052cfEric Laurent 31689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectprivate: 31789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* copying audio tracks is not allowed */ 31889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioRecord(const AudioRecord& other); 31989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioRecord& operator = (const AudioRecord& other); 32089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 32189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* a small internal class to handle the callback */ 32289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project class ClientRecordThread : public Thread 32389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project { 32489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project public: 32589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project ClientRecordThread(AudioRecord& receiver, bool bCanCallJava = false); 32689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project private: 32789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project friend class AudioRecord; 32889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project virtual bool threadLoop(); 32989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project virtual status_t readyToRun() { return NO_ERROR; } 33089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project virtual void onFirstRef() {} 33189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioRecord& mReceiver; 33289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project Mutex mLock; 33389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 33489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 33589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project bool processAudioBuffer(const sp<ClientRecordThread>& thread); 33634f1d8ecd23169a5f299937e3aaf1bd7937578a0Eric Laurent status_t openRecord(uint32_t sampleRate, 33734f1d8ecd23169a5f299937e3aaf1bd7937578a0Eric Laurent int format, 33834f1d8ecd23169a5f299937e3aaf1bd7937578a0Eric Laurent int channelCount, 33934f1d8ecd23169a5f299937e3aaf1bd7937578a0Eric Laurent int frameCount, 3406100d2d60517ff33ed8eb35d0b7ea63cde0831c9Eric Laurent uint32_t flags, 3416100d2d60517ff33ed8eb35d0b7ea63cde0831c9Eric Laurent audio_io_handle_t input); 34289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 34389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<IAudioRecord> mAudioRecord; 34489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<IMemory> mCblkMemory; 34589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<ClientRecordThread> mClientRecordThread; 34689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project Mutex mRecordThreadLock; 34789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 34889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mFrameCount; 34989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 35089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project audio_track_cblk_t* mCblk; 35189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint8_t mFormat; 35289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint8_t mChannelCount; 353f5879c1448cc6aebc51b26d3ec2399d66144f8f4Eric Laurent uint8_t mInputSource; 354f5879c1448cc6aebc51b26d3ec2399d66144f8f4Eric Laurent uint8_t mReserved; 35589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t mStatus; 35689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mLatency; 35789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 35889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project volatile int32_t mActive; 35989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 36089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project callback_t mCbf; 36189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void* mUserData; 36289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mNotificationFrames; 36389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mRemainingFrames; 36489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mMarkerPosition; 3657d563247cdac0509009d579bbf849157d47c38a9Jean-Michel Trivi bool mMarkerReached; 36689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mNewPosition; 36789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mUpdatePeriod; 36834f1d8ecd23169a5f299937e3aaf1bd7937578a0Eric Laurent uint32_t mFlags; 3696100d2d60517ff33ed8eb35d0b7ea63cde0831c9Eric Laurent uint32_t mChannels; 37005bca2fde53bfe3063d2a0a877f2b6bfdd6052cfEric Laurent audio_io_handle_t mInput; 371be916aa1267e2e6b1c148f51d11bcbbc79cb864cEric Laurent int mSessionId; 37289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; 37389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 37489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; // namespace android 37589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 37689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#endif /*AUDIORECORD_H_*/ 377