BlueGit

timfa filemanager

Merge fix/subtitle-request-flow-seek-markers

timfa Tim Falken · pushed by timfa

Authored 2026-05-25 · 5 months ago

Hash
5e58729b3934e5bed95b4f21769f3ee1c8114f19
3 files changed +498 −102
.github/technical-reference.md +1 −1
@@ -182,7 +182,7 @@
182 182 ## public/shared-video-player.js
183 183 - 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.
184 184 - 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.
185 - 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, logs current subtitle request/send/receive/show timing to the browser console and optional batch sink, and disables the track after the first hard failure.
185 - 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), coalesces overlapping current-frame refreshes into a single in-flight fetch (only force-refresh paths abort/restart), logs current and prefetch subtitle request/send/receive/not-available timing to the browser console and optional batch sink, renders seek-bar triangle markers for last requested caption start time (`>`) and last received/ready caption start time (`<`), and disables the track after the first hard failure.
186 186 - configureVideoJsBuffering(videojs, opts) - Applies the long forward-buffer settings used for file playback when VHS exposes those knobs.
187 187 - 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.
188 188
@@ -182,7 +182,7 @@
182## public/shared-video-player.js
182## public/shared-video-player.js
183- 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.
183- 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.
184- 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.
184- 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.
185- 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, logs current subtitle request/send/receive/show timing to the browser console and optional batch sink, and disables the track after the first hard failure.
185- 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), coalesces overlapping current-frame refreshes into a single in-flight fetch (only force-refresh paths abort/restart), logs current and prefetch subtitle request/send/receive/not-available timing to the browser console and optional batch sink, renders seek-bar triangle markers for last requested caption start time (`>`) and last received/ready caption start time (`<`), and disables the track after the first hard failure.
186- configureVideoJsBuffering(videojs, opts) - Applies the long forward-buffer settings used for file playback when VHS exposes those knobs.
186- configureVideoJsBuffering(videojs, opts) - Applies the long forward-buffer settings used for file playback when VHS exposes those knobs.
187- 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.
187- 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.
188
188
public/shared-video-player.js +322 −101
@@ -282,6 +282,14 @@
282 282 let prefetchPromise = null;
283 283 let prefetchTargetTimeSeconds = -1;
284 284 let prefetchedThroughTimeSeconds = -1;
285 let queuedCurrentRefresh = false;
286 let queuedCurrentRefreshForce = false;
287 let currentFramePromise = null;
288 let seekMarkerContainerEl = null;
289 let seekMarkerRequestedEl = null;
290 let seekMarkerReceivedEl = null;
291 let lastRequestedCaptionStartTimeSeconds = null;
292 let lastReceivedCaptionStartTimeSeconds = null;
285 293 let subtitleLogSequence = 0;
286 294 let subtitleLogQueue = [];
287 295 let subtitleLogFlushTimer = null;
@@ -409,6 +417,106 @@
409 417 closeObjectUrl();
410 418 };
411 419
420 const setSeekMarkerTime = (kind, timeSeconds) =>
421 {
422 const numericTime = Number(timeSeconds);
423 const nextTime = Number.isFinite(numericTime) && numericTime >= 0 ? numericTime : null;
424
425 if (kind === 'requested')
426 {
427 lastRequestedCaptionStartTimeSeconds = nextTime;
428 } else if (kind === 'received')
429 {
430 lastReceivedCaptionStartTimeSeconds = nextTime;
431 }
432 };
433
434 const updateSeekBarMarkers = () =>
435 {
436 if (!seekMarkerRequestedEl || !seekMarkerReceivedEl) return;
437
438 const duration = Number(player.duration && player.duration());
439 if (!Number.isFinite(duration) || duration <= 0)
440 {
441 seekMarkerRequestedEl.style.display = 'none';
442 seekMarkerReceivedEl.style.display = 'none';
443 return;
444 }
445
446 const applyMarker = (markerEl, markerTimeSeconds) =>
447 {
448 if (!Number.isFinite(markerTimeSeconds) || markerTimeSeconds < 0)
449 {
450 markerEl.style.display = 'none';
451 return;
452 }
453
454 const ratio = Math.max(0, Math.min(1, markerTimeSeconds / duration));
455 markerEl.style.display = 'block';
456 markerEl.style.left = `${(ratio * 100).toFixed(4)}%`;
457 };
458
459 applyMarker(seekMarkerRequestedEl, lastRequestedCaptionStartTimeSeconds);
460 applyMarker(seekMarkerReceivedEl, lastReceivedCaptionStartTimeSeconds);
461 };
462
463 const ensureSeekBarMarkers = () =>
464 {
465 if (seekMarkerContainerEl && seekMarkerContainerEl.isConnected)
466 {
467 updateSeekBarMarkers();
468 return;
469 }
470
471 const playerEl = player.el && player.el();
472 if (!playerEl) return;
473
474 const seekBarEl = playerEl.querySelector('.vjs-progress-control')
475 || playerEl.querySelector('.vjs-progress-holder')
476 || playerEl.querySelector('.vjs-seek-bar');
477 if (!seekBarEl) return;
478
479 const computedPosition = window.getComputedStyle(seekBarEl).position;
480 if (computedPosition === 'static') seekBarEl.style.position = 'relative';
481
482 seekMarkerContainerEl = document.createElement('div');
483 seekMarkerContainerEl.className = 'vjs-image-subtitle-seek-markers';
484 seekMarkerContainerEl.style.position = 'absolute';
485 seekMarkerContainerEl.style.left = '0';
486 seekMarkerContainerEl.style.right = '0';
487 seekMarkerContainerEl.style.top = '-9px';
488 seekMarkerContainerEl.style.height = '10px';
489 seekMarkerContainerEl.style.pointerEvents = 'none';
490 seekMarkerContainerEl.style.zIndex = '5';
491
492 const buildTriangle = (direction) =>
493 {
494 const markerEl = document.createElement('span');
495 markerEl.className = `vjs-image-subtitle-seek-marker vjs-image-subtitle-seek-marker-${direction}`;
496 markerEl.style.position = 'absolute';
497 markerEl.style.width = '12px';
498 markerEl.style.height = '10px';
499 markerEl.style.transform = 'translateX(-50%)';
500 markerEl.style.background = '#fff';
501 markerEl.style.border = '1px solid #000';
502 markerEl.style.display = 'none';
503 markerEl.style.boxSizing = 'border-box';
504 markerEl.style.clipPath = direction === 'left'
505 ? 'polygon(100% 0, 0 50%, 100% 100%)'
506 : 'polygon(0 0, 100% 50%, 0 100%)';
507 markerEl.setAttribute('aria-hidden', 'true');
508 return markerEl;
509 };
510
511 seekMarkerReceivedEl = buildTriangle('left');
512 seekMarkerRequestedEl = buildTriangle('right');
513 seekMarkerContainerEl.appendChild(seekMarkerReceivedEl);
514 seekMarkerContainerEl.appendChild(seekMarkerRequestedEl);
515
516 seekBarEl.appendChild(seekMarkerContainerEl);
517 updateSeekBarMarkers();
518 };
519
412 520 const updateButtonState = () =>
413 521 {
414 522 if (!buttonEl) return;
@@ -469,6 +577,9 @@
469 577 trackDisabled = true;
470 578 selectedStreamIndex = null;
471 579 activeBucket = -1;
580 setSeekMarkerTime('requested', null);
581 setSeekMarkerTime('received', null);
582 updateSeekBarMarkers();
472 583 resetRequestState();
473 584 hideOverlay();
474 585 updateButtonState();
@@ -491,6 +602,9 @@
491 602 failureNotified = false;
492 603 selectedStreamIndex = nextStreamIndex;
493 604 activeBucket = -1;
605 setSeekMarkerTime('requested', null);
606 setSeekMarkerTime('received', null);
607 updateSeekBarMarkers();
494 608 resetRequestState();
495 609 hideOverlay();
496 610 updateButtonState();
@@ -546,6 +660,16 @@
546 660 });
547 661 if (!request || !request.url) return;
548 662
663 const prefetchRequestStartedAtMs = Date.now();
664 const prefetchRequestId = `prefetch-${workerToken}-${Math.round(nextTime * 1000)}`;
665 logSubtitleEvent('subtitle_png_requested', {
666 requestId: prefetchRequestId,
667 requestKind: 'prefetch',
668 requestUrl: String(request.url || ''),
669 requestedAtMs: prefetchRequestStartedAtMs,
670 requestedVideoTimeSeconds: roundLogNumber(nextTime),
671 });
672
549 673 try
550 674 {
551 675 const res = await fetch(request.url, {
@@ -556,20 +680,66 @@
556 680 });
557 681
558 682 if (workerToken !== prefetchWorkerToken || workerLifecycleToken !== lifecycleToken) return;
683
684 const responseMeta = {
685 requestId: prefetchRequestId,
686 requestKind: 'prefetch',
687 status: res.status,
688 serverRequestReceivedAtMs: parseHeaderInt(res, 'X-Subtitle-Request-Received-At-Ms'),
689 serverResponseSentAtMs: parseHeaderInt(res, 'X-Subtitle-Response-Sent-At-Ms'),
690 shouldShowAtVideoTimeSeconds: parseHeaderFloat(res, 'X-Subtitle-Frame-Start-Time'),
691 subtitleEndTimeSeconds: parseHeaderFloat(res, 'X-Subtitle-Frame-End-Time'),
692 responseHeadersReceivedAtMs: Date.now(),
693 };
694 if (Number.isFinite(responseMeta.shouldShowAtVideoTimeSeconds))
695 {
696 setSeekMarkerTime('requested', responseMeta.shouldShowAtVideoTimeSeconds);
697 updateSeekBarMarkers();
698 }
699 logSubtitleEvent('subtitle_png_sent', {
700 ...responseMeta,
701 serverProcessingMs: diffMilliseconds(responseMeta.serverResponseSentAtMs, responseMeta.serverRequestReceivedAtMs),
702 sentToHeadersReceivedMs: diffMilliseconds(responseMeta.responseHeadersReceivedAtMs, responseMeta.serverResponseSentAtMs),
703 });
704
559 705 if (res.status === 204)
560 706 {
561 707 const frameStatus = String(res.headers.get('X-Subtitle-Frame-Status') || '').toLowerCase();
708 logSubtitleEvent('subtitle_png_not_available', {
709 ...responseMeta,
710 frameStatus,
711 });
562 712 if (frameStatus === 'error') return;
563 713 prefetchedThroughTimeSeconds = nextTime;
564 714 continue;
565 715 }
566 716
567 717 if (!res.ok) return;
568 await res.arrayBuffer();
718 const payload = await res.arrayBuffer();
719 const receivedAtMs = Date.now();
720 if (Number.isFinite(responseMeta.shouldShowAtVideoTimeSeconds))
721 {
722 setSeekMarkerTime('received', responseMeta.shouldShowAtVideoTimeSeconds);
723 updateSeekBarMarkers();
724 }
725 logSubtitleEvent('subtitle_png_received', {
726 ...responseMeta,
727 receivedAtMs,
728 sentToReceivedMs: diffMilliseconds(receivedAtMs, responseMeta.serverResponseSentAtMs),
729 requestedToReceivedMs: diffMilliseconds(receivedAtMs, prefetchRequestStartedAtMs),
730 blobBytes: Number(payload && payload.byteLength || 0),
731 });
569 732 prefetchedThroughTimeSeconds = nextTime;
570 733 } catch (error)
571 734 {
572 735 if (isAbortError(error)) return;
736 logSubtitleEvent('subtitle_png_request_failed', {
737 requestId: prefetchRequestId,
738 requestKind: 'prefetch',
739 requestedAtMs: prefetchRequestStartedAtMs,
740 errorName: error && error.name ? String(error.name) : null,
741 errorMessage: error && error.message ? String(error.message) : String(error || ''),
742 });
573 743 return;
574 744 }
575 745 }
@@ -587,6 +757,12 @@
587 757 if (!overlayEl || !overlayImgEl) return;
588 758 if (trackDisabled) return;
589 759
760 if (currentFramePromise && !force)
761 {
762 queuedCurrentRefresh = true;
763 return;
764 }
765
590 766 const currentTime = Number(player.currentTime());
591 767 if (!Number.isFinite(currentTime) || currentTime < 0) return;
592 768
@@ -595,6 +771,16 @@
595 771 activeBucket = bucket;
596 772
597 773 const refreshLifecycleToken = lifecycleToken;
774 if (force && currentFramePromise)
775 {
776 cancelCurrentFrameRequest();
777 }
778 if (currentFramePromise)
779 {
780 queuedCurrentRefresh = true;
781 queuedCurrentRefreshForce = queuedCurrentRefreshForce || !!force;
782 return;
783 }
598 784 cancelCurrentFrameRequest();
599 785 if (force) cancelPrefetchRequests({ resetProgress: true });
600 786
@@ -623,126 +809,152 @@
623 809 requestedVideoTimeSeconds: roundLogNumber(currentTime),
624 810 });
625 811
626 try
812 currentFramePromise = (async () =>
627 813 {
628 const res = await fetch(request.url, {
629 method: request.method || 'GET',
630 headers: request.headers,
631 credentials: request.credentials,
632 signal: controller ? controller.signal : undefined,
633 });
634
635 if (token !== currentFrameToken || refreshLifecycleToken !== lifecycleToken) return;
636
637 const responseMeta = {
638 requestId,
639 requestKind: 'current',
640 status: res.status,
641 serverRequestReceivedAtMs: parseHeaderInt(res, 'X-Subtitle-Request-Received-At-Ms'),
642 serverResponseSentAtMs: parseHeaderInt(res, 'X-Subtitle-Response-Sent-At-Ms'),
643 shouldShowAtVideoTimeSeconds: parseHeaderFloat(res, 'X-Subtitle-Frame-Start-Time'),
644 subtitleEndTimeSeconds: parseHeaderFloat(res, 'X-Subtitle-Frame-End-Time'),
645 responseHeadersReceivedAtMs: Date.now(),
646 };
647 logSubtitleEvent('subtitle_png_sent', {
648 ...responseMeta,
649 serverProcessingMs: diffMilliseconds(responseMeta.serverResponseSentAtMs, responseMeta.serverRequestReceivedAtMs),
650 sentToHeadersReceivedMs: diffMilliseconds(responseMeta.responseHeadersReceivedAtMs, responseMeta.serverResponseSentAtMs),
651 });
652
653 if (res.status === 204)
814 try
654 815 {
655 const frameStatus = String(res.headers.get('X-Subtitle-Frame-Status') || '').toLowerCase();
656 logSubtitleEvent('subtitle_png_not_available', {
816 const res = await fetch(request.url, {
817 method: request.method || 'GET',
818 headers: request.headers,
819 credentials: request.credentials,
820 signal: controller ? controller.signal : undefined,
821 });
822
823 if (token !== currentFrameToken || refreshLifecycleToken !== lifecycleToken) return;
824
825 const responseMeta = {
826 requestId,
827 requestKind: 'current',
828 status: res.status,
829 serverRequestReceivedAtMs: parseHeaderInt(res, 'X-Subtitle-Request-Received-At-Ms'),
830 serverResponseSentAtMs: parseHeaderInt(res, 'X-Subtitle-Response-Sent-At-Ms'),
831 shouldShowAtVideoTimeSeconds: parseHeaderFloat(res, 'X-Subtitle-Frame-Start-Time'),
832 subtitleEndTimeSeconds: parseHeaderFloat(res, 'X-Subtitle-Frame-End-Time'),
833 responseHeadersReceivedAtMs: Date.now(),
834 };
835 if (Number.isFinite(responseMeta.shouldShowAtVideoTimeSeconds))
836 {
837 setSeekMarkerTime('requested', responseMeta.shouldShowAtVideoTimeSeconds);
838 updateSeekBarMarkers();
839 }
840 logSubtitleEvent('subtitle_png_sent', {
657 841 ...responseMeta,
658 frameStatus,
842 serverProcessingMs: diffMilliseconds(responseMeta.serverResponseSentAtMs, responseMeta.serverRequestReceivedAtMs),
843 sentToHeadersReceivedMs: diffMilliseconds(responseMeta.responseHeadersReceivedAtMs, responseMeta.serverResponseSentAtMs),
659 844 });
660 hideOverlay();
661 if (frameStatus === 'error') disableTrack();
662 else queueLookaheadPrefetch(currentTime, { reset: force });
663 return;
664 }
665 845
666 if (!res.ok)
667 {
668 disableTrack();
669 return;
670 }
846 if (res.status === 204)
847 {
848 const frameStatus = String(res.headers.get('X-Subtitle-Frame-Status') || '').toLowerCase();
849 logSubtitleEvent('subtitle_png_not_available', {
850 ...responseMeta,
851 frameStatus,
852 });
853 hideOverlay();
854 if (frameStatus === 'error') disableTrack();
855 else queueLookaheadPrefetch(currentTime, { reset: force });
856 return;
857 }
671 858
672 const blob = await res.blob();
673 if (token !== currentFrameToken || refreshLifecycleToken !== lifecycleToken) return;
859 if (!res.ok)
860 {
861 disableTrack();
862 return;
863 }
674 864
675 const receivedAtMs = Date.now();
676 logSubtitleEvent('subtitle_png_received', {
677 ...responseMeta,
678 receivedAtMs,
679 sentToReceivedMs: diffMilliseconds(receivedAtMs, responseMeta.serverResponseSentAtMs),
680 requestedToReceivedMs: diffMilliseconds(receivedAtMs, requestStartedAtMs),
681 blobBytes: Number(blob && blob.size || 0),
682 });
865 const blob = await res.blob();
866 if (token !== currentFrameToken || refreshLifecycleToken !== lifecycleToken) return;
683 867
684 if (!blob || blob.size === 0)
685 {
686 disableTrack();
687 return;
688 }
868 const receivedAtMs = Date.now();
869 if (Number.isFinite(responseMeta.shouldShowAtVideoTimeSeconds))
870 {
871 setSeekMarkerTime('received', responseMeta.shouldShowAtVideoTimeSeconds);
872 updateSeekBarMarkers();
873 }
874 logSubtitleEvent('subtitle_png_received', {
875 ...responseMeta,
876 receivedAtMs,
877 sentToReceivedMs: diffMilliseconds(receivedAtMs, responseMeta.serverResponseSentAtMs),
878 requestedToReceivedMs: diffMilliseconds(receivedAtMs, requestStartedAtMs),
879 blobBytes: Number(blob && blob.size || 0),
880 });
689 881
690 closeObjectUrl();
691 activeObjectUrl = URL.createObjectURL(blob);
692 overlayImgEl.src = activeObjectUrl;
882 if (!blob || blob.size === 0)
883 {
884 disableTrack();
885 return;
886 }
887
888 closeObjectUrl();
889 activeObjectUrl = URL.createObjectURL(blob);
890 overlayImgEl.src = activeObjectUrl;
693 891
694 892 const frameWidth = Number.parseInt(String(res.headers.get('X-Subtitle-Frame-Width') || ''), 10);
695 893 const frameHeight = Number.parseInt(String(res.headers.get('X-Subtitle-Frame-Height') || ''), 10);
696 894 const canvasWidth = Number.parseInt(String(res.headers.get('X-Subtitle-Frame-Canvas-Width') || ''), 10);
697 895 const canvasHeight = Number.parseInt(String(res.headers.get('X-Subtitle-Frame-Canvas-Height') || ''), 10);
698 896
699 if (frameWidth > 0 && frameHeight > 0 && canvasWidth > 0 && canvasHeight > 0)
700 {
701 const widthPercent = (frameWidth / canvasWidth) * 100;
702 const heightPercent = (frameHeight / canvasHeight) * 100;
703 overlayImgEl.style.width = `${widthPercent}%`;
704 overlayImgEl.style.height = `${heightPercent}%`;
705 overlayImgEl.style.maxWidth = 'none';
706 overlayImgEl.style.maxHeight = 'none';
707 } else
708 {
709 overlayImgEl.style.width = 'auto';
710 overlayImgEl.style.height = 'auto';
711 overlayImgEl.style.maxWidth = '100%';
712 overlayImgEl.style.maxHeight = '100%';
713 }
897 if (frameWidth > 0 && frameHeight > 0 && canvasWidth > 0 && canvasHeight > 0)
898 {
899 const widthPercent = (frameWidth / canvasWidth) * 100;
900 const heightPercent = (frameHeight / canvasHeight) * 100;
901 overlayImgEl.style.width = `${widthPercent}%`;
902 overlayImgEl.style.height = `${heightPercent}%`;
903 overlayImgEl.style.maxWidth = 'none';
904 overlayImgEl.style.maxHeight = 'none';
905 } else
906 {
907 overlayImgEl.style.width = 'auto';
908 overlayImgEl.style.height = 'auto';
909 overlayImgEl.style.maxWidth = '100%';
910 overlayImgEl.style.maxHeight = '100%';
911 }
714 912
715 overlayEl.style.display = 'block';
716 overlayImgEl.style.display = 'block';
913 overlayEl.style.display = 'block';
914 overlayImgEl.style.display = 'block';
717 915
718 void waitForImagePresentation(window, overlayImgEl).then((shownAtMs) =>
719 {
720 if (token !== currentFrameToken || refreshLifecycleToken !== lifecycleToken) return;
721 const shownAtVideoTimeSeconds = roundLogNumber(player.currentTime());
722 logSubtitleEvent('subtitle_png_shown', {
723 ...responseMeta,
724 receivedAtMs,
725 shownAtMs,
726 shownAtVideoTimeSeconds,
727 sentToReceivedMs: diffMilliseconds(receivedAtMs, responseMeta.serverResponseSentAtMs),
728 receivedToShownMs: diffMilliseconds(shownAtMs, receivedAtMs),
729 shouldVsShownDiffSeconds: diffSeconds(shownAtVideoTimeSeconds, responseMeta.shouldShowAtVideoTimeSeconds),
916 void waitForImagePresentation(window, overlayImgEl).then((shownAtMs) =>
917 {
918 if (token !== currentFrameToken || refreshLifecycleToken !== lifecycleToken) return;
919 const shownAtVideoTimeSeconds = roundLogNumber(player.currentTime());
920 logSubtitleEvent('subtitle_png_shown', {
921 ...responseMeta,
922 receivedAtMs,
923 shownAtMs,
924 shownAtVideoTimeSeconds,
925 sentToReceivedMs: diffMilliseconds(receivedAtMs, responseMeta.serverResponseSentAtMs),
926 receivedToShownMs: diffMilliseconds(shownAtMs, receivedAtMs),
927 shouldVsShownDiffSeconds: diffSeconds(shownAtVideoTimeSeconds, responseMeta.shouldShowAtVideoTimeSeconds),
928 });
730 929 });
731 });
732 930
733 queueLookaheadPrefetch(currentTime, { reset: force });
734 } catch (error)
931 queueLookaheadPrefetch(currentTime, { reset: force });
932 } catch (error)
933 {
934 if (isAbortError(error)) return;
935 logSubtitleEvent('subtitle_png_request_failed', {
936 requestId,
937 requestKind: 'current',
938 requestedAtMs: requestStartedAtMs,
939 errorName: error && error.name ? String(error.name) : null,
940 errorMessage: error && error.message ? String(error.message) : String(error || ''),
941 });
942 if (token === currentFrameToken && refreshLifecycleToken === lifecycleToken) disableTrack();
943 }
944 })().finally(() =>
735 945 {
736 if (isAbortError(error)) return;
737 logSubtitleEvent('subtitle_png_request_failed', {
738 requestId,
739 requestKind: 'current',
740 requestedAtMs: requestStartedAtMs,
741 errorName: error && error.name ? String(error.name) : null,
742 errorMessage: error && error.message ? String(error.message) : String(error || ''),
743 });
744 if (token === currentFrameToken && refreshLifecycleToken === lifecycleToken) disableTrack();
745 }
946 if (token !== currentFrameToken) return;
947 currentFrameAbortController = null;
948 currentFramePromise = null;
949 if (!queuedCurrentRefresh) return;
950
951 const queuedForce = queuedCurrentRefreshForce;
952 queuedCurrentRefresh = false;
953 queuedCurrentRefreshForce = false;
954 void refreshFrame(queuedForce);
955 });
956
957 return currentFramePromise;
746 958 };
747 959
748 960 const dispose = () =>
@@ -751,6 +963,10 @@
751 963 flushSubtitleLogs();
752 964 closeMenu();
753 965 hideOverlay();
966 if (seekMarkerContainerEl) seekMarkerContainerEl.remove();
967 seekMarkerContainerEl = null;
968 seekMarkerRequestedEl = null;
969 seekMarkerReceivedEl = null;
754 970 if (overlayEl) overlayEl.remove();
755 971 if (menuEl) menuEl.remove();
756 972 player.imageSubtitleOverlayController = null;
@@ -922,12 +1138,17 @@
922 1138 player.ready(() =>
923 1139 {
924 1140 attachUi();
1141 ensureSeekBarMarkers();
925 1142 updateMenuState();
926 1143 updateButtonState();
1144 updateSeekBarMarkers();
927 1145 applySavedTracks();
928 1146 if (menuOpen) openMenu();
929 1147 });
930 1148
1149 player.on('durationchange', () => { ensureSeekBarMarkers(); updateSeekBarMarkers(); });
1150 player.on('loadedmetadata', () => { ensureSeekBarMarkers(); updateSeekBarMarkers(); });
1151
931 1152 return player.imageSubtitleOverlayController;
932 1153 }
933 1154
@@ -282,6 +282,14 @@
282 let prefetchPromise = null;
282 let prefetchPromise = null;
283 let prefetchTargetTimeSeconds = -1;
283 let prefetchTargetTimeSeconds = -1;
284 let prefetchedThroughTimeSeconds = -1;
284 let prefetchedThroughTimeSeconds = -1;
285 let queuedCurrentRefresh = false;
286 let queuedCurrentRefreshForce = false;
287 let currentFramePromise = null;
288 let seekMarkerContainerEl = null;
289 let seekMarkerRequestedEl = null;
290 let seekMarkerReceivedEl = null;
291 let lastRequestedCaptionStartTimeSeconds = null;
292 let lastReceivedCaptionStartTimeSeconds = null;
285 let subtitleLogSequence = 0;
293 let subtitleLogSequence = 0;
286 let subtitleLogQueue = [];
294 let subtitleLogQueue = [];
287 let subtitleLogFlushTimer = null;
295 let subtitleLogFlushTimer = null;
@@ -409,6 +417,106 @@
409 closeObjectUrl();
417 closeObjectUrl();
410 };
418 };
411
419
420 const setSeekMarkerTime = (kind, timeSeconds) =>
421 {
422 const numericTime = Number(timeSeconds);
423 const nextTime = Number.isFinite(numericTime) && numericTime >= 0 ? numericTime : null;
424
425 if (kind === 'requested')
426 {
427 lastRequestedCaptionStartTimeSeconds = nextTime;
428 } else if (kind === 'received')
429 {
430 lastReceivedCaptionStartTimeSeconds = nextTime;
431 }
432 };
433
434 const updateSeekBarMarkers = () =>
435 {
436 if (!seekMarkerRequestedEl || !seekMarkerReceivedEl) return;
437
438 const duration = Number(player.duration && player.duration());
439 if (!Number.isFinite(duration) || duration <= 0)
440 {
441 seekMarkerRequestedEl.style.display = 'none';
442 seekMarkerReceivedEl.style.display = 'none';
443 return;
444 }
445
446 const applyMarker = (markerEl, markerTimeSeconds) =>
447 {
448 if (!Number.isFinite(markerTimeSeconds) || markerTimeSeconds < 0)
449 {
450 markerEl.style.display = 'none';
451 return;
452 }
453
454 const ratio = Math.max(0, Math.min(1, markerTimeSeconds / duration));
455 markerEl.style.display = 'block';
456 markerEl.style.left = `${(ratio * 100).toFixed(4)}%`;
457 };
458
459 applyMarker(seekMarkerRequestedEl, lastRequestedCaptionStartTimeSeconds);
460 applyMarker(seekMarkerReceivedEl, lastReceivedCaptionStartTimeSeconds);
461 };
462
463 const ensureSeekBarMarkers = () =>
464 {
465 if (seekMarkerContainerEl && seekMarkerContainerEl.isConnected)
466 {
467 updateSeekBarMarkers();
468 return;
469 }
470
471 const playerEl = player.el && player.el();
472 if (!playerEl) return;
473
474 const seekBarEl = playerEl.querySelector('.vjs-progress-control')
475 || playerEl.querySelector('.vjs-progress-holder')
476 || playerEl.querySelector('.vjs-seek-bar');
477 if (!seekBarEl) return;
478
479 const computedPosition = window.getComputedStyle(seekBarEl).position;
480 if (computedPosition === 'static') seekBarEl.style.position = 'relative';
481
482 seekMarkerContainerEl = document.createElement('div');
483 seekMarkerContainerEl.className = 'vjs-image-subtitle-seek-markers';
484 seekMarkerContainerEl.style.position = 'absolute';
485 seekMarkerContainerEl.style.left = '0';
486 seekMarkerContainerEl.style.right = '0';
487 seekMarkerContainerEl.style.top = '-9px';
488 seekMarkerContainerEl.style.height = '10px';
489 seekMarkerContainerEl.style.pointerEvents = 'none';
490 seekMarkerContainerEl.style.zIndex = '5';
491
492 const buildTriangle = (direction) =>
493 {
494 const markerEl = document.createElement('span');
495 markerEl.className = `vjs-image-subtitle-seek-marker vjs-image-subtitle-seek-marker-${direction}`;
496 markerEl.style.position = 'absolute';
497 markerEl.style.width = '12px';
498 markerEl.style.height = '10px';
499 markerEl.style.transform = 'translateX(-50%)';
500 markerEl.style.background = '#fff';
501 markerEl.style.border = '1px solid #000';
502 markerEl.style.display = 'none';
503 markerEl.style.boxSizing = 'border-box';
504 markerEl.style.clipPath = direction === 'left'
505 ? 'polygon(100% 0, 0 50%, 100% 100%)'
506 : 'polygon(0 0, 100% 50%, 0 100%)';
507 markerEl.setAttribute('aria-hidden', 'true');
508 return markerEl;
509 };
510
511 seekMarkerReceivedEl = buildTriangle('left');
512 seekMarkerRequestedEl = buildTriangle('right');
513 seekMarkerContainerEl.appendChild(seekMarkerReceivedEl);
514 seekMarkerContainerEl.appendChild(seekMarkerRequestedEl);
515
516 seekBarEl.appendChild(seekMarkerContainerEl);
517 updateSeekBarMarkers();
518 };
519
412 const updateButtonState = () =>
520 const updateButtonState = () =>
413 {
521 {
414 if (!buttonEl) return;
522 if (!buttonEl) return;
@@ -469,6 +577,9 @@
469 trackDisabled = true;
577 trackDisabled = true;
470 selectedStreamIndex = null;
578 selectedStreamIndex = null;
471 activeBucket = -1;
579 activeBucket = -1;
580 setSeekMarkerTime('requested', null);
581 setSeekMarkerTime('received', null);
582 updateSeekBarMarkers();
472 resetRequestState();
583 resetRequestState();
473 hideOverlay();
584 hideOverlay();
474 updateButtonState();
585 updateButtonState();
@@ -491,6 +602,9 @@
491 failureNotified = false;
602 failureNotified = false;
492 selectedStreamIndex = nextStreamIndex;
603 selectedStreamIndex = nextStreamIndex;
493 activeBucket = -1;
604 activeBucket = -1;
605 setSeekMarkerTime('requested', null);
606 setSeekMarkerTime('received', null);
607 updateSeekBarMarkers();
494 resetRequestState();
608 resetRequestState();
495 hideOverlay();
609 hideOverlay();
496 updateButtonState();
610 updateButtonState();
@@ -546,6 +660,16 @@
546 });
660 });
547 if (!request || !request.url) return;
661 if (!request || !request.url) return;
548
662
663 const prefetchRequestStartedAtMs = Date.now();
664 const prefetchRequestId = `prefetch-${workerToken}-${Math.round(nextTime * 1000)}`;
665 logSubtitleEvent('subtitle_png_requested', {
666 requestId: prefetchRequestId,
667 requestKind: 'prefetch',
668 requestUrl: String(request.url || ''),
669 requestedAtMs: prefetchRequestStartedAtMs,
670 requestedVideoTimeSeconds: roundLogNumber(nextTime),
671 });
672
549 try
673 try
550 {
674 {
551 const res = await fetch(request.url, {
675 const res = await fetch(request.url, {
@@ -556,20 +680,66 @@
556 });
680 });
557
681
558 if (workerToken !== prefetchWorkerToken || workerLifecycleToken !== lifecycleToken) return;
682 if (workerToken !== prefetchWorkerToken || workerLifecycleToken !== lifecycleToken) return;
683
684 const responseMeta = {
685 requestId: prefetchRequestId,
686 requestKind: 'prefetch',
687 status: res.status,
688 serverRequestReceivedAtMs: parseHeaderInt(res, 'X-Subtitle-Request-Received-At-Ms'),
689 serverResponseSentAtMs: parseHeaderInt(res, 'X-Subtitle-Response-Sent-At-Ms'),
690 shouldShowAtVideoTimeSeconds: parseHeaderFloat(res, 'X-Subtitle-Frame-Start-Time'),
691 subtitleEndTimeSeconds: parseHeaderFloat(res, 'X-Subtitle-Frame-End-Time'),
692 responseHeadersReceivedAtMs: Date.now(),
693 };
694 if (Number.isFinite(responseMeta.shouldShowAtVideoTimeSeconds))
695 {
696 setSeekMarkerTime('requested', responseMeta.shouldShowAtVideoTimeSeconds);
697 updateSeekBarMarkers();
698 }
699 logSubtitleEvent('subtitle_png_sent', {
700 ...responseMeta,
701 serverProcessingMs: diffMilliseconds(responseMeta.serverResponseSentAtMs, responseMeta.serverRequestReceivedAtMs),
702 sentToHeadersReceivedMs: diffMilliseconds(responseMeta.responseHeadersReceivedAtMs, responseMeta.serverResponseSentAtMs),
703 });
704
559 if (res.status === 204)
705 if (res.status === 204)
560 {
706 {
561 const frameStatus = String(res.headers.get('X-Subtitle-Frame-Status') || '').toLowerCase();
707 const frameStatus = String(res.headers.get('X-Subtitle-Frame-Status') || '').toLowerCase();
708 logSubtitleEvent('subtitle_png_not_available', {
709 ...responseMeta,
710 frameStatus,
711 });
562 if (frameStatus === 'error') return;
712 if (frameStatus === 'error') return;
563 prefetchedThroughTimeSeconds = nextTime;
713 prefetchedThroughTimeSeconds = nextTime;
564 continue;
714 continue;
565 }
715 }
566
716
567 if (!res.ok) return;
717 if (!res.ok) return;
568 await res.arrayBuffer();
718 const payload = await res.arrayBuffer();
719 const receivedAtMs = Date.now();
720 if (Number.isFinite(responseMeta.shouldShowAtVideoTimeSeconds))
721 {
722 setSeekMarkerTime('received', responseMeta.shouldShowAtVideoTimeSeconds);
723 updateSeekBarMarkers();
724 }
725 logSubtitleEvent('subtitle_png_received', {
726 ...responseMeta,
727 receivedAtMs,
728 sentToReceivedMs: diffMilliseconds(receivedAtMs, responseMeta.serverResponseSentAtMs),
729 requestedToReceivedMs: diffMilliseconds(receivedAtMs, prefetchRequestStartedAtMs),
730 blobBytes: Number(payload && payload.byteLength || 0),
731 });
569 prefetchedThroughTimeSeconds = nextTime;
732 prefetchedThroughTimeSeconds = nextTime;
570 } catch (error)
733 } catch (error)
571 {
734 {
572 if (isAbortError(error)) return;
735 if (isAbortError(error)) return;
736 logSubtitleEvent('subtitle_png_request_failed', {
737 requestId: prefetchRequestId,
738 requestKind: 'prefetch',
739 requestedAtMs: prefetchRequestStartedAtMs,
740 errorName: error && error.name ? String(error.name) : null,
741 errorMessage: error && error.message ? String(error.message) : String(error || ''),
742 });
573 return;
743 return;
574 }
744 }
575 }
745 }
@@ -587,6 +757,12 @@
587 if (!overlayEl || !overlayImgEl) return;
757 if (!overlayEl || !overlayImgEl) return;
588 if (trackDisabled) return;
758 if (trackDisabled) return;
589
759
760 if (currentFramePromise && !force)
761 {
762 queuedCurrentRefresh = true;
763 return;
764 }
765
590 const currentTime = Number(player.currentTime());
766 const currentTime = Number(player.currentTime());
591 if (!Number.isFinite(currentTime) || currentTime < 0) return;
767 if (!Number.isFinite(currentTime) || currentTime < 0) return;
592
768
@@ -595,6 +771,16 @@
595 activeBucket = bucket;
771 activeBucket = bucket;
596
772
597 const refreshLifecycleToken = lifecycleToken;
773 const refreshLifecycleToken = lifecycleToken;
774 if (force && currentFramePromise)
775 {
776 cancelCurrentFrameRequest();
777 }
778 if (currentFramePromise)
779 {
780 queuedCurrentRefresh = true;
781 queuedCurrentRefreshForce = queuedCurrentRefreshForce || !!force;
782 return;
783 }
598 cancelCurrentFrameRequest();
784 cancelCurrentFrameRequest();
599 if (force) cancelPrefetchRequests({ resetProgress: true });
785 if (force) cancelPrefetchRequests({ resetProgress: true });
600
786
@@ -623,126 +809,152 @@
623 requestedVideoTimeSeconds: roundLogNumber(currentTime),
809 requestedVideoTimeSeconds: roundLogNumber(currentTime),
624 });
810 });
625
811
626 try
812 currentFramePromise = (async () =>
627 {
813 {
628 const res = await fetch(request.url, {
814 try
629 method: request.method || 'GET',
630 headers: request.headers,
631 credentials: request.credentials,
632 signal: controller ? controller.signal : undefined,
633 });
634
635 if (token !== currentFrameToken || refreshLifecycleToken !== lifecycleToken) return;
636
637 const responseMeta = {
638 requestId,
639 requestKind: 'current',
640 status: res.status,
641 serverRequestReceivedAtMs: parseHeaderInt(res, 'X-Subtitle-Request-Received-At-Ms'),
642 serverResponseSentAtMs: parseHeaderInt(res, 'X-Subtitle-Response-Sent-At-Ms'),
643 shouldShowAtVideoTimeSeconds: parseHeaderFloat(res, 'X-Subtitle-Frame-Start-Time'),
644 subtitleEndTimeSeconds: parseHeaderFloat(res, 'X-Subtitle-Frame-End-Time'),
645 responseHeadersReceivedAtMs: Date.now(),
646 };
647 logSubtitleEvent('subtitle_png_sent', {
648 ...responseMeta,
649 serverProcessingMs: diffMilliseconds(responseMeta.serverResponseSentAtMs, responseMeta.serverRequestReceivedAtMs),
650 sentToHeadersReceivedMs: diffMilliseconds(responseMeta.responseHeadersReceivedAtMs, responseMeta.serverResponseSentAtMs),
651 });
652
653 if (res.status === 204)
654 {
815 {
655 const frameStatus = String(res.headers.get('X-Subtitle-Frame-Status') || '').toLowerCase();
816 const res = await fetch(request.url, {
656 logSubtitleEvent('subtitle_png_not_available', {
817 method: request.method || 'GET',
818 headers: request.headers,
819 credentials: request.credentials,
820 signal: controller ? controller.signal : undefined,
821 });
822
823 if (token !== currentFrameToken || refreshLifecycleToken !== lifecycleToken) return;
824
825 const responseMeta = {
826 requestId,
827 requestKind: 'current',
828 status: res.status,
829 serverRequestReceivedAtMs: parseHeaderInt(res, 'X-Subtitle-Request-Received-At-Ms'),
830 serverResponseSentAtMs: parseHeaderInt(res, 'X-Subtitle-Response-Sent-At-Ms'),
831 shouldShowAtVideoTimeSeconds: parseHeaderFloat(res, 'X-Subtitle-Frame-Start-Time'),
832 subtitleEndTimeSeconds: parseHeaderFloat(res, 'X-Subtitle-Frame-End-Time'),
833 responseHeadersReceivedAtMs: Date.now(),
834 };
835 if (Number.isFinite(responseMeta.shouldShowAtVideoTimeSeconds))
836 {
837 setSeekMarkerTime('requested', responseMeta.shouldShowAtVideoTimeSeconds);
838 updateSeekBarMarkers();
839 }
840 logSubtitleEvent('subtitle_png_sent', {
657 ...responseMeta,
841 ...responseMeta,
658 frameStatus,
842 serverProcessingMs: diffMilliseconds(responseMeta.serverResponseSentAtMs, responseMeta.serverRequestReceivedAtMs),
843 sentToHeadersReceivedMs: diffMilliseconds(responseMeta.responseHeadersReceivedAtMs, responseMeta.serverResponseSentAtMs),
659 });
844 });
660 hideOverlay();
661 if (frameStatus === 'error') disableTrack();
662 else queueLookaheadPrefetch(currentTime, { reset: force });
663 return;
664 }
665
845
666 if (!res.ok)
846 if (res.status === 204)
667 {
847 {
668 disableTrack();
848 const frameStatus = String(res.headers.get('X-Subtitle-Frame-Status') || '').toLowerCase();
669 return;
849 logSubtitleEvent('subtitle_png_not_available', {
670 }
850 ...responseMeta,
851 frameStatus,
852 });
853 hideOverlay();
854 if (frameStatus === 'error') disableTrack();
855 else queueLookaheadPrefetch(currentTime, { reset: force });
856 return;
857 }
671
858
672 const blob = await res.blob();
859 if (!res.ok)
673 if (token !== currentFrameToken || refreshLifecycleToken !== lifecycleToken) return;
860 {
861 disableTrack();
862 return;
863 }
674
864
675 const receivedAtMs = Date.now();
865 const blob = await res.blob();
676 logSubtitleEvent('subtitle_png_received', {
866 if (token !== currentFrameToken || refreshLifecycleToken !== lifecycleToken) return;
677 ...responseMeta,
678 receivedAtMs,
679 sentToReceivedMs: diffMilliseconds(receivedAtMs, responseMeta.serverResponseSentAtMs),
680 requestedToReceivedMs: diffMilliseconds(receivedAtMs, requestStartedAtMs),
681 blobBytes: Number(blob && blob.size || 0),
682 });
683
867
684 if (!blob || blob.size === 0)
868 const receivedAtMs = Date.now();
685 {
869 if (Number.isFinite(responseMeta.shouldShowAtVideoTimeSeconds))
686 disableTrack();
870 {
687 return;
871 setSeekMarkerTime('received', responseMeta.shouldShowAtVideoTimeSeconds);
688 }
872 updateSeekBarMarkers();
873 }
874 logSubtitleEvent('subtitle_png_received', {
875 ...responseMeta,
876 receivedAtMs,
877 sentToReceivedMs: diffMilliseconds(receivedAtMs, responseMeta.serverResponseSentAtMs),
878 requestedToReceivedMs: diffMilliseconds(receivedAtMs, requestStartedAtMs),
879 blobBytes: Number(blob && blob.size || 0),
880 });
689
881
690 closeObjectUrl();
882 if (!blob || blob.size === 0)
691 activeObjectUrl = URL.createObjectURL(blob);
883 {
692 overlayImgEl.src = activeObjectUrl;
884 disableTrack();
885 return;
886 }
887
888 closeObjectUrl();
889 activeObjectUrl = URL.createObjectURL(blob);
890 overlayImgEl.src = activeObjectUrl;
693
891
694 const frameWidth = Number.parseInt(String(res.headers.get('X-Subtitle-Frame-Width') || ''), 10);
892 const frameWidth = Number.parseInt(String(res.headers.get('X-Subtitle-Frame-Width') || ''), 10);
695 const frameHeight = Number.parseInt(String(res.headers.get('X-Subtitle-Frame-Height') || ''), 10);
893 const frameHeight = Number.parseInt(String(res.headers.get('X-Subtitle-Frame-Height') || ''), 10);
696 const canvasWidth = Number.parseInt(String(res.headers.get('X-Subtitle-Frame-Canvas-Width') || ''), 10);
894 const canvasWidth = Number.parseInt(String(res.headers.get('X-Subtitle-Frame-Canvas-Width') || ''), 10);
697 const canvasHeight = Number.parseInt(String(res.headers.get('X-Subtitle-Frame-Canvas-Height') || ''), 10);
895 const canvasHeight = Number.parseInt(String(res.headers.get('X-Subtitle-Frame-Canvas-Height') || ''), 10);
698
896
699 if (frameWidth > 0 && frameHeight > 0 && canvasWidth > 0 && canvasHeight > 0)
897 if (frameWidth > 0 && frameHeight > 0 && canvasWidth > 0 && canvasHeight > 0)
700 {
898 {
701 const widthPercent = (frameWidth / canvasWidth) * 100;
899 const widthPercent = (frameWidth / canvasWidth) * 100;
702 const heightPercent = (frameHeight / canvasHeight) * 100;
900 const heightPercent = (frameHeight / canvasHeight) * 100;
703 overlayImgEl.style.width = `${widthPercent}%`;
901 overlayImgEl.style.width = `${widthPercent}%`;
704 overlayImgEl.style.height = `${heightPercent}%`;
902 overlayImgEl.style.height = `${heightPercent}%`;
705 overlayImgEl.style.maxWidth = 'none';
903 overlayImgEl.style.maxWidth = 'none';
706 overlayImgEl.style.maxHeight = 'none';
904 overlayImgEl.style.maxHeight = 'none';
707 } else
905 } else
708 {
906 {
709 overlayImgEl.style.width = 'auto';
907 overlayImgEl.style.width = 'auto';
710 overlayImgEl.style.height = 'auto';
908 overlayImgEl.style.height = 'auto';
711 overlayImgEl.style.maxWidth = '100%';
909 overlayImgEl.style.maxWidth = '100%';
712 overlayImgEl.style.maxHeight = '100%';
910 overlayImgEl.style.maxHeight = '100%';
713 }
911 }
714
912
715 overlayEl.style.display = 'block';
913 overlayEl.style.display = 'block';
716 overlayImgEl.style.display = 'block';
914 overlayImgEl.style.display = 'block';
717
915
718 void waitForImagePresentation(window, overlayImgEl).then((shownAtMs) =>
916 void waitForImagePresentation(window, overlayImgEl).then((shownAtMs) =>
719 {
917 {
720 if (token !== currentFrameToken || refreshLifecycleToken !== lifecycleToken) return;
918 if (token !== currentFrameToken || refreshLifecycleToken !== lifecycleToken) return;
721 const shownAtVideoTimeSeconds = roundLogNumber(player.currentTime());
919 const shownAtVideoTimeSeconds = roundLogNumber(player.currentTime());
722 logSubtitleEvent('subtitle_png_shown', {
920 logSubtitleEvent('subtitle_png_shown', {
723 ...responseMeta,
921 ...responseMeta,
724 receivedAtMs,
922 receivedAtMs,
725 shownAtMs,
923 shownAtMs,
726 shownAtVideoTimeSeconds,
924 shownAtVideoTimeSeconds,
727 sentToReceivedMs: diffMilliseconds(receivedAtMs, responseMeta.serverResponseSentAtMs),
925 sentToReceivedMs: diffMilliseconds(receivedAtMs, responseMeta.serverResponseSentAtMs),
728 receivedToShownMs: diffMilliseconds(shownAtMs, receivedAtMs),
926 receivedToShownMs: diffMilliseconds(shownAtMs, receivedAtMs),
729 shouldVsShownDiffSeconds: diffSeconds(shownAtVideoTimeSeconds, responseMeta.shouldShowAtVideoTimeSeconds),
927 shouldVsShownDiffSeconds: diffSeconds(shownAtVideoTimeSeconds, responseMeta.shouldShowAtVideoTimeSeconds),
928 });
730 });
929 });
731 });
732
930
733 queueLookaheadPrefetch(currentTime, { reset: force });
931 queueLookaheadPrefetch(currentTime, { reset: force });
734 } catch (error)
932 } catch (error)
933 {
934 if (isAbortError(error)) return;
935 logSubtitleEvent('subtitle_png_request_failed', {
936 requestId,
937 requestKind: 'current',
938 requestedAtMs: requestStartedAtMs,
939 errorName: error && error.name ? String(error.name) : null,
940 errorMessage: error && error.message ? String(error.message) : String(error || ''),
941 });
942 if (token === currentFrameToken && refreshLifecycleToken === lifecycleToken) disableTrack();
943 }
944 })().finally(() =>
735 {
945 {
736 if (isAbortError(error)) return;
946 if (token !== currentFrameToken) return;
737 logSubtitleEvent('subtitle_png_request_failed', {
947 currentFrameAbortController = null;
738 requestId,
948 currentFramePromise = null;
739 requestKind: 'current',
949 if (!queuedCurrentRefresh) return;
740 requestedAtMs: requestStartedAtMs,
950
741 errorName: error && error.name ? String(error.name) : null,
951 const queuedForce = queuedCurrentRefreshForce;
742 errorMessage: error && error.message ? String(error.message) : String(error || ''),
952 queuedCurrentRefresh = false;
743 });
953 queuedCurrentRefreshForce = false;
744 if (token === currentFrameToken && refreshLifecycleToken === lifecycleToken) disableTrack();
954 void refreshFrame(queuedForce);
745 }
955 });
956
957 return currentFramePromise;
746 };
958 };
747
959
748 const dispose = () =>
960 const dispose = () =>
@@ -751,6 +963,10 @@
751 flushSubtitleLogs();
963 flushSubtitleLogs();
752 closeMenu();
964 closeMenu();
753 hideOverlay();
965 hideOverlay();
966 if (seekMarkerContainerEl) seekMarkerContainerEl.remove();
967 seekMarkerContainerEl = null;
968 seekMarkerRequestedEl = null;
969 seekMarkerReceivedEl = null;
754 if (overlayEl) overlayEl.remove();
970 if (overlayEl) overlayEl.remove();
755 if (menuEl) menuEl.remove();
971 if (menuEl) menuEl.remove();
756 player.imageSubtitleOverlayController = null;
972 player.imageSubtitleOverlayController = null;
@@ -922,12 +1138,17 @@
922 player.ready(() =>
1138 player.ready(() =>
923 {
1139 {
924 attachUi();
1140 attachUi();
1141 ensureSeekBarMarkers();
925 updateMenuState();
1142 updateMenuState();
926 updateButtonState();
1143 updateButtonState();
1144 updateSeekBarMarkers();
927 applySavedTracks();
1145 applySavedTracks();
928 if (menuOpen) openMenu();
1146 if (menuOpen) openMenu();
929 });
1147 });
930
1148
1149 player.on('durationchange', () => { ensureSeekBarMarkers(); updateSeekBarMarkers(); });
1150 player.on('loadedmetadata', () => { ensureSeekBarMarkers(); updateSeekBarMarkers(); });
1151
931 return player.imageSubtitleOverlayController;
1152 return player.imageSubtitleOverlayController;
932 }
1153 }
933
1154
tests/shared-video-player.test.js +175 −0
@@ -62,7 +62,11 @@ function buildPlayerHarness (window)
62 62
63 63 const events = new Map();
64 64 const playerEl = window.document.createElement('div');
65 const progressControlEl = window.document.createElement('div');
66 progressControlEl.className = 'vjs-progress-control';
67 playerEl.appendChild(progressControlEl);
65 68 let currentTime = 0;
69 let durationSeconds = 10;
66 70
67 71 const player = {
68 72 ready (cb)
@@ -88,6 +92,14 @@ function buildPlayerHarness (window)
88 92 {
89 93 currentTime = Number(next);
90 94 },
95 duration (nextValue)
96 {
97 if (typeof nextValue === 'number')
98 {
99 durationSeconds = nextValue;
100 }
101 return durationSeconds;
102 },
91 103 el ()
92 104 {
93 105 return playerEl;
@@ -171,6 +183,66 @@ describe('shared image subtitle prefetching', () =>
171 183 window.close();
172 184 });
173 185
186 test('does not restart current subtitle request while one is in flight', async () =>
187 {
188 const window = createWindow();
189 const helper = loadSharedVideoPlayer(window);
190 const { player, videojs } = buildPlayerHarness(window);
191 const pendingResolvers = [];
192 const requestTimes = [];
193
194 window.fetch = jest.fn((url, init = {}) =>
195 {
196 const parsed = new URL(url, 'http://localhost/');
197 requestTimes.push(Number(parsed.searchParams.get('timeSeconds')));
198
199 if (pendingResolvers.length === 0)
200 {
201 return new Promise((resolve) =>
202 {
203 pendingResolvers.push(() => resolve(new Response(null, {
204 status: 204,
205 headers: { 'X-Subtitle-Frame-Status': 'none' },
206 })));
207 });
208 }
209
210 expect(init.signal && init.signal.aborted).toBe(false);
211 return Promise.resolve(new Response(null, {
212 status: 204,
213 headers: { 'X-Subtitle-Frame-Status': 'none' },
214 }));
215 });
216
217 helper.bindImageSubtitleOverlay(player, videojs, {}, {
218 imageSubtitleTracks: [{ label: 'PGS English', streamIndex: 0, default: true }],
219 }, {
220 lookaheadSeconds: 0,
221 buildFrameRequest: ({ currentTime, streamIndex }) => ({
222 url: `/subtitle-frame?streamIndex=${streamIndex}&timeSeconds=${currentTime}`,
223 }),
224 });
225
226 await flushAsyncWork(window, 3);
227 expect(window.fetch).toHaveBeenCalledTimes(1);
228
229 player.setCurrentTime(1.5);
230 player.trigger('timeupdate');
231 player.setCurrentTime(2.25);
232 player.trigger('timeupdate');
233 await flushAsyncWork(window, 2);
234
235 expect(window.fetch).toHaveBeenCalledTimes(1);
236
237 pendingResolvers[0]();
238 await flushAsyncWork(window, 5);
239
240 expect(window.fetch.mock.calls.length).toBeGreaterThanOrEqual(2);
241 expect(requestTimes).toEqual(expect.arrayContaining([0, 2.25]));
242
243 window.close();
244 });
245
174 246 test('aborts in-flight prefetch requests when the overlay is detached', async () =>
175 247 {
176 248 const window = createWindow();
@@ -279,4 +351,107 @@ describe('shared image subtitle prefetching', () =>
279 351
280 352 window.close();
281 353 });
354
355 test('logs prefetch subtitle lifecycle events', async () =>
356 {
357 const window = createWindow();
358 const helper = loadSharedVideoPlayer(window);
359 const { player, videojs } = buildPlayerHarness(window);
360 const sentBatches = [];
361
362 window.fetch = jest.fn(async () =>
363 {
364 return new Response(null, {
365 status: 204,
366 headers: {
367 'X-Subtitle-Frame-Status': 'none',
368 'X-Subtitle-Request-Received-At-Ms': '1000',
369 'X-Subtitle-Response-Sent-At-Ms': '1010',
370 'X-Subtitle-Frame-Start-Time': '2',
371 'X-Subtitle-Frame-End-Time': '3',
372 },
373 });
374 });
375
376 const controller = helper.bindImageSubtitleOverlay(player, videojs, {}, {
377 sessionId: 'sess-1',
378 imageSubtitleTracks: [{ label: 'PGS English', streamIndex: 0, default: true }],
379 }, {
380 lookaheadSeconds: 1,
381 sendSubtitleLogBatch: (entries) =>
382 {
383 sentBatches.push(entries);
384 return Promise.resolve();
385 },
386 buildFrameRequest: ({ currentTime, streamIndex }) => ({
387 url: `/subtitle-frame?streamIndex=${streamIndex}&timeSeconds=${currentTime}`,
388 }),
389 });
390
391 await flushAsyncWork(window, 8);
392 controller.detach();
393 await flushAsyncWork(window, 4);
394
395 const flattened = sentBatches.flat();
396 const prefetchEvents = flattened.filter((entry) => entry.requestKind === 'prefetch').map((entry) => entry.eventType);
397 expect(prefetchEvents).toEqual(expect.arrayContaining([
398 'subtitle_png_requested',
399 'subtitle_png_sent',
400 'subtitle_png_not_available',
401 ]));
402
403 window.close();
404 });
405
406 test('renders requested and received subtitle markers on the seek bar', async () =>
407 {
408 const window = createWindow();
409 const helper = loadSharedVideoPlayer(window);
410 const { player, videojs } = buildPlayerHarness(window);
411
412 window.fetch = jest.fn(async () =>
413 {
414 return new Response('png-data', {
415 status: 200,
416 headers: {
417 'Content-Type': 'image/png',
418 'X-Subtitle-Frame-Status': 'ok',
419 'X-Subtitle-Request-Received-At-Ms': '1000',
420 'X-Subtitle-Response-Sent-At-Ms': '1012',
421 'X-Subtitle-Frame-Start-Time': '2.5',
422 'X-Subtitle-Frame-End-Time': '3.5',
423 'X-Subtitle-Frame-Width': '320',
424 'X-Subtitle-Frame-Height': '180',
425 'X-Subtitle-Frame-Canvas-Width': '640',
426 'X-Subtitle-Frame-Canvas-Height': '360',
427 },
428 });
429 });
430
431 player.duration(10);
432 const controller = helper.bindImageSubtitleOverlay(player, videojs, {}, {
433 imageSubtitleTracks: [{ label: 'PGS English', streamIndex: 0, default: true }],
434 }, {
435 lookaheadSeconds: 0,
436 buildFrameRequest: ({ currentTime, streamIndex }) => ({
437 url: `/subtitle-frame?streamIndex=${streamIndex}&timeSeconds=${currentTime}`,
438 }),
439 });
440
441 await flushAsyncWork(window, 8);
442
443 const requestedMarker = player.el().querySelector('.vjs-image-subtitle-seek-marker-right');
444 const receivedMarker = player.el().querySelector('.vjs-image-subtitle-seek-marker-left');
445 expect(requestedMarker).toBeTruthy();
446 expect(receivedMarker).toBeTruthy();
447 expect(requestedMarker.style.display).toBe('block');
448 expect(receivedMarker.style.display).toBe('block');
449 expect(requestedMarker.style.left).toBe('25.0000%');
450 expect(receivedMarker.style.left).toBe('25.0000%');
451
452 controller.detach();
453 await flushAsyncWork(window, 2);
454
455 window.close();
456 });
282 457 });
@@ -62,7 +62,11 @@ function buildPlayerHarness (window)
62
62
63 const events = new Map();
63 const events = new Map();
64 const playerEl = window.document.createElement('div');
64 const playerEl = window.document.createElement('div');
65 const progressControlEl = window.document.createElement('div');
66 progressControlEl.className = 'vjs-progress-control';
67 playerEl.appendChild(progressControlEl);
65 let currentTime = 0;
68 let currentTime = 0;
69 let durationSeconds = 10;
66
70
67 const player = {
71 const player = {
68 ready (cb)
72 ready (cb)
@@ -88,6 +92,14 @@ function buildPlayerHarness (window)
88 {
92 {
89 currentTime = Number(next);
93 currentTime = Number(next);
90 },
94 },
95 duration (nextValue)
96 {
97 if (typeof nextValue === 'number')
98 {
99 durationSeconds = nextValue;
100 }
101 return durationSeconds;
102 },
91 el ()
103 el ()
92 {
104 {
93 return playerEl;
105 return playerEl;
@@ -171,6 +183,66 @@ describe('shared image subtitle prefetching', () =>
171 window.close();
183 window.close();
172 });
184 });
173
185
186 test('does not restart current subtitle request while one is in flight', async () =>
187 {
188 const window = createWindow();
189 const helper = loadSharedVideoPlayer(window);
190 const { player, videojs } = buildPlayerHarness(window);
191 const pendingResolvers = [];
192 const requestTimes = [];
193
194 window.fetch = jest.fn((url, init = {}) =>
195 {
196 const parsed = new URL(url, 'http://localhost/');
197 requestTimes.push(Number(parsed.searchParams.get('timeSeconds')));
198
199 if (pendingResolvers.length === 0)
200 {
201 return new Promise((resolve) =>
202 {
203 pendingResolvers.push(() => resolve(new Response(null, {
204 status: 204,
205 headers: { 'X-Subtitle-Frame-Status': 'none' },
206 })));
207 });
208 }
209
210 expect(init.signal && init.signal.aborted).toBe(false);
211 return Promise.resolve(new Response(null, {
212 status: 204,
213 headers: { 'X-Subtitle-Frame-Status': 'none' },
214 }));
215 });
216
217 helper.bindImageSubtitleOverlay(player, videojs, {}, {
218 imageSubtitleTracks: [{ label: 'PGS English', streamIndex: 0, default: true }],
219 }, {
220 lookaheadSeconds: 0,
221 buildFrameRequest: ({ currentTime, streamIndex }) => ({
222 url: `/subtitle-frame?streamIndex=${streamIndex}&timeSeconds=${currentTime}`,
223 }),
224 });
225
226 await flushAsyncWork(window, 3);
227 expect(window.fetch).toHaveBeenCalledTimes(1);
228
229 player.setCurrentTime(1.5);
230 player.trigger('timeupdate');
231 player.setCurrentTime(2.25);
232 player.trigger('timeupdate');
233 await flushAsyncWork(window, 2);
234
235 expect(window.fetch).toHaveBeenCalledTimes(1);
236
237 pendingResolvers[0]();
238 await flushAsyncWork(window, 5);
239
240 expect(window.fetch.mock.calls.length).toBeGreaterThanOrEqual(2);
241 expect(requestTimes).toEqual(expect.arrayContaining([0, 2.25]));
242
243 window.close();
244 });
245
174 test('aborts in-flight prefetch requests when the overlay is detached', async () =>
246 test('aborts in-flight prefetch requests when the overlay is detached', async () =>
175 {
247 {
176 const window = createWindow();
248 const window = createWindow();
@@ -279,4 +351,107 @@ describe('shared image subtitle prefetching', () =>
279
351
280 window.close();
352 window.close();
281 });
353 });
354
355 test('logs prefetch subtitle lifecycle events', async () =>
356 {
357 const window = createWindow();
358 const helper = loadSharedVideoPlayer(window);
359 const { player, videojs } = buildPlayerHarness(window);
360 const sentBatches = [];
361
362 window.fetch = jest.fn(async () =>
363 {
364 return new Response(null, {
365 status: 204,
366 headers: {
367 'X-Subtitle-Frame-Status': 'none',
368 'X-Subtitle-Request-Received-At-Ms': '1000',
369 'X-Subtitle-Response-Sent-At-Ms': '1010',
370 'X-Subtitle-Frame-Start-Time': '2',
371 'X-Subtitle-Frame-End-Time': '3',
372 },
373 });
374 });
375
376 const controller = helper.bindImageSubtitleOverlay(player, videojs, {}, {
377 sessionId: 'sess-1',
378 imageSubtitleTracks: [{ label: 'PGS English', streamIndex: 0, default: true }],
379 }, {
380 lookaheadSeconds: 1,
381 sendSubtitleLogBatch: (entries) =>
382 {
383 sentBatches.push(entries);
384 return Promise.resolve();
385 },
386 buildFrameRequest: ({ currentTime, streamIndex }) => ({
387 url: `/subtitle-frame?streamIndex=${streamIndex}&timeSeconds=${currentTime}`,
388 }),
389 });
390
391 await flushAsyncWork(window, 8);
392 controller.detach();
393 await flushAsyncWork(window, 4);
394
395 const flattened = sentBatches.flat();
396 const prefetchEvents = flattened.filter((entry) => entry.requestKind === 'prefetch').map((entry) => entry.eventType);
397 expect(prefetchEvents).toEqual(expect.arrayContaining([
398 'subtitle_png_requested',
399 'subtitle_png_sent',
400 'subtitle_png_not_available',
401 ]));
402
403 window.close();
404 });
405
406 test('renders requested and received subtitle markers on the seek bar', async () =>
407 {
408 const window = createWindow();
409 const helper = loadSharedVideoPlayer(window);
410 const { player, videojs } = buildPlayerHarness(window);
411
412 window.fetch = jest.fn(async () =>
413 {
414 return new Response('png-data', {
415 status: 200,
416 headers: {
417 'Content-Type': 'image/png',
418 'X-Subtitle-Frame-Status': 'ok',
419 'X-Subtitle-Request-Received-At-Ms': '1000',
420 'X-Subtitle-Response-Sent-At-Ms': '1012',
421 'X-Subtitle-Frame-Start-Time': '2.5',
422 'X-Subtitle-Frame-End-Time': '3.5',
423 'X-Subtitle-Frame-Width': '320',
424 'X-Subtitle-Frame-Height': '180',
425 'X-Subtitle-Frame-Canvas-Width': '640',
426 'X-Subtitle-Frame-Canvas-Height': '360',
427 },
428 });
429 });
430
431 player.duration(10);
432 const controller = helper.bindImageSubtitleOverlay(player, videojs, {}, {
433 imageSubtitleTracks: [{ label: 'PGS English', streamIndex: 0, default: true }],
434 }, {
435 lookaheadSeconds: 0,
436 buildFrameRequest: ({ currentTime, streamIndex }) => ({
437 url: `/subtitle-frame?streamIndex=${streamIndex}&timeSeconds=${currentTime}`,
438 }),
439 });
440
441 await flushAsyncWork(window, 8);
442
443 const requestedMarker = player.el().querySelector('.vjs-image-subtitle-seek-marker-right');
444 const receivedMarker = player.el().querySelector('.vjs-image-subtitle-seek-marker-left');
445 expect(requestedMarker).toBeTruthy();
446 expect(receivedMarker).toBeTruthy();
447 expect(requestedMarker.style.display).toBe('block');
448 expect(receivedMarker.style.display).toBe('block');
449 expect(requestedMarker.style.left).toBe('25.0000%');
450 expect(receivedMarker.style.left).toBe('25.0000%');
451
452 controller.detach();
453 await flushAsyncWork(window, 2);
454
455 window.close();
456 });
282});
457});