File: MediaElementEventRunners.cpp

package info (click to toggle)
firefox 148.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,719,656 kB
  • sloc: cpp: 7,618,171; javascript: 6,701,506; ansic: 3,781,787; python: 1,418,364; xml: 638,647; asm: 438,962; java: 186,285; sh: 62,885; makefile: 19,010; objc: 13,092; perl: 12,763; yacc: 4,583; cs: 3,846; pascal: 3,448; lex: 1,720; ruby: 1,003; php: 436; lisp: 258; awk: 247; sql: 66; sed: 54; csh: 10; exp: 6
file content (235 lines) | stat: -rw-r--r-- 8,875 bytes parent folder | download | duplicates (3)
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
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "MediaElementEventRunners.h"

#include <stdint.h>

#include "MediaProfilerMarkers.h"
#include "mozilla/Casting.h"
#include "mozilla/FlowMarkers.h"
#include "mozilla/ProfilerState.h"
#include "mozilla/dom/HTMLMediaElement.h"
#include "mozilla/dom/HTMLVideoElement.h"
#include "mozilla/dom/MediaError.h"
#include "mozilla/dom/TimeRanges.h"

extern mozilla::LazyLogModule gMediaElementEventsLog;
#define LOG_EVENT(type, msg) MOZ_LOG(gMediaElementEventsLog, type, msg)

namespace mozilla::dom {

nsMediaEventRunner::nsMediaEventRunner(const char* aName,
                                       HTMLMediaElement* aElement,
                                       const nsAString& aEventName)
    : mElement(aElement),
      mName(aName),
      mEventName(aEventName),
      mLoadID(mElement->GetCurrentLoadID()) {}

bool nsMediaEventRunner::IsCancelled() const {
  return !mElement || mElement->GetCurrentLoadID() != mLoadID;
}

nsresult nsMediaEventRunner::FireEvent(const nsAString& aName) {
  nsresult rv = NS_OK;
  if (mElement) {
    ReportProfilerMarker();
    rv = RefPtr { mElement } -> FireEvent(aName);
  }
  return rv;
}

void nsMediaEventRunner::ReportProfilerMarker() {
  if (!profiler_is_collecting_markers()) {
    return;
  }
  // Report the buffered range.
  if (mEventName.EqualsLiteral("progress")) {
    RefPtr<TimeRanges> buffered = mElement->Buffered();
    if (buffered && buffered->Length() > 0) {
      for (size_t i = 0; i < buffered->Length(); ++i) {
        profiler_add_marker("progress", geckoprofiler::category::MEDIA_PLAYBACK,
                            {}, BufferedUpdateMarker{},
                            AssertedCast<uint64_t>(buffered->Start(i) * 1000),
                            AssertedCast<uint64_t>(buffered->End(i) * 1000),
                            GetElementDurationMs(),
                            Flow::FromPointer(mElement.get()));
      }
    }
  } else if (mEventName.EqualsLiteral("resize")) {
    MOZ_ASSERT(mElement->HasVideo());
    auto mediaInfo = mElement->GetMediaInfo();
    profiler_add_marker("resize", geckoprofiler::category::MEDIA_PLAYBACK, {},
                        VideoResizeMarker{}, mediaInfo.mVideo.mDisplay.width,
                        mediaInfo.mVideo.mDisplay.height,
                        Flow::FromPointer(mElement.get()));
  } else if (mEventName.EqualsLiteral("loadedmetadata")) {
    nsString src;
    mElement->GetCurrentSrc(src);
    auto mediaInfo = mElement->GetMediaInfo();
    profiler_add_marker(
        "loadedmetadata", geckoprofiler::category::MEDIA_PLAYBACK, {},
        MetadataMarker{}, src,
        mediaInfo.HasAudio() ? mediaInfo.mAudio.mMimeType : "none"_ns,
        mediaInfo.HasVideo() ? mediaInfo.mVideo.mMimeType : "none"_ns,
        Flow::FromPointer(mElement.get()));
  } else if (mEventName.EqualsLiteral("error")) {
    auto* error = mElement->GetError();
    nsString message;
    error->GetMessage(message);
    profiler_add_marker("error", geckoprofiler::category::MEDIA_PLAYBACK, {},
                        ErrorMarker{}, message,
                        Flow::FromPointer(mElement.get()));
  } else {
    auto eventName = NS_ConvertUTF16toUTF8(mEventName);
    PROFILER_MARKER(eventName, MEDIA_PLAYBACK, {}, FlowMarker,
                    Flow::FromPointer(mElement.get()));
  }
}

uint64_t nsMediaEventRunner::GetElementDurationMs() const {
  MOZ_ASSERT(!IsCancelled());
  double duration = mElement->Duration();

  if (duration == std::numeric_limits<double>::infinity()) {
    return std::numeric_limits<uint64_t>::max();
  }

  if (std::isnan(duration) || duration <= 0) {
    // Duration is unknown or invalid
    return 0;
  }
  return AssertedCast<uint64_t>(duration * 1000);
}

NS_IMPL_CYCLE_COLLECTION(nsMediaEventRunner, mElement)
NS_IMPL_CYCLE_COLLECTING_ADDREF(nsMediaEventRunner)
NS_IMPL_CYCLE_COLLECTING_RELEASE(nsMediaEventRunner)
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(nsMediaEventRunner)
  NS_INTERFACE_MAP_ENTRY(nsINamed)
  NS_INTERFACE_MAP_ENTRY(nsIRunnable)
  NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, nsIRunnable)
NS_INTERFACE_MAP_END

NS_IMETHODIMP nsAsyncEventRunner::Run() {
  // Silently cancel if our load has been cancelled or element has been CCed.
  return IsCancelled() ? NS_OK : FireEvent(mEventName);
}

nsResolveOrRejectPendingPlayPromisesRunner::
    nsResolveOrRejectPendingPlayPromisesRunner(
        HTMLMediaElement* aElement, nsTArray<RefPtr<PlayPromise>>&& aPromises,
        nsresult aError)
    : nsMediaEventRunner("nsResolveOrRejectPendingPlayPromisesRunner",
                         aElement),
      mPromises(std::move(aPromises)),
      mError(aError) {
  mElement->mPendingPlayPromisesRunners.AppendElement(this);
}

void nsResolveOrRejectPendingPlayPromisesRunner::ResolveOrReject() {
  if (NS_SUCCEEDED(mError)) {
    PlayPromise::ResolvePromisesWithUndefined(mPromises);
  } else {
    PlayPromise::RejectPromises(mPromises, mError);
  }
}

NS_IMETHODIMP nsResolveOrRejectPendingPlayPromisesRunner::Run() {
  if (!IsCancelled()) {
    ResolveOrReject();
  }

  mElement->mPendingPlayPromisesRunners.RemoveElement(this);
  return NS_OK;
}

NS_IMETHODIMP nsNotifyAboutPlayingRunner::Run() {
  if (!IsCancelled()) {
    FireEvent(u"playing"_ns);
  }
  return nsResolveOrRejectPendingPlayPromisesRunner::Run();
}

NS_IMPL_CYCLE_COLLECTION_INHERITED(nsResolveOrRejectPendingPlayPromisesRunner,
                                   nsMediaEventRunner, mPromises)
NS_IMPL_ADDREF_INHERITED(nsResolveOrRejectPendingPlayPromisesRunner,
                         nsMediaEventRunner)
NS_IMPL_RELEASE_INHERITED(nsResolveOrRejectPendingPlayPromisesRunner,
                          nsMediaEventRunner)
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(
    nsResolveOrRejectPendingPlayPromisesRunner)
NS_INTERFACE_MAP_END_INHERITING(nsMediaEventRunner)

NS_IMETHODIMP nsSourceErrorEventRunner::Run() {
  // Silently cancel if our load has been cancelled.
  if (IsCancelled()) {
    return NS_OK;
  }
  LOG_EVENT(LogLevel::Debug,
            ("%p Dispatching simple event source error", mElement.get()));
  if (profiler_is_collecting_markers()) {
    profiler_add_marker("sourceerror", geckoprofiler::category::MEDIA_PLAYBACK,
                        {}, ErrorMarker{}, mErrorDetails,
                        Flow::FromPointer(mElement.get()));
  }
  return nsContentUtils::DispatchTrustedEvent(mElement->OwnerDoc(), mSource,
                                              u"error"_ns, CanBubble::eNo,
                                              Cancelable::eNo);
}

NS_IMPL_CYCLE_COLLECTION_INHERITED(nsSourceErrorEventRunner, nsMediaEventRunner,
                                   mSource)
NS_IMPL_ADDREF_INHERITED(nsSourceErrorEventRunner, nsMediaEventRunner)
NS_IMPL_RELEASE_INHERITED(nsSourceErrorEventRunner, nsMediaEventRunner)
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(nsSourceErrorEventRunner)
NS_INTERFACE_MAP_END_INHERITING(nsMediaEventRunner)

NS_IMETHODIMP nsTimeupdateRunner::Run() {
  if (IsCancelled() || !ShouldDispatchTimeupdate()) {
    return NS_OK;
  }
  // After dispatching `timeupdate`, if the timeupdate event listener takes lots
  // of time then we end up spending all time handling just timeupdate events.
  // The spec is vague in this situation, so we choose to update time after we
  // dispatch the event in order to solve that issue.
  nsresult rv = FireEvent(mEventName);
  if (NS_WARN_IF(NS_FAILED(rv))) {
    LOG_EVENT(LogLevel::Debug,
              ("%p Failed to dispatch 'timeupdate'", mElement.get()));
  } else {
    mElement->UpdateLastTimeupdateDispatchTime();
  }
  return rv;
}

bool nsTimeupdateRunner::ShouldDispatchTimeupdate() const {
  if (mIsMandatory) {
    return true;
  }

  // If the main thread is busy, tasks may be delayed and dispatched at
  // unexpected times. Ensure we don't dispatch `timeupdate` more often
  // than once per `TIMEUPDATE_MS`.
  const TimeStamp& lastTime = mElement->LastTimeupdateDispatchTime();
  return lastTime.IsNull() || TimeStamp::Now() - lastTime >
                                  TimeDuration::FromMilliseconds(TIMEUPDATE_MS);
}

void nsTimeupdateRunner::ReportProfilerMarker() {
  if (!profiler_is_collecting_markers()) {
    return;
  }
  auto* videoElement = mElement->AsHTMLVideoElement();
  profiler_add_marker("timeupdate", geckoprofiler::category::MEDIA_PLAYBACK, {},
                      TimeUpdateMarker{},
                      AssertedCast<uint64_t>(mElement->CurrentTime() * 1000),
                      GetElementDurationMs(),
                      videoElement ? videoElement->MozPaintedFrames() : 0,
                      Flow::FromPointer(mElement.get()));
}

#undef LOG_EVENT
}  // namespace mozilla::dom