-
-
Notifications
You must be signed in to change notification settings - Fork 29
/
videojs-ogvjs.js
764 lines (689 loc) · 15.3 KB
/
videojs-ogvjs.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
/* eslint-disable no-prototype-builtins */
/**
* videojs-ogvjs
* @version 1.0.0
* @copyright 2023 Huong Nguyen <huongnv13@gmail.com>
* @license MIT
*/
/**
* source: https://github.com/HuongNV13/videojs-ogvjs/releases/tag/v1.0.0
* commit-id: https://github.com/HuongNV13/videojs-ogvjs/commit/76508fae090b8db1c3ea19603eace169cbe9f5ab
* date retrieved: 2024-07-02
*/
import videojs from 'video.js'
import { OGVCompat, OGVLoader, OGVPlayer } from 'ogv'
const Tech = videojs.getComponent('Tech')
const androidOS = 'Android'
const iPhoneOS = 'iPhoneOS'
const iPadOS = 'iPadOS'
const otherOS = 'Other'
/**
* Object.defineProperty but "lazy", which means that the value is only set after
* it retrieved the first time, rather than being set right away.
*
* @param {Object} obj the object to set the property on.
* @param {string} key the key for the property to set.
* @param {Function} getValue the function used to get the value when it is needed.
* @param {boolean} setter whether a setter should be allowed or not.
*/
const defineLazyProperty = (obj, key, getValue, setter = true) => {
const set = (value) => {
Object.defineProperty(obj, key, { value, enumerable: true, writable: true })
}
const options = {
configurable: true,
enumerable: true,
get() {
const value = getValue()
set(value)
return value
}
}
if (setter) {
options.set = set
}
return Object.defineProperty(obj, key, options)
}
/**
* Get the device's OS.
*
* @return {string} Device's OS.
*/
const getDeviceOS = () => {
const ua = navigator.userAgent
if (/android/i.test(ua)) {
return androidOS
} else if (/iPad|iPhone|iPod/.test(ua)) {
return iPhoneOS
} else if (navigator.platform === 'MacIntel' && navigator.maxTouchPoints > 1) {
return iPadOS
}
return otherOS
}
/**
* OgvJS Media Controller - Wrapper for ogv.js Media API
*
* @mixes Tech~SourceHandlerAdditions
* @extends Tech
*/
class OgvJS extends Tech {
/**
* Create an instance of this Tech.
*
* @param {Object} [options] The key/value store of player options.
* @param {Component~ReadyCallback} ready Callback function to call when the `OgvJS` Tech is ready.
*/
constructor(options, ready) {
super(options, ready)
this.el_.src = options.source.src
OgvJS.setIfAvailable(this.el_, 'autoplay', options.autoplay)
OgvJS.setIfAvailable(this.el_, 'loop', options.loop)
OgvJS.setIfAvailable(this.el_, 'poster', options.poster)
OgvJS.setIfAvailable(this.el_, 'preload', options.preload)
this.on('loadedmetadata', () => {
if (getDeviceOS() === iPhoneOS) {
// iPhoneOS add some inline styles to the canvas, we need to remove it.
const canvas = this.el_.getElementsByTagName('canvas')[0]
canvas.style.removeProperty('width')
canvas.style.removeProperty('margin')
}
})
this.triggerReady()
}
/**
* Create the 'OgvJS' Tech's DOM element.
*
* @return {Element} The element that gets created.
*/
createEl() {
const options = this.options_
if (options.base) {
OGVLoader.base = options.base
} else {
throw new Error('Please specify the base for the ogv.js library')
}
const el = new OGVPlayer(options)
el.className += ' vjs-tech'
options.tag = el
return el
}
/**
* Start playback
*
* @method play
*/
play() {
this.el_.play()
}
/**
* Get the current playback speed.
*
* @return {number}
* @method playbackRate
*/
playbackRate() {
return this.el_.playbackRate || 1
}
/**
* Set the playback speed.
*
* @param {number} val Speed for the player to play.
* @method setPlaybackRate
*/
setPlaybackRate(val) {
if (this.el_.hasOwnProperty('playbackRate')) {
this.el_.playbackRate = val
}
}
/**
* Returns a TimeRanges object that represents the ranges of the media resource that the user agent has played.
*
* @return {TimeRangeObject} the range of points on the media timeline that has been reached through normal playback
*/
played() {
return this.el_.played
}
/**
* Pause playback
*
* @method pause
*/
pause() {
this.el_.pause()
}
/**
* Is the player paused or not.
*
* @return {boolean}
* @method paused
*/
paused() {
return this.el_.paused
}
/**
* Get current playing time.
*
* @return {number}
* @method currentTime
*/
currentTime() {
return this.el_.currentTime
}
/**
* Set current playing time.
*
* @param {number} seconds Current time of audio/video.
* @method setCurrentTime
*/
setCurrentTime(seconds) {
try {
this.el_.currentTime = seconds
} catch (e) {
videojs.log(e, 'Media is not ready. (Video.JS)')
}
}
/**
* Get media's duration.
*
* @return {number}
* @method duration
*/
duration() {
if (this.el_.duration && this.el_.duration !== Infinity) {
return this.el_.duration
}
return 0
}
/**
* Get a TimeRange object that represents the intersection
* of the time ranges for which the user agent has all
* relevant media.
*
* @return {TimeRangeObject}
* @method buffered
*/
buffered() {
return this.el_.buffered
}
/**
* Get current volume level.
*
* @return {number}
* @method volume
*/
volume() {
return this.el_.hasOwnProperty('volume') ? this.el_.volume : 1
}
/**
* Set current playing volume level.
*
* @param {number} percentAsDecimal Volume percent as a decimal.
* @method setVolume
*/
setVolume(percentAsDecimal) {
// Apple does not allow iOS and iPadOS devices to set the volume on UI.
if (
getDeviceOS() !== iPhoneOS &&
getDeviceOS() !== iPadOS &&
this.el_.hasOwnProperty('volume')
) {
this.el_.volume = percentAsDecimal
}
}
/**
* Is the player muted or not.
*
* @return {boolean}
* @method muted
*/
muted() {
return this.el_.muted
}
/**
* Mute the player.
*
* @param {boolean} muted True to mute the player.
*/
setMuted(muted) {
this.el_.muted = !!muted
}
/**
* Is the player muted by default or not.
*
* @return {boolean}
* @method defaultMuted
*/
defaultMuted() {
return this.el_.defaultMuted || false
}
/**
* Get the player width.
*
* @return {number}
* @method width
*/
width() {
return this.el_.offsetWidth
}
/**
* Get the player height.
*
* @return {number}
* @method height
*/
height() {
return this.el_.offsetHeight
}
/**
* Get the video width.
*
* @return {number}
* @method videoWidth
*/
videoWidth() {
return this.el_.videoWidth
}
/**
* Get the video height.
*
* @return {number}
* @method videoHeight
*/
videoHeight() {
return this.el_.videoHeight
}
/**
* Get/set media source.
*
* @param {Object=} src Source object
* @return {Object}
* @method src
*/
src(src) {
if (typeof src === 'undefined') {
return this.el_.src
}
this.el_.src = src
}
/**
* Load the media into the player.
*
* @method load
*/
load() {
this.el_.load()
}
/**
* Get current media source.
*
* @return {Object}
* @method currentSrc
*/
currentSrc() {
if (this.currentSource_) {
return this.currentSource_.src
}
return this.el_.currentSrc
}
/**
* Get media poster URL.
*
* @return {string}
* @method poster
*/
poster() {
return this.el_.poster
}
/**
* Set media poster URL.
*
* @param {string} url the poster image's url.
* @method
*/
setPoster(url) {
this.el_.poster = url
}
/**
* Is the media preloaded or not.
*
* @return {string}
* @method preload
*/
preload() {
return this.el_.preload || 'none'
}
/**
* Set the media preload method.
*
* @param {string} val Value for preload attribute.
* @method setPreload
*/
setPreload(val) {
if (this.el_.hasOwnProperty('preload')) {
this.el_.preload = val
}
}
/**
* Is the media auto-played or not.
*
* @return {boolean}
* @method autoplay
*/
autoplay() {
return this.el_.autoplay || false
}
/**
* Set media autoplay method.
*
* @param {boolean} val Value for autoplay attribute.
* @method setAutoplay
*/
setAutoplay(val) {
if (this.el_.hasOwnProperty('autoplay')) {
this.el_.autoplay = !!val
}
}
/**
* Does the media has controls or not.
*
* @return {boolean}
* @method controls
*/
controls() {
return this.el_.controls || false
}
/**
* Set the media controls method.
*
* @param {boolean} val Value for controls attribute.
* @method setControls
*/
setControls(val) {
if (this.el_.hasOwnProperty('controls')) {
this.el_.controls = !!val
}
}
/**
* Is the media looped or not.
*
* @return {boolean}
* @method loop
*/
loop() {
return this.el_.loop || false
}
/**
* Set the media loop method.
*
* @param {boolean} val Value for loop attribute.
* @method setLoop
*/
setLoop(val) {
if (this.el_.hasOwnProperty('loop')) {
this.el_.loop = !!val
}
}
/**
* Get a TimeRanges object that represents the
* ranges of the media resource to which it is possible
* for the user agent to seek.
*
* @return {TimeRangeObject}
* @method seekable
*/
seekable() {
return this.el_.seekable
}
/**
* Is player in the "seeking" state or not.
*
* @return {boolean}
* @method seeking
*/
seeking() {
return this.el_.seeking
}
/**
* Is the media ended or not.
*
* @return {boolean}
* @method ended
*/
ended() {
return this.el_.ended
}
/**
* Get the current state of network activity
* NETWORK_EMPTY (numeric value 0)
* NETWORK_IDLE (numeric value 1)
* NETWORK_LOADING (numeric value 2)
* NETWORK_NO_SOURCE (numeric value 3)
*
* @return {number}
* @method networkState
*/
networkState() {
return this.el_.networkState
}
/**
* Get the current state of the player.
* HAVE_NOTHING (numeric value 0)
* HAVE_METADATA (numeric value 1)
* HAVE_CURRENT_DATA (numeric value 2)
* HAVE_FUTURE_DATA (numeric value 3)
* HAVE_ENOUGH_DATA (numeric value 4)
*
* @return {number}
* @method readyState
*/
readyState() {
return this.el_.readyState
}
/**
* Does the player support native fullscreen mode or not. (Mobile devices)
*
* @return {boolean}
*/
supportsFullScreen() {
// iOS devices have some problem with HTML5 fullscreen api so we need to fallback to fullWindow mode.
return false
}
/**
* Get media player error.
*
* @return {string}
* @method error
*/
error() {
return this.el_.error
}
}
/**
* List of available events of the media player.
*
* @private
* @type {Array}
*/
OgvJS.Events = [
'loadstart',
'suspend',
'abort',
'error',
'emptied',
'stalled',
'loadedmetadata',
'loadeddata',
'canplay',
'canplaythrough',
'playing',
'waiting',
'seeking',
'seeked',
'ended',
'durationchange',
'timeupdate',
'progress',
'play',
'pause',
'ratechange',
'resize',
'volumechange'
]
/**
* Set the value for the player is it has that property.
*
* @param {Element} el
* @param {string} name
* @param value
*/
OgvJS.setIfAvailable = (el, name, value) => {
if (el.hasOwnProperty(name)) {
el[name] = value
}
}
/**
* Check if browser/device is supported by Ogv.JS.
*
* @return {boolean}
*/
OgvJS.isSupported = () => {
return OGVCompat.supported('OGVPlayer')
}
/**
* Check if the tech can support the given type.
*
* @param {string} type The mimetype to check
* @return {string} 'probably', 'maybe', or '' (empty string)
*/
OgvJS.canPlayType = (type) => {
return type.indexOf('/ogg') !== -1 || type.indexOf('/webm') ? 'maybe' : ''
}
/**
* Check if the tech can support the given source
*
* @param srcObj The source object
* @return {string} The options passed to the tech
*/
OgvJS.canPlaySource = (srcObj) => {
return OgvJS.canPlayType(srcObj.type)
}
/**
* Check if the volume can be changed in this browser/device.
* Volume cannot be changed in a lot of mobile devices.
* Specifically, it can't be changed on iOS and iPadOS.
*
* @return {boolean} True if volume can be controlled.
*/
OgvJS.canControlVolume = () => {
if (getDeviceOS() === iPhoneOS || getDeviceOS() === iPadOS) {
return false
}
const p = new OGVPlayer()
return p.hasOwnProperty('volume')
}
/**
* Check if the volume can be muted in this browser/device.
*
* @return {boolean} True if volume can be muted.
*/
OgvJS.canMuteVolume = () => {
return true
}
/**
* Check if the playback rate can be changed in this browser/device.
*
* @return {boolean} True if playback rate can be controlled.
*/
OgvJS.canControlPlaybackRate = () => {
return true
}
/**
* Check to see if native 'TextTracks' are supported by this browser/device.
*
* @return {boolean} True if native 'TextTracks' are supported.
*/
OgvJS.supportsNativeTextTracks = () => {
return false
}
/**
* Check if the fullscreen resize is supported by this browser/device.
*
* @return {boolean} True if the fullscreen resize is supported.
*/
OgvJS.supportsFullscreenResize = () => {
return true
}
/**
* Check if the progress events is supported by this browser/device.
*
* @return {boolean} True if the progress events is supported.
*/
OgvJS.supportsProgressEvents = () => {
return true
}
/**
* Check if the time update events is supported by this browser/device.
*
* @return {boolean} True if the time update events is supported.
*/
OgvJS.supportsTimeupdateEvents = () => {
return true
}
/**
* Boolean indicating whether the 'OgvJS' tech supports volume control.
*
* @type {boolean}
* @default {@link OgvJS.canControlVolume}
*/
/**
* Boolean indicating whether the 'OgvJS' tech supports muting volume.
*
* @type {boolean}
* @default {@link OgvJS.canMuteVolume}
*/
/**
* Boolean indicating whether the 'OgvJS' tech supports changing the speed at which the media plays.
* Examples:
* - Set player to play 2x (twice) as fast.
* - Set player to play 0.5x (half) as fast.
*
* @type {boolean}
* @default {@link OgvJS.canControlPlaybackRate}
*/
/**
* Boolean indicating whether the 'OgvJS' tech currently supports native 'TextTracks'.
*
* @type {boolean}
* @default {@link OgvJS.supportsNativeTextTracks}
*/
/**
* Boolean indicating whether the 'OgvJS' tech currently supports fullscreen resize.
*
* @type {boolean}
* @default {@link OgvJS.supportsFullscreenResize}
*/
/**
* Boolean indicating whether the 'OgvJS' tech currently supports progress events.
*
* @type {boolean}
* @default {@link OgvJS.supportsProgressEvents}
*/
/**
* Boolean indicating whether the 'OgvJS' tech currently supports time update events.
*
* @type {boolean}
* @default {@link OgvJS.supportsTimeupdateEvents}
*/
;[
['featuresVolumeControl', 'canControlVolume'],
['featuresMuteControl', 'canMuteVolume'],
['featuresPlaybackRate', 'canControlPlaybackRate'],
['featuresNativeTextTracks', 'supportsNativeTextTracks'],
['featuresFullscreenResize', 'supportsFullscreenResize'],
['featuresProgressEvents', 'supportsProgressEvents'],
['featuresTimeupdateEvents', 'supportsTimeupdateEvents']
].forEach(([key, fn]) => {
defineLazyProperty(OgvJS.prototype, key, () => OgvJS[fn](), true)
})
Tech.registerTech('ogvjs', OgvJS)
export { OgvJS as default }