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
|
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "content/renderer/media/batching_media_log.h"
#include <sstream>
#include "base/bind.h"
#include "base/json/json_writer.h"
#include "base/location.h"
#include "base/logging.h"
#include "base/single_thread_task_runner.h"
#include "base/threading/thread_task_runner_handle.h"
#include "base/time/default_tick_clock.h"
#include "content/public/common/content_client.h"
#include "content/public/renderer/content_renderer_client.h"
#include "content/public/renderer/render_thread.h"
#include "media/base/logging_override_if_enabled.h"
namespace {
// Keep the JSON conversion in one function to prevent LOG and DVLOG calls
// from unnecessarily converting it.
std::string ToJSON(const media::MediaLogRecord* event) {
std::string params_json;
base::JSONWriter::Write(event->params, ¶ms_json);
return params_json;
}
// Print an event to the chromium log.
// TODO(tmathmeyer) replace this with a log-only EventHandler.
void Log(media::MediaLogRecord* event) {
if (event->type == media::MediaLogRecord::Type::kMediaStatus) {
LOG(ERROR) << "MediaEvent: " << ToJSON(event);
} else if (event->type == media::MediaLogRecord::Type::kMessage &&
event->params.HasKey("error")) {
LOG(ERROR) << "MediaEvent: " << ToJSON(event);
} else if (event->type != media::MediaLogRecord::Type::kMediaPropertyChange) {
DVLOG(1) << "MediaEvent: " << ToJSON(event);
}
}
// This string comes from the TypeName template specialization
// in media_log_type_enforcement.h, it's not encoded anywhere, so it's
// just typed out here.
constexpr char duration_changed_message[] = "kDurationChanged";
} // namespace
namespace content {
BatchingMediaLog::BatchingMediaLog(
const GURL& security_origin,
scoped_refptr<base::SingleThreadTaskRunner> task_runner,
std::vector<std::unique_ptr<EventHandler>> event_handlers)
: security_origin_(security_origin),
task_runner_(std::move(task_runner)),
tick_clock_(base::DefaultTickClock::GetInstance()),
last_ipc_send_time_(tick_clock_->NowTicks()),
event_handlers_(std::move(event_handlers)),
ipc_send_pending_(false) {
DCHECK(RenderThread::Get())
<< "BatchingMediaLog must be constructed on the render thread";
// Pre-bind the WeakPtr on the right thread since we'll receive calls from
// other threads and don't want races.
weak_this_ = weak_factory_.GetWeakPtr();
}
BatchingMediaLog::~BatchingMediaLog() {
DCHECK(task_runner_->BelongsToCurrentThread());
// AddEvent() could be in-flight on some other thread. Wait for it, and make
// sure that nobody else calls it.
InvalidateLog();
// There's no further chance to handle this, so send them now. This should not
// be racy since nothing should have a pointer to the media log on another
// thread by this point.
if (ipc_send_pending_)
SendQueuedMediaEvents();
}
void BatchingMediaLog::OnWebMediaPlayerDestroyedLocked() {
base::AutoLock lock(lock_);
for (const auto& handler : event_handlers_)
handler->OnWebMediaPlayerDestroyed();
}
void BatchingMediaLog::AddLogRecordLocked(
std::unique_ptr<media::MediaLogRecord> event) {
Log(event.get());
// For enforcing delay until it's been a second since the last ipc message was
// sent.
base::TimeDelta delay_for_next_ipc_send;
{
base::AutoLock auto_lock(lock_);
switch (event->type) {
// Hold onto the most recent PIPELINE_ERROR and the first, if any,
// MEDIA_LOG_ERROR_ENTRY for use in GetErrorMessage().
case media::MediaLogRecord::Type::kMediaStatus:
queued_media_events_.push_back(*event);
last_pipeline_error_.swap(event);
break;
case media::MediaLogRecord::Type::kMediaEventTriggered:
DCHECK(event->params.HasKey(MediaLog::kEventKey));
if (*event->params.FindStringKey(MediaLog::kEventKey) ==
duration_changed_message) {
// Similar to the extents changed message, this may fire many times
// for badly muxed media. Suppress within our rate limits here.
last_duration_changed_event_.swap(event);
} else {
queued_media_events_.push_back(*std::move(event));
}
break;
case media::MediaLogRecord::Type::kMessage:
queued_media_events_.push_back(*event);
if (event->params.HasKey(media::MediaLogMessageLevelToString(
media::MediaLogMessageLevel::kERROR)) &&
!cached_media_error_for_message_) {
cached_media_error_for_message_ = std::move(event);
}
break;
// Just enqueue all other event types for throttled transmission.
default:
queued_media_events_.push_back(*event);
}
if (ipc_send_pending_)
return;
ipc_send_pending_ = true;
delay_for_next_ipc_send = base::TimeDelta::FromSeconds(1) -
(tick_clock_->NowTicks() - last_ipc_send_time_);
}
if (delay_for_next_ipc_send > base::TimeDelta()) {
task_runner_->PostDelayedTask(
FROM_HERE,
base::BindOnce(&BatchingMediaLog::SendQueuedMediaEvents, weak_this_),
delay_for_next_ipc_send);
return;
}
// It's been more than a second so send ASAP.
if (task_runner_->BelongsToCurrentThread()) {
SendQueuedMediaEvents();
return;
}
task_runner_->PostTask(
FROM_HERE,
base::BindOnce(&BatchingMediaLog::SendQueuedMediaEvents, weak_this_));
}
std::string BatchingMediaLog::GetErrorMessageLocked() {
// Keep message structure in sync with
// HTMLMediaElement::BuildElementErrorMessage().
std::stringstream result;
if (last_pipeline_error_)
result << MediaEventToMessageString(*last_pipeline_error_);
if (cached_media_error_for_message_) {
DCHECK(last_pipeline_error_)
<< "Message with detail should be associated with a pipeline error";
// This ':' lets web apps extract the UA-specific-error-code from the
// MediaError.message prefix.
result << ": "
<< MediaEventToMessageString(*cached_media_error_for_message_);
}
return result.str();
}
std::string BatchingMediaLog::MediaEventToMessageString(
const media::MediaLogRecord& event) {
switch (event.type) {
case media::MediaLogRecord::Type::kMediaStatus: {
int error_code = 0;
event.params.GetInteger(media::MediaLog::kStatusText, &error_code);
DCHECK_NE(error_code, 0);
return PipelineStatusToString(
static_cast<media::PipelineStatus>(error_code));
}
case media::MediaLogRecord::Type::kMessage: {
std::string result;
if (event.params.GetString(
MediaLogMessageLevelToString(media::MediaLogMessageLevel::kERROR),
&result)) {
base::ReplaceChars(result, "\n", " ", &result);
}
return result;
}
default:
NOTREACHED();
return "";
}
}
void BatchingMediaLog::SendQueuedMediaEvents() {
DCHECK(task_runner_->BelongsToCurrentThread());
base::AutoLock auto_lock(lock_);
DCHECK(ipc_send_pending_);
ipc_send_pending_ = false;
if (last_duration_changed_event_) {
queued_media_events_.push_back(*last_duration_changed_event_);
last_duration_changed_event_.reset();
}
last_ipc_send_time_ = tick_clock_->NowTicks();
if (queued_media_events_.empty())
return;
for (const auto& handler : event_handlers_)
handler->SendQueuedMediaEvents(queued_media_events_);
queued_media_events_.clear();
}
void BatchingMediaLog::SetTickClockForTesting(
const base::TickClock* tick_clock) {
base::AutoLock auto_lock(lock_);
tick_clock_ = tick_clock;
last_ipc_send_time_ = tick_clock_->NowTicks();
}
} // namespace content
|
