AudioRecord.h revision 89fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5
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> 2989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <utils/IInterface.h> 3089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#include <utils/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 enum stream_type { 4389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project DEFAULT_INPUT =-1, 4489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project MIC_INPUT = 0, 4589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project NUM_STREAM_TYPES 4689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 4789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 4889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project static const int DEFAULT_SAMPLE_RATE = 8000; 4989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 5089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Events used by AudioRecord callback function (callback_t). 5189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 5289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * to keep in sync with frameworks/base/media/java/android/media/AudioRecord.java 5389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 5489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum event_type { 5589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project EVENT_MORE_DATA = 0, // Request to reqd more data from PCM buffer. 5689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project EVENT_OVERRUN = 1, // PCM buffer overrun occured. 5789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project EVENT_MARKER = 2, // Record head is at the specified marker position 5889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project // (See setMarkerPosition()). 5989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project EVENT_NEW_POS = 3, // Record head is at a new position 6089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project // (See setPositionUpdatePeriod()). 6189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 6289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 6389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Create Buffer on the stack and pass it to obtainBuffer() 6489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and releaseBuffer(). 6589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 6689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 6789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project class Buffer 6889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project { 6989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project public: 7089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum { 7189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project MUTE = 0x00000001 7289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 7389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t flags; 7489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int channelCount; 7589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int format; 7689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project size_t frameCount; 7789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project size_t size; 7889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project union { 7989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void* raw; 8089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project short* i16; 8189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int8_t* i8; 8289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 8389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 8489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 8589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* These are static methods to control the system-wide AudioFlinger 8689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * only privileged processes can have access to them 8789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 8889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 8989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project// static status_t setMasterMute(bool mute); 9089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 9189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* As a convenience, if a callback is supplied, a handler thread 9289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * is automatically created with the appropriate priority. This thread 9389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * invokes the callback when a new buffer becomes ready or an overrun condition occurs. 9489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 9589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 9689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * event: type of event notified (see enum AudioRecord::event_type). 9789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * user: Pointer to context for use by the callback receiver. 9889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * info: Pointer to optional parameter according to event type: 9989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_MORE_DATA: pointer to AudioRecord::Buffer struct. The callback must not read 10089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * more bytes than indicated by 'size' field and update 'size' if less bytes are 10189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * read. 10289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_OVERRUN: unused. 10389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_MARKER: pointer to an uin32_t containing the marker position in frames. 10489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - EVENT_NEW_POS: pointer to an uin32_t containing the new position in frames. 10589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 10689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 10789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project typedef void (*callback_t)(int event, void* user, void *info); 10889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 10989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Constructs an uninitialized AudioRecord. No connection with 11089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * AudioFlinger takes place. 11189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 11289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioRecord(); 11389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 11489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Creates an AudioRecord track and registers it with AudioFlinger. 11589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Once created, the track needs to be started before it can be used. 11689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Unspecified values are set to the audio hardware's current 11789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * values. 11889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 11989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 12089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 12189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * streamType: Select the audio input to record to (e.g. AudioRecord::MIC_INPUT). 12289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * sampleRate: Track sampling rate in Hz. 12389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * format: PCM sample format (e.g AudioSystem::PCM_16_BIT for signed 12489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 16 bits per sample). 12589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * channelCount: Number of PCM channels (e.g 2 for stereo). 12689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * frameCount: Total size of track PCM buffer in frames. This defines the 12789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * latency of the track. 12889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * flags: A bitmask of acoustic values from enum record_flags. It enables 12989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * AGC, NS, and IIR. 13089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * cbf: Callback function. If not null, this function is called periodically 13189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * to provide new PCM data. 13289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * notificationFrames: The callback function is called each time notificationFrames PCM 13389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * frames are ready in record track output buffer. 13489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * user Context for use by the callback receiver. 13589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 13689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 13789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum record_flags { 13889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project RECORD_AGC_ENABLE = AudioSystem::AGC_ENABLE, 13989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project RECORD_NS_ENABLE = AudioSystem::NS_ENABLE, 14089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project RECORD_IIR_ENABLE = AudioSystem::TX_IIR_ENABLE 14189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 14289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 14389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioRecord(int streamType, 14489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t sampleRate = 0, 14589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int format = 0, 14689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int channelCount = 0, 14789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int frameCount = 0, 14889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t flags = 0, 14989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project callback_t cbf = 0, 15089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void* user = 0, 15189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int notificationFrames = 0); 15289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 15389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 15489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Terminates the AudioRecord and unregisters it from AudioFlinger. 15589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Also destroys all resources assotiated with the AudioRecord. 15689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 15789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project ~AudioRecord(); 15889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 15989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 16089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Initialize an uninitialized AudioRecord. 16189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 16289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful intialization 16389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: AudioRecord is already intitialized or record device is already in use 16489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - BAD_VALUE: invalid parameter (channelCount, format, sampleRate...) 16589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_INIT: audio server or audio hardware not initialized 16689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - PERMISSION_DENIED: recording is not allowed for the requesting process 16789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * */ 16889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t set(int streamType = 0, 16989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t sampleRate = 0, 17089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int format = 0, 17189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int channelCount = 0, 17289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int frameCount = 0, 17389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t flags = 0, 17489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project callback_t cbf = 0, 17589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void* user = 0, 17689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int notificationFrames = 0, 17789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project bool threadCanCallJava = false); 17889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 17989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 18089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Result of constructing the AudioRecord. This must be checked 18189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * before using any AudioRecord API (except for set()), using 18289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * an uninitialized AudioRecord produces undefined results. 18389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * See set() method above for possible return codes. 18489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 18589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t initCheck() const; 18689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 18789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Returns this track's latency in milliseconds. 18889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * This includes the latency due to AudioRecord buffer size 18989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and audio hardware driver. 19089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 19189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t latency() const; 19289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 19389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* getters, see constructor */ 19489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 19589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t sampleRate() const; 19689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int format() const; 19789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int channelCount() const; 19889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t frameCount() const; 19989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project int frameSize() const; 20089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 20189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 20289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* After it's created the track is not active. Call start() to 20389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * make it active. If set, the callback will start being called. 20489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 20589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t start(); 20689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 20789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Stop a track. If set, the callback will cease being called and 20889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * obtainBuffer returns STOPPED. Note that obtainBuffer() still works 20989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * and will fill up buffers until the pool is exhausted. 21089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 21189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t stop(); 21289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project bool stopped() const; 21389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 21489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* get sample rate for this track 21589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 21689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t getSampleRate(); 21789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 21889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Sets marker position. When record reaches the number of frames specified, 21989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * a callback with event type EVENT_MARKER is called. Calling setMarkerPosition 22089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * with marker == 0 cancels marker notification callback. 22189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * If the AudioRecord has been opened with no callback function associated, 22289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * the operation will fail. 22389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 22489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 22589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 22689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * marker: marker position expressed in frames. 22789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 22889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 22989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 23089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioRecord has no callback installed. 23189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 23289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setMarkerPosition(uint32_t marker); 23389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t getMarkerPosition(uint32_t *marker); 23489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 23589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 23689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Sets position update period. Every time the number of frames specified has been recorded, 23789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * a callback with event type EVENT_NEW_POS is called. 23889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Calling setPositionUpdatePeriod with updatePeriod == 0 cancels new position notification 23989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * callback. 24089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * If the AudioRecord has been opened with no callback function associated, 24189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * the operation will fail. 24289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 24389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 24489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 24589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * updatePeriod: position update notification period expressed in frames. 24689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 24789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 24889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 24989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - INVALID_OPERATION: the AudioRecord has no callback installed. 25089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 25189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t setPositionUpdatePeriod(uint32_t updatePeriod); 25289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t getPositionUpdatePeriod(uint32_t *updatePeriod); 25389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 25489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 25589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* Gets record head position. The position is the total number of frames 25689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * recorded since record start. 25789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 25889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Parameters: 25989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 26089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * position: Address where to return record head position within AudioRecord buffer. 26189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * 26289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Returned status (from utils/Errors.h) can be: 26389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - NO_ERROR: successful operation 26489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * - BAD_VALUE: position is NULL 26589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 26689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t getPosition(uint32_t *position); 26789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 26889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 26989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 27089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* obtains a buffer of "frameCount" frames. The buffer must be 27189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * filled entirely. If the track is stopped, obtainBuffer() returns 27289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * STOPPED instead of NO_ERROR as long as there are buffers availlable, 27389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * at which point NO_MORE_BUFFERS is returned. 27489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * Buffers will be returned until the pool (buffercount()) 27589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * is exhausted, at which point obtainBuffer() will either block 27689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * or return WOULD_BLOCK depending on the value of the "blocking" 27789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * parameter. 27889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 27989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 28089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project enum { 28189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project NO_MORE_BUFFERS = 0x80000001, 28289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project STOPPED = 1 28389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 28489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 28589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t obtainBuffer(Buffer* audioBuffer, int32_t waitCount); 28689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void releaseBuffer(Buffer* audioBuffer); 28789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 28889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 28989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* As a convenience we provide a read() interface to the audio buffer. 29089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project * This is implemented on top of lockBuffer/unlockBuffer. 29189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project */ 29289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project ssize_t read(void* buffer, size_t size); 29389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 29489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Projectprivate: 29589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* copying audio tracks is not allowed */ 29689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioRecord(const AudioRecord& other); 29789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioRecord& operator = (const AudioRecord& other); 29889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 29989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project /* a small internal class to handle the callback */ 30089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project class ClientRecordThread : public Thread 30189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project { 30289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project public: 30389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project ClientRecordThread(AudioRecord& receiver, bool bCanCallJava = false); 30489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project private: 30589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project friend class AudioRecord; 30689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project virtual bool threadLoop(); 30789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project virtual status_t readyToRun() { return NO_ERROR; } 30889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project virtual void onFirstRef() {} 30989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project AudioRecord& mReceiver; 31089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project Mutex mLock; 31189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project }; 31289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 31389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project bool processAudioBuffer(const sp<ClientRecordThread>& thread); 31489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 31589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<IAudioFlinger> mAudioFlinger; 31689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<IAudioRecord> mAudioRecord; 31789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<IMemory> mCblkMemory; 31889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project sp<ClientRecordThread> mClientRecordThread; 31989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project Mutex mRecordThreadLock; 32089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 32189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mSampleRate; 32289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mFrameCount; 32389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 32489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project audio_track_cblk_t* mCblk; 32589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint8_t mFormat; 32689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint8_t mChannelCount; 32789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint8_t mReserved[2]; 32889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project status_t mStatus; 32989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mLatency; 33089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 33189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project volatile int32_t mActive; 33289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 33389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project callback_t mCbf; 33489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project void* mUserData; 33589fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mNotificationFrames; 33689fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mRemainingFrames; 33789fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mMarkerPosition; 33889fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mNewPosition; 33989fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project uint32_t mUpdatePeriod; 34089fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; 34189fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 34289fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project}; // namespace android 34389fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project 34489fa4ad53f2f4d57adbc97ae1149fc00c9b6f3c5The Android Open Source Project#endif /*AUDIORECORD_H_*/ 345