/
player_integration.js
1136 lines (958 loc) · 42.8 KB
/
player_integration.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
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*! @license
* Shaka Player
* Copyright 2016 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
describe('Player', () => {
/** @type {!jasmine.Spy} */
let onErrorSpy;
/** @type {!HTMLVideoElement} */
let video;
/** @type {!shaka.Player} */
let player;
/** @type {!shaka.util.EventManager} */
let eventManager;
let compiledShaka;
/** @type {shaka.test.Waiter} */
let waiter;
const Util = shaka.test.Util;
beforeAll(async () => {
video = shaka.test.UiUtils.createVideoElement();
document.body.appendChild(video);
compiledShaka =
await shaka.test.Loader.loadShaka(getClientArg('uncompiled'));
});
beforeEach(async () => {
await shaka.test.TestScheme.createManifests(compiledShaka, '_compiled');
player = new compiledShaka.Player(video);
// Grab event manager from the uncompiled library:
eventManager = new shaka.util.EventManager();
waiter = new shaka.test.Waiter(eventManager);
waiter.setPlayer(player);
onErrorSpy = jasmine.createSpy('onError');
onErrorSpy.and.callFake((event) => {
fail(event.detail);
});
eventManager.listen(player, 'error', Util.spyFunc(onErrorSpy));
});
afterEach(async () => {
eventManager.release();
await player.destroy();
});
afterAll(() => {
document.body.removeChild(video);
});
describe('attach', () => {
beforeEach(async () => {
// To test attach, we want to construct a player without a video element
// attached in advance. To do that, we destroy the player that was
// constructed in the outermost beforeEach(), then construct a new one
// without a video element.
await player.destroy();
player = new compiledShaka.Player();
});
it('can be used before load()', async () => {
await player.attach(video);
await player.load('test:sintel_compiled');
});
}); // describe('attach')
describe('updateStartTime() in manifestparsed event handler', () => {
it('does not get segments prior to startTime', async () => {
player.addEventListener('manifestparsed', () => {
player.updateStartTime(24);
});
const results = {
requestedVideoSegment0: false,
requestedVideoSegment1: false,
requestedVideoSegment2: false,
};
const expected = {
requestedVideoSegment0: false,
requestedVideoSegment1: false,
requestedVideoSegment2: true,
};
player.getNetworkingEngine().registerRequestFilter(
(type, request) => {
if (request.uris[0] == 'test:sintel/video/0') {
results.requestedVideoSegment0 = true;
}
if (request.uris[0] == 'test:sintel/video/1') {
results.requestedVideoSegment1 = true;
}
if (request.uris[0] == 'test:sintel/video/2') {
results.requestedVideoSegment2 = true;
}
});
await player.load('test:sintel_compiled');
video.play();
await waiter.waitUntilPlayheadReachesOrFailOnTimeout(video, 25, 30);
expect(results).toEqual(expected);
});
});
describe('getStats', () => {
it('gives stats about current stream', async () => {
// This is tested more in player_unit.js. This is here to test the public
// API and to check for renaming.
await player.load('test:sintel_compiled');
video.play();
await waiter.waitUntilPlayheadReachesOrFailOnTimeout(video, 1, 10);
const stats = player.getStats();
const expected = {
width: jasmine.any(Number),
height: jasmine.any(Number),
streamBandwidth: jasmine.any(Number),
decodedFrames: jasmine.any(Number),
droppedFrames: jasmine.any(Number),
corruptedFrames: jasmine.any(Number),
estimatedBandwidth: jasmine.any(Number),
completionPercent: jasmine.any(Number),
loadLatency: jasmine.any(Number),
manifestTimeSeconds: jasmine.any(Number),
drmTimeSeconds: jasmine.any(Number),
playTime: jasmine.any(Number),
pauseTime: jasmine.any(Number),
bufferingTime: jasmine.any(Number),
licenseTime: jasmine.any(Number),
liveLatency: jasmine.any(Number),
maxSegmentDuration: jasmine.any(Number),
// We should have loaded the first Period by now, so we should have a
// history.
switchHistory: jasmine.arrayContaining([{
timestamp: jasmine.any(Number),
id: jasmine.any(Number),
type: 'variant',
fromAdaptation: true,
bandwidth: 0,
}]),
stateHistory: jasmine.arrayContaining([{
state: 'playing',
timestamp: jasmine.any(Number),
duration: jasmine.any(Number),
}]),
};
expect(stats).toEqual(expected);
});
// Regression test for Issue #968 where trying to get the stats before
// calling load would fail because not all components had been initialized.
it('can get stats before loading content', async () => {
// Destroy Player created in beforeEach.
await player.destroy();
// We are opting not to initialize the player with a video element so that
// it is in the least loaded state possible.
player = new compiledShaka.Player();
const stats = player.getStats();
expect(stats).toBeTruthy();
await player.destroy();
});
}); // describe('getStats')
describe('setTextTrackVisibility', () => {
// Using mode='disabled' on TextTrack causes cues to go null, which leads
// to a crash in TextEngine. This validates that we do not trigger this
// behavior when changing visibility of text.
it('does not cause cues to be null', async () => {
await player.load('test:sintel_compiled');
video.play();
await waiter.waitUntilPlayheadReachesOrFailOnTimeout(video, 1, 10);
// This TextTrack was created as part of load() when we set up the
// TextDisplayer.
const textTrack = video.textTracks[0];
expect(textTrack).not.toBe(null);
if (textTrack) {
// This should not be null initially.
expect(textTrack.cues).not.toBe(null);
await player.setTextTrackVisibility(true);
// This should definitely not be null when visible.
expect(textTrack.cues).not.toBe(null);
await player.setTextTrackVisibility(false);
// This should not transition to null when invisible.
expect(textTrack.cues).not.toBe(null);
}
});
it('is called automatically if language prefs match', async () => {
// If the text is a match for the user's preferences, and audio differs
// from text, we enable text display automatically.
// NOTE: This is also a regression test for #1696, in which a change
// to this feature broke StreamingEngine initialization.
const preferredTextLanguage = 'fa'; // The same as in the content itself
player.configure({preferredTextLanguage: preferredTextLanguage});
// Now load a version of Sintel with delayed setup of video & audio
// streams and wait for completion.
await player.load('test:sintel_realistic_compiled');
// By this point, a MediaSource error would be thrown in a repro of bug
// #1696.
// Make sure the automatic setting took effect.
expect(player.isTextTrackVisible()).toBe(true);
// Make sure the content we tested with has text tracks, that the config
// we used matches the text language, and that the audio language differs.
// These will catch any changes to the underlying content that would
// invalidate the test setup.
expect(player.getTextTracks().length).not.toBe(0);
const textTrack = player.getTextTracks()[0];
expect(textTrack.language).toBe(preferredTextLanguage);
const variantTrack = player.getVariantTracks()[0];
expect(variantTrack.language).not.toBe(textTrack.language);
});
it('is not called automatically without language pref match', async () => {
// If the text preference doesn't match the content, we do not enable text
// display automatically.
const preferredTextLanguage = 'xx'; // Differs from the content itself
player.configure({preferredTextLanguage: preferredTextLanguage});
// Now load the content and wait for completion.
await player.load('test:sintel_realistic_compiled');
// Make sure the automatic setting did not happen.
expect(player.isTextTrackVisible()).toBe(false);
// Make sure the content we tested with has text tracks, that the config
// we used does not match the text language, and that the text and audio
// languages do not match each other (to keep this distinct from the next
// test case). This will catch any changes to the underlying content that
// would invalidate the test setup.
expect(player.getTextTracks().length).not.toBe(0);
const textTrack = player.getTextTracks()[0];
expect(textTrack.language).not.toBe(preferredTextLanguage);
const variantTrack = player.getVariantTracks()[0];
expect(variantTrack.language).not.toBe(textTrack.language);
});
it('is not called automatically with audio and text match', async () => {
// If the audio and text tracks use the same language, we do not enable
// text display automatically, no matter the text preference.
const preferredTextLanguage = 'und'; // The same as in the content itself
player.configure({preferredTextLanguage: preferredTextLanguage});
// Now load the content and wait for completion.
await player.load('test:sintel_compiled');
// Make sure the automatic setting did not happen.
expect(player.isTextTrackVisible()).toBe(false);
// Make sure the content we tested with has text tracks, that the
// config we used matches the content, and that the text and audio
// languages match each other. This will catch any changes to the
// underlying content that would invalidate the test setup.
expect(player.getTextTracks().length).not.toBe(0);
const textTrack = player.getTextTracks()[0];
expect(textTrack.language).toBe(preferredTextLanguage);
const variantTrack = player.getVariantTracks()[0];
expect(variantTrack.language).toBe(textTrack.language);
});
// Repro for https://github.com/shaka-project/shaka-player/issues/1879.
it('appends cues when enabled initially', async () => {
let cues = [];
/** @const {!shaka.test.FakeTextDisplayer} */
const displayer = new shaka.test.FakeTextDisplayer();
displayer.appendSpy.and.callFake((added) => {
cues = cues.concat(added);
});
player.configure('textDisplayFactory', () => displayer);
const preferredTextLanguage = 'fa'; // The same as in the content itself
player.configure({preferredTextLanguage: preferredTextLanguage});
await player.load('test:sintel_realistic_compiled');
// Play until a time at which the external cues would be on screen.
video.play();
await waiter.waitUntilPlayheadReachesOrFailOnTimeout(video, 4, 20);
expect(player.isTextTrackVisible()).toBe(true);
expect(displayer.isTextVisible()).toBe(true);
expect(cues.length).toBeGreaterThan(0);
});
it('appends cues for external text', async () => {
let cues = [];
/** @const {!shaka.test.FakeTextDisplayer} */
const displayer = new shaka.test.FakeTextDisplayer();
displayer.appendSpy.and.callFake((added) => {
cues = cues.concat(added);
});
player.configure('textDisplayFactory', () => displayer);
await player.load('test:sintel_no_text_compiled');
const locationUri = new goog.Uri(location.href);
const partialUri = new goog.Uri('/base/test/test/assets/text-clip.vtt');
const absoluteUri = locationUri.resolve(partialUri);
const newTrack = await player.addTextTrackAsync(
absoluteUri.toString(), 'en', 'subtitles', 'text/vtt');
expect(player.getTextTracks()).toEqual([newTrack]);
player.selectTextTrack(newTrack);
player.setTextTrackVisibility(true);
await waiter.waitForEvent(player, 'texttrackvisibility');
// Play until a time at which the external cues would be on screen.
video.play();
await waiter.waitUntilPlayheadReachesOrFailOnTimeout(video, 4, 20);
expect(player.isTextTrackVisible()).toBe(true);
expect(displayer.isTextVisible()).toBe(true);
expect(cues.length).toBeGreaterThan(0);
});
// https://github.com/shaka-project/shaka-player/issues/2553
it('does not change the selected track', async () => {
player.configure('streaming.alwaysStreamText', false);
await player.load('test:forced_subs_simulation_compiled');
// In this content, both text tracks have the same language and role, and
// so should look identical in terms of choosing one to match a
// preference. This is important to the test, so verify it first.
const tracks = player.getTextTracks();
expect(tracks[0].language).toBe(tracks[1].language);
expect(tracks[0].roles).toEqual(tracks[1].roles);
const getTracksActive = () => player.getTextTracks().map((t) => t.active);
// If we choose a track first, then turn on text, the track should not
// change. Try this with both tracks.
player.setTextTrackVisibility(false);
player.selectTextTrack(tracks[0]);
expect(getTracksActive()).toEqual([true, false]);
player.setTextTrackVisibility(true);
expect(getTracksActive()).toEqual([true, false]);
player.setTextTrackVisibility(false);
player.selectTextTrack(tracks[1]);
expect(getTracksActive()).toEqual([false, true]);
player.setTextTrackVisibility(true);
expect(getTracksActive()).toEqual([false, true]);
});
}); // describe('setTextTrackVisibility')
describe('plays', () => {
it('with external text tracks', async () => {
await player.load('test:sintel_no_text_compiled');
// For some reason, using path-absolute URLs (i.e. without the hostname)
// like this doesn't work on Safari. So manually resolve the URL.
const locationUri = new goog.Uri(location.href);
const partialUri = new goog.Uri('/base/test/test/assets/text-clip.vtt');
const absoluteUri = locationUri.resolve(partialUri);
const newTrack = await player.addTextTrackAsync(
absoluteUri.toString(), 'en', 'subtitles', 'text/vtt');
expect(newTrack.language).toBe('en');
expect(player.getTextTracks()).toEqual([newTrack]);
player.selectTextTrack(newTrack);
expect(player.getTextTracks()[0].active).toBe(true);
});
it('with cea closed captions', async () => {
await player.load('test:cea-708_mp4_compiled');
const textTracks = player.getTextTracks();
expect(textTracks).toBeTruthy();
expect(textTracks.length).toBe(1);
expect(textTracks[0].language).toBe('en');
});
it('at higher playback rates', async () => {
await player.load('test:sintel_compiled');
video.play();
await waiter.waitUntilPlayheadReachesOrFailOnTimeout(video, 1, 10);
// Enabling trick play should change our playback rate to the same rate.
player.trickPlay(2);
expect(video.playbackRate).toBe(2);
// Let playback continue playing for a bit longer.
await shaka.test.Util.delay(2);
// Cancelling trick play should return our playback rate to normal.
player.cancelTrickPlay();
expect(video.playbackRate).toBe(1);
});
// Regression test for #2326.
//
// 1. Construct an instance with a video element.
// 2. Don't call or await attach().
// 3. Call load() with a MIME type, which triggers a check for native
// playback support.
//
// Note that a real playback may use a HEAD request to fetch a MIME type,
// even if one is not specified in load().
it('immediately after construction with MIME type', async () => {
const testSchemeMimeType = 'application/x-test-manifest';
player = new compiledShaka.Player(video);
await player.load('test:sintel_compiled', 0, testSchemeMimeType);
video.play();
await waiter.waitUntilPlayheadReachesOrFailOnTimeout(video, 1, 10);
});
/**
* Gets the language of the active Variant.
* @return {string}
*/
function getActiveLanguage() {
const tracks = player.getVariantTracks().filter((t) => {
return t.active;
});
expect(tracks.length).toBeGreaterThan(0);
return tracks[0].language;
}
}); // describe('plays')
describe('TextDisplayer plugin', () => {
// Simulate the use of an external TextDisplayer plugin.
/** @type {shaka.test.FakeTextDisplayer} */
let textDisplayer;
beforeEach(() => {
textDisplayer = new shaka.test.FakeTextDisplayer();
textDisplayer.isTextVisibleSpy.and.callFake(() => {
return false;
});
textDisplayer.destroySpy.and.returnValue(Promise.resolve());
player.configure('textDisplayFactory', () => textDisplayer);
// Make sure the configuration was taken.
const configuredFactory = player.getConfiguration().textDisplayFactory;
const configuredTextDisplayer = configuredFactory();
expect(configuredTextDisplayer).toBe(textDisplayer);
});
// Regression test for https://github.com/shaka-project/shaka-player/issues/1187
it('does not throw on destroy', async () => {
await player.load('test:sintel_compiled');
video.play();
await waiter.waitUntilPlayheadReachesOrFailOnTimeout(video, 1, 10);
await player.unload();
// Before we fixed #1187, the call to destroy() on textDisplayer was
// renamed in the compiled version and could not be called.
expect(textDisplayer.destroySpy).toHaveBeenCalled();
});
}); // describe('TextDisplayer plugin')
describe('TextAndRoles', () => {
// Regression Test. Makes sure that the language and role fields have been
// properly exported from the player.
it('exports language and roles fields', async () => {
await player.load('test:sintel_compiled');
const languagesAndRoles = player.getTextLanguagesAndRoles();
expect(languagesAndRoles.length).toBeTruthy();
for (const languageAndRole of languagesAndRoles) {
expect(languageAndRole.language).not.toBeUndefined();
expect(languageAndRole.role).not.toBeUndefined();
}
});
}); // describe('TextAndRoles')
describe('streaming event', () => {
// Calling switch early during load() caused a failed assertion in Player
// and the track selection was ignored. Because this bug involved
// interactions between Player and StreamingEngine, it is an integration
// test and not a unit test.
// https://github.com/shaka-project/shaka-player/issues/1119
it('allows early selection of specific tracks', async () => {
/** @type {!jasmine.Spy} */
const streamingListener = jasmine.createSpy('listener');
// Because this is an issue with failed assertions, destroy the existing
// player from the compiled version, and create a new one using the
// uncompiled version. Then we will get assertions.
eventManager.unlisten(player, 'error');
await player.destroy();
player = new shaka.Player(video); // NOTE: MUST BE UNCOMPILED
player.configure({abr: {enabled: false}});
eventManager.listen(player, 'error', Util.spyFunc(onErrorSpy));
// When 'streaming' fires, select the first track explicitly.
player.addEventListener('streaming', Util.spyFunc(streamingListener));
streamingListener.and.callFake(() => {
const tracks = player.getVariantTracks();
player.selectVariantTrack(tracks[0]);
});
// Now load the content.
await player.load('test:sintel');
// When the bug triggers, we fail assertions in Player.
// Make sure the listener was triggered, so that it could trigger the
// code path in this bug.
expect(streamingListener).toHaveBeenCalled();
});
// After fixing the issue above, calling switch early during a second load()
// caused a failed assertion in StreamingEngine, because we did not reset
// switchingPeriods_ in Player. Because this bug involved interactions
// between Player and StreamingEngine, it is an integration test and not a
// unit test.
// https://github.com/shaka-project/shaka-player/issues/1119
it('allows selection of tracks in subsequent loads', async () => {
/** @type {!jasmine.Spy} */
const streamingListener = jasmine.createSpy('listener');
// Because this is an issue with failed assertions, destroy the existing
// player from the compiled version, and create a new one using the
// uncompiled version. Then we will get assertions.
eventManager.unlisten(player, 'error');
await player.destroy();
player = new shaka.Player(video); // NOTE: MUST BE UNCOMPILED
player.configure({abr: {enabled: false}});
eventManager.listen(player, 'error', Util.spyFunc(onErrorSpy));
// This bug only triggers when you do this on the second load.
// So we load one piece of content, then set up the streaming listener
// to change tracks, then we load a second piece of content.
await player.load('test:sintel');
// Give StreamingEngine time to complete all setup and to call back into
// the Player with canSwitch_. If you move on too quickly to the next
// load(), the bug does not reproduce.
await shaka.test.Util.delay(1);
player.addEventListener('streaming', Util.spyFunc(streamingListener));
streamingListener.and.callFake(() => {
const track = player.getVariantTracks()[0];
player.selectVariantTrack(track);
});
// Now load again to trigger the failed assertion.
await player.load('test:sintel');
// When the bug triggers, we fail assertions in StreamingEngine.
// So just make sure the listener was triggered, so that it could
// trigger the code path in this bug.
expect(streamingListener).toHaveBeenCalled();
});
}); // describe('streaming event')
describe('tracks', () => {
// This is a regression test for b/138941217, in which tracks briefly
// vanished during the loading process. On Chromecast devices, where the
// timing is very different from on desktop, this could occur such that
// there were no tracks after load() is resolved.
// This is an integration test so that we can check the behavior of the
// Player against actual platform behavior on all supported platforms.
it('remain available at every stage of loading', async () => {
let tracksFound = false;
/**
* @param {string} when When the check takes place.
*
* Will fail the test if tracks disappear after they first become
* available.
*/
const checkTracks = (when) => {
// If tracks have already been found, expect them to still be found.
const tracksNow = player.getVariantTracks().length != 0;
if (tracksFound) {
expect(tracksNow).withContext(when).toBe(true);
} else {
// If tracks are now found, they should not, at any point during
// the loading process, disappear again.
if (tracksNow) {
tracksFound = true;
}
}
shaka.log.debug(
'checkTracks', when,
'tracksFound=', tracksFound,
'tracksNow=', tracksNow);
};
/** @param {Event} event */
const checkOnEvent = (event) => {
checkTracks(event.type + ' event');
};
// On each of these events, we will notice when tracks first appear, and
// verify that they never disappear at any point in the loading sequence.
eventManager.listen(video, 'canplay', checkOnEvent);
eventManager.listen(video, 'canplaythrough', checkOnEvent);
eventManager.listen(video, 'durationchange', checkOnEvent);
eventManager.listen(video, 'emptied', checkOnEvent);
eventManager.listen(video, 'loadeddata', checkOnEvent);
eventManager.listen(video, 'loadedmetadata', checkOnEvent);
eventManager.listen(video, 'loadstart', checkOnEvent);
eventManager.listen(video, 'pause', checkOnEvent);
eventManager.listen(video, 'play', checkOnEvent);
eventManager.listen(video, 'playing', checkOnEvent);
eventManager.listen(video, 'seeked', checkOnEvent);
eventManager.listen(video, 'seeking', checkOnEvent);
eventManager.listen(video, 'stalled', checkOnEvent);
eventManager.listen(video, 'waiting', checkOnEvent);
eventManager.listen(player, 'trackschanged', checkOnEvent);
const waiter = new shaka.test.Waiter(eventManager)
.setPlayer(player)
.timeoutAfter(10);
const canPlayThrough = waiter.waitForEvent(video, 'canplaythrough');
await player.load('test:sintel_compiled', 5);
shaka.log.debug('load resolved');
// When load is resolved(), tracks should definitely exist.
expect(tracksFound).toBe(true);
// Let the test keep running until we can play through. In the original
// bug, tracks would disappear _after_ load() on some platforms.
await canPlayThrough;
});
}); // describe('tracks')
describe('loading', () => {
// A regression test for Issue #2433.
it('can load very large files', async () => {
// Reset the lazy function, so that it does not remember any chunk size
// that was detected beforehand.
compiledShaka.util.StringUtils.resetFromCharCode();
const oldFromCharCode = String.fromCharCode;
try {
// Replace String.fromCharCode with a version that can only handle very
// small chunks.
// This has to be an old-style function, to use the "arguments" object.
// eslint-disable-next-line no-restricted-syntax
String.fromCharCode = function() {
if (arguments.length > 2000) {
throw new RangeError('Synthetic Range Error');
}
// eslint-disable-next-line prefer-spread
return oldFromCharCode.apply(null, arguments);
};
await player.load('/base/test/test/assets/large_file.mpd');
} finally {
String.fromCharCode = oldFromCharCode;
}
});
});
describe('mediaQualityChanges', () => {
/** @type {!jasmine.Spy} */
let onQualityChange;
/** @type {!shaka.test.Waiter} */
let waiter;
const qualityChange1 = jasmine.objectContaining({
mediaQuality: jasmine.objectContaining({
bandwidth: 1,
codecs: 'mp4a.40.2',
contentType: 'audio',
mimeType: 'audio/mp4',
}),
type: 'mediaqualitychanged',
position: jasmine.any(Number),
});
const qualityChange2 = jasmine.objectContaining({
mediaQuality: jasmine.objectContaining({
bandwidth: 1,
codecs: 'avc1.42c01e',
contentType: 'video',
mimeType: 'video/mp4',
}),
type: 'mediaqualitychanged',
position: jasmine.any(Number),
});
beforeEach(() => {
onQualityChange = jasmine.createSpy('onQualityChange');
// const spyFunc = Util.spyFunc(onQualityChange);
player.addEventListener('mediaqualitychanged',
Util.spyFunc(onQualityChange));
waiter = new shaka.test.Waiter(eventManager)
.setPlayer(player)
.timeoutAfter(10)
.failOnTimeout(true);
});
it('emits audio/video quality changes at start when enabled', async () => {
player.configure('streaming.observeQualityChanges', true);
await player.load('test:sintel_compiled');
video.play();
// Wait for the video to start playback. If it takes longer than 10
// seconds, fail the test.
await waiter.waitForMovementOrFailOnTimeout(video, 10);
expect(onQualityChange).toHaveBeenCalledTimes(2);
expect(onQualityChange).toHaveBeenCalledWith(qualityChange1);
expect(onQualityChange).toHaveBeenCalledWith(qualityChange2);
});
it('does not emit quality changes at start when disabled', async () => {
player.configure('streaming.observeQualityChanges', false);
await player.load('test:sintel_compiled');
video.play();
// Wait for the video to start playback. If it takes longer than 10
// seconds, fail the test.
await waiter.waitForMovementOrFailOnTimeout(video, 10);
expect(onQualityChange).not.toHaveBeenCalled();
});
});
describe('seek range', () => {
// Regression test for Issue #3675.
it('has a reasonable seek range after going from live to VOD', async () => {
const netEngine = player.getNetworkingEngine();
const startTime = Date.now();
netEngine.registerRequestFilter((type, request) => {
if (type != shaka.net.NetworkingEngine.RequestType.MANIFEST) {
return;
}
// Simulate a live stream by providing different manifests over time.
const time = (Date.now() - startTime) / 1000;
const manifestNumber = Math.min(5, Math.floor(0.5 + time / 2));
request.uris = [
'/base/test/test/assets/3675/dash_' + manifestNumber + '.mpd',
];
console.log('getting manifest', request.uris);
});
// Play the stream.
await player.load('/base/test/test/assets/3675/dash_0.mpd');
video.play();
// Wait for the stream to be over.
eventManager.listen(player, 'error', Util.spyFunc(onErrorSpy));
/** @type {shaka.test.Waiter} */
const waiter = new shaka.test.Waiter(eventManager)
.setPlayer(player)
.timeoutAfter(20)
.failOnTimeout(true);
await waiter.waitForEnd(video);
// The stream should have transitioned to VOD by now.
expect(player.isLive()).toBe(false);
// Check that the final seek range is as expected.
const seekRange = player.seekRange();
expect(seekRange.end).toBeCloseTo(14);
});
});
describe('buffering', () => {
const startBuffering = jasmine.objectContaining({buffering: true});
const endBuffering = jasmine.objectContaining({buffering: false});
/** @type {!jasmine.Spy} */
let onBuffering;
/** @type {!shaka.test.Waiter} */
let waiter;
beforeEach(() => {
onBuffering = jasmine.createSpy('onBuffering');
player.addEventListener('buffering', Util.spyFunc(onBuffering));
waiter = new shaka.test.Waiter(eventManager)
.setPlayer(player)
.timeoutAfter(10)
.failOnTimeout(true);
});
it('enters/exits buffering state at start', async () => {
// Set a large rebuffer goal to ensure we can see the buffering before
// we start playing.
player.configure('streaming.rebufferingGoal', 30);
await player.load('test:sintel_long_compiled');
video.pause();
expect(onBuffering).toHaveBeenCalledTimes(1);
expect(onBuffering).toHaveBeenCalledWith(startBuffering);
onBuffering.calls.reset();
await waiter.waitForEvent(player, 'buffering');
expect(onBuffering).toHaveBeenCalledTimes(1);
expect(onBuffering).toHaveBeenCalledWith(endBuffering);
expect(getBufferedAhead()).toBeGreaterThanOrEqual(30);
});
it('enters/exits buffering state while playing', async () => {
player.configure('streaming.rebufferingGoal', 1);
player.configure('streaming.bufferingGoal', 10);
await player.load('test:sintel_long_compiled');
video.pause();
if (player.isBuffering()) {
await waiter.waitForEvent(player, 'buffering');
}
onBuffering.calls.reset();
player.configure('streaming.rebufferingGoal', 30);
video.currentTime = 70;
await waiter.waitForEvent(player, 'buffering');
expect(onBuffering).toHaveBeenCalledTimes(1);
expect(onBuffering).toHaveBeenCalledWith(startBuffering);
onBuffering.calls.reset();
expect(getBufferedAhead()).toBeLessThan(30);
await waiter.waitForEvent(player, 'buffering');
expect(onBuffering).toHaveBeenCalledTimes(1);
expect(onBuffering).toHaveBeenCalledWith(endBuffering);
expect(getBufferedAhead()).toBeGreaterThanOrEqual(30);
});
it('buffers ahead of the playhead', async () => {
player.configure('streaming.bufferingGoal', 10);
await player.load('test:sintel_long_compiled');
video.pause();
await waitUntilBuffered(10);
player.configure('streaming.bufferingGoal', 30);
await waitUntilBuffered(30);
player.configure('streaming.bufferingGoal', 60);
await waitUntilBuffered(60);
await Util.delay(0.2);
expect(getBufferedAhead()).toBeLessThan(70); // 60 + segment_size
// We don't remove buffered content ahead of the playhead, so seek to
// clear the buffer.
player.configure('streaming.bufferingGoal', 10);
video.currentTime = 120;
await waitUntilBuffered(10);
await Util.delay(0.2);
expect(getBufferedAhead()).toBeLessThan(20); // 10 + segment_size
});
it('clears buffer behind playhead', async () => {
player.configure('streaming.bufferingGoal', 30);
player.configure('streaming.bufferBehind', 30);
await player.load('test:sintel_long_compiled');
video.pause();
await waitUntilBuffered(30);
video.currentTime = 20;
await waitUntilBuffered(30);
expect(getBufferedBehind()).toBe(20); // Buffered to start still.
video.currentTime = 50;
await waitUntilBuffered(30);
expect(getBufferedBehind()).toBeLessThan(30);
player.configure('streaming.bufferBehind', 10);
// We only evict content when we append a segment, so increase the
// buffering goal so we append another segment.
player.configure('streaming.bufferingGoal', 40);
await waitUntilBuffered(40);
expect(getBufferedBehind()).toBeLessThanOrEqual(10);
});
function getBufferedAhead() {
const end = shaka.media.TimeRangesUtils.bufferEnd(video.buffered);
if (end == null) {
return 0;
}
return end - video.currentTime;
}
function getBufferedBehind() {
const start = shaka.media.TimeRangesUtils.bufferStart(video.buffered);
if (start == null) {
return 0;
}
return video.currentTime - start;
}
async function waitUntilBuffered(amount) {
for (let i = 0; i < 25; i++) {
// We buffer from an internal segment, so this shouldn't take long to
// buffer.
await Util.delay(0.1); // eslint-disable-line no-await-in-loop
if (getBufferedAhead() >= amount) {
return;
}
}
throw new Error('Timeout waiting to buffer');
}
}); // describe('buffering')
describe('configuration', () => {
it('has the correct number of arguments in compiled callbacks', () => {
// Get the default configuration for both the compiled & uncompiled
// versions for comparison.
const compiledConfig = (new compiledShaka.Player()).getConfiguration();
const uncompiledConfig = (new shaka.Player()).getConfiguration();
compareConfigFunctions(compiledConfig, uncompiledConfig);
/**
* Find all the callbacks in the configuration recursively and compare
* their lengths (number of arguments). We warn the app developer when a
* configured callback has the wrong number of arguments, so our own
* compiled versions must be correct.
*
* @param {Object} compiled
* @param {Object} uncompiled
* @param {string=} basePath The path to this point in the config, for
* logging purposes.
*/
function compareConfigFunctions(compiled, uncompiled, basePath = '') {
for (const key in uncompiled) {
const uncompiledValue = uncompiled[key];
const compiledValue = compiled[key];
const path = basePath + '.' + key;
if (uncompiledValue && uncompiledValue.constructor == Object) {
// This is an anonymous Object, so recurse on it.
compareConfigFunctions(compiledValue, uncompiledValue, path);
} else if (typeof uncompiledValue == 'function') {
// This is a function, so check its length. The uncompiled version
// is considered canonically correct, so we use the uncompiled
// length as the expectation.
shaka.log.debug('[' + path + ']',
compiledValue.length, 'should be', uncompiledValue.length);
expect(compiledValue.length).withContext(path)
.toBe(uncompiledValue.length);
}
}
}
});
}); // describe('configuration')
describe('adaptation', () => {
/** @type {!shaka.test.FakeAbrManager} */
let abrManager;
beforeEach(() => {
abrManager = new shaka.test.FakeAbrManager();
player.configure('abrFactory', () => abrManager);
});
it('fires "adaptation" event', async () => {
const abrEnabled = new Promise((resolve) => {
abrManager.enable.and.callFake(resolve);
});
await player.load('test:sintel_multi_lingual_multi_res_compiled');
expect(abrManager.switchCallback).toBeTruthy();
expect(abrManager.variants.length).toBeGreaterThan(1);
expect(abrManager.chooseIndex).toBe(0);
/** @type {shaka.test.Waiter} */
const waiter = new shaka.test.Waiter(eventManager)
.setPlayer(player)
.timeoutAfter(1)
.failOnTimeout(true);
await waiter.waitForPromise(abrEnabled, 'AbrManager enabled');
const p = waiter.waitForEvent(player, 'adaptation');
abrManager.switchCallback(abrManager.variants[1]);
await expectAsync(p).toBeResolved();
});
it('doesn\'t fire "adaptation" when not changing streams', async () => {
const abrEnabled = new Promise((resolve) => {
abrManager.enable.and.callFake(resolve);
});