forked from shaka-project/shaka-player
/
asset.js
468 lines (421 loc) · 11.6 KB
/
asset.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
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
/*! @license
* Shaka Player
* Copyright 2016 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @fileoverview
* @suppress {missingRequire}
*/
goog.provide('ShakaDemoAssetInfo');
goog.require('shakaDemo.MessageIds');
/**
* An object that contains information about an asset.
*/
const ShakaDemoAssetInfo = class {
/**
* @param {string} name
* @param {string} iconUri
* @param {string} manifestUri
* @param {shakaAssets.Source} source
*/
constructor(name, iconUri, manifestUri, source) {
// Required members.
/** @type {string} */
this.name = name;
/** @type {string} */
this.shortName = '';
/** @type {string} */
this.iconUri = iconUri;
/** @type {string} */
this.manifestUri = manifestUri;
/** @type {!shakaAssets.Source} */
this.source = source;
// Optional members.
/** @type {boolean} */
this.focus = false;
/** @type {boolean} */
this.disabled = false;
/** @type {!Array.<!shakaAssets.ExtraText>} */
this.extraText = [];
/** @type {?string} */
this.certificateUri = null;
/** @type {?string} */
this.description = null;
/** @type {boolean} */
this.isFeatured = false;
/** @type {!Array.<!shakaAssets.KeySystem>} */
this.drm = [shakaAssets.KeySystem.CLEAR];
/** @type {!Array.<!shakaAssets.Feature>} */
this.features = [shakaAssets.Feature.VOD];
/** @type {!Map.<string, string>} */
this.licenseServers = new Map();
/** @type {!Map.<string, string>} */
this.licenseRequestHeaders = new Map();
/** @type {?shaka.extern.RequestFilter} */
this.requestFilter = null;
/** @type {?shaka.extern.ResponseFilter} */
this.responseFilter = null;
/** @type {!Map.<string, string>} */
this.clearKeys = new Map(); // TODO: Setter method?
/** @type {?Object} */
this.extraConfig = null;
/** @type {?string} */
this.adTagUri = null;
/** @type {?string} */
this.imaVideoId = null;
/** @type {?string} */
this.imaAssetKey = null;
/** @type {?string} */
this.imaContentSrcId = null;
/** @type {?string} */
this.mimeType = null;
/** @type {?string} */
this.mediaPlaylistFullMimeType = null;
// Offline storage values.
/** @type {?function()} */
this.storeCallback;
/** @type {?function()} */
this.unstoreCallback;
/** @type {?shaka.extern.StoredContent} */
this.storedContent;
/** @type {number} */
this.storedProgress = 1;
}
/**
* @param {string} description
* @return {!ShakaDemoAssetInfo}
*/
addDescription(description) {
this.description = description;
return this;
}
/**
* @param {string} certificateUri
* @return {!ShakaDemoAssetInfo}
*/
addCertificateUri(certificateUri) {
this.certificateUri = certificateUri;
return this;
}
/**
* A sort comparator for comparing two message Ids, ignoring case.
* @param {shakaDemo.MessageIds} a
* @param {shakaDemo.MessageIds} b
* @return {number}
* @private
*/
static caseLessAlphaComparator_(a, b) {
if (a.toLowerCase() < b.toLowerCase()) {
return -1;
}
if (a.toLowerCase() > b.toLowerCase()) {
return 1;
}
return 0;
}
/**
* @param {shakaAssets.Feature} feature
* @return {!ShakaDemoAssetInfo}
*/
addFeature(feature) {
const Feature = shakaAssets.Feature;
if (feature == Feature.LIVE) {
// Unmark this feature as being VOD.
this.features = this.features.filter((feature) => feature != Feature.VOD);
}
this.features.push(feature);
// Sort the features list, so that features are in a predictable order.
this.features.sort(ShakaDemoAssetInfo.caseLessAlphaComparator_);
return this;
}
/**
* @param {shakaAssets.KeySystem} keySystem
* @return {!ShakaDemoAssetInfo}
*/
addKeySystem(keySystem) {
if (this.isClear()) {
// Once an asset has an actual key system, it's no longer a CLEAR asset.
this.drm = [];
}
this.drm.push(keySystem);
// Sort the drm list, so that key systems are in a predictable order.
this.drm.sort(ShakaDemoAssetInfo.caseLessAlphaComparator_);
return this;
}
/** @return {boolean} */
isClear() {
return this.drm.length == 1 && this.drm[0] == shakaAssets.KeySystem.CLEAR;
}
/**
* @param {string} mediaPlaylistFullMimeType
* @return {!ShakaDemoAssetInfo}
*/
setMediaPlaylistFullMimeType(mediaPlaylistFullMimeType) {
this.mediaPlaylistFullMimeType = mediaPlaylistFullMimeType;
return this;
}
/**
* @param {!Object} extraConfig
* @return {!ShakaDemoAssetInfo}
*/
setExtraConfig(extraConfig) {
this.extraConfig = extraConfig;
return this;
}
/**
* @param {string} mimeType
* @return {!ShakaDemoAssetInfo}
*/
setMimeType(mimeType) {
this.mimeType = mimeType;
return this;
}
/**
* @param {!shaka.extern.RequestFilter} requestFilter
* @return {!ShakaDemoAssetInfo}
*/
setRequestFilter(requestFilter) {
this.requestFilter = requestFilter;
return this;
}
/**
* @param {!shaka.extern.ResponseFilter} responseFilter
* @return {!ShakaDemoAssetInfo}
*/
setResponseFilter(responseFilter) {
this.responseFilter = responseFilter;
return this;
}
/**
* @param {string} keySystem
* @param {string} licenseServer
* @return {!ShakaDemoAssetInfo}
*/
addLicenseServer(keySystem, licenseServer) {
this.licenseServers.set(keySystem, licenseServer);
return this;
}
/**
* @param {string} uri
* @return {!ShakaDemoAssetInfo}
*/
setAdTagUri(uri) {
this.adTagUri = uri;
this.addFeature(shakaAssets.Feature.ADS);
return this;
}
/**
* @param {string} id
* @return {!ShakaDemoAssetInfo}
*/
setIMAContentSourceId(id) {
this.imaContentSrcId = id;
if (!this.features.includes(shakaAssets.Feature.ADS)) {
this.addFeature(shakaAssets.Feature.ADS);
}
return this;
}
/**
* @param {string} id
* @return {!ShakaDemoAssetInfo}
*/
setIMAVideoId(id) {
this.imaVideoId = id;
if (!this.features.includes(shakaAssets.Feature.ADS)) {
this.addFeature(shakaAssets.Feature.ADS);
}
return this;
}
/**
* @param {string} key
* @return {!ShakaDemoAssetInfo}
*/
setIMAAssetKey(key) {
this.imaAssetKey = key;
if (!this.features.includes(shakaAssets.Feature.ADS)) {
this.addFeature(shakaAssets.Feature.ADS);
}
return this;
}
/**
* @param {string} headerName
* @param {string} headerValue
* @return {!ShakaDemoAssetInfo}
*/
addLicenseRequestHeader(headerName, headerValue) {
this.licenseRequestHeaders.set(headerName, headerValue);
return this;
}
/**
* @param {shakaAssets.ExtraText} extraText
* @return {!ShakaDemoAssetInfo}
*/
addExtraText(extraText) {
// TODO: At no point do we actually use the extraText... why does it exist?
this.extraText.push(extraText);
return this;
}
/**
* If this is called, the asset will be focused on by the integration tests.
* @return {!ShakaDemoAssetInfo}
*/
markAsFocused() {
this.focus = true;
return this;
}
/**
* If this is called, the asset will appear on the main page of the demo.
* Also, this allows you to provide a shorter name to be used in the feature
* card.
* @param {string=} shortName
* @return {!ShakaDemoAssetInfo}
*/
markAsFeatured(shortName) {
this.isFeatured = true;
this.shortName = shortName || this.shortName;
return this;
}
/**
* If this is called, the asset is disabled in tests and in the demo app.
* @return {!ShakaDemoAssetInfo}
*/
markAsDisabled() {
this.disabled = true;
return this;
}
/**
* @return {!Object}
* @override
*
* Suppress checkTypes warnings, so that we can access properties of this
* object as though it were a struct.
* @suppress {checkTypes}
*/
toJSON() {
// Construct a generic object with the values of this object, but with the
// proper formatting.
const raw = {};
for (const key in this) {
const value = this[key];
if (value instanceof Map) {
// The built-in JSON functions cannot convert Maps; this converts Maps
// to objects.
const replacement = {};
replacement['__type__'] = 'map';
for (const entry of value.entries()) {
replacement[entry[0]] = entry[1];
}
raw[key] = replacement;
} else {
raw[key] = value;
}
}
return raw;
}
/**
* Applies appropriate request or response filters to the player.
* @param {shaka.net.NetworkingEngine} networkingEngine
*/
applyFilters(networkingEngine) {
networkingEngine.clearAllRequestFilters();
networkingEngine.clearAllResponseFilters();
if (this.licenseRequestHeaders.size) {
const filter = (requestType, request) => {
return this.addLicenseRequestHeaders_(this.licenseRequestHeaders,
requestType,
request);
};
networkingEngine.registerRequestFilter(filter);
}
if (this.requestFilter) {
networkingEngine.registerRequestFilter(this.requestFilter);
}
if (this.responseFilter) {
networkingEngine.registerResponseFilter(this.responseFilter);
}
}
/**
* Gets the configuration object for the asset.
* @return {!shaka.extern.PlayerConfiguration}
*/
getConfiguration() {
const config = /** @type {shaka.extern.PlayerConfiguration} */(
{drm: {advanced: {}}, manifest: {dash: {}, hls: {}}});
if (this.extraConfig) {
for (const key in this.extraConfig) {
config[key] = this.extraConfig[key];
}
}
if (this.mediaPlaylistFullMimeType) {
config.manifest.hls.mediaPlaylistFullMimeType =
this.mediaPlaylistFullMimeType;
}
if (this.licenseServers.size) {
config.drm.servers = config.drm.servers || {};
this.licenseServers.forEach((value, key) => {
config.drm.servers[key] = value;
});
}
if (this.clearKeys.size) {
config.drm.clearKeys = config.drm.clearKeys || {};
this.clearKeys.forEach((value, key) => {
config.drm.clearKeys[key] = value;
});
}
return config;
}
/**
* @param {!Map.<string, string>} headers
* @param {shaka.net.NetworkingEngine.RequestType} requestType
* @param {shaka.extern.Request} request
* @private
*/
addLicenseRequestHeaders_(headers, requestType, request) {
if (requestType != shaka.net.NetworkingEngine.RequestType.LICENSE) {
return;
}
// Add these to the existing headers. Do not clobber them!
// For PlayReady, there will already be headers in the request.
headers.forEach((value, key) => {
request.headers[key] = value;
});
}
/** @return {boolean} */
isStored() {
return this.storedContent != null;
}
/** @return {!ShakaDemoAssetInfo} */
static makeBlankAsset() {
return new ShakaDemoAssetInfo(
/* name= */ '',
/* iconUri= */ '',
/* manifestUri= */ '',
/* source= */ shakaAssets.Source.CUSTOM);
}
/**
* @param {!Object} raw
* @return {!ShakaDemoAssetInfo}
*/
static fromJSON(raw) {
// This handles the special case for Maps in toJSON.
const parsed = {};
for (const key in raw) {
const value = raw[key];
if (value && typeof value == 'object' && value['__type__'] == 'map') {
const replacement = new Map();
for (const key in value) {
if (key != '__type__') {
replacement.set(key, value[key]);
}
}
parsed[key] = replacement;
} else {
parsed[key] = value;
}
}
const asset = ShakaDemoAssetInfo.makeBlankAsset();
Object.assign(asset, parsed);
return asset;
}
};