-
-
Notifications
You must be signed in to change notification settings - Fork 4.7k
/
VideoResource.ts
387 lines (322 loc) · 10.8 KB
/
VideoResource.ts
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
import { BaseImageResource } from './BaseImageResource';
import { Ticker } from '@pixi/ticker';
import type { Dict } from '@pixi/utils';
export interface IVideoResourceOptions
{
autoLoad?: boolean;
autoPlay?: boolean;
updateFPS?: number;
crossorigin?: boolean | string;
}
export interface IVideoResourceOptionsElement
{
src: string;
mime: string;
}
/**
* Resource type for {@code HTMLVideoElement}.
* @memberof PIXI
*/
export class VideoResource extends BaseImageResource
{
/** Override the source to be the video element. */
public source: HTMLVideoElement;
/**
* `true` to use PIXI.Ticker.shared to auto update the base texture.
* @default true
*/
protected _autoUpdate: boolean;
/**
* `true` if the instance is currently connected to PIXI.Ticker.shared to auto update the base texture.
* @default false
*/
protected _isConnectedToTicker: boolean;
protected _updateFPS: number;
protected _msToNextUpdate: number;
/**
* When set to true will automatically play videos used by this texture once
* they are loaded. If false, it will not modify the playing state.
* @default true
*/
protected autoPlay: boolean;
/**
* Promise when loading.
* @default null
*/
private _load: Promise<VideoResource>;
/** Callback when completed with load. */
private _resolve: (value?: VideoResource | PromiseLike<VideoResource>) => void;
/**
* @param {HTMLVideoElement|object|string|Array<string|object>} source - Video element to use.
* @param {object} [options] - Options to use
* @param {boolean} [options.autoLoad=true] - Start loading the video immediately
* @param {boolean} [options.autoPlay=true] - Start playing video immediately
* @param {number} [options.updateFPS=0] - How many times a second to update the texture from the video.
* Leave at 0 to update at every render.
* @param {boolean} [options.crossorigin=true] - Load image using cross origin
*/
constructor(
source?: HTMLVideoElement | Array<string | IVideoResourceOptionsElement> | string, options?: IVideoResourceOptions
)
{
options = options || {};
if (!(source instanceof HTMLVideoElement))
{
const videoElement = document.createElement('video');
// workaround for https://github.com/pixijs/pixijs/issues/5996
videoElement.setAttribute('preload', 'auto');
videoElement.setAttribute('webkit-playsinline', '');
videoElement.setAttribute('playsinline', '');
if (typeof source === 'string')
{
source = [source];
}
const firstSrc = (source[0] as IVideoResourceOptionsElement).src || source[0] as string;
BaseImageResource.crossOrigin(videoElement, firstSrc, options.crossorigin);
// array of objects or strings
for (let i = 0; i < source.length; ++i)
{
const sourceElement = document.createElement('source');
let { src, mime } = source[i] as IVideoResourceOptionsElement;
src = src || source[i] as string;
const baseSrc = src.split('?').shift().toLowerCase();
const ext = baseSrc.slice(baseSrc.lastIndexOf('.') + 1);
mime = mime || VideoResource.MIME_TYPES[ext] || `video/${ext}`;
sourceElement.src = src;
sourceElement.type = mime;
videoElement.appendChild(sourceElement);
}
// Override the source
source = videoElement;
}
super(source);
this.noSubImage = true;
this._autoUpdate = true;
this._isConnectedToTicker = false;
this._updateFPS = options.updateFPS || 0;
this._msToNextUpdate = 0;
this.autoPlay = options.autoPlay !== false;
this._load = null;
this._resolve = null;
// Bind for listeners
this._onCanPlay = this._onCanPlay.bind(this);
this._onError = this._onError.bind(this);
if (options.autoLoad !== false)
{
this.load();
}
}
/**
* Trigger updating of the texture.
* @param _deltaTime - time delta since last tick
*/
update(_deltaTime = 0): void
{
if (!this.destroyed)
{
// account for if video has had its playbackRate changed
const elapsedMS = Ticker.shared.elapsedMS * (this.source as HTMLVideoElement).playbackRate;
this._msToNextUpdate = Math.floor(this._msToNextUpdate - elapsedMS);
if (!this._updateFPS || this._msToNextUpdate <= 0)
{
super.update(/* deltaTime*/);
this._msToNextUpdate = this._updateFPS ? Math.floor(1000 / this._updateFPS) : 0;
}
}
}
/**
* Start preloading the video resource.
* @returns {Promise<void>} Handle the validate event
*/
load(): Promise<VideoResource>
{
if (this._load)
{
return this._load;
}
const source = this.source as HTMLVideoElement;
if ((source.readyState === source.HAVE_ENOUGH_DATA || source.readyState === source.HAVE_FUTURE_DATA)
&& source.width && source.height)
{
(source as any).complete = true;
}
source.addEventListener('play', this._onPlayStart.bind(this));
source.addEventListener('pause', this._onPlayStop.bind(this));
if (!this._isSourceReady())
{
source.addEventListener('canplay', this._onCanPlay);
source.addEventListener('canplaythrough', this._onCanPlay);
source.addEventListener('error', this._onError, true);
}
else
{
this._onCanPlay();
}
this._load = new Promise((resolve): void =>
{
if (this.valid)
{
resolve(this);
}
else
{
this._resolve = resolve;
source.load();
}
});
return this._load;
}
/**
* Handle video error events.
* @param event
*/
private _onError(event: ErrorEvent): void
{
(this.source as HTMLVideoElement).removeEventListener('error', this._onError, true);
this.onError.emit(event);
}
/**
* Returns true if the underlying source is playing.
* @returns - True if playing.
*/
private _isSourcePlaying(): boolean
{
const source = this.source as HTMLVideoElement;
return (!source.paused && !source.ended && this._isSourceReady());
}
/**
* Returns true if the underlying source is ready for playing.
* @returns - True if ready.
*/
private _isSourceReady(): boolean
{
const source = this.source as HTMLVideoElement;
return source.readyState > 2;
}
/** Runs the update loop when the video is ready to play. */
private _onPlayStart(): void
{
// Just in case the video has not received its can play even yet..
if (!this.valid)
{
this._onCanPlay();
}
if (this.autoUpdate && !this._isConnectedToTicker)
{
Ticker.shared.add(this.update, this);
this._isConnectedToTicker = true;
}
}
/** Fired when a pause event is triggered, stops the update loop. */
private _onPlayStop(): void
{
if (this._isConnectedToTicker)
{
Ticker.shared.remove(this.update, this);
this._isConnectedToTicker = false;
}
}
/** Fired when the video is loaded and ready to play. */
private _onCanPlay(): void
{
const source = this.source as HTMLVideoElement;
source.removeEventListener('canplay', this._onCanPlay);
source.removeEventListener('canplaythrough', this._onCanPlay);
const valid = this.valid;
this.resize(source.videoWidth, source.videoHeight);
// prevent multiple loaded dispatches..
if (!valid && this._resolve)
{
this._resolve(this);
this._resolve = null;
}
if (this._isSourcePlaying())
{
this._onPlayStart();
}
else if (this.autoPlay)
{
source.play();
}
}
/** Destroys this texture. */
dispose(): void
{
if (this._isConnectedToTicker)
{
Ticker.shared.remove(this.update, this);
this._isConnectedToTicker = false;
}
const source = this.source as HTMLVideoElement;
if (source)
{
source.removeEventListener('error', this._onError, true);
source.pause();
source.src = '';
source.load();
}
super.dispose();
}
/** Should the base texture automatically update itself, set to true by default. */
get autoUpdate(): boolean
{
return this._autoUpdate;
}
set autoUpdate(value: boolean)
{
if (value !== this._autoUpdate)
{
this._autoUpdate = value;
if (!this._autoUpdate && this._isConnectedToTicker)
{
Ticker.shared.remove(this.update, this);
this._isConnectedToTicker = false;
}
else if (this._autoUpdate && !this._isConnectedToTicker && this._isSourcePlaying())
{
Ticker.shared.add(this.update, this);
this._isConnectedToTicker = true;
}
}
}
/**
* How many times a second to update the texture from the video. Leave at 0 to update at every render.
* A lower fps can help performance, as updating the texture at 60fps on a 30ps video may not be efficient.
*/
get updateFPS(): number
{
return this._updateFPS;
}
set updateFPS(value: number)
{
if (value !== this._updateFPS)
{
this._updateFPS = value;
}
}
/**
* Used to auto-detect the type of resource.
* @param {*} source - The source object
* @param {string} extension - The extension of source, if set
* @returns {boolean} `true` if video source
*/
static test(source: unknown, extension?: string): source is HTMLVideoElement
{
return (globalThis.HTMLVideoElement && source instanceof HTMLVideoElement)
|| VideoResource.TYPES.includes(extension);
}
/**
* List of common video file extensions supported by VideoResource.
* @readonly
*/
static TYPES: Array<string> = ['mp4', 'm4v', 'webm', 'ogg', 'ogv', 'h264', 'avi', 'mov'];
/**
* Map of video MIME types that can't be directly derived from file extensions.
* @readonly
*/
static MIME_TYPES: Dict<string> = {
ogv: 'video/ogg',
mov: 'video/quicktime',
m4v: 'video/mp4',
};
}