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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
content / renderer / media / renderer_webaudiodevice_impl.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 "content/renderer/media/renderer_webaudiodevice_impl.h"
#include <stddef.h>
#include <memory>
#include <string>
#include "base/check_op.h"
#include "base/command_line.h"
#include "base/feature_list.h"
#include "base/functional/bind.h"
#include "base/notreached.h"
#include "base/strings/stringprintf.h"
#include "base/task/bind_post_task.h"
#include "base/task/sequenced_task_runner.h"
#include "base/task/single_thread_task_runner.h"
#include "base/task/task_traits.h"
#include "base/task/thread_pool.h"
#include "base/time/time.h"
#include "base/trace_event/trace_event.h"
#include "content/public/renderer/render_frame.h"
#include "media/audio/null_audio_sink.h"
#include "media/base/audio_glitch_info.h"
#include "media/base/audio_timestamp_helper.h"
#include "media/base/limits.h"
#include "media/base/media_switches.h"
#include "media/base/output_device_info.h"
#include "media/base/silent_sink_suspender.h"
#include "media/base/speech_recognition_client.h"
#include "third_party/blink/public/common/features.h"
#include "third_party/blink/public/platform/audio/web_audio_device_source_type.h"
#include "third_party/blink/public/platform/modules/webrtc/webrtc_logging.h"
#include "third_party/blink/public/platform/task_type.h"
#include "third_party/blink/public/web/modules/media/audio/audio_device_factory.h"
#include "third_party/blink/public/web/web_local_frame.h"
#include "third_party/blink/public/web/web_local_frame_client.h"
#include "third_party/blink/public/web/web_view.h"
using blink::AudioDeviceFactory;
using blink::WebAudioDevice;
using blink::WebAudioLatencyHint;
using blink::WebAudioSinkDescriptor;
using blink::WebLocalFrame;
using blink::WebView;
namespace content {
namespace {
blink::WebAudioDeviceSourceType GetLatencyHintSourceType(
WebAudioLatencyHint::AudioContextLatencyCategory latency_category) {
switch (latency_category) {
case WebAudioLatencyHint::kCategoryInteractive:
return blink::WebAudioDeviceSourceType::kWebAudioInteractive;
case WebAudioLatencyHint::kCategoryBalanced:
return blink::WebAudioDeviceSourceType::kWebAudioBalanced;
case WebAudioLatencyHint::kCategoryPlayback:
return blink::WebAudioDeviceSourceType::kWebAudioPlayback;
case WebAudioLatencyHint::kCategoryExact:
return blink::WebAudioDeviceSourceType::kWebAudioExact;
case WebAudioLatencyHint::kLastValue:
NOTREACHED();
}
NOTREACHED();
}
int GetOutputBufferSize(const blink::WebAudioLatencyHint& latency_hint,
media::AudioLatency::Type latency,
const media::AudioParameters& hardware_params) {
media::AudioParameters::HardwareCapabilities hardware_capabilities =
hardware_params.hardware_capabilities().value_or(
media::AudioParameters::HardwareCapabilities());
// Adjust output buffer size according to the latency requirement.
switch (latency) {
case media::AudioLatency::Type::kInteractive:
return media::AudioLatency::GetInteractiveBufferSize(
hardware_params.frames_per_buffer());
case media::AudioLatency::Type::kRtc:
return media::AudioLatency::GetRtcBufferSize(
hardware_params.sample_rate(), hardware_params.frames_per_buffer());
case media::AudioLatency::Type::kPlayback:
return media::AudioLatency::GetHighLatencyBufferSize(
hardware_params.sample_rate(), hardware_params.frames_per_buffer());
case media::AudioLatency::Type::kExactMS:
return media::AudioLatency::GetExactBufferSize(
base::Seconds(latency_hint.Seconds()), hardware_params.sample_rate(),
hardware_params.frames_per_buffer(),
hardware_capabilities.min_frames_per_buffer,
hardware_capabilities.max_frames_per_buffer,
media::limits::kMaxWebAudioBufferSize);
default:
NOTREACHED_IN_MIGRATION();
}
return 0;
}
media::AudioParameters GetOutputDeviceParameters(
const blink::LocalFrameToken& frame_token,
const std::string& device_id) {
TRACE_EVENT0("webaudio", "GetOutputDeviceParameters");
return AudioDeviceFactory::GetInstance()
->GetOutputDeviceInfo(frame_token, device_id)
.output_params();
}
scoped_refptr<media::AudioRendererSink> GetNullAudioSink(
const scoped_refptr<base::SequencedTaskRunner>& task_runner) {
return base::MakeRefCounted<media::NullAudioSink>(task_runner);
}
} // namespace
std::unique_ptr<RendererWebAudioDeviceImpl> RendererWebAudioDeviceImpl::Create(
const WebAudioSinkDescriptor& sink_descriptor,
int number_of_output_channels,
const blink::WebAudioLatencyHint& latency_hint,
media::AudioRendererSink::RenderCallback* callback) {
// The `number_of_output_channels` does not manifest the actual channel
// layout of the audio output device. We use the best guess to the channel
// layout based on the number of channels.
media::ChannelLayout layout =
media::GuessChannelLayout(number_of_output_channels);
// Use "discrete" channel layout when the best guess was not successful.
if (layout == media::CHANNEL_LAYOUT_UNSUPPORTED) {
layout = media::CHANNEL_LAYOUT_DISCRETE;
}
return std::unique_ptr<RendererWebAudioDeviceImpl>(
new RendererWebAudioDeviceImpl(
sink_descriptor, {layout, number_of_output_channels}, latency_hint,
callback, base::BindOnce(&GetOutputDeviceParameters),
base::BindRepeating(&GetNullAudioSink)));
}
RendererWebAudioDeviceImpl::RendererWebAudioDeviceImpl(
const WebAudioSinkDescriptor& sink_descriptor,
media::ChannelLayoutConfig layout_config,
const blink::WebAudioLatencyHint& latency_hint,
media::AudioRendererSink::RenderCallback* callback,
OutputDeviceParamsCallback device_params_cb,
CreateSilentSinkCallback create_silent_sink_cb)
: sink_descriptor_(sink_descriptor),
latency_hint_(latency_hint),
webaudio_callback_(callback),
frame_token_(sink_descriptor.Token()),
main_thread_task_runner_(
base::SingleThreadTaskRunner::GetCurrentDefault()),
create_silent_sink_cb_(std::move(create_silent_sink_cb)) {
TRACE_EVENT0("webaudio",
"RendererWebAudioDeviceImpl::RendererWebAudioDeviceImpl");
DCHECK(webaudio_callback_);
SendLogMessage(base::StringPrintf("%s", __func__));
std::string device_id;
switch (sink_descriptor_.Type()) {
case blink::WebAudioSinkDescriptor::kAudible:
device_id = sink_descriptor_.SinkId().Utf8();
break;
case blink::WebAudioSinkDescriptor::kSilent:
// Use the default audio device's parameters for a silent sink.
device_id = std::string();
break;
}
original_sink_params_ =
std::move(device_params_cb).Run(frame_token_, device_id);
// On systems without audio hardware the returned parameters may be invalid.
// In which case just choose whatever we want for the fake device.
if (!original_sink_params_.IsValid()) {
SendLogMessage(base::StringPrintf(
"%s => (original_sink_params_ is invalid =[original_sink_params_=%s])",
__func__, original_sink_params_.AsHumanReadableString().c_str()));
original_sink_params_.Reset(media::AudioParameters::AUDIO_FAKE,
media::ChannelLayoutConfig::Stereo(), 48000,
480);
// Inform the Blink client (e.g. AudioContext) that we have invalid device
// parameters.
if (base::FeatureList::IsEnabled(blink::features::kAudioContextOnError)) {
// Post a task on the same thread, and the posted task will be executed
// once the construction sequence is finished.
main_thread_task_runner_->PostTask(
FROM_HERE,
base::BindOnce(&RendererWebAudioDeviceImpl::NotifyRenderError,
weak_ptr_factory_.GetWeakPtr()));
}
}
SendLogMessage(base::StringPrintf(
"%s => (hardware_params=[%s])", __func__,
original_sink_params_.AsHumanReadableString().c_str()));
const media::AudioLatency::Type latency =
AudioDeviceFactory::GetSourceLatencyType(
GetLatencyHintSourceType(latency_hint_.Category()));
const int output_buffer_size =
GetOutputBufferSize(latency_hint_, latency, original_sink_params_);
DCHECK_NE(0, output_buffer_size);
current_sink_params_.Reset(original_sink_params_.format(), layout_config,
original_sink_params_.sample_rate(),
output_buffer_size);
// Specify the latency info to be passed to the browser side.
current_sink_params_.set_latency_tag(latency);
SendLogMessage(
base::StringPrintf("%s => (sink_params=[%s])", __func__,
current_sink_params_.AsHumanReadableString().c_str()));
if (base::FeatureList::IsEnabled(media::kLiveCaptionWebAudio)) {
auto* web_local_frame = WebLocalFrame::FromFrameToken(frame_token_);
if (web_local_frame) {
speech_recognition_client_ =
web_local_frame->Client()->CreateSpeechRecognitionClient();
if (speech_recognition_client_) {
speech_recognition_client_->Reconfigure(current_sink_params_);
}
}
}
}
RendererWebAudioDeviceImpl::~RendererWebAudioDeviceImpl() {
// In case device is not stopped, we can stop it here.
Stop();
}
void RendererWebAudioDeviceImpl::Start() {
DCHECK(thread_checker_.CalledOnValidThread());
SendLogMessage(base::StringPrintf("%s", __func__));
// Already started.
if (!is_stopped_) {
return;
}
if (!sink_) {
CreateAudioRendererSink();
}
sink_->Start();
sink_->Play();
is_stopped_ = false;
}
void RendererWebAudioDeviceImpl::Pause() {
DCHECK(thread_checker_.CalledOnValidThread());
SendLogMessage(base::StringPrintf("%s", __func__));
if (sink_)
sink_->Pause();
if (silent_sink_suspender_)
silent_sink_suspender_->OnPaused();
}
void RendererWebAudioDeviceImpl::Resume() {
DCHECK(thread_checker_.CalledOnValidThread());
SendLogMessage(base::StringPrintf("%s", __func__));
if (sink_)
sink_->Play();
}
void RendererWebAudioDeviceImpl::Stop() {
DCHECK(thread_checker_.CalledOnValidThread());
SendLogMessage(base::StringPrintf("%s", __func__));
if (sink_) {
sink_->Stop();
sink_ = nullptr;
}
silent_sink_suspender_.reset();
is_stopped_ = true;
}
double RendererWebAudioDeviceImpl::SampleRate() {
return current_sink_params_.sample_rate();
}
int RendererWebAudioDeviceImpl::FramesPerBuffer() {
return current_sink_params_.frames_per_buffer();
}
int RendererWebAudioDeviceImpl::MaxChannelCount() {
return original_sink_params_.channels();
}
void RendererWebAudioDeviceImpl::SetDetectSilence(
bool enable_silence_detection) {
SendLogMessage(
base::StringPrintf("%s({enable_silence_detection=%s})", __func__,
enable_silence_detection ? "true" : "false"));
DCHECK(thread_checker_.CalledOnValidThread());
if (silent_sink_suspender_)
silent_sink_suspender_->SetDetectSilence(enable_silence_detection);
}
int RendererWebAudioDeviceImpl::Render(
base::TimeDelta delay,
base::TimeTicks delay_timestamp,
const media::AudioGlitchInfo& glitch_info,
media::AudioBus* dest) {
if (!is_rendering_) {
SendLogMessage(base::StringPrintf("%s => (rendering is alive [frames=%d])",
__func__, dest->frames()));
is_rendering_ = true;
}
int frames_filled =
webaudio_callback_->Render(delay, delay_timestamp, glitch_info, dest);
if (speech_recognition_client_) {
speech_recognition_client_->AddAudio(*dest);
}
return frames_filled;
}
void RendererWebAudioDeviceImpl::OnRenderError() {
if (!base::FeatureList::IsEnabled(blink::features::kAudioContextOnError)) {
return;
}
// This function gets called from the audio infra, non-main thread, so this
// posts a cross-thread task to the main thread task runner.
main_thread_task_runner_->PostTask(
FROM_HERE,
base::BindOnce(&RendererWebAudioDeviceImpl::NotifyRenderError,
weak_ptr_factory_.GetWeakPtr()));
}
void RendererWebAudioDeviceImpl::NotifyRenderError() {
if (!base::FeatureList::IsEnabled(blink::features::kAudioContextOnError)) {
return;
}
DCHECK(thread_checker_.CalledOnValidThread());
SendLogMessage(base::StringPrintf("%s", __func__));
webaudio_callback_->OnRenderError();
}
void RendererWebAudioDeviceImpl::SetSilentSinkTaskRunnerForTesting(
scoped_refptr<base::SingleThreadTaskRunner> task_runner) {
silent_sink_task_runner_ = std::move(task_runner);
}
scoped_refptr<base::SingleThreadTaskRunner>
RendererWebAudioDeviceImpl::GetSilentSinkTaskRunner() {
if (!silent_sink_task_runner_) {
silent_sink_task_runner_ = base::ThreadPool::CreateSingleThreadTaskRunner(
{base::TaskPriority::USER_VISIBLE,
base::TaskShutdownBehavior::SKIP_ON_SHUTDOWN});
}
return silent_sink_task_runner_;
}
void RendererWebAudioDeviceImpl::SendLogMessage(const std::string& message) {
blink::WebRtcLogMessage(base::StringPrintf("[WA]RWADI::%s", message.c_str()));
}
void RendererWebAudioDeviceImpl::CreateAudioRendererSink() {
TRACE_EVENT0("webaudio",
"RendererWebAudioDeviceImpl::CreateAudioRendererSink");
DCHECK(thread_checker_.CalledOnValidThread());
CHECK(!sink_);
switch (sink_descriptor_.Type()) {
case blink::WebAudioSinkDescriptor::kAudible:
sink_ = AudioDeviceFactory::GetInstance()->NewAudioRendererSink(
GetLatencyHintSourceType(latency_hint_.Category()), frame_token_,
media::AudioSinkParameters(base::UnguessableToken(),
sink_descriptor_.SinkId().Utf8()));
// Use a task runner instead of the render thread for fake Render() calls
// since it has special connotations for Blink and garbage collection.
// Timeout value chosen to be highly unlikely in the normal case.
silent_sink_suspender_ = std::make_unique<media::SilentSinkSuspender>(
this, base::Seconds(30), current_sink_params_, sink_,
GetSilentSinkTaskRunner());
sink_->Initialize(current_sink_params_, silent_sink_suspender_.get());
break;
case blink::WebAudioSinkDescriptor::kSilent:
sink_ = create_silent_sink_cb_.Run(GetSilentSinkTaskRunner());
sink_->Initialize(current_sink_params_, this);
break;
}
}
media::OutputDeviceStatus
RendererWebAudioDeviceImpl::MaybeCreateSinkAndGetStatus() {
DCHECK(thread_checker_.CalledOnValidThread());
if (!sink_) {
CreateAudioRendererSink();
}
// The device status of a silent sink is always OK.
bool is_silent_sink =
sink_descriptor_.Type() == blink::WebAudioSinkDescriptor::kSilent;
media::OutputDeviceStatus status =
is_silent_sink ? media::OutputDeviceStatus::OUTPUT_DEVICE_STATUS_OK
: sink_->GetOutputDeviceInfo().device_status();
// If sink status is not OK, reset `sink_` and `silent_sink_suspender_`
// because this instance will be destroyed.
if (status != media::OutputDeviceStatus::OUTPUT_DEVICE_STATUS_OK) {
Stop();
}
return status;
}
} // namespace content