AudioStreamRecord.cpp revision d08f04f33b80c37bd3889f461846d59f70e726c7 
1/*
2 * Copyright 2016 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#define LOG_TAG "AAudio"
18//#define LOG_NDEBUG 0
19#include <utils/Log.h>
20
21#include <stdint.h>
22#include <utils/String16.h>
23#include <media/AudioRecord.h>
24#include <aaudio/AAudio.h>
25
26#include "AudioClock.h"
27#include "legacy/AudioStreamLegacy.h"
28#include "legacy/AudioStreamRecord.h"
29#include "utility/FixedBlockWriter.h"
30
31using namespace android;
32using namespace aaudio;
33
34AudioStreamRecord::AudioStreamRecord()
35    : AudioStreamLegacy()
36    , mFixedBlockWriter(*this)
37{
38}
39
40AudioStreamRecord::~AudioStreamRecord()
41{
42    const aaudio_stream_state_t state = getState();
43    bool bad = !(state == AAUDIO_STREAM_STATE_UNINITIALIZED || state == AAUDIO_STREAM_STATE_CLOSED);
44    ALOGE_IF(bad, "stream not closed, in state %d", state);
45}
46
47aaudio_result_t AudioStreamRecord::open(const AudioStreamBuilder& builder)
48{
49    aaudio_result_t result = AAUDIO_OK;
50
51    result = AudioStream::open(builder);
52    if (result != AAUDIO_OK) {
53        return result;
54    }
55
56    // Try to create an AudioRecord
57
58    // TODO Support UNSPECIFIED in AudioTrack. For now, use stereo if unspecified.
59    int32_t samplesPerFrame = (getSamplesPerFrame() == AAUDIO_UNSPECIFIED)
60                              ? 2 : getSamplesPerFrame();
61    audio_channel_mask_t channelMask = audio_channel_in_mask_from_count(samplesPerFrame);
62
63    size_t frameCount = (builder.getBufferCapacity() == AAUDIO_UNSPECIFIED) ? 0
64                        : builder.getBufferCapacity();
65
66    // TODO implement an unspecified Android format then use that.
67    audio_format_t format = (getFormat() == AAUDIO_UNSPECIFIED)
68            ? AUDIO_FORMAT_PCM_FLOAT
69            : AAudioConvert_aaudioToAndroidDataFormat(getFormat());
70
71    audio_input_flags_t flags = AUDIO_INPUT_FLAG_NONE;
72    aaudio_performance_mode_t perfMode = getPerformanceMode();
73    switch (perfMode) {
74        case AAUDIO_PERFORMANCE_MODE_LOW_LATENCY:
75            flags = (audio_input_flags_t) (AUDIO_INPUT_FLAG_FAST | AUDIO_INPUT_FLAG_RAW);
76            break;
77
78        case AAUDIO_PERFORMANCE_MODE_POWER_SAVING:
79        case AAUDIO_PERFORMANCE_MODE_NONE:
80        default:
81            // No flags.
82            break;
83    }
84
85    uint32_t notificationFrames = 0;
86
87    // Setup the callback if there is one.
88    AudioRecord::callback_t callback = nullptr;
89    void *callbackData = nullptr;
90    AudioRecord::transfer_type streamTransferType = AudioRecord::transfer_type::TRANSFER_SYNC;
91    if (builder.getDataCallbackProc() != nullptr) {
92        streamTransferType = AudioRecord::transfer_type::TRANSFER_CALLBACK;
93        callback = getLegacyCallback();
94        callbackData = this;
95        notificationFrames = builder.getFramesPerDataCallback();
96    }
97    mCallbackBufferSize = builder.getFramesPerDataCallback();
98
99    ALOGD("AudioStreamRecord::open(), request notificationFrames = %u, frameCount = %u",
100          notificationFrames, (uint)frameCount);
101    mAudioRecord = new AudioRecord(
102            AUDIO_SOURCE_VOICE_RECOGNITION,
103            getSampleRate(),
104            format,
105            channelMask,
106            mOpPackageName, // const String16& opPackageName TODO does not compile
107            frameCount,
108            callback,
109            callbackData,
110            notificationFrames,
111            AUDIO_SESSION_ALLOCATE,
112            streamTransferType,
113            flags
114            //   int uid = -1,
115            //   pid_t pid = -1,
116            //   const audio_attributes_t* pAttributes = nullptr
117            );
118
119    // Did we get a valid track?
120    status_t status = mAudioRecord->initCheck();
121    if (status != OK) {
122        close();
123        ALOGE("AudioStreamRecord::open(), initCheck() returned %d", status);
124        return AAudioConvert_androidToAAudioResult(status);
125    }
126
127    // Get the actual rate.
128    setSampleRate(mAudioRecord->getSampleRate());
129    setFormat(AAudioConvert_androidToAAudioDataFormat(mAudioRecord->format()));
130
131    int32_t actualSampleRate = mAudioRecord->getSampleRate();
132    ALOGW_IF(actualSampleRate != getSampleRate(),
133             "AudioStreamRecord::open() sampleRate changed from %d to %d",
134             getSampleRate(), actualSampleRate);
135    setSampleRate(actualSampleRate);
136
137    // We may need to pass the data through a block size adapter to guarantee constant size.
138    if (mCallbackBufferSize != AAUDIO_UNSPECIFIED) {
139        int callbackSizeBytes = getBytesPerFrame() * mCallbackBufferSize;
140        mFixedBlockWriter.open(callbackSizeBytes);
141        mBlockAdapter = &mFixedBlockWriter;
142    } else {
143        mBlockAdapter = nullptr;
144    }
145
146    // Update performance mode based on the actual stream.
147    // For example, if the sample rate does not match native then you won't get a FAST track.
148    audio_input_flags_t actualFlags = mAudioRecord->getFlags();
149    aaudio_performance_mode_t actualPerformanceMode = AAUDIO_PERFORMANCE_MODE_NONE;
150    // FIXME Some platforms do not advertise RAW mode for low latency inputs.
151    if ((actualFlags & (AUDIO_INPUT_FLAG_FAST))
152        == (AUDIO_INPUT_FLAG_FAST)) {
153        actualPerformanceMode = AAUDIO_PERFORMANCE_MODE_LOW_LATENCY;
154    }
155    setPerformanceMode(actualPerformanceMode);
156    // Log warning if we did not get what we asked for.
157    ALOGW_IF(actualFlags != flags,
158             "AudioStreamRecord::open() flags changed from 0x%08X to 0x%08X",
159             flags, actualFlags);
160    ALOGW_IF(actualPerformanceMode != perfMode,
161             "AudioStreamRecord::open() perfMode changed from %d to %d",
162             perfMode, actualPerformanceMode);
163
164    setState(AAUDIO_STREAM_STATE_OPEN);
165
166    return AAUDIO_OK;
167}
168
169aaudio_result_t AudioStreamRecord::close()
170{
171    // TODO add close() or release() to AudioRecord API then call it from here
172    if (getState() != AAUDIO_STREAM_STATE_CLOSED) {
173        mAudioRecord.clear();
174        setState(AAUDIO_STREAM_STATE_CLOSED);
175    }
176    mFixedBlockWriter.close();
177    return AAUDIO_OK;
178}
179
180void AudioStreamRecord::processCallback(int event, void *info) {
181    switch (event) {
182        case AudioRecord::EVENT_MORE_DATA:
183            processCallbackCommon(AAUDIO_CALLBACK_OPERATION_PROCESS_DATA, info);
184            break;
185
186            // Stream got rerouted so we disconnect.
187        case AudioRecord::EVENT_NEW_IAUDIORECORD:
188            processCallbackCommon(AAUDIO_CALLBACK_OPERATION_DISCONNECTED, info);
189            break;
190
191        default:
192            break;
193    }
194    return;
195}
196
197aaudio_result_t AudioStreamRecord::requestStart()
198{
199    if (mAudioRecord.get() == nullptr) {
200        return AAUDIO_ERROR_INVALID_STATE;
201    }
202    // Get current position so we can detect when the track is playing.
203    status_t err = mAudioRecord->getPosition(&mPositionWhenStarting);
204    if (err != OK) {
205        return AAudioConvert_androidToAAudioResult(err);
206    }
207
208    err = mAudioRecord->start();
209    if (err != OK) {
210        return AAudioConvert_androidToAAudioResult(err);
211    } else {
212        setState(AAUDIO_STREAM_STATE_STARTING);
213    }
214    return AAUDIO_OK;
215}
216
217aaudio_result_t AudioStreamRecord::requestPause()
218{
219    // This does not make sense for an input stream.
220    // There is no real difference between pause() and stop().
221    return AAUDIO_ERROR_UNIMPLEMENTED;
222}
223
224aaudio_result_t AudioStreamRecord::requestFlush() {
225    // This does not make sense for an input stream.
226    return AAUDIO_ERROR_UNIMPLEMENTED;
227}
228
229aaudio_result_t AudioStreamRecord::requestStop() {
230    if (mAudioRecord.get() == nullptr) {
231        return AAUDIO_ERROR_INVALID_STATE;
232    }
233    setState(AAUDIO_STREAM_STATE_STOPPING);
234    incrementFramesWritten(getFramesRead() - getFramesWritten()); // TODO review
235    mAudioRecord->stop();
236    mFramesRead.reset32();
237    return AAUDIO_OK;
238}
239
240aaudio_result_t AudioStreamRecord::updateStateWhileWaiting()
241{
242    aaudio_result_t result = AAUDIO_OK;
243    aaudio_wrapping_frames_t position;
244    status_t err;
245    switch (getState()) {
246    // TODO add better state visibility to AudioRecord
247    case AAUDIO_STREAM_STATE_STARTING:
248        err = mAudioRecord->getPosition(&position);
249        if (err != OK) {
250            result = AAudioConvert_androidToAAudioResult(err);
251        } else if (position != mPositionWhenStarting) {
252            setState(AAUDIO_STREAM_STATE_STARTED);
253        }
254        break;
255    case AAUDIO_STREAM_STATE_STOPPING:
256        if (mAudioRecord->stopped()) {
257            setState(AAUDIO_STREAM_STATE_STOPPED);
258        }
259        break;
260    default:
261        break;
262    }
263    return result;
264}
265
266aaudio_result_t AudioStreamRecord::read(void *buffer,
267                                      int32_t numFrames,
268                                      int64_t timeoutNanoseconds)
269{
270    int32_t bytesPerFrame = getBytesPerFrame();
271    int32_t numBytes;
272    aaudio_result_t result = AAudioConvert_framesToBytes(numFrames, bytesPerFrame, &numBytes);
273    if (result != AAUDIO_OK) {
274        return result;
275    }
276
277    // TODO add timeout to AudioRecord
278    bool blocking = (timeoutNanoseconds > 0);
279    ssize_t bytesRead = mAudioRecord->read(buffer, numBytes, blocking);
280    if (bytesRead == WOULD_BLOCK) {
281        return 0;
282    } else if (bytesRead < 0) {
283        return AAudioConvert_androidToAAudioResult(bytesRead);
284    }
285    int32_t framesRead = (int32_t)(bytesRead / bytesPerFrame);
286    incrementFramesRead(framesRead);
287    return (aaudio_result_t) framesRead;
288}
289
290aaudio_result_t AudioStreamRecord::setBufferSize(int32_t requestedFrames)
291{
292    return getBufferSize();
293}
294
295int32_t AudioStreamRecord::getBufferSize() const
296{
297    return getBufferCapacity(); // TODO implement in AudioRecord?
298}
299
300int32_t AudioStreamRecord::getBufferCapacity() const
301{
302    return static_cast<int32_t>(mAudioRecord->frameCount());
303}
304
305int32_t AudioStreamRecord::getXRunCount() const
306{
307    return 0; // TODO implement when AudioRecord supports it
308}
309
310int32_t AudioStreamRecord::getFramesPerBurst() const
311{
312    return static_cast<int32_t>(mAudioRecord->getNotificationPeriodInFrames());
313}
314
315aaudio_result_t AudioStreamRecord::getTimestamp(clockid_t clockId,
316                                               int64_t *framePosition,
317                                               int64_t *timeNanoseconds) {
318    ExtendedTimestamp extendedTimestamp;
319    status_t status = mAudioRecord->getTimestamp(&extendedTimestamp);
320    if (status != NO_ERROR) {
321        return AAudioConvert_androidToAAudioResult(status);
322    }
323    return getBestTimestamp(clockId, framePosition, timeNanoseconds, &extendedTimestamp);
324}
325