diff options
Diffstat (limited to 'packages/meshbay-hub')
15 files changed, 492 insertions, 4 deletions
diff --git a/packages/meshbay-hub/src/meshbay_hub/static/icon.js b/packages/meshbay-hub/src/meshbay_hub/static/icon.js index 306158a..94a82fb 100644 --- a/packages/meshbay-hub/src/meshbay_hub/static/icon.js +++ b/packages/meshbay-hub/src/meshbay_hub/static/icon.js @@ -100,6 +100,11 @@ const ICON_PATHS = { // overlapping outlines read as a tangle at 20 px. 'speech-pair': ['M11 2.5H4A1.5 1.5 0 0 0 2.5 4v4A1.5 1.5 0 0 0 4 9.5h1V12l3-2.5h3A1.5 1.5 0 0 0 12.5 8V4A1.5 1.5 0 0 0 11 2.5z', 'M13 12.5h7A1.5 1.5 0 0 1 21.5 14v4a1.5 1.5 0 0 1-1.5 1.5h-1V22l-3-2.5h-3A1.5 1.5 0 0 1 11.5 18v-4a1.5 1.5 0 0 1 1.5-1.5z'], + // A frame with two lines at its foot — the conventional subtitle glyph, and + // the reason `speech-pair` above is not a frame: the two sit side by side in + // the player's toolbar and have to be told apart at a glance. + subtitles: ['M3.5 5.5h17a1 1 0 0 1 1 1v11a1 1 0 0 1-1 1h-17a1 1 0 0 1-1-1v-11a1 1 0 0 1 1-1z', + 'M6 14.5h7', 'M15.5 14.5h2.5'], image: ['M5 3.5h14a1.5 1.5 0 0 1 1.5 1.5v14a1.5 1.5 0 0 1-1.5 1.5H5a1.5 1.5 0 0 1-1.5-1.5V5a1.5 1.5 0 0 1 1.5-1.5z', 'M7 9.5a1.5 1.5 0 1 0 3 0 1.5 1.5 0 0 0-3 0', 'M20.5 15l-5-5-9.5 9.5'], diff --git a/packages/meshbay-hub/src/meshbay_hub/static/locales/de.js b/packages/meshbay-hub/src/meshbay_hub/static/locales/de.js index 806fa38..dd53bcf 100644 --- a/packages/meshbay-hub/src/meshbay_hub/static/locales/de.js +++ b/packages/meshbay-hub/src/meshbay_hub/static/locales/de.js @@ -251,6 +251,10 @@ export default { 'video.from_start': "Von vorn beginnen", 'video.audio_track': 'Tonspur', 'video.audio_track_n': 'Spur {n}', + 'video.subtitles': 'Untertitel', + 'video.subtitles_off': 'Aus', + 'video.subtitle_track_n': 'Spur {n}', + 'video.err_subtitle': 'Diese Untertitelspur konnte nicht geladen werden', 'video.close': 'Schließen (Esc)', 'preview.pdf_fallback': 'Dieser Browser zeigt das PDF nicht direkt an. Laden Sie es ' + 'stattdessen herunter — entschlüsselt wurde es ohnehin hier.', diff --git a/packages/meshbay-hub/src/meshbay_hub/static/locales/en.js b/packages/meshbay-hub/src/meshbay_hub/static/locales/en.js index 92114c9..e9f3d8d 100644 --- a/packages/meshbay-hub/src/meshbay_hub/static/locales/en.js +++ b/packages/meshbay-hub/src/meshbay_hub/static/locales/en.js @@ -250,6 +250,10 @@ export default { 'video.from_start': "Start from the beginning", 'video.audio_track': 'Audio track', 'video.audio_track_n': 'Track {n}', + 'video.subtitles': 'Subtitles', + 'video.subtitles_off': 'Off', + 'video.subtitle_track_n': 'Track {n}', + 'video.err_subtitle': 'Could not load this subtitle track', 'video.close': 'Close (Esc)', 'preview.pdf_fallback': 'This browser will not display the PDF inline. Download it instead — it was decrypted here either way.', 'preview.too_large': 'This file is {size}, more than this page can hold in memory ({limit}). Download it instead — a download is written straight to disk.', diff --git a/packages/meshbay-hub/src/meshbay_hub/static/locales/es.js b/packages/meshbay-hub/src/meshbay_hub/static/locales/es.js index d9b8f63..68fbe10 100644 --- a/packages/meshbay-hub/src/meshbay_hub/static/locales/es.js +++ b/packages/meshbay-hub/src/meshbay_hub/static/locales/es.js @@ -249,6 +249,10 @@ export default { 'video.from_start': "Empezar desde el principio", 'video.audio_track': 'Pista de audio', 'video.audio_track_n': 'Pista {n}', + 'video.subtitles': 'Subtítulos', + 'video.subtitles_off': 'Ninguno', + 'video.subtitle_track_n': 'Pista {n}', + 'video.err_subtitle': 'No se pudo cargar esta pista de subtítulos', 'video.close': 'Cerrar (Esc)', 'preview.pdf_fallback': 'Este navegador no mostrará el PDF integrado. Descárguelo ' + 'en su lugar — en cualquier caso se descifró aquí.', diff --git a/packages/meshbay-hub/src/meshbay_hub/static/locales/fr.js b/packages/meshbay-hub/src/meshbay_hub/static/locales/fr.js index d507d28..679a458 100644 --- a/packages/meshbay-hub/src/meshbay_hub/static/locales/fr.js +++ b/packages/meshbay-hub/src/meshbay_hub/static/locales/fr.js @@ -250,6 +250,10 @@ export default { 'video.from_start': "Reprendre depuis le début", 'video.audio_track': 'Piste audio', 'video.audio_track_n': 'Piste {n}', + 'video.subtitles': 'Sous-titres', + 'video.subtitles_off': 'Aucun', + 'video.subtitle_track_n': 'Piste {n}', + 'video.err_subtitle': 'Impossible de charger cette piste de sous-titres', 'video.close': 'Fermer (Échap)', 'preview.pdf_fallback': 'Ce navigateur n’affichera pas le PDF directement. ' + 'Téléchargez-le plutôt — il a été déchiffré ici dans les deux cas.', diff --git a/packages/meshbay-hub/src/meshbay_hub/static/locales/it.js b/packages/meshbay-hub/src/meshbay_hub/static/locales/it.js index b6c68dd..9a34c93 100644 --- a/packages/meshbay-hub/src/meshbay_hub/static/locales/it.js +++ b/packages/meshbay-hub/src/meshbay_hub/static/locales/it.js @@ -250,6 +250,10 @@ export default { 'video.from_start': "Riparti dall'inizio", 'video.audio_track': 'Traccia audio', 'video.audio_track_n': 'Traccia {n}', + 'video.subtitles': 'Sottotitoli', + 'video.subtitles_off': 'Nessuno', + 'video.subtitle_track_n': 'Traccia {n}', + 'video.err_subtitle': 'Impossibile caricare questa traccia di sottotitoli', 'video.close': 'Chiudi (Esc)', 'preview.pdf_fallback': 'Questo browser non mostrerà il PDF nella pagina. Lo scarichi ' + 'invece — in ogni caso è stato decifrato qui.', diff --git a/packages/meshbay-hub/src/meshbay_hub/static/locales/ja.js b/packages/meshbay-hub/src/meshbay_hub/static/locales/ja.js index 99e2e1f..1d58e2c 100644 --- a/packages/meshbay-hub/src/meshbay_hub/static/locales/ja.js +++ b/packages/meshbay-hub/src/meshbay_hub/static/locales/ja.js @@ -247,6 +247,10 @@ export default { 'video.from_start': "最初から再生する", 'video.audio_track': '音声トラック', 'video.audio_track_n': 'トラック {n}', + 'video.subtitles': '字幕', + 'video.subtitles_off': 'なし', + 'video.subtitle_track_n': 'トラック {n}', + 'video.err_subtitle': 'この字幕トラックを読み込めませんでした', 'video.close': '閉じる（Esc）', 'preview.pdf_fallback': 'このブラウザーはページ内に PDF を表示しません。' + 'ダウンロードしてご覧ください。いずれにせよ復号はここで行われています。', diff --git a/packages/meshbay-hub/src/meshbay_hub/static/locales/nl.js b/packages/meshbay-hub/src/meshbay_hub/static/locales/nl.js index 269fa70..5bef61f 100644 --- a/packages/meshbay-hub/src/meshbay_hub/static/locales/nl.js +++ b/packages/meshbay-hub/src/meshbay_hub/static/locales/nl.js @@ -251,6 +251,10 @@ export default { 'video.from_start': "Vanaf het begin afspelen", 'video.audio_track': 'Audiospoor', 'video.audio_track_n': 'Spoor {n}', + 'video.subtitles': 'Ondertiteling', + 'video.subtitles_off': 'Geen', + 'video.subtitle_track_n': 'Spoor {n}', + 'video.err_subtitle': 'Dit ondertitelspoor kon niet worden geladen', 'video.close': 'Sluiten (Esc)', 'preview.pdf_fallback': 'Deze browser toont de PDF niet in de pagina zelf. Download ' + 'hem in plaats daarvan — ontsleuteld werd hij hoe dan ook hier.', diff --git a/packages/meshbay-hub/src/meshbay_hub/static/locales/pl.js b/packages/meshbay-hub/src/meshbay_hub/static/locales/pl.js index 363296c..8989880 100644 --- a/packages/meshbay-hub/src/meshbay_hub/static/locales/pl.js +++ b/packages/meshbay-hub/src/meshbay_hub/static/locales/pl.js @@ -256,6 +256,10 @@ export default { 'video.from_start': "Odtwórz od początku", 'video.audio_track': 'Ścieżka dźwiękowa', 'video.audio_track_n': 'Ścieżka {n}', + 'video.subtitles': 'Napisy', + 'video.subtitles_off': 'Brak', + 'video.subtitle_track_n': 'Ścieżka {n}', + 'video.err_subtitle': 'Nie udało się wczytać tej ścieżki napisów', 'video.close': 'Zamknij (Esc)', 'preview.pdf_fallback': 'Ta przeglądarka nie wyświetli pliku PDF na stronie. Proszę ' + 'go pobrać — i tak został odszyfrowany tutaj.', diff --git a/packages/meshbay-hub/src/meshbay_hub/static/locales/pt-BR.js b/packages/meshbay-hub/src/meshbay_hub/static/locales/pt-BR.js index 2a90956..f1b8643 100644 --- a/packages/meshbay-hub/src/meshbay_hub/static/locales/pt-BR.js +++ b/packages/meshbay-hub/src/meshbay_hub/static/locales/pt-BR.js @@ -251,6 +251,10 @@ export default { 'video.from_start': "Começar do início", 'video.audio_track': 'Faixa de áudio', 'video.audio_track_n': 'Faixa {n}', + 'video.subtitles': 'Legendas', + 'video.subtitles_off': 'Nenhuma', + 'video.subtitle_track_n': 'Faixa {n}', + 'video.err_subtitle': 'Não foi possível carregar esta faixa de legendas', 'video.close': 'Fechar (Esc)', 'preview.pdf_fallback': 'Este navegador não exibirá o PDF na própria página. Baixe ' + 'o arquivo — de todo modo ele foi descriptografado aqui.', diff --git a/packages/meshbay-hub/src/meshbay_hub/static/locales/zh-CN.js b/packages/meshbay-hub/src/meshbay_hub/static/locales/zh-CN.js index e3aa440..91da464 100644 --- a/packages/meshbay-hub/src/meshbay_hub/static/locales/zh-CN.js +++ b/packages/meshbay-hub/src/meshbay_hub/static/locales/zh-CN.js @@ -245,6 +245,10 @@ export default { 'video.from_start': "从头开始播放", 'video.audio_track': '音轨', 'video.audio_track_n': '音轨 {n}', + 'video.subtitles': '字幕', + 'video.subtitles_off': '关闭', + 'video.subtitle_track_n': '字幕 {n}', + 'video.err_subtitle': '无法加载此字幕轨道', 'video.close': '关闭（Esc）', 'preview.pdf_fallback': '此浏览器不会在页面内显示该 PDF。请改为下载——无论如何它都已在本地解密。', 'preview.too_large': '该文件为 {size}，超出本页面可在内存中保存的上限（{limit}）。请改为下载——下载会直接写入磁盘。', diff --git a/packages/meshbay-hub/src/meshbay_hub/static/transport.js b/packages/meshbay-hub/src/meshbay_hub/static/transport.js index 262b00e..63c71ff 100644 --- a/packages/meshbay-hub/src/meshbay_hub/static/transport.js +++ b/packages/meshbay-hub/src/meshbay_hub/static/transport.js @@ -1607,6 +1607,25 @@ class MeshBayTransport { } /** + * One embedded subtitle track, extracted node-side to WebVTT. Returns + * `{ hash, size, mime, track }` — the *cache* hash to pull through the + * ordinary file_req/chunk path, the same indirection as an audio transcode + * or a TMDB poster, and cached node-side under the file's own id so a film + * is extracted once rather than once per viewing. + * + * `track` is the ordinal the node published in `stream_init.subtitle_tracks` + * and is passed back untouched: it counts every subtitle stream in the + * container, including the bitmap ones that are never listed, so it is not + * a position in the list this client received. + */ + async requestSubtitle(fileId, track) { + const msg = await this._sendAndWait( + { type: 'subtitle_req', v: '0.9', file_id: fileId, track }, 90000); + if (msg.type === 'error') throw new Error(msg.detail); + return msg; + } + + /** * Whether MusicBrainz lookups run for this group at all — per-group from * the start (docs/musicbay.md §3.2/§6). Signed like setTmdbEnabled. */ @@ -2968,6 +2987,12 @@ class MeshBayTransport { // Same reordering hazard as media_meta_req: the player prefetches // the next track while the current one may still be transcoding. : obj.type === 'audio_transcode_req' ? `audio_transcode:${obj.file_id}` + // The track ordinal is part of the key, not just the file id: a + // viewer who opens the menu and picks a second language before the + // first extraction has answered has two of these in flight for the + // same film, and the one that arrives first is not necessarily the + // one that was asked for first. + : obj.type === 'subtitle_req' ? `subtitle:${obj.file_id}:${obj.track}` // Two-step admin-op flow (_authorizeAdminOp) — see ADMIN_OP_TYPES' // own comment for the race this closes. The initial request and // the admin_response that follows it are keyed the same way @@ -3399,6 +3424,18 @@ class MeshBayTransport { return; } + // Keyed on file *and* track — see the `subtitle_req` key above. The node + // echoes `track` back for exactly this: without it a reply could only be + // matched to the film, and the two tracks of one film are precisely the + // pair that can be in flight together. + if (msg.type === 'subtitle_resp') { + const key = `subtitle:${msg.file_id}:${msg.track}`; + for (const [, handler] of this._pending) { + if (handler._key === key) { handler.resolve(msg); return; } + } + return; + } + // Same reasoning as media_meta_resp: keyed, not arrival-order, and // "nobody's waiting any more" must not fall through either. if (msg.type === 'season_meta_resp') { diff --git a/packages/meshbay-hub/src/meshbay_hub/static/video-player.js b/packages/meshbay-hub/src/meshbay_hub/static/video-player.js index 23b0699..5725fc4 100644 --- a/packages/meshbay-hub/src/meshbay_hub/static/video-player.js +++ b/packages/meshbay-hub/src/meshbay_hub/static/video-player.js @@ -3,7 +3,7 @@ import { } from './vendor/htm-preact.js'; import { t, getLocale } from './i18n.js'; import { Icon } from './icon.js'; -import { formatSize } from './file-utils.js'; +import { formatSize, CHUNK_SIZE, pipelinedDownload } from './file-utils.js'; import { loadAuth } from './hub-client.js'; import * as platform from './platform.js'; @@ -68,8 +68,8 @@ const _ISO639 = { * otherwise indistinguishable in the menu — which is common, since a stereo * downmix usually sits beside the surround track it came from. */ -function audioTrackLabel(track) { - const code = (track.lang || '').toLowerCase(); +function _languageName(lang) { + const code = (lang || '').toLowerCase(); let name = null; const iso = _ISO639[code] || (code.length === 2 ? code : null); if (iso) { @@ -84,6 +84,11 @@ function audioTrackLabel(track) { } catch { /* no Intl.DisplayNames, or a code it does not know */ } } if (!name && code && code !== 'und') name = code; + return name; +} + +function audioTrackLabel(track) { + let name = _languageName(track.lang); if (!name) name = t('video.audio_track_n', { n: track.i + 1 }); // Two tracks in the same language are one menu entry repeated without // this, and a library where a stereo downmix sits beside the surround @@ -96,6 +101,21 @@ function audioTrackLabel(track) { return detail ? `${name} — ${detail}` : name; } +/** + * What to call one subtitle track. + * + * Same shape as `audioTrackLabel`, minus the channel layout, which subtitles + * have no equivalent of. The container's title still wins where there is one: + * "Forced", "SDH" and "Signs & Songs" are all the same language tag as the + * ordinary track they sit beside, and picking the wrong one of those is the + * difference between a full translation and three lines in a whole film. + */ +function subtitleTrackLabel(track) { + const name = _languageName(track.lang) + || t('video.subtitle_track_n', { n: track.i + 1 }); + return track.title ? `${name} — ${track.title}` : name; +} + function _mseSupported(codec) { if (!window.MediaSource) return false; const mime = `video/mp4; codecs="${codec}"`; @@ -218,6 +238,25 @@ function VideoPlayer({ entry, transportRef, gekRef, onClose, onDownload }) { // Read inside the effect's closures, which are built once and would // otherwise capture the first track forever. const audioTrackRef = useRef(null); + // Subtitles. The node lists only the tracks it can turn into WebVTT, so an + // empty list means "nothing showable here" whatever the container holds, + // and draws no selector — the same discovery-from-the-answer shape as the + // audio tracks above. `null` is off, and off is where a film opens. + // + // None of this is torn down by a seek or a language change: the extraction + // is whole-file, so the cues are absolute and the <track> outlives every + // restart of the MediaSource underneath it. + const [subtitleTracks, setSubtitleTracks] = useState([]); + const [subtitleTrack, setSubtitleTrack] = useState(null); + const [subtitleMenuOpen, setSubtitleMenuOpen] = useState(false); + const [subtitleUrl, setSubtitleUrl] = useState(null); + const [subtitleBusy, setSubtitleBusy] = useState(false); + const [subtitleError, setSubtitleError] = useState(false); + const subtitleUrlRef = useRef(null); + // Two extractions can be in flight when the viewer changes their mind, and + // the first one asked for is not necessarily the first one answered. Only + // the newest request may install its blob. + const subtitleGenRef = useRef(0); const [castActive, setCastActive] = useState(false); const [castUrl, setCastUrl] = useState(null); const [castPickerOpen, setCastPickerOpen] = useState(false); @@ -629,6 +668,12 @@ function VideoPlayer({ entry, transportRef, gekRef, onClose, onDownload }) { // was drawn falls back to the first track, and the selector must show // the truth rather than the request. setAudioTracks(Array.isArray(msg.audio_tracks) ? msg.audio_tracks : []); + // Re-stated on every stream_init, including the ones a seek and an + // audio-language change produce. Deliberately does not touch + // `subtitleTrack` or the blob: the cues are absolute, so the track + // showing before the restart is still the right one after it. + setSubtitleTracks( + Array.isArray(msg.subtitle_tracks) ? msg.subtitle_tracks : []); if (Number.isInteger(msg.audio_track)) { audioTrackRef.current = msg.audio_track; setAudioTrack(msg.audio_track); @@ -1025,6 +1070,80 @@ function VideoPlayer({ entry, transportRef, gekRef, onClose, onDownload }) { return () => window.removeEventListener('keydown', onKey); }, [onClose]); + /** + * Show one subtitle track, or none. + * + * The node extracts the whole track to WebVTT and caches it under its own + * hash; what comes back here is that hash, pulled through the ordinary + * chunk path like any other file. So this is slow exactly once per film per + * track, and instant every time after — including in a later sitting, which + * is the part a per-seek extraction could never have given. + * + * A failure here never touches playback. Subtitles are an addition to a + * film that is already running, and taking the film down because a text + * track could not be read would be a worse answer than no subtitles. + */ + const selectSubtitle = useCallback(async (track) => { + const gen = ++subtitleGenRef.current; + if (subtitleUrlRef.current) { + URL.revokeObjectURL(subtitleUrlRef.current); + subtitleUrlRef.current = null; + } + setSubtitleUrl(null); + setSubtitleError(false); + if (track === null) { + setSubtitleTrack(null); + setSubtitleBusy(false); + return; + } + const transport = transportRef.current; + if (!transport) return; + setSubtitleTrack(track.i); + setSubtitleBusy(true); + try { + const info = await transport.requestSubtitle(entry.id, track.i); + const chunks = await pipelinedDownload( + transport, gekRef.current, info.hash, Math.ceil(info.size / CHUNK_SIZE)); + const url = URL.createObjectURL( + new Blob(chunks, { type: info.mime || 'text/vtt' })); + // Someone changed their mind while this was in flight. Dropping the blob + // rather than installing it is the whole point of the generation: the + // reply that arrives last is not the choice that was made last. + if (subtitleGenRef.current !== gen) { URL.revokeObjectURL(url); return; } + subtitleUrlRef.current = url; + setSubtitleUrl(url); + } catch (err) { + if (subtitleGenRef.current !== gen) return; + console.warn('[MeshBay] subtitle track', track.i, 'failed:', err); + setSubtitleTrack(null); + setSubtitleError(true); + } finally { + if (subtitleGenRef.current === gen) setSubtitleBusy(false); + } + }, [entry, transportRef, gekRef]); + + // A <track> added to a media element after it started playing is not shown + // by the `default` attribute — that one is read when the element is first + // parsed, and by then this track did not exist. The mode has to be set on + // the live TextTrack, which only appears once the element has adopted the + // child preact just rendered. + useEffect(() => { + const v = videoRef.current; + if (!v) return; + for (let i = 0; i < v.textTracks.length; i++) { + v.textTracks[i].mode = subtitleUrl ? 'showing' : 'disabled'; + } + }, [subtitleUrl]); + + useEffect(() => { + return () => { + if (subtitleUrlRef.current) { + URL.revokeObjectURL(subtitleUrlRef.current); + subtitleUrlRef.current = null; + } + }; + }, []); + return html` <div class="video-overlay" onClick=${(e) => { if (e.target.classList.contains('video-overlay')) onClose(); @@ -1065,6 +1184,46 @@ function VideoPlayer({ entry, transportRef, gekRef, onClose, onDownload }) { `} </div> `} + ${subtitleTracks.length > 0 && html` + <div class="cast-wrapper" style="position:relative"> + <button class="video-close ${subtitleUrl ? 'cast-active' : ''}" + onClick=${() => setSubtitleMenuOpen(!subtitleMenuOpen)} + title="${t('video.subtitles')}"> + ${subtitleBusy + ? html`<span class="spinner"></span>` + : html`<${Icon} name="subtitles" />`}</button> + ${subtitleMenuOpen && html` + <div class="cast-picker"> + <button class="cast-picker-item" onClick=${() => { + setSubtitleMenuOpen(false); + selectSubtitle(null); + }}> + ${subtitleTrack === null + ? html`<${Icon} name="check" />` + : html`<span style="display:inline-block;width:14px"></span>`} + ${' '}${t('video.subtitles_off')} + </button> + ${subtitleTracks.map((track) => html` + <button class="cast-picker-item" onClick=${() => { + setSubtitleMenuOpen(false); + if (track.i === subtitleTrack) return; + selectSubtitle(track); + }}> + ${track.i === subtitleTrack + ? html`<${Icon} name="check" />` + : html`<span style="display:inline-block;width:14px"></span>`} + ${' '}${subtitleTrackLabel(track)} + </button> + `)} + ${subtitleError && html` + <div class="cast-picker-item cast-picker-empty"> + ${t('video.err_subtitle')} + </div> + `} + </div> + `} + </div> + `} ${platform.capabilities.lanCast && html` <div class="cast-wrapper" style="position:relative"> <button class="video-close ${castActive ? 'cast-active' : ''}" @@ -1167,7 +1326,16 @@ function VideoPlayer({ entry, transportRef, gekRef, onClose, onDownload }) { ${(phase === 'streaming' || phase === 'loading') && html` <div class="video-container"> - <video ref=${videoRef} controls autoplay /> + <video ref=${videoRef} controls autoplay> + ${subtitleUrl && html` + <track key=${subtitleUrl} kind="subtitles" src=${subtitleUrl} + srclang=${(subtitleTracks.find((s) => s.i === subtitleTrack) || {}).lang || ''} + label=${subtitleTrack === null ? '' + : subtitleTrackLabel( + subtitleTracks.find((s) => s.i === subtitleTrack) || { i: 0 })} + default /> + `} + </video> ${phase === 'loading' && html` <div class="video-loading"> <div class="video-loading-label"> diff --git a/packages/meshbay-hub/tests/test_video_audio_track.py b/packages/meshbay-hub/tests/test_video_audio_track.py index 534da6d..6eb98ba 100644 --- a/packages/meshbay-hub/tests/test_video_audio_track.py +++ b/packages/meshbay-hub/tests/test_video_audio_track.py @@ -72,6 +72,12 @@ def _label_cases(tmp_path, app, cases, locale="en"): script = tmp_path / "label.mjs" src = "\n".join([ app[app.index("const _ISO639 = {"):app.index("};", app.index("const _ISO639 = {")) + 2], + # The language name is shared with `subtitleTrackLabel`, so it lives in + # a function of its own and has to be lifted alongside its caller. A + # lift that names one function stops exercising anything the moment + # logic moves out of it — here it throws, which is the good case; the + # bad one is a lift that still runs and no longer covers the rule. + _lift(app, "_languageName"), _lift(app, "audioTrackLabel"), ]) script.write_text( diff --git a/packages/meshbay-hub/tests/test_video_subtitles.py b/packages/meshbay-hub/tests/test_video_subtitles.py new file mode 100644 index 0000000..9f0c08d --- /dev/null +++ b/packages/meshbay-hub/tests/test_video_subtitles.py @@ -0,0 +1,232 @@ +""" +Showing a subtitle track in the player. + +The node extracts one track whole, converts it to WebVTT and caches it under +its own hash; this side asks for it by ordinal, pulls the blob through the +ordinary chunk path and hangs a `<track>` on the video element. Four things +have to hold here: + +**The selector exists only where the node said there was something to show.** +It is drawn from `subtitle_tracks` in `stream_init` and from nothing else — +there is no version check in the player — so a node too old to enumerate them +draws no selector and is never sent a `subtitle_req` it would answer "unknown +message type" to. The list also carries only the tracks the node can convert, +so what the menu offers is what will actually appear. + +**The ordinal travels untouched.** It counts every subtitle stream in the +container, including the bitmap ones that are never listed, so it is not the +track's position in the list this client received. Renumbering it here would +map a different stream on the node and show the wrong language, or nothing. + +**A seek does not take the subtitles down.** The extraction is whole-file, so +the cues are absolute: the `<track>` outlives every restart of the +MediaSource, including the one an audio-language change produces. + +**The reply is matched to the request by file *and* track.** Two extractions +for one film can be in flight when the viewer changes their mind, and the +reply that arrives first is not necessarily the one asked for first. +""" + +import json +import re +import shutil +import subprocess +from pathlib import Path + +import pytest + +STATIC = Path(__file__).resolve().parents[1] / "src" / "meshbay_hub" / "static" +APP = STATIC / "video-player.js" +TRANSPORT = STATIC / "transport.js" + +pytestmark = pytest.mark.skipif( + shutil.which("node") is None or not APP.exists(), + reason="node or the SPA sources are not available") + + +@pytest.fixture(scope="module") +def app(): + return APP.read_text() + + +@pytest.fixture(scope="module") +def transport(): + return TRANSPORT.read_text() + + +def _lift(src: str, name: str) -> str: + """One top-level function, as text, for node to execute.""" + start = src.index(f"function {name}(") + depth, i, seen = 0, start, False + while i < len(src): + if src[i] == "{": + depth += 1 + seen = True + elif src[i] == "}": + depth -= 1 + if seen and depth == 0: + return src[start:i + 1] + i += 1 + raise AssertionError(f"{name} never closes") + + +def _player(app: str) -> str: + """The whole component, by position in the file. + + Not the brace matcher below: `function VideoPlayer({ entry, ... })` + destructures its props, so counting from the first `{` closes on the + parameter list and returns the signature alone — a lift that finds + nothing it was asked about and asserts happily against an empty string. + """ + i = app.index("function VideoPlayer(") + nxt = app.find("\nfunction ", i + 1) + return app[i:nxt if nxt > 0 else len(app)] + + +def _block(src: str, opener: str) -> str: + """The body of one `x = (args) => {` assignment, braces matched.""" + start = src.index(opener) + depth, i, seen = 0, start, False + while i < len(src): + if src[i] == "{": + depth += 1 + seen = True + elif src[i] == "}": + depth -= 1 + if seen and depth == 0: + return src[start:i + 1] + i += 1 + raise AssertionError(f"{opener!r} never closes") + + +# ── The label, run rather than read ─────────────────────────────────────────── + +def _label_cases(tmp_path, app, cases, locale="en"): + script = tmp_path / "sublabel.mjs" + src = "\n".join([ + app[app.index("const _ISO639 = {"):app.index("};", app.index("const _ISO639 = {")) + 2], + _lift(app, "_languageName"), + _lift(app, "subtitleTrackLabel"), + ]) + script.write_text( + f"const getLocale = () => '{locale}';\n" + "const t = (k, p) => `${k}:${p.n}`;\n" + + src + + "\nconst out = JSON.parse(process.argv[2]).map(subtitleTrackLabel);\n" + "console.log(JSON.stringify(out));\n") + proc = subprocess.run( + ["node", str(script), json.dumps(cases)], + capture_output=True, text=True) + assert proc.returncode == 0, proc.stderr + return json.loads(proc.stdout) + + +def test_the_language_is_named_not_shown_as_a_tag(tmp_path, app): + """Same fold as the audio tracks: ffprobe reports either ISO 639-2 variant + and a library uses both.""" + out = _label_cases(tmp_path, app, [ + {"i": 0, "lang": "fre"}, + {"i": 1, "lang": "fra"}, + {"i": 2, "lang": "eng"}, + ]) + assert out[0] == out[1], f"fre and fra must agree: {out}" + assert "French" in out[0] and "English" in out[2], out + + +def test_the_container_title_tells_a_forced_track_from_a_full_one(tmp_path, app): + """The difference the title carries is not cosmetic here. + + "Forced" and "SDH" are tagged with the same language as the ordinary track + they sit beside. Dropping the title makes them one menu entry repeated, + and picking the wrong one is the difference between a full translation and + three lines of signage in a whole film. + """ + out = _label_cases(tmp_path, app, [ + {"i": 0, "lang": "eng", "title": "Forced"}, + {"i": 1, "lang": "eng", "title": "SDH"}, + {"i": 2, "lang": "eng"}, + ]) + assert len({*out}) == 3, f"three tracks must give three entries: {out}" + assert "Forced" in out[0] and "SDH" in out[1] + + +def test_an_untagged_track_is_numbered_not_called_unknown(tmp_path, app): + """A file with no language tags still needs distinguishable entries.""" + out = _label_cases(tmp_path, app, [{"i": 3, "lang": None}, {"i": 4, "lang": "und"}]) + assert out == ["video.subtitle_track_n:4", "video.subtitle_track_n:5"], out + + +# ── The shape of the feature, read from the source ──────────────────────────── + +def test_the_selector_comes_from_the_node_list_and_not_from_a_version(app): + """Discovery from the answer. There is no version check in the player, and + an empty list is the whole of "this node has no subtitles for you".""" + assert "msg.subtitle_tracks" in app + assert "subtitleTracks.length > 0 &&" in app, ( + "the selector must be drawn from the node's list") + for forbidden in ("MNP_VERSION", "v >= '3.3'", "'3.3'"): + assert forbidden not in app, ( + f"the player decided on {forbidden!r} instead of on the answer") + + +def test_the_ordinal_is_passed_through_rather_than_renumbered(app): + """`track.i` is the node's ordinal; the list index is not it.""" + assert "requestSubtitle(entry.id, track.i)" in app, ( + "the request must carry the ordinal the node published") + assert not re.search(r"requestSubtitle\([^)]*\bindex\b", app), ( + "a list position was sent where a stream ordinal belongs") + + +def test_a_seek_does_not_take_the_subtitles_down(app): + """The payoff of extracting whole-file rather than per-seek. + + `stream_init` arrives again on every seek and on every audio-language + change. It may restate the available tracks; it must not clear the chosen + one or revoke the blob, or every seek would re-extract and the track would + blink out mid-film. + """ + body = _block(app, "transport.onStreamInit = (msg) => {") + assert "setSubtitleTracks(" in body + for forbidden in ("setSubtitleUrl(", "setSubtitleTrack(", "subtitleUrlRef.current ="): + assert forbidden not in body, ( + f"stream_init touches {forbidden!r}, so a seek disturbs the track") + + +def test_the_blob_is_pulled_through_the_ordinary_chunk_path(app): + """Not a new transfer mechanism — the same indirection as a poster.""" + assert "pipelinedDownload(" in app + assert "info.hash" in app, "the cache hash from the reply is what is fetched" + + +def test_a_stale_reply_cannot_install_its_track(app): + """Two extractions in flight, and the last answered is not the last asked. + + Without the generation the older reply overwrites the newer choice, and + the menu then shows a tick against a language that is not on screen. + """ + body = _player(app) + assert "subtitleGenRef.current !== gen" in body, ( + "nothing stops an out-of-date extraction from installing its blob") + assert "URL.revokeObjectURL(url)" in body, ( + "the superseded blob must be released, not merely ignored") + + +def test_the_reply_is_matched_on_the_file_and_the_track(transport): + """One film's two tracks are exactly the pair that can be in flight + together, so the file id alone cannot route the reply.""" + assert "`subtitle:${obj.file_id}:${obj.track}`" in transport + assert "`subtitle:${msg.file_id}:${msg.track}`" in transport + + +def test_a_failed_extraction_does_not_take_the_film_down(app): + """Subtitles are an addition to a film that is already playing. + + `setError` is the player's fatal path — it replaces the picture. A text + track that could not be read must not reach it. + """ + body = _player(app) + start = body.index("const selectSubtitle = useCallback(") + end = body.index("}, [entry, transportRef, gekRef]);", start) + assert "setError(" not in body[start:end], ( + "a subtitle failure takes the whole player down") + assert "setSubtitleError(true)" in body[start:end] |