forked from shaka-project/shaka-player
-
Notifications
You must be signed in to change notification settings - Fork 0
/
server_side_ad_manager.js
420 lines (358 loc) · 12.7 KB
/
server_side_ad_manager.js
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
417
418
419
420
/*! @license
* Shaka Player
* Copyright 2016 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @fileoverview
* @suppress {missingRequire} TODO(b/152540451): this shouldn't be needed
*/
goog.provide('shaka.ads.ServerSideAdManager');
goog.require('goog.asserts');
goog.require('shaka.ads.ServerSideAd');
goog.require('shaka.log');
goog.require('shaka.util.IReleasable');
/**
* A class responsible for server-side ad interactions.
* @implements {shaka.util.IReleasable}
*/
shaka.ads.ServerSideAdManager = class {
/**
* @param {HTMLElement} adContainer
* @param {HTMLMediaElement} video
* @param {string} locale
* @param {function(!shaka.util.FakeEvent)} onEvent
*/
constructor(adContainer, video, locale, onEvent) {
/** @private {HTMLElement} */
this.adContainer_ = adContainer;
/** @private {HTMLMediaElement} */
this.video_ = video;
/** @private {?shaka.extern.AdsConfiguration} */
this.config_ = null;
/** @private
{?shaka.util.PublicPromise.<string>} */
this.streamPromise_ = null;
/** @private {number} */
this.streamRequestStartTime_ = NaN;
/** @private {function(!shaka.util.FakeEvent)} */
this.onEvent_ = onEvent;
/** @private {boolean} */
this.isLiveContent_ = false;
/**
* Time to seek to after an ad if that ad was played as the result of
* snapback.
* @private {?number}
*/
this.snapForwardTime_ = null;
/** @private {shaka.ads.ServerSideAd} */
this.ad_ = null;
/** @private {?google.ima.dai.api.AdProgressData} */
this.adProgressData_ = null;
/** @private {string} */
this.backupUrl_ = '';
/** @private {!Array.<!shaka.extern.AdCuePoint>} */
this.currentCuePoints_ = [];
/** @private {shaka.util.EventManager} */
this.eventManager_ = new shaka.util.EventManager();
/** @private {google.ima.dai.api.UiSettings} */
const uiSettings = new google.ima.dai.api.UiSettings();
uiSettings.setLocale(locale);
/** @private {google.ima.dai.api.StreamManager} */
this.streamManager_ = new google.ima.dai.api.StreamManager(
this.video_, this.adContainer_, uiSettings);
this.onEvent_(new shaka.util.FakeEvent(
shaka.ads.AdManager.IMA_STREAM_MANAGER_LOADED,
(new Map()).set('imaStreamManager', this.streamManager_)));
// Events
this.eventManager_.listen(this.streamManager_,
google.ima.dai.api.StreamEvent.Type.LOADED, (e) => {
shaka.log.info('Ad SS Loaded');
this.onLoaded_(
/** @type {!google.ima.dai.api.StreamEvent} */ (e));
});
this.eventManager_.listen(this.streamManager_,
google.ima.dai.api.StreamEvent.Type.ERROR, () => {
shaka.log.info('Ad SS Error');
this.onError_();
});
this.eventManager_.listen(this.streamManager_,
google.ima.dai.api.StreamEvent.Type.AD_BREAK_STARTED, () => {
shaka.log.info('Ad Break Started');
});
this.eventManager_.listen(this.streamManager_,
google.ima.dai.api.StreamEvent.Type.STARTED, (e) => {
shaka.log.info('Ad Started');
this.onAdStart_(/** @type {!google.ima.dai.api.StreamEvent} */ (e));
});
this.eventManager_.listen(this.streamManager_,
google.ima.dai.api.StreamEvent.Type.AD_BREAK_ENDED, () => {
shaka.log.info('Ad Break Ended');
this.onAdBreakEnded_();
});
this.eventManager_.listen(this.streamManager_,
google.ima.dai.api.StreamEvent.Type.AD_PROGRESS, (e) => {
this.onAdProgress_(
/** @type {!google.ima.dai.api.StreamEvent} */ (e));
});
this.eventManager_.listen(this.streamManager_,
google.ima.dai.api.StreamEvent.Type.FIRST_QUARTILE, () => {
shaka.log.info('Ad event: First Quartile');
this.onEvent_(
new shaka.util.FakeEvent(shaka.ads.AdManager.AD_FIRST_QUARTILE));
});
this.eventManager_.listen(this.streamManager_,
google.ima.dai.api.StreamEvent.Type.MIDPOINT, () => {
shaka.log.info('Ad event: Midpoint');
this.onEvent_(
new shaka.util.FakeEvent(shaka.ads.AdManager.AD_MIDPOINT));
});
this.eventManager_.listen(this.streamManager_,
google.ima.dai.api.StreamEvent.Type.THIRD_QUARTILE, () => {
shaka.log.info('Ad event: Third Quartile');
this.onEvent_(
new shaka.util.FakeEvent(shaka.ads.AdManager.AD_THIRD_QUARTILE));
});
this.eventManager_.listen(this.streamManager_,
google.ima.dai.api.StreamEvent.Type.COMPLETE, () => {
shaka.log.info('Ad event: Complete');
this.onEvent_(
new shaka.util.FakeEvent(shaka.ads.AdManager.AD_COMPLETE));
this.onEvent_(
new shaka.util.FakeEvent(shaka.ads.AdManager.AD_STOPPED));
this.adContainer_.removeAttribute('ad-active');
this.ad_ = null;
});
this.eventManager_.listen(this.streamManager_,
google.ima.dai.api.StreamEvent.Type.SKIPPED, () => {
shaka.log.info('Ad event: Skipped');
this.onEvent_(
new shaka.util.FakeEvent(shaka.ads.AdManager.AD_SKIPPED));
this.onEvent_(
new shaka.util.FakeEvent(shaka.ads.AdManager.AD_STOPPED));
});
this.eventManager_.listen(this.streamManager_,
google.ima.dai.api.StreamEvent.Type.CUEPOINTS_CHANGED, (e) => {
shaka.log.info('Ad event: Cue points changed');
this.onCuePointsChanged_(
/** @type {!google.ima.dai.api.StreamEvent} */ (e));
});
}
/**
* Called by the AdManager to provide an updated configuration any time it
* changes.
*
* @param {shaka.extern.AdsConfiguration} config
*/
configure(config) {
this.config_ = config;
}
/**
* @param {!google.ima.dai.api.StreamRequest} streamRequest
* @param {string=} backupUrl
* @return {!Promise.<string>}
*/
streamRequest(streamRequest, backupUrl) {
if (this.streamPromise_) {
return Promise.reject(new shaka.util.Error(
shaka.util.Error.Severity.RECOVERABLE,
shaka.util.Error.Category.ADS,
shaka.util.Error.Code.CURRENT_DAI_REQUEST_NOT_FINISHED));
}
if (streamRequest instanceof google.ima.dai.api.LiveStreamRequest) {
this.isLiveContent_ = true;
}
this.streamPromise_ = new shaka.util.PublicPromise();
this.streamManager_.requestStream(streamRequest);
this.backupUrl_ = backupUrl || '';
this.streamRequestStartTime_ = Date.now() / 1000;
return this.streamPromise_;
}
/**
* @param {Object} adTagParameters
*/
replaceAdTagParameters(adTagParameters) {
this.streamManager_.replaceAdTagParameters(adTagParameters);
}
/**
* Resets the stream manager and removes any continuous polling.
*/
stop() {
// TODO:
// For SS DAI streams, if a different asset gets unloaded as
// part of the process
// of loading a DAI asset, stream manager state gets reset and we
// don't get any ad events.
// We need to figure out if it makes sense to stop the SS
// manager on unload, and, if it does, find
// a way to do it safely.
// this.streamManager_.reset();
this.backupUrl_ = '';
this.snapForwardTime_ = null;
this.currentCuePoints_ = [];
}
/** @override */
release() {
this.stop();
if (this.eventManager_) {
this.eventManager_.release();
}
}
/**
* @param {string} type
* @param {Uint8Array|string} data
* Comes as string in DASH and as Uint8Array in HLS.
* @param {number} timestamp (in seconds)
*/
onTimedMetadata(type, data, timestamp) {
this.streamManager_.processMetadata(type, data, timestamp);
}
/**
* @param {shaka.extern.MetadataFrame} value
*/
onCueMetadataChange(value) {
// Native HLS over Safari/iOS/iPadOS
// For live event streams, the stream needs some way of informing the SDK
// that an ad break is coming up or ending. In the IMA DAI SDK, this is
// done through timed metadata. Timed metadata is carried as part of the
// DAI stream content and carries ad break timing information used by the
// SDK to track ad breaks.
if (value.key && value.data) {
const metadata = {};
metadata[value.key] = value.data;
this.streamManager_.onTimedMetadata(metadata);
}
}
/**
* @return {!Array.<!shaka.extern.AdCuePoint>}
*/
getCuePoints() {
return this.currentCuePoints_;
}
/**
* If a seek jumped over the ad break, return to the start of the
* ad break, then complete the seek after the ad played through.
* @private
*/
checkForSnapback_() {
const currentTime = this.video_.currentTime;
if (currentTime == 0) {
return;
}
this.streamManager_.streamTimeForContentTime(currentTime);
const previousCuePoint =
this.streamManager_.previousCuePointForStreamTime(currentTime);
// The cue point gets marked as 'played' as soon as the playhead hits it
// (at the start of an ad), so when we come back to this method as a result
// of seeking back to the user-selected time, the 'played' flag will be set.
if (previousCuePoint && !previousCuePoint.played) {
shaka.log.info('Seeking back to the start of the ad break at ' +
previousCuePoint.start + ' and will return to ' + currentTime);
this.snapForwardTime_ = currentTime;
this.video_.currentTime = previousCuePoint.start;
}
}
/**
* @param {!google.ima.dai.api.StreamEvent} e
* @private
*/
onAdStart_(e) {
goog.asserts.assert(this.streamManager_,
'Should have a stream manager at this point!');
const imaAd = e.getAd();
this.ad_ = new shaka.ads.ServerSideAd(imaAd, this.video_);
// Ad object and ad progress data come from two different IMA events.
// It's a race, and we don't know, which one will fire first - the
// event that contains an ad object (AD_STARTED) or the one that
// contains ad progress info (AD_PROGRESS).
// If the progress event fired first, we must've saved the progress
// info and can now add it to the ad object.
if (this.adProgressData_) {
this.ad_.setProgressData(this.adProgressData_);
}
this.onEvent_(new shaka.util.FakeEvent(shaka.ads.AdManager.AD_STARTED,
(new Map()).set('ad', this.ad_)));
this.adContainer_.setAttribute('ad-active', 'true');
}
/**
* @private
*/
onAdBreakEnded_() {
this.adContainer_.removeAttribute('ad-active');
const currentTime = this.video_.currentTime;
// If the ad break was a result of snapping back (a user seeked over
// an ad break and was returned to it), seek forward to the point,
// originally chosen by the user.
if (this.snapForwardTime_ && this.snapForwardTime_ > currentTime) {
this.video_.currentTime = this.snapForwardTime_;
this.snapForwardTime_ = null;
}
}
/**
* @param {!google.ima.dai.api.StreamEvent} e
* @private
*/
onLoaded_(e) {
const now = Date.now() / 1000;
const loadTime = now - this.streamRequestStartTime_;
this.onEvent_(new shaka.util.FakeEvent(shaka.ads.AdManager.ADS_LOADED,
(new Map()).set('loadTime', loadTime)));
const streamData = e.getStreamData();
const url = streamData.url;
this.streamPromise_.resolve(url);
this.streamPromise_ = null;
if (!this.isLiveContent_) {
this.eventManager_.listen(this.video_, 'seeked', () => {
this.checkForSnapback_();
});
}
}
/**
* @private
*/
onError_() {
if (!this.backupUrl_.length) {
this.streamPromise_.reject('IMA Stream request returned an error ' +
'and there was no backup asset uri provided.');
this.streamPromise_ = null;
return;
}
shaka.log.warning('IMA stream request returned an error. ' +
'Falling back to the backup asset uri.');
this.streamPromise_.resolve(this.backupUrl_);
this.streamPromise_ = null;
}
/**
* @param {!google.ima.dai.api.StreamEvent} e
* @private
*/
onAdProgress_(e) {
const streamData = e.getStreamData();
const adProgressData = streamData.adProgressData;
this.adProgressData_ = adProgressData;
if (this.ad_) {
this.ad_.setProgressData(this.adProgressData_);
}
}
/**
* @param {!google.ima.dai.api.StreamEvent} e
* @private
*/
onCuePointsChanged_(e) {
const streamData = e.getStreamData();
/** @type {!Array.<!shaka.extern.AdCuePoint>} */
const cuePoints = [];
for (const point of streamData.cuepoints) {
/** @type {shaka.extern.AdCuePoint} */
const shakaCuePoint = {
start: point.start,
end: point.end,
};
cuePoints.push(shakaCuePoint);
}
this.currentCuePoints_ = cuePoints;
this.onEvent_(new shaka.util.FakeEvent(
shaka.ads.AdManager.CUEPOINTS_CHANGED,
(new Map()).set('cuepoints', cuePoints)));
}
};