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
content / browser / media / audio_output_stream_broker.cc [blame]
// Copyright 2018 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/browser/media/audio_output_stream_broker.h"
#include <utility>
#include "base/functional/bind.h"
#include "base/metrics/histogram_macros.h"
#include "base/trace_event/trace_event.h"
#include "content/browser/media/audio_stream_broker_helper.h"
#include "content/browser/media/media_internals.h"
#include "content/public/browser/content_browser_client.h"
#include "content/public/browser/media_observer.h"
#include "content/public/common/content_client.h"
#include "media/audio/audio_logging.h"
#include "media/mojo/mojom/audio_data_pipe.mojom.h"
namespace content {
namespace {
enum class StreamBrokerDisconnectReason {
kDefault = 0,
kPlatformError,
kTerminatedByClient,
kTerminatedByClientAwaitingCreated,
kStreamCreationFailed,
kDocumentDestroyed,
kDocumentDestroyedAwaitingCreated,
kMaxValue = kDocumentDestroyedAwaitingCreated
};
using DisconnectReason =
media::mojom::AudioOutputStreamObserver::DisconnectReason;
StreamBrokerDisconnectReason GetDisconnectReason(DisconnectReason reason,
bool awaiting_created) {
switch (reason) {
case DisconnectReason::kPlatformError:
return StreamBrokerDisconnectReason::kPlatformError;
case DisconnectReason::kTerminatedByClient:
return awaiting_created
? StreamBrokerDisconnectReason::
kTerminatedByClientAwaitingCreated
: StreamBrokerDisconnectReason::kTerminatedByClient;
case DisconnectReason::kStreamCreationFailed:
return StreamBrokerDisconnectReason::kStreamCreationFailed;
case DisconnectReason::kDocumentDestroyed:
return awaiting_created
? StreamBrokerDisconnectReason::
kDocumentDestroyedAwaitingCreated
: StreamBrokerDisconnectReason::kDocumentDestroyed;
case DisconnectReason::kDefault:
return StreamBrokerDisconnectReason::kDefault;
}
}
} // namespace
AudioOutputStreamBroker::AudioOutputStreamBroker(
int render_process_id,
int render_frame_id,
int stream_id,
const std::string& output_device_id,
const media::AudioParameters& params,
const base::UnguessableToken& group_id,
DeleterCallback deleter,
mojo::PendingRemote<media::mojom::AudioOutputStreamProviderClient> client)
: AudioStreamBroker(render_process_id, render_frame_id),
output_device_id_(output_device_id),
params_(params),
group_id_(group_id),
deleter_(std::move(deleter)),
client_(std::move(client)),
observer_(render_process_id, render_frame_id, stream_id),
observer_receiver_(&observer_) {
DCHECK(client_);
DCHECK(deleter_);
DCHECK(group_id_);
TRACE_EVENT_NESTABLE_ASYNC_BEGIN0("audio", "AudioOutputStreamBroker", this);
MediaObserver* media_observer =
GetContentClient()->browser()->GetMediaObserver();
// May be null in unit tests.
if (media_observer)
media_observer->OnCreatingAudioStream(render_process_id, render_frame_id);
// Unretained is safe because |this| owns |client_|
client_.set_disconnect_handler(
base::BindOnce(&AudioOutputStreamBroker::Cleanup, base::Unretained(this),
DisconnectReason::kTerminatedByClient));
NotifyFrameHostOfAudioStreamStarted(render_process_id, render_frame_id,
/*is_capturing=*/false);
}
AudioOutputStreamBroker::~AudioOutputStreamBroker() {
DCHECK_CALLED_ON_VALID_SEQUENCE(owning_sequence_);
NotifyFrameHostOfAudioStreamStopped(render_process_id(), render_frame_id(),
/*is_capturing=*/false);
const StreamBrokerDisconnectReason reason =
GetDisconnectReason(disconnect_reason_, AwaitingCreated());
if (AwaitingCreated()) {
TRACE_EVENT_NESTABLE_ASYNC_END1("audio", "CreateStream", this, "success",
"failed or cancelled");
}
TRACE_EVENT_NESTABLE_ASYNC_END1("audio", "AudioOutputStreamBroker", this,
"disconnect reason",
static_cast<uint32_t>(reason));
}
void AudioOutputStreamBroker::CreateStream(
media::mojom::AudioStreamFactory* factory) {
DCHECK_CALLED_ON_VALID_SEQUENCE(owning_sequence_);
DCHECK(!observer_receiver_.is_bound());
TRACE_EVENT_NESTABLE_ASYNC_BEGIN1("audio", "CreateStream", this, "device id",
output_device_id_);
stream_creation_start_time_ = base::TimeTicks::Now();
// Set up observer ptr. Unretained is safe because |this| owns
// |observer_receiver_|.
mojo::PendingAssociatedRemote<media::mojom::AudioOutputStreamObserver>
observer;
observer_receiver_.Bind(observer.InitWithNewEndpointAndPassReceiver());
observer_receiver_.set_disconnect_with_reason_handler(base::BindOnce(
&AudioOutputStreamBroker::ObserverBindingLost, base::Unretained(this)));
mojo::PendingRemote<media::mojom::AudioOutputStream> stream;
auto stream_receiver = stream.InitWithNewPipeAndPassReceiver();
// Note that the component id for AudioLog is used to differentiate between
// several users of the same audio log. Since this audio log is for a single
// stream, the component id used doesn't matter.
constexpr int log_component_id = 0;
factory->CreateOutputStream(
std::move(stream_receiver), std::move(observer),
MediaInternals::GetInstance()->CreateMojoAudioLog(
media::AudioLogFactory::AudioComponent::kAudioOuputController,
log_component_id, render_process_id(), render_frame_id()),
output_device_id_, params_, group_id_,
base::BindOnce(&AudioOutputStreamBroker::StreamCreated,
weak_ptr_factory_.GetWeakPtr(), std::move(stream)));
}
void AudioOutputStreamBroker::StreamCreated(
mojo::PendingRemote<media::mojom::AudioOutputStream> stream,
media::mojom::ReadWriteAudioDataPipePtr data_pipe) {
DCHECK_CALLED_ON_VALID_SEQUENCE(owning_sequence_);
TRACE_EVENT_NESTABLE_ASYNC_END1("audio", "CreateStream", this, "success",
!!data_pipe);
stream_creation_start_time_ = base::TimeTicks();
if (!data_pipe) {
// Stream creation failed. Signal error.
client_.ResetWithReason(
static_cast<uint32_t>(DisconnectReason::kPlatformError), std::string());
Cleanup(DisconnectReason::kStreamCreationFailed);
return;
}
client_->Created(std::move(stream), std::move(data_pipe));
}
void AudioOutputStreamBroker::ObserverBindingLost(
uint32_t reason,
const std::string& description) {
DCHECK_CALLED_ON_VALID_SEQUENCE(owning_sequence_);
TRACE_EVENT_NESTABLE_ASYNC_INSTANT1("audio", "ObserverBindingLost", this,
"reset reason", reason);
if (reason > static_cast<uint32_t>(DisconnectReason::kMaxValue))
NOTREACHED_IN_MIGRATION() << "Invalid reason: " << reason;
DisconnectReason reason_enum = static_cast<DisconnectReason>(reason);
// TODO(crbug.com/40551225): Don't propagate errors if we can retry
// instead.
client_.ResetWithReason(
static_cast<uint32_t>(DisconnectReason::kPlatformError), std::string());
Cleanup((reason_enum == DisconnectReason::kPlatformError && AwaitingCreated())
? DisconnectReason::kStreamCreationFailed
: reason_enum);
}
void AudioOutputStreamBroker::Cleanup(DisconnectReason reason) {
DCHECK_CALLED_ON_VALID_SEQUENCE(owning_sequence_);
DCHECK_EQ(DisconnectReason::kDocumentDestroyed, disconnect_reason_);
disconnect_reason_ = reason;
std::move(deleter_).Run(this);
}
bool AudioOutputStreamBroker::AwaitingCreated() const {
return stream_creation_start_time_ != base::TimeTicks();
}
} // namespace content