Files
SubMiner/src/main/runtime/local-subtitle-selection.ts
T
sudacode b1bdeabca8 fix(jellyfin): show overlay, inject plugin, and fix stats title on playback (#77)
* fix(jellyfin): show overlay, inject plugin, and fix stats title on playb

- Show visible overlay automatically during Jellyfin playback so subtitleStyle applies
- Inject bundled mpv plugin on auto-launch so keybindings work without overlay focus
- Group Jellyfin playback stats under item metadata (jellyfin://host/item/id) instead of stream URLs so episodes merge with matching local titles
- Mark ffsubsync unavailable in subsync modal for remote media paths
- Drain queued second-instance commands even when onReady throws

* fix(overlay): stabilize macOS focus handoff and sidebar Yomitan pause

- Keep overlay visible during macOS foreground probe after overlay blur
- Hold sidebar hover-pause while a Yomitan lookup popup remains open

* fix(jellyfin): fix discovery loop, device identity, tray state, and Disc

- Derive device identity from OS hostname; remove legacy configurable client/device fields
- Prevent discovery playback from reloading active item, misreporting pause state, and duplicate overlay restores
- Restart stale tray discovery sessions without re-login when server drops SubMiner cast target
- Sync tray discovery checkbox state on Linux after CLI/startup/remote-session changes
- Stop Discord presence falling back to stream URLs; prime title before tokenized stream loads
- Fix picker library discovery when log level is above info
- Fix config.example.jsonc trailing commas and array formatting

* docs(release): trim and consolidate prerelease notes for 0.15.0

- Remove breaking changes section and several redundant bullet points
- Consolidate per-platform updater notes into a single entry
- Normalize em-dash separators to hyphens in section headers

* fix(config): remove trailing commas from config.example.jsonc

- Strip trailing commas throughout both config.example.jsonc copies
- Reformat inline arrays to multi-line for JSON strictness
- Update Jellyfin subtitle preload and playback launch tests and impl

* fix(tokenizer): preserve known-word highlight when POS filters suppress

- Known-word cache matches now set isKnown=true even for tokens excluded by POS filters
- POS exclusion gate suppresses N+1, frequency, and JLPT only; known status is computed before the gate
- Jellyfin subtitle preload continues after cleanup failures instead of aborting
- Update config docs and option description to document the known-word bypass behavior

* fix(jellyfin): send explicit hide/show overlay instead of toggle

- Track overlay visibility in plugin state; y-t uses explicit hide/show commands when state is known
- Prevent paused Jellyfin playback from resuming on overlay hide
- Fix subtitle cache cleanup to only remove dirs after successful cleanup

* fix(jellyfin): fix remote progress sync, seek reporting, and startup sto

- arm active playback before loadfile with loadedMediaPath: null to suppress premature stop events
- force immediate progress report on seek-like position jumps at the mpv time-pos level
- send positionTicks and failed=false in reportStopped payload
- remove EventName from HTTP timeline payloads (websocket-only field)
- add startup grace window to drop stop events before media finishes loading

* fix(jellyfin): fix overlay toggle sync, redirect reload, and AppImage bi

- Sync visible-overlay state back to plugin via script messages to avoid toggle/hide drift
- Collapse duplicate toggle events within 250ms to prevent hide-then-show on single keypress
- Preserve manual hide across Jellyfin path-changing redirects even when media-title drops
- Rearm managed subtitle defaults on path-changing redirects
- Route toggleVisibleOverlay session binding through plugin toggle instead of app-side IPC
- Show Linux/Hyprland overlay passively (showInactive) to avoid stealing mpv keyboard focus
- Fix AppImage binary resolution to prefer $APPIMAGE env over mounted inner binary
- Add stats window layer management so delete/update dialogs appear above stats window
- Fix Jellyfin remote progress sync during Linux websocket reconnect windows

* Fix CodeRabbit review feedback

* fix(jellyfin): subtitle timing, resume progress, and overlay sync

- Add per-stream subtitle delay persistence and auto timeline-offset correction
- Strip server-selected subtitle stream from mpv load URL; suppress plugin subtitle rearm and auto-start during app-managed preload
- Fix resume position lost when mpv resets on stop; use last known position for final progress/stopped reports
- Keep Play vs Resume distinct to avoid early seek race on normal play
- Fix discovery resume when remote play sends StartPositionTicks=0 despite saved progress
- Deduplicate show/hide overlay commands using recorded visibility state
- Rewrite docs-site Jellyfin page around cast-to-device UX

* test: update lifecycle cleanup assertion

* fix: clear aborted playback state, fix overlay passthrough, and guard du

- Reset app_managed_playback_pending on lifecycle cleanup to prevent state leak into next item
- Record visible overlay action only after command succeeds, not before
- Non-native passive overlay now always click-through on re-show (fix isNonNativePassiveOverlay ordering)
- Defer activeParsedSubtitleMediaPath assignment until after prefetch completes
- Move autoplay gate release into the hide branch of toggleVisibleOverlay
- Clear active Jellyfin playback when stopping media that never loaded
- Reset managed subtitle delay and delay key when no external tracks are available
- Await async removeDir in subtitle cache cleanup
- Guard duplicate delete clicks in MediaDetailView and SessionsTab with refs
- Escape key in DeleteConfirmDialog now calls stopPropagation and stopImmediatePropagation
2026-05-24 18:40:56 -07:00

290 lines
9.2 KiB
TypeScript

import path from 'node:path';
import { isRemoteMediaPath } from '../../jimaku/utils';
import { normalizeYoutubeLangCode } from '../../core/services/youtube/labels';
const DEFAULT_PRIMARY_SUBTITLE_LANGUAGES = ['ja', 'jpn'];
const DEFAULT_SECONDARY_SUBTITLE_LANGUAGES = ['en', 'eng', 'english', 'enus', 'en-us'];
const HEARING_IMPAIRED_PATTERN = /\b(hearing impaired|sdh|closed captions?|cc)\b/i;
type SubtitleTrackLike = {
type?: unknown;
id?: unknown;
lang?: unknown;
title?: unknown;
external?: unknown;
selected?: unknown;
};
type NormalizedSubtitleTrack = {
id: number;
lang: string;
title: string;
external: boolean;
selected: boolean;
};
export type ManagedLocalSubtitleSelection = {
primaryTrackId: number | null;
secondaryTrackId: number | null;
hasPrimaryMatch: boolean;
hasSecondaryMatch: boolean;
};
function parseTrackId(value: unknown): number | null {
if (typeof value === 'number' && Number.isInteger(value)) {
return value;
}
if (typeof value === 'string') {
const parsed = Number(value.trim());
return Number.isInteger(parsed) ? parsed : null;
}
return null;
}
function normalizeTrack(entry: unknown): NormalizedSubtitleTrack | null {
if (!entry || typeof entry !== 'object') {
return null;
}
const track = entry as SubtitleTrackLike;
const id = parseTrackId(track.id);
if (id === null || (track.type !== undefined && track.type !== 'sub')) {
return null;
}
return {
id,
lang: String(track.lang || '').trim(),
title: String(track.title || '').trim(),
external: track.external === true,
selected: track.selected === true,
};
}
function normalizeLanguageList(values: string[], fallback: string[]): string[] {
const normalized = values
.map((value) => normalizeYoutubeLangCode(value))
.filter((value, index, items) => value.length > 0 && items.indexOf(value) === index);
if (normalized.length > 0) {
return normalized;
}
return fallback
.map((value) => normalizeYoutubeLangCode(value))
.filter((value, index, items) => value.length > 0 && items.indexOf(value) === index);
}
function resolveLanguageRank(language: string, preferredLanguages: string[]): number {
const normalized = normalizeYoutubeLangCode(language);
if (!normalized) {
return Number.POSITIVE_INFINITY;
}
const directIndex = preferredLanguages.indexOf(normalized);
if (directIndex >= 0) {
return directIndex;
}
const base = normalized.split('-')[0] || normalized;
const baseIndex = preferredLanguages.indexOf(base);
return baseIndex >= 0 ? baseIndex : Number.POSITIVE_INFINITY;
}
function isLikelyHearingImpaired(title: string): boolean {
return HEARING_IMPAIRED_PATTERN.test(title);
}
function isUnlabeledExternalTrack(track: NormalizedSubtitleTrack): boolean {
return track.external && normalizeYoutubeLangCode(track.lang).length === 0;
}
function pickBestTrackId(
tracks: NormalizedSubtitleTrack[],
preferredLanguages: string[],
excludeId: number | null = null,
): { trackId: number | null; hasMatch: boolean } {
const ranked = tracks
.filter((track) => track.id !== excludeId)
.map((track) => ({
track,
languageRank: resolveLanguageRank(track.lang, preferredLanguages),
}))
.filter(({ languageRank }) => Number.isFinite(languageRank))
.sort((left, right) => {
if (left.languageRank !== right.languageRank) {
return left.languageRank - right.languageRank;
}
if (left.track.external !== right.track.external) {
return left.track.external ? -1 : 1;
}
if (
isLikelyHearingImpaired(left.track.title) !== isLikelyHearingImpaired(right.track.title)
) {
return isLikelyHearingImpaired(left.track.title) ? 1 : -1;
}
if (/\bdefault\b/i.test(left.track.title) !== /\bdefault\b/i.test(right.track.title)) {
return /\bdefault\b/i.test(left.track.title) ? -1 : 1;
}
return left.track.id - right.track.id;
});
return {
trackId: ranked[0]?.track.id ?? null,
hasMatch: ranked.length > 0,
};
}
function pickSingleUnlabeledExternalTrackId(
tracks: NormalizedSubtitleTrack[],
excludeId: number | null = null,
): number | null {
const fallbackCandidates = tracks.filter(
(track) => track.id !== excludeId && isUnlabeledExternalTrack(track),
);
if (fallbackCandidates.length !== 1) {
return null;
}
return fallbackCandidates[0]?.id ?? null;
}
export function resolveManagedLocalSubtitleSelection(input: {
trackList: unknown[] | null;
primaryLanguages: string[];
secondaryLanguages: string[];
}): ManagedLocalSubtitleSelection {
const tracks = Array.isArray(input.trackList)
? input.trackList
.map(normalizeTrack)
.filter((track): track is NormalizedSubtitleTrack => track !== null)
: [];
const preferredPrimaryLanguages = normalizeLanguageList(
input.primaryLanguages,
DEFAULT_PRIMARY_SUBTITLE_LANGUAGES,
);
const preferredSecondaryLanguages = normalizeLanguageList(
input.secondaryLanguages,
DEFAULT_SECONDARY_SUBTITLE_LANGUAGES,
);
const primary = pickBestTrackId(tracks, preferredPrimaryLanguages);
const primaryTrackId = primary.trackId ?? pickSingleUnlabeledExternalTrackId(tracks);
const secondary = pickBestTrackId(tracks, preferredSecondaryLanguages, primaryTrackId);
return {
primaryTrackId,
secondaryTrackId: secondary.trackId,
hasPrimaryMatch: primary.hasMatch || primaryTrackId !== null,
hasSecondaryMatch: secondary.hasMatch,
};
}
function normalizeLocalMediaPath(mediaPath: string | null | undefined): string | null {
if (typeof mediaPath !== 'string') {
return null;
}
const trimmed = mediaPath.trim();
if (!trimmed || isRemoteMediaPath(trimmed)) {
return null;
}
return path.resolve(trimmed);
}
export function createManagedLocalSubtitleSelectionRuntime(deps: {
getCurrentMediaPath: () => string | null;
getMpvClient: () => {
connected?: boolean;
requestProperty?: (name: string) => Promise<unknown>;
} | null;
getPrimarySubtitleLanguages: () => string[];
getSecondarySubtitleLanguages: () => string[];
sendMpvCommand: (command: ['set_property', 'sid' | 'secondary-sid', number]) => void;
schedule: (callback: () => void, delayMs: number) => ReturnType<typeof setTimeout>;
clearScheduled: (timer: ReturnType<typeof setTimeout>) => void;
delayMs?: number;
}) {
const delayMs = deps.delayMs ?? 400;
let currentMediaPath: string | null = null;
let appliedPrimaryMediaPath: string | null = null;
let appliedSecondaryMediaPath: string | null = null;
let pendingTimer: ReturnType<typeof setTimeout> | null = null;
const clearPendingTimer = (): void => {
if (!pendingTimer) {
return;
}
deps.clearScheduled(pendingTimer);
pendingTimer = null;
};
const hasAppliedSelectionForCurrentMediaPath = (): boolean =>
appliedPrimaryMediaPath === currentMediaPath && appliedSecondaryMediaPath === currentMediaPath;
const maybeApplySelection = (trackList: unknown[] | null): void => {
if (!currentMediaPath || hasAppliedSelectionForCurrentMediaPath()) {
return;
}
const selection = resolveManagedLocalSubtitleSelection({
trackList,
primaryLanguages: deps.getPrimarySubtitleLanguages(),
secondaryLanguages: deps.getSecondarySubtitleLanguages(),
});
if (!selection.hasPrimaryMatch && !selection.hasSecondaryMatch) {
return;
}
if (selection.primaryTrackId !== null && appliedPrimaryMediaPath !== currentMediaPath) {
deps.sendMpvCommand(['set_property', 'sid', selection.primaryTrackId]);
appliedPrimaryMediaPath = currentMediaPath;
}
if (selection.secondaryTrackId !== null && appliedSecondaryMediaPath !== currentMediaPath) {
deps.sendMpvCommand(['set_property', 'secondary-sid', selection.secondaryTrackId]);
appliedSecondaryMediaPath = currentMediaPath;
}
if (hasAppliedSelectionForCurrentMediaPath()) {
clearPendingTimer();
}
};
const refreshFromMpv = async (): Promise<void> => {
const client = deps.getMpvClient();
if (!client?.connected || !client.requestProperty) {
return;
}
const mediaPath = normalizeLocalMediaPath(deps.getCurrentMediaPath());
if (!mediaPath || mediaPath !== currentMediaPath) {
return;
}
try {
const trackList = await client.requestProperty('track-list');
maybeApplySelection(Array.isArray(trackList) ? trackList : null);
} catch {
// Skip selection when mpv track inspection fails.
}
};
const scheduleRefresh = (): void => {
clearPendingTimer();
if (!currentMediaPath || hasAppliedSelectionForCurrentMediaPath()) {
return;
}
pendingTimer = deps.schedule(() => {
pendingTimer = null;
void refreshFromMpv();
}, delayMs);
};
return {
handleMediaPathChange: (mediaPath: string | null | undefined): void => {
const normalizedPath = normalizeLocalMediaPath(mediaPath);
if (normalizedPath !== currentMediaPath) {
appliedPrimaryMediaPath = null;
appliedSecondaryMediaPath = null;
}
currentMediaPath = normalizedPath;
if (!currentMediaPath) {
clearPendingTimer();
return;
}
scheduleRefresh();
},
handleSubtitleTrackListChange: (trackList: unknown[] | null): void => {
maybeApplySelection(trackList);
},
};
}