BlueGit

timfa filemanager

Merge fix/image-subtitle-prefetch-cancellation

timfa Tim Falken · pushed by timfa

Authored 2026-05-24 · 5 months ago

Hash
21c159a80dcc2cf1163d1d30da19df7673a27511
4 files changed +387 −73
.github/technical-reference.md +1 −1
@@ -160,7 +160,7 @@
160 160 ## public/shared-video-player.js
161 161 - applyDefaultTextTrackPrefs() - Writes the default Video.js caption override settings (transparent background, uniform edge style) so all streamed players start from the same text-track baseline.
162 162 - bindTrackPrefs(player, prefs, savePrefs) - Restores subtitle/audio track selections by track name and persists later track changes; shared by the authenticated player and the share page so both resolve track matches the same way.
163 - bindImageSubtitleOverlay(player, videojs, prefs, session, opts) - Adds the shared IM button/menu/overlay for bitmap subtitle tracks, restores saved image-subtitle selections, fetches rendered frames through a caller-supplied request builder, prefetches lookahead subtitle frames (default 15 seconds, bounded to 30 seconds max) to reduce event-boundary lag, and disables the track after the first hard failure.
163 - bindImageSubtitleOverlay(player, videojs, prefs, session, opts) - Adds the shared IM button/menu/overlay for bitmap subtitle tracks, restores saved image-subtitle selections, fetches rendered frames through a caller-supplied request builder, keeps a separate rolling lookahead-prefetch worker alive across timeupdates (including gaps where no subtitle is currently visible), aborts stale current/prefetch fetches on seek/track-switch/dispose, and disables the track after the first hard failure.
164 164 - configureVideoJsBuffering(videojs, opts) - Applies the long forward-buffer settings used for file playback when VHS exposes those knobs.
165 165 - ensureVideoPlaybackUi(player, durationSeconds) - Forces file streams into VOD UI mode, normalises the reported duration, stops live-tracker state, and hides the live badge when present.
166 166
@@ -160,7 +160,7 @@
160## public/shared-video-player.js
160## public/shared-video-player.js
161- applyDefaultTextTrackPrefs() - Writes the default Video.js caption override settings (transparent background, uniform edge style) so all streamed players start from the same text-track baseline.
161- applyDefaultTextTrackPrefs() - Writes the default Video.js caption override settings (transparent background, uniform edge style) so all streamed players start from the same text-track baseline.
162- bindTrackPrefs(player, prefs, savePrefs) - Restores subtitle/audio track selections by track name and persists later track changes; shared by the authenticated player and the share page so both resolve track matches the same way.
162- bindTrackPrefs(player, prefs, savePrefs) - Restores subtitle/audio track selections by track name and persists later track changes; shared by the authenticated player and the share page so both resolve track matches the same way.
163- bindImageSubtitleOverlay(player, videojs, prefs, session, opts) - Adds the shared IM button/menu/overlay for bitmap subtitle tracks, restores saved image-subtitle selections, fetches rendered frames through a caller-supplied request builder, prefetches lookahead subtitle frames (default 15 seconds, bounded to 30 seconds max) to reduce event-boundary lag, and disables the track after the first hard failure.
163- bindImageSubtitleOverlay(player, videojs, prefs, session, opts) - Adds the shared IM button/menu/overlay for bitmap subtitle tracks, restores saved image-subtitle selections, fetches rendered frames through a caller-supplied request builder, keeps a separate rolling lookahead-prefetch worker alive across timeupdates (including gaps where no subtitle is currently visible), aborts stale current/prefetch fetches on seek/track-switch/dispose, and disables the track after the first hard failure.
164- configureVideoJsBuffering(videojs, opts) - Applies the long forward-buffer settings used for file playback when VHS exposes those knobs.
164- configureVideoJsBuffering(videojs, opts) - Applies the long forward-buffer settings used for file playback when VHS exposes those knobs.
165- ensureVideoPlaybackUi(player, durationSeconds) - Forces file streams into VOD UI mode, normalises the reported duration, stops live-tracker state, and hides the live badge when present.
165- ensureVideoPlaybackUi(player, durationSeconds) - Forces file streams into VOD UI mode, normalises the reported duration, stops live-tracker state, and hides the live badge when present.
166
166
.github/tests.md +5 −0
@@ -84,6 +84,11 @@
84 84
85 85 ---
86 86
87 ## `test/shared-video-player.test.js`
88 - `shared image subtitle prefetching`
89
90 ---
91
87 92 ## `test/thumbnail-cache.test.js`
88 93 - `thumbnail cache worker`
89 94
@@ -84,6 +84,11 @@
84
84
85---
85---
86
86
87## `test/shared-video-player.test.js`
88- `shared image subtitle prefetching`
89
90---
91
87## `test/thumbnail-cache.test.js`
92## `test/thumbnail-cache.test.js`
88- `thumbnail cache worker`
93- `thumbnail cache worker`
89
94
public/shared-video-player.js +154 −72
@@ -191,7 +191,6 @@
191 191 const trackByStreamIndex = new Map(imageTracks.map((track) => [track.streamIndex, track]));
192 192 let selectedStreamIndex = null;
193 193 let menuOpen = false;
194 let requestToken = 0;
195 194 let activeBucket = -1;
196 195 let activeObjectUrl = null;
197 196 let overlayEl = null;
@@ -200,7 +199,64 @@
200 199 let buttonEl = null;
201 200 let trackDisabled = false;
202 201 let failureNotified = false;
203 let lastPrefetchedBucket = -1;
202 let lifecycleToken = 0;
203 let currentFrameToken = 0;
204 let currentFrameAbortController = null;
205 let prefetchWorkerToken = 0;
206 let prefetchAbortController = null;
207 let prefetchPromise = null;
208 let prefetchTargetTimeSeconds = -1;
209 let prefetchedThroughTimeSeconds = -1;
210
211 const createAbortController = () =>
212 {
213 if (typeof AbortController !== 'function') return null;
214 return new AbortController();
215 };
216
217 const abortController = (controller) =>
218 {
219 if (!controller || typeof controller.abort !== 'function') return;
220 try
221 {
222 controller.abort();
223 } catch
224 {
225 // Ignore abort races during teardown.
226 }
227 };
228
229 const isAbortError = (error) =>
230 {
231 return !!(error && typeof error === 'object' && error.name === 'AbortError');
232 };
233
234 const cancelCurrentFrameRequest = () =>
235 {
236 currentFrameToken++;
237 abortController(currentFrameAbortController);
238 currentFrameAbortController = null;
239 };
240
241 const cancelPrefetchRequests = ({ resetProgress = false } = {}) =>
242 {
243 prefetchWorkerToken++;
244 abortController(prefetchAbortController);
245 prefetchAbortController = null;
246 prefetchPromise = null;
247 if (resetProgress)
248 {
249 prefetchTargetTimeSeconds = -1;
250 prefetchedThroughTimeSeconds = -1;
251 }
252 };
253
254 const resetRequestState = () =>
255 {
256 lifecycleToken++;
257 cancelCurrentFrameRequest();
258 cancelPrefetchRequests({ resetProgress: true });
259 };
204 260
205 261 const closeObjectUrl = () =>
206 262 {
@@ -278,6 +334,7 @@
278 334 trackDisabled = true;
279 335 selectedStreamIndex = null;
280 336 activeBucket = -1;
337 resetRequestState();
281 338 hideOverlay();
282 339 updateButtonState();
283 340 updateMenuState();
@@ -299,7 +356,7 @@
299 356 failureNotified = false;
300 357 selectedStreamIndex = nextStreamIndex;
301 358 activeBucket = -1;
302 lastPrefetchedBucket = -1;
359 resetRequestState();
303 360 hideOverlay();
304 361 updateButtonState();
305 362 updateMenuState();
@@ -311,6 +368,84 @@
311 368 }
312 369 };
313 370
371 const queueLookaheadPrefetch = (currentTime, { reset = false } = {}) =>
372 {
373 if (selectedStreamIndex === null) return;
374 if (trackDisabled) return;
375 if (lookaheadSeconds <= 0) return;
376
377 const startTime = currentTime + IMAGE_SUBTITLE_PREFETCH_STEP_SECONDS;
378 const endTime = currentTime + lookaheadSeconds;
379 if (!Number.isFinite(startTime) || !Number.isFinite(endTime) || endTime <= startTime) return;
380
381 if (reset || prefetchedThroughTimeSeconds < 0 || prefetchedThroughTimeSeconds < currentTime - IMAGE_SUBTITLE_PREFETCH_STEP_SECONDS)
382 {
383 cancelPrefetchRequests({ resetProgress: true });
384 prefetchedThroughTimeSeconds = currentTime;
385 }
386
387 prefetchTargetTimeSeconds = Math.max(prefetchTargetTimeSeconds, endTime);
388 if (prefetchPromise) return;
389
390 const workerToken = ++prefetchWorkerToken;
391 const workerLifecycleToken = lifecycleToken;
392 const controller = createAbortController();
393 prefetchAbortController = controller;
394
395 prefetchPromise = (async () =>
396 {
397 while (true)
398 {
399 if (selectedStreamIndex === null || trackDisabled) return;
400 if (workerToken !== prefetchWorkerToken || workerLifecycleToken !== lifecycleToken) return;
401
402 const nextTime = prefetchedThroughTimeSeconds < 0
403 ? startTime
404 : prefetchedThroughTimeSeconds + IMAGE_SUBTITLE_PREFETCH_STEP_SECONDS;
405 if (!Number.isFinite(nextTime) || nextTime > prefetchTargetTimeSeconds + 1e-6) return;
406
407 const request = buildFrameRequest({
408 streamIndex: selectedStreamIndex,
409 currentTime: nextTime,
410 session,
411 });
412 if (!request || !request.url) return;
413
414 try
415 {
416 const res = await fetch(request.url, {
417 method: request.method || 'GET',
418 headers: request.headers,
419 credentials: request.credentials,
420 signal: controller ? controller.signal : undefined,
421 });
422
423 if (workerToken !== prefetchWorkerToken || workerLifecycleToken !== lifecycleToken) return;
424 if (res.status === 204)
425 {
426 const frameStatus = String(res.headers.get('X-Subtitle-Frame-Status') || '').toLowerCase();
427 if (frameStatus === 'error') return;
428 prefetchedThroughTimeSeconds = nextTime;
429 continue;
430 }
431
432 if (!res.ok) return;
433 await res.arrayBuffer();
434 prefetchedThroughTimeSeconds = nextTime;
435 } catch (error)
436 {
437 if (isAbortError(error)) return;
438 return;
439 }
440 }
441 })().finally(() =>
442 {
443 if (workerToken !== prefetchWorkerToken) return;
444 prefetchAbortController = null;
445 prefetchPromise = null;
446 });
447 };
448
314 449 const refreshFrame = async (force = false) =>
315 450 {
316 451 if (selectedStreamIndex === null) return;
@@ -324,7 +459,13 @@
324 459 if (!force && bucket === activeBucket) return;
325 460 activeBucket = bucket;
326 461
327 const token = ++requestToken;
462 const refreshLifecycleToken = lifecycleToken;
463 cancelCurrentFrameRequest();
464 if (force) cancelPrefetchRequests({ resetProgress: true });
465
466 const token = ++currentFrameToken;
467 const controller = createAbortController();
468 currentFrameAbortController = controller;
328 469 const request = buildFrameRequest({
329 470 streamIndex: selectedStreamIndex,
330 471 currentTime,
@@ -343,15 +484,17 @@
343 484 method: request.method || 'GET',
344 485 headers: request.headers,
345 486 credentials: request.credentials,
487 signal: controller ? controller.signal : undefined,
346 488 });
347 489
348 if (token !== requestToken) return;
490 if (token !== currentFrameToken || refreshLifecycleToken !== lifecycleToken) return;
349 491
350 492 if (res.status === 204)
351 493 {
352 494 const frameStatus = String(res.headers.get('X-Subtitle-Frame-Status') || '').toLowerCase();
353 495 hideOverlay();
354 496 if (frameStatus === 'error') disableTrack();
497 else queueLookaheadPrefetch(currentTime, { reset: force });
355 498 return;
356 499 }
357 500
@@ -362,7 +505,7 @@
362 505 }
363 506
364 507 const blob = await res.blob();
365 if (token !== requestToken) return;
508 if (token !== currentFrameToken || refreshLifecycleToken !== lifecycleToken) return;
366 509
367 510 if (!blob || blob.size === 0)
368 511 {
@@ -398,78 +541,17 @@
398 541 overlayEl.style.display = 'block';
399 542 overlayImgEl.style.display = 'block';
400 543
401 if (lookaheadSeconds > 0)
402 {
403 const currentBucket = Math.floor(currentTime * 4);
404 if (force || currentBucket !== lastPrefetchedBucket)
405 {
406 lastPrefetchedBucket = currentBucket;
407 void prefetchLookaheadFrames(currentTime, currentBucket, token);
408 }
409 }
410 } catch
544 queueLookaheadPrefetch(currentTime, { reset: force });
545 } catch (error)
411 546 {
412 if (token === requestToken) disableTrack();
413 }
414 };
415
416 const prefetchLookaheadFrames = async (currentTime, currentBucket, token) =>
417 {
418 if (selectedStreamIndex === null) return;
419 if (trackDisabled) return;
420 if (token !== requestToken) return;
421
422 const startTime = currentTime + IMAGE_SUBTITLE_PREFETCH_STEP_SECONDS;
423 const endTime = currentTime + lookaheadSeconds;
424 if (!Number.isFinite(startTime) || !Number.isFinite(endTime) || endTime <= startTime) return;
425
426 const prefetchedBuckets = new Set([currentBucket]);
427 for (let t = startTime; t <= endTime + 1e-6; t += IMAGE_SUBTITLE_PREFETCH_STEP_SECONDS)
428 {
429 if (token !== requestToken) return;
430 if (selectedStreamIndex === null || trackDisabled) return;
431
432 const bucket = Math.floor(t * 4);
433 if (prefetchedBuckets.has(bucket)) continue;
434 prefetchedBuckets.add(bucket);
435
436 const request = buildFrameRequest({
437 streamIndex: selectedStreamIndex,
438 currentTime: t,
439 session,
440 });
441 if (!request || !request.url) return;
442
443 try
444 {
445 const res = await fetch(request.url, {
446 method: request.method || 'GET',
447 headers: request.headers,
448 credentials: request.credentials,
449 });
450
451 if (token !== requestToken) return;
452 if (res.status === 204)
453 {
454 const frameStatus = String(res.headers.get('X-Subtitle-Frame-Status') || '').toLowerCase();
455 if (frameStatus === 'error') return;
456 continue;
457 }
458
459 if (!res.ok) return;
460 // Ensure body is fully consumed so the browser can reuse connections.
461 await res.arrayBuffer();
462 } catch
463 {
464 // Best-effort prefetch; avoid disrupting active subtitle rendering.
465 return;
466 }
547 if (isAbortError(error)) return;
548 if (token === currentFrameToken && refreshLifecycleToken === lifecycleToken) disableTrack();
467 549 }
468 550 };
469 551
470 552 const dispose = () =>
471 553 {
472 requestToken++;
554 resetRequestState();
473 555 closeMenu();
474 556 hideOverlay();
475 557 if (overlayEl) overlayEl.remove();
@@ -191,7 +191,6 @@
191 const trackByStreamIndex = new Map(imageTracks.map((track) => [track.streamIndex, track]));
191 const trackByStreamIndex = new Map(imageTracks.map((track) => [track.streamIndex, track]));
192 let selectedStreamIndex = null;
192 let selectedStreamIndex = null;
193 let menuOpen = false;
193 let menuOpen = false;
194 let requestToken = 0;
195 let activeBucket = -1;
194 let activeBucket = -1;
196 let activeObjectUrl = null;
195 let activeObjectUrl = null;
197 let overlayEl = null;
196 let overlayEl = null;
@@ -200,7 +199,64 @@
200 let buttonEl = null;
199 let buttonEl = null;
201 let trackDisabled = false;
200 let trackDisabled = false;
202 let failureNotified = false;
201 let failureNotified = false;
203 let lastPrefetchedBucket = -1;
202 let lifecycleToken = 0;
203 let currentFrameToken = 0;
204 let currentFrameAbortController = null;
205 let prefetchWorkerToken = 0;
206 let prefetchAbortController = null;
207 let prefetchPromise = null;
208 let prefetchTargetTimeSeconds = -1;
209 let prefetchedThroughTimeSeconds = -1;
210
211 const createAbortController = () =>
212 {
213 if (typeof AbortController !== 'function') return null;
214 return new AbortController();
215 };
216
217 const abortController = (controller) =>
218 {
219 if (!controller || typeof controller.abort !== 'function') return;
220 try
221 {
222 controller.abort();
223 } catch
224 {
225 // Ignore abort races during teardown.
226 }
227 };
228
229 const isAbortError = (error) =>
230 {
231 return !!(error && typeof error === 'object' && error.name === 'AbortError');
232 };
233
234 const cancelCurrentFrameRequest = () =>
235 {
236 currentFrameToken++;
237 abortController(currentFrameAbortController);
238 currentFrameAbortController = null;
239 };
240
241 const cancelPrefetchRequests = ({ resetProgress = false } = {}) =>
242 {
243 prefetchWorkerToken++;
244 abortController(prefetchAbortController);
245 prefetchAbortController = null;
246 prefetchPromise = null;
247 if (resetProgress)
248 {
249 prefetchTargetTimeSeconds = -1;
250 prefetchedThroughTimeSeconds = -1;
251 }
252 };
253
254 const resetRequestState = () =>
255 {
256 lifecycleToken++;
257 cancelCurrentFrameRequest();
258 cancelPrefetchRequests({ resetProgress: true });
259 };
204
260
205 const closeObjectUrl = () =>
261 const closeObjectUrl = () =>
206 {
262 {
@@ -278,6 +334,7 @@
278 trackDisabled = true;
334 trackDisabled = true;
279 selectedStreamIndex = null;
335 selectedStreamIndex = null;
280 activeBucket = -1;
336 activeBucket = -1;
337 resetRequestState();
281 hideOverlay();
338 hideOverlay();
282 updateButtonState();
339 updateButtonState();
283 updateMenuState();
340 updateMenuState();
@@ -299,7 +356,7 @@
299 failureNotified = false;
356 failureNotified = false;
300 selectedStreamIndex = nextStreamIndex;
357 selectedStreamIndex = nextStreamIndex;
301 activeBucket = -1;
358 activeBucket = -1;
302 lastPrefetchedBucket = -1;
359 resetRequestState();
303 hideOverlay();
360 hideOverlay();
304 updateButtonState();
361 updateButtonState();
305 updateMenuState();
362 updateMenuState();
@@ -311,6 +368,84 @@
311 }
368 }
312 };
369 };
313
370
371 const queueLookaheadPrefetch = (currentTime, { reset = false } = {}) =>
372 {
373 if (selectedStreamIndex === null) return;
374 if (trackDisabled) return;
375 if (lookaheadSeconds <= 0) return;
376
377 const startTime = currentTime + IMAGE_SUBTITLE_PREFETCH_STEP_SECONDS;
378 const endTime = currentTime + lookaheadSeconds;
379 if (!Number.isFinite(startTime) || !Number.isFinite(endTime) || endTime <= startTime) return;
380
381 if (reset || prefetchedThroughTimeSeconds < 0 || prefetchedThroughTimeSeconds < currentTime - IMAGE_SUBTITLE_PREFETCH_STEP_SECONDS)
382 {
383 cancelPrefetchRequests({ resetProgress: true });
384 prefetchedThroughTimeSeconds = currentTime;
385 }
386
387 prefetchTargetTimeSeconds = Math.max(prefetchTargetTimeSeconds, endTime);
388 if (prefetchPromise) return;
389
390 const workerToken = ++prefetchWorkerToken;
391 const workerLifecycleToken = lifecycleToken;
392 const controller = createAbortController();
393 prefetchAbortController = controller;
394
395 prefetchPromise = (async () =>
396 {
397 while (true)
398 {
399 if (selectedStreamIndex === null || trackDisabled) return;
400 if (workerToken !== prefetchWorkerToken || workerLifecycleToken !== lifecycleToken) return;
401
402 const nextTime = prefetchedThroughTimeSeconds < 0
403 ? startTime
404 : prefetchedThroughTimeSeconds + IMAGE_SUBTITLE_PREFETCH_STEP_SECONDS;
405 if (!Number.isFinite(nextTime) || nextTime > prefetchTargetTimeSeconds + 1e-6) return;
406
407 const request = buildFrameRequest({
408 streamIndex: selectedStreamIndex,
409 currentTime: nextTime,
410 session,
411 });
412 if (!request || !request.url) return;
413
414 try
415 {
416 const res = await fetch(request.url, {
417 method: request.method || 'GET',
418 headers: request.headers,
419 credentials: request.credentials,
420 signal: controller ? controller.signal : undefined,
421 });
422
423 if (workerToken !== prefetchWorkerToken || workerLifecycleToken !== lifecycleToken) return;
424 if (res.status === 204)
425 {
426 const frameStatus = String(res.headers.get('X-Subtitle-Frame-Status') || '').toLowerCase();
427 if (frameStatus === 'error') return;
428 prefetchedThroughTimeSeconds = nextTime;
429 continue;
430 }
431
432 if (!res.ok) return;
433 await res.arrayBuffer();
434 prefetchedThroughTimeSeconds = nextTime;
435 } catch (error)
436 {
437 if (isAbortError(error)) return;
438 return;
439 }
440 }
441 })().finally(() =>
442 {
443 if (workerToken !== prefetchWorkerToken) return;
444 prefetchAbortController = null;
445 prefetchPromise = null;
446 });
447 };
448
314 const refreshFrame = async (force = false) =>
449 const refreshFrame = async (force = false) =>
315 {
450 {
316 if (selectedStreamIndex === null) return;
451 if (selectedStreamIndex === null) return;
@@ -324,7 +459,13 @@
324 if (!force && bucket === activeBucket) return;
459 if (!force && bucket === activeBucket) return;
325 activeBucket = bucket;
460 activeBucket = bucket;
326
461
327 const token = ++requestToken;
462 const refreshLifecycleToken = lifecycleToken;
463 cancelCurrentFrameRequest();
464 if (force) cancelPrefetchRequests({ resetProgress: true });
465
466 const token = ++currentFrameToken;
467 const controller = createAbortController();
468 currentFrameAbortController = controller;
328 const request = buildFrameRequest({
469 const request = buildFrameRequest({
329 streamIndex: selectedStreamIndex,
470 streamIndex: selectedStreamIndex,
330 currentTime,
471 currentTime,
@@ -343,15 +484,17 @@
343 method: request.method || 'GET',
484 method: request.method || 'GET',
344 headers: request.headers,
485 headers: request.headers,
345 credentials: request.credentials,
486 credentials: request.credentials,
487 signal: controller ? controller.signal : undefined,
346 });
488 });
347
489
348 if (token !== requestToken) return;
490 if (token !== currentFrameToken || refreshLifecycleToken !== lifecycleToken) return;
349
491
350 if (res.status === 204)
492 if (res.status === 204)
351 {
493 {
352 const frameStatus = String(res.headers.get('X-Subtitle-Frame-Status') || '').toLowerCase();
494 const frameStatus = String(res.headers.get('X-Subtitle-Frame-Status') || '').toLowerCase();
353 hideOverlay();
495 hideOverlay();
354 if (frameStatus === 'error') disableTrack();
496 if (frameStatus === 'error') disableTrack();
497 else queueLookaheadPrefetch(currentTime, { reset: force });
355 return;
498 return;
356 }
499 }
357
500
@@ -362,7 +505,7 @@
362 }
505 }
363
506
364 const blob = await res.blob();
507 const blob = await res.blob();
365 if (token !== requestToken) return;
508 if (token !== currentFrameToken || refreshLifecycleToken !== lifecycleToken) return;
366
509
367 if (!blob || blob.size === 0)
510 if (!blob || blob.size === 0)
368 {
511 {
@@ -398,78 +541,17 @@
398 overlayEl.style.display = 'block';
541 overlayEl.style.display = 'block';
399 overlayImgEl.style.display = 'block';
542 overlayImgEl.style.display = 'block';
400
543
401 if (lookaheadSeconds > 0)
544 queueLookaheadPrefetch(currentTime, { reset: force });
402 {
545 } catch (error)
403 const currentBucket = Math.floor(currentTime * 4);
404 if (force || currentBucket !== lastPrefetchedBucket)
405 {
406 lastPrefetchedBucket = currentBucket;
407 void prefetchLookaheadFrames(currentTime, currentBucket, token);
408 }
409 }
410 } catch
411 {
546 {
412 if (token === requestToken) disableTrack();
547 if (isAbortError(error)) return;
413 }
548 if (token === currentFrameToken && refreshLifecycleToken === lifecycleToken) disableTrack();
414 };
415
416 const prefetchLookaheadFrames = async (currentTime, currentBucket, token) =>
417 {
418 if (selectedStreamIndex === null) return;
419 if (trackDisabled) return;
420 if (token !== requestToken) return;
421
422 const startTime = currentTime + IMAGE_SUBTITLE_PREFETCH_STEP_SECONDS;
423 const endTime = currentTime + lookaheadSeconds;
424 if (!Number.isFinite(startTime) || !Number.isFinite(endTime) || endTime <= startTime) return;
425
426 const prefetchedBuckets = new Set([currentBucket]);
427 for (let t = startTime; t <= endTime + 1e-6; t += IMAGE_SUBTITLE_PREFETCH_STEP_SECONDS)
428 {
429 if (token !== requestToken) return;
430 if (selectedStreamIndex === null || trackDisabled) return;
431
432 const bucket = Math.floor(t * 4);
433 if (prefetchedBuckets.has(bucket)) continue;
434 prefetchedBuckets.add(bucket);
435
436 const request = buildFrameRequest({
437 streamIndex: selectedStreamIndex,
438 currentTime: t,
439 session,
440 });
441 if (!request || !request.url) return;
442
443 try
444 {
445 const res = await fetch(request.url, {
446 method: request.method || 'GET',
447 headers: request.headers,
448 credentials: request.credentials,
449 });
450
451 if (token !== requestToken) return;
452 if (res.status === 204)
453 {
454 const frameStatus = String(res.headers.get('X-Subtitle-Frame-Status') || '').toLowerCase();
455 if (frameStatus === 'error') return;
456 continue;
457 }
458
459 if (!res.ok) return;
460 // Ensure body is fully consumed so the browser can reuse connections.
461 await res.arrayBuffer();
462 } catch
463 {
464 // Best-effort prefetch; avoid disrupting active subtitle rendering.
465 return;
466 }
467 }
549 }
468 };
550 };
469
551
470 const dispose = () =>
552 const dispose = () =>
471 {
553 {
472 requestToken++;
554 resetRequestState();
473 closeMenu();
555 closeMenu();
474 hideOverlay();
556 hideOverlay();
475 if (overlayEl) overlayEl.remove();
557 if (overlayEl) overlayEl.remove();
tests/shared-video-player.test.js added +227 −0
@@ -0,0 +1,227 @@
1 'use strict';
2
3 const fs = require('fs');
4 const path = require('path');
5 const { JSDOM } = require('jsdom');
6
7 function flushAsyncWork (window, rounds = 6)
8 {
9 let chain = Promise.resolve();
10 for (let i = 0; i < rounds; i++)
11 {
12 chain = chain.then(() => new Promise((resolve) => window.setTimeout(resolve, 0)));
13 }
14 return chain;
15 }
16
17 function buildPlayerHarness (window)
18 {
19 const registeredComponents = new Map();
20
21 class MockButton
22 {
23 constructor(player)
24 {
25 this._player = player;
26 this._el = null;
27 }
28
29 player ()
30 {
31 return this._player;
32 }
33
34 buildCSSClass ()
35 {
36 return 'vjs-control';
37 }
38
39 createEl ()
40 {
41 const el = window.document.createElement('button');
42 el.className = this.buildCSSClass();
43 return el;
44 }
45
46 el ()
47 {
48 if (!this._el) this._el = this.createEl();
49 return this._el;
50 }
51 }
52
53 registeredComponents.set('Button', MockButton);
54
55 const videojs = {
56 getComponent: (name) => registeredComponents.get(name),
57 registerComponent: (name, component) =>
58 {
59 registeredComponents.set(name, component);
60 },
61 };
62
63 const events = new Map();
64 const playerEl = window.document.createElement('div');
65 let currentTime = 0;
66
67 const player = {
68 ready (cb)
69 {
70 if (typeof cb === 'function') cb();
71 },
72 on (type, fn)
73 {
74 if (!events.has(type)) events.set(type, new Set());
75 events.get(type).add(fn);
76 },
77 trigger (type)
78 {
79 const listeners = events.get(type);
80 if (!listeners) return;
81 for (const fn of Array.from(listeners)) fn();
82 },
83 currentTime ()
84 {
85 return currentTime;
86 },
87 setCurrentTime (next)
88 {
89 currentTime = Number(next);
90 },
91 el ()
92 {
93 return playerEl;
94 },
95 getChild (name)
96 {
97 if (name !== 'controlBar') return null;
98 return {
99 addChild (componentName)
100 {
101 const Component = registeredComponents.get(componentName);
102 if (!Component) return null;
103 const instance = new Component(player);
104 playerEl.appendChild(instance.el());
105 return instance;
106 },
107 };
108 },
109 };
110
111 return { player, videojs };
112 }
113
114 function loadSharedVideoPlayer (window)
115 {
116 const script = fs.readFileSync(path.join(__dirname, '../public/shared-video-player.js'), 'utf8');
117 window.eval(script);
118 return window.FilemanagerSharedVideoPlayer;
119 }
120
121 describe('shared image subtitle prefetching', () =>
122 {
123 function createWindow ()
124 {
125 const dom = new JSDOM('<!doctype html><html><body></body></html>', {
126 url: 'http://localhost/',
127 runScripts: 'dangerously',
128 pretendToBeVisual: true,
129 });
130
131 dom.window.AbortController = AbortController;
132 dom.window.Response = Response;
133 dom.window.Headers = Headers;
134 dom.window.Request = Request;
135 dom.window.URL.createObjectURL = () => 'blob:subtitle';
136 dom.window.URL.revokeObjectURL = () => {};
137
138 return dom.window;
139 }
140
141 test('prefetches lookahead frames even when no subtitle is currently active', async () =>
142 {
143 const window = createWindow();
144 const helper = loadSharedVideoPlayer(window);
145 const { player, videojs } = buildPlayerHarness(window);
146 const requestedTimes = [];
147
148 window.fetch = jest.fn(async (url) =>
149 {
150 const parsed = new URL(url, 'http://localhost/');
151 requestedTimes.push(Number(parsed.searchParams.get('timeSeconds')));
152 return new Response(null, {
153 status: 204,
154 headers: { 'X-Subtitle-Frame-Status': 'none' },
155 });
156 });
157
158 helper.bindImageSubtitleOverlay(player, videojs, {}, {
159 imageSubtitleTracks: [{ label: 'PGS English', streamIndex: 0, default: true }],
160 }, {
161 lookaheadSeconds: 1,
162 buildFrameRequest: ({ currentTime, streamIndex }) => ({
163 url: `/subtitle-frame?streamIndex=${streamIndex}&timeSeconds=${currentTime}`,
164 }),
165 });
166
167 await flushAsyncWork(window);
168
169 expect(requestedTimes).toEqual(expect.arrayContaining([0, 0.5, 1]));
170
171 window.close();
172 });
173
174 test('aborts in-flight prefetch requests when the overlay is detached', async () =>
175 {
176 const window = createWindow();
177 const helper = loadSharedVideoPlayer(window);
178 const { player, videojs } = buildPlayerHarness(window);
179 const activeSignals = [];
180
181 window.fetch = jest.fn((url, init = {}) =>
182 {
183 const parsed = new URL(url, 'http://localhost/');
184 const timeSeconds = Number(parsed.searchParams.get('timeSeconds'));
185
186 if (timeSeconds === 0)
187 {
188 return Promise.resolve(new Response(null, {
189 status: 204,
190 headers: { 'X-Subtitle-Frame-Status': 'none' },
191 }));
192 }
193
194 activeSignals.push(init.signal || null);
195
196 return new Promise((resolve, reject) =>
197 {
198 if (init.signal && typeof init.signal.addEventListener === 'function')
199 {
200 init.signal.addEventListener('abort', () =>
201 {
202 reject(new DOMException('Aborted', 'AbortError'));
203 }, { once: true });
204 }
205 });
206 });
207
208 const controller = helper.bindImageSubtitleOverlay(player, videojs, {}, {
209 imageSubtitleTracks: [{ label: 'PGS English', streamIndex: 0, default: true }],
210 }, {
211 lookaheadSeconds: 1,
212 buildFrameRequest: ({ currentTime, streamIndex }) => ({
213 url: `/subtitle-frame?streamIndex=${streamIndex}&timeSeconds=${currentTime}`,
214 }),
215 });
216
217 await flushAsyncWork(window, 3);
218 expect(activeSignals.length).toBeGreaterThan(0);
219
220 controller.detach();
221 await flushAsyncWork(window, 2);
222
223 expect(activeSignals.every(signal => signal && signal.aborted)).toBe(true);
224
225 window.close();
226 });
227 });
@@ -0,0 +1,227 @@
1'use strict';
2
3const fs = require('fs');
4const path = require('path');
5const { JSDOM } = require('jsdom');
6
7function flushAsyncWork (window, rounds = 6)
8{
9 let chain = Promise.resolve();
10 for (let i = 0; i < rounds; i++)
11 {
12 chain = chain.then(() => new Promise((resolve) => window.setTimeout(resolve, 0)));
13 }
14 return chain;
15}
16
17function buildPlayerHarness (window)
18{
19 const registeredComponents = new Map();
20
21 class MockButton
22 {
23 constructor(player)
24 {
25 this._player = player;
26 this._el = null;
27 }
28
29 player ()
30 {
31 return this._player;
32 }
33
34 buildCSSClass ()
35 {
36 return 'vjs-control';
37 }
38
39 createEl ()
40 {
41 const el = window.document.createElement('button');
42 el.className = this.buildCSSClass();
43 return el;
44 }
45
46 el ()
47 {
48 if (!this._el) this._el = this.createEl();
49 return this._el;
50 }
51 }
52
53 registeredComponents.set('Button', MockButton);
54
55 const videojs = {
56 getComponent: (name) => registeredComponents.get(name),
57 registerComponent: (name, component) =>
58 {
59 registeredComponents.set(name, component);
60 },
61 };
62
63 const events = new Map();
64 const playerEl = window.document.createElement('div');
65 let currentTime = 0;
66
67 const player = {
68 ready (cb)
69 {
70 if (typeof cb === 'function') cb();
71 },
72 on (type, fn)
73 {
74 if (!events.has(type)) events.set(type, new Set());
75 events.get(type).add(fn);
76 },
77 trigger (type)
78 {
79 const listeners = events.get(type);
80 if (!listeners) return;
81 for (const fn of Array.from(listeners)) fn();
82 },
83 currentTime ()
84 {
85 return currentTime;
86 },
87 setCurrentTime (next)
88 {
89 currentTime = Number(next);
90 },
91 el ()
92 {
93 return playerEl;
94 },
95 getChild (name)
96 {
97 if (name !== 'controlBar') return null;
98 return {
99 addChild (componentName)
100 {
101 const Component = registeredComponents.get(componentName);
102 if (!Component) return null;
103 const instance = new Component(player);
104 playerEl.appendChild(instance.el());
105 return instance;
106 },
107 };
108 },
109 };
110
111 return { player, videojs };
112}
113
114function loadSharedVideoPlayer (window)
115{
116 const script = fs.readFileSync(path.join(__dirname, '../public/shared-video-player.js'), 'utf8');
117 window.eval(script);
118 return window.FilemanagerSharedVideoPlayer;
119}
120
121describe('shared image subtitle prefetching', () =>
122{
123 function createWindow ()
124 {
125 const dom = new JSDOM('<!doctype html><html><body></body></html>', {
126 url: 'http://localhost/',
127 runScripts: 'dangerously',
128 pretendToBeVisual: true,
129 });
130
131 dom.window.AbortController = AbortController;
132 dom.window.Response = Response;
133 dom.window.Headers = Headers;
134 dom.window.Request = Request;
135 dom.window.URL.createObjectURL = () => 'blob:subtitle';
136 dom.window.URL.revokeObjectURL = () => {};
137
138 return dom.window;
139 }
140
141 test('prefetches lookahead frames even when no subtitle is currently active', async () =>
142 {
143 const window = createWindow();
144 const helper = loadSharedVideoPlayer(window);
145 const { player, videojs } = buildPlayerHarness(window);
146 const requestedTimes = [];
147
148 window.fetch = jest.fn(async (url) =>
149 {
150 const parsed = new URL(url, 'http://localhost/');
151 requestedTimes.push(Number(parsed.searchParams.get('timeSeconds')));
152 return new Response(null, {
153 status: 204,
154 headers: { 'X-Subtitle-Frame-Status': 'none' },
155 });
156 });
157
158 helper.bindImageSubtitleOverlay(player, videojs, {}, {
159 imageSubtitleTracks: [{ label: 'PGS English', streamIndex: 0, default: true }],
160 }, {
161 lookaheadSeconds: 1,
162 buildFrameRequest: ({ currentTime, streamIndex }) => ({
163 url: `/subtitle-frame?streamIndex=${streamIndex}&timeSeconds=${currentTime}`,
164 }),
165 });
166
167 await flushAsyncWork(window);
168
169 expect(requestedTimes).toEqual(expect.arrayContaining([0, 0.5, 1]));
170
171 window.close();
172 });
173
174 test('aborts in-flight prefetch requests when the overlay is detached', async () =>
175 {
176 const window = createWindow();
177 const helper = loadSharedVideoPlayer(window);
178 const { player, videojs } = buildPlayerHarness(window);
179 const activeSignals = [];
180
181 window.fetch = jest.fn((url, init = {}) =>
182 {
183 const parsed = new URL(url, 'http://localhost/');
184 const timeSeconds = Number(parsed.searchParams.get('timeSeconds'));
185
186 if (timeSeconds === 0)
187 {
188 return Promise.resolve(new Response(null, {
189 status: 204,
190 headers: { 'X-Subtitle-Frame-Status': 'none' },
191 }));
192 }
193
194 activeSignals.push(init.signal || null);
195
196 return new Promise((resolve, reject) =>
197 {
198 if (init.signal && typeof init.signal.addEventListener === 'function')
199 {
200 init.signal.addEventListener('abort', () =>
201 {
202 reject(new DOMException('Aborted', 'AbortError'));
203 }, { once: true });
204 }
205 });
206 });
207
208 const controller = helper.bindImageSubtitleOverlay(player, videojs, {}, {
209 imageSubtitleTracks: [{ label: 'PGS English', streamIndex: 0, default: true }],
210 }, {
211 lookaheadSeconds: 1,
212 buildFrameRequest: ({ currentTime, streamIndex }) => ({
213 url: `/subtitle-frame?streamIndex=${streamIndex}&timeSeconds=${currentTime}`,
214 }),
215 });
216
217 await flushAsyncWork(window, 3);
218 expect(activeSignals.length).toBeGreaterThan(0);
219
220 controller.detach();
221 await flushAsyncWork(window, 2);
222
223 expect(activeSignals.every(signal => signal && signal.aborted)).toBe(true);
224
225 window.close();
226 });
227});