1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
media / audio / apple / audio_input.cc [blame]
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "media/audio/apple/audio_input.h"
#include <CoreServices/CoreServices.h>
#include <memory>
#include "base/apple/osstatus_logging.h"
#include "base/functional/bind.h"
#include "base/logging.h"
#include "base/metrics/histogram_macros.h"
#include "base/metrics/sparse_histogram.h"
#include "base/time/time.h"
#include "base/trace_event/trace_event.h"
#if BUILDFLAG(IS_MAC)
#include "media/audio/mac/audio_manager_mac.h"
#else
#include "media/audio/ios/audio_manager_ios.h"
#endif
namespace media {
namespace {
// A one-shot timer is created and started in Start() and it triggers
// CheckInputStartupSuccess() after this amount of time. UMA stats marked
// Media.Audio.InputStartupSuccessMacHighLatency is then updated where true is
// added if input callbacks have started, and false otherwise. This constant
// should ideally be set to about the same value as in
// audio_low_latency_input_mac.cc, to make comparing them reasonable.
const int kInputCallbackStartTimeoutInSeconds = 8;
} // namespace
PCMQueueInAudioInputStream::PCMQueueInAudioInputStream(
AudioManagerApple* manager,
const AudioParameters& params)
: manager_(manager),
callback_(nullptr),
audio_queue_(NULL),
buffer_size_bytes_(0),
started_(false),
input_callback_is_active_(false),
audio_bus_(media::AudioBus::Create(params)) {
// We must have a manager.
DCHECK(manager_);
const SampleFormat kSampleFormat = kSampleFormatS16;
// A frame is one sample across all channels. In interleaved audio the per
// frame fields identify the set of n |channels|. In uncompressed audio, a
// packet is always one frame.
format_.mSampleRate = params.sample_rate();
format_.mFormatID = kAudioFormatLinearPCM;
format_.mFormatFlags =
kLinearPCMFormatFlagIsPacked | kLinearPCMFormatFlagIsSignedInteger;
format_.mBitsPerChannel = SampleFormatToBitsPerChannel(kSampleFormat);
format_.mChannelsPerFrame = params.channels();
format_.mFramesPerPacket = 1;
format_.mBytesPerPacket = format_.mBytesPerFrame =
params.GetBytesPerFrame(kSampleFormat);
format_.mReserved = 0;
buffer_size_bytes_ = params.GetBytesPerBuffer(kSampleFormat);
}
PCMQueueInAudioInputStream::~PCMQueueInAudioInputStream() {
DCHECK(!callback_);
DCHECK(!audio_queue_);
}
AudioInputStream::OpenOutcome PCMQueueInAudioInputStream::Open() {
OSStatus err = AudioQueueNewInput(&format_,
&HandleInputBufferStatic,
this,
NULL, // Use OS CFRunLoop for |callback|
kCFRunLoopCommonModes,
0, // Reserved
&audio_queue_);
if (err != noErr) {
HandleError(err);
return AudioInputStream::OpenOutcome::kFailed;
}
return SetupBuffers() ? AudioInputStream::OpenOutcome::kSuccess
: AudioInputStream::OpenOutcome::kFailed;
}
void PCMQueueInAudioInputStream::Start(AudioInputCallback* callback) {
DCHECK(callback);
DLOG_IF(ERROR, !audio_queue_) << "Open() has not been called successfully";
if (callback_ || !audio_queue_)
return;
#if BUILDFLAG(IS_MAC)
// Check if we should defer Start() for http://crbug.com/160920.
base::TimeDelta defer_start = manager_->GetDeferStreamStartTimeout();
if (!defer_start.is_zero()) {
// Use a cancellable closure so that if Stop() is called before Start()
// actually runs, we can cancel the pending start.
deferred_start_cb_.Reset(base::BindOnce(&PCMQueueInAudioInputStream::Start,
base::Unretained(this), callback));
manager_->GetTaskRunner()->PostDelayedTask(
FROM_HERE, deferred_start_cb_.callback(), defer_start);
return;
}
#endif
callback_ = callback;
OSStatus err = AudioQueueStart(audio_queue_, NULL);
if (err != noErr) {
HandleError(err);
} else {
started_ = true;
}
// For UMA stat purposes, start a one-shot timer which detects when input
// callbacks starts indicating if input audio recording starts as intended.
// CheckInputStartupSuccess() will check if |input_callback_is_active_| is
// true when the timer expires.
input_callback_timer_ = std::make_unique<base::OneShotTimer>();
input_callback_timer_->Start(
FROM_HERE, base::Seconds(kInputCallbackStartTimeoutInSeconds), this,
&PCMQueueInAudioInputStream::CheckInputStartupSuccess);
DCHECK(input_callback_timer_->IsRunning());
}
void PCMQueueInAudioInputStream::Stop() {
deferred_start_cb_.Cancel();
if (input_callback_timer_ != nullptr) {
input_callback_timer_->Stop();
input_callback_timer_.reset();
}
if (!audio_queue_ || !started_)
return;
// We request a synchronous stop, so the next call can take some time. In
// the windows implementation we block here as well.
OSStatus err = AudioQueueStop(audio_queue_, true);
if (err != noErr)
HandleError(err);
SetInputCallbackIsActive(false);
started_ = false;
callback_ = nullptr;
}
void PCMQueueInAudioInputStream::Close() {
Stop();
// It is valid to call Close() before calling Open() or Start(), thus
// |audio_queue_| and |callback_| might be NULL.
if (audio_queue_) {
OSStatus err = AudioQueueDispose(audio_queue_, true);
audio_queue_ = NULL;
if (err != noErr)
HandleError(err);
}
manager_->ReleaseInputStream(this);
// CARE: This object may now be destroyed.
}
double PCMQueueInAudioInputStream::GetMaxVolume() {
NOTIMPLEMENTED();
return 1.0;
}
void PCMQueueInAudioInputStream::SetVolume(double volume) {
#if BUILDFLAG(IS_MAC)
NOTIMPLEMENTED();
#else
manager_->SetInputVolume(kAudioObjectUnknown, volume);
#endif
}
double PCMQueueInAudioInputStream::GetVolume() {
#if BUILDFLAG(IS_MAC)
NOTIMPLEMENTED();
return 1.0;
#else
return manager_->GetInputVolume(kAudioObjectUnknown);
#endif
}
bool PCMQueueInAudioInputStream::IsMuted() {
#if BUILDFLAG(IS_MAC)
NOTIMPLEMENTED();
return false;
#else
return manager_->IsInputMuted(kAudioObjectUnknown);
#endif
}
bool PCMQueueInAudioInputStream::SetAutomaticGainControl(bool enabled) {
NOTIMPLEMENTED();
return false;
}
bool PCMQueueInAudioInputStream::GetAutomaticGainControl() {
NOTIMPLEMENTED();
return false;
}
void PCMQueueInAudioInputStream::SetOutputDeviceForAec(
const std::string& output_device_id) {
// Not supported. Do nothing.
}
void PCMQueueInAudioInputStream::HandleError(OSStatus err) {
if (callback_)
callback_->OnError();
// This point should never be reached.
OSSTATUS_DCHECK(0, err);
}
bool PCMQueueInAudioInputStream::SetupBuffers() {
DCHECK(buffer_size_bytes_);
for (int i = 0; i < kNumberBuffers; ++i) {
AudioQueueBufferRef buffer;
OSStatus err = AudioQueueAllocateBuffer(audio_queue_,
buffer_size_bytes_,
&buffer);
if (err == noErr)
err = QueueNextBuffer(buffer);
if (err != noErr) {
HandleError(err);
return false;
}
// |buffer| will automatically be freed when |audio_queue_| is released.
}
return true;
}
OSStatus PCMQueueInAudioInputStream::QueueNextBuffer(
AudioQueueBufferRef audio_buffer) {
// Only the first 2 params are needed for recording.
return AudioQueueEnqueueBuffer(audio_queue_, audio_buffer, 0, NULL);
}
// static
void PCMQueueInAudioInputStream::HandleInputBufferStatic(
void* data,
AudioQueueRef audio_queue,
AudioQueueBufferRef audio_buffer,
const AudioTimeStamp* start_time,
UInt32 num_packets,
const AudioStreamPacketDescription* desc) {
reinterpret_cast<PCMQueueInAudioInputStream*>(data)->
HandleInputBuffer(audio_queue, audio_buffer, start_time,
num_packets, desc);
}
void PCMQueueInAudioInputStream::HandleInputBuffer(
AudioQueueRef audio_queue,
AudioQueueBufferRef audio_buffer,
const AudioTimeStamp* start_time,
UInt32 num_packets,
const AudioStreamPacketDescription* packet_desc) {
DCHECK_EQ(audio_queue_, audio_queue);
DCHECK(audio_buffer->mAudioData);
TRACE_EVENT0("audio", "PCMQueueInAudioInputStream::HandleInputBuffer");
if (!callback_) {
// This can happen if Stop() was called without start.
DCHECK_EQ(0U, audio_buffer->mAudioDataByteSize);
return;
}
// Indicate that input callbacks have started.
SetInputCallbackIsActive(true);
if (audio_buffer->mAudioDataByteSize) {
// The AudioQueue API may use a large internal buffer and repeatedly call us
// back to back once that internal buffer is filled. When this happens the
// renderer client does not have enough time to read data back from the
// shared memory before the next write comes along. If HandleInputBuffer()
// is called too frequently, Sleep() at least 5ms to ensure the shared
// memory doesn't get trampled.
// TODO(dalecurtis): This is a HACK. Long term the AudioQueue path is going
// away in favor of the AudioUnit based AUAudioInputStream(). Tracked by
// http://crbug.com/161383.
// TODO(dalecurtis): Delete all this. It shouldn't be necessary now that we
// have a ring buffer and FIFO on the actual shared memory.
base::TimeDelta elapsed = base::TimeTicks::Now() - last_fill_;
const base::TimeDelta kMinDelay = base::Milliseconds(5);
if (elapsed < kMinDelay) {
TRACE_EVENT0("audio",
"PCMQueueInAudioInputStream::HandleInputBuffer sleep");
base::PlatformThread::Sleep(kMinDelay - elapsed);
}
// TODO(dalecurtis): This should be updated to include the device latency,
// but really since Pepper (which ignores the delay value) is on the only
// one creating AUDIO_PCM_LINEAR input devices, it doesn't matter.
// https://lists.apple.com/archives/coreaudio-api/2017/Jul/msg00035.html
const base::TimeTicks capture_time =
start_time->mFlags & kAudioTimeStampHostTimeValid
? base::TimeTicks::FromMachAbsoluteTime(start_time->mHostTime)
: base::TimeTicks::Now();
uint8_t* audio_data = reinterpret_cast<uint8_t*>(audio_buffer->mAudioData);
DCHECK_EQ(format_.mBitsPerChannel, 16u);
audio_bus_->FromInterleaved<SignedInt16SampleTypeTraits>(
reinterpret_cast<int16_t*>(audio_data), audio_bus_->frames());
callback_->OnData(audio_bus_.get(), capture_time, 0.0, {});
last_fill_ = base::TimeTicks::Now();
}
// Recycle the buffer.
OSStatus err = QueueNextBuffer(audio_buffer);
if (err != noErr) {
if (err == kAudioQueueErr_EnqueueDuringReset) {
// This is the error you get if you try to enqueue a buffer and the
// queue has been closed. Not really a problem if indeed the queue
// has been closed.
// TODO(joth): PCMQueueOutAudioOutputStream uses callback_ to provide an
// extra guard for this situation, but it seems to introduce more
// complications than it solves (memory barrier issues accessing it from
// multiple threads, looses the means to indicate OnClosed to client).
// Should determine if we need to do something equivalent here.
return;
}
HandleError(err);
}
}
void PCMQueueInAudioInputStream::SetInputCallbackIsActive(bool enabled) {
base::subtle::Release_Store(&input_callback_is_active_, enabled);
}
bool PCMQueueInAudioInputStream::GetInputCallbackIsActive() {
return (base::subtle::Acquire_Load(&input_callback_is_active_) != false);
}
void PCMQueueInAudioInputStream::CheckInputStartupSuccess() {
// Check if we have called Start() and input callbacks have actually
// started in time as they should. If that is not the case, we have a
// problem and the stream is considered dead.
const bool input_callback_is_active = GetInputCallbackIsActive();
UMA_HISTOGRAM_BOOLEAN("Media.Audio.InputStartupSuccessMac_HighLatency",
input_callback_is_active);
DVLOG(1) << "high_latency_input_callback_is_active: "
<< input_callback_is_active;
}
} // namespace media