AudioStreamRecord.cpp revision c42d5f9ba80d827e135f21c7ff995bc752f6477c 
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 "AudioStreamRecord"
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    mAudioRecord = new AudioRecord(
100            AUDIO_SOURCE_VOICE_RECOGNITION,
101            getSampleRate(),
102            format,
103            channelMask,
104            mOpPackageName, // const String16& opPackageName TODO does not compile
105            frameCount,
106            callback,
107            callbackData,
108            notificationFrames,
109            AUDIO_SESSION_ALLOCATE,
110            streamTransferType,
111            flags
112            //   int uid = -1,
113            //   pid_t pid = -1,
114            //   const audio_attributes_t* pAttributes = nullptr
115            );
116
117    // Did we get a valid track?
118    status_t status = mAudioRecord->initCheck();
119    if (status != OK) {
120        close();
121        ALOGE("AudioStreamRecord::open(), initCheck() returned %d", status);
122        return AAudioConvert_androidToAAudioResult(status);
123    }
124
125    // Get the actual rate.
126    setSampleRate(mAudioRecord->getSampleRate());
127    setSamplesPerFrame(mAudioRecord->channelCount());
128    setFormat(AAudioConvert_androidToAAudioDataFormat(mAudioRecord->format()));
129
130    // We may need to pass the data through a block size adapter to guarantee constant size.
131    if (mCallbackBufferSize != AAUDIO_UNSPECIFIED) {
132        int callbackSizeBytes = getBytesPerFrame() * mCallbackBufferSize;
133        mFixedBlockWriter.open(callbackSizeBytes);
134        mBlockAdapter = &mFixedBlockWriter;
135    } else {
136        mBlockAdapter = nullptr;
137    }
138
139    // Update performance mode based on the actual stream.
140    // For example, if the sample rate does not match native then you won't get a FAST track.
141    audio_input_flags_t actualFlags = mAudioRecord->getFlags();
142    aaudio_performance_mode_t actualPerformanceMode = AAUDIO_PERFORMANCE_MODE_NONE;
143    // FIXME Some platforms do not advertise RAW mode for low latency inputs.
144    if ((actualFlags & (AUDIO_INPUT_FLAG_FAST))
145        == (AUDIO_INPUT_FLAG_FAST)) {
146        actualPerformanceMode = AAUDIO_PERFORMANCE_MODE_LOW_LATENCY;
147    }
148    setPerformanceMode(actualPerformanceMode);
149    // Log warning if we did not get what we asked for.
150    ALOGW_IF(actualFlags != flags,
151             "AudioStreamRecord::open() flags changed from 0x%08X to 0x%08X",
152             flags, actualFlags);
153    ALOGW_IF(actualPerformanceMode != perfMode,
154             "AudioStreamRecord::open() perfMode changed from %d to %d",
155             perfMode, actualPerformanceMode);
156
157    setState(AAUDIO_STREAM_STATE_OPEN);
158
159    return AAUDIO_OK;
160}
161
162aaudio_result_t AudioStreamRecord::close()
163{
164    // TODO add close() or release() to AudioRecord API then call it from here
165    if (getState() != AAUDIO_STREAM_STATE_CLOSED) {
166        mAudioRecord.clear();
167        setState(AAUDIO_STREAM_STATE_CLOSED);
168    }
169    mFixedBlockWriter.close();
170    return AAUDIO_OK;
171}
172
173void AudioStreamRecord::processCallback(int event, void *info) {
174
175    ALOGD("AudioStreamRecord::processCallback(), event %d", event);
176    switch (event) {
177        case AudioRecord::EVENT_MORE_DATA:
178            processCallbackCommon(AAUDIO_CALLBACK_OPERATION_PROCESS_DATA, info);
179            break;
180
181            // Stream got rerouted so we disconnect.
182        case AudioRecord::EVENT_NEW_IAUDIORECORD:
183            processCallbackCommon(AAUDIO_CALLBACK_OPERATION_DISCONNECTED, info);
184            break;
185
186        default:
187            break;
188    }
189    return;
190}
191
192aaudio_result_t AudioStreamRecord::requestStart()
193{
194    if (mAudioRecord.get() == nullptr) {
195        return AAUDIO_ERROR_INVALID_STATE;
196    }
197    // Get current position so we can detect when the track is playing.
198    status_t err = mAudioRecord->getPosition(&mPositionWhenStarting);
199    if (err != OK) {
200        return AAudioConvert_androidToAAudioResult(err);
201    }
202
203    err = mAudioRecord->start();
204    if (err != OK) {
205        return AAudioConvert_androidToAAudioResult(err);
206    } else {
207        setState(AAUDIO_STREAM_STATE_STARTING);
208    }
209    return AAUDIO_OK;
210}
211
212aaudio_result_t AudioStreamRecord::requestPause()
213{
214    // This does not make sense for an input stream.
215    // There is no real difference between pause() and stop().
216    return AAUDIO_ERROR_UNIMPLEMENTED;
217}
218
219aaudio_result_t AudioStreamRecord::requestFlush() {
220    // This does not make sense for an input stream.
221    return AAUDIO_ERROR_UNIMPLEMENTED;
222}
223
224aaudio_result_t AudioStreamRecord::requestStop() {
225    if (mAudioRecord.get() == nullptr) {
226        return AAUDIO_ERROR_INVALID_STATE;
227    }
228    setState(AAUDIO_STREAM_STATE_STOPPING);
229    incrementFramesWritten(getFramesRead() - getFramesWritten()); // TODO review
230    mAudioRecord->stop();
231    mFramesRead.reset32();
232    return AAUDIO_OK;
233}
234
235aaudio_result_t AudioStreamRecord::updateStateWhileWaiting()
236{
237    aaudio_result_t result = AAUDIO_OK;
238    aaudio_wrapping_frames_t position;
239    status_t err;
240    switch (getState()) {
241    // TODO add better state visibility to AudioRecord
242    case AAUDIO_STREAM_STATE_STARTING:
243        err = mAudioRecord->getPosition(&position);
244        if (err != OK) {
245            result = AAudioConvert_androidToAAudioResult(err);
246        } else if (position != mPositionWhenStarting) {
247            setState(AAUDIO_STREAM_STATE_STARTED);
248        }
249        break;
250    case AAUDIO_STREAM_STATE_STOPPING:
251        if (mAudioRecord->stopped()) {
252            setState(AAUDIO_STREAM_STATE_STOPPED);
253        }
254        break;
255    default:
256        break;
257    }
258    return result;
259}
260
261aaudio_result_t AudioStreamRecord::read(void *buffer,
262                                      int32_t numFrames,
263                                      int64_t timeoutNanoseconds)
264{
265    int32_t bytesPerFrame = getBytesPerFrame();
266    int32_t numBytes;
267    aaudio_result_t result = AAudioConvert_framesToBytes(numFrames, bytesPerFrame, &numBytes);
268    if (result != AAUDIO_OK) {
269        return result;
270    }
271
272    // TODO add timeout to AudioRecord
273    bool blocking = (timeoutNanoseconds > 0);
274    ssize_t bytesRead = mAudioRecord->read(buffer, numBytes, blocking);
275    if (bytesRead == WOULD_BLOCK) {
276        return 0;
277    } else if (bytesRead < 0) {
278        return AAudioConvert_androidToAAudioResult(bytesRead);
279    }
280    int32_t framesRead = (int32_t)(bytesRead / bytesPerFrame);
281    incrementFramesRead(framesRead);
282    return (aaudio_result_t) framesRead;
283}
284
285aaudio_result_t AudioStreamRecord::setBufferSize(int32_t requestedFrames)
286{
287    return getBufferSize();
288}
289
290int32_t AudioStreamRecord::getBufferSize() const
291{
292    return getBufferCapacity(); // TODO implement in AudioRecord?
293}
294
295int32_t AudioStreamRecord::getBufferCapacity() const
296{
297    return static_cast<int32_t>(mAudioRecord->frameCount());
298}
299
300int32_t AudioStreamRecord::getXRunCount() const
301{
302    return 0; // TODO implement when AudioRecord supports it
303}
304
305int32_t AudioStreamRecord::getFramesPerBurst() const
306{
307    return static_cast<int32_t>(mAudioRecord->getNotificationPeriodInFrames());
308}
309
310aaudio_result_t AudioStreamRecord::getTimestamp(clockid_t clockId,
311                                               int64_t *framePosition,
312                                               int64_t *timeNanoseconds) {
313    ExtendedTimestamp extendedTimestamp;
314    status_t status = mAudioRecord->getTimestamp(&extendedTimestamp);
315    if (status != NO_ERROR) {
316        return AAudioConvert_androidToAAudioResult(status);
317    }
318    return getBestTimestamp(clockId, framePosition, timeNanoseconds, &extendedTimestamp);
319}
320