mirror of https://github.com/ksyasuda/SubMiner.git synced 2026-05-26 12:55:16 -07:00

Files

T

docs: audit and refresh user-facing and internal docs

Cross-check every config key, shortcut, default, and command against the
current source and fix the drift (mpv.socketPath, auto_start_overlay
default, AniSkip TAB key, JLPT N4 color, secondary-sub font/defaults,
secondary-sub language behavior, modular mpv plugin layout, and more).
Add plain-language intros and first-use definitions across onboarding and
integration pages so non-technical readers can follow along.

Internal docs/: fix stale module paths in architecture/domains.md, add
missing contract entry points and catalog rows, and bump verified dates.
Remove the obsolete docs/plans/ directory (its only plan shipped in
0.15.0) and reframe planning.md so plans live with the work, not in docs/.

2026-05-23 21:21:16 -07:00

6.9 KiB

Raw Blame History

YouTube Integration

SubMiner auto-loads Japanese subtitles when you play a YouTube URL, giving you the same sentence-mining overlay experience as local video files. It probes available subtitle tracks via yt-dlp, selects the best primary and secondary tracks, downloads them, and loads them into mpv before playback resumes.

Requirements

yt-dlp must be installed and on your PATH. yt-dlp is a free command-line tool that reads YouTube video and subtitle info; SubMiner calls it behind the scenes. (PATH is the list of folders your system searches for programs — most installers add yt-dlp to it automatically. If yours did not, set SUBMINER_YTDLP_BIN to the full path of the yt-dlp binary.)
mpv with --input-ipc-server configured (handled automatically when you launch playback through the subminer launcher — no manual setup needed).

How It Works

When SubMiner detects a YouTube URL (or ytsearch: target), it pauses mpv at startup and runs a subtitle pipeline before resuming playback:

Probe --- yt-dlp --dump-single-json extracts all available subtitle tracks (manual uploads and auto-generated captions) along with video metadata.
Discover --- Each track is normalized into a YoutubeTrackOption with language code, kind (manual or auto), display label, and direct download URL.
Select --- SubMiner picks the best primary track (Japanese, preferring manual over auto) and secondary track (English, preferring manual over auto).
Download --- Selected tracks are fetched via direct URL when available, falling back to yt-dlp --write-subs / --write-auto-subs. YouTube TimedText XML formats (srv1/srv2/srv3) are converted to VTT on the fly. Auto-generated VTT captions are normalized to remove rolling-caption duplication.
Load --- Subtitle files are injected into mpv via sub-add. Playback resumes once the primary track is ready; secondary failures do not block.

Pipeline Diagram

flowchart TD
    classDef step fill:#c6a0f6,stroke:#494d64,color:#24273a
    classDef action fill:#8aadf4,stroke:#494d64,color:#24273a
    classDef result fill:#a6da95,stroke:#494d64,color:#24273a
    classDef enrich fill:#8bd5ca,stroke:#494d64,color:#24273a
    classDef ext fill:#eed49f,stroke:#494d64,color:#24273a

    A[YouTube URL detected]:::step
    B[yt-dlp probe]:::ext
    C[Track discovery]:::action
    D{Auto or manual selection?}:::step
    E[Auto-select best tracks]:::action
    F[Manual picker — Ctrl+Alt+C]:::action
    G[Download subtitle files]:::action
    H[Convert TimedText to VTT]:::enrich
    I[Normalize auto-caption duplicates]:::enrich
    K[sub-add into mpv]:::action
    L[Overlay renders subtitles]:::result

    A --> B
    B --> C
    C --> D
    D -- startup --> E
    D -- user request --> F
    E --> G
    F --> G
    G --> H
    H --> I
    I --> K
    K --> L

Auto-Load Flow

On startup with a YouTube URL:

mpv launches paused.
SubMiner calls yt-dlp --dump-single-json to probe all subtitle tracks.
Tracks are split into manual (human-uploaded) and auto (machine-generated) categories.
The selection algorithm picks:
- Primary: first Japanese manual track, then Japanese auto track, then any manual track, then first available track.
- Secondary: first English manual track, then English auto track (excluding the primary).
If mpv already exposes an authoritative matching track, SubMiner reuses it instead of downloading again.
Missing tracks are downloaded to a temp directory and loaded via sub-add.
Playback unpauses once the primary subtitle is ready.

Manual Subtitle Picker

Press Ctrl+Alt+C during YouTube playback to open the subtitle picker overlay. This lets you:

Browse all discovered tracks (manual and auto-generated)
Select different primary and secondary tracks
Retry track loading if the auto-load failed or picked the wrong track

The picker displays each track with its language, kind (manual/auto), and title when available.

Subtitle Format Handling

SubMiner handles several YouTube subtitle formats transparently:

Format	Handling
`srt`, `vtt`	Used directly (preferred for manual tracks)
`srv1`, `srv2`, `srv3`	YouTube TimedText XML --- converted to VTT automatically
Auto-generated VTT	Normalized to remove rolling-caption text duplication

For auto-generated tracks, SubMiner prefers srv3 > srv2 > srv1 > vtt (TimedText XML produces cleaner output). For manual tracks, srt > vtt is preferred.

Configuration Reference

Primary Subtitle Languages

{
  "youtube": {
    "primarySubLanguages": ["ja", "jpn"]
  }
}

Option	Type	Description
`primarySubLanguages`	`string[]`	Language priority for YouTube primary subtitle auto-loading (default `["ja", "jpn"]`)

Secondary Subtitle Languages

Secondary track selection uses the shared secondarySub config:

{
  "secondarySub": {
    "secondarySubLanguages": [],
    "autoLoadSecondarySub": false,
    "defaultMode": "hover"
  }
}

Option	Type	Description
`secondarySubLanguages`	`string[]`	Extra language codes (e.g. `["eng", "en"]`) used when auto-selecting a secondary track. Default is empty (`[]`). For YouTube, SubMiner always tries an English track first regardless of this list.
`autoLoadSecondarySub`	`boolean`	Auto-detect and load a matching secondary track (default: `false`)
`defaultMode`	`"hidden"` / `"visible"` / `"hover"`	Initial display mode for secondary subtitles (default: `"hover"`)

Precedence: CLI flag > environment variable > config.jsonc > built-in default.

Limitations and Troubleshooting

No subtitles found: The video may not have Japanese subtitles. Open the picker with Ctrl+Alt+C to see all available tracks.
yt-dlp not found: Install yt-dlp and ensure it is on PATH, or set SUBMINER_YTDLP_BIN to the binary path.
Probe timeout: yt-dlp has a 15-second timeout per operation. Slow connections or rate-limited IPs may hit this. Retry or update yt-dlp.
Auto-caption quality: YouTube auto-generated captions vary in quality. Manual subtitles (when available) are always preferred.
ytsearch: targets: subminer ytsearch:"keyword" plays the first search result. Subtitle availability depends on the matched video.
Secondary subtitle fails: Secondary track failures never block playback. The primary subtitle loads independently.
Native mpv secondary rendering: Stays hidden during YouTube flows so the SubMiner overlay remains the visible secondary subtitle surface.

6.9 KiB Raw Blame History