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
|
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "third_party/blink/renderer/modules/webaudio/setsinkid_resolver.h"
#include "base/trace_event/trace_event.h"
#include "third_party/blink/renderer/bindings/core/v8/v8_throw_dom_exception.h"
#include "third_party/blink/renderer/bindings/modules/v8/v8_union_audiosinkinfo_string.h"
#include "third_party/blink/renderer/core/frame/local_dom_window.h"
#include "third_party/blink/renderer/modules/webaudio/audio_context.h"
#include "third_party/blink/renderer/modules/webaudio/realtime_audio_destination_node.h"
#include "third_party/blink/renderer/platform/audio/audio_utilities.h"
namespace blink {
SetSinkIdResolver::SetSinkIdResolver(
ScriptState* script_state,
AudioContext& audio_context,
const V8UnionAudioSinkOptionsOrString& sink_id)
: audio_context_(audio_context),
resolver_(MakeGarbageCollected<ScriptPromiseResolver<IDLUndefined>>(
script_state)) {
DCHECK(IsMainThread());
// Currently the only available AudioSinkOptions is a type of a silent sink,
// which can be specified by an empty descriptor constructor.
auto& frame_token = To<LocalDOMWindow>(audio_context_->GetExecutionContext())
->GetLocalFrameToken();
if (sink_id.GetContentType() ==
V8UnionAudioSinkOptionsOrString::ContentType::kAudioSinkOptions) {
sink_descriptor_ = WebAudioSinkDescriptor(frame_token);
} else {
sink_descriptor_ =
WebAudioSinkDescriptor(sink_id.GetAsString(), frame_token);
}
TRACE_EVENT1("webaudio", "SetSinkIdResolver::SetSinkIdResolver",
"sink_id (after setting sink_descriptor_)",
audio_utilities::GetSinkIdForTracing(sink_descriptor_));
}
void SetSinkIdResolver::Trace(Visitor* visitor) const {
visitor->Trace(audio_context_);
visitor->Trace(resolver_);
}
void SetSinkIdResolver::Start() {
TRACE_EVENT1("webaudio", "SetSinkIdResolver::Start", "sink_id",
audio_utilities::GetSinkIdForTracing(sink_descriptor_));
DCHECK(IsMainThread());
if (!resolver_ || !resolver_->GetExecutionContext() || !audio_context_ ||
audio_context_->IsContextCleared()) {
// No point in rejecting promise, as it will bail out upon detached
// context anyway.
return;
}
// Refer to
// https://webaudio.github.io/web-audio-api/#validating-sink-identifier for
// sink_id/sink_descriptor validation steps.
if (sink_descriptor_ == audio_context_->GetSinkDescriptor()) {
OnSetSinkIdComplete(media::OutputDeviceStatus::OUTPUT_DEVICE_STATUS_OK);
} else if (!audio_context_->IsValidSinkDescriptor(sink_descriptor_)) {
OnSetSinkIdComplete(
media::OutputDeviceStatus::OUTPUT_DEVICE_STATUS_ERROR_NOT_FOUND);
} else {
auto* audio_destination = audio_context_->destination();
// A sanity check to make sure we have valid audio_destination node from
// `audio_context_`.
if (!audio_destination) {
OnSetSinkIdComplete(
media::OutputDeviceStatus::OUTPUT_DEVICE_STATUS_ERROR_INTERNAL);
} else {
audio_context_->NotifySetSinkIdBegins();
auto set_sink_id_completion_callback = WTF::BindOnce(
&SetSinkIdResolver::OnSetSinkIdComplete, WrapPersistent(this));
auto set_sink_descriptor_callback = WTF::BindOnce(
&RealtimeAudioDestinationNode::SetSinkDescriptor,
WrapWeakPersistent(
static_cast<RealtimeAudioDestinationNode*>(audio_destination)),
sink_descriptor_, std::move(set_sink_id_completion_callback));
audio_context_->GetExecutionContext()
->GetTaskRunner(TaskType::kInternalMediaRealTime)
->PostTask(FROM_HERE, std::move(set_sink_descriptor_callback));
}
}
}
void SetSinkIdResolver::Resolve() {
DCHECK(IsMainThread());
DCHECK(resolver_);
resolver_->Resolve();
resolver_ = nullptr;
}
void SetSinkIdResolver::Reject(DOMException* exception) {
DCHECK(IsMainThread());
DCHECK(resolver_);
resolver_->Reject(exception);
resolver_ = nullptr;
}
void SetSinkIdResolver::Reject(v8::Local<v8::Value> value) {
DCHECK(IsMainThread());
DCHECK(resolver_);
resolver_->Reject(value);
resolver_ = nullptr;
}
ScriptPromise<IDLUndefined> SetSinkIdResolver::GetPromise() {
DCHECK(IsMainThread());
DCHECK(resolver_);
return resolver_->Promise();
}
void SetSinkIdResolver::HandleOutputDeviceStatus(
media::OutputDeviceStatus status) {
ScriptState* script_state = resolver_->GetScriptState();
ScriptState::Scope scope(script_state);
switch (status) {
case media::OutputDeviceStatus::OUTPUT_DEVICE_STATUS_OK:
if (audio_context_ && !audio_context_->IsContextCleared()) {
// Update AudioContext's sink ID and fire the 'onsinkchange' event
audio_context_->NotifySetSinkIdIsDone(sink_descriptor_);
}
Resolve();
return;
case media::OutputDeviceStatus::OUTPUT_DEVICE_STATUS_ERROR_NOT_FOUND:
Reject(V8ThrowDOMException::CreateOrEmpty(
script_state->GetIsolate(), DOMExceptionCode::kNotFoundError,
"AudioContext.setSinkId(): failed: the device " +
String(sink_descriptor_.SinkId()) + " is not found."));
return;
case media::OutputDeviceStatus::OUTPUT_DEVICE_STATUS_ERROR_NOT_AUTHORIZED:
Reject(V8ThrowDOMException::CreateOrEmpty(
script_state->GetIsolate(), DOMExceptionCode::kNotAllowedError,
"AudioContext.setSinkId() failed: access to the device " +
String(sink_descriptor_.SinkId()) + " is not permitted."));
return;
case media::OutputDeviceStatus::OUTPUT_DEVICE_STATUS_ERROR_TIMED_OUT:
Reject(V8ThrowDOMException::CreateOrEmpty(
script_state->GetIsolate(), DOMExceptionCode::kTimeoutError,
"AudioContext.setSinkId() failed: the request for device " +
String(sink_descriptor_.SinkId()) + " is timed out."));
return;
case media::OutputDeviceStatus::OUTPUT_DEVICE_STATUS_ERROR_INTERNAL:
Reject(V8ThrowDOMException::CreateOrEmpty(
script_state->GetIsolate(), DOMExceptionCode::kInvalidStateError,
"AudioContext.setSinkId() failed: the device " +
String(sink_descriptor_.SinkId()) + " is not available."));
return;
}
NOTREACHED();
}
void SetSinkIdResolver::OnSetSinkIdComplete(media::OutputDeviceStatus status) {
TRACE_EVENT1("webaudio", "SetSinkIdResolver::OnSetSinkIdComplete", "sink_id",
audio_utilities::GetSinkIdForTracing(sink_descriptor_));
DCHECK(IsMainThread());
if (!resolver_) {
return;
}
auto* excecution_context = resolver_->GetExecutionContext();
if (!excecution_context || excecution_context->IsContextDestroyed()) {
return;
}
HandleOutputDeviceStatus(status);
auto& resolvers = audio_context_->GetSetSinkIdResolver();
resolvers.pop_front();
if (!resolvers.empty() && (audio_context_->PendingDeviceListUpdates() == 0)) {
// Prevent potential stack overflow under heavy load by scheduling the next
// resolver start asynchronously instead of invoking it directly.
auto next_start_task = WTF::BindOnce(
&SetSinkIdResolver::Start, WrapWeakPersistent(resolvers.front().Get()));
audio_context_->GetExecutionContext()
->GetTaskRunner(TaskType::kInternalMediaRealTime)
->PostTask(FROM_HERE, std::move(next_start_task));
}
}
} // namespace blink
|