Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
release-patterns
command
Command release-patterns imports the arr and TRaSH patterns internal/release parses with, from patterns.manifest.json at the commits patterns_source.go pins.
|
Command release-patterns imports the arr and TRaSH patterns internal/release parses with, from patterns.manifest.json at the commits patterns_source.go pins. |
|
subflux
command
Command subflux finds, syncs and keeps subtitles for a media library.
|
Command subflux finds, syncs and keeps subtitles for a media library. |
|
internal
|
|
|
app
Package app is subflux's composition root: the one boot path, the supervision of every long-running component, and the drain.
|
Package app is subflux's composition root: the one boot path, the supervision of every long-running component, and the drain. |
|
cache
Package cache provides a generic TTL cache with singleflight coalescing.
|
Package cache provides a generic TTL cache with singleflight coalescing. |
|
embedded
Package embedded detects embedded subtitle tracks in video files.
|
Package embedded detects embedded subtitle tracks in video files. |
|
epmarker
Package epmarker is the one authority for what a release or archive member name claims about its season and episode.
|
Package epmarker is the one authority for what a release or archive member name claims about its season and episode. |
|
formschema
Package formschema is the form-shaped half of every settings section: a schema of typed fields, the decoder that reads a section's YAML node by that schema, and the marks that tell the settings document which scalars are safe to show.
|
Package formschema is the form-shaped half of every settings section: a schema of typed fields, the decoder that reads a section's YAML node by that schema, and the marks that tell the settings document which scalars are safe to show. |
|
httpwire
Package httpwire holds subflux's own HTTP wire policy: the byte bounds it will read from a peer, and the vocabulary it classifies a peer's response with.
|
Package httpwire holds subflux's own HTTP wire policy: the byte bounds it will read from a peer, and the vocabulary it classifies a peer's response with. |
|
langcode
Package langcode maps any language identifier subflux meets — a provider payload, an ffprobe stream tag, an arr API response, a config file — onto the one internal code space, and is the only place that mapping happens.
|
Package langcode maps any language identifier subflux meets — a provider payload, an ffprobe stream tag, an arr API response, a config file — onto the one internal code space, and is the only place that mapping happens. |
|
language
Package language is subflux's language model: canonical BCP 47 tags over langtag, the subtitle targets a configuration asks for, how close an offered tag is to a target and whether automation may take it, and the filename spellings subflux writes and reads.
|
Package language is subflux's language model: canonical BCP 47 tags over langtag, the subtitle targets a configuration asks for, how close an offered tag is to a target and whether automation may take it, and the filename spellings subflux writes and reads. |
|
logsafe
Package logsafe binds textsafe's single-line preset to Subflux's log surface, so every untrusted string reaches slog through one policy.
|
Package logsafe binds textsafe's single-line preset to Subflux's log surface, so every untrusted string reaches slog through one policy. |
|
media
Package media is subflux's identity: the key an episode or movie is stored, matched and served by.
|
Package media is subflux's identity: the key an episode or movie is stored, matched and served by. |
|
mediaserver
Package mediaserver is subflux's view of the media servers (Plex) that play a library: how each labels the subtitles beside a video.
|
Package mediaserver is subflux's view of the media servers (Plex) that play a library: how each labels the subtitles beside a video. |
|
mediasource
Package mediasource is what subflux learns from its media sources (Sonarr, Radarr): the facts a source reports about its series and movies, its change cursor, and the errors every source call answers with.
|
Package mediasource is what subflux learns from its media sources (Sonarr, Radarr): the facts a source reports about its series and movies, its change cursor, and the errors every source call answers with. |
|
mediasource/arr
Package arr is what the Sonarr and Radarr adapters share: their form, error classifier, history cursor, tags, root folders and the poster's two-zone fetch.
|
Package arr is what the Sonarr and Radarr adapters share: their form, error classifier, history cursor, tags, root folders and the poster's two-zone fetch. |
|
mediasource/sourcetest
Package sourcetest is the contract suite every mediasource adapter passes, the fake library a harness serves, and Fake, an in-memory adapter for Set and scan tests.
|
Package sourcetest is the contract suite every mediasource adapter passes, the fake library a harness serves, and Fake, an in-memory adapter for Set and scan tests. |
|
obs
Package obs is subflux's /metrics registry: the platform series and the door every other owner's series registers through.
|
Package obs is subflux's /metrics registry: the platform series and the door every other owner's series registers through. |
|
provider
Package provider contains the provider registry and retry wrappers.
|
Package provider contains the provider registry and retry wrappers. |
|
provider/anidb
Package anidb provides TVDB → AniDB mapping using the community-maintained anime-list.xml from https://github.com/Anime-Lists/anime-lists.
|
Package anidb provides TVDB → AniDB mapping using the community-maintained anime-list.xml from https://github.com/Anime-Lists/anime-lists. |
|
provider/animetosho
Package animetosho implements the AnimeTosho subtitle provider.
|
Package animetosho implements the AnimeTosho subtitle provider. |
|
provider/archive
Package archive extracts a subtitle from a ZIP or RAR container.
|
Package archive extracts a subtitle from a ZIP or RAR container. |
|
provider/betaseries
Package betaseries implements the BetaSeries subtitle provider.
|
Package betaseries implements the BetaSeries subtitle provider. |
|
provider/classify
Package classify provides subtitle classification (forced/HI) and language resolution utilities consumed by provider sub-packages.
|
Package classify provides subtitle classification (forced/HI) and language resolution utilities consumed by provider sub-packages. |
|
provider/gestdown
Package gestdown implements the Gestdown subtitle provider.
|
Package gestdown implements the Gestdown subtitle provider. |
|
provider/hdbits
Package hdbits implements the HDBits.org subtitle provider.
|
Package hdbits implements the HDBits.org subtitle provider. |
|
provider/opensubtitles
Package opensubtitles implements the OpenSubtitles.com REST API provider.
|
Package opensubtitles implements the OpenSubtitles.com REST API provider. |
|
provider/subdl
Package subdl implements the SubDL subtitle provider.
|
Package subdl implements the SubDL subtitle provider. |
|
provider/subsource
Package subsource implements the SubSource subtitle provider.
|
Package subsource implements the SubSource subtitle provider. |
|
provider/synthetic
Package synthetic provides a subtitle provider that answers from generated data instead of an upstream service.
|
Package synthetic provides a subtitle provider that answers from generated data instead of an upstream service. |
|
provider/yifysubtitles
Package yifysubtitles implements the YIFY Subtitles provider.
|
Package yifysubtitles implements the YIFY Subtitles provider. |
|
rank
Package rank answers how well a subtitle's release fits the video's, as tri-state facts and a Fit grade with no number anywhere.
|
Package rank answers how well a subtitle's release fits the video's, as tri-state facts and a Fit grade with no number anywhere. |
|
release
Package release reads a release or subtitle name with the patterns the arrs and TRaSH publish, imported as published by cmd/release-patterns into patterns_gen.go and run by netregex with .NET's match semantics.
|
Package release reads a release or subtitle name with the patterns the arrs and TRaSH publish, imported as published by cmd/release-patterns into patterns_gen.go and run by netregex with .NET's match semantics. |
|
release/netregex
Package netregex runs .NET-flavour regular expressions with .NET's match semantics, as dlclark/regexp2 defines them, in polynomial time.
|
Package netregex runs .NET-flavour regular expressions with .NET's match semantics, as dlclark/regexp2 defines them, in polynomial time. |
|
search/release
Package release provides release name parsing via PCRE-compatible regex patterns sourced from TRaSH Guides and Sonarr/Radarr QualityParser.
|
Package release provides release name parsing via PCRE-compatible regex patterns sourced from TRaSH Guides and Sonarr/Radarr QualityParser. |
|
settings
Package settings loads, holds and saves subflux's one configuration file: each section parsed by its owner, the result a Snapshot that is Unconfigured, Failed or Active, never a configuration beside a flag.
|
Package settings loads, holds and saves subflux's one configuration file: each section parsed by its owner, the result a Snapshot that is Unconfigured, Failed or Active, never a configuration beside a flag. |
|
skyhook
Package skyhook reads SkyHook, Sonarr's metadata service, for a series' episode list in one of its orders, the lists Sonarr builds its own from.
|
Package skyhook reads SkyHook, Sonarr's metadata service, for a series' episode list in one of its orders, the lists Sonarr builds its own from. |
|
statedb
Package statedb is subflux's one store: the core namespace of a bolttable file holding source facts, ownership, coverage, locks, the write protocol's rows, history, work, jobs and credentials (the storage spec's design sections 3 to 10).
|
Package statedb is subflux's one store: the core namespace of a bolttable file holding source facts, ownership, coverage, locks, the write protocol's rows, history, work, jobs and credentials (the storage spec's design sections 3 to 10). |
|
status
Package status holds what subflux is doing and what is wrong with it and its providers: jobs, alerts as levels and provider states.
|
Package status holds what subflux is doing and what is wrong with it and its providers: jobs, alerts as levels and provider states. |
|
status/statustest
Package statustest holds the contract every status.Persister meets and an in-memory reference implementation of it.
|
Package statustest holds the contract every status.Persister meets and an in-memory reference implementation of it. |
|
subflux
Package subflux is the application's wire and domain type vocabulary.
|
Package subflux is the application's wire and domain type vocabulary. |
|
subsync
Package subsync provides subtitle timing synchronization.
|
Package subsync provides subtitle timing synchronization. |
|
subsync/crosslang
Package crosslang implements cross-language subtitle alignment using anchor-based matching and dynamic programming.
|
Package crosslang implements cross-language subtitle alignment using anchor-based matching and dynamic programming. |
|
subsync/ffmpeg
Package ffmpeg provides low-level ffmpeg/ffprobe subprocess wrappers for stream probing, subtitle extraction, and PCM audio extraction.
|
Package ffmpeg provides low-level ffmpeg/ffprobe subprocess wrappers for stream probing, subtitle extraction, and PCM audio extraction. |
|
subsync/fft
Package fft provides a radix-2 Cooley-Tukey FFT implementation for cross-correlation in the subsync package.
|
Package fft provides a radix-2 Cooley-Tukey FFT implementation for cross-correlation in the subsync package. |
|
subsync/framerate
Package framerate provides framerate drift detection for subtitle alignment.
|
Package framerate provides framerate drift detection for subtitle alignment. |
|
subtitleenc
Package subtitleenc answers what encoding a subtitle's bytes are in, by ICU's charset-detection models (internal/subtitleenc/icu) narrowed by the subtitle's language, and reads and writes them as the Encoding Standard does, on golang.org/x/text's decode tables.
|
Package subtitleenc answers what encoding a subtitle's bytes are in, by ICU's charset-detection models (internal/subtitleenc/icu) narrowed by the subtitle's language, and reads and writes them as the Encoding Standard does, on golang.org/x/text's decode tables. |
|
subtitleenc/icu
Package icu is a Go port of ICU4C's charset detector (icu4c/source/i18n csrsbcs.cpp, csrmbcs.cpp and csr2022.cpp at 560e6db, ICU 69.1), under the Unicode License V3 (THIRD_PARTY_NOTICES.md).
|
Package icu is a Go port of ICU4C's charset detector (icu4c/source/i18n csrsbcs.cpp, csrmbcs.cpp and csr2022.cpp at 560e6db, ICU 69.1), under the Unicode License V3 (THIRD_PARTY_NOTICES.md). |
|
subtitleext
Package subtitleext is the one answer to which file extensions count as subtitles, as three capability views over one table: archive input (members extracted from provider archives), on disk (standalone files beside a video) and writer output (formats subflux writes).
|
Package subtitleext is the one answer to which file extensions count as subtitles, as three capability views over one table: archive input (members extracted from provider archives), on disk (standalone files beside a video) and writer output (formats subflux writes). |
|
subtitlefile
Package subtitlefile is the subtitle file name grammar, <stem>.<language>[.sdh][.forced][.<N>].<ext>, and which video in a folder owns a name.
|
Package subtitlefile is the subtitle file name grammar, <stem>.<language>[.sdh][.forced][.<N>].<ext>, and which video in a folder owns a name. |
|
testrig
Package testrig is the in-process harness, Start running app.Run on a temp directory and a loopback listener, and holds the module-wide checks: the retired modules, the retained set the dead-code roots name, and import confinement.
|
Package testrig is the in-process harness, Start running app.Run on a temp directory and a loopback listener, and holds the module-wide checks: the retired modules, the retained set the dead-code roots name, and import confinement. |
|
timing
Package timing is subflux's subtitle timing model: a Timing maps each cue's baseline time to the time a media server shows it, and every managed file is its baseline rendered under one Timing.
|
Package timing is subflux's subtitle timing model: a Timing maps each cue's baseline time to the time a media server shows it, and every managed file is its baseline rendered under one Timing. |
Click to show internal directories.
Click to hide internal directories.