livetv

type Block struct {
	// Start and End are minutes after midnight in Timezone, or UTC when
	// the channel has no timezone. End may be 1440. Days empty means every
	// day, which is how channels saved before the weekly grid behave.
	// Days are Go weekdays: 0 Sunday … 6 Saturday, in that same zone.
	Start int   `json:"start"`
	End   int   `json:"end"`
	Days  []int `json:"days,omitempty"`
	// Name is a short grid label such as "Cartoons". It does not change
	// what plays. Known preset names are translated in the console.
	Name        string          `json:"name,omitempty"`
	Items       []Item          `json:"items"`
	Shuffle     bool            `json:"shuffle"`
	Mode        string          `json:"mode,omitempty"`  // order, shuffle, random, marathon, newest
	Align       string          `json:"align,omitempty"` // hour, half
	Fit         string          `json:"fit,omitempty"`   // cut, pad
	RepeatDays  int             `json:"repeatDays,omitempty"`
	Filler      []Item          `json:"filler,omitempty"`
	MarathonKey core.RatingKey  `json:"marathonKey,omitempty"`
	Collection  core.RatingKey  `json:"collection,omitempty"`
	Filter      *core.Filter    `json:"filter,omitempty"`
	Sources     []ProgramSource `json:"sources,omitempty"`
	Watched     string          `json:"watched,omitempty"`
}

type Channel struct {
	Health    string `json:"health,omitempty"`
	Transcode bool   `json:"transcode"` // IPTV: normalize codecs through the transcoder
	ID        string `json:"id"`
	// Private channels are hidden from every viewer whose policy does not
	// grant them: a restricted viewer needs it in Channels, an unrestricted
	// one in Granted. Owners always see them.
	Private       bool           `json:"private,omitempty"`
	Number        string         `json:"number"`
	Name          string         `json:"name"`
	Kind          string         `json:"kind"` // virtual or iptv
	Enabled       bool           `json:"enabled"`
	Favorite      bool           `json:"favorite"`
	Logo          string         `json:"logo,omitempty"`
	LogoMatched   bool           `json:"logoMatched,omitempty"`
	Rating        string         `json:"rating,omitempty"`
	SourceID      string         `json:"sourceId,omitempty"`
	GuideID       string         `json:"guideId,omitempty"`
	TvgName       string         `json:"tvgName,omitempty"`       // provider's label; a guide-matching hint
	StreamURL     string         `json:"streamUrl,omitempty"`     // owner API only
	StreamSources []StreamSource `json:"streamSources,omitempty"` // ordered inputs; independent of channel/guide identity
	Group         string         `json:"group,omitempty"`
	CustomGroup   bool           `json:"customGroup,omitempty"` // preserve owner grouping on provider refresh
	Epoch         time.Time      `json:"epoch"`
	Seed          int64          `json:"seed"`
	Shuffle       bool           `json:"shuffle"`
	Items         []Item         `json:"items"`
	Blocks        []Block        `json:"blocks,omitempty"`
	// Collection/Filter/Sources are expanded into a stable item snapshot when saved.
	Collection core.RatingKey  `json:"collection,omitempty"`
	Filter     *core.Filter    `json:"filter,omitempty"`
	Sources    []ProgramSource `json:"sources,omitempty"`
	Watched    string          `json:"watched,omitempty"` // household: watched, unwatched
	// Mode, Align, Fit, RepeatDays and Filler are the base playout. Empty
	// Mode keeps Shuffle as the original engine: false resumes in order from
	// Epoch, true is one stable shuffle. Timezone empty means block minutes
	// are UTC, every day.
	Mode        string         `json:"mode,omitempty"`
	Align       string         `json:"align,omitempty"`
	Fit         string         `json:"fit,omitempty"`
	RepeatDays  int            `json:"repeatDays,omitempty"`
	Filler      []Item         `json:"filler,omitempty"`
	Fallback    []Item         `json:"fallback,omitempty"`
	OffAir      bool           `json:"offAir,omitempty"`
	MarathonKey core.RatingKey `json:"marathonKey,omitempty"`
	Timezone    string         `json:"timezone,omitempty"`

	// GuideSourceID names the source whose XMLTV supplies GuideID's
	// programmes. Empty means SourceID. Virtual channels ignore it.
	GuideSourceID string `json:"guideSourceId,omitempty"`

	// ProviderNumber is the number the source gave this channel at the last
	// import (Xtream num, M3U tvg-chno, or the position in the owner's group
	// order). While Number still equals it the channel follows the
	// provider's renumbering; an owner edit makes Number differ and sticks.
	ProviderNumber string `json:"providerNumber,omitempty"`
	// contains filtered or unexported fields
}

type ChannelBatch struct {
	IDs      []string `json:"ids"`
	Enabled  *bool    `json:"enabled,omitempty"`
	Favorite *bool    `json:"favorite,omitempty"`
	Group    *string  `json:"group,omitempty"`
}

type ChannelCounts struct {
	All       int `json:"all"`
	Live      int `json:"live"`
	Favorites int `json:"favorites"`
	Virtual   int `json:"virtual"`
	IPTV      int `json:"iptv"`
	Off       int `json:"off"`
	Missing   int `json:"missing"`
}

type ChannelGroup struct {
	Key      string `json:"key"`
	SourceID string `json:"sourceId,omitempty"`
	Kind     string `json:"kind"`
	Count    int    `json:"count"`
	Start    int    `json:"start"`
}

type ChannelPage struct {
	Channels   []Channel       `json:"channels"`
	Total      int             `json:"total"`
	Counts     ChannelCounts   `json:"counts"`
	Groups     []ChannelGroup  `json:"groups"`
	Coverage   map[string]bool `json:"coverage"`
	NextNumber string          `json:"nextNumber"`
}

type ChannelPageQuery struct {
	Limit  int
	Offset int
	Q      string
	Filter string
	Source string
}

type ChannelSummary struct {
	ID            string `json:"id"`
	Number        string `json:"number"`
	Name          string `json:"name"`
	Kind          string `json:"kind"`
	Private       bool   `json:"private,omitempty"`
	Enabled       bool   `json:"enabled"`
	Favorite      bool   `json:"favorite"`
	Rating        string `json:"rating,omitempty"`
	Logo          string `json:"logo,omitempty"`
	SourceID      string `json:"sourceId,omitempty"`
	GuideID       string `json:"guideId,omitempty"`
	GuideSourceID string `json:"guideSourceId,omitempty"`
	Group         string `json:"group,omitempty"`
	// contains filtered or unexported fields
}

type ChannelUsage struct {
	ChannelID string `json:"channelId"`
	Viewers   int    `json:"viewers"`
}

type ChannelViewers struct {
	Allow []int64 `json:"allow,omitempty"`
	Deny  []int64 `json:"deny,omitempty"`
}

type Fetched struct {
	Channels []Channel
	Guide    XMLGuide
	// AddonInputs marks channels whose inputs an add-on owns (ids carry
	// AddonInputPrefix); see addon_streams.go.
	AddonInputs bool
	// ProviderNumbers marks a lineup whose every number comes from the
	// provider. Channels imported before provider numbers were recorded
	// then take the provider's number instead of keeping a generated one.
	ProviderNumbers bool
}

type GuideChannel struct {
	SourceID   string     `json:"sourceId"`
	SourceName string     `json:"sourceName"`
	SourceKind string     `json:"sourceKind,omitempty"`
	GuideID    string     `json:"guideId"`
	Name       string     `json:"name"`
	Logo       string     `json:"logo"`
	Programmes int        `json:"programmes"`
	Until      *time.Time `json:"until,omitempty"`
}

type GuideCoverage struct {
	ChannelID  string     `json:"channelId"`
	Programmes int        `json:"programmes"`
	Until      *time.Time `json:"until,omitempty"`
}

type GuideMatchChange struct {
	ChannelID       string `json:"channelId"`
	ChannelName     string `json:"channelName"`
	GuideSourceID   string `json:"guideSourceId"`
	GuideSourceName string `json:"guideSourceName"`
	GuideID         string `json:"guideId"`
	GuideName       string `json:"guideName"`
	Method          string `json:"method"` // "id", "name" or "alias"
	ReviewRegion    bool   `json:"reviewRegion,omitempty"`
}

type GuideMatchRequest struct {
	ChannelIDs []string `json:"channelIds,omitempty"`
	Overwrite  bool     `json:"overwrite"`
	DryRun     bool     `json:"dryRun"`
	// Reviewed is set by the owner route for explicitly accepted proposals, never by imports.
	Reviewed bool `json:"-"`
}

type GuideMatchResult struct {
	Matched   int `json:"matched"`
	Unmatched int `json:"unmatched"`
	Skipped   int `json:"skipped"` // already had guide data and overwrite was false
	// Ambiguous and RegionRejected count name matches the matcher refused:
	// several guide ids or playlist rows share the name, or the declared
	// regions contradict.
	Ambiguous      int                `json:"ambiguous"`
	RegionRejected int                `json:"regionRejected"`
	DryRun         bool               `json:"dryRun"`
	Changes        []GuideMatchChange `json:"changes"`
}

type Item struct {
	EpisodeTitle string         `json:"episodeTitle,omitempty"`
	ShowTitle    string         `json:"showTitle,omitempty"`
	Art          string         `json:"art,omitempty"`
	Genres       []string       `json:"genres,omitempty"`
	GUID         string         `json:"guid,omitempty"`
	ShowGUID     string         `json:"showGuid,omitempty"`
	MediaType    string         `json:"mediaType,omitempty"`
	Premiere     bool           `json:"premiere,omitempty"`
	Live         bool           `json:"live,omitempty"`
	Key          core.RatingKey `json:"key"`
	Title        string         `json:"title"`
	DurationMS   int64          `json:"durationMs"`
	Summary      string         `json:"summary,omitempty"`
	Rating       string         `json:"rating,omitempty"`
	Thumb        string         `json:"thumb,omitempty"`
	// Show metadata keeps episodes in season order inside a shuffle,
	// marathon or newest-first playout. Zero values are movies and items
	// saved before weekly scheduling, which stay in their stored order.
	ShowKey    core.RatingKey `json:"showKey,omitempty"`
	Season     int            `json:"season,omitempty"`
	Episode    int            `json:"episode,omitempty"`
	ReleasedMS int64          `json:"releasedMs,omitempty"`
	// Slate is "offair" for a guide entry that fills a gap. It is not a
	// catalogue title and is never stored on a channel.
	Slate string `json:"slate,omitempty"`
}

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

type Options struct {
	PlexGuideToken func() string
	PlexGuideURL   string // test endpoint

	CanPlay            func(*core.User, bool, time.Time) bool
	StreamLimit        func(*core.User) int
	DB                 *sql.DB
	Catalog            core.Catalog
	Collections        core.Collections
	Playback           core.Playback
	Transcoder         core.Transcoder
	HTTPClient         *http.Client
	LogoHTTP           *http.Client // optional test transport for the logo index; nil uses the guarded client
	LogoIndexURL       func() string
	HealthSweepMinutes func() int // 0 defaults to 15; negative disables
	Now                func() time.Time
	// Logger receives credential-safe import, playback and delivery diagnostics.
	Logger *slog.Logger
	// Allowed applies additional owner title/genre policies to every surface.
	Allowed func(*core.User, *core.Title) bool
	// Warm resolves/primes a title without opening a viewer stream.
	Warm func(context.Context, core.RatingKey) error
	// Availability is the resolver's cached playability. Known-unavailable
	// titles are left out of the guide; unknown titles stay in place.
	Availability core.AvailabilitySource
	// Sealer protects source credentials at rest (secrets.go); nil stores
	// them as given.
	Sealer config.FieldSealer
	// Kinds overrides the source-kind registry; nil uses the built-ins.
	Kinds *KindRegistry
}

type PlexLineup struct {
	ID    string `json:"id"`
	Title string `json:"title"`
	Type  string `json:"type"`
}

type Policy struct {
	UserID   int64 `json:"userId"`
	Disabled bool  `json:"disabled"`
	// Restricted limits the viewer to Channels (none when empty), private
	// ones included. Unrestricted viewers see every public channel, including
	// ones added later, plus the private channels in Granted; Channels is
	// empty.
	Restricted bool     `json:"restricted"`
	Channels   []string `json:"channels,omitempty"`
	Granted    []string `json:"granted,omitempty"`
	Favorites  []string `json:"favorites,omitempty"`
	MaxRating  string   `json:"maxRating,omitempty"`
	// contains filtered or unexported fields
}

type PreviewSession struct {
	ID               string     `json:"id"`
	Playlist         string     `json:"playlist"`
	ActiveSourceID   string     `json:"activeSourceId,omitempty"`
	ActiveSourceName string     `json:"activeSourceName,omitempty"`
	Programme        *Programme `json:"programme,omitempty"`
}

type ProgramSource struct {
	Name       string         `json:"name,omitempty"`
	Weight     int            `json:"weight,omitempty"`
	Items      []Item         `json:"items,omitempty"`
	Collection core.RatingKey `json:"collection,omitempty"`
	Filter     *core.Filter   `json:"filter,omitempty"`
	Watched    string         `json:"watched,omitempty"`
}

type Programme struct {
	ID        string    `json:"id"`
	ChannelID string    `json:"channelId"`
	Start     time.Time `json:"start"`
	End       time.Time `json:"end"`
	Item      Item      `json:"item"`
}

type ProviderAccount struct {
	Status            string     `json:"status,omitempty"`
	Trial             bool       `json:"trial,omitempty"`
	ExpiresAt         *time.Time `json:"expiresAt,omitempty"`
	MaxConnections    int        `json:"maxConnections,omitempty"`
	ActiveConnections int        `json:"activeConnections"`
	Formats           []string   `json:"formats,omitempty"`
	CheckedAt         time.Time  `json:"checkedAt"`
}

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

type SessionInfo struct {
	ActiveSourceID string `json:"activeSourceId,omitempty"`
	// Plex's rolling subscription identity is numeric; the stream UUID remains
	// separate. These are ephemeral identities, scoped to this service lifetime.
	SubscriptionID  int64           `json:"-"`
	ActivityID      string          `json:"-"`
	ClientSessionID string          `json:"-"`
	MediaInfo       *core.MediaInfo `json:"-"` // Actual source analysis for native clients.
	ID              string          `json:"id"`
	UserID          int64           `json:"userId"`
	Channel         Channel         `json:"channel"`
	Programme       *Programme      `json:"programme,omitempty"`
	StartedAt       time.Time       `json:"startedAt"`
}

type Source struct {
	LineupID    string `json:"lineupId,omitempty"`
	Country     string `json:"country,omitempty"`
	PostalCode  string `json:"postalCode,omitempty"`
	PlexCursor  int    `json:"plexCursor,omitempty"`
	ID          string `json:"id"`
	Name        string `json:"name"`
	Kind        string `json:"kind,omitempty"` // a source kind id, e.g. plugin:<id>/channels
	PlaylistURL string `json:"playlistUrl,omitempty"`
	GuideURL    string `json:"guideUrl,omitempty"`
	// Inline uploads are supplied on import and are not returned by GET.
	Playlist  string    `json:"playlist,omitempty"`
	Guide     string    `json:"guide,omitempty"`
	UpdatedAt time.Time `json:"updatedAt"`
	// Auth authenticates playlist, guide and stream requests to the provider.
	// Secrets are redacted by the owner API (see auth.go).
	Auth *SourceAuth `json:"auth,omitempty"`
	// RefreshHours caps the time between automatic refreshes of URL-backed
	// sources: 0 uses the 6 hour default, a negative value means manual
	// refresh only. Sources also refresh before mapped listings run out.
	// Inline uploads never refresh automatically.
	RefreshHours int `json:"refreshHours,omitempty"`
	// LastError/LastErrorAt/RefreshFailures record failed refreshes; a
	// successful import clears them. Existing data is kept on failure.
	LastError       string     `json:"lastError,omitempty"`
	LastErrorAt     *time.Time `json:"lastErrorAt,omitempty"`
	RefreshFailures int        `json:"refreshFailures,omitempty"`
	// SkippedVOD counts VOD entries (Xtream /movie/ and /series/ streams)
	// the last playlist import left out. It is persisted with the source so
	// the console can report what the import dropped.
	SkippedVOD int `json:"skippedVod,omitempty"`
	// Read-only statistics computed by Sources(); ignored on import.
	HasPlaylist       bool       `json:"hasPlaylist"`
	HasGuide          bool       `json:"hasGuide"`
	ChannelCount      int        `json:"channelCount"`
	GuideChannelCount int        `json:"guideChannelCount"`
	ProgrammeCount    int        `json:"programmeCount"`
	GuideFrom         *time.Time `json:"guideFrom,omitempty"`
	GuideUntil        *time.Time `json:"guideUntil,omitempty"`
	NextRefresh       *time.Time `json:"nextRefresh,omitempty"`

	// Account is the provider's report on this login (Xtream panels),
	// refreshed with the lineup. Read-only.
	Account *ProviderAccount `json:"account,omitempty"`
	// Groups are the provider's channel groups from the last refresh, in
	// provider order, including the ones the owner excludes. Read-only.
	Groups []SourceGroup `json:"groups,omitempty"`
	// ExcludeGroups are group names the owner leaves out; their channels
	// are not imported at all. NewGroups "exclude" adds each group that
	// first appears on a refresh to ExcludeGroups; "" includes it.
	// HideAdult leaves out every group the provider flags as adult.
	ExcludeGroups []string `json:"excludeGroups,omitempty"`
	NewGroups     string   `json:"newGroups,omitempty"`
	HideAdult     bool     `json:"hideAdult,omitempty"`
	// GroupOrder is the owner's group order. Empty keeps the provider's
	// order and numbers; otherwise channels are numbered 1… down the
	// listed groups (unlisted groups follow in provider order).
	GroupOrder []string `json:"groupOrder,omitempty"`

	// Provider etiquette for the source's streams. MaxConnections caps
	// simultaneous provider connections below what the panel allows (0 uses
	// the panel's limit; it can never raise it). TuneGapSeconds is the least
	// time between two new provider streams: 0 is the default (2 s on a
	// connection-limited account, none otherwise), negative turns it off.
	// TunesPerHour caps new provider streams per hour; 0 is no cap.
	MaxConnections int `json:"maxConnections,omitempty"`
	TuneGapSeconds int `json:"tuneGapSeconds,omitempty"`
	TunesPerHour   int `json:"tunesPerHour,omitempty"`
}

type SourceAuth struct {
	// Type: "" (none), "basic", "bearer", "headers" or "xtream".
	Type     string `json:"type,omitempty"`
	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty"` // secret
	Token    string `json:"token,omitempty"`    // secret (bearer)
	// UserAgent and Referer apply to every type; many providers reject
	// unknown clients.
	UserAgent string `json:"userAgent,omitempty"`
	Referer   string `json:"referer,omitempty"`
	// Headers are extra request headers (cookies, API keys); values are secret.
	Headers map[string]string `json:"headers,omitempty"`
	// Xtream Codes: the panel URL. Playlist and guide URLs are derived from
	// it and the credentials, and never returned by the API.
	Server string `json:"server,omitempty"`
	// Output selects the Xtream stream format: "ts" (default) or "m3u8".
	Output string `json:"output,omitempty"`
}

type SourceDescribe struct {
	Label          extend.Text
	Hint           extend.Text
	Icon           string
	Order          int
	Editor         string
	Params         []extend.ParamField
	YieldsChannels bool
	YieldsGuide    bool
}

type SourceGroup struct {
	Name     string `json:"name"`
	Channels int    `json:"channels"`
	Adult    bool   `json:"adult,omitempty"`
	// Excluded reports whether the owner's rules leave this group out.
	Excluded bool `json:"excluded,omitempty"`
}

type SourceKind interface {
	ID() string
	Describe() SourceDescribe
	Matches(src Source) bool
	// Fetch fills src.Playlist/src.Guide from URLs as needed (so they are
	// stored for the next refresh) and returns the parsed result.
	Fetch(ctx context.Context, s *Service, src *Source) (Fetched, error)
}

type SourceProgress struct {
	Phase           string    `json:"phase"` // starting, playlist, guide, saving
	Read            int64     `json:"read"`
	Total           int64     `json:"total,omitempty"`
	Channels        int       `json:"channels,omitempty"`
	Programmes      int       `json:"programmes,omitempty"`
	SavedChannels   int       `json:"savedChannels,omitempty"`
	SavedProgrammes int       `json:"savedProgrammes,omitempty"`
	Started         time.Time `json:"started"`
	Updated         time.Time `json:"updated"`
}

type SourceUsage struct {
	SourceID string `json:"sourceId"`
	// Open is how many provider connections Ether holds now.
	Open int `json:"open"`
	// StartsLastHour counts stream starts reserved in the last hour.
	StartsLastHour int `json:"startsLastHour"`
}

type StreamSource struct {
	ID       string `json:"id"`
	Name     string `json:"name"`
	URL      string `json:"url"`
	Enabled  bool   `json:"enabled"`
	Priority int    `json:"priority"` // smaller first; equal priorities retain list order
	// AuthSourceID names the source whose provider credentials this input
	// uses; empty means the channel's own source.
	AuthSourceID string `json:"authSourceId,omitempty"`
	// Headers are request headers this input needs (a Stremio stream's
	// proxy headers), sent after the source's own.
	Headers map[string]string `json:"headers,omitempty"`
}

type StreamSourceStatus struct {
	ID          string    `json:"id"`
	State       string    `json:"state"`
	Failures    int       `json:"failures"`
	LastChecked time.Time `json:"lastChecked,omitempty"`
	LastPlayed  time.Time `json:"lastPlayed,omitempty"`
	RetryAfter  time.Time `json:"retryAfter,omitempty"`
	LastError   string    `json:"lastError,omitempty"`
}

type TuneError struct {
	Code           string
	Stage          string
	UpstreamStatus int
	RetryAfter     time.Duration
	// contains filtered or unexported fields
}

type Usage struct {
	// Sessions counts live tunes; Viewers the distinct viewers behind them.
	Sessions int            `json:"sessions"`
	Viewers  int            `json:"viewers"`
	Watching []ChannelUsage `json:"watching"`
	Sources  []SourceUsage  `json:"sources"`
}

type VirtualDASHError struct {
	Err error
	// Message is the client-facing reason when it is more specific than Err.
	Message string
}

type XMLGuide struct {
	Channels   map[string]Channel
	Programmes []Programme
	// Names holds every display-name of each XMLTV channel, in order.
	Names map[string][]string
	// LateChannels counts <channel> elements that appeared after the first
	// <programme>. A valid guide has none; they are skipped rather than
	// buffered, so name candidates they declare are missed.
	LateChannels int
}