config

type Cache struct {
	Storage string `json:"storage,omitempty"` // local (default) or shared; restart required

	PreloadEnabled         bool   `json:"preloadEnabled,omitempty"`
	PreloadBudgetBytes     int64  `json:"preloadBudgetBytes,omitempty"`
	PreloadMaxTitles       int    `json:"preloadMaxTitles,omitempty"`
	PreloadRateMiB         int    `json:"preloadRateMiB,omitempty"`
	PreloadDuringPlayback  bool   `json:"preloadDuringPlayback,omitempty"`
	PreloadMinFreeBytes    int64  `json:"preloadMinFreeBytes,omitempty"`
	PreloadSource          string `json:"preloadSource,omitempty"`
	PreloadContent         string `json:"preloadContent,omitempty"`         // mixed (default), movies, tv
	PreloadHouseholdWeight *int   `json:"preloadHouseholdWeight,omitempty"` // 0–100; nil = 65
	PreloadHouseholdScope  string `json:"preloadHouseholdScope,omitempty"`  // home (default), all
	PreloadEpisodesAhead   int    `json:"preloadEpisodesAhead,omitempty"`   // per-show shelf window; 0 = 3
	PreloadHistoryDays     int    `json:"preloadHistoryDays,omitempty"`     // 0 = 90

	// Mode: empty/demand retains fetched bytes; adaptive favours replayed titles;
	// off bypasses persistent media writes. Zero budget remains unlimited.
	Mode               string `json:"mode,omitempty"`
	RetentionDays      int    `json:"retentionDays,omitempty"`
	ReplayBoostHours   int    `json:"replayBoostHours,omitempty"`
	DisableSpeculation bool   `json:"disableSpeculation,omitempty"`
	DetailWarmup       string `json:"detailWarmup,omitempty"` // empty/on or off
	DetailBytes        int64  `json:"detailBytes,omitempty"`  // zero preserves the 2 MiB default

	Dir         string `json:"dir"`
	BudgetBytes int64  `json:"budgetBytes"`
	// Prefetch
	PrefetchNextEpisode bool    `json:"prefetchNextEpisode"`
	PrefetchBytes       int64   `json:"prefetchBytes"` // opening bytes pulled ahead
	KeepInProgressWarm  bool    `json:"keepInProgressWarm"`
	NextEpisodeAt       float64 `json:"nextEpisodeAt"` // fraction of current episode, e.g. 0.8
	// InProgressPinMaxAge: an in-progress title nobody has watched for this
	// long stops pinning its release in the cache (0 = default 30 days).
	InProgressPinMaxAge Duration `json:"inProgressPinMaxAge,omitempty"`
	// InProgressPinPercent caps the share of BudgetBytes that in-progress
	// pins may hold; the least recently watched titles lose their pin first
	// (0 = default 50, max 100).
	InProgressPinPercent int `json:"inProgressPinPercent,omitempty"`
}

type Catalog struct {
	TMDBKey         string   `json:"tmdbKey"`  // owner override; empty uses the bundled key
	Language        string   `json:"language"` // TMDB language, e.g. "en-US"
	Region          string   `json:"region"`
	MinPopularity   float64  `json:"minPopularity"`
	MinVotes        int      `json:"minVotes"`
	IncludeAdult    bool     `json:"includeAdult"`
	RefreshInterval Duration `json:"refreshInterval"`
}

type Config struct {
	// SharedCache is the cluster-wide NAS policy. Mount paths stay in Cache.
	SharedCache   *Cache        `json:"sharedCache,omitempty"`
	Server        Server        `json:"server"`
	Plex          Plex          `json:"plex"`
	Usenet        Usenet        `json:"usenet"`
	Indexers      []Indexer     `json:"indexers"`
	Cache         Cache         `json:"cache"`
	Catalog       Catalog       `json:"catalog"`
	Resolver      Resolver      `json:"resolver"`
	Quality       Quality       `json:"quality"`
	Transcode     Transcode     `json:"transcode"`
	Trakt         Trakt         `json:"trakt"`
	OpenSubtitles OpenSubtitles `json:"openSubtitles"`
	LLM           LLM           `json:"llm"`
	Updates       Updates       `json:"updates"`
	Spike         Spike         `json:"spike"`
	Downloads     Downloads     `json:"downloads"`
	Markers       Markers       `json:"markers"`
	Personalize   Personalize   `json:"personalize"`
	Extras        Extras        `json:"extras"`
	Debrid        Debrid        `json:"debrid"`
	// Database is node-local storage selection (SQLite or PostgreSQL).
	Database      Database     `json:"database"`
	IndexerSites  IndexerSites `json:"indexerSites"`
	SetupComplete bool         `json:"setupComplete"`
}

type Database struct {
	// Driver is "sqlite" (default) or "postgres".
	Driver string `json:"driver,omitempty"`
	// URL is the PostgreSQL connection URL, e.g.
	// postgres://ether:secret@db.lan:5432/ether?sslmode=verify-full
	URL string `json:"url,omitempty"`
	// DeferMigrations makes this node wait, at startup, instead of applying
	// new schema migrations to the shared database while another live node
	// runs a version of Ether that does not know them. Off by default:
	// migrations are additive, so older nodes keep working on a newer
	// schema and a rolling update never stalls on it.
	DeferMigrations bool `json:"deferMigrations,omitempty"`
}

type Debrid struct {
	Providers []DebridProvider `json:"providers"`
	// CachedOnly accepts a torrent only when a provider can serve it
	// instantly. When false, an uncached torrent is left on the account to
	// download and the release is skipped for now; playback never waits.
	CachedOnly bool `json:"cachedOnly"`
	// RemoveUncached deletes torrents Ether added that turned out not to be
	// cached, keeping the owner's account clean (CachedOnly only).
	RemoveUncached bool `json:"removeUncached"`
	// ChunkBytes caps one HTTP range request (0 = 8 MiB). Requests start
	// small for a fast first byte and grow towards this size.
	ChunkBytes int64 `json:"chunkBytes,omitempty"`
	// ReadAheadChunks fixes the sequential read-ahead window in chunks
	// (0 = adaptive to measured throughput; negative disables read-ahead).
	ReadAheadChunks int `json:"readAheadChunks,omitempty"`
	// MaxConnections caps concurrent range requests per open file (0 = 4).
	MaxConnections int `json:"maxConnections,omitempty"`
}

type DebridProvider struct {
	ID       string `json:"id"`
	Name     string `json:"name"`
	Kind     string `json:"kind"` // realdebrid, torbox, alldebrid, premiumize
	APIKey   string `json:"apiKey"`
	Priority int    `json:"priority"` // lower is tried first
	Enabled  bool   `json:"enabled"`
}

type Downloads struct {
	Enabled bool `json:"enabled"`
	// AllowFriends lets shared (non-owner) users download. Off by
	// default, matching PMS sharing where sync is a separate grant; an
	// AccessPolicy AllowDownloads decision overrides this per user.
	AllowFriends bool `json:"allowFriends"`
	// MaxConcurrent bounds simultaneous remuxes server-wide (default 2),
	// MaxConcurrentPerUser per viewer (default 1).
	MaxConcurrent        int `json:"maxConcurrent"`
	MaxConcurrentPerUser int `json:"maxConcurrentPerUser"`
	// DiskBudgetBytes bounds the temporary remuxed files on disk at any
	// time (default 20 GiB). 0 uses the default.
	DiskBudgetBytes int64 `json:"diskBudgetBytes"`
	// Expiry is how long a finished download stays fetchable before its
	// temp file is deleted (default 24h).
	Expiry Duration `json:"expiry"`
	// MaxHeight caps the download profile's resolution (default 1080).
	MaxHeight int `json:"maxHeight"`
}

type Duration time.Duration

type Extras struct {
	// Enabled turns extras (and Cinema Trailers) on.
	Enabled bool `json:"enabled"`
	// ResolverCommand is the path (or PATH name) of a yt-dlp-compatible
	// tool that prints a direct media URL for a video page. Empty disables
	// the command source. Ether ships no resolver binary.
	ResolverCommand string `json:"resolverCommand,omitempty"`
	// ResolverArgs is the fixed argument template passed to
	// ResolverCommand. The placeholders {url}, {site}, {key} and {id} are
	// substituted; the command always runs without a shell. Empty uses a
	// yt-dlp-compatible default ("-g -f b[ext=mp4]/b --no-playlist {url}").
	ResolverArgs []string `json:"resolverArgs,omitempty"`
	// ResolverTimeout bounds one resolver invocation (default 20s).
	ResolverTimeout Duration `json:"resolverTimeout,omitempty"`
	// PrewarmBytes is how much of the feature to pre-buffer while a
	// trailer plays (clamped to 32–64 MiB, default 48 MiB).
	PrewarmBytes int64 `json:"prewarmBytes,omitempty"`
}

type FieldSealer interface {
	SealField(plain string, context ...string) (string, error)
	OpenField(stored string, context ...string) (plain string, legacy bool, err error)
}

type Indexer struct {
	ID         string `json:"id"`
	Name       string `json:"name"`
	URL        string `json:"url"` // base URL; /api is appended
	APIKey     string `json:"apiKey"`
	DailyLimit int    `json:"dailyLimit"` // optional personal API cap per UTC day; 0 = automatic service limits
	DailyGrabs int    `json:"dailyGrabs"` // optional personal NZB cap per UTC day; 0 = automatic service limits
	Priority   int    `json:"priority"`
	Enabled    bool   `json:"enabled"`
	// Categories override; empty uses Newznab defaults (2000 movies, 5000 TV).
	MovieCategories []int `json:"movieCategories"`
	TVCategories    []int `json:"tvCategories"`
	// Protocol is "usenet" (Newznab, the default when empty) or "torrent"
	// (Torznab; results stream through a debrid provider).
	Protocol string `json:"protocol,omitempty"`
	// Kind selects how the indexer is searched: "" or IndexerKindNewznab
	// for a Newznab/Torznab API at URL, IndexerKindCardigann for a built-in
	// site run from an owner-installed definition. For a built-in site URL
	// is the site address and Protocol follows the definition.
	Kind string `json:"kind,omitempty"`
	// Definition is the installed definition id of a built-in site.
	Definition string `json:"definition,omitempty"`
	// Settings are the definition's setting values by name.
	Settings map[string]string `json:"settings,omitempty"`
	// SecretSettings are the definition's password-type settings. They are
	// sealed at rest and redacted in API responses like API keys.
	SecretSettings map[string]string `json:"secretSettings,omitempty"`
}

type IndexerSites struct {
	// DefinitionsURL is an optional source of definitions the owner trusts
	// and has the right to use: a GitHub contents API URL, a GitHub folder
	// or raw folder URL, or a plain list of definition URLs. Empty = none;
	// definitions are then added only by upload.
	DefinitionsURL string `json:"definitionsUrl,omitempty"`
	// FlareSolverrURL is an optional FlareSolverr service used to pass
	// Cloudflare browser challenges, e.g. http://localhost:8191.
	FlareSolverrURL string `json:"flareSolverrUrl,omitempty"`
}

type LLM struct {
	Enabled bool `json:"enabled"` // off by default
	// Provider is an LLMProviders ID; empty means LLMProviderCustom.
	Provider string `json:"provider"`
	// BaseURL overrides the provider's endpoint for local servers and is
	// required for a custom OpenAI-compatible endpoint, e.g.
	// http://localhost:11434/v1. Hosted providers ignore it.
	BaseURL string `json:"baseUrl"`
	APIKey  string `json:"apiKey"`
	Model   string `json:"model"`
}

type LLMProvider struct {
	ID    string `json:"id"`
	Label string `json:"label"`
	// API is the wire protocol (LLMAPIOpenAI, LLMAPIAnthropic, LLMAPIGoogle).
	API string `json:"api"`
	// BaseURL is the default endpoint; empty for LLMProviderCustom.
	BaseURL string `json:"baseUrl"`
	// NeedsKey is set for hosted services that reject anonymous calls.
	NeedsKey bool `json:"needsKey"`
	// Local servers run on the owner's network, so their endpoint is
	// editable (BaseURL is only the usual default).
	Local bool `json:"local"`
	// RequiresBaseURL is set when the owner must supply the endpoint.
	RequiresBaseURL bool `json:"requiresBaseUrl"`
	// KeyHint is the API-key placeholder; ModelHint explains model IDs.
	KeyHint   string `json:"keyHint,omitempty"`
	ModelHint string `json:"modelHint,omitempty"`
}

type Markers struct {
	TheIntroDB bool   `json:"theIntroDb"`
	APIKey     string `json:"apiKey"`
}

type Notifier interface {
	Publish(ctx context.Context, topic string, payload []byte) error
	Subscribe(topic string, fn func([]byte)) (unsubscribe func())
}

type OpenSubtitles struct {
	Enabled  bool   `json:"enabled"`
	APIKey   string `json:"apiKey"`
	Username string `json:"username"`
	Password string `json:"password"`
}

type Personalize struct {
	// PostPlay ranks the post-play "hook queue" per viewer instead of
	// returning generic related rows (#30). The ranked endpoint itself is
	// cheap; the switch exists for owners who prefer plain PMS behaviour.
	PostPlay bool `json:"postPlay"`
	// PostPlayPrebuffer pre-warms and pre-buffers the #1 post-play pick in
	// the last minutes of a movie or finale (#30).
	PostPlayPrebuffer bool `json:"postPlayPrebuffer"`
	// MicroReasons decorates single-item detail pages with the viewer's
	// decision header ("96% Match · … · Ends at 10:45 PM") (#31).
	MicroReasons bool `json:"microReasons"`
	// SessionIntent adapts /hubs to what the viewer is browsing tonight
	// (detail opens that did not turn into playback) (#32).
	SessionIntent bool `json:"sessionIntent"`
	// ClockFormat is the finish-time style of the decision header:
	// "12h", "24h", or "" to derive it from Catalog.Language.
	ClockFormat string `json:"clockFormat"`
}

type Plex struct {
	CompatibilityVersion       string `json:"compatibilityVersion,omitempty"`
	LatestCompatibilityVersion string `json:"latestCompatibilityVersion,omitempty"`
	DisableVersionTracking     bool   `json:"disableVersionTracking"`
	// Token is the owner's plex.tv token from sign-in; the server token.
	Token            string `json:"token"`
	ClientIdentifier string `json:"clientIdentifier"` // X-Plex-Client-Identifier Ether uses towards plex.tv
	OwnerPlexID      int64  `json:"ownerPlexId"`
	OwnerUsername    string `json:"ownerUsername"`
	Claimed          bool   `json:"claimed"`
	// Remote access
	RemoteAccess bool     `json:"remoteAccess"`
	UseUPnP      bool     `json:"useUpnp"`
	PublicPort   int      `json:"publicPort"` // manual port forward; 0 = same as Server.Port
	PublicHost   string   `json:"publicHost"` // override detected WAN IP
	CustomURLs   []string `json:"customUrls"`
	// TLS certificate for *.plex.direct (or a self-signed fallback).
	CertFile          string `json:"certFile"`
	KeyFile           string `json:"keyFile"`
	CertHash          string `json:"certHash"`          // plex.direct subdomain hash
	SecureConnections string `json:"secureConnections"` // "required", "preferred", "disabled"
}

type Prowlarr struct {
	URL        string `json:"url"`
	APIKey     string `json:"apiKey"`
	DailyLimit int    `json:"dailyLimit"`
	DailyGrabs int    `json:"dailyGrabs"`
	Priority   int    `json:"priority"`
}

type Quality struct {
	// Profiles by name. Rules pick a profile per client.
	Profiles []core.QualityProfile `json:"profiles"`
	Rules    []QualityRule         `json:"rules"`
	Default  string                `json:"default"`
	Remote   string                `json:"remote"` // profile for remote clients, "" = same as default
}

type QualityRule struct {
	Product  string `json:"product,omitempty"`  // substring of X-Plex-Product
	Platform string `json:"platform,omitempty"` // substring of X-Plex-Platform
	UserID   int64  `json:"userId,omitempty"`
	Profile  string `json:"profile"`
}

type RTXVideo struct {
	Mode            string `json:"mode"`            // off, auto (LAN), on (also remote)
	ExecutablePath  string `json:"executablePath"`  // optional NVEncC64.exe, otherwise PATH
	SourceMaxHeight int    `json:"sourceMaxHeight"` // default 720
	TargetMaxHeight int    `json:"targetMaxHeight"` // default 1080, maximum 2160
	Quality         int    `json:"quality"`         // default 2, NGX quality 1..4 or streaming 21/23 (Ampere+); 0 uses default
	MaxConcurrent   int    `json:"maxConcurrent"`   // default 1, maximum 8
}

type Resolver struct {
	HealthRace           int                 `json:"healthRace"`      // 0 = ranked checks; >0 = first healthy of bounded concurrent candidates
	OptimisticStart      bool                `json:"optimisticStart"` // return top NZB before background health check
	CustomFormats        []core.CustomFormat `json:"customFormats,omitempty"`
	CustomFormatScores   map[string]int      `json:"customFormatScores,omitempty"`
	MinCustomFormatScore *int                `json:"minCustomFormatScore,omitempty"`
	AllowCam             bool                `json:"allowCam"` // owner setting, off by default
	HealthSamples        int                 `json:"healthSamples"`
	SearchCacheTTL       Duration            `json:"searchCacheTtl"`
	UnavailableCooloff   Duration            `json:"unavailableCooloff"` // hide titles with no release this long
	MaxCandidates        int                 `json:"maxCandidates"`
	BlockedGroups        []string            `json:"blockedGroups"`
	BlockedTerms         []string            `json:"blockedTerms"`
	// SourcePreference orders releases of equivalent quality by source:
	// "auto" (or empty) puts the source that measurably starts faster
	// first, and cached debrid first for popular titles until both
	// sources have measurements; "usenet" or "debrid" always prefer one.
	// Quality is never traded for speed (see resolver/routing.go).
	SourcePreference string `json:"sourcePreference,omitempty"`
	// SourceScoreMargin is how far below the leader's score a release of
	// the same quality tier may be and still be moved first for its
	// source (0 = 25).
	SourceScoreMargin float64 `json:"sourceScoreMargin,omitempty"`
}

type Scope int

type Server struct {
	// Port for the Plex API and web UI. PMS uses 32400.
	Port         int    `json:"port"`
	BindAddress  string `json:"bindAddress"`
	FriendlyName string `json:"friendlyName"`
	// MachineIdentifier is generated on first run and never changes.
	MachineIdentifier string `json:"machineIdentifier"`
	LogLevel          string `json:"logLevel"`
	// DefaultStreamLimit applies to users without their own limit.
	DefaultStreamLimit int `json:"defaultStreamLimit"`
	MaxStreams         int `json:"maxStreams"` // server-wide cap, 0 = derived from Usenet connections
	// ClusterWeight is this node's weight when a cluster divides
	// account-wide budgets (Usenet provider connections) among live nodes;
	// a node with weight 2 gets twice the share of a node with weight 1.
	// 0 means 1. Node-local; ignored on a standalone server.
	ClusterWeight int `json:"clusterWeight,omitempty"`
}

type SharedBackend interface {
	// LoadShared returns the stored document; found is false when none
	// has been stored yet.
	LoadShared(ctx context.Context) (doc SharedDoc, found bool, err error)
	// SaveShared stores doc if the stored version is expectVersion (0:
	// nothing stored yet) and returns the new version, or
	// ErrSharedConflict.
	SaveShared(ctx context.Context, doc SharedDoc, expectVersion int64) (int64, error)
	// SharedVersion is the stored version (0 when none).
	SharedVersion(ctx context.Context) (int64, error)
}

type SharedDoc struct {
	// Doc is the shared settings JSON with secrets sealed by the cluster's
	// credential key.
	Doc string
	// Version increases by one on every write.
	Version int64
	// KeyFingerprint is KeyFingerprint(credential key) of the cluster.
	KeyFingerprint string
}

type SharedOptions struct {
	// Notifier pushes changes between nodes; may also be set later with
	// SetNotifier. Nil: polling only.
	Notifier Notifier
	// PollInterval re-reads the stored version (default
	// DefaultSharedPoll; negative disables polling and the watcher).
	PollInterval time.Duration
	// Timeout bounds each database call (default 10s).
	Timeout time.Duration
	// NoSeed makes AttachShared fail with ErrSharedMissing instead of
	// seeding an empty database from this node's settings.
	NoSeed bool
	Logger *slog.Logger
}

type Spike struct {
	Enabled    bool     `json:"enabled"`
	LocalFiles []string `json:"localFiles"`
}

type Store struct {
	// contains filtered or unexported fields
}

type Trakt struct {
	Enabled      bool   `json:"enabled"`
	ClientID     string `json:"clientId"`
	ClientSecret string `json:"clientSecret"`
}

type Transcode struct {
	RTXVideo RTXVideo `json:"rtxVideo"`

	FFmpegPath           string `json:"ffmpegPath"` // empty = bundled, then PATH
	FFprobePath          string `json:"ffprobePath"`
	HWAccel              string `json:"hwAccel"` // "auto", "none", "videotoolbox", "nvenc", "qsv", "vaapi"
	VAAPIDevice          string `json:"vaapiDevice"`
	TempDir              string `json:"tempDir"`
	MaxTranscodes        int    `json:"maxTranscodes"`
	RemoteMaxBitrateKbps int    `json:"remoteMaxBitrateKbps"`

	// Adaptive HLS engine (additive). Numeric zero values select the
	// transcode package defaults; see Defaults for the shipped values.
	FastStart          bool     `json:"fastStart"`          // short, quick opening segments
	FastStartSegments  int      `json:"fastStartSegments"`  // opening segments in the ramp (default 2)
	FastStartSegment   Duration `json:"fastStartSegment"`   // ramp segment length (default 2s)
	FastStartMaxHeight int      `json:"fastStartMaxHeight"` // ramp encode height cap (default 720)
	ABRLadder          bool     `json:"abrLadder"`          // multi-rung master playlist / MPD
	VBVReservoir       bool     `json:"vbvReservoir"`       // constant-quality + generous VBV for capped transcodes
	VBVBufferSeconds   int      `json:"vbvBufferSeconds"`   // VBV buffer depth in seconds of maxrate (default 8)
	SpikeGovernor      bool     `json:"spikeGovernor"`      // clamp VBR spikes in copy streams to measured goodput
	SpikeMarginPercent int      `json:"spikeMarginPercent"` // spike threshold over goodput, percent (default 125)
}

type Updates struct {
	Channel    string `json:"channel"` // "stable", "beta"
	AutoUpdate bool   `json:"autoUpdate"`
	FeedURL    string `json:"feedUrl"`
	// MaintenanceStart/End bound the local-time window ("HH:MM") in which
	// a downloaded update may be installed automatically. The window may
	// wrap midnight; equal values mean "any time".
	MaintenanceStart string `json:"maintenanceStart"`
	MaintenanceEnd   string `json:"maintenanceEnd"`
	// MaxDrain bounds how long a clustered node about to install an update
	// waits for its own playback sessions to end (it admits no new ones
	// meanwhile) before installing anyway inside the window. 0 means 30
	// minutes. Ignored on a standalone server, which waits for idle.
	MaxDrain Duration `json:"maxDrain,omitempty"`
}

type Usenet struct {
	Providers []UsenetProvider `json:"providers"`
	// MinIdle is how many connections per primary (non-backfill) provider
	// are kept warm (dialled, authenticated, DATE-pinged) at all times so
	// Play never pays a cold handshake. 0 = default (2); negative = off
	// (connections are dialled lazily and expire when idle). A provider's
	// own MinIdle overrides this.
	MinIdle int `json:"minIdle"`
}

type UsenetProvider struct {
	ID          string `json:"id"`
	Name        string `json:"name"`
	Host        string `json:"host"`
	Port        int    `json:"port"`
	TLS         bool   `json:"tls"`
	Username    string `json:"username"`
	Password    string `json:"password"`
	Connections int    `json:"connections"`
	// Priority: lower is tried first. Block accounts set Backfill.
	Priority int  `json:"priority"`
	Backfill bool `json:"backfill"` // only used for articles missing elsewhere
	Enabled  bool `json:"enabled"`
	// MinIdle overrides Usenet.MinIdle for this provider: 0 = inherit the
	// global setting, positive = that many warm connections, negative =
	// no warm floor for this provider. Backfill providers are never kept
	// warm regardless.
	MinIdle int `json:"minIdle,omitempty"`
}