Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 CoffeeKnyte
|
2312c0f4be |
+4
-16
@@ -2,11 +2,9 @@
|
||||
# For the default docker compose setup, MEDIA_ROOT is the main value you need to set.
|
||||
|
||||
# Optional: layer compose files through env. Leave unset for CPU-only defaults.
|
||||
# Linux example for Intel/AMD VA-API or Intel Quick Sync:
|
||||
# COMPOSE_FILE=docker-compose.yml:docker-compose.vaapi.yml
|
||||
# Linux example for NVIDIA NVENC:
|
||||
# Linux/macOS example for enabling NVIDIA override:
|
||||
# COMPOSE_FILE=docker-compose.yml:docker-compose.nvidia.yml
|
||||
# Windows NVIDIA example:
|
||||
# Windows example:
|
||||
# COMPOSE_FILE=docker-compose.yml;docker-compose.nvidia.yml
|
||||
|
||||
# Required for docker compose: host path to your media library.
|
||||
@@ -29,15 +27,6 @@ POSTGRES_USER=silo
|
||||
POSTGRES_PASSWORD=silo
|
||||
POSTGRES_DB=silo
|
||||
POSTGRES_SHM_SIZE=8gb
|
||||
# POSTGRES_PORT=5432
|
||||
# REDIS_PORT=6379
|
||||
|
||||
# Optional Meilisearch service. Generate a key, uncomment it, then start the
|
||||
# search profile with: docker compose --profile search up -d
|
||||
# MEILI_MASTER_KEY=replace-with-output-of-openssl-rand-hex-32
|
||||
# MEILISEARCH_IMAGE=getmeili/meilisearch:latest
|
||||
# MEILISEARCH_HOST=127.0.0.1
|
||||
# MEILISEARCH_PORT=7700
|
||||
|
||||
# PostgreSQL auto-tuning is enabled by default in docker-compose.yml. Silo
|
||||
# applies pgtune-style OLTP recommendations through ALTER SYSTEM at startup.
|
||||
@@ -51,8 +40,7 @@ POSTGRES_SHM_SIZE=8gb
|
||||
# POSTGRES_TUNE_DB_SIZE=auto
|
||||
# POSTGRES_TUNE_CONNECTIONS=100
|
||||
|
||||
# Optional host port overrides for docker-compose.yml. The container listeners
|
||||
# remain fixed, so these values only change the host side of each port mapping.
|
||||
# Optional host port overrides for docker-compose.yml.
|
||||
# PORT=8090
|
||||
# Used only after Jellyfin-compatible app support is enabled by an admin.
|
||||
# JF_PORT=8096
|
||||
@@ -89,7 +77,7 @@ POSTGRES_SHM_SIZE=8gb
|
||||
# Optional Redis override when running from source or pointing workers at an external Redis.
|
||||
# REDIS_URL=redis://localhost:6379
|
||||
|
||||
# Optional standalone worker identity settings for custom worker deployments.
|
||||
# Optional standalone worker identity settings for docker-compose.remote-transcode.yml.
|
||||
# NODE_NAME=transcode-01
|
||||
# NODE_URL=http://transcode-01.example.com:8082
|
||||
|
||||
|
||||
@@ -99,14 +99,6 @@ jobs:
|
||||
- name: Verify settings bindings are current
|
||||
run: make verify-settings-bindings
|
||||
|
||||
# The server defines the playback protocol and the clients prove
|
||||
# conformance against these fixtures. A contract change that does not
|
||||
# regenerate leaves every client testing against a stale body, so the
|
||||
# drift surfaces as a playback bug on three platforms rather than as a
|
||||
# failure here.
|
||||
- name: Verify playback protocol fixtures are current
|
||||
run: make verify-playback-fixtures
|
||||
|
||||
# Runs the settings-contract gate among everything else: the embedded
|
||||
# manifest must parse, satisfy its own schema, hold every structural
|
||||
# invariant, and agree with the live settings registry on keys and
|
||||
|
||||
@@ -82,4 +82,3 @@ docker-compose.local.yml
|
||||
.playwright-cli/
|
||||
output/
|
||||
/settingsgen
|
||||
/playbackfixtures
|
||||
|
||||
+7
-16
@@ -6,10 +6,9 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution expectations, merge requ
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- **Go** 1.26.4+
|
||||
- **Node.js** 22+ with **pnpm** 10.32.1
|
||||
- **PostgreSQL** 18 with pgvector
|
||||
- **Redis**
|
||||
- **Go** 1.24+
|
||||
- **Bun** 1.0+
|
||||
- **PostgreSQL** 18+
|
||||
- **FFmpeg** (for transcoding support)
|
||||
|
||||
## Local Development
|
||||
@@ -17,13 +16,6 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution expectations, merge requ
|
||||
Local development remains intentionally separate from the deploy-oriented compose setup. Use [docker-compose.yml](docker-compose.yml) for local services and the source-build workflow below.
|
||||
|
||||
```sh
|
||||
# Create the local bootstrap configuration
|
||||
cp .env.example .env
|
||||
printf '\nSECRET_KEY=%s\nDATABASE_URL=%s\nREDIS_URL=%s\n' \
|
||||
"$(openssl rand -base64 48)" \
|
||||
'postgres://silo:silo@localhost:5432/silo?sslmode=disable' \
|
||||
'redis://localhost:6379' >> .env
|
||||
|
||||
# Start local PostgreSQL and Redis
|
||||
docker compose up -d postgres redis
|
||||
|
||||
@@ -34,8 +26,7 @@ make dev-frontend
|
||||
make dev-backend
|
||||
```
|
||||
|
||||
The template supplies a non-empty `MEDIA_ROOT` because Compose validates the whole file even when
|
||||
you start only PostgreSQL and Redis. Change it before testing libraries against real media.
|
||||
The main compose file expects `MEDIA_ROOT` to be set even if you only want the bundled PostgreSQL and Redis services, so set that in `.env` first (`cp .env.example .env`).
|
||||
|
||||
If you are developing `Silo` and `silo-plugin-sdk` together, keep using the local [`go.work`](go.work) workspace. That workspace is a developer convenience only. CI and release builds run with `GOWORK=off`, so any new SDK helper used here must be pushed and tagged in `silo-plugin-sdk` before this repo can merge or release the change.
|
||||
|
||||
@@ -88,7 +79,7 @@ database URL should be read from a non-default env file.
|
||||
go test ./...
|
||||
|
||||
# Frontend tests
|
||||
cd web && pnpm test
|
||||
cd web && bun test
|
||||
```
|
||||
|
||||
## Linting
|
||||
@@ -98,8 +89,8 @@ cd web && pnpm test
|
||||
golangci-lint run
|
||||
|
||||
# Frontend
|
||||
cd web && pnpm run lint
|
||||
cd web && pnpm run format:check
|
||||
cd web && bun run lint
|
||||
cd web && bun run format:check
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.PHONY: frontend build dev-frontend dev-backend dev-proxy dev-transcode lint test test-go test-web embed-stub clean jellyfin-web migrate-continuum-check verify-local-paths install-hooks migrate-create migrate-validate migrate-status migrate-up migrate-down-to settings-bindings verify-settings-bindings verify-settings-bindings-web verify-settings-bindings-all playback-fixtures verify-playback-fixtures
|
||||
.PHONY: frontend build dev-frontend dev-backend dev-proxy dev-transcode lint test test-go test-web embed-stub clean jellyfin-web migrate-continuum-check verify-local-paths install-hooks migrate-create migrate-validate migrate-status migrate-up migrate-down-to settings-bindings verify-settings-bindings verify-settings-bindings-web verify-settings-bindings-all
|
||||
|
||||
GIT_COMMON_DIR := $(strip $(shell git rev-parse --git-common-dir 2>/dev/null))
|
||||
MAIN_CHECKOUT_ROOT := $(if $(GIT_COMMON_DIR),$(abspath $(GIT_COMMON_DIR)/..))
|
||||
@@ -62,6 +62,7 @@ WEBTEST_KNOWN_FAILURES := \
|
||||
--exclude src/pages/Catalog.test.tsx \
|
||||
--exclude src/pages/ItemDetail/SeasonContent.test.tsx \
|
||||
--exclude src/pages/LibraryRecommended.test.tsx \
|
||||
--exclude src/pages/audiobooks/player/useAudiobookPlayback.test.ts \
|
||||
--exclude src/pages/setup-wizard/steps/ServerStorageStep.test.tsx \
|
||||
--exclude src/player/hooks/useASSSubtitles.test.tsx
|
||||
|
||||
@@ -144,36 +145,6 @@ verify-settings-bindings-web:
|
||||
|
||||
verify-settings-bindings-all: verify-settings-bindings verify-settings-bindings-web
|
||||
|
||||
# Regenerate the protocol-v3 golden contract fixtures from the live types and planner.
|
||||
#
|
||||
# The server owns the playback contract and the clients prove conformance
|
||||
# against these bodies, so they are only trustworthy while the code that emits
|
||||
# them is the code that serves traffic. Editing one by hand instead of running
|
||||
# this would let the contract and the implementation drift apart in silence.
|
||||
PLAYBACK_FIXTURE_DIR := internal/playback/testdata/protocol_v3
|
||||
PLAYBACK_SCHEMA_FIXTURE_DIR := docs/design/schemas/playback-v3/v3/fixtures/valid
|
||||
PLAYBACK_WIRE_FIXTURES := start_request.json replan_request.json decision_response.json capability_response.json error_response.json route_event.json
|
||||
|
||||
playback-fixtures:
|
||||
go run ./cmd/playbackfixtures -out $(PLAYBACK_FIXTURE_DIR)
|
||||
@set -e; for fixture in $(PLAYBACK_WIRE_FIXTURES); do \
|
||||
cp "$(PLAYBACK_FIXTURE_DIR)/$$fixture" "$(PLAYBACK_SCHEMA_FIXTURE_DIR)/$$fixture"; \
|
||||
done
|
||||
|
||||
# Fail when the committed fixtures disagree with the contract types. A change
|
||||
# that does not regenerate leaves every client testing against a body the server
|
||||
# no longer produces, which is exactly the drift the fixtures exist to catch.
|
||||
verify-playback-fixtures:
|
||||
@CHECK_DIR=$$(mktemp -d) && trap 'rm -rf "$$CHECK_DIR"' EXIT && \
|
||||
go run ./cmd/playbackfixtures -out "$$CHECK_DIR" && \
|
||||
diff -ur $(PLAYBACK_FIXTURE_DIR) "$$CHECK_DIR" \
|
||||
|| { echo "::error::$(PLAYBACK_FIXTURE_DIR) is stale; run make playback-fixtures"; exit 1; }; \
|
||||
for fixture in $(PLAYBACK_WIRE_FIXTURES); do \
|
||||
cmp -s "$$CHECK_DIR/$$fixture" "$(PLAYBACK_SCHEMA_FIXTURE_DIR)/$$fixture" \
|
||||
|| { echo "::error::$(PLAYBACK_SCHEMA_FIXTURE_DIR)/$$fixture is stale; run make playback-fixtures"; exit 1; }; \
|
||||
done
|
||||
@echo "playback fixtures are current"
|
||||
|
||||
# Check committed content for local machine path leaks.
|
||||
verify-local-paths:
|
||||
scripts/check-local-path-leaks.sh
|
||||
|
||||
@@ -15,22 +15,14 @@ Join the community on [Discord](https://discord.gg/4RxuUQAEnW). If Silo is usefu
|
||||
|
||||
## Deploy with Docker (recommended)
|
||||
|
||||
The easiest way to run Silo is with Docker Compose 2.24 or newer. The default stack assumes you do
|
||||
not already have PostgreSQL and Redis available, so it bundles PostgreSQL, Redis, FFmpeg, and the
|
||||
application for a one-command start.
|
||||
The easiest way to run Silo is with Docker Compose. The default stack assumes you do not already have PostgreSQL and Redis available, so it bundles PostgreSQL, Redis, FFmpeg, and the application for a one-command start.
|
||||
|
||||
1. **Create a `.env` file**
|
||||
|
||||
```sh
|
||||
cp .env.example .env
|
||||
printf '\nPOSTGRES_PASSWORD=%s\nSECRET_KEY=%s\n' \
|
||||
"$(openssl rand -hex 24)" "$(openssl rand -base64 48)" >> .env
|
||||
```
|
||||
|
||||
This replaces the development database password from `.env.example` and creates the key Silo
|
||||
uses to encrypt stored credentials. Back up `.env` separately from PostgreSQL; losing
|
||||
`SECRET_KEY` makes those credentials unrecoverable.
|
||||
|
||||
2. **Set your media path**
|
||||
|
||||
Edit `.env` and set:
|
||||
@@ -51,21 +43,6 @@ application for a one-command start.
|
||||
|
||||
If you already have PostgreSQL and Redis available, omit those bundled service examples from compose and point Silo at your existing `DATABASE_URL` and `REDIS_URL` instead.
|
||||
|
||||
### Optional Intel/AMD VA-API or Intel Quick Sync
|
||||
|
||||
The default stack is CPU-only so it starts on hosts without `/dev/dri`. On a Linux host with
|
||||
`/dev/dri`, enable the device overlay:
|
||||
|
||||
```sh
|
||||
docker compose -f docker-compose.yml -f docker-compose.vaapi.yml up -d
|
||||
```
|
||||
|
||||
To make that the default for this installation, set:
|
||||
|
||||
```dotenv
|
||||
COMPOSE_FILE=docker-compose.yml:docker-compose.vaapi.yml
|
||||
```
|
||||
|
||||
### Optional NVIDIA/NVENC
|
||||
|
||||
GPU support is kept out of the default compose file so hosts without NVIDIA drivers work unchanged.
|
||||
@@ -101,55 +78,32 @@ By default, data is stored under `/opt/silo`:
|
||||
|
||||
- `/opt/silo/postgres`
|
||||
- `/opt/silo/redis`
|
||||
- `/opt/silo/plugins`
|
||||
- `/opt/silo/compat`
|
||||
- `/opt/silo/transcode`
|
||||
- `/opt/silo/catalog-seeds`
|
||||
|
||||
The optional `search` profile also stores its index under `/opt/silo/meilisearch`.
|
||||
|
||||
Media is mounted into the container at `/mnt/media` from the host path you set in `MEDIA_ROOT`.
|
||||
|
||||
### Optional Search Profile
|
||||
### Optional Profiles
|
||||
|
||||
PostgreSQL full-text search works without any optional services. Meilisearch is available when you
|
||||
want its search provider:
|
||||
The main compose file is integrated-first. These profiles exist for operators testing distributed mode or mirroring a split deployment shape. Most single-host installs should stay on the default integrated service, because it already includes proxying and transcoding.
|
||||
|
||||
| Profile | Command | Description |
|
||||
|---|---|---|
|
||||
| default | `docker compose up -d` | Integrated server plus bundled PostgreSQL and Redis |
|
||||
| `search` | `docker compose --profile search up -d` | Add the optional Meilisearch service |
|
||||
| `proxy` | `docker compose --profile proxy up -d` | Start a standalone proxy service for distributed-mode testing |
|
||||
| `transcode` | `docker compose --profile transcode up -d` | Start a standalone transcode service for distributed-mode testing |
|
||||
|
||||
Before starting the `search` profile, set `MEILI_MASTER_KEY` in `.env` to the output of
|
||||
`openssl rand -hex 32`. After Silo starts, choose Meilisearch under **Admin > Settings > Search**,
|
||||
set the URL to `http://meilisearch:7700`, enter the same key as the API key, test the connection,
|
||||
and save. Restart Silo, then rebuild the catalog search index from the same page. Silo continues
|
||||
to use PostgreSQL full-text search until you select Meilisearch.
|
||||
You can enable both optional examples together:
|
||||
|
||||
### Distributed Examples
|
||||
```sh
|
||||
docker compose --profile proxy --profile transcode up -d
|
||||
```
|
||||
|
||||
The main Compose file includes commented proxy and transcode service examples. Most single-host
|
||||
installs should leave them commented because the integrated service already includes proxying and
|
||||
transcoding.
|
||||
If you are splitting workers across multiple hosts, use the separate remote worker example instead of trying to stretch the main compose file across machines.
|
||||
|
||||
Multi-host operators can use those examples as a starting point for a dedicated worker Compose
|
||||
file connected to the deployment's shared PostgreSQL and Redis services.
|
||||
### Advanced Remote Node Example
|
||||
|
||||
Proxy nodes serve source downloads from the same absolute media paths used by direct playback.
|
||||
Prepared-download work can also run on transcode nodes. Each selected transcode node retains its
|
||||
result on node-local storage and exposes it only through Silo's authenticated internal artifact API;
|
||||
the paired proxy relays those bytes, so no shared artifact mount is required. Dedicated transcode
|
||||
nodes default to retaining prepared downloads in a protected directory inside the transcode volume
|
||||
captured at process startup. `download.artifact_dir` overrides that location for both dedicated
|
||||
transcode nodes and the integrated/API-local fallback, so mount the configured path on every process
|
||||
that prepares downloads. Changing either artifact-path setting requires a restart. Downloads with a
|
||||
configured server-wide or per-user bandwidth limit remain API-local so those aggregate limits stay exact.
|
||||
Clients discover distributed delivery through `proxy_delivery` on the download capability response.
|
||||
When it is true, they may opt into `GET` or `HEAD /api/v1/downloads/{id}/file-proxy` and
|
||||
`/api/v1/direct-download-proxy`; those routes may return a temporary redirect to a proxy node. The
|
||||
established `/file` and `/direct-download` routes keep serving bytes directly with their existing
|
||||
status-code contract; for a node-local prepared artifact, the API itself performs the authenticated
|
||||
relay on that fallback route.
|
||||
For a dedicated remote transcode worker, use [docker-compose.remote-transcode.yml](docker-compose.remote-transcode.yml). That file is intended for a separate worker host that connects back to an existing Silo deployment using shared PostgreSQL and Redis.
|
||||
|
||||
### Deployment Notes
|
||||
|
||||
@@ -162,10 +116,7 @@ helper and cutover guide in [docs/continuum-to-silo-docker-migration.md](docs/co
|
||||
|
||||
## Configuration
|
||||
|
||||
Silo requires `DATABASE_URL` and `SECRET_KEY` when running from source or against external
|
||||
infrastructure. In the default Docker Compose path, the stack wires the database and Redis URLs
|
||||
for you. All other settings — libraries, metadata providers, transcoding, users — are managed
|
||||
through the admin UI after first launch.
|
||||
Silo requires only a `DATABASE_URL` when running from source or against external infrastructure. In the default Docker Compose path, the stack wires the database and Redis URLs for you. All other settings — libraries, metadata providers, transcoding, users — are managed through the admin UI after first launch.
|
||||
|
||||
### Server Modes
|
||||
|
||||
@@ -174,7 +125,7 @@ through the admin UI after first launch.
|
||||
| `integrated` | Full server: API + frontend + scanner + transcode (default) |
|
||||
| `api` | API server only, no local transcoding |
|
||||
| `proxy` | Stream proxy node that connects to the shared deployment database and Redis |
|
||||
| `transcode` | HLS and prepared-download worker node that connects to the shared deployment database and Redis |
|
||||
| `transcode` | HLS transcode worker node that connects to the shared deployment database and Redis |
|
||||
|
||||
### PostgreSQL Auto-Tuning
|
||||
|
||||
@@ -232,26 +183,24 @@ move fully to a custom `postgresql.conf`.
|
||||
|
||||
If you prefer running Silo without Docker:
|
||||
|
||||
1. **Install prerequisites**: Go 1.26.4+, Node.js 22+, pnpm 10.32.1, PostgreSQL 18 with pgvector, Redis, and FFmpeg.
|
||||
1. **Install prerequisites**: Go 1.24+, Bun 1.0+, PostgreSQL 18+, and FFmpeg.
|
||||
|
||||
2. **Configure the source process**
|
||||
|
||||
```sh
|
||||
cp .env.example .env
|
||||
printf '\nSECRET_KEY=%s\nDATABASE_URL=%s\nREDIS_URL=%s\n' \
|
||||
"$(openssl rand -base64 48)" \
|
||||
'postgres://silo:silo@localhost:5432/silo?sslmode=disable' \
|
||||
'redis://localhost:6379' >> .env
|
||||
```
|
||||
|
||||
Change the URLs when you use existing services instead of the bundled development defaults.
|
||||
|
||||
3. **Start PostgreSQL and Redis** (skip if you already have them running)
|
||||
2. **Start PostgreSQL and Redis** (skip if you already have them running)
|
||||
|
||||
```sh
|
||||
docker compose up -d postgres redis
|
||||
```
|
||||
|
||||
The main compose file still expects `MEDIA_ROOT` to be set even if you only want the bundled PostgreSQL and Redis services, so set that in `.env` first.
|
||||
|
||||
3. **Configure the database connection**
|
||||
|
||||
```sh
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
Edit `.env` and set `DATABASE_URL` to point to your PostgreSQL instance.
|
||||
|
||||
4. **Build and run**
|
||||
|
||||
```sh
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 62 KiB |
@@ -1,863 +0,0 @@
|
||||
// Command playbackfixtures writes the protocol-v3 golden contract fixtures
|
||||
// from the live Go types and planner.
|
||||
//
|
||||
// The direction of authority is inverted from where it started: the server
|
||||
// defines the playback protocol, and clients prove conformance against these
|
||||
// files. Android and Apple CI vendor them and compare their own decoders and
|
||||
// opaque-token echo behavior against the values here, so a fixture is
|
||||
// only trustworthy if it was produced by the same code that serves real
|
||||
// traffic — hand-editing one would let the contract and the implementation
|
||||
// drift apart silently.
|
||||
//
|
||||
// Usage:
|
||||
//
|
||||
// go run ./cmd/playbackfixtures -out internal/playback/testdata/protocol_v3
|
||||
//
|
||||
// `make playback-fixtures` runs it; `make verify-playback-fixtures`
|
||||
// regenerates into a temporary directory and diffs, so a contract change
|
||||
// cannot merge without refreshing what every client tests against.
|
||||
package main
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"flag"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"time"
|
||||
|
||||
"github.com/Silo-Server/silo-server/internal/models"
|
||||
"github.com/Silo-Server/silo-server/internal/playback"
|
||||
)
|
||||
|
||||
// goldenSessionID is a fixed UUID: fixtures must be byte-stable across runs,
|
||||
// so nothing in this generator may read the clock or a random source.
|
||||
const (
|
||||
goldenSessionID = "11111111-1111-4111-8111-111111111111"
|
||||
goldenAttemptID = "attempt-golden-0001"
|
||||
goldenExpiresAt = "2030-01-01T00:00:00Z"
|
||||
goldenMediaFileID = 42
|
||||
// Codec and container tokens the fixtures are built from. Named so the
|
||||
// capability lists, the plan recipe, and the source descriptor cannot drift
|
||||
// into describing different media by a one-character typo.
|
||||
codecH264 = "h264"
|
||||
codecHEVC = "hevc"
|
||||
codecAAC = "aac"
|
||||
codecTrueHD = "truehd"
|
||||
containerMP4 = "mp4"
|
||||
containerMKV = "mkv"
|
||||
containerHLS = "hls"
|
||||
profileHigh = "high"
|
||||
resolutionHD = "720p"
|
||||
resolutionFHD = "1080p"
|
||||
qualityOriginal = "original"
|
||||
audioLayoutStereo = "stereo"
|
||||
audioLayout71 = "7.1"
|
||||
filmFrameRate = "24000/1001"
|
||||
languageEnglish = "eng"
|
||||
videoRangeSDR = "SDR"
|
||||
categoryMidSeek = "mid_seek_replan"
|
||||
)
|
||||
|
||||
func main() {
|
||||
out := flag.String("out", "", "directory to write fixtures into (required)")
|
||||
flag.Parse()
|
||||
if *out == "" {
|
||||
fail("usage: playbackfixtures -out <dir>")
|
||||
}
|
||||
if err := os.MkdirAll(*out, 0o755); err != nil {
|
||||
fail("create %s: %v", *out, err)
|
||||
}
|
||||
|
||||
write(*out, "start_request.json", goldenStartRequest())
|
||||
write(*out, "replan_request.json", goldenReplanRequest())
|
||||
write(*out, "decision_response.json", goldenDecisionResponse())
|
||||
write(*out, "capability_response.json", goldenCapabilityResponse())
|
||||
write(*out, "error_response.json", goldenErrorResponse())
|
||||
write(*out, "route_event.json", goldenRouteEvent())
|
||||
write(*out, "subtitle_inventory.json", goldenSubtitleInventory())
|
||||
write(*out, "attempt_keys.json", goldenAttemptKeys())
|
||||
write(*out, "conformance_matrix.json", goldenConformanceMatrix())
|
||||
}
|
||||
|
||||
func goldenErrorResponse() playback.ErrorResponseV3 {
|
||||
return playback.LegacyUpgradeErrorV3()
|
||||
}
|
||||
|
||||
func write(dir, name string, value any) {
|
||||
body, err := json.MarshalIndent(value, "", " ")
|
||||
if err != nil {
|
||||
fail("marshal %s: %v", name, err)
|
||||
}
|
||||
body = append(body, '\n')
|
||||
path := filepath.Join(dir, name)
|
||||
if err := os.WriteFile(path, body, 0o644); err != nil { //nolint:gosec // generated fixture
|
||||
fail("write %s: %v", path, err)
|
||||
}
|
||||
}
|
||||
|
||||
func fail(format string, args ...any) {
|
||||
fmt.Fprintf(os.Stderr, format+"\n", args...)
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
// goldenCapabilities is the exact-evidence Android-shaped capability block the
|
||||
// request fixtures share. Both request bodies carry the same capability
|
||||
// contract, so they are built from one function rather than two drifting
|
||||
// literals.
|
||||
func goldenCapabilities() playback.ClientCodecCapabilitiesV3 {
|
||||
return playback.ClientCodecCapabilitiesV3{
|
||||
VideoEvidence: playback.EvidenceExactV3,
|
||||
AudioEvidence: playback.EvidenceExactV3,
|
||||
CodecsVideo: []string{codecH264},
|
||||
CodecsVideoHardware: []string{codecH264},
|
||||
CodecsAudio: []string{codecAAC},
|
||||
Containers: []string{containerMP4},
|
||||
MaxResolution: resolutionFHD,
|
||||
VideoDecode: []playback.VideoDecodeCapabilityV3{{
|
||||
Codec: codecH264,
|
||||
Profiles: []string{profileHigh},
|
||||
Levels: []int{41},
|
||||
BitDepths: []int{8},
|
||||
MaxWidth: 1920,
|
||||
MaxHeight: 1080,
|
||||
MaxFrameRate: 60,
|
||||
MaxBitrateKbps: 20_000,
|
||||
Hardware: true,
|
||||
}},
|
||||
}
|
||||
}
|
||||
|
||||
func goldenPlaybackContext() playback.ClientPlaybackContextV3 {
|
||||
return playback.ClientPlaybackContextV3{
|
||||
ProtocolVersion: playback.ProtocolV3,
|
||||
FormFactor: "tv",
|
||||
AppVersion: "3.0-test",
|
||||
Device: playback.DeviceContextV3{
|
||||
Platform: "android",
|
||||
OSVersion: "15",
|
||||
Manufacturer: "NVIDIA",
|
||||
Model: "SHIELD Android TV",
|
||||
// Everything platform-specific travels here as opaque bounded
|
||||
// strings; the contract itself stays neutral.
|
||||
PlatformDetails: map[string]string{"sdk_int": "35", "abis": "arm64-v8a"},
|
||||
},
|
||||
Output: playback.OutputContextV3{OutputContextID: "7"},
|
||||
Deliveries: map[string]playback.DeliveryCapabilityV3{
|
||||
playback.DeliveryClassOriginalHTTPV3: {
|
||||
Enabled: true,
|
||||
SupportedOnDevice: true,
|
||||
Containers: []string{containerMP4},
|
||||
VideoCodecs: []string{codecH264},
|
||||
AudioDecodeCodecs: []string{codecAAC},
|
||||
AudioPassthroughCodecs: []string{},
|
||||
Subtitles: playback.DeliverySubtitleCapabilitiesV3{
|
||||
EmbeddedText: true,
|
||||
SidecarText: true,
|
||||
},
|
||||
Features: []string{},
|
||||
AuthHeaderRefresh: true,
|
||||
ValidatedClaims: []string{},
|
||||
Transformations: []playback.TransformationV3{},
|
||||
},
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func goldenStartRequest() playback.StartRequestV3 {
|
||||
start := 12.5
|
||||
audioIndex := 0
|
||||
return playback.StartRequestV3{
|
||||
ProtocolVersion: playback.ProtocolV3,
|
||||
ClientFeatures: []string{playback.FeaturePlaybackPlanV3},
|
||||
FileID: goldenMediaFileID,
|
||||
ProfileID: "profile-1",
|
||||
PlaybackAttemptID: goldenAttemptID,
|
||||
QualityPreference: playback.QualityOriginalV3,
|
||||
SubtitleFidelityPreference: playback.SubtitleFidelityCompatibleV3,
|
||||
StartPosition: &start,
|
||||
ProgressPersistence: playback.ProgressPersistenceClientV3,
|
||||
AudioTrackID: playback.TrackIDV3(goldenMediaFileID, "audio", 0),
|
||||
AudioTrackIndex: &audioIndex,
|
||||
Capabilities: goldenCapabilities(),
|
||||
ClientPlaybackContext: goldenPlaybackContext(),
|
||||
}
|
||||
}
|
||||
|
||||
func goldenReplanRequest() playback.ReplanRequestV3 {
|
||||
estimate := 3_500
|
||||
cap := 4_000
|
||||
audioIndex := 0
|
||||
decision := goldenDecisionResponse()
|
||||
if decision.PlaybackPlan == nil {
|
||||
fail("golden decision has no plan")
|
||||
}
|
||||
plan := decision.PlaybackPlan
|
||||
return playback.ReplanRequestV3{
|
||||
ProtocolVersion: playback.ProtocolV3,
|
||||
ClientFeatures: []string{playback.FeaturePlaybackPlanV3},
|
||||
Operation: playback.ReplanOperationFailureRecoveryV3,
|
||||
PlaybackAttemptID: goldenAttemptID,
|
||||
ReplanRequestID: "replan-golden-0001",
|
||||
FailedPlanID: plan.PlanID,
|
||||
PlanAttemptID: "plan-attempt-golden-0001",
|
||||
// Attempt keys are server-owned opaque tokens. A client echoes the
|
||||
// values it was handed; it never computes one.
|
||||
PlanAttemptKey: plan.PlanAttemptKey,
|
||||
AttemptedPlanKeys: []string{plan.PlanAttemptKey},
|
||||
AttemptCount: 1,
|
||||
QualityPreference: "auto",
|
||||
PositionSeconds: 42.5,
|
||||
Metered: true,
|
||||
BandwidthEstimateKbps: &estimate,
|
||||
BandwidthCapKbps: &cap,
|
||||
SelectedTracks: playback.SelectedTracksV3{
|
||||
Audio: &playback.TrackIdentityV3{ID: playback.TrackIDV3(goldenMediaFileID, "audio", 0), Index: &audioIndex},
|
||||
},
|
||||
Failure: playback.FailureV3{Classification: "network_degraded"},
|
||||
Capabilities: goldenCapabilities(),
|
||||
ClientPlaybackContext: goldenPlaybackContext(),
|
||||
}
|
||||
}
|
||||
|
||||
// goldenMediaFile is the subtitle-bearing source the inventory fixtures
|
||||
// describe. The embedded track list deliberately mixes a text track, a PGS
|
||||
// track, and a DVD bitmap track: the DVD track has no sidecar shape the stream
|
||||
// handler can serve, and pinning its ordinal is the point of the fixture.
|
||||
func goldenMediaFile() *models.MediaFile {
|
||||
return &models.MediaFile{
|
||||
ID: goldenMediaFileID,
|
||||
ExternalSubtitles: []models.ExternalSubtitle{
|
||||
{Path: "/library/movie.en.srt", Language: languageEnglish, Format: "srt", Title: "English"},
|
||||
},
|
||||
SubtitleTracks: []models.SubtitleTrack{
|
||||
{Index: 0, Language: languageEnglish, Codec: "ass", Title: "English (Signs)", Forced: true},
|
||||
{Index: 1, Language: "jpn", Codec: "pgs", Title: "Japanese"},
|
||||
{Index: 2, Language: "fre", Codec: "dvd_subtitle", Title: "French"},
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func goldenSubtitleAdditional() []playback.SubtitleInventoryEntryV3 {
|
||||
return []playback.SubtitleInventoryEntryV3{
|
||||
{Codec: "srt", Language: "spa", Label: "Spanish (downloaded)", Source: playback.SubtitleSourceDownloadedV3},
|
||||
}
|
||||
}
|
||||
|
||||
// subtitleInventoryFixture is a self-describing conformance vector: the inputs
|
||||
// a client would receive for the same file, and the ordinals the server
|
||||
// assigns to them. A client reproduces `inventory` from `source` and compares.
|
||||
type subtitleInventoryFixture struct {
|
||||
Description string `json:"description"`
|
||||
SessionID string `json:"session_id"`
|
||||
MediaFileID int `json:"media_file_id"`
|
||||
Source subtitleInventorySource `json:"source"`
|
||||
Inventory []playback.SubtitleInventoryItemV3 `json:"inventory"`
|
||||
}
|
||||
|
||||
type subtitleInventorySource struct {
|
||||
ExternalSubtitles []models.ExternalSubtitle `json:"external_subtitles"`
|
||||
SubtitleTracks []models.SubtitleTrack `json:"subtitle_tracks"`
|
||||
Downloaded []playback.SubtitleInventoryEntryV3 `json:"downloaded"`
|
||||
}
|
||||
|
||||
func goldenSubtitleInventory() subtitleInventoryFixture {
|
||||
file := goldenMediaFile()
|
||||
additional := goldenSubtitleAdditional()
|
||||
return subtitleInventoryFixture{
|
||||
Description: "Combined subtitle ordinals are dense and gap-free across externals, embedded tracks, " +
|
||||
"then downloaded tracks. A track with no sidecar representation keeps its ordinal and is " +
|
||||
"published as burn_in_only without a URL rather than omitted.",
|
||||
SessionID: goldenSessionID,
|
||||
MediaFileID: goldenMediaFileID,
|
||||
Source: subtitleInventorySource{
|
||||
ExternalSubtitles: file.ExternalSubtitles,
|
||||
SubtitleTracks: file.SubtitleTracks,
|
||||
Downloaded: additional,
|
||||
},
|
||||
Inventory: playback.SubtitleInventoryV3(goldenSessionID, file, additional),
|
||||
}
|
||||
}
|
||||
|
||||
func goldenDecisionResponse() playback.DecisionResponseV3 {
|
||||
file := conformanceFallbackFile()
|
||||
subtitleSource := goldenMediaFile()
|
||||
file.ExternalSubtitles = subtitleSource.ExternalSubtitles
|
||||
file.SubtitleTracks = subtitleSource.SubtitleTracks
|
||||
now, err := time.Parse(time.RFC3339, "2029-12-31T23:55:00Z")
|
||||
if err != nil {
|
||||
fail("parse golden planner time: %v", err)
|
||||
}
|
||||
result := playback.PlanPlaybackV3(playback.PlannerInputV3{
|
||||
Request: goldenStartRequest(),
|
||||
RequestedFile: file,
|
||||
EffectiveFile: file,
|
||||
AudioTrackIndex: 0,
|
||||
Settings: playback.PlannerSettingsV3{TranscodeEnabled: true, Allow4KTranscode: true},
|
||||
Registry: conformanceRegistry(),
|
||||
Now: now,
|
||||
AdditionalSubtitles: goldenSubtitleAdditional(),
|
||||
})
|
||||
if result.Plan == nil {
|
||||
fail("golden planner returned terminal: %#v", result.Terminal)
|
||||
}
|
||||
plan := *result.Plan
|
||||
// These values belong to session/transport setup, which runs after the
|
||||
// planner in the request handler. Keep the planner authoritative for every
|
||||
// decision field and bind only the deterministic fixture runtime values.
|
||||
plan.SessionID = goldenSessionID
|
||||
plan.ExpiresAt = goldenExpiresAt
|
||||
plan.Stream.URL = "/stream/" + goldenSessionID
|
||||
plan.Subtitle.Inventory = playback.ScopeSubtitleInventoryV3(goldenSessionID, file, plan.Subtitle.Inventory)
|
||||
|
||||
return playback.DecisionResponseV3{
|
||||
ProtocolVersion: playback.ProtocolV3,
|
||||
ServerFeatures: playback.ServerFeaturesV3(),
|
||||
Outcome: playback.OutcomePlayableV3,
|
||||
SessionID: goldenSessionID,
|
||||
PlaybackPlan: &plan,
|
||||
}
|
||||
}
|
||||
|
||||
func goldenCapabilityResponse() playback.CapabilityResponseV3 {
|
||||
return playback.CapabilityResponseV3{
|
||||
Enabled: true,
|
||||
ProtocolVersions: []int{playback.ProtocolV3},
|
||||
Features: playback.ServerFeaturesV3(),
|
||||
Deliveries: []playback.DeliveryV3{
|
||||
playback.DeliveryOriginalHTTPV3,
|
||||
playback.DeliveryRemuxProgressiveV3,
|
||||
playback.DeliveryRemuxHLSV3,
|
||||
playback.DeliveryTranscodeHLSV3,
|
||||
},
|
||||
// A real server advertises only what its installed FFmpeg probed; the
|
||||
// fixture pins the full set so a client sees every shape it must parse.
|
||||
Transformations: []playback.TransformationV3{
|
||||
{Name: playback.TransformationAudioToAACV3, Executor: playback.ExecutorServerV3, RecipeVersion: "1", ValidatedClaims: []string{playback.ClaimAudioDecodeV3}},
|
||||
{Name: playback.TransformationServerDV7HDR10V3, Executor: playback.ExecutorServerV3, RecipeVersion: "1", ValidatedClaims: playback.DV7ToHDR10ClaimsV3()},
|
||||
{Name: playback.TransformationVideoToH264V3, Executor: playback.ExecutorServerV3, RecipeVersion: playback.TransformationVideoToH264RecipeVersionV3, ValidatedClaims: []string{playback.ClaimH264DecodeV3}},
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func goldenRouteEvent() playback.RouteEventV3 {
|
||||
decision := goldenDecisionResponse()
|
||||
if decision.PlaybackPlan == nil {
|
||||
fail("golden decision has no plan")
|
||||
}
|
||||
plan := decision.PlaybackPlan
|
||||
return playback.RouteEventV3{
|
||||
ProtocolVersion: playback.ProtocolV3,
|
||||
PlaybackAttemptID: goldenAttemptID,
|
||||
SessionID: goldenSessionID,
|
||||
PlanID: plan.PlanID,
|
||||
PlanAttemptID: "plan-attempt-golden-0001",
|
||||
PlanAttemptKey: plan.PlanAttemptKey,
|
||||
Event: playback.RouteEventFirstFrameV3,
|
||||
OutputContextID: "7",
|
||||
Diagnostics: map[string]string{
|
||||
"decoder_name": "c2.android.avc.decoder",
|
||||
"first_frame_ms": "412",
|
||||
"video_mime": "video/avc",
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
// attemptKeyInput exists only inside the Go fixture generator. The inputs to
|
||||
// the server's identity function are deliberately absent from the generated
|
||||
// JSON: clients receive a token and prove only that they echo it unchanged.
|
||||
type attemptKeyInput struct {
|
||||
Name string `json:"name"`
|
||||
PlanID string `json:"plan_id"`
|
||||
Delivery playback.DeliveryV3 `json:"delivery"`
|
||||
StreamProtocol playback.StreamProtocolV3 `json:"stream_protocol"`
|
||||
Container string `json:"container"`
|
||||
VideoCodec string `json:"video_codec"`
|
||||
AudioCodec string `json:"audio_codec"`
|
||||
Width int `json:"width"`
|
||||
Height int `json:"height"`
|
||||
BitrateKbps int `json:"bitrate_kbps"`
|
||||
DynamicRange string `json:"dynamic_range"`
|
||||
SubtitleMode playback.SubtitleModeV3 `json:"subtitle_mode"`
|
||||
Transformations []playback.TransformationV3 `json:"transformations"`
|
||||
AppliedQuirks []playback.AppliedQuirkV3 `json:"applied_quirks,omitempty"`
|
||||
RuntimeCorrections []string `json:"runtime_corrections,omitempty"`
|
||||
OutputContextID string `json:"output_context_id"`
|
||||
LocalMutations []string `json:"local_mutations"`
|
||||
}
|
||||
|
||||
func (f attemptKeyInput) plan() playback.PlanV3 {
|
||||
width, height, bitrate := f.Width, f.Height, f.BitrateKbps
|
||||
return playback.PlanV3{
|
||||
PlanID: f.PlanID,
|
||||
Delivery: f.Delivery,
|
||||
Stream: playback.StreamV3{Protocol: f.StreamProtocol, Container: f.Container},
|
||||
EffectiveRecipe: playback.EffectiveRecipeV3{
|
||||
VideoCodec: f.VideoCodec,
|
||||
AudioCodec: f.AudioCodec,
|
||||
Width: &width,
|
||||
Height: &height,
|
||||
BitrateKbps: &bitrate,
|
||||
DynamicRange: f.DynamicRange,
|
||||
},
|
||||
Subtitle: playback.SubtitleDecisionV3{Mode: f.SubtitleMode},
|
||||
Transformations: f.Transformations,
|
||||
AppliedQuirks: f.AppliedQuirks,
|
||||
RuntimeCorrections: f.RuntimeCorrections,
|
||||
}
|
||||
}
|
||||
|
||||
type opaqueAttemptKeyFixture struct {
|
||||
Name string `json:"name"`
|
||||
ServerPlanAttemptKey string `json:"server_plan_attempt_key"`
|
||||
ReplanEcho string `json:"replan_echo"`
|
||||
AttemptedPlanKeys []string `json:"attempted_plan_keys"`
|
||||
ExpectedServerAction string `json:"expected_server_action"`
|
||||
}
|
||||
|
||||
func goldenAttemptKeys() []opaqueAttemptKeyFixture {
|
||||
inputs := []attemptKeyInput{
|
||||
{
|
||||
Name: "hls_burn_in_sorted_transformations_and_pcm_mutations",
|
||||
PlanID: "plan:fixture",
|
||||
Delivery: playback.DeliveryRemuxHLSV3,
|
||||
StreamProtocol: playback.StreamHLSV3,
|
||||
Container: containerHLS,
|
||||
VideoCodec: codecHEVC,
|
||||
AudioCodec: codecAAC,
|
||||
Width: 3840,
|
||||
Height: 2160,
|
||||
BitrateKbps: 20_000,
|
||||
DynamicRange: playback.DynamicRangeHDR10V3,
|
||||
SubtitleMode: playback.SubtitleBurnInV3,
|
||||
// Deliberately out of order, and deliberately naming a
|
||||
// transformation the registry no longer defines: the key preimage
|
||||
// sorts its inputs and never consults the registry, and pinning a
|
||||
// retired name proves both properties stay true.
|
||||
Transformations: []playback.TransformationV3{
|
||||
{Name: "hdr_to_sdr_tonemap", Executor: playback.ExecutorServerV3, RecipeVersion: "1", ValidatedClaims: []string{}},
|
||||
{Name: playback.TransformationAudioToAACV3, Executor: playback.ExecutorServerV3, RecipeVersion: "1", ValidatedClaims: []string{}},
|
||||
},
|
||||
OutputContextID: "7",
|
||||
LocalMutations: []string{"transport_reopen", "pcm:truehd:8"},
|
||||
},
|
||||
{
|
||||
Name: "direct_client_dv81_executor_and_version",
|
||||
PlanID: "plan:dv81-fixture",
|
||||
Delivery: playback.DeliveryOriginalHTTPV3,
|
||||
StreamProtocol: playback.StreamHTTPProgressiveV3,
|
||||
Container: containerMKV,
|
||||
VideoCodec: codecHEVC,
|
||||
AudioCodec: codecTrueHD,
|
||||
Width: 3840,
|
||||
Height: 2160,
|
||||
BitrateKbps: 65_000,
|
||||
DynamicRange: playback.DynamicRangeDolbyVisionV3,
|
||||
SubtitleMode: playback.SubtitleOffV3,
|
||||
Transformations: []playback.TransformationV3{
|
||||
{Name: playback.ClientDV7ToDV81V3, Executor: playback.ExecutorClientV3, RecipeVersion: playback.ClientDVTransformVersionV3, ValidatedClaims: []string{}},
|
||||
},
|
||||
OutputContextID: "9",
|
||||
LocalMutations: []string{},
|
||||
},
|
||||
{
|
||||
Name: "direct_device_quirk_and_runtime_correction_identity",
|
||||
PlanID: "plan:quirk",
|
||||
Delivery: playback.DeliveryOriginalHTTPV3,
|
||||
StreamProtocol: playback.StreamHTTPProgressiveV3,
|
||||
Container: containerMKV,
|
||||
VideoCodec: codecHEVC,
|
||||
AudioCodec: "eac3",
|
||||
Width: 3840,
|
||||
Height: 2160,
|
||||
BitrateKbps: 60_000,
|
||||
DynamicRange: playback.DynamicRangeDolbyVisionV3,
|
||||
SubtitleMode: playback.SubtitleOffV3,
|
||||
Transformations: []playback.TransformationV3{},
|
||||
// The private server implementation includes quirk and runtime
|
||||
// correction identity; clients see only its opaque result.
|
||||
AppliedQuirks: []playback.AppliedQuirkV3{{
|
||||
ID: playback.QuirkFireTVDV8HDR10PlusV3,
|
||||
RegistryRevision: playback.DeviceQuirkRegistryRevisionV3,
|
||||
Action: "client_runtime_correction",
|
||||
}},
|
||||
RuntimeCorrections: []string{playback.ClientDV8HDR10PlusSanitizerV3},
|
||||
OutputContextID: "9",
|
||||
LocalMutations: []string{},
|
||||
},
|
||||
}
|
||||
fixtures := make([]opaqueAttemptKeyFixture, 0, len(inputs))
|
||||
for _, input := range inputs {
|
||||
key := playback.PlanAttemptKeyV3(input.plan(), input.OutputContextID, input.LocalMutations)
|
||||
fixtures = append(fixtures, opaqueAttemptKeyFixture{
|
||||
Name: input.Name,
|
||||
ServerPlanAttemptKey: key,
|
||||
ReplanEcho: key,
|
||||
AttemptedPlanKeys: []string{key},
|
||||
ExpectedServerAction: "reject_already_attempted_plan",
|
||||
})
|
||||
}
|
||||
return fixtures
|
||||
}
|
||||
|
||||
func goldenConformanceMatrix() playback.ConformanceMatrixV3 {
|
||||
videoFile := conformanceVideoFile()
|
||||
base := conformanceStartRequest()
|
||||
registry := conformanceRegistry()
|
||||
settings := playback.PlannerSettingsV3{TranscodeEnabled: true, Allow4KTranscode: true}
|
||||
|
||||
planner := make([]playback.PlannerScenarioV3, 0, 18)
|
||||
for _, tier := range []playback.CapabilityEvidenceV3{
|
||||
playback.EvidenceExactV3,
|
||||
playback.EvidencePlatformAttestedV3,
|
||||
playback.EvidenceDeclaredV3,
|
||||
} {
|
||||
request := base
|
||||
request.PlaybackAttemptID = "attempt-evidence-" + string(tier)
|
||||
request.Capabilities.VideoEvidence = tier
|
||||
if tier == playback.EvidenceDeclaredV3 {
|
||||
request.Capabilities.VideoDecode = nil
|
||||
}
|
||||
planner = append(planner, makePlannerScenario(
|
||||
"evidence_"+string(tier), "evidence_tier_gating", request, videoFile, nil, settings, registry,
|
||||
))
|
||||
}
|
||||
|
||||
fallbackRequest := conformanceStartRequest()
|
||||
fallbackRequest.Capabilities.VideoEvidence = playback.EvidenceDeclaredV3
|
||||
fallbackRequest.Capabilities.VideoDecode = nil
|
||||
fallbackRequest.Capabilities.CodecsVideo = []string{codecH264}
|
||||
fallbackRequest.Capabilities.CodecsVideoHardware = []string{codecH264}
|
||||
fallbackRequest.Capabilities.Containers = []string{containerMP4}
|
||||
fallbackFile := conformanceFallbackFile()
|
||||
var attempted []string
|
||||
for _, name := range []string{qualityOriginal, "progressive", containerHLS} {
|
||||
request := fallbackRequest
|
||||
request.PlaybackAttemptID = "attempt-delivery-chain"
|
||||
scenario := makePlannerScenario("delivery_"+name, "deliveries_negotiation", request, fallbackFile, attempted, settings, registry)
|
||||
planner = append(planner, scenario)
|
||||
attempted = append(attempted, scenario.Expected.PlanAttemptKey)
|
||||
}
|
||||
transcodeRequest := fallbackRequest
|
||||
transcodeRequest.PlaybackAttemptID = "attempt-delivery-transcode"
|
||||
transcodeRequest.QualityPreference = resolutionHD
|
||||
planner = append(planner, makePlannerScenario("delivery_transcode", "deliveries_negotiation", transcodeRequest, fallbackFile, nil, settings, registry))
|
||||
|
||||
audioFile := &models.MediaFile{ID: 77, BaseType: "audiobook", FilePath: "/media/audiobook.m4b", Container: containerMP4, CodecAudio: codecAAC, Bitrate: 128, AudioChannels: 2, Duration: 39_600, AudioTracks: []models.AudioTrack{{Codec: codecAAC, Channels: 2, Layout: audioLayoutStereo}}}
|
||||
audioRequest := conformanceStartRequest()
|
||||
audioRequest.FileID = audioFile.ID
|
||||
audioRequest.PlaybackAttemptID = "attempt-audio-only"
|
||||
audioRequest.Capabilities.Containers = []string{containerMP4}
|
||||
planner = append(planner, makePlannerScenario("audio_only_original", "audio_only_planning", audioRequest, audioFile, nil, settings, registry))
|
||||
|
||||
hdr10Request := conformanceHDRRequest()
|
||||
hdr10Request.PlaybackAttemptID = "attempt-hdr10-direct"
|
||||
planner = append(planner, makePlannerScenario("hdr10_exact_direct", "hdr_dv_matrix", hdr10Request, conformanceHDRFile(), nil, settings, registry))
|
||||
|
||||
dv8File := conformanceHDRFile()
|
||||
dv8File.VideoTracks[0].DVProfile = 8
|
||||
dv8File.VideoTracks[0].DVBLCompatID = 1
|
||||
dv8File.VideoTracks[0].VideoRange = "DolbyVision"
|
||||
dv8File.VideoTracks[0].VideoRangeType = "DOVIWithHDR10"
|
||||
dv8Request := conformanceHDRRequest()
|
||||
dv8Request.PlaybackAttemptID = "attempt-dv8-direct"
|
||||
dv8Request.Capabilities.HDRDetails.DolbyVisionProfiles = []int{8}
|
||||
dv8Request.ClientPlaybackContext.Output.HDRDetails.DolbyVisionProfiles = []int{8}
|
||||
planner = append(planner, makePlannerScenario("dolby_vision_8_exact_direct", "hdr_dv_matrix", dv8Request, dv8File, nil, settings, registry))
|
||||
|
||||
dv7File := conformanceHDRFile()
|
||||
dv7File.VideoTracks[0].DVProfile = 7
|
||||
dv7File.VideoTracks[0].DVBLCompatID = 6
|
||||
dv7File.VideoTracks[0].VideoRange = "DolbyVision"
|
||||
dv7File.VideoTracks[0].VideoRangeType = "DOVIWithEL"
|
||||
dv7Request := conformanceHDRRequest()
|
||||
dv7Request.PlaybackAttemptID = "attempt-dv7-hdr10"
|
||||
dv7Registry := playback.NewTransformationRegistryV3([]playback.TransformationSpecV3{{Name: playback.TransformationServerDV7HDR10V3, RecipeVersion: "1", Available: true}})
|
||||
planner = append(planner, makePlannerScenario("dolby_vision_7_hdr10_fallback", "hdr_dv_matrix", dv7Request, dv7File, nil, settings, dv7Registry))
|
||||
|
||||
audioAdaptFile := conformanceHDRFile()
|
||||
audioAdaptFile.CodecAudio = codecTrueHD
|
||||
audioAdaptFile.AudioChannels = 8
|
||||
audioAdaptFile.AudioTracks[0] = models.AudioTrack{Codec: codecTrueHD, Channels: 8, Layout: audioLayout71}
|
||||
audioAdaptRequest := conformanceHDRRequest()
|
||||
audioAdaptRequest.PlaybackAttemptID = "attempt-truehd-aac"
|
||||
planner = append(planner, makePlannerScenario("truehd_audio_conversion", "audio_matrix", audioAdaptRequest, audioAdaptFile, nil, settings, registry))
|
||||
|
||||
audioPassthroughFile := conformanceHDRFile()
|
||||
audioPassthroughFile.CodecAudio = codecTrueHD
|
||||
audioPassthroughFile.AudioChannels = 8
|
||||
audioPassthroughFile.AudioTracks[0] = models.AudioTrack{Codec: codecTrueHD, Channels: 8, Layout: audioLayout71}
|
||||
audioPassthroughRequest := conformanceHDRRequest()
|
||||
audioPassthroughRequest.PlaybackAttemptID = "attempt-truehd-passthrough"
|
||||
audioPassthroughRequest.ClientFeatures = append(audioPassthroughRequest.ClientFeatures, playback.FeatureLayoutPassthrough)
|
||||
audioPassthroughRequest.Capabilities.CodecsAudio = []string{codecTrueHD}
|
||||
audioPassthroughRequest.Capabilities.AudioPassthrough = &playback.AudioPassthroughV3{
|
||||
PassthroughCodecs: []string{codecTrueHD}, MaxChannels: 8,
|
||||
Entries: []playback.AudioPassthroughEntryV3{{Codec: codecTrueHD, ChannelCounts: []int{8}, Layouts: []string{audioLayout71}}},
|
||||
}
|
||||
originalDelivery := audioPassthroughRequest.ClientPlaybackContext.Deliveries[playback.DeliveryClassOriginalHTTPV3]
|
||||
originalDelivery.AudioPassthroughCodecs = []string{codecTrueHD}
|
||||
audioPassthroughRequest.ClientPlaybackContext.Deliveries[playback.DeliveryClassOriginalHTTPV3] = originalDelivery
|
||||
planner = append(planner, makePlannerScenario("truehd_exact_layout_passthrough", "audio_matrix", audioPassthroughRequest, audioPassthroughFile, nil, settings, registry))
|
||||
|
||||
pgsFile := conformanceHDRFile()
|
||||
pgsFile.SubtitleTracks = []models.SubtitleTrack{{Index: 4, Language: "jpn", Codec: "hdmv_pgs_subtitle", Title: "Japanese"}}
|
||||
pgsRequest := conformanceHDRRequest()
|
||||
pgsRequest.PlaybackAttemptID = "attempt-pgs-sidecar"
|
||||
pgsIndex := 0
|
||||
pgsRequest.SubtitleTrackIndex = &pgsIndex
|
||||
pgsRequest.SubtitleTrackID = playback.TrackIDV3(pgsFile.ID, "subtitle", pgsIndex)
|
||||
for _, deliveryClass := range []string{playback.DeliveryClassOriginalHTTPV3, playback.DeliveryClassProgressiveV3, playback.DeliveryClassHLSV3} {
|
||||
delivery := pgsRequest.ClientPlaybackContext.Deliveries[deliveryClass]
|
||||
delivery.Subtitles.EmbeddedBitmap = true
|
||||
pgsRequest.ClientPlaybackContext.Deliveries[deliveryClass] = delivery
|
||||
}
|
||||
planner = append(planner, makePlannerScenario("embedded_pgs_sidecar", "subtitle_matrix", pgsRequest, pgsFile, nil, settings, registry))
|
||||
|
||||
assFile := conformanceHDRFile()
|
||||
assFile.SubtitleTracks = []models.SubtitleTrack{{Index: 4, Language: languageEnglish, Codec: "ass", Title: "English Signs"}}
|
||||
assRequest := conformanceHDRRequest()
|
||||
assRequest.PlaybackAttemptID = "attempt-ass-authored"
|
||||
assRequest.SubtitleFidelityPreference = playback.SubtitleFidelityPreserveV3
|
||||
assIndex := 0
|
||||
assRequest.SubtitleTrackIndex = &assIndex
|
||||
assRequest.SubtitleTrackID = playback.TrackIDV3(assFile.ID, "subtitle", assIndex)
|
||||
for _, deliveryClass := range []string{playback.DeliveryClassOriginalHTTPV3, playback.DeliveryClassProgressiveV3, playback.DeliveryClassHLSV3} {
|
||||
delivery := assRequest.ClientPlaybackContext.Deliveries[deliveryClass]
|
||||
delivery.Subtitles.EmbeddedText = true
|
||||
delivery.Subtitles.ASSStyling = true
|
||||
delivery.Subtitles.FontAttachments = true
|
||||
assRequest.ClientPlaybackContext.Deliveries[deliveryClass] = delivery
|
||||
}
|
||||
planner = append(planner, makePlannerScenario("embedded_ass_authored_render", "subtitle_matrix", assRequest, assFile, nil, settings, registry))
|
||||
|
||||
dvdFile := conformanceVideoFile()
|
||||
dvdFile.SubtitleTracks = []models.SubtitleTrack{{Index: 4, Language: languageEnglish, Codec: "dvd_subtitle", Title: "English"}}
|
||||
dvdRequest := conformanceStartRequest()
|
||||
dvdRequest.PlaybackAttemptID = "attempt-dvd-burn-in"
|
||||
dvdIndex := 0
|
||||
dvdRequest.SubtitleTrackIndex = &dvdIndex
|
||||
dvdRequest.SubtitleTrackID = playback.TrackIDV3(dvdFile.ID, "subtitle", dvdIndex)
|
||||
planner = append(planner, makePlannerScenario("embedded_dvd_burn_in", "subtitle_matrix", dvdRequest, dvdFile, nil, settings, registry))
|
||||
|
||||
qualityRequest := fallbackRequest
|
||||
qualityRequest.PlaybackAttemptID = "attempt-available-qualities"
|
||||
qualityRequest.QualityPreference = qualityOriginal
|
||||
planner = append(planner, makePlannerScenario("available_qualities", "available_qualities", qualityRequest, fallbackFile, nil, settings, registry))
|
||||
|
||||
decision := goldenDecisionResponse()
|
||||
plan := decision.PlaybackPlan
|
||||
if plan == nil {
|
||||
fail("golden decision has no plan")
|
||||
}
|
||||
trackIndex := 1
|
||||
trackChange := goldenReplanRequest()
|
||||
trackChange.Operation = playback.ReplanOperationTrackChangeV3
|
||||
trackChange.ReplanRequestID = "replan-track-change-0001"
|
||||
trackChange.Failure = playback.FailureV3{}
|
||||
trackChange.SelectedTracks.Audio = &playback.TrackIdentityV3{ID: "", Index: &trackIndex}
|
||||
qualityChange := goldenReplanRequest()
|
||||
qualityChange.Operation = playback.ReplanOperationQualityChangeV3
|
||||
qualityChange.ReplanRequestID = "replan-quality-change-0001"
|
||||
qualityChange.Failure = playback.FailureV3{}
|
||||
qualityChange.QualityPreference = resolutionHD
|
||||
outputChange := goldenReplanRequest()
|
||||
outputChange.Operation = playback.ReplanOperationOutputChangeV3
|
||||
outputChange.ReplanRequestID = "replan-output-change-0001"
|
||||
outputChange.Failure = playback.FailureV3{}
|
||||
seekReanchor := goldenReplanRequest()
|
||||
seekReanchor.Operation = playback.ReplanOperationSeekReanchorV3
|
||||
seekReanchor.ReplanRequestID = "replan-seek-reanchor-0001"
|
||||
seekReanchor.Failure = playback.FailureV3{}
|
||||
seekReanchor.PositionSeconds = 321.25
|
||||
|
||||
trackChange.PositionSeconds = 321.25
|
||||
qualityChange.PositionSeconds = 321.25
|
||||
trackDuplicate := trackChange
|
||||
trackDuplicate.ReplanRequestID = "replan-track-duplicate-0001"
|
||||
qualityDuplicate := qualityChange
|
||||
qualityDuplicate.ReplanRequestID = "replan-quality-duplicate-0001"
|
||||
trackConcurrent := trackChange
|
||||
trackConcurrent.ReplanRequestID = "replan-track-concurrent-0001"
|
||||
qualityConcurrent := qualityChange
|
||||
qualityConcurrent.ReplanRequestID = "replan-quality-concurrent-0001"
|
||||
trackMidSeek := trackChange
|
||||
trackMidSeek.ReplanRequestID = "replan-track-mid-seek-0001"
|
||||
qualityMidSeek := qualityChange
|
||||
qualityMidSeek.ReplanRequestID = "replan-quality-mid-seek-0001"
|
||||
replans := []playback.ReplanScenarioV3{
|
||||
{Name: "track_change", Category: "track_change_replan", Request: trackChange, Expected: playback.ReplanExpectationV3{HTTPStatus: http.StatusOK, PreserveUnmodifiedTracks: true}},
|
||||
{Name: "quality_change", Category: "quality_change_replan", Request: qualityChange, Expected: playback.ReplanExpectationV3{HTTPStatus: http.StatusOK, SelectedQuality: resolutionHD}},
|
||||
{Name: "output_change", Category: "output_change_replan", Request: outputChange, Expected: playback.ReplanExpectationV3{HTTPStatus: http.StatusOK, PreserveUnmodifiedTracks: true}},
|
||||
{Name: "track_change_idempotent_duplicate", Category: "idempotent_replan", Request: trackDuplicate, Expected: playback.ReplanExpectationV3{SameRequestAndBodyStatus: http.StatusOK, ResponseReplayedVerbatim: true, ChangedBodyStatus: http.StatusConflict, ChangedBodyError: "idempotency_key_reused"}},
|
||||
{Name: "quality_change_idempotent_duplicate", Category: "idempotent_replan", Request: qualityDuplicate, Expected: playback.ReplanExpectationV3{SameRequestAndBodyStatus: http.StatusOK, ResponseReplayedVerbatim: true, ChangedBodyStatus: http.StatusConflict, ChangedBodyError: "idempotency_key_reused"}},
|
||||
{Name: "track_change_concurrent_duplicate", Category: "concurrent_replan", Request: trackConcurrent, Expected: playback.ReplanExpectationV3{WhileFirstLeaseActiveStatus: http.StatusConflict, ConcurrentError: "replan_in_progress", AfterCompletionStatus: http.StatusOK, ResponseReplayedVerbatim: true}},
|
||||
{Name: "quality_change_concurrent_duplicate", Category: "concurrent_replan", Request: qualityConcurrent, Expected: playback.ReplanExpectationV3{WhileFirstLeaseActiveStatus: http.StatusConflict, ConcurrentError: "replan_in_progress", AfterCompletionStatus: http.StatusOK, ResponseReplayedVerbatim: true}},
|
||||
{Name: "track_change_mid_seek", Category: categoryMidSeek, Request: trackMidSeek, Expected: playback.ReplanExpectationV3{HTTPStatus: http.StatusOK, PositionSeconds: trackMidSeek.PositionSeconds, PositionPreserved: true}},
|
||||
{Name: "quality_change_mid_seek", Category: categoryMidSeek, Request: qualityMidSeek, Expected: playback.ReplanExpectationV3{HTTPStatus: http.StatusOK, PositionSeconds: qualityMidSeek.PositionSeconds, PositionPreserved: true}},
|
||||
{Name: "mid_seek_reanchor", Category: categoryMidSeek, Request: seekReanchor, Expected: playback.ReplanExpectationV3{HTTPStatus: http.StatusOK, PositionSeconds: seekReanchor.PositionSeconds, PositionPreserved: true}},
|
||||
}
|
||||
|
||||
outputA := playback.PlanAttemptKeyV3(*plan, "output-a", nil)
|
||||
outputB := playback.PlanAttemptKeyV3(*plan, "output-b", nil)
|
||||
if outputA == outputB {
|
||||
fail("output context must change the opaque plan attempt key")
|
||||
}
|
||||
recovery := goldenReplanRequest()
|
||||
recovery.ReplanRequestID = "replan-failure-matrix-0001"
|
||||
recovery.PositionSeconds = 321.25
|
||||
subtitleIndex := 2
|
||||
recovery.SelectedTracks.Subtitle = &playback.TrackIdentityV3{
|
||||
ID: playback.TrackIDV3(goldenMediaFileID, "subtitle", subtitleIndex),
|
||||
Index: &subtitleIndex,
|
||||
}
|
||||
restartStart := goldenStartRequest()
|
||||
restartStart.PlaybackAttemptID = "attempt-restart-terminal"
|
||||
restartTerminal := playback.NewTerminalResponseV3(
|
||||
"transcode_start_failed",
|
||||
"The playback transport did not become ready in time.",
|
||||
true,
|
||||
)
|
||||
capacityStart := goldenStartRequest()
|
||||
capacityStart.PlaybackAttemptID = "attempt-capacity-unavailable"
|
||||
capacityAvailable := false
|
||||
zeroCapacityDelta := 0
|
||||
limitEvent := goldenRouteEvent()
|
||||
limitEvent.PlaybackAttemptID = "attempt-route-limit"
|
||||
limitEvent.Diagnostics = make(map[string]string, 33)
|
||||
for index := range 33 {
|
||||
limitEvent.Diagnostics[fmt.Sprintf("diagnostic_%02d", index)] = "value"
|
||||
}
|
||||
draftProtocolVersion := playback.ProtocolV3
|
||||
protocol := []playback.ProtocolScenarioV3{
|
||||
{Name: "legacy_start_requires_upgrade", Category: "legacy_426", Input: playback.ProtocolScenarioInputV3{LegacyStartBody: &playback.LegacyStartBodyV3{FileID: goldenMediaFileID}}, Expected: playback.ProtocolExpectationV3{HTTPStatus: http.StatusUpgradeRequired, Error: "client_upgrade_required"}},
|
||||
{Name: "draft_v3_start_requires_upgrade", Category: "draft_v3_426", Input: playback.ProtocolScenarioInputV3{LegacyStartBody: &playback.LegacyStartBodyV3{ProtocolVersion: &draftProtocolVersion, FileID: goldenMediaFileID, ClientCapabilities: &playback.DraftClientCapabilitiesV3{CodecsVideo: []string{codecH264}}}}, Expected: playback.ProtocolExpectationV3{HTTPStatus: http.StatusUpgradeRequired, Error: "client_upgrade_required"}},
|
||||
{Name: "output_context_change_invalidates_attempt", Category: "output_context_invalidation", Input: playback.ProtocolScenarioInputV3{PlanID: plan.PlanID, FirstOutputContextID: "output-a", SecondOutputContextID: "output-b", FirstPlanAttemptKey: outputA, SecondPlanAttemptKey: outputB}, Expected: playback.ProtocolExpectationV3{PlanIDUnchanged: true, PlanAttemptKeyChanged: true}},
|
||||
{Name: "opaque_attempt_key_loop", Category: "attempt_key_echo_and_loop", Input: playback.ProtocolScenarioInputV3{ServerPlanAttemptKey: plan.PlanAttemptKey, ReplanEcho: plan.PlanAttemptKey, AttemptedPlanKeys: []string{plan.PlanAttemptKey}}, Expected: playback.ProtocolExpectationV3{Action: "reject_already_attempted_plan"}},
|
||||
{Name: "failure_recovery_preserves_intent", Category: "recovery_matrix", Input: playback.ProtocolScenarioInputV3{ReplanRequest: &recovery}, Expected: playback.ProtocolExpectationV3{HTTPStatus: http.StatusOK, SelectionPreserved: true, PositionPreserved: true, Action: "preserve_selected_tracks_and_position"}},
|
||||
{Name: "restart_replays_terminal_attempt", Category: "restart_matrix", Input: playback.ProtocolScenarioInputV3{StartRequest: &restartStart, PersistedDecision: &restartTerminal, Restarted: true}, Expected: playback.ProtocolExpectationV3{HTTPStatus: http.StatusCreated, Outcome: playback.OutcomeAdaptationUnavailableV3, TerminalReason: "transcode_start_failed", ResponseReplayedVerbatim: true, CapacityDelta: &zeroCapacityDelta}},
|
||||
{Name: "capacity_unavailable_cleans_up", Category: "capacity_matrix", Input: playback.ProtocolScenarioInputV3{StartRequest: &capacityStart, CapacityAvailable: &capacityAvailable}, Expected: playback.ProtocolExpectationV3{HTTPStatus: http.StatusCreated, Outcome: playback.OutcomeAdaptationUnavailableV3, TerminalReason: "capacity_unavailable", CapacityDelta: &zeroCapacityDelta, CleanupComplete: true}},
|
||||
{Name: "route_event_diagnostic_limit", Category: "route_event_limits", Input: playback.ProtocolScenarioInputV3{RouteEvent: &limitEvent}, Expected: playback.ProtocolExpectationV3{HTTPStatus: http.StatusBadRequest, Error: "bad_request", Action: "reject_without_persisting"}},
|
||||
}
|
||||
|
||||
return playback.ConformanceMatrixV3{SchemaVersion: 1, Planner: planner, Replans: replans, Protocol: protocol}
|
||||
}
|
||||
|
||||
func makePlannerScenario(name, category string, request playback.StartRequestV3, file *models.MediaFile, attempted []string, settings playback.PlannerSettingsV3, registry *playback.TransformationRegistryV3) playback.PlannerScenarioV3 {
|
||||
result := playback.PlanPlaybackV3(playback.PlannerInputV3{
|
||||
Request: request, RequestedFile: file, EffectiveFile: file, AudioTrackIndex: 0,
|
||||
Settings: settings, Registry: registry, AttemptedKeys: attempted,
|
||||
})
|
||||
expected := playback.PlannerExpectationV3{Outcome: playback.OutcomeAdaptationUnavailableV3}
|
||||
if result.Plan != nil {
|
||||
selectedTracks := result.Plan.SelectedTracks
|
||||
subtitle := result.Plan.Subtitle
|
||||
claims := result.Plan.Claims
|
||||
expected = playback.PlannerExpectationV3{
|
||||
Outcome: playback.OutcomePlayableV3,
|
||||
Delivery: result.Plan.Delivery,
|
||||
DecisionReason: result.Plan.DecisionReason,
|
||||
PlanID: result.Plan.PlanID,
|
||||
PlanAttemptKey: result.Plan.PlanAttemptKey,
|
||||
SelectedTracks: &selectedTracks,
|
||||
Subtitle: &subtitle,
|
||||
Claims: &claims,
|
||||
Transformations: append([]playback.TransformationV3(nil), result.Plan.Transformations...),
|
||||
AvailableQualities: result.Plan.AvailableQualities,
|
||||
}
|
||||
} else if result.Terminal != nil {
|
||||
expected.TerminalReason = result.Terminal.Reason
|
||||
}
|
||||
return playback.PlannerScenarioV3{
|
||||
Name: name, Category: category, Request: request,
|
||||
Source: playback.SourceDescriptorFromFileV3(file, 0),
|
||||
AttemptedKeys: append([]string(nil), attempted...), Expected: expected,
|
||||
}
|
||||
}
|
||||
|
||||
func conformanceStartRequest() playback.StartRequestV3 {
|
||||
request := goldenStartRequest()
|
||||
request.QualityPreference = qualityOriginal
|
||||
request.Capabilities = playback.ClientCodecCapabilitiesV3{
|
||||
VideoEvidence: playback.EvidenceExactV3, AudioEvidence: playback.EvidenceExactV3,
|
||||
CodecsVideo: []string{codecHEVC}, CodecsVideoHardware: []string{codecHEVC}, CodecsAudio: []string{codecAAC}, Containers: []string{containerMKV}, MaxResolution: resolutionFHD,
|
||||
VideoDecode: []playback.VideoDecodeCapabilityV3{{Codec: codecHEVC, Profiles: []string{"main 10"}, Levels: []int{41}, BitDepths: []int{8}, MaxWidth: 1920, MaxHeight: 1080, MaxFrameRate: 60, MaxBitrateKbps: 20_000, Hardware: true}},
|
||||
}
|
||||
request.ClientPlaybackContext = playback.ClientPlaybackContextV3{
|
||||
ProtocolVersion: playback.ProtocolV3, FormFactor: "tv", AppVersion: "3.0-test",
|
||||
Device: playback.DeviceContextV3{Platform: "fixture"}, Output: playback.OutputContextV3{OutputContextID: "output-a"},
|
||||
Deliveries: map[string]playback.DeliveryCapabilityV3{
|
||||
playback.DeliveryClassOriginalHTTPV3: conformanceDelivery([]string{containerMKV, containerMP4}),
|
||||
playback.DeliveryClassProgressiveV3: conformanceDelivery([]string{containerMP4}),
|
||||
playback.DeliveryClassHLSV3: conformanceDelivery([]string{containerHLS}),
|
||||
},
|
||||
}
|
||||
return request
|
||||
}
|
||||
|
||||
func conformanceDelivery(containers []string) playback.DeliveryCapabilityV3 {
|
||||
return playback.DeliveryCapabilityV3{
|
||||
Enabled: true,
|
||||
SupportedOnDevice: true,
|
||||
Containers: append([]string(nil), containers...),
|
||||
VideoCodecs: []string{codecHEVC, codecH264},
|
||||
AudioDecodeCodecs: []string{codecAAC},
|
||||
AudioPassthroughCodecs: []string{},
|
||||
Features: []string{},
|
||||
ValidatedClaims: []string{},
|
||||
Transformations: []playback.TransformationV3{},
|
||||
}
|
||||
}
|
||||
|
||||
func conformanceVideoFile() *models.MediaFile {
|
||||
return &models.MediaFile{ID: goldenMediaFileID, Container: containerMKV, CodecVideo: codecHEVC, CodecAudio: codecAAC, Resolution: resolutionFHD, Bitrate: 8_000, AudioChannels: 2, Duration: 7_200, VideoTracks: []models.VideoTrack{{Codec: codecHEVC, Profile: "Main", Level: 41, Width: 1920, Height: 1080, FrameRate: filmFrameRate, Bitrate: 8_000, BitDepth: 8, VideoRange: videoRangeSDR, VideoRangeType: videoRangeSDR}}, AudioTracks: []models.AudioTrack{{Codec: codecAAC, Channels: 2, Layout: audioLayoutStereo}}}
|
||||
}
|
||||
|
||||
func conformanceHDRFile() *models.MediaFile {
|
||||
return &models.MediaFile{
|
||||
ID: goldenMediaFileID,
|
||||
Container: containerMKV,
|
||||
CodecVideo: codecHEVC,
|
||||
CodecAudio: codecAAC,
|
||||
Resolution: "2160p",
|
||||
Bitrate: 60_000,
|
||||
AudioChannels: 2,
|
||||
Duration: 7_200,
|
||||
VideoTracks: []models.VideoTrack{{
|
||||
Codec: codecHEVC, Profile: "Main 10", Level: 153,
|
||||
Width: 3840, Height: 2160, FrameRate: filmFrameRate, Bitrate: 60_000, BitDepth: 10,
|
||||
VideoRange: "HDR", VideoRangeType: "HDR10", ColorRange: "tv",
|
||||
}},
|
||||
AudioTracks: []models.AudioTrack{{Codec: codecAAC, Channels: 2, Layout: audioLayoutStereo}},
|
||||
}
|
||||
}
|
||||
|
||||
func conformanceHDRRequest() playback.StartRequestV3 {
|
||||
request := conformanceStartRequest()
|
||||
request.Capabilities.CodecsVideo = []string{codecHEVC}
|
||||
request.Capabilities.CodecsVideoHardware = []string{codecHEVC}
|
||||
request.Capabilities.CodecsAudio = []string{codecAAC}
|
||||
request.Capabilities.Containers = []string{containerMKV}
|
||||
request.Capabilities.MaxResolution = "2160p"
|
||||
request.Capabilities.HDR = true
|
||||
request.Capabilities.HDRDetails = &playback.HDRCapabilitiesV3{HDR10: true, DolbyVisionProfiles: []int{}}
|
||||
request.Capabilities.VideoDecode = []playback.VideoDecodeCapabilityV3{{
|
||||
Codec: codecHEVC, Profiles: []string{"main 10"}, Levels: []int{153}, BitDepths: []int{10},
|
||||
MaxWidth: 3840, MaxHeight: 2160, MaxFrameRate: 60, MaxBitrateKbps: 80_000, Hardware: true,
|
||||
}}
|
||||
request.ClientPlaybackContext.Output.HDRDetails = &playback.HDRCapabilitiesV3{HDR10: true, DolbyVisionProfiles: []int{}}
|
||||
return request
|
||||
}
|
||||
|
||||
func conformanceFallbackFile() *models.MediaFile {
|
||||
return &models.MediaFile{ID: goldenMediaFileID, FilePath: "/media/movie.mp4", Container: containerMP4, CodecVideo: codecH264, CodecAudio: codecAAC, Resolution: resolutionFHD, Bitrate: 8_000, AudioChannels: 2, Duration: 7_200, VideoTracks: []models.VideoTrack{{Codec: codecH264, Profile: profileHigh, Level: 41, Width: 1920, Height: 1080, FrameRate: filmFrameRate, Bitrate: 8_000, BitDepth: 8, VideoRange: videoRangeSDR, VideoRangeType: videoRangeSDR}}, AudioTracks: []models.AudioTrack{{Codec: codecAAC, Channels: 2, Layout: audioLayoutStereo}}}
|
||||
}
|
||||
|
||||
func conformanceRegistry() *playback.TransformationRegistryV3 {
|
||||
return playback.NewTransformationRegistryV3([]playback.TransformationSpecV3{
|
||||
{Name: playback.TransformationAudioToAACV3, RecipeVersion: "1", Available: true},
|
||||
{Name: playback.TransformationVideoToH264V3, RecipeVersion: "1", Available: true},
|
||||
{Name: playback.TransformationServerDV7HDR10V3, RecipeVersion: "1", Available: true},
|
||||
})
|
||||
}
|
||||
+16
-139
@@ -19,7 +19,6 @@ import (
|
||||
"sort"
|
||||
"strconv"
|
||||
"strings"
|
||||
"sync"
|
||||
"sync/atomic"
|
||||
"syscall"
|
||||
"time"
|
||||
@@ -718,19 +717,9 @@ func main() {
|
||||
var handler http.Handler
|
||||
if mode == "proxy" {
|
||||
srv := proxy.NewServer(watcher, tracker)
|
||||
srv.SetRemoteArtifactMissReporter(downloads.NewArtifactManager(
|
||||
downloads.NewArtifactRepository(pool),
|
||||
downloads.NewRepository(pool),
|
||||
nil,
|
||||
downloads.NewPlaybackPreparer(),
|
||||
nodeID,
|
||||
watcher.Config,
|
||||
nil,
|
||||
))
|
||||
handler = srv.Handler()
|
||||
} else {
|
||||
srv := transcodenode.NewServer(watcher, tracker)
|
||||
srv.SetInputPathAuthorizer(transcodenode.NewCatalogPathAuthorizer(scanner.NewFileRepository(pool)))
|
||||
srv.SetFFmpegLogSink(playback.NewSlogFFmpegLogSink(slog.Default(), nodeID))
|
||||
// Read jellycompat reconstruction recipes central wrote at transcode
|
||||
// start, so this node can rebuild a Jellyfin transcode after its own
|
||||
@@ -904,10 +893,8 @@ func main() {
|
||||
)
|
||||
}
|
||||
var watchProviderService *watchsync.Service
|
||||
var watchProviderRegistry *watchsync.Registry
|
||||
var watchProviderRepo *watchsync.PostgresRepository
|
||||
if deps.DB != nil {
|
||||
watchProviderRegistry = watchsync.NewRegistry()
|
||||
watchProviderRegistry := watchsync.NewRegistry()
|
||||
if err := watchProviderRegistry.Register(trakt.NewProvider(nil, "")); err != nil {
|
||||
log.Fatalf("register watch provider: %v", err)
|
||||
}
|
||||
@@ -917,8 +904,10 @@ func main() {
|
||||
if err := watchProviderRegistry.Register(watchmdblist.NewProvider(nil, "")); err != nil {
|
||||
log.Fatalf("register watch provider: %v", err)
|
||||
}
|
||||
watchProviderRepo = watchsync.NewPostgresRepository(deps.DB, deps.SecretCipher)
|
||||
watchProviderService = watchsync.NewService(watchProviderRepo, watchProviderRegistry)
|
||||
watchProviderService = watchsync.NewService(
|
||||
watchsync.NewPostgresRepository(deps.DB, deps.SecretCipher),
|
||||
watchProviderRegistry,
|
||||
)
|
||||
deps.WatchProviderService = watchProviderService
|
||||
}
|
||||
|
||||
@@ -930,14 +919,8 @@ func main() {
|
||||
proxyPool := nodepool.NewProxyPool()
|
||||
transcodePool := nodepool.NewTranscodePool()
|
||||
|
||||
proxyNodes, err := nodeRepo.ListEnabled(appCtx, nodepool.NodeTypeProxy)
|
||||
if err != nil {
|
||||
log.Fatalf("load enabled proxy nodes: %v", err)
|
||||
}
|
||||
transcodeNodes, err := nodeRepo.ListEnabled(appCtx, nodepool.NodeTypeTranscode)
|
||||
if err != nil {
|
||||
log.Fatalf("load enabled transcode nodes: %v", err)
|
||||
}
|
||||
proxyNodes, _ := nodeRepo.ListEnabled(context.Background(), nodepool.NodeTypeProxy)
|
||||
transcodeNodes, _ := nodeRepo.ListEnabled(context.Background(), nodepool.NodeTypeTranscode)
|
||||
proxyPool.SetNodes(proxyNodes)
|
||||
transcodePool.SetNodes(transcodeNodes)
|
||||
|
||||
@@ -1136,15 +1119,6 @@ func main() {
|
||||
installer,
|
||||
plugins.NewHostAdapter(pluginHost),
|
||||
)
|
||||
if watchProviderRegistry != nil {
|
||||
reloadWatchProviders := func(ctx context.Context) {
|
||||
if err := reloadWatchSyncPluginProviders(ctx, watchProviderRegistry, installationStore, pluginService, watchProviderRepo); err != nil {
|
||||
slog.WarnContext(ctx, "failed to reload watch sync plugin providers", "component", "app", "error", err)
|
||||
}
|
||||
}
|
||||
pluginService.AddLifecycleHook(reloadWatchProviders)
|
||||
reloadWatchProviders(appCtx)
|
||||
}
|
||||
if deps.MarkerRegistry != nil && deps.MarkerProviderConfig != nil {
|
||||
markerPluginResolver := markers.NewPluginResolverAdapter(pluginService)
|
||||
pluginService.AddLifecycleHook(func(ctx context.Context) {
|
||||
@@ -2076,29 +2050,20 @@ func main() {
|
||||
// Download prepare-to-file pipeline (Phase 3): a durable, leased encode
|
||||
// queue hosted on the task manager. Built here (before Start) and shared
|
||||
// with the API via deps so the download service can enqueue jobs.
|
||||
liveDownloadConfig := func() *config.Config {
|
||||
if deps.LiveConfig != nil {
|
||||
if c := deps.LiveConfig(); c != nil {
|
||||
return c
|
||||
}
|
||||
}
|
||||
return deps.Config
|
||||
}
|
||||
var downloadWorkPlanner nodepool.TranscodeWorkPlanner
|
||||
if deps.NodePlanner != nil {
|
||||
downloadWorkPlanner = deps.NodePlanner
|
||||
}
|
||||
preparer := downloads.NewNodeAwarePreparer(downloads.NewPlaybackPreparer(), downloadWorkPlanner, liveDownloadConfig)
|
||||
if deps.NodeRepo != nil {
|
||||
preparer.SetOriginLookup(deps.NodeRepo)
|
||||
}
|
||||
artifactMgr := downloads.NewArtifactManager(
|
||||
downloads.NewArtifactRepository(deps.DB),
|
||||
downloads.NewRepository(deps.DB),
|
||||
deps.FileRepo,
|
||||
preparer,
|
||||
downloads.NewPlaybackPreparer(),
|
||||
deps.NodeID,
|
||||
liveDownloadConfig,
|
||||
func() *config.Config {
|
||||
if deps.LiveConfig != nil {
|
||||
if c := deps.LiveConfig(); c != nil {
|
||||
return c
|
||||
}
|
||||
}
|
||||
return deps.Config
|
||||
},
|
||||
func(ctx context.Context, d *downloads.Download) {
|
||||
if deps.EventsHub == nil {
|
||||
return
|
||||
@@ -3123,99 +3088,11 @@ func metadataInt(value any) int {
|
||||
}
|
||||
}
|
||||
|
||||
var watchSyncPluginReloadMu sync.Mutex
|
||||
|
||||
type markerPluginCapabilityStore interface {
|
||||
ListEnabled(ctx context.Context) ([]*plugins.Installation, error)
|
||||
ListCapabilities(ctx context.Context, installationID int) ([]*plugins.Capability, error)
|
||||
}
|
||||
|
||||
func reloadWatchSyncPluginProviders(
|
||||
ctx context.Context,
|
||||
registry *watchsync.Registry,
|
||||
store markerPluginCapabilityStore,
|
||||
service *plugins.Service,
|
||||
repository watchsync.PluginCredentialRepository,
|
||||
) error {
|
||||
if registry == nil {
|
||||
return nil
|
||||
}
|
||||
watchSyncPluginReloadMu.Lock()
|
||||
defer watchSyncPluginReloadMu.Unlock()
|
||||
|
||||
var providers []watchsync.Provider
|
||||
if store == nil || service == nil {
|
||||
return registry.ReplacePluginProviders(providers)
|
||||
}
|
||||
installations, err := store.ListEnabled(ctx)
|
||||
if err != nil {
|
||||
return fmt.Errorf("list enabled watch sync plugin installations: %w", err)
|
||||
}
|
||||
sort.Slice(installations, func(i, j int) bool {
|
||||
if installations[i] == nil {
|
||||
return false
|
||||
}
|
||||
if installations[j] == nil {
|
||||
return true
|
||||
}
|
||||
return installations[i].ID < installations[j].ID
|
||||
})
|
||||
for _, installation := range installations {
|
||||
if installation == nil || installation.IsBuiltin() {
|
||||
continue
|
||||
}
|
||||
capabilities, err := store.ListCapabilities(ctx, installation.ID)
|
||||
if err != nil {
|
||||
slog.WarnContext(ctx, "skip watch sync plugin with unreadable capabilities",
|
||||
"component", "app",
|
||||
"installation_id", installation.ID,
|
||||
"error", err,
|
||||
)
|
||||
continue
|
||||
}
|
||||
for _, capability := range capabilities {
|
||||
if capability == nil || capability.Type != sdkcapability.WatchSyncProvider {
|
||||
continue
|
||||
}
|
||||
descriptor, err := plugins.DecodeCapability(capability)
|
||||
if err != nil {
|
||||
slog.WarnContext(ctx, "skip invalid watch sync plugin capability",
|
||||
"component", "app",
|
||||
"installation_id", installation.ID,
|
||||
"capability_id", capability.ID,
|
||||
"error", err,
|
||||
)
|
||||
continue
|
||||
}
|
||||
provider, err := watchsync.NewPluginProvider(watchsync.PluginProviderOptions{
|
||||
InstallationID: installation.ID,
|
||||
ProviderKey: fmt.Sprintf("plugin:%d:%s", installation.ID, capability.ID),
|
||||
CapabilityID: capability.ID,
|
||||
DisplayName: descriptor.GetDisplayName(),
|
||||
Descriptor: descriptor.GetWatchSyncProvider(),
|
||||
ResolveClient: func(callCtx context.Context, installationID int, capabilityID string) (watchsync.WatchSyncPluginClient, error) {
|
||||
return service.WatchSyncProviderClient(callCtx, installationID, capabilityID)
|
||||
},
|
||||
ResolveConfig: func(callCtx context.Context, installationID int) (*pluginv1.WatchSyncProviderConfig, error) {
|
||||
return service.WatchSyncProviderConfig(callCtx, installationID)
|
||||
},
|
||||
Repository: repository,
|
||||
})
|
||||
if err != nil {
|
||||
slog.WarnContext(ctx, "skip unsupported watch sync plugin capability",
|
||||
"component", "app",
|
||||
"installation_id", installation.ID,
|
||||
"capability_id", capability.ID,
|
||||
"error", err,
|
||||
)
|
||||
continue
|
||||
}
|
||||
providers = append(providers, provider)
|
||||
}
|
||||
}
|
||||
return registry.ReplacePluginProviders(providers)
|
||||
}
|
||||
|
||||
type markerPluginRuntimeConfigStore interface {
|
||||
ListGlobalConfigs(ctx context.Context, installationID int) ([]*plugins.RuntimeConfig, error)
|
||||
PutGlobalConfig(ctx context.Context, installationID int, key string, value map[string]any) error
|
||||
|
||||
@@ -1,8 +1,6 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
@@ -10,12 +8,9 @@ import (
|
||||
"sync"
|
||||
"testing"
|
||||
|
||||
pluginv1 "github.com/Silo-Server/silo-plugin-sdk/pkg/pluginproto/silo/plugin/v1"
|
||||
"github.com/Silo-Server/silo-server/internal/api"
|
||||
"github.com/Silo-Server/silo-server/internal/config"
|
||||
"github.com/Silo-Server/silo-server/internal/playback"
|
||||
"github.com/Silo-Server/silo-server/internal/plugins"
|
||||
"github.com/Silo-Server/silo-server/internal/watchsync"
|
||||
)
|
||||
|
||||
func TestConfigureS3Clients_SetsCORSOnPublicAssetsBucket(t *testing.T) {
|
||||
@@ -187,44 +182,3 @@ func TestBuildLiveSessionSync_UsesTransportPlayMethod(t *testing.T) {
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
type failingWatchSyncCapabilityStore struct{}
|
||||
|
||||
func (failingWatchSyncCapabilityStore) ListEnabled(context.Context) ([]*plugins.Installation, error) {
|
||||
return []*plugins.Installation{{ID: 2, Enabled: true, Kind: plugins.KindPlugin}}, nil
|
||||
}
|
||||
|
||||
func (failingWatchSyncCapabilityStore) ListCapabilities(context.Context, int) ([]*plugins.Capability, error) {
|
||||
return nil, errors.New("database unavailable")
|
||||
}
|
||||
|
||||
func TestReloadWatchSyncPluginProvidersDropsStaleProvidersOnCapabilityReadFailure(t *testing.T) {
|
||||
registry := watchsync.NewRegistry()
|
||||
provider, err := watchsync.NewPluginProvider(watchsync.PluginProviderOptions{
|
||||
InstallationID: 1,
|
||||
ProviderKey: "plugin:1:tracker",
|
||||
CapabilityID: "tracker",
|
||||
Descriptor: &pluginv1.WatchSyncProviderDescriptor{
|
||||
AuthMethods: []pluginv1.WatchSyncAuthMethod{pluginv1.WatchSyncAuthMethod_WATCH_SYNC_AUTH_METHOD_API_KEY},
|
||||
ExportWatched: true,
|
||||
},
|
||||
ResolveClient: func(context.Context, int, string) (watchsync.WatchSyncPluginClient, error) {
|
||||
return nil, errors.New("not used")
|
||||
},
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := registry.Register(provider); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if err := reloadWatchSyncPluginProviders(
|
||||
context.Background(), registry, failingWatchSyncCapabilityStore{}, &plugins.Service{}, nil,
|
||||
); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if _, ok := registry.Get(provider.Key()); ok {
|
||||
t.Fatalf("stale provider %q remained registered", provider.Key())
|
||||
}
|
||||
}
|
||||
|
||||
@@ -25,8 +25,6 @@ func buildLiveSessionSync(s *playback.Session, reportingNode string) worker.Sess
|
||||
ClientIP: s.ClientIP,
|
||||
ClientName: s.ClientName,
|
||||
ClientVersion: s.ClientVersion,
|
||||
ClientBuild: s.ClientBuild,
|
||||
ClientChannel: s.ClientChannel,
|
||||
ClientUserAgent: s.ClientUserAgent,
|
||||
AudioTrackIndex: s.AudioTrackIndex,
|
||||
TranscodeAudio: s.TranscodeAudio,
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"fixture_version": 1,
|
||||
"manifest_revision": 6,
|
||||
"manifest_revision": 5,
|
||||
"description": "Cross-platform conformance cases for settings resolution. Every case runs against the shipped manifest in this directory: definitions are referenced by key, never restated, so an expectation can only be satisfied by resolving the real contract. Each platform's resolver (Go in internal/settingsresolve, TypeScript in web/src/lib/settingsResolve.ts, Kotlin and Swift in the client repos) runs every case through a hand-written runner; a runner must fail on any fixture field it does not know, because schema drift in the fixture itself is drift. A case's constraint_bindings attach a constraint to a copy of a real definition so constraint semantics stay testable even while no shipped definition carries that constraint kind. In expected entries, constrained:true requires stored_value and constraint_kind to be present, and stored_value may be null to mean the authored value was JSON null.",
|
||||
"cases": [
|
||||
{
|
||||
@@ -667,30 +667,6 @@
|
||||
"source": "profile"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "subtitle_appearance_uses_shared_default",
|
||||
"description": "With no stored profile or device value, every client receives the contract's shared Box 75% subtitle appearance.",
|
||||
"keys": ["playback.subtitle_appearance"],
|
||||
"context": { "profile_id": "p1", "device_id": "d1" },
|
||||
"stored": [],
|
||||
"expected": [
|
||||
{
|
||||
"key": "playback.subtitle_appearance",
|
||||
"value": {
|
||||
"fontSize": "large",
|
||||
"fontFamily": "sans-serif",
|
||||
"fontColor": "#ffffff",
|
||||
"backgroundColor": "#000000",
|
||||
"backgroundStyle": "box",
|
||||
"backgroundOpacity": 75,
|
||||
"textOutline": false,
|
||||
"textOutlineColor": "#000000",
|
||||
"position": "bottom"
|
||||
},
|
||||
"source": "default"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"api_version": 1,
|
||||
"revision": 6,
|
||||
"revision": 5,
|
||||
"option_sets": {
|
||||
"playback_audio_languages": {
|
||||
"type": "language_tag",
|
||||
@@ -233,7 +233,7 @@
|
||||
"fontFamily": "sans-serif",
|
||||
"fontColor": "#ffffff",
|
||||
"backgroundColor": "#000000",
|
||||
"backgroundStyle": "box",
|
||||
"backgroundStyle": "shadow",
|
||||
"backgroundOpacity": 75,
|
||||
"textOutline": false,
|
||||
"textOutlineColor": "#000000",
|
||||
@@ -243,7 +243,7 @@
|
||||
"label": "Subtitle appearance",
|
||||
"description": "How subtitles are drawn during playback.",
|
||||
"recommended_control": "panel",
|
||||
"notes": "Renamed from the unprefixed legacy key \"subtitle_appearance\". Every other canonical key carries a domain prefix, and preserving accidental key names is an explicit non-goal of the design. The rename touches three URL paths in internal/api/router.go, the admin device-settings routes, and the key constant in every client, so it cannot land without them. Migration copies the account-level legacy fallback to every existing profile and leaves device overrides unchanged, rewriting the key on each row. Revision 6 changes the fallback background from shadow to a 75% opaque box, matching the previous intended web default and the current Apple fallback. Connected clients receive the complete effective default from the server; clients should adopt revision 6 so their local and sparse-object decoding fallbacks match it. Stored profile and device overrides remain authoritative."
|
||||
"notes": "Renamed from the unprefixed legacy key \"subtitle_appearance\". Every other canonical key carries a domain prefix, and preserving accidental key names is an explicit non-goal of the design. The rename touches three URL paths in internal/api/router.go, the admin device-settings routes, and the key constant in every client, so it cannot land without them. Migration copies the account-level legacy fallback to every existing profile and leaves device overrides unchanged, rewriting the key on each row. The default below is the web client's; Apple defaults to a box background and Android to no background with an outline, so migration must first write each platform's own default into a row for users who never opened the panel, or their subtitles silently change appearance at cutover."
|
||||
},
|
||||
{
|
||||
"key": "playback.preferred_quality",
|
||||
|
||||
@@ -123,6 +123,7 @@ services:
|
||||
- silo-dev-plugins:/var/lib/silo/plugins
|
||||
- silo-dev-compat:/var/lib/silo/compat
|
||||
- silo-dev-transcode:/tmp/silo-transcode
|
||||
- silo-dev-audiobook-covers:/var/lib/silo/audiobook-covers
|
||||
- ${MEDIA_ROOT:-/tmp/silo-dev-media}:${MEDIA_CONTAINER_ROOT:-/mnt/media}:ro
|
||||
depends_on:
|
||||
postgres:
|
||||
@@ -168,6 +169,7 @@ services:
|
||||
|
||||
volumes:
|
||||
silo-dev-air-tmp:
|
||||
silo-dev-audiobook-covers:
|
||||
silo-dev-compat:
|
||||
silo-dev-go-build:
|
||||
silo-dev-go-mod:
|
||||
|
||||
@@ -1,10 +0,0 @@
|
||||
services:
|
||||
silo:
|
||||
devices:
|
||||
- /dev/dri:/dev/dri
|
||||
|
||||
# Optional distributed-mode example. Most single-host installs should
|
||||
# just use the integrated service above.
|
||||
# silo-transcode:
|
||||
# devices:
|
||||
# - /dev/dri:/dev/dri
|
||||
+7
-6
@@ -8,7 +8,7 @@ services:
|
||||
POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-silo}
|
||||
POSTGRES_DB: ${POSTGRES_DB:-silo}
|
||||
ports:
|
||||
- "127.0.0.1:${POSTGRES_PORT:-5432}:5432"
|
||||
- "5432:5432"
|
||||
volumes:
|
||||
- ${SILO_DATA_ROOT:-/opt/silo}/postgres:/var/lib/postgresql
|
||||
command: ["postgres", "-c", "listen_addresses=*"]
|
||||
@@ -22,7 +22,7 @@ services:
|
||||
image: redis:alpine
|
||||
restart: unless-stopped
|
||||
ports:
|
||||
- "127.0.0.1:${REDIS_PORT:-6379}:6379"
|
||||
- "6379:6379"
|
||||
volumes:
|
||||
- ${SILO_DATA_ROOT:-/opt/silo}/redis:/data
|
||||
healthcheck:
|
||||
@@ -56,10 +56,6 @@ services:
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
MODE: integrated
|
||||
# Keep the container listeners fixed. PORT and JF_PORT in .env are
|
||||
# host-side published-port overrides.
|
||||
PORT: "8080"
|
||||
JF_PORT: "8096"
|
||||
# Master key for at-rest credential encryption. Required — the server
|
||||
# refuses to start without it. Generate with: openssl rand -base64 48
|
||||
# Back it up SEPARATELY from your database dumps; losing it makes encrypted
|
||||
@@ -75,10 +71,12 @@ services:
|
||||
- "${ABS_PORT:-13378}:13378"
|
||||
volumes:
|
||||
- ${MEDIA_ROOT:?Set MEDIA_ROOT in .env to the host media path}:${MEDIA_CONTAINER_ROOT:-/mnt/media}:ro
|
||||
- ${MEDIA_BOOKS_ROOT:-${MEDIA_ROOT}}:${MEDIA_BOOKS_CONTAINER_ROOT:-${MEDIA_CONTAINER_ROOT:-/mnt/media}/books}:ro
|
||||
- ${SILO_DATA_ROOT:-/opt/silo}/plugins:/var/lib/silo/plugins
|
||||
- ${SILO_DATA_ROOT:-/opt/silo}/compat:/var/lib/silo/compat
|
||||
- ${SILO_DATA_ROOT:-/opt/silo}/transcode:/tmp/silo-transcode
|
||||
- ${SILO_DATA_ROOT:-/opt/silo}/catalog-seeds:/catalog-seeds:ro
|
||||
- ${SILO_DATA_ROOT:-/opt/silo}/audiobook-covers:/var/lib/silo/audiobook-covers
|
||||
- /proc/meminfo:/host/proc/meminfo:ro
|
||||
depends_on:
|
||||
postgres:
|
||||
@@ -88,6 +86,9 @@ services:
|
||||
env_file:
|
||||
- path: .env
|
||||
required: false
|
||||
devices:
|
||||
- /dev/dri:/dev/dri
|
||||
|
||||
# Optional distributed-mode example. Most single-host installs should
|
||||
# just use the integrated service above.
|
||||
# silo-proxy:
|
||||
|
||||
@@ -31,20 +31,6 @@ entire current entity as `200 OK`, preventing bytes from different revisions
|
||||
from being combined. `If-None-Match` uses the same validator for ordinary
|
||||
conditional requests.
|
||||
|
||||
For a bounded chunk read, a client can instead send `Range` and `If-Match`.
|
||||
When the validator matches, the server returns the requested `206` interval.
|
||||
When it does not match, the server returns `412 Precondition Failed` without a
|
||||
body. This contract avoids materializing a full entity when a bounded read's
|
||||
validator is stale. It does not change `If-Range`: an `If-Range` mismatch still
|
||||
ignores the range and returns the full current entity as `200 OK`, as required
|
||||
by the HTTP range contract.
|
||||
|
||||
Direct-stream completion logs record whether `If-Match` and `If-Range` were
|
||||
present, a bounded conditional-result value, and short SHA-256 fingerprints for
|
||||
the emitted and requested validators. The raw validators and media path are not
|
||||
logged. The fingerprints are only correlation aids and are not protocol
|
||||
validators.
|
||||
|
||||
Playback sessions already treat each transport request independently.
|
||||
Sequential ranged requests refresh transport activity, and cleanup never
|
||||
expires a session while one of those transport requests is active. A late
|
||||
|
||||
@@ -1,847 +0,0 @@
|
||||
# Playback protocol v3
|
||||
|
||||
The wire contract between a Silo client and a Silo server for deciding *how* a
|
||||
piece of media will play, and for recovering when that decision turns out to be
|
||||
wrong on the device in front of the user.
|
||||
|
||||
> **Status: normative.** This document, the JSON Schemas under
|
||||
> [`docs/design/schemas/playback-v3/`](../design/schemas/playback-v3/), and the
|
||||
> golden fixtures under `internal/playback/testdata/protocol_v3/` are the
|
||||
> contract. Where this document and a client implementation disagree, the client
|
||||
> is wrong. Where this document and the server implementation disagree, that is a
|
||||
> bug in one of them — file it.
|
||||
|
||||
This is written to be sufficient on its own. A third-party client should be able
|
||||
to implement playback against a Silo server from this document plus the schemas,
|
||||
without reading any client repository and without reading the server source.
|
||||
|
||||
Paths are repository-relative; assume the repository root is the cwd.
|
||||
|
||||
---
|
||||
|
||||
## 1. Design invariants
|
||||
|
||||
Five properties hold everywhere in the protocol. Most of the surprising details
|
||||
below follow from one of them.
|
||||
|
||||
**The server owns the decision.** A client reports what it can do; the server
|
||||
decides what will be sent and how. Clients do not pick a bitrate ladder rung, do
|
||||
not choose a container, do not decide whether to remux, and do not post a
|
||||
transcode recipe. The `playback_plan` in a response is the whole instruction.
|
||||
|
||||
**Plan identity is deterministic.** `plan_id` is a pure function of the request
|
||||
identity and the plan's own shape (§9). The same decision made twice produces
|
||||
the same `plan_id`. This is what makes replans idempotent rather than merely
|
||||
retried.
|
||||
|
||||
**Attempt keys are server-owned and opaque.** `plan_attempt_key` identifies "this
|
||||
plan, on this output, with these local mutations" for loop prevention. It is a
|
||||
hash the server computes. A client stores it, echoes it back, and never parses,
|
||||
compares by substring, or recomputes it. Its algorithm and preimage are server
|
||||
implementation details; §9 specifies only the stability clients may rely on.
|
||||
|
||||
**Claims are validated, not assumed.** When the server says a route preserves
|
||||
Atmos, or that Dolby Vision metadata was removed, that claim was checked against
|
||||
evidence the client supplied, at the strictness its evidence tier allows (§3).
|
||||
The server never claims something it did not verify.
|
||||
|
||||
**Route events are diagnostics, not control.** A client reports what happened
|
||||
(`first_frame`, `plan_failed`, `terminal`) so the server can learn; the report
|
||||
never changes the session. Playback recovery goes through replan (§6), which is a
|
||||
request with a response, not a fire-and-forget event.
|
||||
|
||||
Two consequences worth stating early, because they surprise implementers:
|
||||
|
||||
- `POST /playback/start` returns **201 for every outcome**, including a terminal
|
||||
refusal to play. A terminal is a decision, not a transport failure. 4xx means
|
||||
the request was malformed; it never means "this media cannot play."
|
||||
- `protocol_version: 3` is carried on every body independently, and each is
|
||||
validated separately: the start request, the `client_playback_context` nested
|
||||
inside it, the replan request, the route event, the decision response, and the
|
||||
plan within it. A start request whose envelope says 3 but whose
|
||||
`client_playback_context` says otherwise is rejected. There is no negotiation
|
||||
and no fallback — a server that does not speak v3 is not a server this
|
||||
contract describes.
|
||||
|
||||
---
|
||||
|
||||
## 2. Endpoints
|
||||
|
||||
All paths are relative to `/api/v1`. Every endpoint requires an authenticated
|
||||
user. The mutation endpoints additionally require a profile, supplied as the
|
||||
`X-Profile-Id` header.
|
||||
|
||||
Every non-2xx response body is the standard error envelope:
|
||||
|
||||
```json
|
||||
{"error": "<machine_code>", "message": "<human sentence>"}
|
||||
```
|
||||
|
||||
The `error` code is the stable part; the `message` is for logs and is not
|
||||
contract.
|
||||
|
||||
### 2.1 `GET /playback/capability`
|
||||
|
||||
Feature detection. Auth required; no profile needed.
|
||||
|
||||
| Status | Meaning |
|
||||
| --- | --- |
|
||||
| `200` | Capability document |
|
||||
| `401` `unauthorized` | No authenticated user |
|
||||
|
||||
v3 is the server's only playback protocol, so `enabled` is constant `true` and
|
||||
the document is always the full one:
|
||||
|
||||
```json
|
||||
{
|
||||
"enabled": true,
|
||||
"protocol_versions": [3],
|
||||
"features": ["playback_plan_v3", "neutral_playback_v3_contract_v1", "layout_aware_passthrough", "playback_route_diagnostics",
|
||||
"device_quirks_v1", "seek_reanchor_v1", "output_change_v1", "direct_stream_resume_v1",
|
||||
"plan_source_duration_v1"],
|
||||
"deliveries": ["original_http", "server_remux_progressive", "server_remux_hls", "server_transcode_hls"],
|
||||
"transformations": [{"name": "audio_to_aac", "executor": "server", "recipe_version": "1", "validated_claims": ["audio_decode"]}]
|
||||
}
|
||||
```
|
||||
|
||||
The nine feature strings above are the full set this server version advertises:
|
||||
|
||||
| Feature | What it promises |
|
||||
| --- | --- |
|
||||
| `playback_plan_v3` | The three plan endpoints exist and behave as specified here |
|
||||
| `neutral_playback_v3_contract_v1` | The server mints opaque `plan_attempt_key` values that clients only echo, and exposes track/quality intent replans distinct from failure recovery |
|
||||
| `layout_aware_passthrough` | Audio passthrough is decided from channel *layouts*, not just channel counts (§3) |
|
||||
| `playback_route_diagnostics` | `POST /playback/route-events` is accepted |
|
||||
| `device_quirks_v1` | Plans may carry `applied_quirks` and `runtime_corrections` (§9) |
|
||||
| `seek_reanchor_v1` | The `seek_reanchor` replan operation is available (§6) |
|
||||
| `output_change_v1` | The `output_change` intent replan is available; clients must keep the active route when this feature is absent |
|
||||
| `direct_stream_resume_v1` | A direct route may resume mid-file rather than restarting |
|
||||
| `plan_source_duration_v1` | `source.duration_seconds` is populated when known, so its absence means *unknown* rather than *unsupported* (§5) |
|
||||
|
||||
That last one is the reason feature detection is a list and not a version
|
||||
number: without it, a client cannot tell a server that never sends the runtime
|
||||
apart from a server that knows this particular file's runtime is genuinely
|
||||
unknown, and both look like an absent field.
|
||||
|
||||
`deliveries` reports the four *server-side* delivery values, not the three
|
||||
delivery classes a client negotiates in. §4 gives the folding.
|
||||
|
||||
`transformations` advertises only what the *installed* FFmpeg was probed for at
|
||||
startup — a server without a `dovi_rpu` bitstream filter does not list
|
||||
`server_dv7_to_hdr10`. A client must not assume a transformation exists because
|
||||
this document names it.
|
||||
|
||||
`enabled` survives from the rollout period and is now constant `true`; the
|
||||
negative shape was deliberately removed before v1 lock because v3 is the only
|
||||
playback protocol. `reason` remains an optional diagnostic for a future
|
||||
non-rollout condition, but it never changes the meaning of `enabled`.
|
||||
|
||||
### 2.2 `POST /playback/start`
|
||||
|
||||
Requests a plan. Auth + `X-Profile-Id` required. Request body cap: **256 KiB**.
|
||||
Body: `StartRequestV3`
|
||||
([`start-request.schema.json`](../design/schemas/playback-v3/v3/start-request.schema.json)).
|
||||
|
||||
| Status | Code | Meaning |
|
||||
| --- | --- | --- |
|
||||
| `201` | — | A decision was made. Body is `DecisionResponseV3`: either `outcome: "playable"` with a `playback_plan`, or `outcome: "adaptation_unavailable"` with a `terminal`. |
|
||||
| `400` | `bad_request` | Malformed JSON, failed validation (the `message` is the validator's own text), missing `X-Profile-Id`, or `profile_id` disagreeing with the header |
|
||||
| `401` | `unauthorized` | No authenticated user |
|
||||
| `404` | `not_found` | `file_id` does not exist, is marked missing, or this profile cannot see it |
|
||||
| `409` | `playback_attempt_reused` | This `playback_attempt_id` was already used for a *different* request |
|
||||
| `426` | `client_upgrade_required` | The body does not declare the finalized v3 shape: `protocol_version: 3` plus both capability evidence markers |
|
||||
| `500` | `internal_error` | Session store failure |
|
||||
|
||||
A file the profile is not allowed to see is `404`, not `403` — parental and
|
||||
library restrictions do not confirm that a hidden item exists.
|
||||
|
||||
The `426` is what a pre-v3 or draft-v3 client gets. There is no protocol negotiation and no
|
||||
fallback: the server decodes v3 or it refuses, and the client is expected to
|
||||
render an "update required" state rather than retry. It is deliberately not a
|
||||
`400` — the request may be perfectly well-formed for the protocol it was written
|
||||
against, and the distinction is what lets a client tell "I sent something wrong"
|
||||
apart from "I am too old to talk to this server".
|
||||
|
||||
Note the layering: a request whose *body* is fine but whose *media* cannot be
|
||||
played is not an HTTP error. It is a `201` with `outcome:
|
||||
"adaptation_unavailable"` and a terminal reason from §7.3. HTTP statuses on this
|
||||
endpoint describe the request; the decision lives in the body.
|
||||
|
||||
**Idempotency.** The server stores each `playback_attempt_id` alongside a
|
||||
SHA-256 digest of the exact request body. Replaying a byte-identical body
|
||||
replays the original response verbatim. Reusing the id with a different body is
|
||||
`409 playback_attempt_reused` — the id is a claim about *which* playback attempt
|
||||
this is, so reusing it for different intent is a client bug the server refuses to
|
||||
paper over. If the attempt is known but its session has since expired, the
|
||||
response is a `201` terminal with reason `session_expired` rather than a replay
|
||||
of a plan that no longer exists.
|
||||
|
||||
Playable and terminal decisions are both durable attempts. A terminal start has
|
||||
no `session_id` or plan identity, but its response and ownership are retained
|
||||
under `playback_attempt_id` for the same TTL. This makes terminal retries obey
|
||||
the same replay/conflict rules and gives terminal route events an addressable
|
||||
authorization record.
|
||||
|
||||
A client generates a fresh `playback_attempt_id` per user-initiated playback and
|
||||
reuses it only to retry a request whose response it did not receive.
|
||||
|
||||
**Omission is a request, not a default.** Two start fields mean "you decide" when
|
||||
absent, and the server answers from stored user state rather than from a
|
||||
constant:
|
||||
|
||||
| Field | Omitted | Present |
|
||||
| --- | --- | --- |
|
||||
| `start_position` | The profile's saved resume point for this item, or `0` when there is none, it is already complete, or the file is one part of a multipart item (every part shares the item's resume point, so a part-local seek to it would land somewhere arbitrary). It is required when `progress_persistence` is `client` | Exactly that position. `0` means *start over* |
|
||||
| `audio_track_id` / `audio_track_index` | The profile's preferred audio track, resolved from the series preference, then the profile's audio-language setting, then the library override | Exactly that track |
|
||||
|
||||
`progress_persistence` separates the live session clock from durable resume
|
||||
ownership. Omission (or `server`) means session progress may update the item's
|
||||
resume/history normally. `client` keeps heartbeats, route diagnostics, and live
|
||||
session state intact but suppresses those durable writes because the client
|
||||
persists its own item-global timeline (for example through `/sync/progress`). A
|
||||
client choosing that mode must send `start_position` explicitly, including
|
||||
explicit `0`; the server never substitutes saved resume state for it.
|
||||
|
||||
Both are settled *before* planning, not after. This is not an implementation
|
||||
detail a client can ignore: the plan's timeline is cut at the start position
|
||||
(§5), and the audio track is part of the plan's identity (§9), so a route chosen
|
||||
for position zero and then seeked is a different route than the one the server
|
||||
would have chosen for the resume point. A client that resolves resume state
|
||||
itself and sends the position explicitly gets identical behaviour — that is the
|
||||
supported way to override the server's policy.
|
||||
|
||||
### 2.3 `POST /playback/{session_id}/replan`
|
||||
|
||||
Asks for a different plan for an existing session — after a failure, or because
|
||||
the user changed a track or the quality. Auth + `X-Profile-Id` required. Request
|
||||
body cap: 256 KiB. Body: `ReplanRequestV3`
|
||||
([`replan-request.schema.json`](../design/schemas/playback-v3/v3/replan-request.schema.json)).
|
||||
|
||||
| Status | Code | Meaning |
|
||||
| --- | --- | --- |
|
||||
| `200` | — | `DecisionResponseV3`, plan or terminal |
|
||||
| `400` | `bad_request` | Malformed or failed validation |
|
||||
| `401` | `unauthorized` | No authenticated user, or no `X-Profile-Id` |
|
||||
| `403` | `forbidden` | The session belongs to another user or profile |
|
||||
| `404` | `playback_session_not_found` | No such session, or its session has ended |
|
||||
| `409` | `stale_playback_plan` | `failed_plan_id` is not the session's current plan, `playback_attempt_id` is not the session's attempt, or a newer replacement is already active |
|
||||
| `409` | `idempotency_key_reused` | This `replan_request_id` was used for a different replan |
|
||||
| `409` | `replan_in_progress` | A replan for this session holds the lease right now |
|
||||
| `503` | `replan_capacity_exhausted` | Server-wide concurrent replan limit (8) reached; retryable |
|
||||
| `500` | `internal_error` | Store outage |
|
||||
|
||||
Note that a missing profile is `401` here, where start answers `400` — start
|
||||
validates the body first and reports the header as one more field problem, while
|
||||
replan treats identity as a precondition. Neither is retryable, so the
|
||||
difference does not change client behaviour.
|
||||
|
||||
Checks run in this order: auth → body decode and validation → concurrency slot →
|
||||
session lock → attempt lookup → ownership → attempt match → live session → lease.
|
||||
A client that sees `503` therefore knows nothing was read or written for its
|
||||
session, and can retry the identical request unchanged. Note that validation
|
||||
comes before every session lookup: a malformed body against a session that does
|
||||
not exist answers `400`, not `404`.
|
||||
|
||||
**Leases.** A replan takes a 15-second lease on the session. A second request
|
||||
carrying the *same* `replan_request_id` while the lease is in flight gets `409
|
||||
replan_in_progress`; once the original completes, the same id replays its
|
||||
response verbatim. This is what makes a client's retry-on-timeout safe.
|
||||
|
||||
Note the deliberate asymmetry with start: a store outage during replan is `500`,
|
||||
never `404`. Clients tear playback down on session-not-found, so a transient
|
||||
store failure must read as retryable rather than as the session having vanished.
|
||||
|
||||
### 2.4 `POST /playback/route-events`
|
||||
|
||||
Reports what happened on the device. Auth + `X-Profile-Id` required. Request body
|
||||
cap: **32 KiB**. Body: a single `RouteEventV3`, not a batch
|
||||
([`route-event.schema.json`](../design/schemas/playback-v3/v3/route-event.schema.json)).
|
||||
|
||||
| Status | Code | Meaning |
|
||||
| --- | --- | --- |
|
||||
| `202` | — | Accepted. **No response body.** |
|
||||
| `400` | `bad_request` | Malformed or failed validation |
|
||||
| `401` | `unauthorized` | No authenticated user or no profile |
|
||||
| `403` | `forbidden` | The session or attempt belongs to another profile, or the referenced session/attempt does not exist |
|
||||
| `429` | `event_rate_limited` | 120 events/attempt/minute or 600/user/minute exceeded |
|
||||
| `500` | `internal_error` | Store outage |
|
||||
|
||||
The checks run in that order: auth, then body decode and validation, then the
|
||||
rate limit, and only then the session-ownership lookup. The
|
||||
limiter sits in front of the ownership lookup deliberately — it exists to bound
|
||||
store reads as much as writes, so it has to precede the read that would establish
|
||||
ownership.
|
||||
|
||||
Two consequences for clients. A `429` means "drop this event," never "retry it";
|
||||
the events are diagnostics and losing one costs nothing. And an unknown session
|
||||
is `403`, not `404` — the handler does not distinguish "not yours" from "not
|
||||
there." A store outage during that lookup is `500`, so a `403` genuinely means
|
||||
the event will never be accepted and should be dropped rather than retried.
|
||||
|
||||
A terminal decision returned by `POST /playback/start` has a durable attempt but
|
||||
no playback session or plan. The client reports it with `event: "terminal"`,
|
||||
the start request's `playback_attempt_id`, and no `session_id`, `plan_id`,
|
||||
`plan_attempt_id`, or `plan_attempt_key`. The server authorizes the event through
|
||||
the persisted attempt ownership and returns `202`.
|
||||
|
||||
Event names are the eleven in §7.4. `diagnostics` is a string→string map, capped
|
||||
at 32 entries, and the server keeps only the keys on its allowlist (§7.5),
|
||||
truncating each value to 256 characters. Unknown keys are dropped silently; a
|
||||
client sending them is not an error, it just achieves nothing.
|
||||
|
||||
---
|
||||
|
||||
## 3. Capability evidence tiers
|
||||
|
||||
The hardest problem in this protocol is that clients lie — not maliciously, but
|
||||
because platform APIs vary in how much they actually know. Android can enumerate
|
||||
`MediaCodecList` and answer "this exact decoder supports H.264 High@4.1 at 8-bit
|
||||
up to 1920×1080@60". A browser can only answer `isTypeSupported("video/mp4;
|
||||
codecs=avc1.640028")` → true. Apple can attest that VideoToolbox handles a codec
|
||||
family but not enumerate levels.
|
||||
|
||||
So a client declares *how it knows*, per media type, and the server applies a
|
||||
different strictness to each tier. `video_evidence` and `audio_evidence` are
|
||||
required and are one of:
|
||||
|
||||
| Tier | Who reports it | What the server does with it |
|
||||
| --- | --- | --- |
|
||||
| `exact` | Android (`MediaCodecList`) | Full strict validation. The server walks `video_decode[]` and requires a hardware entry matching codec, profile, level, bit depth, and every `max_*` bound. Only this tier can earn a validated audio **passthrough** claim. |
|
||||
| `platform_attested` | Apple (VideoToolbox) | Same walk, but profile and level are **skipped** — the platform attests the codec family rather than enumerating modes. All other bounds still apply. |
|
||||
| `declared` | Web (`isTypeSupported`) | Flat list match only: `codecs_video` / `codecs_video_hardware` membership. No `video_decode[]` walk. |
|
||||
|
||||
Four rules follow from the table and are easy to get wrong:
|
||||
|
||||
**A flat claim without backing detail is a refusal, not a pass.** On `exact` and
|
||||
`platform_attested`, if a codec appears in `codecs_video` but no `video_decode[]`
|
||||
entry names that codec with `hardware: true`, the source is *not* eligible for a
|
||||
direct route. The plan is downgraded and carries the decision reason
|
||||
`evidence_insufficient_for_direct` plus the matching degradation warning, which
|
||||
distinguishes "your evidence didn't support this" from "your device said no." A
|
||||
client advertising a strict tier must populate `video_decode[]`; the flat lists
|
||||
alone earn it nothing. On `declared` the flat lists are the whole mechanism, so
|
||||
that tier never produces this signal.
|
||||
|
||||
Note the precise trigger: the signal fires only when *no* entry named the codec.
|
||||
If an entry matched the codec but the source exceeded one of its bounds — a
|
||||
4K file against a `max_height: 1080` decoder — that is a real device limit, and
|
||||
the plan is downgraded with no evidence warning. The two cases mean different
|
||||
things and a client should not conflate them in its telemetry.
|
||||
|
||||
**An omitted bound means "unconstrained", not "unknown".** Within a
|
||||
`video_decode[]` entry, an empty `profiles`, `levels`, or `bit_depths` list and a
|
||||
zero `max_width` / `max_height` / `max_frame_rate` / `max_bitrate_kbps` are each
|
||||
*skipped*, not failed. An entry that names a codec and nothing else therefore
|
||||
claims that decoder handles every variant of it. That is a strong claim, and on
|
||||
`exact` it is the client's job not to make it carelessly: the server will honour
|
||||
it and hand back a direct route. Report what the platform actually enumerated.
|
||||
|
||||
The three list bounds are also not matched the same way, which matters when
|
||||
populating them:
|
||||
|
||||
| Field | Match |
|
||||
| --- | --- |
|
||||
| `profiles` | Case-insensitive string equality against the source profile |
|
||||
| `levels` | **At-least**: any listed level ≥ the source level passes |
|
||||
| `bit_depths` | Exact integer equality |
|
||||
|
||||
So a decoder that tops out at H.264 level 4.1 may report `[41]` and still
|
||||
validate a level-3.0 stream, while a decoder that handles 8- and 10-bit must
|
||||
list both — `[10]` alone rejects an 8-bit source. Levels use the integer form
|
||||
(4.1 → `41`).
|
||||
|
||||
**Every validated video route requires complete routing metadata.** Before any
|
||||
tier logic runs, the server requires video codec, bit depth, width, height,
|
||||
frame rate, and bitrate. Profile and level are decoder bounds instead: an
|
||||
`exact` entry that supplies either bound cannot validate a source whose matching
|
||||
probe value is absent or unknown, while an omitted bound keeps the explicit
|
||||
“unconstrained” meaning above. This permits server adaptation of sources such as
|
||||
VP9 whose probe reports an unknown level without allowing that sentinel to
|
||||
satisfy a concrete client limit. A source missing the routing fields is
|
||||
ineligible for any route and this case is *not* reported as
|
||||
`evidence_insufficient_for_direct` — the client's evidence was never the
|
||||
problem.
|
||||
|
||||
**Passthrough requires `exact` audio evidence.** A validated passthrough claim
|
||||
(bitstreaming E-AC-3/TrueHD to a receiver) additionally requires the
|
||||
`layout_aware_passthrough` feature in `client_features`, the codec listed in
|
||||
`audio_passthrough.passthrough_codecs`, and a matching
|
||||
`audio_passthrough.entries[]` whose `channel_counts` and `layouts` cover the
|
||||
source. Only a client that can enumerate real sink layouts — the Android audio
|
||||
HAL — can supply that. `platform_attested` and `declared` audio evidence still
|
||||
qualify for ordinary decode/copy routes; they simply cannot earn
|
||||
`claims.audio.passthrough = true`.
|
||||
|
||||
**HDR is decided against the output, not the decoder.** `output.hdr_details` (the
|
||||
display or receiver actually attached) takes precedence over
|
||||
`client_capabilities.hdr_details` (what the device could do in principle). A
|
||||
source whose dynamic range is recorded as `hdr_unknown` — legacy rows that only
|
||||
stored a file-level HDR boolean — is treated as HDR10 when the output supports
|
||||
HDR10, and the plan carries the `hdr_range_assumed_hdr10` degradation warning.
|
||||
Refusing to play those outright would be worse than an assumption the client is
|
||||
told about.
|
||||
|
||||
The web client does not promote the generic high-dynamic-range media query to a
|
||||
format claim, and it does not gate format claims on it either. Decoder capability
|
||||
and active-output HDR are separate facts — browsers tone-map HDR content onto SDR
|
||||
outputs, and Safari 26 reports `dynamic-range: standard` even on an XDR display —
|
||||
so the media query survives only as the best-effort `hdr` output boolean. Format
|
||||
claims come from exact shape probes matched to the bytes the remux delivers:
|
||||
HDR10 requires Media Capabilities support for Silo's progressive 2160p HEVC
|
||||
Main10, Rec. 2020, PQ, SMPTE ST 2086 shape, probed under exactly the `hvc1`
|
||||
sample entry because the explicit v3 HDR10 strip remux labels its output `hvc1`
|
||||
(legacy and automatic strip paths retain FFmpeg's default `hev1`). Dolby Vision
|
||||
requires a definitive media-element answer for exactly `dvh1.05.06` or
|
||||
`dvh1.08.06`, because the preserve remux tags its output `dvh1`. An answer only
|
||||
for the other spelling (`hev1`/`dvhe`) is evidence for a file Silo never sends
|
||||
and earns no claim. Both claims are scoped to `progressive`: they
|
||||
are cleared from `original_http` and `hls` because those delivery paths were not
|
||||
tested by the same probe. An HDR10 claim can carry `hdr10_max_width`, `hdr10_max_height`,
|
||||
`hdr10_max_frame_rate`, and `hdr10_max_bitrate_kbps`; these ceilings keep a
|
||||
successful format probe from admitting an untested stream class.
|
||||
|
||||
---
|
||||
|
||||
## 4. Deliveries
|
||||
|
||||
A delivery is *how bytes reach the player*. The server works in four values; the
|
||||
client negotiates in three classes.
|
||||
|
||||
| Server `delivery` | Client class | What it is |
|
||||
| --- | --- | --- |
|
||||
| `original_http` | `original_http` | The source file, byte-for-byte, over HTTP with range support |
|
||||
| `server_remux_progressive` | `progressive` | Repackaged into a new container, streamed as one chunked response |
|
||||
| `server_remux_hls` | `hls` | Repackaged into HLS segments; codecs untouched |
|
||||
| `server_transcode_hls` | `hls` | Re-encoded and segmented |
|
||||
|
||||
`client_playback_context.deliveries` is keyed by **class**, because a client's
|
||||
answer to "can you play HLS" does not differ between a remux and a transcode —
|
||||
the same player component handles both. The server folds its four values into
|
||||
three when checking eligibility, and reports the specific one it chose in the
|
||||
plan.
|
||||
|
||||
Each `deliveries` entry describes one class:
|
||||
|
||||
| Field | Meaning |
|
||||
| --- | --- |
|
||||
| `enabled` | The client is *willing* to use this class right now (user setting, network policy) |
|
||||
| `supported_on_device` | The client is *able* to — the platform has a player for it at all |
|
||||
| `failure_reason` | Optional free text explaining a `false` above; diagnostics only |
|
||||
| `containers`, `video_codecs`, `audio_decode_codecs` | Flat lowercase name lists |
|
||||
| `audio_passthrough_codecs` | Bitstream-out candidates; only ever honoured under the `exact` tier (§3) |
|
||||
| `max_channels` | Optional ceiling applied to audio routing |
|
||||
| `hdr_details` | Optional per-class HDR support, overriding the device-level value |
|
||||
| `subtitles` | Six booleans: `embedded_text`, `sidecar_text`, `ass_styling`, `embedded_bitmap`, `sidecar_bitmap`, `font_attachments` |
|
||||
| `features` | Class-scoped feature strings |
|
||||
| `auth_header_refresh` | The client can re-fetch stream auth headers without restarting playback |
|
||||
| `validated_claims` | Claims the client asserts it has verified for this class |
|
||||
| `transformations` | Client-executed transformations offered for this class (§11) |
|
||||
|
||||
Both booleans must be true for the class to be eligible; they are separate
|
||||
because "the user turned HLS off" and "this device has no HLS player" call for
|
||||
different degradation warnings and different diagnostics. A class the client
|
||||
omits entirely is unavailable — the server will not guess.
|
||||
|
||||
`stream.header_refresh` tells the client what to do when the stream URL's auth
|
||||
expires: `none` means the URL is stable for the session, `session` means
|
||||
re-request headers from `header_refresh_url` rather than restarting playback.
|
||||
|
||||
---
|
||||
|
||||
## 5. The timeline model
|
||||
|
||||
The single most common client bug in v2 was assuming the player's zero and the
|
||||
source's zero are the same instant. In v3 they usually are not, and the plan says
|
||||
so explicitly.
|
||||
|
||||
`timeline` carries four numbers that a client must keep distinct:
|
||||
|
||||
- `source_start_seconds` — where in the *media* this plan begins.
|
||||
- `stream_origin_seconds` — the source position that the *transport's* byte-zero
|
||||
corresponds to.
|
||||
- `player_start_seconds` — where the client should seek the player after load.
|
||||
- `timeline_offset_seconds` — what to add to a player position to get a source
|
||||
position.
|
||||
|
||||
Three shapes exist:
|
||||
|
||||
**Direct and transcoded routes** hand the player a complete timeline.
|
||||
`stream_origin` and `timeline_offset` are `0`, `player_start` is the requested
|
||||
position, `can_seek_anywhere` is true when the runtime is known, and
|
||||
`seek_restoration` is `player_position` — the client seeks locally.
|
||||
|
||||
**Copy remux over HLS** is served from FFmpeg's live, still-growing playlist,
|
||||
which starts at the preceding keyframe selected by FFmpeg's input seek.
|
||||
`stream_origin` and `timeline_offset` both equal that resolved source position,
|
||||
while `player_start` is the requested position minus the resolved origin so the
|
||||
client advances past copied pre-roll. `seek_window_start_seconds` is the resolved
|
||||
origin, and **`seek_window_end_seconds` is deliberately absent**. An open end
|
||||
marks the window as incomplete; combined with `can_seek_anywhere: false` it
|
||||
routes every seek back through the server as a reanchor (§6), which is correct
|
||||
because the playlist has no bytes for positions FFmpeg has not reached yet.
|
||||
`seek_restoration` is `source_position`.
|
||||
|
||||
**Progressive remux** is a freshly generated chunked response with no byte-range
|
||||
support, so it uses the same resolved keyframe origin and player pre-roll offset;
|
||||
the window is open-ended and seeks go through the server.
|
||||
|
||||
### `source.duration_seconds`
|
||||
|
||||
The media's full runtime, and nothing else. Specifically:
|
||||
|
||||
- It is **not** `total − source_start`. It does not shrink because the plan
|
||||
starts mid-file.
|
||||
- It is **not** adjusted by `timeline_offset_seconds`.
|
||||
- It is **omitted** rather than sent as `null` when the server does not know it,
|
||||
because a client coercing `null` to a numeric default would read it as zero.
|
||||
- A client **must not** substitute the playback engine's reported duration for
|
||||
it. On an HLS copy remux the engine reports the length produced so far, not the
|
||||
runtime — using it makes the scrubber grow while the user watches.
|
||||
|
||||
---
|
||||
|
||||
## 6. Replan
|
||||
|
||||
Replan is the only way a plan changes. It covers both "that didn't work" and
|
||||
"the user asked for something else," and the distinction matters to the server.
|
||||
|
||||
`operation` is one of six:
|
||||
|
||||
| Operation | Meaning | Requires |
|
||||
| --- | --- | --- |
|
||||
| `failure_recovery` | The plan failed on the device | `failure.classification` |
|
||||
| `seek_failure_recovery` | A seek failed | `failure.classification` |
|
||||
| `seek_reanchor` | Move a server-anchored timeline to a new position | — |
|
||||
| `track_change` | The user picked a different audio or subtitle track | — |
|
||||
| `quality_change` | The user picked a rung from `available_qualities` | non-empty `quality_preference` |
|
||||
| `output_change` | The active display/output capabilities changed | — |
|
||||
|
||||
The asymmetry is intentional. A seek reanchor is a timeline operation, not a
|
||||
failed recipe — a classification is still accepted from older callers but never
|
||||
selects seek semantics. A track or quality change is not a failure at all, so
|
||||
demanding a classification would force clients to invent one. But
|
||||
`quality_change` *must* name the rung it wants: an empty `quality_preference`
|
||||
normalizes to `auto`, which is a different user intent than the menu selection
|
||||
the operation models, so the server rejects it rather than silently doing
|
||||
something else.
|
||||
|
||||
**Intent operations behave differently from failure recovery.**
|
||||
`track_change`, `quality_change`, and `output_change` keep the previous route
|
||||
eligible because nothing established that its recipe failed: neither attempted-
|
||||
key history nor the failed-plan exclusion applies. The first two replace what
|
||||
were separate v2 endpoints (an audio PATCH and a client-posted transcode start).
|
||||
A client may therefore be handed back a plan it has already tried — that is
|
||||
correct here, and a client must not treat a repeated `plan_attempt_key` as a
|
||||
loop.
|
||||
|
||||
When such an operation actually changes something — the request's tracks,
|
||||
quality, or output capabilities differ from what the session currently has —
|
||||
the server also tries to return to the *requested* edition rather than staying
|
||||
on whatever alternate version a previous fallback landed on, since the newly
|
||||
requested intent may fit the original file again. That is a preference, not a
|
||||
guarantee: if the requested edition no longer resolves or fails its preflight,
|
||||
the healthy active alternate is kept. Track identities are remapped only when
|
||||
the edition really changes, because remapping within one file would degrade an
|
||||
exact selection to a best-match lookup and could silently move a listener off a
|
||||
commentary track.
|
||||
|
||||
Omitting `quality_preference` on any replan preserves the session's current
|
||||
preference; sending it replaces that preference. A track change therefore does
|
||||
not silently reset `original` or a pinned rung, and failure recovery does not
|
||||
discard the viewer's requested quality unless the client explicitly asks it to.
|
||||
Clients should still send the current preference when they know it, so their
|
||||
intent remains explicit in diagnostics.
|
||||
|
||||
For failure recovery, `attempted_plan_keys` is the loop guard. The client sends
|
||||
back every `plan_attempt_key` it has already tried for this attempt (up to 16);
|
||||
the server will not hand back a plan whose key is in that list. `attempt_count`
|
||||
(1–8) bounds the whole recovery chain. Together they mean a device that fails
|
||||
every route reaches a terminal instead of cycling forever.
|
||||
|
||||
Failure, seek, and quality replans may omit unchanged track identities. The
|
||||
server overlays only identities present in those requests and preserves the
|
||||
durable selected subtitle otherwise. Only `operation: "track_change"` gives an
|
||||
omitted `selected_tracks.subtitle` the explicit meaning "subtitles off". A
|
||||
fallback to another media version must remap the selected subtitle; if no
|
||||
equivalent exists, it returns terminal reason `subtitle_unavailable_in_version`
|
||||
instead of silently continuing with subtitles off.
|
||||
|
||||
`local_mutations` (up to 8 entries, 64 chars each) reports client-side
|
||||
adjustments — a transport reopen, a PCM decode fallback — that change the
|
||||
effective route without changing the plan. They feed the attempt key, so a plan
|
||||
retried after a local mutation is a *different* attempt and is not blocked by the
|
||||
loop guard.
|
||||
|
||||
A seek-scoped recovery refuses to accept new capability or device evidence: a
|
||||
seek is not an authority boundary for replacing the client's declared abilities
|
||||
mid-session.
|
||||
|
||||
---
|
||||
|
||||
## 7. Registries
|
||||
|
||||
### 7.1 Decision reasons
|
||||
|
||||
Why the server picked this route. Informational; clients may log or display but
|
||||
must not branch on an unrecognized value.
|
||||
|
||||
`validated_original_playback`, `container_normalization`, `audio_adaptation`,
|
||||
`hls_audio_adaptation`, `hls_packaging_required`, `subtitle_burn_in_required`,
|
||||
`client_dv7_to_dv81`, `client_dv7_to_hdr10`, `evidence_insufficient_for_direct`,
|
||||
and the quality reasons `quality_original`, `quality_auto_source`,
|
||||
`quality_fixed_rung`, `quality_device_limit`, `quality_bandwidth_limit`,
|
||||
`quality_metered_limit`, `quality_bandwidth_cap`.
|
||||
|
||||
### 7.2 Degradation warnings
|
||||
|
||||
The plan will play, but something the user might notice was given up.
|
||||
|
||||
| Code | Meaning |
|
||||
| --- | --- |
|
||||
| `hdr_range_assumed_hdr10` | Source range unknown; treated as HDR10 |
|
||||
| `dolby_vision_removed` | DV metadata stripped |
|
||||
| `dolby_vision_strip_unsupported_by_source` | DV could not be stripped |
|
||||
| `dolby_vision_enhancement_layer_discarded` | FEL/MEL dropped, base layer kept |
|
||||
| `audio_converted` | Audio re-encoded rather than copied |
|
||||
| `subtitle_burn_in` | Subtitles rendered into the video |
|
||||
| `quality_reduction_unavailable` | Requested rung could not be produced |
|
||||
| `quality_preference_normalized` | Unknown `quality_preference` normalized to `auto` |
|
||||
| `bandwidth_cap_applied` | `bandwidth_cap_kbps` limited the selection |
|
||||
| `evidence_insufficient_for_direct` | Evidence tier blocked a direct route |
|
||||
|
||||
### 7.3 Terminal reasons
|
||||
|
||||
Playback will not proceed. `terminal.retryable` says whether trying again could
|
||||
help. Delivered inside a `201` (start) or `200` (replan), never a 4xx.
|
||||
|
||||
*Planner:* `adaptation_exhausted`, `adaptation_unavailable`,
|
||||
`client_hls_unsupported`, `conversion_tool_unavailable`,
|
||||
`hdr_transcode_unsupported`, `no_alternate_version`,
|
||||
`source_metadata_incomplete`, `source_unavailable`,
|
||||
`audio_conversion_unsupported`, `video_conversion_unsupported`,
|
||||
`dv_conversion_unsupported`, `transcoding_disabled`,
|
||||
`subtitle_conversion_unsupported`. When a video adaptation is forced solely by a
|
||||
subtitle burn-in requirement and cannot execute, the terminal is
|
||||
`subtitle_conversion_unsupported` naming the subtitle rather than the underlying
|
||||
HDR, 4K, or transcode-policy reason — deselecting the subtitle restores playback.
|
||||
|
||||
*Subtitle policy:* `subtitle_burn_in_source_unsupported`,
|
||||
`subtitle_codec_unsupported`, `subtitle_track_invalid`,
|
||||
`subtitle_track_unavailable`, `subtitle_unavailable_in_version`.
|
||||
|
||||
*Transport and session:* `internal_error`, `session_expired`,
|
||||
`subtitle_artifact_unavailable`, `capacity_unavailable`,
|
||||
`audio_transcoding_disabled`,
|
||||
`transcode_start_failed`, `transcode_node_unavailable`,
|
||||
`transcode_node_capability_unavailable`, `track_unavailable`,
|
||||
`invalid_seek_position`, `invalid_replan`, `seek_reanchor_route_changed`,
|
||||
`seek_reanchor_recipe_unavailable`,
|
||||
`seek_reanchor_intent_mismatch`, `seek_failure_recovery_intent_mismatch`,
|
||||
`policy_denied`.
|
||||
|
||||
### 7.4 Route event names
|
||||
|
||||
`plan_selected`, `plan_invalidated`, `plan_failed`, `first_frame`, `terminal`,
|
||||
`stopped`, `runtime_correction_applied`, `runtime_correction_succeeded`,
|
||||
`runtime_correction_failed`, `seek_reanchor_requested`, `seek_reanchored`.
|
||||
|
||||
### 7.5 Diagnostics allowlist
|
||||
|
||||
Route-event `diagnostics` keys the server retains. Everything else is dropped;
|
||||
every value is truncated to 256 characters.
|
||||
|
||||
`decoder_name`, `decoder_init_ms`, `first_frame_ms`, `device_model`,
|
||||
`requested_quality`, `effective_quality`, `pcm_recovery`, `retry_outcome`,
|
||||
`replan_request_id`, `video_mime`, `video_codecs`, `video_width`, `video_height`,
|
||||
`color_transfer`, `color_range`, `error_code`, `error_code_name`, `error_cause`,
|
||||
`transformation_name`, `transformation_version`, `transformation_stage`,
|
||||
`input_dv_profile`, `output_dv_profile`, `rpu_converted_count`,
|
||||
`rpu_failed_count`, `el_nal_dropped_count`, `sample_count`,
|
||||
`transform_buffer_peak_bytes`, `requested_media_file_id`,
|
||||
`effective_media_file_id`, `audio_output_mode`, `audio_mime`, `audio_channels`,
|
||||
`audio_decoder_name`, `correction_id`, `correction_stage`, `network_transport`,
|
||||
`network_metered`, `network_validated`, `bandwidth_estimate_kbps`,
|
||||
`link_downstream_kbps`, `target_source_position_seconds`, `reason`.
|
||||
|
||||
---
|
||||
|
||||
## 8. Track identity and the subtitle ordinal space
|
||||
|
||||
Every track is addressed as `file:{media_file_id}:{kind}:{ordinal}` — for
|
||||
example `file:42:audio:0`. When a client sends both an id and an index they must
|
||||
agree; the server rejects a disagreeing pair rather than picking one.
|
||||
|
||||
Subtitles occupy a single **combined ordinal space** spanning three sources, in
|
||||
three dense consecutive ranges:
|
||||
|
||||
1. **External** sidecar files, in catalog order — ordinals `0 … E-1`
|
||||
2. **Embedded** container streams, in container stream order — `E … E+M-1`
|
||||
3. **Downloaded** subtitles, in `created_at` order — `E+M … E+M+D-1`
|
||||
|
||||
The space is dense and gap-free, and this is load-bearing. A track that has no
|
||||
sidecar representation the stream handler can serve — a DVD or DVB bitmap stream
|
||||
— **keeps its ordinal** and is published with `delivery: "burn_in_only"` and no
|
||||
`url`. Omitting it would leave a hole, and any client deriving the
|
||||
downloaded-track base by counting published URLs would then undercount and
|
||||
address the wrong track. (That was a real bug; this rule is the fix.)
|
||||
|
||||
`playback_plan.subtitle.inventory` is the authoritative list. A client selects a
|
||||
track by echoing an entry's `track_id` or `combined_index`. It must never derive
|
||||
an ordinal by counting tracks, summing array lengths, or taking `max(index)+1`.
|
||||
|
||||
Each entry carries `source` (`external` | `embedded` | `downloaded`), `delivery`
|
||||
(`sidecar` | `burn_in_only`), the `forced` / `default` / `hearing_impaired`
|
||||
flags, a `url` when deliverable, and a `font_bundle_url` for embedded ASS tracks
|
||||
with attachments. `default` reflects the source container's own default flag, so
|
||||
only embedded and external tracks can carry it — a downloaded subtitle is never
|
||||
`default`. `url` is present only on `sidecar` tracks, and only once a session
|
||||
exists to scope it to — but it does not depend on the current selection: a start
|
||||
or replan that resolves to `subtitle.mode: "off"` still publishes every sidecar
|
||||
entry with its fetchable `url`, so a client can build its full subtitle menu
|
||||
without first asking for a plan it does not want.
|
||||
|
||||
`subtitle.mode` is `off`, `render` (client draws the sidecar), `convert` (server
|
||||
transcodes it to a client-renderable format first — always to WebVTT, served as
|
||||
`text/vtt` at a `.vtt` URL), or `burn_in` (rendered into the video, which forces
|
||||
a transcode).
|
||||
|
||||
The sidecar URL suffix is part of the representation contract, not decoration.
|
||||
An embedded `hdmv_pgs_subtitle`/PGS sidecar is lossless binary PGS at a `.sup`
|
||||
URL with `application/octet-stream`; cached full-track responses support `HEAD`
|
||||
and byte ranges. Text conversion is always WebVTT at `.vtt`, while lossless
|
||||
ASS/SSA uses `.ass`. A suffix that does not match the selected track or a valid
|
||||
conversion is rejected with `415` rather than returning bytes of a different
|
||||
type under the requested extension.
|
||||
|
||||
---
|
||||
|
||||
## 9. Plan identity
|
||||
|
||||
The server mints both identifiers. **Clients treat both as opaque, case-sensitive
|
||||
tokens and never implement either identity algorithm.** Their wire prefixes and
|
||||
lengths are validation syntax, not a derivation recipe.
|
||||
|
||||
`plan_id` identifies the server's playback decision. It is stable when the same
|
||||
attempt produces the same source, delivery, recipe, tracks, subtitle mode,
|
||||
transformations, applied quirks, and recipe revision. A change to any of those
|
||||
inputs produces a different identity.
|
||||
|
||||
`plan_attempt_key` is the replan loop guard for a plan as attempted on one output
|
||||
route with a set of client-reported local mutations. The server canonicalizes
|
||||
order-insensitive inputs internally. The client:
|
||||
|
||||
1. stores the exact key from `playback_plan.plan_attempt_key`;
|
||||
2. echoes it unchanged as `plan_attempt_key` when reporting that plan;
|
||||
3. adds the unchanged token to `attempted_plan_keys` after the plan fails; and
|
||||
4. never case-folds, parses, truncates, hashes, or synthesizes a replacement.
|
||||
|
||||
`internal/playback/testdata/protocol_v3/attempt_keys.json` contains opaque
|
||||
cross-message vectors: a server-emitted token, the exact replan echo, and the
|
||||
loop-rejection result. The generator computes the server token internally but
|
||||
does not publish its preimage.
|
||||
|
||||
---
|
||||
|
||||
## 10. Quality
|
||||
|
||||
`playback_plan.available_qualities` is the menu. The client renders it and, on
|
||||
selection, sends a `quality_change` replan with the entry's `label`. It does not
|
||||
compute rungs.
|
||||
|
||||
The source rung is always present, labelled `original`, with
|
||||
`preserves_source: true`. Transcode rungs are added only below the source's own
|
||||
height, and only when HLS is available to the client, transcoding is enabled,
|
||||
4K transcoding is permitted for a 4K source, and the source is not HDR. Ladder
|
||||
bitrates:
|
||||
|
||||
| Rung | kbps |
|
||||
| --- | --- |
|
||||
| 2160p | 20000 |
|
||||
| 1080p | 6000 |
|
||||
| 720p | 2000 |
|
||||
| 480p | 1500 |
|
||||
|
||||
Registry availability is deliberately *not* consulted when building the menu: a
|
||||
capability check there could trigger lazy node fetches that a source-preserving
|
||||
start must never pay for. A rung whose toolchain turns out to be missing degrades
|
||||
to a retryable terminal at replan time instead.
|
||||
|
||||
Audio-only sources publish a single `original` rung — quality rungs are a video
|
||||
concept.
|
||||
|
||||
`quality_preference` accepts `auto`, `original` (aliases `source`, `max`), and
|
||||
`2160p` / `1080p` / `720p` / `480p` with the obvious aliases (`4k`, `uhd`, `fhd`,
|
||||
`hd`, `sd`). An unrecognized value normalizes to `auto` and the response carries
|
||||
the `quality_preference_normalized` warning rather than an error.
|
||||
|
||||
---
|
||||
|
||||
## 11. Transformations
|
||||
|
||||
A transformation is a named, versioned media operation with claims attached.
|
||||
|
||||
| Name | Executor | Recipe version | Promises | Claims |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| `audio_to_aac` | `server` | `1` | — | `audio_decode` |
|
||||
| `video_to_h264` | `server` | `2` | `sdr` output | `h264_decode` |
|
||||
| `server_dv7_to_hdr10` | `server` | `1` | `hdr10` output | `dolby_vision_metadata_removed`, `hdr10_base_layer_preserved`, `enhancement_layer_discarded` |
|
||||
|
||||
They are advertised only if the installed FFmpeg actually has the required
|
||||
capability, probed once at startup:
|
||||
|
||||
| Transformation | Probe |
|
||||
| --- | --- |
|
||||
| `server_dv7_to_hdr10` | `ffmpeg -bsfs` contains `dovi_rpu` |
|
||||
| `audio_to_aac` | `ffmpeg -encoders` contains an `aac` encoder |
|
||||
| `video_to_h264` | `ffmpeg -encoders` contains any of `libx264`, `h264_qsv`, `h264_vaapi`, `h264_nvenc`, `h264_videotoolbox` |
|
||||
|
||||
`GET /playback/capability` reports the *local* probe only. A deployment with
|
||||
pooled transcode nodes may still plan an HLS route using a transformation those
|
||||
nodes advertise but the local FFmpeg lacks, so the capability list is a floor,
|
||||
not a ceiling — one more reason a client must not precompute routes from it.
|
||||
|
||||
An unavailable transformation is not silently skipped at plan time: it produces
|
||||
its own terminal reason (`dv_conversion_unsupported`,
|
||||
`audio_conversion_unsupported`, `video_conversion_unsupported`) so the client
|
||||
learns which conversion was missing rather than seeing a generic refusal.
|
||||
|
||||
A client may advertise its *own* transformations in a delivery's
|
||||
`transformations[]` with `executor: "client"` — Dolby Vision profile 7 → 8.1
|
||||
conversion, for instance. The server accepts a client executor only when that
|
||||
delivery is both `enabled` and `supported_on_device` **and** the request's
|
||||
top-level `client_features` includes `client_video_transformations_v1`.
|
||||
Duplicate `executor:name:recipe_version` triples are rejected. Client
|
||||
transformations participate in plan identity exactly like server ones, so a
|
||||
client that changes its transform version invalidates its prior attempt keys —
|
||||
which is the intent.
|
||||
|
||||
---
|
||||
|
||||
## 12. Conformance
|
||||
|
||||
Three artifacts, in decreasing order of authority:
|
||||
|
||||
1. **`internal/playback/testdata/protocol_v3/`** — golden fixtures generated by
|
||||
`cmd/playbackfixtures` from the live server types. `make playback-fixtures`
|
||||
regenerates them; `make verify-playback-fixtures` fails CI if they are stale.
|
||||
Android and Apple CI vendor these and compare against them as **opaque
|
||||
expected output**. The direction of authority is inverted from where this
|
||||
protocol started: the server defines the contract and clients prove
|
||||
conformance, not the reverse. `conformance_matrix.json` covers the release
|
||||
train's evidence tiers, delivery fallback chain, replan operations and
|
||||
idempotency, quality ladder, audio-only route, HDR/Dolby Vision decisions,
|
||||
audio adaptation and exact-layout passthrough, text/bitmap subtitle policy,
|
||||
failure recovery, restart replay, capacity cleanup, output change, route
|
||||
event limits, opaque loop guard, and legacy-upgrade response in one
|
||||
generated cross-client corpus.
|
||||
2. **`docs/design/schemas/playback-v3/`** — JSON Schemas for every wire body,
|
||||
with valid and invalid fixtures. Every bound mirrors a server validator, so a
|
||||
body these schemas reject is a body the server rejects.
|
||||
`internal/playback/contract` enforces that the schemas, the Go types, and the
|
||||
golden fixtures agree.
|
||||
3. **This document** — the reasoning behind the above, and the normative source
|
||||
for anything the schemas cannot express (idempotency semantics, the timeline
|
||||
model, evidence-tier strictness, ordinal density).
|
||||
|
||||
A client that decodes the golden fixtures, echoes attempt keys byte-for-byte,
|
||||
and round-trips a replan without computing an identity is conforming.
|
||||
@@ -515,7 +515,7 @@ ASCII blocks render anywhere.
|
||||
|
||||
```text
|
||||
┌─────────────────────────── CENTRAL (mode=server) ───────────────────────────┐
|
||||
Client │ RequireAuth /playback/start /playback/{sid}/replan (mint token) │
|
||||
Client │ RequireAuth /playback/start /playback/transcode/start (mint token) │
|
||||
(web / android / │ native serve: /playback/transcode/{sid}/master.m3u8?st= /stream/{sid}?st= │
|
||||
apple / jellyfin) │ Admin Stop/Terminate → write session-deny marker (event, not a timer) │
|
||||
└───────────┬──────────────────────────┬───────────────────────┬──────────────┘
|
||||
@@ -564,13 +564,12 @@ sequenceDiagram
|
||||
participant C as Client
|
||||
participant S as Central server (integrated)
|
||||
participant PG as Postgres (access)
|
||||
Note over C,S: start — the plan decides this is a transcode
|
||||
C->>S: POST /playback/start (RequireAuth, protocol_version 3)
|
||||
Note over C,S: transcode start
|
||||
C->>S: POST /playback/transcode/start (RequireAuth)
|
||||
S->>PG: resolve file + access
|
||||
S->>S: PlanPlaybackV3 → delivery = server_transcode_hls
|
||||
S->>S: StartTranscode (ffmpeg) + RegisterTranscodeSession
|
||||
S->>S: card = NewRecipeCard(opts); token = Sign(card.ToClaims(), 24h)
|
||||
S-->>C: 201 plan.url = /playback/transcode/{sid}/master.m3u8?st=TOKEN
|
||||
S-->>C: 202 manifestURL = /playback/transcode/{sid}/master.m3u8?st=TOKEN
|
||||
Note over C,S: hot path — NO Postgres, NO lease (live session in memory)
|
||||
C->>S: GET .../master.m3u8?st=TOKEN
|
||||
S->>S: LoadOrReconstructSession → live hit → BuildPlaybackManifest (segments carry ?st)
|
||||
@@ -600,9 +599,9 @@ sequenceDiagram
|
||||
participant N as Proxy node
|
||||
participant T as Transcode node
|
||||
participant R as Redis
|
||||
C->>S: POST /playback/start (RequireAuth, protocol_version 3)
|
||||
C->>S: POST /playback/transcode/start (RequireAuth)
|
||||
S->>S: card(full recipe, tnode=T); token = Sign(card.ToClaims())
|
||||
S-->>C: plan.url = {N}/stream/transcode/TOKEN/master.m3u8
|
||||
S-->>C: manifestURL = {N}/stream/transcode/TOKEN/master.m3u8
|
||||
loop manifest + segments
|
||||
C->>N: GET /stream/transcode/TOKEN/...
|
||||
N->>N: verifyToken(TOKEN)
|
||||
|
||||
@@ -33,11 +33,6 @@ justification and falls back to the Deprecation/Sunset flow like anything else.
|
||||
|---|---|---|
|
||||
| String `GET`/`PUT`/`DELETE /api/v1/settings…`, the unknown-key extension bag, preference fields on profile/library/series DTOs | Cross-platform settings contract, [design](../superpowers/specs/2026-07-10-cross-platform-user-settings-contract-design.md) | Replaced wholesale by the typed settings contract. Deferring past lock would mean carrying the Deprecation/Sunset surface *and* the untyped key bag — which lets any client invent a production setting the server stores unvalidated — through the deprecation window, which is the exact surface the contract exists to close. |
|
||||
| The ten string-registry admin user-settings routes: `GET /api/v1/admin/users/{id}/settings`, `GET /api/v1/admin/users/{id}/settings/{key}`, `PUT /api/v1/admin/users/{id}/settings/{key}`, `DELETE /api/v1/admin/users/{id}/settings/{key}`, `GET /api/v1/admin/users/{id}/device-settings`, `GET /api/v1/admin/users/{id}/device-settings/{key}`, `DELETE /api/v1/admin/users/{id}/device-settings/{key}`, `PUT /api/v1/admin/users/{id}/profiles/{profile_id}/device-settings/{key}/{device_id}`, `DELETE /api/v1/admin/users/{id}/profiles/{profile_id}/device-settings/{key}/{device_id}`, `DELETE /api/v1/admin/users/{id}/profiles/{profile_id}/devices/{device_id}/settings` | Cross-platform settings contract, [design](../superpowers/specs/2026-07-10-cross-platform-user-settings-contract-design.md) | The admin projection of the removal above: these routes read and wrote the string registry the contract replaces. Their canonical successors are `GET /api/v1/admin/users/{id}/settings/values` (every stored value across all scopes) and `PUT`/`DELETE /api/v1/admin/users/{id}/settings/values/{key}` at an explicit scope, sharing the session routes' validation. Keeping the string routes past lock would preserve an admin-only write path into the untyped bag after the user-facing one closed. |
|
||||
| The legacy (pre-v3) request and response bodies of `POST /api/v1/playback/start`. The route stays; a body that does not declare `protocol_version: 3` now gets `426 client_upgrade_required` instead of a legacy plan | Playback protocol v3, [spec](playback-protocol-v3.md), [plan](../superpowers/plans/2026-07-30-playback-protocol-v3-neutral-contract.md) | v3 is a platform-neutral contract that moves route selection, quality laddering and track choice server-side. The legacy body carried the opposite model — the client posted a decision it had already made. Running both means every planner change has to be made twice, in two shapes that disagree about who decides, and the legacy shape is the one the client-specific bugs live in. A deprecation window would extend that duplication across the whole window for a protocol no shipping client will still speak by lock. |
|
||||
| `POST /api/v1/playback/transcode/start` | Playback protocol v3, [spec](playback-protocol-v3.md) | Client-posted transcode recipes. Superseded by the `quality_change` replan operation: the client sends a label from `playback_plan.available_qualities` and the server picks the encode. Keeping the endpoint keeps a second, unvalidated way to start a transcode that bypasses plan identity entirely. |
|
||||
| `PATCH /api/v1/playback/{session_id}/audio` | Playback protocol v3, [spec](playback-protocol-v3.md) | Superseded by the `track_change` replan operation, which changes the audio track *and* returns the resulting plan. The PATCH mutated the session without re-planning, so a track change that invalidated the route left the client playing a plan the server no longer agreed with. |
|
||||
| `409 protocol_disabled` on `POST /api/v1/playback/route-events`, and the `"enabled": false` shape of `GET /api/v1/playback/capability` | Playback protocol v3, [spec](playback-protocol-v3.md) | Both described a server with v3 switched off. With v3 the only playback protocol that state cannot exist — "disabled" would mean "no playback at all". The `enabled` field itself is kept and is constant `true`, so clients that feature-detect against it keep working; only the negative shape and the status code go. |
|
||||
| The draft-v3 platform-specific wire vocabulary: `ClientPlaybackContextV3.features`, `.platform`, and `.engines`; `PlanV3.engine`; `output_route_generation` in start, replan, output-context, and route-event bodies; Android device/build fields (`brand`, `device`, `product`, `soc_*`, `build_*`, `security_patch`, `sdk_int`, `abis`); and the `media3_only` / `detailed_decode_capabilities` feature tokens | Platform-neutral playback protocol v3, [spec](playback-protocol-v3.md), [plan](../superpowers/plans/2026-07-30-playback-protocol-v3-neutral-contract.md) | These names exposed one client's implementation as the cross-platform contract. Before v1 lock they are replaced by neutral delivery classes, evidence tiers, `device.platform` / `device.os_version` / bounded `platform_details`, opaque `output_context_id`, and top-level feature advertisement. Carrying both drafts through lock would force every client to translate Media3-specific aliases indefinitely and leave two conflicting sources of capability truth. |
|
||||
|
||||
Feature-detection precedent: clients discover which metadata providers (including the
|
||||
built-in NFO provider, #216) apply to a library type via
|
||||
|
||||
@@ -361,7 +361,7 @@ Borrows the *behavior* of the requests gate (status endpoint + per-call
|
||||
guard that rereads settings) but stores keys in the general `server_settings`
|
||||
store — requests uses its own dedicated table, which diagnostics doesn't
|
||||
need. Key naming follows existing namespaces (`opslog.*`,
|
||||
`audiobooks.enabled`, `playback.*`):
|
||||
`audiobooks.enabled`, `playback.protocol_v3_enabled`):
|
||||
|
||||
- `diagnostics.uploads_enabled` (bool, default `false`)
|
||||
- `diagnostics.max_bundle_bytes` (default 10 MiB compressed)
|
||||
|
||||
@@ -39,22 +39,6 @@
|
||||
"audio_underruns": {
|
||||
"type": "integer",
|
||||
"description": "Audio underrun count."
|
||||
},
|
||||
"session_id": {
|
||||
"type": "string",
|
||||
"description": "Playback session identifier for correlation with operational logs."
|
||||
},
|
||||
"play_method": {
|
||||
"type": "string",
|
||||
"description": "Selected playback delivery method such as direct, remux, or transcode."
|
||||
},
|
||||
"reason": {
|
||||
"type": "string",
|
||||
"description": "Playback route, interruption, or lifecycle reason."
|
||||
},
|
||||
"position_ms": {
|
||||
"type": "integer",
|
||||
"description": "Current playback position in milliseconds."
|
||||
}
|
||||
},
|
||||
"focus": {
|
||||
@@ -83,44 +67,12 @@
|
||||
"duration_ms": {
|
||||
"type": "integer",
|
||||
"description": "Request duration in milliseconds."
|
||||
},
|
||||
"outcome": {
|
||||
"type": "string",
|
||||
"description": "Request outcome such as success, http_error, transport_error, or cancelled."
|
||||
},
|
||||
"error_code": {
|
||||
"type": "string",
|
||||
"description": "Stable error classification for a failed request."
|
||||
},
|
||||
"attempt": {
|
||||
"type": "integer",
|
||||
"description": "Attempt ordinal for a retried request."
|
||||
}
|
||||
},
|
||||
"lifecycle": {
|
||||
"state": {
|
||||
"type": "string",
|
||||
"description": "App lifecycle state."
|
||||
},
|
||||
"phase": {
|
||||
"type": "string",
|
||||
"description": "Startup or lifecycle phase identifier."
|
||||
},
|
||||
"duration_ms": {
|
||||
"type": "integer",
|
||||
"description": "Elapsed duration for the phase in milliseconds."
|
||||
},
|
||||
"outcome": {
|
||||
"type": "string",
|
||||
"description": "Result of the phase, such as success, failure, or skipped."
|
||||
},
|
||||
"reason": {
|
||||
"type": "string",
|
||||
"description": "Classification for the phase outcome."
|
||||
},
|
||||
"launch_type": {
|
||||
"type": "string",
|
||||
"description": "Launch classification, such as cold or warm."
|
||||
}
|
||||
},
|
||||
"crash": {
|
||||
|
||||
@@ -1,8 +0,0 @@
|
||||
The canonical playback protocol v3 wire contract lives in `v3/`.
|
||||
Clients vendor the schema files and fixtures from this directory; each schema is self-contained and refers only to its own `$defs`, so a client can vendor one body at a time.
|
||||
The wire fixtures under `v3/fixtures/valid/` are copies of the matching server-generated golden bodies in `internal/playback/testdata/protocol_v3/`; treat them as opaque expected output rather than hand-edited examples, and regenerate them from the server rather than editing them in place. The golden directory also contains non-wire cross-message fixtures such as `attempt_keys.json`, `subtitle_inventory.json`, and `conformance_matrix.json`; clients vendor those directly from the generator output.
|
||||
`error-response.schema.json` describes the common non-2xx envelope; its golden fixture is the exact `426 client_upgrade_required` response to a legacy start body.
|
||||
Every bound in these schemas mirrors a server validator, so a body this directory rejects is a body the server rejects.
|
||||
Identity fields the server computes — `plan_id`, `plan_attempt_key` — are opaque to clients: store them, echo them back on replan and route events, and never parse or recompute them.
|
||||
Within v3, changes are additive only: new optional fields, and new enum values after coordinated client support.
|
||||
Breaking changes require a new versioned contract directory and explicit server support.
|
||||
@@ -1,123 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://silo-server.dev/schemas/playback-v3/v3/capability-response.schema.json",
|
||||
"title": "Silo Playback Protocol v3 Capability Response",
|
||||
"description": "Response body of GET /api/v1/playback/capability, mirroring CapabilityResponseV3 in internal/playback/protocol_v3.go. A client reads this before its first start request so it plans against what the server actually advertises instead of a compiled-in assumption. Protocol v3 is the server's only playback protocol, so enabled is always true; there is no disabled response shape.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"enabled",
|
||||
"protocol_versions",
|
||||
"features",
|
||||
"deliveries",
|
||||
"transformations"
|
||||
],
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean",
|
||||
"const": true
|
||||
},
|
||||
"protocol_versions": {
|
||||
"type": "array",
|
||||
"description": "Protocol versions this server speaks. A client picks the highest it supports rather than assuming a single value, which is what keeps a future v4 from breaking v3 clients.",
|
||||
"minItems": 1,
|
||||
"uniqueItems": true,
|
||||
"contains": {
|
||||
"const": 3
|
||||
},
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"features": {
|
||||
"type": "array",
|
||||
"description": "Server feature flags. The list grows additively within v3, so an unrecognized entry is expected and must be ignored, not treated as an error.",
|
||||
"minItems": 8,
|
||||
"uniqueItems": true,
|
||||
"allOf": [
|
||||
{ "contains": { "const": "playback_plan_v3" } },
|
||||
{ "contains": { "const": "neutral_playback_v3_contract_v1" } },
|
||||
{ "contains": { "const": "layout_aware_passthrough" } },
|
||||
{ "contains": { "const": "playback_route_diagnostics" } },
|
||||
{ "contains": { "const": "device_quirks_v1" } },
|
||||
{ "contains": { "const": "seek_reanchor_v1" } },
|
||||
{ "contains": { "const": "direct_stream_resume_v1" } },
|
||||
{ "contains": { "const": "plan_source_duration_v1" } }
|
||||
],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"deliveries": {
|
||||
"type": "array",
|
||||
"description": "Serving routes the planner may return. The list contains the server's currently executable delivery classes and grows additively.",
|
||||
"minItems": 4,
|
||||
"uniqueItems": true,
|
||||
"allOf": [
|
||||
{ "contains": { "const": "original_http" } },
|
||||
{ "contains": { "const": "server_remux_progressive" } },
|
||||
{ "contains": { "const": "server_remux_hls" } },
|
||||
{ "contains": { "const": "server_transcode_hls" } }
|
||||
],
|
||||
"items": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"original_http",
|
||||
"server_remux_progressive",
|
||||
"server_remux_hls",
|
||||
"server_transcode_hls"
|
||||
]
|
||||
}
|
||||
},
|
||||
"transformations": {
|
||||
"type": "array",
|
||||
"description": "Server-executed transformations available to the planner. Client-executed transformations are declared by the client in its start request, not listed here.",
|
||||
"items": {
|
||||
"$ref": "#/$defs/transformation"
|
||||
}
|
||||
},
|
||||
"reason": {
|
||||
"type": "string",
|
||||
"description": "Reserved optional diagnostic for a future non-rollout condition. It does not disable protocol v3; enabled remains true."
|
||||
}
|
||||
},
|
||||
"$defs": {
|
||||
"transformation": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"name",
|
||||
"executor",
|
||||
"recipe_version",
|
||||
"validated_claims"
|
||||
],
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"maxLength": 64
|
||||
},
|
||||
"executor": {
|
||||
"type": "string",
|
||||
"description": "Capability responses advertise transformations installed on the server. Client-executed transformations are declared in requests instead.",
|
||||
"const": "server"
|
||||
},
|
||||
"recipe_version": {
|
||||
"type": "string",
|
||||
"description": "Identity of the recipe, not a semantic version to compare. A client matches it exactly or declines the transformation.",
|
||||
"minLength": 1,
|
||||
"maxLength": 32
|
||||
},
|
||||
"validated_claims": {
|
||||
"type": "array",
|
||||
"description": "Neutral statements about the bytes the transformation produces, so a client reasons about the output without knowing the server's toolchain.",
|
||||
"maxItems": 32,
|
||||
"items": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
}
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
@@ -1,798 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://silo-server.dev/schemas/playback-v3/v3/decision-response.schema.json",
|
||||
"title": "Silo Playback Protocol v3 Decision Response",
|
||||
"description": "Response body of POST /api/v1/playback/start and POST /api/v1/playback/{session_id}/replan. Shapes mirror DecisionResponseV3 and PlanV3 in internal/playback/protocol_v3.go. A playable outcome carries playback_plan; adaptation_unavailable carries terminal. Enum lists are the values the server emits today and grow additively within v3, so a client must tolerate an unrecognized member of a described-but-open list rather than treating the plan as unusable.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"protocol_version",
|
||||
"server_features",
|
||||
"outcome"
|
||||
],
|
||||
"properties": {
|
||||
"protocol_version": {
|
||||
"type": "integer",
|
||||
"const": 3
|
||||
},
|
||||
"server_features": {
|
||||
"type": "array",
|
||||
"description": "Additive feature tokens supported by this server. Unknown entries must be ignored.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"outcome": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"playable",
|
||||
"adaptation_unavailable"
|
||||
]
|
||||
},
|
||||
"session_id": {
|
||||
"type": "string"
|
||||
},
|
||||
"playback_plan": {
|
||||
"$ref": "#/$defs/plan"
|
||||
},
|
||||
"terminal": {
|
||||
"$ref": "#/$defs/terminal"
|
||||
}
|
||||
},
|
||||
"oneOf": [
|
||||
{
|
||||
"properties": {
|
||||
"outcome": {
|
||||
"const": "playable"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"session_id",
|
||||
"playback_plan"
|
||||
],
|
||||
"not": {
|
||||
"required": [
|
||||
"terminal"
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"properties": {
|
||||
"outcome": {
|
||||
"const": "adaptation_unavailable"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"terminal"
|
||||
],
|
||||
"allOf": [
|
||||
{
|
||||
"not": {
|
||||
"required": [
|
||||
"session_id"
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"not": {
|
||||
"required": [
|
||||
"playback_plan"
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"$defs": {
|
||||
"terminal": {
|
||||
"type": "object",
|
||||
"description": "Why no route exists. `retryable` distinguishes a condition that may clear (a missing toolchain, incomplete metadata) from one that will not for this client and source.",
|
||||
"required": [
|
||||
"reason",
|
||||
"message",
|
||||
"retryable"
|
||||
],
|
||||
"properties": {
|
||||
"reason": {
|
||||
"type": "string",
|
||||
"minLength": 1
|
||||
},
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"retryable": {
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"track_identity": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"id"
|
||||
],
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"description": "Combined-ordinal track identity `file:{file_id}:{audio|subtitle}:{ordinal}`."
|
||||
},
|
||||
"index": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"transformation": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"name",
|
||||
"executor",
|
||||
"recipe_version",
|
||||
"validated_claims"
|
||||
],
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"minLength": 1
|
||||
},
|
||||
"executor": {
|
||||
"type": "string",
|
||||
"description": "Who runs it: `server` before the bytes leave the server, `client` as the client's own responsibility.",
|
||||
"enum": [
|
||||
"client",
|
||||
"server"
|
||||
]
|
||||
},
|
||||
"recipe_version": {
|
||||
"type": "string",
|
||||
"minLength": 1
|
||||
},
|
||||
"validated_claims": {
|
||||
"type": "array",
|
||||
"description": "Neutral statements about the produced bytes, not client-framework decoder names.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"plan": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"protocol_version",
|
||||
"plan_id",
|
||||
"plan_attempt_key",
|
||||
"delivery",
|
||||
"stream",
|
||||
"timeline",
|
||||
"selected_tracks",
|
||||
"effective_recipe",
|
||||
"claims",
|
||||
"subtitle",
|
||||
"transformations",
|
||||
"applied_quirks",
|
||||
"runtime_corrections",
|
||||
"available_qualities",
|
||||
"degradation_warnings",
|
||||
"decision_reason",
|
||||
"requested_media_file_id",
|
||||
"effective_media_file_id",
|
||||
"source",
|
||||
"subtitle_fidelity_policy"
|
||||
],
|
||||
"properties": {
|
||||
"protocol_version": {
|
||||
"type": "integer",
|
||||
"const": 3
|
||||
},
|
||||
"plan_id": {
|
||||
"type": "string",
|
||||
"description": "Deterministic server-computed plan identity, `plan:` followed by 32 hex characters. Opaque to clients: echo it, never parse or recompute it.",
|
||||
"pattern": "^plan:[0-9a-f]{32}$"
|
||||
},
|
||||
"plan_attempt_key": {
|
||||
"type": "string",
|
||||
"description": "Server-computed opaque loop-prevention token, always `v3:` prefixed. Clients store the keys of attempted plans and echo them in attempted_plan_keys on replan; they never compute keys themselves.",
|
||||
"pattern": "^v3:",
|
||||
"minLength": 8
|
||||
},
|
||||
"session_id": {
|
||||
"type": "string"
|
||||
},
|
||||
"expires_at": {
|
||||
"type": "string",
|
||||
"format": "date-time"
|
||||
},
|
||||
"delivery": {
|
||||
"type": "string",
|
||||
"description": "The plan's serving route. Clients negotiate the coarser delivery classes (original_http, progressive, hls); these are the finer-grained plan outcomes those classes fold onto.",
|
||||
"enum": [
|
||||
"original_http",
|
||||
"server_remux_progressive",
|
||||
"server_remux_hls",
|
||||
"server_transcode_hls"
|
||||
]
|
||||
},
|
||||
"stream": {
|
||||
"$ref": "#/$defs/stream"
|
||||
},
|
||||
"timeline": {
|
||||
"$ref": "#/$defs/timeline"
|
||||
},
|
||||
"selected_tracks": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"audio": {
|
||||
"$ref": "#/$defs/track_identity"
|
||||
},
|
||||
"subtitle": {
|
||||
"$ref": "#/$defs/track_identity"
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"effective_recipe": {
|
||||
"$ref": "#/$defs/effective_recipe"
|
||||
},
|
||||
"claims": {
|
||||
"$ref": "#/$defs/claims"
|
||||
},
|
||||
"subtitle": {
|
||||
"$ref": "#/$defs/subtitle_decision"
|
||||
},
|
||||
"transformations": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/$defs/transformation"
|
||||
}
|
||||
},
|
||||
"applied_quirks": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/$defs/applied_quirk"
|
||||
}
|
||||
},
|
||||
"runtime_corrections": {
|
||||
"type": "array",
|
||||
"description": "Client-executed corrections this plan depends on. A client that cannot run a listed correction must not select the plan.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"available_qualities": {
|
||||
"type": "array",
|
||||
"description": "Server ladder rungs valid for this source and client, so a client renders a quality menu without owning a bitrate table. The entry with preserves_source true pins the source rung.",
|
||||
"minItems": 1,
|
||||
"contains": {
|
||||
"type": "object",
|
||||
"required": ["label", "preserves_source"],
|
||||
"properties": {
|
||||
"label": { "const": "original" },
|
||||
"preserves_source": { "const": true }
|
||||
}
|
||||
},
|
||||
"items": {
|
||||
"$ref": "#/$defs/available_quality"
|
||||
}
|
||||
},
|
||||
"degradation_warnings": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/$defs/degradation_warning"
|
||||
}
|
||||
},
|
||||
"decision_reason": {
|
||||
"type": "string",
|
||||
"minLength": 1
|
||||
},
|
||||
"requested_media_file_id": {
|
||||
"type": "integer",
|
||||
"minimum": 1
|
||||
},
|
||||
"effective_media_file_id": {
|
||||
"type": "integer",
|
||||
"minimum": 1,
|
||||
"description": "Differs from requested_media_file_id when the server routed to an alternate edition of the same title. Track identities in this plan belong to the effective file."
|
||||
},
|
||||
"source": {
|
||||
"$ref": "#/$defs/source_descriptor"
|
||||
},
|
||||
"subtitle_fidelity_policy": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"require_authored_fidelity",
|
||||
"allow_simplified_rendering"
|
||||
]
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"stream": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"url",
|
||||
"protocol",
|
||||
"headers",
|
||||
"header_refresh"
|
||||
],
|
||||
"properties": {
|
||||
"url": {
|
||||
"type": "string",
|
||||
"minLength": 1
|
||||
},
|
||||
"protocol": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"http_progressive",
|
||||
"hls"
|
||||
]
|
||||
},
|
||||
"container": {
|
||||
"type": "string"
|
||||
},
|
||||
"mime_type": {
|
||||
"type": "string",
|
||||
"description": "What the transport will actually serve. A declared-tier client probes this before attaching a source buffer, so an audio-only remux advertises audio/mp4 rather than video/mp4."
|
||||
},
|
||||
"headers": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"header_refresh": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"none",
|
||||
"session"
|
||||
]
|
||||
},
|
||||
"header_refresh_url": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"timeline": {
|
||||
"type": "object",
|
||||
"description": "Anchoring for the delivered stream. source_start_seconds is the position in the source, player_start_seconds where the player should start within the delivered timeline; the two differ when the stream is re-anchored at a seek point.",
|
||||
"required": [
|
||||
"source_start_seconds",
|
||||
"stream_origin_seconds",
|
||||
"player_start_seconds",
|
||||
"timeline_offset_seconds",
|
||||
"can_seek_anywhere",
|
||||
"seek_restoration"
|
||||
],
|
||||
"properties": {
|
||||
"source_start_seconds": {
|
||||
"type": "number"
|
||||
},
|
||||
"stream_origin_seconds": {
|
||||
"type": "number"
|
||||
},
|
||||
"player_start_seconds": {
|
||||
"type": "number"
|
||||
},
|
||||
"timeline_offset_seconds": {
|
||||
"type": "number"
|
||||
},
|
||||
"seek_window_start_seconds": {
|
||||
"type": "number"
|
||||
},
|
||||
"seek_window_end_seconds": {
|
||||
"type": "number"
|
||||
},
|
||||
"can_seek_anywhere": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"seek_restoration": {
|
||||
"type": "string",
|
||||
"description": "Which clock a resume position is expressed in: `player_position` for a full-timeline stream, `source_position` for one re-anchored at a seek point.",
|
||||
"enum": [
|
||||
"player_position",
|
||||
"source_position"
|
||||
]
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"effective_recipe": {
|
||||
"type": "object",
|
||||
"description": "What the delivered bytes actually are, after any adaptation. Fields the server has no value for are omitted rather than sent as zero.",
|
||||
"properties": {
|
||||
"video_codec": {
|
||||
"type": "string"
|
||||
},
|
||||
"audio_codec": {
|
||||
"type": "string"
|
||||
},
|
||||
"width": {
|
||||
"type": "integer"
|
||||
},
|
||||
"height": {
|
||||
"type": "integer"
|
||||
},
|
||||
"frame_rate": {
|
||||
"type": "number"
|
||||
},
|
||||
"bitrate_kbps": {
|
||||
"type": "integer"
|
||||
},
|
||||
"dynamic_range": {
|
||||
"type": "string"
|
||||
},
|
||||
"audio_channels": {
|
||||
"type": "integer"
|
||||
},
|
||||
"audio_layout": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"claims": {
|
||||
"type": "object",
|
||||
"description": "What the server promises about the delivered bytes. A client renders its HDR/passthrough/subtitle affordances from these rather than re-deriving them from the source descriptor.",
|
||||
"required": [
|
||||
"video",
|
||||
"audio",
|
||||
"subtitles"
|
||||
],
|
||||
"properties": {
|
||||
"video": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"hdr10",
|
||||
"hdr10_plus",
|
||||
"hlg",
|
||||
"dolby_vision"
|
||||
],
|
||||
"properties": {
|
||||
"hdr10": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"hdr10_plus": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"hlg": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"dolby_vision": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"dolby_vision_reason": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"audio": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"passthrough",
|
||||
"atmos_preserved"
|
||||
],
|
||||
"properties": {
|
||||
"codec": {
|
||||
"type": "string"
|
||||
},
|
||||
"passthrough": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"atmos_preserved": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"dts_variant": {
|
||||
"type": "string"
|
||||
},
|
||||
"reason": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"subtitles": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"ass_styling_preserved",
|
||||
"bitmap_overlay",
|
||||
"bitmap_sidecar"
|
||||
],
|
||||
"properties": {
|
||||
"ass_styling_preserved": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"bitmap_overlay": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"bitmap_sidecar": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"reason": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"subtitle_decision": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"mode",
|
||||
"inventory"
|
||||
],
|
||||
"properties": {
|
||||
"mode": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"off",
|
||||
"render",
|
||||
"convert",
|
||||
"burn_in"
|
||||
]
|
||||
},
|
||||
"track_id": {
|
||||
"type": "string"
|
||||
},
|
||||
"artifact": {
|
||||
"type": "object",
|
||||
"description": "The prepared sidecar for the selected track. timing_origin_seconds is the source position the artifact's cue timestamps are relative to.",
|
||||
"required": [
|
||||
"url",
|
||||
"mime_type",
|
||||
"format",
|
||||
"timing_origin_seconds"
|
||||
],
|
||||
"properties": {
|
||||
"url": {
|
||||
"type": "string",
|
||||
"minLength": 1
|
||||
},
|
||||
"mime_type": {
|
||||
"type": "string"
|
||||
},
|
||||
"format": {
|
||||
"type": "string"
|
||||
},
|
||||
"timing_origin_seconds": {
|
||||
"type": "number"
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"inventory": {
|
||||
"type": "array",
|
||||
"description": "Authoritative, dense, gap-free combined-ordinal track list for the effective source: external tracks first, then embedded, then downloaded. A client selects by echoing an entry's track_id or combined_index and never derives an ordinal by counting, summing track arrays, or taking max(index)+1.",
|
||||
"items": {
|
||||
"$ref": "#/$defs/subtitle_inventory_item"
|
||||
}
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"subtitle_inventory_item": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"track_id",
|
||||
"combined_index",
|
||||
"source",
|
||||
"forced",
|
||||
"default",
|
||||
"hearing_impaired",
|
||||
"delivery"
|
||||
],
|
||||
"properties": {
|
||||
"track_id": {
|
||||
"type": "string",
|
||||
"minLength": 1
|
||||
},
|
||||
"combined_index": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"source": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"external",
|
||||
"embedded",
|
||||
"downloaded"
|
||||
]
|
||||
},
|
||||
"codec": {
|
||||
"type": "string"
|
||||
},
|
||||
"language": {
|
||||
"type": "string"
|
||||
},
|
||||
"label": {
|
||||
"type": "string"
|
||||
},
|
||||
"forced": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"default": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"hearing_impaired": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"delivery": {
|
||||
"type": "string",
|
||||
"description": "`sidecar` tracks are fetchable from their published url. A `burn_in_only` track has no client-fetchable representation and carries no url, but still occupies its ordinal and stays selectable — omitting it would leave a hole that makes every later ordinal wrong.",
|
||||
"enum": [
|
||||
"sidecar",
|
||||
"burn_in_only"
|
||||
]
|
||||
},
|
||||
"url": {
|
||||
"type": "string"
|
||||
},
|
||||
"font_bundle_url": {
|
||||
"type": "string",
|
||||
"description": "Attachment bundle needed to render an embedded ASS/SSA track with its authored typesetting."
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"applied_quirk": {
|
||||
"type": "object",
|
||||
"description": "A device-specific decision the planner made on top of the generic route. registry_revision identifies the quirk registry the decision came from.",
|
||||
"required": [
|
||||
"id",
|
||||
"registry_revision",
|
||||
"action"
|
||||
],
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"maxLength": 128
|
||||
},
|
||||
"registry_revision": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
},
|
||||
"action": {
|
||||
"type": "string"
|
||||
},
|
||||
"reason": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"available_quality": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"label",
|
||||
"preserves_source"
|
||||
],
|
||||
"properties": {
|
||||
"label": {
|
||||
"type": "string",
|
||||
"minLength": 1
|
||||
},
|
||||
"height": {
|
||||
"type": "integer"
|
||||
},
|
||||
"bitrate_kbps": {
|
||||
"type": "integer"
|
||||
},
|
||||
"preserves_source": {
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"degradation_warning": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"code",
|
||||
"message"
|
||||
],
|
||||
"properties": {
|
||||
"code": {
|
||||
"type": "string",
|
||||
"minLength": 1
|
||||
},
|
||||
"message": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"source_descriptor": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"media_file_id",
|
||||
"hdr10_plus",
|
||||
"dv_enhancement_layer"
|
||||
],
|
||||
"properties": {
|
||||
"media_file_id": {
|
||||
"type": "integer",
|
||||
"minimum": 1
|
||||
},
|
||||
"duration_seconds": {
|
||||
"type": "number",
|
||||
"description": "Full runtime of this source, independent of where the delivery's timeline is anchored. Absent means the server does not know the runtime; it is omitted rather than null so clients that coerce null to a numeric default do not read it as zero. Do not substitute the playback engine's reported duration — on an HLS copy remux the engine reports the length produced so far."
|
||||
},
|
||||
"container": {
|
||||
"type": "string"
|
||||
},
|
||||
"video_codec": {
|
||||
"type": "string"
|
||||
},
|
||||
"video_profile": {
|
||||
"type": "string"
|
||||
},
|
||||
"video_level": {
|
||||
"type": "integer"
|
||||
},
|
||||
"bit_depth": {
|
||||
"type": "integer"
|
||||
},
|
||||
"color_range": {
|
||||
"type": "string"
|
||||
},
|
||||
"width": {
|
||||
"type": "integer"
|
||||
},
|
||||
"height": {
|
||||
"type": "integer"
|
||||
},
|
||||
"frame_rate": {
|
||||
"type": "number"
|
||||
},
|
||||
"bitrate_kbps": {
|
||||
"type": "integer"
|
||||
},
|
||||
"dynamic_range": {
|
||||
"type": "string",
|
||||
"description": "Values the server emits today: sdr, hdr10, hdr10_plus, hlg, dolby_vision, and hdr_unknown for legacy rows that recorded only a file-level HDR flag."
|
||||
},
|
||||
"hdr10_plus": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"dolby_vision_profile": {
|
||||
"type": "integer"
|
||||
},
|
||||
"dolby_vision_level": {
|
||||
"type": "integer",
|
||||
"minimum": 1,
|
||||
"maximum": 13
|
||||
},
|
||||
"dv_bl_compat_id": {
|
||||
"type": "integer"
|
||||
},
|
||||
"dv_enhancement_layer": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"none",
|
||||
"mel",
|
||||
"fel",
|
||||
"unknown"
|
||||
]
|
||||
},
|
||||
"audio_codec": {
|
||||
"type": "string"
|
||||
},
|
||||
"audio_channels": {
|
||||
"type": "integer"
|
||||
},
|
||||
"audio_layout": {
|
||||
"type": "string"
|
||||
},
|
||||
"video_copy_unsafe": {
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
@@ -1,22 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://silo-server.dev/schemas/playback-v3/v3/error-response.schema.json",
|
||||
"title": "Silo Playback Protocol v3 Error Response",
|
||||
"description": "Common non-2xx response body for playback-v3 endpoints. Clients branch on error and may display message. The valid fixture pins the 426 response returned to a legacy start body.",
|
||||
"type": "object",
|
||||
"required": ["error", "message"],
|
||||
"properties": {
|
||||
"error": {
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"maxLength": 64,
|
||||
"pattern": "^[a-z][a-z0-9_]*$"
|
||||
},
|
||||
"message": {
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"maxLength": 1024
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
-113
@@ -1,113 +0,0 @@
|
||||
{
|
||||
"protocol_version": 3,
|
||||
"client_features": [
|
||||
"playback_plan_v3"
|
||||
],
|
||||
"operation": "failure_recovery",
|
||||
"playback_attempt_id": "attempt-golden-0001",
|
||||
"replan_request_id": "replan-golden-0001",
|
||||
"failed_plan_id": "plan:golden-0001",
|
||||
"plan_attempt_id": "plan-attempt-golden-0001",
|
||||
"plan_attempt_key": "v3:0000000000000001",
|
||||
"attempted_plan_keys": [
|
||||
"v3:0000000000000001"
|
||||
],
|
||||
"attempt_count": 9,
|
||||
"quality_preference": "auto",
|
||||
"position_seconds": 42.5,
|
||||
"metered": true,
|
||||
"bandwidth_estimate_kbps": 3500,
|
||||
"bandwidth_cap_kbps": 4000,
|
||||
"selected_tracks": {
|
||||
"audio": {
|
||||
"id": "file:42:audio:0",
|
||||
"index": 0
|
||||
}
|
||||
},
|
||||
"failure": {
|
||||
"classification": "network_degraded"
|
||||
},
|
||||
"client_capabilities": {
|
||||
"video_evidence": "exact",
|
||||
"audio_evidence": "exact",
|
||||
"codecs_video": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_video_hardware": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_audio": [
|
||||
"aac"
|
||||
],
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"max_resolution": "1080p",
|
||||
"hdr": false,
|
||||
"video_decode": [
|
||||
{
|
||||
"codec": "h264",
|
||||
"profiles": [
|
||||
"high"
|
||||
],
|
||||
"levels": [
|
||||
41
|
||||
],
|
||||
"bit_depths": [
|
||||
8
|
||||
],
|
||||
"max_width": 1920,
|
||||
"max_height": 1080,
|
||||
"max_frame_rate": 60,
|
||||
"max_bitrate_kbps": 20000,
|
||||
"hardware": true
|
||||
}
|
||||
]
|
||||
},
|
||||
"client_playback_context": {
|
||||
"protocol_version": 3,
|
||||
"form_factor": "tv",
|
||||
"app_version": "3.0-test",
|
||||
"device": {
|
||||
"platform": "android",
|
||||
"os_version": "15",
|
||||
"manufacturer": "NVIDIA",
|
||||
"model": "SHIELD Android TV",
|
||||
"platform_details": {
|
||||
"abis": "arm64-v8a",
|
||||
"sdk_int": "35"
|
||||
}
|
||||
},
|
||||
"output": {
|
||||
"output_context_id": "7"
|
||||
},
|
||||
"deliveries": {
|
||||
"original_http": {
|
||||
"enabled": true,
|
||||
"supported_on_device": true,
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"video_codecs": [
|
||||
"h264"
|
||||
],
|
||||
"audio_decode_codecs": [
|
||||
"aac"
|
||||
],
|
||||
"audio_passthrough_codecs": [],
|
||||
"subtitles": {
|
||||
"embedded_text": true,
|
||||
"sidecar_text": true,
|
||||
"ass_styling": false,
|
||||
"embedded_bitmap": false,
|
||||
"sidecar_bitmap": false,
|
||||
"font_attachments": false
|
||||
},
|
||||
"features": [],
|
||||
"auth_header_refresh": true,
|
||||
"validated_claims": [],
|
||||
"transformations": []
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
-99
@@ -1,99 +0,0 @@
|
||||
{
|
||||
"protocol_version": 3,
|
||||
"client_features": [
|
||||
"playback_plan_v3"
|
||||
],
|
||||
"file_id": 42,
|
||||
"profile_id": "profile-1",
|
||||
"playback_attempt_id": "attempt-golden-0001",
|
||||
"quality_preference": "original",
|
||||
"subtitle_fidelity_preference": "compatible",
|
||||
"start_position": 12.5,
|
||||
"audio_track_id": "file:42:audio:0",
|
||||
"audio_track_index": 0,
|
||||
"metered": false,
|
||||
"client_capabilities": {
|
||||
"video_evidence": "exact",
|
||||
"audio_evidence": "exact",
|
||||
"codecs_video": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_video_hardware": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_audio": [
|
||||
"aac"
|
||||
],
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"max_resolution": "1080p",
|
||||
"hdr": false,
|
||||
"video_decode": [
|
||||
{
|
||||
"codec": "h264",
|
||||
"profiles": [
|
||||
"high"
|
||||
],
|
||||
"levels": [
|
||||
41
|
||||
],
|
||||
"bit_depths": [
|
||||
8
|
||||
],
|
||||
"max_width": 1920,
|
||||
"max_height": 1080,
|
||||
"max_frame_rate": 60,
|
||||
"max_bitrate_kbps": 20000,
|
||||
"hardware": true
|
||||
}
|
||||
]
|
||||
},
|
||||
"client_playback_context": {
|
||||
"protocol_version": 3,
|
||||
"form_factor": "tv",
|
||||
"app_version": "3.0-test",
|
||||
"device": {
|
||||
"platform": "android",
|
||||
"os_version": "15",
|
||||
"manufacturer": "NVIDIA",
|
||||
"model": "SHIELD Android TV",
|
||||
"platform_details": {
|
||||
"abis": "arm64-v8a",
|
||||
"sdk_int": "35"
|
||||
}
|
||||
},
|
||||
"output": {
|
||||
"output_context_id": "7"
|
||||
},
|
||||
"deliveries": {
|
||||
"original_http": {
|
||||
"enabled": true,
|
||||
"supported_on_device": true,
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"video_codecs": [
|
||||
"h264"
|
||||
],
|
||||
"audio_decode_codecs": [
|
||||
"aac"
|
||||
],
|
||||
"audio_passthrough_codecs": [],
|
||||
"subtitles": {
|
||||
"embedded_text": true,
|
||||
"sidecar_text": true,
|
||||
"ass_styling": false,
|
||||
"embedded_bitmap": false,
|
||||
"sidecar_bitmap": false,
|
||||
"font_attachments": false
|
||||
},
|
||||
"features": [],
|
||||
"auth_header_refresh": true,
|
||||
"validated_claims": [],
|
||||
"transformations": []
|
||||
}
|
||||
}
|
||||
},
|
||||
"bandwidth_estimate_kbps": 99
|
||||
}
|
||||
-162
@@ -1,162 +0,0 @@
|
||||
{
|
||||
"protocol_version": 3,
|
||||
"client_features": [
|
||||
"feature_00",
|
||||
"feature_01",
|
||||
"feature_02",
|
||||
"feature_03",
|
||||
"feature_04",
|
||||
"feature_05",
|
||||
"feature_06",
|
||||
"feature_07",
|
||||
"feature_08",
|
||||
"feature_09",
|
||||
"feature_10",
|
||||
"feature_11",
|
||||
"feature_12",
|
||||
"feature_13",
|
||||
"feature_14",
|
||||
"feature_15",
|
||||
"feature_16",
|
||||
"feature_17",
|
||||
"feature_18",
|
||||
"feature_19",
|
||||
"feature_20",
|
||||
"feature_21",
|
||||
"feature_22",
|
||||
"feature_23",
|
||||
"feature_24",
|
||||
"feature_25",
|
||||
"feature_26",
|
||||
"feature_27",
|
||||
"feature_28",
|
||||
"feature_29",
|
||||
"feature_30",
|
||||
"feature_31",
|
||||
"feature_32",
|
||||
"feature_33",
|
||||
"feature_34",
|
||||
"feature_35",
|
||||
"feature_36",
|
||||
"feature_37",
|
||||
"feature_38",
|
||||
"feature_39",
|
||||
"feature_40",
|
||||
"feature_41",
|
||||
"feature_42",
|
||||
"feature_43",
|
||||
"feature_44",
|
||||
"feature_45",
|
||||
"feature_46",
|
||||
"feature_47",
|
||||
"feature_48",
|
||||
"feature_49",
|
||||
"feature_50",
|
||||
"feature_51",
|
||||
"feature_52",
|
||||
"feature_53",
|
||||
"feature_54",
|
||||
"feature_55",
|
||||
"feature_56",
|
||||
"feature_57",
|
||||
"feature_58",
|
||||
"feature_59",
|
||||
"feature_60",
|
||||
"feature_61",
|
||||
"feature_62",
|
||||
"feature_63",
|
||||
"feature_64"
|
||||
],
|
||||
"file_id": 42,
|
||||
"profile_id": "profile-1",
|
||||
"playback_attempt_id": "attempt-golden-0001",
|
||||
"quality_preference": "original",
|
||||
"subtitle_fidelity_preference": "compatible",
|
||||
"start_position": 12.5,
|
||||
"audio_track_id": "file:42:audio:0",
|
||||
"audio_track_index": 0,
|
||||
"metered": false,
|
||||
"client_capabilities": {
|
||||
"video_evidence": "exact",
|
||||
"audio_evidence": "exact",
|
||||
"codecs_video": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_video_hardware": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_audio": [
|
||||
"aac"
|
||||
],
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"max_resolution": "1080p",
|
||||
"hdr": false,
|
||||
"video_decode": [
|
||||
{
|
||||
"codec": "h264",
|
||||
"profiles": [
|
||||
"high"
|
||||
],
|
||||
"levels": [
|
||||
41
|
||||
],
|
||||
"bit_depths": [
|
||||
8
|
||||
],
|
||||
"max_width": 1920,
|
||||
"max_height": 1080,
|
||||
"max_frame_rate": 60,
|
||||
"max_bitrate_kbps": 20000,
|
||||
"hardware": true
|
||||
}
|
||||
]
|
||||
},
|
||||
"client_playback_context": {
|
||||
"protocol_version": 3,
|
||||
"form_factor": "tv",
|
||||
"app_version": "3.0-test",
|
||||
"device": {
|
||||
"platform": "android",
|
||||
"os_version": "15",
|
||||
"manufacturer": "NVIDIA",
|
||||
"model": "SHIELD Android TV",
|
||||
"platform_details": {
|
||||
"abis": "arm64-v8a",
|
||||
"sdk_int": "35"
|
||||
}
|
||||
},
|
||||
"output": {
|
||||
"output_context_id": "7"
|
||||
},
|
||||
"deliveries": {
|
||||
"original_http": {
|
||||
"enabled": true,
|
||||
"supported_on_device": true,
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"video_codecs": [
|
||||
"h264"
|
||||
],
|
||||
"audio_decode_codecs": [
|
||||
"aac"
|
||||
],
|
||||
"audio_passthrough_codecs": [],
|
||||
"subtitles": {
|
||||
"embedded_text": true,
|
||||
"sidecar_text": true,
|
||||
"ass_styling": false,
|
||||
"embedded_bitmap": false,
|
||||
"sidecar_bitmap": false,
|
||||
"font_attachments": false
|
||||
},
|
||||
"features": [],
|
||||
"auth_header_refresh": true,
|
||||
"validated_claims": [],
|
||||
"transformations": []
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
-45
@@ -1,45 +0,0 @@
|
||||
{
|
||||
"protocol_version": 3,
|
||||
"playback_attempt_id": "attempt-golden-0001",
|
||||
"session_id": "11111111-1111-4111-8111-111111111111",
|
||||
"plan_id": "plan:golden-0001",
|
||||
"plan_attempt_id": "plan-attempt-golden-0001",
|
||||
"plan_attempt_key": "v3:0000000000000001",
|
||||
"event": "first_frame",
|
||||
"output_context_id": "7",
|
||||
"diagnostics": {
|
||||
"key_00": "0",
|
||||
"key_01": "1",
|
||||
"key_02": "2",
|
||||
"key_03": "3",
|
||||
"key_04": "4",
|
||||
"key_05": "5",
|
||||
"key_06": "6",
|
||||
"key_07": "7",
|
||||
"key_08": "8",
|
||||
"key_09": "9",
|
||||
"key_10": "10",
|
||||
"key_11": "11",
|
||||
"key_12": "12",
|
||||
"key_13": "13",
|
||||
"key_14": "14",
|
||||
"key_15": "15",
|
||||
"key_16": "16",
|
||||
"key_17": "17",
|
||||
"key_18": "18",
|
||||
"key_19": "19",
|
||||
"key_20": "20",
|
||||
"key_21": "21",
|
||||
"key_22": "22",
|
||||
"key_23": "23",
|
||||
"key_24": "24",
|
||||
"key_25": "25",
|
||||
"key_26": "26",
|
||||
"key_27": "27",
|
||||
"key_28": "28",
|
||||
"key_29": "29",
|
||||
"key_30": "30",
|
||||
"key_31": "31",
|
||||
"key_32": "32"
|
||||
}
|
||||
}
|
||||
@@ -1,8 +0,0 @@
|
||||
{
|
||||
"enabled": false,
|
||||
"protocol_versions": [],
|
||||
"features": [],
|
||||
"deliveries": [],
|
||||
"transformations": [],
|
||||
"reason": "disabled"
|
||||
}
|
||||
-110
@@ -1,110 +0,0 @@
|
||||
{
|
||||
"protocol_version": 3,
|
||||
"client_features": [
|
||||
"playback_plan_v3"
|
||||
],
|
||||
"operation": "failure_recovery",
|
||||
"playback_attempt_id": "attempt-golden-0001",
|
||||
"replan_request_id": "replan-golden-0001",
|
||||
"failed_plan_id": "plan:golden-0001",
|
||||
"plan_attempt_id": "plan-attempt-golden-0001",
|
||||
"plan_attempt_key": "v3:0000000000000001",
|
||||
"attempted_plan_keys": [
|
||||
"v3:0000000000000001"
|
||||
],
|
||||
"attempt_count": 1,
|
||||
"quality_preference": "auto",
|
||||
"position_seconds": 42.5,
|
||||
"metered": true,
|
||||
"bandwidth_estimate_kbps": 3500,
|
||||
"bandwidth_cap_kbps": 4000,
|
||||
"selected_tracks": {
|
||||
"audio": {
|
||||
"id": "file:42:audio:0",
|
||||
"index": 0
|
||||
}
|
||||
},
|
||||
"client_capabilities": {
|
||||
"video_evidence": "exact",
|
||||
"audio_evidence": "exact",
|
||||
"codecs_video": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_video_hardware": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_audio": [
|
||||
"aac"
|
||||
],
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"max_resolution": "1080p",
|
||||
"hdr": false,
|
||||
"video_decode": [
|
||||
{
|
||||
"codec": "h264",
|
||||
"profiles": [
|
||||
"high"
|
||||
],
|
||||
"levels": [
|
||||
41
|
||||
],
|
||||
"bit_depths": [
|
||||
8
|
||||
],
|
||||
"max_width": 1920,
|
||||
"max_height": 1080,
|
||||
"max_frame_rate": 60,
|
||||
"max_bitrate_kbps": 20000,
|
||||
"hardware": true
|
||||
}
|
||||
]
|
||||
},
|
||||
"client_playback_context": {
|
||||
"protocol_version": 3,
|
||||
"form_factor": "tv",
|
||||
"app_version": "3.0-test",
|
||||
"device": {
|
||||
"platform": "android",
|
||||
"os_version": "15",
|
||||
"manufacturer": "NVIDIA",
|
||||
"model": "SHIELD Android TV",
|
||||
"platform_details": {
|
||||
"abis": "arm64-v8a",
|
||||
"sdk_int": "35"
|
||||
}
|
||||
},
|
||||
"output": {
|
||||
"output_context_id": "7"
|
||||
},
|
||||
"deliveries": {
|
||||
"original_http": {
|
||||
"enabled": true,
|
||||
"supported_on_device": true,
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"video_codecs": [
|
||||
"h264"
|
||||
],
|
||||
"audio_decode_codecs": [
|
||||
"aac"
|
||||
],
|
||||
"audio_passthrough_codecs": [],
|
||||
"subtitles": {
|
||||
"embedded_text": true,
|
||||
"sidecar_text": true,
|
||||
"ass_styling": false,
|
||||
"embedded_bitmap": false,
|
||||
"sidecar_bitmap": false,
|
||||
"font_attachments": false
|
||||
},
|
||||
"features": [],
|
||||
"auth_header_refresh": true,
|
||||
"validated_claims": [],
|
||||
"transformations": []
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
-61
@@ -1,61 +0,0 @@
|
||||
{
|
||||
"protocol_version": 3,
|
||||
"client_features": [
|
||||
"playback_plan_v3"
|
||||
],
|
||||
"file_id": 42,
|
||||
"profile_id": "profile-1",
|
||||
"playback_attempt_id": "attempt-golden-0001",
|
||||
"quality_preference": "original",
|
||||
"subtitle_fidelity_preference": "compatible",
|
||||
"start_position": 12.5,
|
||||
"audio_track_id": "file:42:audio:0",
|
||||
"audio_track_index": 0,
|
||||
"metered": false,
|
||||
"client_playback_context": {
|
||||
"protocol_version": 3,
|
||||
"form_factor": "tv",
|
||||
"app_version": "3.0-test",
|
||||
"device": {
|
||||
"platform": "android",
|
||||
"os_version": "15",
|
||||
"manufacturer": "NVIDIA",
|
||||
"model": "SHIELD Android TV",
|
||||
"platform_details": {
|
||||
"abis": "arm64-v8a",
|
||||
"sdk_int": "35"
|
||||
}
|
||||
},
|
||||
"output": {
|
||||
"output_context_id": "7"
|
||||
},
|
||||
"deliveries": {
|
||||
"original_http": {
|
||||
"enabled": true,
|
||||
"supported_on_device": true,
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"video_codecs": [
|
||||
"h264"
|
||||
],
|
||||
"audio_decode_codecs": [
|
||||
"aac"
|
||||
],
|
||||
"audio_passthrough_codecs": [],
|
||||
"subtitles": {
|
||||
"embedded_text": true,
|
||||
"sidecar_text": true,
|
||||
"ass_styling": false,
|
||||
"embedded_bitmap": false,
|
||||
"sidecar_bitmap": false,
|
||||
"font_attachments": false
|
||||
},
|
||||
"features": [],
|
||||
"auth_header_refresh": true,
|
||||
"validated_claims": [],
|
||||
"transformations": []
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
-3
@@ -1,3 +0,0 @@
|
||||
{
|
||||
"error": "client_upgrade_required"
|
||||
}
|
||||
-98
@@ -1,98 +0,0 @@
|
||||
{
|
||||
"protocol_version": 3,
|
||||
"client_features": [
|
||||
"playback_plan_v3"
|
||||
],
|
||||
"file_id": 42,
|
||||
"profile_id": "profile-1",
|
||||
"playback_attempt_id": "attempt-golden-0001",
|
||||
"quality_preference": "original",
|
||||
"subtitle_fidelity_preference": "compatible",
|
||||
"start_position": 12.5,
|
||||
"audio_track_id": "file:42:audio:0",
|
||||
"audio_track_index": 0,
|
||||
"metered": false,
|
||||
"client_capabilities": {
|
||||
"video_evidence": "exact",
|
||||
"audio_evidence": "exact",
|
||||
"codecs_video": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_video_hardware": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_audio": [
|
||||
"aac"
|
||||
],
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"max_resolution": "1080p",
|
||||
"hdr": false,
|
||||
"video_decode": [
|
||||
{
|
||||
"codec": "h264",
|
||||
"profiles": [
|
||||
"high"
|
||||
],
|
||||
"levels": [
|
||||
41
|
||||
],
|
||||
"bit_depths": [
|
||||
8
|
||||
],
|
||||
"max_width": 1920,
|
||||
"max_height": 1080,
|
||||
"max_frame_rate": 60,
|
||||
"max_bitrate_kbps": 20000,
|
||||
"hardware": true
|
||||
}
|
||||
]
|
||||
},
|
||||
"client_playback_context": {
|
||||
"protocol_version": 3,
|
||||
"form_factor": "tv",
|
||||
"app_version": "3.0-test",
|
||||
"device": {
|
||||
"platform": "android",
|
||||
"os_version": "111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
|
||||
"manufacturer": "NVIDIA",
|
||||
"model": "SHIELD Android TV",
|
||||
"platform_details": {
|
||||
"abis": "arm64-v8a",
|
||||
"sdk_int": "35"
|
||||
}
|
||||
},
|
||||
"output": {
|
||||
"output_context_id": "7"
|
||||
},
|
||||
"deliveries": {
|
||||
"original_http": {
|
||||
"enabled": true,
|
||||
"supported_on_device": true,
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"video_codecs": [
|
||||
"h264"
|
||||
],
|
||||
"audio_decode_codecs": [
|
||||
"aac"
|
||||
],
|
||||
"audio_passthrough_codecs": [],
|
||||
"subtitles": {
|
||||
"embedded_text": true,
|
||||
"sidecar_text": true,
|
||||
"ass_styling": false,
|
||||
"embedded_bitmap": false,
|
||||
"sidecar_bitmap": false,
|
||||
"font_attachments": false
|
||||
},
|
||||
"features": [],
|
||||
"auth_header_refresh": true,
|
||||
"validated_claims": [],
|
||||
"transformations": []
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
-113
@@ -1,113 +0,0 @@
|
||||
{
|
||||
"protocol_version": 3,
|
||||
"client_features": [
|
||||
"playback_plan_v3"
|
||||
],
|
||||
"operation": "failure_recovery",
|
||||
"playback_attempt_id": "attempt-golden-0001",
|
||||
"replan_request_id": "replan-golden-0001",
|
||||
"failed_plan_id": "plan:golden-0001",
|
||||
"plan_attempt_id": "plan-attempt-golden-0001",
|
||||
"plan_attempt_key": "0000000000000001",
|
||||
"attempted_plan_keys": [
|
||||
"v3:0000000000000001"
|
||||
],
|
||||
"attempt_count": 1,
|
||||
"quality_preference": "auto",
|
||||
"position_seconds": 42.5,
|
||||
"metered": true,
|
||||
"bandwidth_estimate_kbps": 3500,
|
||||
"bandwidth_cap_kbps": 4000,
|
||||
"selected_tracks": {
|
||||
"audio": {
|
||||
"id": "file:42:audio:0",
|
||||
"index": 0
|
||||
}
|
||||
},
|
||||
"failure": {
|
||||
"classification": "network_degraded"
|
||||
},
|
||||
"client_capabilities": {
|
||||
"video_evidence": "exact",
|
||||
"audio_evidence": "exact",
|
||||
"codecs_video": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_video_hardware": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_audio": [
|
||||
"aac"
|
||||
],
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"max_resolution": "1080p",
|
||||
"hdr": false,
|
||||
"video_decode": [
|
||||
{
|
||||
"codec": "h264",
|
||||
"profiles": [
|
||||
"high"
|
||||
],
|
||||
"levels": [
|
||||
41
|
||||
],
|
||||
"bit_depths": [
|
||||
8
|
||||
],
|
||||
"max_width": 1920,
|
||||
"max_height": 1080,
|
||||
"max_frame_rate": 60,
|
||||
"max_bitrate_kbps": 20000,
|
||||
"hardware": true
|
||||
}
|
||||
]
|
||||
},
|
||||
"client_playback_context": {
|
||||
"protocol_version": 3,
|
||||
"form_factor": "tv",
|
||||
"app_version": "3.0-test",
|
||||
"device": {
|
||||
"platform": "android",
|
||||
"os_version": "15",
|
||||
"manufacturer": "NVIDIA",
|
||||
"model": "SHIELD Android TV",
|
||||
"platform_details": {
|
||||
"abis": "arm64-v8a",
|
||||
"sdk_int": "35"
|
||||
}
|
||||
},
|
||||
"output": {
|
||||
"output_context_id": "7"
|
||||
},
|
||||
"deliveries": {
|
||||
"original_http": {
|
||||
"enabled": true,
|
||||
"supported_on_device": true,
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"video_codecs": [
|
||||
"h264"
|
||||
],
|
||||
"audio_decode_codecs": [
|
||||
"aac"
|
||||
],
|
||||
"audio_passthrough_codecs": [],
|
||||
"subtitles": {
|
||||
"embedded_text": true,
|
||||
"sidecar_text": true,
|
||||
"ass_styling": false,
|
||||
"embedded_bitmap": false,
|
||||
"sidecar_bitmap": false,
|
||||
"font_attachments": false
|
||||
},
|
||||
"features": [],
|
||||
"auth_header_refresh": true,
|
||||
"validated_claims": [],
|
||||
"transformations": []
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,5 +0,0 @@
|
||||
{
|
||||
"protocol_version": 3,
|
||||
"server_features": [],
|
||||
"outcome": "playable"
|
||||
}
|
||||
-113
@@ -1,113 +0,0 @@
|
||||
{
|
||||
"protocol_version": 3,
|
||||
"client_features": [
|
||||
"playback_plan_v3"
|
||||
],
|
||||
"file_id": 42,
|
||||
"profile_id": "profile-1",
|
||||
"playback_attempt_id": "attempt-golden-0001",
|
||||
"quality_preference": "original",
|
||||
"subtitle_fidelity_preference": "compatible",
|
||||
"start_position": 12.5,
|
||||
"audio_track_id": "file:42:audio:0",
|
||||
"audio_track_index": 0,
|
||||
"metered": false,
|
||||
"client_capabilities": {
|
||||
"video_evidence": "exact",
|
||||
"audio_evidence": "exact",
|
||||
"codecs_video": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_video_hardware": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_audio": [
|
||||
"aac"
|
||||
],
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"max_resolution": "1080p",
|
||||
"hdr": false,
|
||||
"video_decode": [
|
||||
{
|
||||
"codec": "h264",
|
||||
"profiles": [
|
||||
"high"
|
||||
],
|
||||
"levels": [
|
||||
41
|
||||
],
|
||||
"bit_depths": [
|
||||
8
|
||||
],
|
||||
"max_width": 1920,
|
||||
"max_height": 1080,
|
||||
"max_frame_rate": 60,
|
||||
"max_bitrate_kbps": 20000,
|
||||
"hardware": true
|
||||
}
|
||||
]
|
||||
},
|
||||
"client_playback_context": {
|
||||
"protocol_version": 3,
|
||||
"form_factor": "tv",
|
||||
"app_version": "3.0-test",
|
||||
"device": {
|
||||
"platform": "android",
|
||||
"os_version": "15",
|
||||
"manufacturer": "NVIDIA",
|
||||
"model": "SHIELD Android TV",
|
||||
"platform_details": {
|
||||
"detail_00": "0",
|
||||
"detail_01": "1",
|
||||
"detail_02": "2",
|
||||
"detail_03": "3",
|
||||
"detail_04": "4",
|
||||
"detail_05": "5",
|
||||
"detail_06": "6",
|
||||
"detail_07": "7",
|
||||
"detail_08": "8",
|
||||
"detail_09": "9",
|
||||
"detail_10": "10",
|
||||
"detail_11": "11",
|
||||
"detail_12": "12",
|
||||
"detail_13": "13",
|
||||
"detail_14": "14",
|
||||
"detail_15": "15",
|
||||
"detail_16": "16"
|
||||
}
|
||||
},
|
||||
"output": {
|
||||
"output_context_id": "7"
|
||||
},
|
||||
"deliveries": {
|
||||
"original_http": {
|
||||
"enabled": true,
|
||||
"supported_on_device": true,
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"video_codecs": [
|
||||
"h264"
|
||||
],
|
||||
"audio_decode_codecs": [
|
||||
"aac"
|
||||
],
|
||||
"audio_passthrough_codecs": [],
|
||||
"subtitles": {
|
||||
"embedded_text": true,
|
||||
"sidecar_text": true,
|
||||
"ass_styling": false,
|
||||
"embedded_bitmap": false,
|
||||
"sidecar_bitmap": false,
|
||||
"font_attachments": false
|
||||
},
|
||||
"features": [],
|
||||
"auth_header_refresh": true,
|
||||
"validated_claims": [],
|
||||
"transformations": []
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
-98
@@ -1,98 +0,0 @@
|
||||
{
|
||||
"protocol_version": 3,
|
||||
"client_features": [
|
||||
"playback_plan_v3"
|
||||
],
|
||||
"file_id": 42,
|
||||
"profile_id": "profile-1",
|
||||
"playback_attempt_id": "-leading-dash-attempt",
|
||||
"quality_preference": "original",
|
||||
"subtitle_fidelity_preference": "compatible",
|
||||
"start_position": 12.5,
|
||||
"audio_track_id": "file:42:audio:0",
|
||||
"audio_track_index": 0,
|
||||
"metered": false,
|
||||
"client_capabilities": {
|
||||
"video_evidence": "exact",
|
||||
"audio_evidence": "exact",
|
||||
"codecs_video": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_video_hardware": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_audio": [
|
||||
"aac"
|
||||
],
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"max_resolution": "1080p",
|
||||
"hdr": false,
|
||||
"video_decode": [
|
||||
{
|
||||
"codec": "h264",
|
||||
"profiles": [
|
||||
"high"
|
||||
],
|
||||
"levels": [
|
||||
41
|
||||
],
|
||||
"bit_depths": [
|
||||
8
|
||||
],
|
||||
"max_width": 1920,
|
||||
"max_height": 1080,
|
||||
"max_frame_rate": 60,
|
||||
"max_bitrate_kbps": 20000,
|
||||
"hardware": true
|
||||
}
|
||||
]
|
||||
},
|
||||
"client_playback_context": {
|
||||
"protocol_version": 3,
|
||||
"form_factor": "tv",
|
||||
"app_version": "3.0-test",
|
||||
"device": {
|
||||
"platform": "android",
|
||||
"os_version": "15",
|
||||
"manufacturer": "NVIDIA",
|
||||
"model": "SHIELD Android TV",
|
||||
"platform_details": {
|
||||
"abis": "arm64-v8a",
|
||||
"sdk_int": "35"
|
||||
}
|
||||
},
|
||||
"output": {
|
||||
"output_context_id": "7"
|
||||
},
|
||||
"deliveries": {
|
||||
"original_http": {
|
||||
"enabled": true,
|
||||
"supported_on_device": true,
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"video_codecs": [
|
||||
"h264"
|
||||
],
|
||||
"audio_decode_codecs": [
|
||||
"aac"
|
||||
],
|
||||
"audio_passthrough_codecs": [],
|
||||
"subtitles": {
|
||||
"embedded_text": true,
|
||||
"sidecar_text": true,
|
||||
"ass_styling": false,
|
||||
"embedded_bitmap": false,
|
||||
"sidecar_bitmap": false,
|
||||
"font_attachments": false
|
||||
},
|
||||
"features": [],
|
||||
"auth_header_refresh": true,
|
||||
"validated_claims": [],
|
||||
"transformations": []
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
-110
@@ -1,110 +0,0 @@
|
||||
{
|
||||
"protocol_version": 3,
|
||||
"client_features": [
|
||||
"playback_plan_v3"
|
||||
],
|
||||
"operation": "quality_change",
|
||||
"playback_attempt_id": "attempt-golden-0001",
|
||||
"replan_request_id": "replan-golden-0001",
|
||||
"failed_plan_id": "plan:golden-0001",
|
||||
"plan_attempt_id": "plan-attempt-golden-0001",
|
||||
"plan_attempt_key": "v3:0000000000000001",
|
||||
"attempted_plan_keys": [
|
||||
"v3:0000000000000001"
|
||||
],
|
||||
"attempt_count": 1,
|
||||
"quality_preference": "",
|
||||
"position_seconds": 42.5,
|
||||
"metered": true,
|
||||
"bandwidth_estimate_kbps": 3500,
|
||||
"bandwidth_cap_kbps": 4000,
|
||||
"selected_tracks": {
|
||||
"audio": {
|
||||
"id": "file:42:audio:0",
|
||||
"index": 0
|
||||
}
|
||||
},
|
||||
"client_capabilities": {
|
||||
"video_evidence": "exact",
|
||||
"audio_evidence": "exact",
|
||||
"codecs_video": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_video_hardware": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_audio": [
|
||||
"aac"
|
||||
],
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"max_resolution": "1080p",
|
||||
"hdr": false,
|
||||
"video_decode": [
|
||||
{
|
||||
"codec": "h264",
|
||||
"profiles": [
|
||||
"high"
|
||||
],
|
||||
"levels": [
|
||||
41
|
||||
],
|
||||
"bit_depths": [
|
||||
8
|
||||
],
|
||||
"max_width": 1920,
|
||||
"max_height": 1080,
|
||||
"max_frame_rate": 60,
|
||||
"max_bitrate_kbps": 20000,
|
||||
"hardware": true
|
||||
}
|
||||
]
|
||||
},
|
||||
"client_playback_context": {
|
||||
"protocol_version": 3,
|
||||
"form_factor": "tv",
|
||||
"app_version": "3.0-test",
|
||||
"device": {
|
||||
"platform": "android",
|
||||
"os_version": "15",
|
||||
"manufacturer": "NVIDIA",
|
||||
"model": "SHIELD Android TV",
|
||||
"platform_details": {
|
||||
"abis": "arm64-v8a",
|
||||
"sdk_int": "35"
|
||||
}
|
||||
},
|
||||
"output": {
|
||||
"output_context_id": "7"
|
||||
},
|
||||
"deliveries": {
|
||||
"original_http": {
|
||||
"enabled": true,
|
||||
"supported_on_device": true,
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"video_codecs": [
|
||||
"h264"
|
||||
],
|
||||
"audio_decode_codecs": [
|
||||
"aac"
|
||||
],
|
||||
"audio_passthrough_codecs": [],
|
||||
"subtitles": {
|
||||
"embedded_text": true,
|
||||
"sidecar_text": true,
|
||||
"ass_styling": false,
|
||||
"embedded_bitmap": false,
|
||||
"sidecar_bitmap": false,
|
||||
"font_attachments": false
|
||||
},
|
||||
"features": [],
|
||||
"auth_header_refresh": true,
|
||||
"validated_claims": [],
|
||||
"transformations": []
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
-98
@@ -1,98 +0,0 @@
|
||||
{
|
||||
"protocol_version": 3,
|
||||
"client_features": [
|
||||
"playback_plan_v3"
|
||||
],
|
||||
"file_id": 42,
|
||||
"profile_id": "profile-1",
|
||||
"playback_attempt_id": "attempt-golden-0001",
|
||||
"quality_preference": "original",
|
||||
"subtitle_fidelity_preference": "compatible",
|
||||
"start_position": 31536001,
|
||||
"audio_track_id": "file:42:audio:0",
|
||||
"audio_track_index": 0,
|
||||
"metered": false,
|
||||
"client_capabilities": {
|
||||
"video_evidence": "exact",
|
||||
"audio_evidence": "exact",
|
||||
"codecs_video": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_video_hardware": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_audio": [
|
||||
"aac"
|
||||
],
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"max_resolution": "1080p",
|
||||
"hdr": false,
|
||||
"video_decode": [
|
||||
{
|
||||
"codec": "h264",
|
||||
"profiles": [
|
||||
"high"
|
||||
],
|
||||
"levels": [
|
||||
41
|
||||
],
|
||||
"bit_depths": [
|
||||
8
|
||||
],
|
||||
"max_width": 1920,
|
||||
"max_height": 1080,
|
||||
"max_frame_rate": 60,
|
||||
"max_bitrate_kbps": 20000,
|
||||
"hardware": true
|
||||
}
|
||||
]
|
||||
},
|
||||
"client_playback_context": {
|
||||
"protocol_version": 3,
|
||||
"form_factor": "tv",
|
||||
"app_version": "3.0-test",
|
||||
"device": {
|
||||
"platform": "android",
|
||||
"os_version": "15",
|
||||
"manufacturer": "NVIDIA",
|
||||
"model": "SHIELD Android TV",
|
||||
"platform_details": {
|
||||
"abis": "arm64-v8a",
|
||||
"sdk_int": "35"
|
||||
}
|
||||
},
|
||||
"output": {
|
||||
"output_context_id": "7"
|
||||
},
|
||||
"deliveries": {
|
||||
"original_http": {
|
||||
"enabled": true,
|
||||
"supported_on_device": true,
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"video_codecs": [
|
||||
"h264"
|
||||
],
|
||||
"audio_decode_codecs": [
|
||||
"aac"
|
||||
],
|
||||
"audio_passthrough_codecs": [],
|
||||
"subtitles": {
|
||||
"embedded_text": true,
|
||||
"sidecar_text": true,
|
||||
"ass_styling": false,
|
||||
"embedded_bitmap": false,
|
||||
"sidecar_bitmap": false,
|
||||
"font_attachments": false
|
||||
},
|
||||
"features": [],
|
||||
"auth_header_refresh": true,
|
||||
"validated_claims": [],
|
||||
"transformations": []
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
-15
@@ -1,15 +0,0 @@
|
||||
{
|
||||
"protocol_version": 3,
|
||||
"playback_attempt_id": "attempt-golden-0001",
|
||||
"session_id": "11111111-1111-4111-8111-111111111111",
|
||||
"plan_id": "plan:golden-0001",
|
||||
"plan_attempt_id": "plan-attempt-golden-0001",
|
||||
"plan_attempt_key": "v3:0000000000000001",
|
||||
"event": "buffering",
|
||||
"output_context_id": "7",
|
||||
"diagnostics": {
|
||||
"decoder_name": "c2.android.avc.decoder",
|
||||
"first_frame_ms": "412",
|
||||
"video_mime": "video/avc"
|
||||
}
|
||||
}
|
||||
-98
@@ -1,98 +0,0 @@
|
||||
{
|
||||
"protocol_version": 3,
|
||||
"client_features": [
|
||||
"playback_plan_v3"
|
||||
],
|
||||
"file_id": 42,
|
||||
"profile_id": "profile-1",
|
||||
"playback_attempt_id": "attempt-golden-0001",
|
||||
"quality_preference": "original",
|
||||
"subtitle_fidelity_preference": "best_effort",
|
||||
"start_position": 12.5,
|
||||
"audio_track_id": "file:42:audio:0",
|
||||
"audio_track_index": 0,
|
||||
"metered": false,
|
||||
"client_capabilities": {
|
||||
"video_evidence": "exact",
|
||||
"audio_evidence": "exact",
|
||||
"codecs_video": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_video_hardware": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_audio": [
|
||||
"aac"
|
||||
],
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"max_resolution": "1080p",
|
||||
"hdr": false,
|
||||
"video_decode": [
|
||||
{
|
||||
"codec": "h264",
|
||||
"profiles": [
|
||||
"high"
|
||||
],
|
||||
"levels": [
|
||||
41
|
||||
],
|
||||
"bit_depths": [
|
||||
8
|
||||
],
|
||||
"max_width": 1920,
|
||||
"max_height": 1080,
|
||||
"max_frame_rate": 60,
|
||||
"max_bitrate_kbps": 20000,
|
||||
"hardware": true
|
||||
}
|
||||
]
|
||||
},
|
||||
"client_playback_context": {
|
||||
"protocol_version": 3,
|
||||
"form_factor": "tv",
|
||||
"app_version": "3.0-test",
|
||||
"device": {
|
||||
"platform": "android",
|
||||
"os_version": "15",
|
||||
"manufacturer": "NVIDIA",
|
||||
"model": "SHIELD Android TV",
|
||||
"platform_details": {
|
||||
"abis": "arm64-v8a",
|
||||
"sdk_int": "35"
|
||||
}
|
||||
},
|
||||
"output": {
|
||||
"output_context_id": "7"
|
||||
},
|
||||
"deliveries": {
|
||||
"original_http": {
|
||||
"enabled": true,
|
||||
"supported_on_device": true,
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"video_codecs": [
|
||||
"h264"
|
||||
],
|
||||
"audio_decode_codecs": [
|
||||
"aac"
|
||||
],
|
||||
"audio_passthrough_codecs": [],
|
||||
"subtitles": {
|
||||
"embedded_text": true,
|
||||
"sidecar_text": true,
|
||||
"ass_styling": false,
|
||||
"embedded_bitmap": false,
|
||||
"sidecar_bitmap": false,
|
||||
"font_attachments": false
|
||||
},
|
||||
"features": [],
|
||||
"auth_header_refresh": true,
|
||||
"validated_claims": [],
|
||||
"transformations": []
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
-98
@@ -1,98 +0,0 @@
|
||||
{
|
||||
"protocol_version": 2,
|
||||
"client_features": [
|
||||
"playback_plan_v3"
|
||||
],
|
||||
"file_id": 42,
|
||||
"profile_id": "profile-1",
|
||||
"playback_attempt_id": "attempt-golden-0001",
|
||||
"quality_preference": "original",
|
||||
"subtitle_fidelity_preference": "compatible",
|
||||
"start_position": 12.5,
|
||||
"audio_track_id": "file:42:audio:0",
|
||||
"audio_track_index": 0,
|
||||
"metered": false,
|
||||
"client_capabilities": {
|
||||
"video_evidence": "exact",
|
||||
"audio_evidence": "exact",
|
||||
"codecs_video": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_video_hardware": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_audio": [
|
||||
"aac"
|
||||
],
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"max_resolution": "1080p",
|
||||
"hdr": false,
|
||||
"video_decode": [
|
||||
{
|
||||
"codec": "h264",
|
||||
"profiles": [
|
||||
"high"
|
||||
],
|
||||
"levels": [
|
||||
41
|
||||
],
|
||||
"bit_depths": [
|
||||
8
|
||||
],
|
||||
"max_width": 1920,
|
||||
"max_height": 1080,
|
||||
"max_frame_rate": 60,
|
||||
"max_bitrate_kbps": 20000,
|
||||
"hardware": true
|
||||
}
|
||||
]
|
||||
},
|
||||
"client_playback_context": {
|
||||
"protocol_version": 3,
|
||||
"form_factor": "tv",
|
||||
"app_version": "3.0-test",
|
||||
"device": {
|
||||
"platform": "android",
|
||||
"os_version": "15",
|
||||
"manufacturer": "NVIDIA",
|
||||
"model": "SHIELD Android TV",
|
||||
"platform_details": {
|
||||
"abis": "arm64-v8a",
|
||||
"sdk_int": "35"
|
||||
}
|
||||
},
|
||||
"output": {
|
||||
"output_context_id": "7"
|
||||
},
|
||||
"deliveries": {
|
||||
"original_http": {
|
||||
"enabled": true,
|
||||
"supported_on_device": true,
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"video_codecs": [
|
||||
"h264"
|
||||
],
|
||||
"audio_decode_codecs": [
|
||||
"aac"
|
||||
],
|
||||
"audio_passthrough_codecs": [],
|
||||
"subtitles": {
|
||||
"embedded_text": true,
|
||||
"sidecar_text": true,
|
||||
"ass_styling": false,
|
||||
"embedded_bitmap": false,
|
||||
"sidecar_bitmap": false,
|
||||
"font_attachments": false
|
||||
},
|
||||
"features": [],
|
||||
"auth_header_refresh": true,
|
||||
"validated_claims": [],
|
||||
"transformations": []
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,51 +0,0 @@
|
||||
{
|
||||
"enabled": true,
|
||||
"protocol_versions": [
|
||||
3
|
||||
],
|
||||
"features": [
|
||||
"playback_plan_v3",
|
||||
"neutral_playback_v3_contract_v1",
|
||||
"layout_aware_passthrough",
|
||||
"playback_route_diagnostics",
|
||||
"device_quirks_v1",
|
||||
"seek_reanchor_v1",
|
||||
"output_change_v1",
|
||||
"direct_stream_resume_v1",
|
||||
"plan_source_duration_v1"
|
||||
],
|
||||
"deliveries": [
|
||||
"original_http",
|
||||
"server_remux_progressive",
|
||||
"server_remux_hls",
|
||||
"server_transcode_hls"
|
||||
],
|
||||
"transformations": [
|
||||
{
|
||||
"name": "audio_to_aac",
|
||||
"executor": "server",
|
||||
"recipe_version": "1",
|
||||
"validated_claims": [
|
||||
"audio_decode"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "server_dv7_to_hdr10",
|
||||
"executor": "server",
|
||||
"recipe_version": "1",
|
||||
"validated_claims": [
|
||||
"dolby_vision_metadata_removed",
|
||||
"hdr10_base_layer_preserved",
|
||||
"enhancement_layer_discarded"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "video_to_h264",
|
||||
"executor": "server",
|
||||
"recipe_version": "2",
|
||||
"validated_claims": [
|
||||
"h264_decode"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -1,181 +0,0 @@
|
||||
{
|
||||
"protocol_version": 3,
|
||||
"server_features": [
|
||||
"playback_plan_v3",
|
||||
"neutral_playback_v3_contract_v1",
|
||||
"layout_aware_passthrough",
|
||||
"playback_route_diagnostics",
|
||||
"device_quirks_v1",
|
||||
"seek_reanchor_v1",
|
||||
"output_change_v1",
|
||||
"direct_stream_resume_v1",
|
||||
"plan_source_duration_v1"
|
||||
],
|
||||
"outcome": "playable",
|
||||
"session_id": "11111111-1111-4111-8111-111111111111",
|
||||
"playback_plan": {
|
||||
"protocol_version": 3,
|
||||
"plan_id": "plan:478677870860e5e5108c18bff749b34b",
|
||||
"plan_attempt_key": "v3:f0144c47fa349e3e",
|
||||
"session_id": "11111111-1111-4111-8111-111111111111",
|
||||
"expires_at": "2030-01-01T00:00:00Z",
|
||||
"delivery": "original_http",
|
||||
"stream": {
|
||||
"url": "/stream/11111111-1111-4111-8111-111111111111",
|
||||
"protocol": "http_progressive",
|
||||
"container": "mp4",
|
||||
"mime_type": "video/mp4",
|
||||
"headers": {},
|
||||
"header_refresh": "none"
|
||||
},
|
||||
"timeline": {
|
||||
"source_start_seconds": 12.5,
|
||||
"stream_origin_seconds": 0,
|
||||
"player_start_seconds": 12.5,
|
||||
"timeline_offset_seconds": 0,
|
||||
"can_seek_anywhere": true,
|
||||
"seek_restoration": "player_position"
|
||||
},
|
||||
"selected_tracks": {
|
||||
"audio": {
|
||||
"id": "file:42:audio:0",
|
||||
"index": 0
|
||||
}
|
||||
},
|
||||
"effective_recipe": {
|
||||
"video_codec": "h264",
|
||||
"audio_codec": "aac",
|
||||
"width": 1920,
|
||||
"height": 1080,
|
||||
"frame_rate": 23.976023976023978,
|
||||
"bitrate_kbps": 8000,
|
||||
"dynamic_range": "sdr",
|
||||
"audio_channels": 2,
|
||||
"audio_layout": "stereo"
|
||||
},
|
||||
"claims": {
|
||||
"video": {
|
||||
"hdr10": false,
|
||||
"hdr10_plus": false,
|
||||
"hlg": false,
|
||||
"dolby_vision": false
|
||||
},
|
||||
"audio": {
|
||||
"codec": "aac",
|
||||
"passthrough": false,
|
||||
"atmos_preserved": false,
|
||||
"reason": "client_decode_supported"
|
||||
},
|
||||
"subtitles": {
|
||||
"ass_styling_preserved": false,
|
||||
"bitmap_overlay": false,
|
||||
"bitmap_sidecar": false
|
||||
}
|
||||
},
|
||||
"subtitle": {
|
||||
"mode": "off",
|
||||
"inventory": [
|
||||
{
|
||||
"track_id": "file:42:subtitle:0",
|
||||
"combined_index": 0,
|
||||
"source": "external",
|
||||
"codec": "srt",
|
||||
"language": "eng",
|
||||
"label": "English",
|
||||
"forced": false,
|
||||
"default": false,
|
||||
"hearing_impaired": false,
|
||||
"delivery": "sidecar",
|
||||
"url": "/stream/11111111-1111-4111-8111-111111111111/subtitles/0.vtt?file_id=42"
|
||||
},
|
||||
{
|
||||
"track_id": "file:42:subtitle:1",
|
||||
"combined_index": 1,
|
||||
"source": "embedded",
|
||||
"codec": "ass",
|
||||
"language": "eng",
|
||||
"label": "English (Signs)",
|
||||
"forced": true,
|
||||
"default": false,
|
||||
"hearing_impaired": false,
|
||||
"delivery": "sidecar",
|
||||
"url": "/stream/11111111-1111-4111-8111-111111111111/subtitles/1.ass?file_id=42",
|
||||
"font_bundle_url": "/stream/11111111-1111-4111-8111-111111111111/subtitles/1/fonts?file_id=42"
|
||||
},
|
||||
{
|
||||
"track_id": "file:42:subtitle:2",
|
||||
"combined_index": 2,
|
||||
"source": "embedded",
|
||||
"codec": "pgs",
|
||||
"language": "jpn",
|
||||
"label": "Japanese",
|
||||
"forced": false,
|
||||
"default": false,
|
||||
"hearing_impaired": false,
|
||||
"delivery": "sidecar",
|
||||
"url": "/stream/11111111-1111-4111-8111-111111111111/subtitles/2.sup?file_id=42"
|
||||
},
|
||||
{
|
||||
"track_id": "file:42:subtitle:3",
|
||||
"combined_index": 3,
|
||||
"source": "embedded",
|
||||
"codec": "dvd_subtitle",
|
||||
"language": "fre",
|
||||
"label": "French",
|
||||
"forced": false,
|
||||
"default": false,
|
||||
"hearing_impaired": false,
|
||||
"delivery": "burn_in_only"
|
||||
},
|
||||
{
|
||||
"track_id": "file:42:subtitle:4",
|
||||
"combined_index": 4,
|
||||
"source": "downloaded",
|
||||
"codec": "srt",
|
||||
"language": "spa",
|
||||
"label": "Spanish (downloaded)",
|
||||
"forced": false,
|
||||
"default": false,
|
||||
"hearing_impaired": false,
|
||||
"delivery": "sidecar",
|
||||
"url": "/stream/11111111-1111-4111-8111-111111111111/subtitles/4.vtt?file_id=42"
|
||||
}
|
||||
]
|
||||
},
|
||||
"transformations": [],
|
||||
"applied_quirks": [],
|
||||
"runtime_corrections": [],
|
||||
"available_qualities": [
|
||||
{
|
||||
"label": "original",
|
||||
"height": 1080,
|
||||
"bitrate_kbps": 8000,
|
||||
"preserves_source": true
|
||||
}
|
||||
],
|
||||
"degradation_warnings": [],
|
||||
"decision_reason": "validated_original_playback",
|
||||
"requested_media_file_id": 42,
|
||||
"effective_media_file_id": 42,
|
||||
"source": {
|
||||
"media_file_id": 42,
|
||||
"duration_seconds": 7200,
|
||||
"container": "mp4",
|
||||
"video_codec": "h264",
|
||||
"video_profile": "high",
|
||||
"video_level": 41,
|
||||
"bit_depth": 8,
|
||||
"width": 1920,
|
||||
"height": 1080,
|
||||
"frame_rate": 23.976023976023978,
|
||||
"bitrate_kbps": 8000,
|
||||
"dynamic_range": "sdr",
|
||||
"hdr10_plus": false,
|
||||
"dv_enhancement_layer": "none",
|
||||
"audio_codec": "aac",
|
||||
"audio_channels": 2,
|
||||
"audio_layout": "stereo"
|
||||
},
|
||||
"subtitle_fidelity_policy": "allow_simplified_rendering"
|
||||
}
|
||||
}
|
||||
@@ -1,4 +0,0 @@
|
||||
{
|
||||
"error": "client_upgrade_required",
|
||||
"message": "This server requires playback protocol v3. Update the app to continue."
|
||||
}
|
||||
@@ -1,113 +0,0 @@
|
||||
{
|
||||
"protocol_version": 3,
|
||||
"client_features": [
|
||||
"playback_plan_v3"
|
||||
],
|
||||
"operation": "failure_recovery",
|
||||
"playback_attempt_id": "attempt-golden-0001",
|
||||
"replan_request_id": "replan-golden-0001",
|
||||
"failed_plan_id": "plan:478677870860e5e5108c18bff749b34b",
|
||||
"plan_attempt_id": "plan-attempt-golden-0001",
|
||||
"plan_attempt_key": "v3:f0144c47fa349e3e",
|
||||
"attempted_plan_keys": [
|
||||
"v3:f0144c47fa349e3e"
|
||||
],
|
||||
"attempt_count": 1,
|
||||
"quality_preference": "auto",
|
||||
"position_seconds": 42.5,
|
||||
"metered": true,
|
||||
"bandwidth_estimate_kbps": 3500,
|
||||
"bandwidth_cap_kbps": 4000,
|
||||
"selected_tracks": {
|
||||
"audio": {
|
||||
"id": "file:42:audio:0",
|
||||
"index": 0
|
||||
}
|
||||
},
|
||||
"failure": {
|
||||
"classification": "network_degraded"
|
||||
},
|
||||
"client_capabilities": {
|
||||
"video_evidence": "exact",
|
||||
"audio_evidence": "exact",
|
||||
"codecs_video": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_video_hardware": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_audio": [
|
||||
"aac"
|
||||
],
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"max_resolution": "1080p",
|
||||
"hdr": false,
|
||||
"video_decode": [
|
||||
{
|
||||
"codec": "h264",
|
||||
"profiles": [
|
||||
"high"
|
||||
],
|
||||
"levels": [
|
||||
41
|
||||
],
|
||||
"bit_depths": [
|
||||
8
|
||||
],
|
||||
"max_width": 1920,
|
||||
"max_height": 1080,
|
||||
"max_frame_rate": 60,
|
||||
"max_bitrate_kbps": 20000,
|
||||
"hardware": true
|
||||
}
|
||||
]
|
||||
},
|
||||
"client_playback_context": {
|
||||
"protocol_version": 3,
|
||||
"form_factor": "tv",
|
||||
"app_version": "3.0-test",
|
||||
"device": {
|
||||
"platform": "android",
|
||||
"os_version": "15",
|
||||
"manufacturer": "NVIDIA",
|
||||
"model": "SHIELD Android TV",
|
||||
"platform_details": {
|
||||
"abis": "arm64-v8a",
|
||||
"sdk_int": "35"
|
||||
}
|
||||
},
|
||||
"output": {
|
||||
"output_context_id": "7"
|
||||
},
|
||||
"deliveries": {
|
||||
"original_http": {
|
||||
"enabled": true,
|
||||
"supported_on_device": true,
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"video_codecs": [
|
||||
"h264"
|
||||
],
|
||||
"audio_decode_codecs": [
|
||||
"aac"
|
||||
],
|
||||
"audio_passthrough_codecs": [],
|
||||
"subtitles": {
|
||||
"embedded_text": true,
|
||||
"sidecar_text": true,
|
||||
"ass_styling": false,
|
||||
"embedded_bitmap": false,
|
||||
"sidecar_bitmap": false,
|
||||
"font_attachments": false
|
||||
},
|
||||
"features": [],
|
||||
"auth_header_refresh": true,
|
||||
"validated_claims": [],
|
||||
"transformations": []
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,15 +0,0 @@
|
||||
{
|
||||
"protocol_version": 3,
|
||||
"playback_attempt_id": "attempt-golden-0001",
|
||||
"session_id": "11111111-1111-4111-8111-111111111111",
|
||||
"plan_id": "plan:478677870860e5e5108c18bff749b34b",
|
||||
"plan_attempt_id": "plan-attempt-golden-0001",
|
||||
"plan_attempt_key": "v3:f0144c47fa349e3e",
|
||||
"event": "first_frame",
|
||||
"output_context_id": "7",
|
||||
"diagnostics": {
|
||||
"decoder_name": "c2.android.avc.decoder",
|
||||
"first_frame_ms": "412",
|
||||
"video_mime": "video/avc"
|
||||
}
|
||||
}
|
||||
@@ -1,99 +0,0 @@
|
||||
{
|
||||
"protocol_version": 3,
|
||||
"client_features": [
|
||||
"playback_plan_v3"
|
||||
],
|
||||
"file_id": 42,
|
||||
"profile_id": "profile-1",
|
||||
"playback_attempt_id": "attempt-golden-0001",
|
||||
"quality_preference": "original",
|
||||
"subtitle_fidelity_preference": "compatible",
|
||||
"start_position": 12.5,
|
||||
"progress_persistence": "client",
|
||||
"audio_track_id": "file:42:audio:0",
|
||||
"audio_track_index": 0,
|
||||
"metered": false,
|
||||
"client_capabilities": {
|
||||
"video_evidence": "exact",
|
||||
"audio_evidence": "exact",
|
||||
"codecs_video": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_video_hardware": [
|
||||
"h264"
|
||||
],
|
||||
"codecs_audio": [
|
||||
"aac"
|
||||
],
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"max_resolution": "1080p",
|
||||
"hdr": false,
|
||||
"video_decode": [
|
||||
{
|
||||
"codec": "h264",
|
||||
"profiles": [
|
||||
"high"
|
||||
],
|
||||
"levels": [
|
||||
41
|
||||
],
|
||||
"bit_depths": [
|
||||
8
|
||||
],
|
||||
"max_width": 1920,
|
||||
"max_height": 1080,
|
||||
"max_frame_rate": 60,
|
||||
"max_bitrate_kbps": 20000,
|
||||
"hardware": true
|
||||
}
|
||||
]
|
||||
},
|
||||
"client_playback_context": {
|
||||
"protocol_version": 3,
|
||||
"form_factor": "tv",
|
||||
"app_version": "3.0-test",
|
||||
"device": {
|
||||
"platform": "android",
|
||||
"os_version": "15",
|
||||
"manufacturer": "NVIDIA",
|
||||
"model": "SHIELD Android TV",
|
||||
"platform_details": {
|
||||
"abis": "arm64-v8a",
|
||||
"sdk_int": "35"
|
||||
}
|
||||
},
|
||||
"output": {
|
||||
"output_context_id": "7"
|
||||
},
|
||||
"deliveries": {
|
||||
"original_http": {
|
||||
"enabled": true,
|
||||
"supported_on_device": true,
|
||||
"containers": [
|
||||
"mp4"
|
||||
],
|
||||
"video_codecs": [
|
||||
"h264"
|
||||
],
|
||||
"audio_decode_codecs": [
|
||||
"aac"
|
||||
],
|
||||
"audio_passthrough_codecs": [],
|
||||
"subtitles": {
|
||||
"embedded_text": true,
|
||||
"sidecar_text": true,
|
||||
"ass_styling": false,
|
||||
"embedded_bitmap": false,
|
||||
"sidecar_bitmap": false,
|
||||
"font_attachments": false
|
||||
},
|
||||
"features": [],
|
||||
"auth_header_refresh": true,
|
||||
"validated_claims": [],
|
||||
"transformations": []
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,761 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://silo-server.dev/schemas/playback-v3/v3/replan-request.schema.json",
|
||||
"title": "Silo Playback Protocol v3 Replan Request",
|
||||
"description": "Body of POST /api/v1/playback/{session_id}/replan. Bounds mirror ReplanRequestV3.Validate and validateCapabilitiesV3 in internal/playback/protocol_v3.go. STRING LENGTHS: every `maxLength` here is a character count, while the server enforces the same limit as a UTF-8 byte length (Go `len(string)`), so a value near a cap that contains multi-byte characters can satisfy this schema yet be rejected at ingest. JSON Schema cannot express byte length, so the divergence is documented rather than encoded.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"protocol_version",
|
||||
"playback_attempt_id",
|
||||
"replan_request_id",
|
||||
"failed_plan_id",
|
||||
"plan_attempt_id",
|
||||
"plan_attempt_key",
|
||||
"attempt_count",
|
||||
"client_capabilities",
|
||||
"client_playback_context"
|
||||
],
|
||||
"properties": {
|
||||
"protocol_version": {
|
||||
"type": "integer",
|
||||
"const": 3
|
||||
},
|
||||
"client_features": {
|
||||
"$ref": "#/$defs/feature_list"
|
||||
},
|
||||
"operation": {
|
||||
"type": "string",
|
||||
"description": "Omitted means failure_recovery, which keeps callers that predate the field on the ordinary recovery path. Seek operations are opt-in because both pin the current media version and user intent.",
|
||||
"enum": [
|
||||
"failure_recovery",
|
||||
"seek_reanchor",
|
||||
"seek_failure_recovery",
|
||||
"track_change",
|
||||
"quality_change",
|
||||
"output_change"
|
||||
],
|
||||
"maxLength": 32
|
||||
},
|
||||
"playback_attempt_id": {
|
||||
"$ref": "#/$defs/bounded_identifier"
|
||||
},
|
||||
"replan_request_id": {
|
||||
"$ref": "#/$defs/bounded_identifier"
|
||||
},
|
||||
"failed_plan_id": {
|
||||
"$ref": "#/$defs/opaque_plan_token"
|
||||
},
|
||||
"plan_attempt_id": {
|
||||
"$ref": "#/$defs/opaque_plan_token"
|
||||
},
|
||||
"plan_attempt_key": {
|
||||
"$ref": "#/$defs/plan_attempt_key"
|
||||
},
|
||||
"attempted_plan_keys": {
|
||||
"type": "array",
|
||||
"description": "Keys of the plans this attempt has already tried, echoed back verbatim so the server can refuse to hand out a plan that already failed on this output route.",
|
||||
"maxItems": 16,
|
||||
"items": {
|
||||
"$ref": "#/$defs/plan_attempt_key"
|
||||
}
|
||||
},
|
||||
"local_mutations": {
|
||||
"type": "array",
|
||||
"description": "Client-applied local plan mutations, so the server can fold them into the attempt key it computes for the failed plan. Clients never hash anything themselves.",
|
||||
"maxItems": 8,
|
||||
"items": {
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"maxLength": 64
|
||||
}
|
||||
},
|
||||
"attempt_count": {
|
||||
"type": "integer",
|
||||
"minimum": 1,
|
||||
"maximum": 8
|
||||
},
|
||||
"quality_preference": {
|
||||
"type": "string",
|
||||
"description": "Free-form and deliberately unbounded, normalized the same way as on a start request. A quality_change operation must name a non-blank rung: an empty preference would silently mean \"auto\", which is a different user intent than the menu selection that operation models."
|
||||
},
|
||||
"position_seconds": {
|
||||
"type": "number",
|
||||
"minimum": 0,
|
||||
"maximum": 31536000
|
||||
},
|
||||
"metered": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"bandwidth_estimate_kbps": {
|
||||
"$ref": "#/$defs/bandwidth_kbps"
|
||||
},
|
||||
"bandwidth_cap_kbps": {
|
||||
"$ref": "#/$defs/bandwidth_kbps"
|
||||
},
|
||||
"selected_tracks": {
|
||||
"$ref": "#/$defs/selected_tracks"
|
||||
},
|
||||
"failure": {
|
||||
"$ref": "#/$defs/failure"
|
||||
},
|
||||
"client_capabilities": {
|
||||
"$ref": "#/$defs/client_capabilities"
|
||||
},
|
||||
"client_playback_context": {
|
||||
"$ref": "#/$defs/client_playback_context"
|
||||
}
|
||||
},
|
||||
"$defs": {
|
||||
"bounded_identifier": {
|
||||
"type": "string",
|
||||
"description": "Opaque client-minted identifier. The server matches ^[A-Za-z0-9][A-Za-z0-9._:-]{7,127}$, so the value is 8 to 128 characters and starts alphanumeric.",
|
||||
"pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{7,127}$",
|
||||
"minLength": 8,
|
||||
"maxLength": 128
|
||||
},
|
||||
"opaque_plan_token": {
|
||||
"type": "string",
|
||||
"description": "Server-minted plan identity echoed back verbatim. Clients store and return these tokens and never parse or recompute them.",
|
||||
"minLength": 8,
|
||||
"maxLength": 128
|
||||
},
|
||||
"plan_attempt_key": {
|
||||
"type": "string",
|
||||
"description": "Server-computed opaque loop-prevention token. Always carries the `v3:` prefix; the server compares keys byte-for-byte, so case and whitespace are significant.",
|
||||
"pattern": "^v3:",
|
||||
"minLength": 8,
|
||||
"maxLength": 128
|
||||
},
|
||||
"track_identity": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
},
|
||||
"index": {
|
||||
"$ref": "#/$defs/track_index"
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"selected_tracks": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"audio": {
|
||||
"$ref": "#/$defs/track_identity"
|
||||
},
|
||||
"subtitle": {
|
||||
"$ref": "#/$defs/track_identity"
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"failure": {
|
||||
"type": "object",
|
||||
"description": "Required for failure_recovery and seek_failure_recovery: both need a non-empty classification. Intent operations carry no failure.",
|
||||
"properties": {
|
||||
"classification": {
|
||||
"type": "string",
|
||||
"maxLength": 64
|
||||
},
|
||||
"message": {
|
||||
"type": "string",
|
||||
"maxLength": 512
|
||||
},
|
||||
"decoder_name": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"track_index": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 10000
|
||||
},
|
||||
"bandwidth_kbps": {
|
||||
"type": "integer",
|
||||
"minimum": 100,
|
||||
"maximum": 1000000
|
||||
},
|
||||
"feature_list": {
|
||||
"type": "array",
|
||||
"maxItems": 64,
|
||||
"items": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
}
|
||||
},
|
||||
"capability_value_list": {
|
||||
"type": "array",
|
||||
"maxItems": 64,
|
||||
"items": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
}
|
||||
},
|
||||
"delivery_value_list": {
|
||||
"type": "array",
|
||||
"maxItems": 64,
|
||||
"items": {
|
||||
"type": "string",
|
||||
"maxLength": 64
|
||||
}
|
||||
},
|
||||
"capability_evidence": {
|
||||
"type": "string",
|
||||
"description": "How the capability facts were produced. `exact` is a real platform probe with per-codec profiles/levels/bounds, `platform_attested` a decoder attestation without profile enumeration, `declared` a boolean support statement. Planner strictness follows the tier.",
|
||||
"enum": [
|
||||
"exact",
|
||||
"platform_attested",
|
||||
"declared"
|
||||
],
|
||||
"maxLength": 32
|
||||
},
|
||||
"hdr_capabilities": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"hdr10": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"hdr10_plus": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"hlg": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"hdr10_max_width": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"hdr10_max_height": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"hdr10_max_frame_rate": {
|
||||
"type": "number",
|
||||
"minimum": 0
|
||||
},
|
||||
"hdr10_max_bitrate_kbps": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"dolby_vision_profiles": {
|
||||
"type": "array",
|
||||
"maxItems": 16,
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"dolby_vision_profile_levels": {
|
||||
"type": "array",
|
||||
"maxItems": 16,
|
||||
"items": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"profile",
|
||||
"max_level"
|
||||
],
|
||||
"properties": {
|
||||
"profile": {
|
||||
"type": "integer",
|
||||
"minimum": 1
|
||||
},
|
||||
"max_level": {
|
||||
"type": "integer",
|
||||
"minimum": 1,
|
||||
"maximum": 13
|
||||
},
|
||||
"bl_compatibility_ids": {
|
||||
"type": "array",
|
||||
"maxItems": 16,
|
||||
"uniqueItems": true,
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 15
|
||||
}
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"if": {
|
||||
"anyOf": [
|
||||
{ "required": ["hdr10_max_width"] },
|
||||
{ "required": ["hdr10_max_height"] },
|
||||
{ "required": ["hdr10_max_frame_rate"] },
|
||||
{ "required": ["hdr10_max_bitrate_kbps"] }
|
||||
]
|
||||
},
|
||||
"then": {
|
||||
"required": ["hdr10"],
|
||||
"properties": { "hdr10": { "const": true } }
|
||||
}
|
||||
}
|
||||
],
|
||||
"additionalProperties": true
|
||||
},
|
||||
"audio_passthrough": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"passthrough_codecs": {
|
||||
"$ref": "#/$defs/delivery_value_list"
|
||||
},
|
||||
"spatializer_enabled": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"max_channels": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 64
|
||||
},
|
||||
"entries": {
|
||||
"type": "array",
|
||||
"maxItems": 64,
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"codec": {
|
||||
"type": "string",
|
||||
"maxLength": 64
|
||||
},
|
||||
"channel_counts": {
|
||||
"type": "array",
|
||||
"maxItems": 32,
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"layouts": {
|
||||
"type": "array",
|
||||
"maxItems": 32,
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"video_decode_capability": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"codec"
|
||||
],
|
||||
"properties": {
|
||||
"codec": {
|
||||
"type": "string",
|
||||
"minLength": 1
|
||||
},
|
||||
"decoder_name": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
},
|
||||
"profiles": {
|
||||
"type": "array",
|
||||
"maxItems": 64,
|
||||
"items": {
|
||||
"type": "string",
|
||||
"maxLength": 64
|
||||
}
|
||||
},
|
||||
"levels": {
|
||||
"type": "array",
|
||||
"maxItems": 64,
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"bit_depths": {
|
||||
"type": "array",
|
||||
"maxItems": 64,
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"max_width": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"max_height": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"max_frame_rate": {
|
||||
"type": "number",
|
||||
"minimum": 0
|
||||
},
|
||||
"max_bitrate_kbps": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"hardware": {
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"client_capabilities": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"video_evidence",
|
||||
"audio_evidence"
|
||||
],
|
||||
"properties": {
|
||||
"video_evidence": {
|
||||
"$ref": "#/$defs/capability_evidence"
|
||||
},
|
||||
"audio_evidence": {
|
||||
"$ref": "#/$defs/capability_evidence"
|
||||
},
|
||||
"codecs_video": {
|
||||
"$ref": "#/$defs/capability_value_list"
|
||||
},
|
||||
"codecs_video_hardware": {
|
||||
"$ref": "#/$defs/capability_value_list"
|
||||
},
|
||||
"codecs_audio": {
|
||||
"$ref": "#/$defs/capability_value_list"
|
||||
},
|
||||
"containers": {
|
||||
"$ref": "#/$defs/capability_value_list"
|
||||
},
|
||||
"max_resolution": {
|
||||
"type": "string",
|
||||
"maxLength": 32
|
||||
},
|
||||
"hdr": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"hdr_details": {
|
||||
"$ref": "#/$defs/hdr_capabilities"
|
||||
},
|
||||
"audio_passthrough": {
|
||||
"$ref": "#/$defs/audio_passthrough"
|
||||
},
|
||||
"video_decode": {
|
||||
"type": "array",
|
||||
"maxItems": 64,
|
||||
"items": {
|
||||
"$ref": "#/$defs/video_decode_capability"
|
||||
}
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"transformation_capability": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"name",
|
||||
"executor",
|
||||
"recipe_version"
|
||||
],
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"maxLength": 64
|
||||
},
|
||||
"executor": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"client",
|
||||
"server"
|
||||
]
|
||||
},
|
||||
"recipe_version": {
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"maxLength": 32
|
||||
},
|
||||
"validated_claims": {
|
||||
"type": "array",
|
||||
"maxItems": 32,
|
||||
"items": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
}
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"delivery_capability": {
|
||||
"type": "object",
|
||||
"description": "One negotiated delivery class the client can execute. A `client` executor transformation is only accepted on a delivery that is enabled and supported_on_device, and only when client_features advertises client_video_transformations_v1; (executor, name, recipe_version) must be unique within the delivery.",
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"supported_on_device": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"failure_reason": {
|
||||
"type": "string"
|
||||
},
|
||||
"containers": {
|
||||
"$ref": "#/$defs/delivery_value_list"
|
||||
},
|
||||
"video_codecs": {
|
||||
"$ref": "#/$defs/delivery_value_list"
|
||||
},
|
||||
"audio_decode_codecs": {
|
||||
"$ref": "#/$defs/delivery_value_list"
|
||||
},
|
||||
"audio_passthrough_codecs": {
|
||||
"$ref": "#/$defs/delivery_value_list"
|
||||
},
|
||||
"max_channels": {
|
||||
"type": "integer"
|
||||
},
|
||||
"hdr_details": {
|
||||
"$ref": "#/$defs/hdr_capabilities"
|
||||
},
|
||||
"subtitles": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"embedded_text": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"sidecar_text": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"ass_styling": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"embedded_bitmap": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"sidecar_bitmap": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"font_attachments": {
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"features": {
|
||||
"$ref": "#/$defs/delivery_value_list"
|
||||
},
|
||||
"auth_header_refresh": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"validated_claims": {
|
||||
"$ref": "#/$defs/delivery_value_list"
|
||||
},
|
||||
"transformations": {
|
||||
"type": "array",
|
||||
"maxItems": 16,
|
||||
"items": {
|
||||
"$ref": "#/$defs/transformation_capability"
|
||||
}
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"client_playback_context": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"protocol_version"
|
||||
],
|
||||
"properties": {
|
||||
"protocol_version": {
|
||||
"type": "integer",
|
||||
"const": 3
|
||||
},
|
||||
"form_factor": {
|
||||
"type": "string",
|
||||
"maxLength": 32
|
||||
},
|
||||
"app_version": {
|
||||
"type": "string",
|
||||
"maxLength": 64
|
||||
},
|
||||
"app_build": {
|
||||
"type": "string",
|
||||
"maxLength": 64
|
||||
},
|
||||
"app_channel": {
|
||||
"type": "string",
|
||||
"maxLength": 32
|
||||
},
|
||||
"device": {
|
||||
"type": "object",
|
||||
"description": "Manufacturer and model stay first-class because the device-quirk registry matches on them. Everything platform-specific travels in platform_details as opaque bounded strings.",
|
||||
"properties": {
|
||||
"platform": {
|
||||
"type": "string",
|
||||
"maxLength": 32
|
||||
},
|
||||
"os_version": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
},
|
||||
"manufacturer": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
},
|
||||
"model": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
},
|
||||
"platform_details": {
|
||||
"type": "object",
|
||||
"maxProperties": 16,
|
||||
"propertyNames": {
|
||||
"minLength": 1,
|
||||
"maxLength": 128
|
||||
},
|
||||
"additionalProperties": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
}
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"output": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"hdr_details": {
|
||||
"$ref": "#/$defs/hdr_capabilities"
|
||||
},
|
||||
"audio_passthrough": {
|
||||
"$ref": "#/$defs/audio_passthrough"
|
||||
},
|
||||
"current_sink": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
},
|
||||
"sink_type": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
},
|
||||
"output_context_id": {
|
||||
"type": "string",
|
||||
"description": "Opaque token identifying the current output route. The server only ever compares it for equality, so any stable platform-native identity works and omitting it is valid.",
|
||||
"maxLength": 128
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"deliveries": {
|
||||
"type": "object",
|
||||
"description": "Keyed by delivery class: original_http, progressive, hls. A class the client omits is a class the planner will not route to.",
|
||||
"maxProperties": 16,
|
||||
"propertyNames": {
|
||||
"maxLength": 64
|
||||
},
|
||||
"additionalProperties": {
|
||||
"$ref": "#/$defs/delivery_capability"
|
||||
}
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$comment": "failure_recovery (the default when operation is omitted) and seek_failure_recovery require a non-empty failure classification; mirrors ReplanRequestV3.Validate in internal/playback/protocol_v3.go.",
|
||||
"if": {
|
||||
"anyOf": [
|
||||
{
|
||||
"not": {
|
||||
"required": [
|
||||
"operation"
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"properties": {
|
||||
"operation": {
|
||||
"enum": [
|
||||
"failure_recovery",
|
||||
"seek_failure_recovery"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"operation"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"then": {
|
||||
"required": [
|
||||
"failure"
|
||||
],
|
||||
"properties": {
|
||||
"failure": {
|
||||
"required": [
|
||||
"classification"
|
||||
],
|
||||
"properties": {
|
||||
"classification": {
|
||||
"minLength": 1
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"$comment": "quality_change must name the wanted rung; an empty preference would mean auto, a different user intent than the menu selection.",
|
||||
"if": {
|
||||
"properties": {
|
||||
"operation": {
|
||||
"const": "quality_change"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"operation"
|
||||
]
|
||||
},
|
||||
"then": {
|
||||
"required": [
|
||||
"quality_preference"
|
||||
],
|
||||
"properties": {
|
||||
"quality_preference": {
|
||||
"minLength": 1,
|
||||
"pattern": "\\S"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"$comment": "Intent-only replans describe a user or output change and must not carry route-failure evidence.",
|
||||
"if": {
|
||||
"properties": {
|
||||
"operation": {
|
||||
"enum": [
|
||||
"track_change",
|
||||
"quality_change",
|
||||
"output_change"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"operation"
|
||||
]
|
||||
},
|
||||
"then": {
|
||||
"not": {
|
||||
"required": [
|
||||
"failure"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"additionalProperties": true
|
||||
}
|
||||
@@ -1,95 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://silo-server.dev/schemas/playback-v3/v3/route-event.schema.json",
|
||||
"title": "Silo Playback Protocol v3 Route Event",
|
||||
"description": "Request body of POST /api/v1/playback/route-event: one event object, not a batch. Bounds mirror validRouteEventV3 in internal/api/handlers/playback_v3.go. The endpoint is telemetry, so the server rejects a malformed event rather than half-recording it; every bound here is a rejection, and the two behaviours that are not rejections — unknown diagnostics keys being dropped, long diagnostics values being truncated — are described rather than constrained.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"protocol_version",
|
||||
"playback_attempt_id",
|
||||
"event"
|
||||
],
|
||||
"properties": {
|
||||
"protocol_version": {
|
||||
"type": "integer",
|
||||
"const": 3
|
||||
},
|
||||
"playback_attempt_id": {
|
||||
"type": "string",
|
||||
"description": "The attempt this event belongs to, correlating every plan the client tried for one user-visible playback start.",
|
||||
"minLength": 8,
|
||||
"maxLength": 128
|
||||
},
|
||||
"session_id": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
},
|
||||
"plan_id": {
|
||||
"type": "string",
|
||||
"description": "Echoed from the plan being reported on. Opaque to clients.",
|
||||
"maxLength": 128
|
||||
},
|
||||
"plan_attempt_id": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
},
|
||||
"plan_attempt_key": {
|
||||
"type": "string",
|
||||
"description": "Echoed from the plan being reported on. Opaque to clients: never computed on the client side.",
|
||||
"maxLength": 128
|
||||
},
|
||||
"event": {
|
||||
"type": "string",
|
||||
"description": "The complete v3 telemetry contract. New names are added additively within v3; the server rejects a name it does not know, so a client must not invent one.",
|
||||
"enum": [
|
||||
"plan_selected",
|
||||
"plan_invalidated",
|
||||
"plan_failed",
|
||||
"first_frame",
|
||||
"terminal",
|
||||
"stopped",
|
||||
"runtime_correction_applied",
|
||||
"runtime_correction_succeeded",
|
||||
"runtime_correction_failed",
|
||||
"seek_reanchor_requested",
|
||||
"seek_reanchored"
|
||||
]
|
||||
},
|
||||
"failure_classification": {
|
||||
"type": "string",
|
||||
"description": "Neutral failure class, not a client-framework error string.",
|
||||
"maxLength": 64
|
||||
},
|
||||
"fallback_reason": {
|
||||
"type": "string",
|
||||
"maxLength": 64
|
||||
},
|
||||
"applied_quirk_ids": {
|
||||
"type": "array",
|
||||
"description": "Quirks the client actually applied, so a registry entry can be measured against real outcomes rather than assumed to work.",
|
||||
"maxItems": 16,
|
||||
"items": {
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"maxLength": 128
|
||||
}
|
||||
},
|
||||
"quirk_registry_revision": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
},
|
||||
"output_context_id": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
},
|
||||
"diagnostics": {
|
||||
"type": "object",
|
||||
"description": "Free-form key/value detail. The server keeps only keys on its allowlist and silently drops the rest, and trims each surviving value to 256 characters, so an unknown key or a long value is not a rejection — but more than 32 entries is.",
|
||||
"maxProperties": 32,
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
@@ -1,618 +0,0 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"$id": "https://silo-server.dev/schemas/playback-v3/v3/start-request.schema.json",
|
||||
"title": "Silo Playback Protocol v3 Start Request",
|
||||
"description": "Body of POST /api/v1/playback/start. Bounds mirror StartRequestV3.NormalizeAndValidate and validateCapabilitiesV3 in internal/playback/protocol_v3.go. STRING LENGTHS: every `maxLength` here is a character count, while the server enforces the same limit as a UTF-8 byte length (Go `len(string)`), so a value near a cap that contains multi-byte characters can satisfy this schema yet be rejected at ingest. JSON Schema cannot express byte length, so the divergence is documented rather than encoded.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"protocol_version",
|
||||
"file_id",
|
||||
"profile_id",
|
||||
"playback_attempt_id",
|
||||
"subtitle_fidelity_preference",
|
||||
"client_capabilities",
|
||||
"client_playback_context"
|
||||
],
|
||||
"properties": {
|
||||
"protocol_version": {
|
||||
"type": "integer",
|
||||
"const": 3
|
||||
},
|
||||
"client_features": {
|
||||
"$ref": "#/$defs/feature_list"
|
||||
},
|
||||
"file_id": {
|
||||
"type": "integer",
|
||||
"minimum": 1
|
||||
},
|
||||
"profile_id": {
|
||||
"type": "string",
|
||||
"description": "Must equal the X-Profile-Id header on the request; the server rejects a mismatch.",
|
||||
"minLength": 1
|
||||
},
|
||||
"playback_attempt_id": {
|
||||
"$ref": "#/$defs/bounded_identifier"
|
||||
},
|
||||
"quality_preference": {
|
||||
"type": "string",
|
||||
"description": "Free-form and deliberately unbounded: the server normalizes an unrecognized value to \"auto\" and returns a quality_preference_normalized degradation warning rather than rejecting the request. The values that survive normalization unchanged are auto, original, 2160p, 1080p, 720p and 480p."
|
||||
},
|
||||
"subtitle_fidelity_preference": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"preserve",
|
||||
"compatible"
|
||||
],
|
||||
"maxLength": 32
|
||||
},
|
||||
"start_position": {
|
||||
"type": "number",
|
||||
"description": "Where in the source to begin, in seconds. Omitting it asks the server for the profile's saved resume point (0 when there is none, when the item is already complete, or when the file is one part of a multipart item); sending 0 explicitly means start over. Resolved before planning, because the plan's timeline is cut at the start position.",
|
||||
"minimum": 0,
|
||||
"maximum": 31536000
|
||||
},
|
||||
"progress_persistence": {
|
||||
"type": "string",
|
||||
"description": "Who owns durable item resume/history persistence. Omission defaults to server. client keeps session heartbeats live but suppresses server item progress writes and requires an explicit start_position.",
|
||||
"enum": [
|
||||
"server",
|
||||
"client"
|
||||
],
|
||||
"default": "server"
|
||||
},
|
||||
"audio_track_id": {
|
||||
"description": "Omitting both audio fields asks the server for the profile's preferred track, resolved from the series preference, then the profile audio-language setting, then the library override. Sending either one selects exactly that track.",
|
||||
"$ref": "#/$defs/track_id"
|
||||
},
|
||||
"audio_track_index": {
|
||||
"$ref": "#/$defs/track_index"
|
||||
},
|
||||
"subtitle_track_id": {
|
||||
"$ref": "#/$defs/track_id"
|
||||
},
|
||||
"subtitle_track_index": {
|
||||
"$ref": "#/$defs/track_index"
|
||||
},
|
||||
"metered": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"bandwidth_estimate_kbps": {
|
||||
"$ref": "#/$defs/bandwidth_kbps"
|
||||
},
|
||||
"bandwidth_cap_kbps": {
|
||||
"$ref": "#/$defs/bandwidth_kbps"
|
||||
},
|
||||
"client_capabilities": {
|
||||
"$ref": "#/$defs/client_capabilities"
|
||||
},
|
||||
"client_playback_context": {
|
||||
"$ref": "#/$defs/client_playback_context"
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"if": {
|
||||
"properties": {
|
||||
"progress_persistence": {
|
||||
"const": "client"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"progress_persistence"
|
||||
]
|
||||
},
|
||||
"then": {
|
||||
"required": [
|
||||
"start_position"
|
||||
]
|
||||
}
|
||||
}
|
||||
],
|
||||
"$defs": {
|
||||
"bounded_identifier": {
|
||||
"type": "string",
|
||||
"description": "Opaque client-minted identifier. The server matches ^[A-Za-z0-9][A-Za-z0-9._:-]{7,127}$, so the value is 8 to 128 characters and starts alphanumeric.",
|
||||
"pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{7,127}$",
|
||||
"minLength": 8,
|
||||
"maxLength": 128
|
||||
},
|
||||
"track_id": {
|
||||
"type": "string",
|
||||
"description": "Combined-ordinal track identity `file:{file_id}:{audio|subtitle}:{ordinal}`. When the matching index field is also sent the two must agree; the server rebuilds the identity from file_id and index and compares byte-for-byte.",
|
||||
"maxLength": 128
|
||||
},
|
||||
"track_index": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 10000
|
||||
},
|
||||
"bandwidth_kbps": {
|
||||
"type": "integer",
|
||||
"minimum": 100,
|
||||
"maximum": 1000000
|
||||
},
|
||||
"feature_list": {
|
||||
"type": "array",
|
||||
"maxItems": 64,
|
||||
"items": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
}
|
||||
},
|
||||
"capability_value_list": {
|
||||
"type": "array",
|
||||
"maxItems": 64,
|
||||
"items": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
}
|
||||
},
|
||||
"delivery_value_list": {
|
||||
"type": "array",
|
||||
"maxItems": 64,
|
||||
"items": {
|
||||
"type": "string",
|
||||
"maxLength": 64
|
||||
}
|
||||
},
|
||||
"capability_evidence": {
|
||||
"type": "string",
|
||||
"description": "How the capability facts were produced. `exact` is a real platform probe with per-codec profiles/levels/bounds, `platform_attested` a decoder attestation without profile enumeration, `declared` a boolean support statement. Planner strictness follows the tier.",
|
||||
"enum": [
|
||||
"exact",
|
||||
"platform_attested",
|
||||
"declared"
|
||||
],
|
||||
"maxLength": 32
|
||||
},
|
||||
"hdr_capabilities": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"hdr10": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"hdr10_plus": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"hlg": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"hdr10_max_width": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"hdr10_max_height": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"hdr10_max_frame_rate": {
|
||||
"type": "number",
|
||||
"minimum": 0
|
||||
},
|
||||
"hdr10_max_bitrate_kbps": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"dolby_vision_profiles": {
|
||||
"type": "array",
|
||||
"maxItems": 16,
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"dolby_vision_profile_levels": {
|
||||
"type": "array",
|
||||
"maxItems": 16,
|
||||
"items": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"profile",
|
||||
"max_level"
|
||||
],
|
||||
"properties": {
|
||||
"profile": {
|
||||
"type": "integer",
|
||||
"minimum": 1
|
||||
},
|
||||
"max_level": {
|
||||
"type": "integer",
|
||||
"minimum": 1,
|
||||
"maximum": 13
|
||||
},
|
||||
"bl_compatibility_ids": {
|
||||
"type": "array",
|
||||
"maxItems": 16,
|
||||
"uniqueItems": true,
|
||||
"items": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 15
|
||||
}
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"if": {
|
||||
"anyOf": [
|
||||
{ "required": ["hdr10_max_width"] },
|
||||
{ "required": ["hdr10_max_height"] },
|
||||
{ "required": ["hdr10_max_frame_rate"] },
|
||||
{ "required": ["hdr10_max_bitrate_kbps"] }
|
||||
]
|
||||
},
|
||||
"then": {
|
||||
"required": ["hdr10"],
|
||||
"properties": { "hdr10": { "const": true } }
|
||||
}
|
||||
}
|
||||
],
|
||||
"additionalProperties": true
|
||||
},
|
||||
"audio_passthrough": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"passthrough_codecs": {
|
||||
"$ref": "#/$defs/delivery_value_list"
|
||||
},
|
||||
"spatializer_enabled": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"max_channels": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 64
|
||||
},
|
||||
"entries": {
|
||||
"type": "array",
|
||||
"maxItems": 64,
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"codec": {
|
||||
"type": "string",
|
||||
"maxLength": 64
|
||||
},
|
||||
"channel_counts": {
|
||||
"type": "array",
|
||||
"maxItems": 32,
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"layouts": {
|
||||
"type": "array",
|
||||
"maxItems": 32,
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"video_decode_capability": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"codec"
|
||||
],
|
||||
"properties": {
|
||||
"codec": {
|
||||
"type": "string",
|
||||
"minLength": 1
|
||||
},
|
||||
"decoder_name": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
},
|
||||
"profiles": {
|
||||
"type": "array",
|
||||
"maxItems": 64,
|
||||
"items": {
|
||||
"type": "string",
|
||||
"maxLength": 64
|
||||
}
|
||||
},
|
||||
"levels": {
|
||||
"type": "array",
|
||||
"maxItems": 64,
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"bit_depths": {
|
||||
"type": "array",
|
||||
"maxItems": 64,
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"max_width": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"max_height": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"max_frame_rate": {
|
||||
"type": "number",
|
||||
"minimum": 0
|
||||
},
|
||||
"max_bitrate_kbps": {
|
||||
"type": "integer",
|
||||
"minimum": 0
|
||||
},
|
||||
"hardware": {
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"client_capabilities": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"video_evidence",
|
||||
"audio_evidence"
|
||||
],
|
||||
"properties": {
|
||||
"video_evidence": {
|
||||
"$ref": "#/$defs/capability_evidence"
|
||||
},
|
||||
"audio_evidence": {
|
||||
"$ref": "#/$defs/capability_evidence"
|
||||
},
|
||||
"codecs_video": {
|
||||
"$ref": "#/$defs/capability_value_list"
|
||||
},
|
||||
"codecs_video_hardware": {
|
||||
"$ref": "#/$defs/capability_value_list"
|
||||
},
|
||||
"codecs_audio": {
|
||||
"$ref": "#/$defs/capability_value_list"
|
||||
},
|
||||
"containers": {
|
||||
"$ref": "#/$defs/capability_value_list"
|
||||
},
|
||||
"max_resolution": {
|
||||
"type": "string",
|
||||
"maxLength": 32
|
||||
},
|
||||
"hdr": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"hdr_details": {
|
||||
"$ref": "#/$defs/hdr_capabilities"
|
||||
},
|
||||
"audio_passthrough": {
|
||||
"$ref": "#/$defs/audio_passthrough"
|
||||
},
|
||||
"video_decode": {
|
||||
"type": "array",
|
||||
"maxItems": 64,
|
||||
"items": {
|
||||
"$ref": "#/$defs/video_decode_capability"
|
||||
}
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"transformation_capability": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"name",
|
||||
"executor",
|
||||
"recipe_version"
|
||||
],
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"maxLength": 64
|
||||
},
|
||||
"executor": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"client",
|
||||
"server"
|
||||
]
|
||||
},
|
||||
"recipe_version": {
|
||||
"type": "string",
|
||||
"minLength": 1,
|
||||
"maxLength": 32
|
||||
},
|
||||
"validated_claims": {
|
||||
"type": "array",
|
||||
"maxItems": 32,
|
||||
"items": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
}
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"delivery_capability": {
|
||||
"type": "object",
|
||||
"description": "One negotiated delivery class the client can execute. A `client` executor transformation is only accepted on a delivery that is enabled and supported_on_device, and only when client_features advertises client_video_transformations_v1; (executor, name, recipe_version) must be unique within the delivery.",
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"supported_on_device": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"failure_reason": {
|
||||
"type": "string"
|
||||
},
|
||||
"containers": {
|
||||
"$ref": "#/$defs/delivery_value_list"
|
||||
},
|
||||
"video_codecs": {
|
||||
"$ref": "#/$defs/delivery_value_list"
|
||||
},
|
||||
"audio_decode_codecs": {
|
||||
"$ref": "#/$defs/delivery_value_list"
|
||||
},
|
||||
"audio_passthrough_codecs": {
|
||||
"$ref": "#/$defs/delivery_value_list"
|
||||
},
|
||||
"max_channels": {
|
||||
"type": "integer"
|
||||
},
|
||||
"hdr_details": {
|
||||
"$ref": "#/$defs/hdr_capabilities"
|
||||
},
|
||||
"subtitles": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"embedded_text": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"sidecar_text": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"ass_styling": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"embedded_bitmap": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"sidecar_bitmap": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"font_attachments": {
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"features": {
|
||||
"$ref": "#/$defs/delivery_value_list"
|
||||
},
|
||||
"auth_header_refresh": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"validated_claims": {
|
||||
"$ref": "#/$defs/delivery_value_list"
|
||||
},
|
||||
"transformations": {
|
||||
"type": "array",
|
||||
"maxItems": 16,
|
||||
"items": {
|
||||
"$ref": "#/$defs/transformation_capability"
|
||||
}
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"client_playback_context": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"protocol_version"
|
||||
],
|
||||
"properties": {
|
||||
"protocol_version": {
|
||||
"type": "integer",
|
||||
"const": 3
|
||||
},
|
||||
"form_factor": {
|
||||
"type": "string",
|
||||
"maxLength": 32
|
||||
},
|
||||
"app_version": {
|
||||
"type": "string",
|
||||
"maxLength": 64
|
||||
},
|
||||
"app_build": {
|
||||
"type": "string",
|
||||
"maxLength": 64
|
||||
},
|
||||
"app_channel": {
|
||||
"type": "string",
|
||||
"maxLength": 32
|
||||
},
|
||||
"device": {
|
||||
"type": "object",
|
||||
"description": "Manufacturer and model stay first-class because the device-quirk registry matches on them. Everything platform-specific travels in platform_details as opaque bounded strings.",
|
||||
"properties": {
|
||||
"platform": {
|
||||
"type": "string",
|
||||
"maxLength": 32
|
||||
},
|
||||
"os_version": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
},
|
||||
"manufacturer": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
},
|
||||
"model": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
},
|
||||
"platform_details": {
|
||||
"type": "object",
|
||||
"maxProperties": 16,
|
||||
"propertyNames": {
|
||||
"minLength": 1,
|
||||
"maxLength": 128
|
||||
},
|
||||
"additionalProperties": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
}
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"output": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"hdr_details": {
|
||||
"$ref": "#/$defs/hdr_capabilities"
|
||||
},
|
||||
"audio_passthrough": {
|
||||
"$ref": "#/$defs/audio_passthrough"
|
||||
},
|
||||
"current_sink": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
},
|
||||
"sink_type": {
|
||||
"type": "string",
|
||||
"maxLength": 128
|
||||
},
|
||||
"output_context_id": {
|
||||
"type": "string",
|
||||
"description": "Opaque token identifying the current output route. The server only ever compares it for equality, so any stable platform-native identity works and omitting it is valid.",
|
||||
"maxLength": 128
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
},
|
||||
"deliveries": {
|
||||
"type": "object",
|
||||
"description": "Keyed by delivery class: original_http, progressive, hls. A class the client omits is a class the planner will not route to.",
|
||||
"maxProperties": 16,
|
||||
"propertyNames": {
|
||||
"maxLength": 64
|
||||
},
|
||||
"additionalProperties": {
|
||||
"$ref": "#/$defs/delivery_capability"
|
||||
}
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
},
|
||||
"additionalProperties": true
|
||||
}
|
||||
@@ -48,38 +48,6 @@ the other. Send the exact lower-case family:
|
||||
| macOS | `desktop` |
|
||||
| Browser | `web` |
|
||||
|
||||
### App identity headers
|
||||
|
||||
Separately from the family, every first-party client should send its own app
|
||||
identity on playback requests. These are server-wide contextual headers, not
|
||||
settings-specific: the playback session stores them, the admin Activity page
|
||||
renders them ("Silo Android TV 1.0.0 (build 5)"), and playback decision logs
|
||||
carry them so a report can be tied to an exact build.
|
||||
|
||||
| Header | Clamp | Meaning |
|
||||
| ----------------------- | ----- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `X-Silo-Client` | 128 | Product name, e.g. `Silo Android TV`, `Silo iOS`. |
|
||||
| `X-Silo-Client-Version` | 64 | Marketing version, e.g. `1.0.0`. Sent verbatim and displayed verbatim — do not pre-shorten it. |
|
||||
| `X-Silo-Client-Build` | 64 | Opaque per-platform build identifier (Android `versionCode`, Apple `CFBundleVersion`). Never parsed or compared. |
|
||||
| `X-Silo-Client-Channel` | 32 | Opaque distribution channel: `release`, `beta`, `sideload`, `dev`. Stored verbatim; `release` is not displayed. |
|
||||
|
||||
Values are trimmed and truncated to the clamp above — never rejected, on either
|
||||
route, because an identity label must not be able to fail a playback start. The
|
||||
clamp counts characters, not bytes, matching `maxLength` in the v3 request
|
||||
schemas, and is applied where the request is read rather than where the session
|
||||
is created so the decision logs and `playback_route_events` observe it too.
|
||||
Nothing is validated against an enum either, so a client may introduce a new
|
||||
channel without a server change.
|
||||
|
||||
Protocol-v3 `POST /playback/start` accepts `client_playback_context.app_version`,
|
||||
`.app_build`, and `.app_channel` as a body-level fallback for clients that cannot
|
||||
set the headers on every request. The headers win field by field when both are
|
||||
present, and the fallback applies **only to a client that sent `X-Silo-Client`**:
|
||||
`client_playback_context` carries no app name, so nothing in the body can
|
||||
identify a client that did not name itself — such a session is labeled from its
|
||||
user agent, and its `app_version` is a free-form platform string rather than the
|
||||
marketing version `client_version` promises.
|
||||
|
||||
## Remote scopes
|
||||
|
||||
Every stored value has exactly one identity. Context fields not named by the
|
||||
|
||||
@@ -0,0 +1,290 @@
|
||||
# 2026-07-17 — Embedded subtitle extraction: investigation and fix
|
||||
|
||||
Commands assume the repository root is the cwd.
|
||||
|
||||
This document records both the **final design** and the **investigation that
|
||||
produced it**, including four superseded revisions. The dead ends are kept
|
||||
deliberately: every one of them looked correct, three were disproved only by
|
||||
measurement, and the last was a release-blocking bug caught in review. Anyone
|
||||
tempted to "clean up" the subtitle windowing code should read Evolution first.
|
||||
|
||||
## Summary
|
||||
|
||||
Extracting an embedded subtitle track walks the interleaved container: subtitle
|
||||
packets sit between video and audio across clusters, so harvesting a few KB of
|
||||
text means demuxing that stretch of a multi-GB file off network storage (CephFS).
|
||||
|
||||
The server believes it bounds this with a 600s window. **It does not** — the flag
|
||||
is inert, so every request extracts from the seek point to end-of-file. We cannot
|
||||
turn the window on, because two of three clients depend on receiving whole tracks.
|
||||
|
||||
**Fix: cache the extract. Change nothing a client can observe.**
|
||||
|
||||
## Evidence
|
||||
|
||||
41.6h of production logs (2026-07-15 09:19 → 2026-07-17 02:56, 1.29M requests),
|
||||
`/api/v1/stream/{session_id}/subtitles/{track}`:
|
||||
|
||||
| client | requests | p50 | p95 | max | ≥10s |
|
||||
|---|---|---|---|---|---|
|
||||
| browser (web player) | 220 | 72ms | **120,021ms** | 121,470ms | **45** |
|
||||
| native (Android/TV) | 42 | 145ms | 9,566ms | 41,607ms | 2 |
|
||||
|
||||
Sidecar/external subtitles: **118 requests, all <1s** — standalone files, read
|
||||
directly, no demux. That fast path already exists and is why the distribution
|
||||
first looked bimodal.
|
||||
|
||||
Both clients are slow; they differ in *how often they pay*. The web player
|
||||
re-fetches a window every ~10 minutes of playback, so each slow fetch **stalls
|
||||
subtitles mid-film** — that is the 120s cluster. Native fetches once per track and
|
||||
holds all cues, so it rolls the dice once: up to ~41s before subtitles appear, then
|
||||
fine.
|
||||
|
||||
The 120s ceiling is `WriteTimeout: 120 * time.Second` (`cmd/silo/main.go:2389`)
|
||||
cutting the connection mid-body. `WriteHeader(200)` was already called
|
||||
(`stream.go:576`) and the logging middleware records that status
|
||||
(`internal/api/middleware/request_logger.go:29`) — so **truncated subtitles are
|
||||
logged `status=200`** and are invisible in error metrics.
|
||||
|
||||
## Root cause: the window flag is inert
|
||||
|
||||
`streamExtractArgs` (`subtitle_stream.go:161-168`) passes `-t` as an **input**
|
||||
option, reasoning it "caps how much of the file we read". Measured against the
|
||||
production binary (`ffmpeg 7.1.4-Jellyfin` at `/usr/lib/jellyfin-ffmpeg/ffmpeg`
|
||||
inside the `silo` container — not on `$PATH`; there is no host ffmpeg):
|
||||
|
||||
| command | wall | bytes | last cue |
|
||||
|---|---|---|---|
|
||||
| `-ss 4000 -t 30 -i F` | 5s | 38,562 | **02:10:04** |
|
||||
| `-ss 4000 -t 300 -i F` | 6s | 38,562 | **02:10:04** |
|
||||
| `-ss 4000 -i F` (no `-t`) | — | 38,562 | 02:10:04 |
|
||||
| `-t 600 -i F` (seek 0) | **86s** | 83,092 | **02:10:04** |
|
||||
|
||||
`-t 30` and `-t 300` are byte-identical to each other **and to passing no `-t` at
|
||||
all**. Only `-ss` works. Cost is therefore *(duration − seek) × bitrate*, which the
|
||||
logs confirm exactly: `seek=8s/130s/519s` → ≥60s; `seek=7797s/8392s/8987s` → <1s.
|
||||
Bitrate correlates monotonically (39.8 Mbps → 120.6s; 5.0 Mbps → 8.0s; every 120s
|
||||
outlier is a ≥28 Mbps remux).
|
||||
|
||||
`-to` as an **output** option does bound it correctly — `-ss 4000 … -to 4600` →
|
||||
1s, 9,170 bytes, last cue 01:16:32. **We are deliberately not using it.**
|
||||
|
||||
## Why the window stays off
|
||||
|
||||
Subagent scans of the sibling repos found the accidental whole-track behaviour has
|
||||
become the de-facto contract:
|
||||
|
||||
- **silo-apple — BREAKS.** `SidecarSubtitleFetcher.swift:48-95` issues a single
|
||||
GET; `SubtitleSession.swift:244-287` caches the whole response in
|
||||
`sidecarCache[urlIndex]` and never re-requests. No `position=`/`duration=`, no
|
||||
window constant, no sliding window. Its comment states the "buffered path" is
|
||||
deliberate.
|
||||
- **silo-android — BREAKS.** `SubtitleTrackMerge.kt:56` builds the URL bare and
|
||||
hands it to Media3 as a `MediaItem.SubtitleConfiguration`
|
||||
(`SiloPlayerFactory.kt:413`) → `ProgressiveMediaSource` fetches once, parses every
|
||||
cue. No timer, no position listener, no re-fetch.
|
||||
- **web** windows correctly: sends `position=`
|
||||
(`web/src/player/hooks/useSubtitleTracks.ts:79`), advances by 595
|
||||
(`WINDOW_DURATION 600 − WINDOW_OVERLAP 5`, `:9`/`:16`/`:409-410`) — the exact
|
||||
stride observed in production.
|
||||
|
||||
Enabling the window would silently kill subtitles ~10 minutes into every film on
|
||||
iOS, tvOS, macOS and Android. Caching removes the need: keep whole-track delivery,
|
||||
make it cheap.
|
||||
|
||||
## Design
|
||||
|
||||
`SubtitleCache` (`internal/playback/subtitle_cache.go`) already implements the
|
||||
needed shape for PGS: a full-track miss streams to the client while teeing into a
|
||||
temp file, atomically renamed on clean exit (`ServeSUPExtract:113`); a hit serves
|
||||
from disk; a windowed request re-extracts from the small cached artifact
|
||||
(`serveWindowedSUP:161`, via `InputIsExtractedSup`) or starts `WarmInBackground:188`.
|
||||
Keyed by path + track ordinal + source mtime+size. Text was excluded only by the
|
||||
assumption at `stream.go:557-562` that "VTT is already windowed and fast" — which
|
||||
the inert `-t` makes false.
|
||||
|
||||
Windowing a **cached** 83 KB VTT costs **52ms** vs 16,000ms against the original
|
||||
27 GB remux (`-ss 4000 -i cached.vtt … -to 4600` → 9,216 bytes, cues 01:04:40 →
|
||||
01:16:32). Note `-ss` on a webvtt input lands ~2 min *before* the target — a
|
||||
coverage superset, not byte-equivalence.
|
||||
|
||||
### The load-bearing rule: canonical artifact + effective-partial predicate
|
||||
|
||||
A cache entry may only ever hold a **canonical extract**: source track → requested
|
||||
output format, `seek=0`, `duration=0`, original-container input, original track
|
||||
mapping.
|
||||
|
||||
**`AllowWindow` must not be used to decide this.** It is set only in the PGS branch
|
||||
(`stream.go:531`), so it is always false for text — while `streamExtractArgs:155`
|
||||
applies `-ss` to any non-ASS/non-PGS source *regardless* of it. Routing on
|
||||
`AllowWindow` therefore lets a seeked text extract be committed as canonical:
|
||||
|
||||
1. subrip request at 900s → `AllowWindow=false` → full-track path.
|
||||
2. ffmpeg applies `-ss 900`; inert `-t` does not save it → output is 900s→EOF.
|
||||
3. ffmpeg exits cleanly → `Commit` publishes the partial as canonical.
|
||||
4. Every later viewer from 0 gets a hit and **receives no cues before 900s**.
|
||||
|
||||
118 of 143 production requests carry a non-zero seek, so this would poison
|
||||
immediately and silently truncate subtitles for everyone until eviction. Classify
|
||||
from the **effective argv** instead — ideally via the same helper that builds it:
|
||||
|
||||
- effective seek/duration ⇒ partial ⇒ **never fills** the canonical entry; on a hit
|
||||
re-extract from the cached artifact, on a miss stream the seeked extract uncached
|
||||
and start a canonical background warm.
|
||||
- seek=0 & duration=0 ⇒ canonical ⇒ may fill.
|
||||
|
||||
(ASS→VTT happens to be safe because `IsASS` blocks `-ss` — that does **not**
|
||||
generalize to subrip, which is 135 of 143 requests.)
|
||||
|
||||
### Steps
|
||||
|
||||
1. `subtitle_stream.go` — export the output-format resolver (`streamExtractOutput`
|
||||
already is one; export it). Do **not** add a second mapping: the handler's
|
||||
duplicate at `stream.go:493-499` is exactly what let two copies disagree.
|
||||
Preserve current windowing behaviour **exactly** — this commit changes latency
|
||||
only.
|
||||
2. `stream.go` — delete the duplicated mapping; resolve format once. Keep
|
||||
`seek`/`duration` selection keyed so the log line cannot report a window ffmpeg
|
||||
will ignore.
|
||||
3. `subtitle_cache.go` — generalize:
|
||||
- **Key**: add the resolved output profile (out codec + muxer, not the caller's
|
||||
`"vtt"` string) **and a schema version** — mtime+size cannot detect an in-place
|
||||
ffmpeg upgrade or a future argv change. `.ass` and `.vtt` are both reachable
|
||||
for one ASS source, so format must be in the key.
|
||||
- **`removeStaleSiblings:468` groups by a prefix excluding format** — committing
|
||||
`.vtt` would delete a valid `.ass` sibling. Cleanup (`:476`) and eviction
|
||||
(`:517`) hardcode `.sup`, so text would never be reclaimed or counted.
|
||||
- Generalize `InputIsExtractedSup` (used at `subtitle_stream.go:170-176` to force
|
||||
`-f sup` + remap `0:0`) to carry the cached input's format.
|
||||
- `serveWindowedSUP:171` hardcodes `application/octet-stream`; drive Content-Type
|
||||
from the resolved format (`text/vtt`, `text/x-ssa`).
|
||||
- Rename now that it carries text: `SUPExtractFunc` → `SubtitleExtractFunc`,
|
||||
`ServeSUPExtract` → `ServeExtract`, `serveWindowedSUP` → `serveWindowed`.
|
||||
- In-flight coalescing must include the output profile.
|
||||
- Fix the doc comment (`:19-38`) and the `defaultSubtitleCacheMaxBytes` sizing
|
||||
note, which both claim PGS-only.
|
||||
4. `stream.go:563` — remove the `outFormat == "sup"` gate so text routes through the
|
||||
cache. Correct the false comment at `:557-562`.
|
||||
5. **Keep HTTP semantics unchanged**: copy the cached file with the current
|
||||
Content-Type and `no-store`. Do **not** adopt `http.ServeContent` here — it adds
|
||||
Range/`206`/`304`/`Content-Length`, and Media3 uses range-capable data sources,
|
||||
so responses would differ depending on whether the cache happened to be warm.
|
||||
Revisit separately with client testing.
|
||||
|
||||
## Risk / follow-ups
|
||||
|
||||
- **The inert `-t` stays.** Removing or "fixing" it changes what clients receive.
|
||||
Its comment (`subtitle_stream.go:161-165`) confidently describes a bound that does
|
||||
not exist and **must be corrected in place** — otherwise the next reader fixes it
|
||||
and breaks both native clients. This is the most important comment in the change.
|
||||
- **Cache-key completeness is correctness-critical.** A missing dimension serves
|
||||
wrong bytes. mtime+size remains a residual risk (a replaced file with identical
|
||||
size and preserved timestamp reuses stale content); `MediaFile.FileHash` exists if
|
||||
we want content identity later. Documented, not solved.
|
||||
- **First-touch is unimproved.** Native clients fetch once, so the first viewer of a
|
||||
file+track still pays full price; they benefit only from another viewer's warm.
|
||||
The web player's 2nd–14th windows are the win.
|
||||
- **Cached-vs-cold output is a coverage superset, not byte-identical** (`-ss` on a
|
||||
webvtt input lands early). Verification standard is semantic cue coverage.
|
||||
- **120s WriteTimeout masking is not fixed** (`status=200` on a truncated body) —
|
||||
largely inherent once headers are committed;
|
||||
`LogSubtitleStreamError` (`subtitle_stream.go:273-277`) documents it as
|
||||
deliberate. A cold first extract of a large remux can still exceed it. Follow-up:
|
||||
the rolling deadline full downloads already use
|
||||
(`internal/api/handlers/downloads.go:402`, `internal/httpstream/rolling_deadline.go`).
|
||||
- **Not in scope:** the standalone proxy has separate uncached ASS/text extraction
|
||||
paths (`internal/proxy/server.go:273`, `:286`); if remote/proxy subtitle URLs reach
|
||||
those, they stay uncached.
|
||||
- **Dropped: warm-on-playback-start.** `BeginFill` coalesces cache *writes* but does
|
||||
not share extraction *output* — so a warm at session start plus the client's
|
||||
immediate request (exactly what auto-enabled subtitles do) yields **two whole-file
|
||||
demuxes and no latency benefit**. `WarmInBackground:188` also does `stat`/`mkdir`/
|
||||
temp-file work synchronously before detaching, which could block session start on
|
||||
CephFS. Revisit only if commit 1's metrics show a real gap between playback start
|
||||
and subtitle selection.
|
||||
- **Deferred:** (a) real windowing, once `silo-android`/`silo-apple` send
|
||||
`position=`/`duration=` and re-fetch on coverage exhaustion — then `-t`→`-to`
|
||||
becomes safe and this cost drops again; (b) scan-time extraction of embedded tracks
|
||||
into sidecars, putting every subtitle on the already-instant external path and
|
||||
retiring on-demand extraction entirely. (b) is the real endgame.
|
||||
- **Non-finite `?position=`** (`+Inf` parses and passes `>= 0`, reaching ffmpeg and
|
||||
failing after the 200) is a genuine bug found en route — its own commit, not this.
|
||||
|
||||
## Evolution (what we got wrong, and how it was caught)
|
||||
|
||||
Kept because each error is one a careful reader would repeat.
|
||||
|
||||
**R1 — "ASS→VTT skips windowing."** `streamExtractArgs:155` keys `windowable` on
|
||||
`SourceCodec`, so an ASS source requested as `.vtt` never seeks → full-file demux.
|
||||
Real, and the code reads exactly that way. Proposed a one-line predicate fix.
|
||||
*Caught by Codex:* a **no-op**. The handler computes `seek`/`duration` from a
|
||||
source-derived format *before* the `.vtt` override (`stream.go:493-520`), so ASS
|
||||
yields `seek=0, duration=0` and no `-ss`/`-t` is emitted whatever the predicate
|
||||
says. The proposed unit test would have passed while production stayed broken —
|
||||
it hand-built opts the handler never produces.
|
||||
|
||||
**R2 — fix both layers.** Correct, and Codex's implementation was clean.
|
||||
*Caught by the logs:* the premise was wrong. The `subtitle stream requested` line
|
||||
records `track_codec`/`seek`/`duration`; correlating it against request durations
|
||||
showed **all 7 ASS requests logged `seek=0 dur=0` but never exceeded 10s**, while
|
||||
**every request ≥60s was subrip with `seek=NNN dur=600`** — already windowed. The
|
||||
same file (71458) ranged 41ms→120,574ms. The tidy "bimodality splits by codec"
|
||||
story was a subagent's inference that I propagated without testing it against logs
|
||||
I already had open.
|
||||
|
||||
**R3 — `-t`→`-to` plus 600s→60s.** Found by running ffmpeg instead of reading it:
|
||||
`-t` is inert. This is the true root cause, and it hits subrip (135 of 143
|
||||
requests), not ASS. *Caught by the client scans:* both native clients fetch once and
|
||||
expect whole tracks, so enabling the window breaks them. Also caught: 600→60 would
|
||||
have been worse — the web player hardcodes `WINDOW_DURATION = 600` and advances by
|
||||
595 without checking what it received, so a 60s server window means a **535-second
|
||||
subtitle blackout** between fetches.
|
||||
|
||||
**R4 — cache text tracks.** *Caught by Codex:* routing on `AllowWindow` lets a
|
||||
seeked extract be committed as canonical → cache poisoning (see Design). I had
|
||||
generalized from ASS, the one case where `IsASS` blocks `-ss`.
|
||||
|
||||
**Method errors worth naming:**
|
||||
- I twice reported findings from a subagent's code reading without checking them
|
||||
against production data I already had.
|
||||
- I greped `position=`/`duration=`/`windowed=1` on `/api/v1` request logs and
|
||||
concluded no client sends them. **The api request log has no `query=` field** —
|
||||
the greps were vacuous. Ground truth is `seek_seconds` in the handler log (118 of
|
||||
143 non-zero). Do not grep query params off api log lines.
|
||||
- The first "86s → 1s" measurement was cache-flattered; the honest cold number is
|
||||
16s. Always re-measure cold, in a fresh order.
|
||||
- Two rounds of code review missed the inert `-t` because we both read *intent*:
|
||||
the comment says it windows, the test asserts the flag is present, and it is
|
||||
present. Only execution disproved it.
|
||||
|
||||
## Verification
|
||||
|
||||
- `go build ./...`, `go vet ./...`, `gofmt -l` clean.
|
||||
- `go test -race ./internal/playback/ ./internal/api/handlers/`. Note
|
||||
`TestHandleReplanPlaybackV3SeekFailureRecoveryNeverChangesMediaVersion` **already
|
||||
fails on clean `origin/main`** — pre-existing, unrelated, do not chase it.
|
||||
- Required tests:
|
||||
- **a seeked `.vtt` miss must not commit a canonical entry**, and a subsequent
|
||||
seek-0 request must still receive beginning-of-track cues (the poisoning
|
||||
regression — the single most important test here);
|
||||
- seek-0 fill, then a seeked request re-extracts from the cached artifact (assert
|
||||
the rewritten input path/format, not the original);
|
||||
- `.ass` and `.vtt` for the same file+track coexist and do not evict each other
|
||||
via `removeStaleSiblings`;
|
||||
- text entries participate in eviction accounting;
|
||||
- a partial/failed extract never commits;
|
||||
- Content-Type per format on hit and miss.
|
||||
- **Behavioural equivalence is the bar**: for every (source codec, requested format,
|
||||
seek), the bytes a client receives must be unchanged from `origin/main`. Only
|
||||
latency may differ.
|
||||
- Post-deploy: re-run the ≥1s aggregation over `docker logs silo`. Expect browser
|
||||
p95 to fall away from 120s and the ≥10s count (45) to collapse toward the handful
|
||||
of cold first-touches. Watch `subtitle cache warm` lines for failures and
|
||||
dropped-slot rates.
|
||||
|
||||
## AI-use disclosure
|
||||
|
||||
Investigation, root-cause analysis, and this document were prepared with AI (Claude
|
||||
Code) assistance. The plan was adversarially reviewed by Codex (`gpt-5.6-sol`),
|
||||
which caught both the R1 no-op and the R4 cache-poisoning bug; client impact was
|
||||
assessed by subagent scans of `silo-apple` and `silo-android`.
|
||||
@@ -1,366 +0,0 @@
|
||||
# Playback Protocol v3: Platform-Neutral Contract Finalization
|
||||
|
||||
**Status:** Proposed
|
||||
**Scope:** `silo-server` (protocol owner), with coordinated breaking updates in
|
||||
`silo-android`, `silo-apple`, and the in-repo web frontend (`web/src`)
|
||||
**Supersedes:** the wire-contract sections (§3.3, §5.1–§5.2) of
|
||||
`docs/superpowers/plans/2026-07-12-playback-protocol-v3.md`. The planner,
|
||||
session, replan-idempotency, and transport architecture from that plan are
|
||||
unchanged and remain authoritative.
|
||||
|
||||
Commands assume the repository root is the cwd.
|
||||
|
||||
## 1. Goal
|
||||
|
||||
Finalize the v3 playback protocol **in place** as a platform-neutral contract
|
||||
before it carries production traffic. The protocol keeps its version number,
|
||||
its endpoints, and its architecture (server-owned plans, deterministic plan
|
||||
identity, idempotent replans, validated claims, route events). What changes is
|
||||
the wire contract, which today is a serialization of Android Media3 concepts:
|
||||
|
||||
- the engine vocabulary is Media3 branding (`media3_direct`, `media3_hls`,
|
||||
feature token `media3_only`, claims `media3_h264_decode`);
|
||||
- loop-prevention attempt keys are client-computed FNV hashes whose canonical
|
||||
string is defined by Kotlin enum constant names, forcing the Go server to
|
||||
carry `KotlinName()` methods and Apple to reimplement the hash in Swift;
|
||||
- the capability schema mirrors `android.media.MediaCodecInfo` and
|
||||
`android.os.Build`, which Apple can only fill with hardcoded literals
|
||||
(`profiles: []`, fabricated `output_route_generation`) and the web client
|
||||
cannot fill at all;
|
||||
- the normative spec lives in the Android repository.
|
||||
|
||||
**There is no backwards compatibility requirement.** v3 is dark
|
||||
(`playback.protocol_v3_enabled` defaults to `false`), the only v3 speakers are
|
||||
first-party test builds, and the product is early enough to require clients and
|
||||
servers to update together. All three repos move in one coordinated release;
|
||||
the legacy playback protocol is deleted, not deprecated.
|
||||
|
||||
## 2. Current state (verified)
|
||||
|
||||
| Surface | State |
|
||||
| --- | --- |
|
||||
| Server v3 | Complete behind `playback.protocol_v3_enabled`: capability, start, replan, route-events; planner in `internal/playback/plan_v3.go`; durable attempt store in `internal/playback/planstore/`. |
|
||||
| Android | Speaks v3 natively; owns the normative Kotlin model and generates the attempt-key fixtures Go tests consume. |
|
||||
| Apple | Speaks v3 through a ~1,050-line translation shim (`ProtocolV3/` directory) that aliases AVPlayer under Media3 engine names, hardcodes decode capabilities, and reimplements the Kotlin attempt-key hash. |
|
||||
| Web video player | Legacy protocol only: flat codec lists to `POST /playback/start`, client-chosen FFmpeg recipes via `POST /playback/transcode/start`, audio switch via `PATCH /playback/{id}/audio`. |
|
||||
| Web audiobook player | Legacy `POST /playback/start` with `play_method: "direct"`. |
|
||||
| Transcode nodes | Advertise the shared transformation registry (`internal/playback/transformations_v3.go`), including its `media3_*` validated-claim strings. |
|
||||
| jellycompat | Separate protocol surface for Jellyfin clients; out of scope. |
|
||||
|
||||
## 3. Contract changes
|
||||
|
||||
### 3.1 Server-owned attempt keys
|
||||
|
||||
The server already computes `PlanAttemptKeyV3` to enforce loop prevention.
|
||||
Make that the only implementation:
|
||||
|
||||
- Every `PlanV3` response carries `plan_attempt_key`, an **opaque token**.
|
||||
Clients store the keys of attempted plans and echo them in
|
||||
`attempted_plan_keys` on replan. Clients never hash anything.
|
||||
- A client that applies a local mutation (Android's PCM recovery route) reports
|
||||
it as a bounded string list `local_mutations` on the replan; the server folds
|
||||
it into the key.
|
||||
- Delete `KotlinName()` on `DeliveryV3`, `StreamProtocolV3`, and
|
||||
`SubtitleModeV3` (`internal/playback/protocol_v3.go`). The canonical string
|
||||
in `internal/playback/plan_key_v3.go` switches to lowercase wire tokens. The
|
||||
key remains FNV-1a `v3:<16-hex>` so existing store columns and log tooling
|
||||
keep working, but the algorithm is now a server implementation detail.
|
||||
- Bump `PlanRecipeVersionV3` (currently `v3.2`) so no key or plan ID computed
|
||||
under the old canonicalization can collide with the new scheme.
|
||||
- Golden fixtures in `internal/playback/testdata/protocol_v3/` are regenerated
|
||||
**by Go** and become the cross-repo source of truth (§3.7). The
|
||||
"fixtures must be generated by the checked-in Kotlin implementation" rule
|
||||
from the original plan is retired along with the reason it existed.
|
||||
|
||||
Deterministic `plan_id` (`DeterministicPlanIDV3`) stays: the server still needs
|
||||
recipe-stable identity for idempotency and telemetry. Only the client-visible
|
||||
hashing contract disappears.
|
||||
|
||||
### 3.2 Engines leave the wire; deliveries are the negotiation unit
|
||||
|
||||
Delete `EngineV3` from the wire contract. The delivery→engine mapping was
|
||||
already fixed one-to-one, so `delivery` plus `stream.protocol` carries all the
|
||||
information; each client maps deliveries to its own player internally
|
||||
(Media3, AVPlayer, hls.js).
|
||||
|
||||
- `ClientPlaybackContextV3.Engines` (map keyed `media3_*`) becomes
|
||||
`deliveries`, keyed by the delivery class the client can execute:
|
||||
`original_http`, `progressive`, `hls`. The value keeps the existing
|
||||
per-engine shape (containers, codecs, subtitle capabilities, features,
|
||||
transformations), renamed `DeliveryCapabilityV3`.
|
||||
- `PlanV3.Engine` is removed. `ResolveSubtitlePolicyV3` and
|
||||
`engineAvailableV3` re-key on delivery class; their logic is unchanged.
|
||||
- Feature token `media3_only` is deleted from `ServerFeaturesV3()`.
|
||||
- Validated-claim strings drop the prefix: `media3_h264_decode` →
|
||||
`h264_decode`, `media3_audio_decode` → `audio_decode` (registry specs in
|
||||
`internal/playback/transformations_v3.go`; flows automatically to the
|
||||
transcode-node advertisement, which matches on name/version/executor and is
|
||||
version-locked to the server binary anyway).
|
||||
- Reserved legacy Android enum values (`mpv_direct`, `client_local_loopback`,
|
||||
`external_player`, `client_local_normalization`) lose their protocol
|
||||
reservation; they become Android-internal history.
|
||||
|
||||
### 3.3 Tiered capability evidence
|
||||
|
||||
Replace the implicit "Android fills everything, others fake it" model with an
|
||||
explicit per-area evidence tier, and make planner strictness follow the tier:
|
||||
|
||||
```text
|
||||
video_evidence: "exact" | "platform_attested" | "declared"
|
||||
audio_evidence: "exact" | "platform_attested" | "declared"
|
||||
```
|
||||
|
||||
- **exact** — per-codec profiles/levels/bit-depths/bounds from a real platform
|
||||
probe (Android `MediaCodecList`). Full strict validation, exactly today's
|
||||
`detailedVideoEligibleV3` path.
|
||||
- **platform_attested** — platform-level decoder attestation without
|
||||
profile/level enumeration (Apple/VideoToolbox): codec, hardware flag, max
|
||||
resolution/frame-rate, bit depths, HDR ranges. The planner validates codec,
|
||||
resolution, bit depth, frame rate, and dynamic range, and skips
|
||||
profile/level matching instead of failing conservative. Apple stops
|
||||
advertising `detailed_decode_capabilities` facts it cannot produce.
|
||||
- **declared** — boolean support statements (web `MediaSource.isTypeSupported`).
|
||||
The request is valid (today web cannot construct a legal v3 request at all);
|
||||
the planner grants copy routes on codec+container+range match and otherwise
|
||||
adapts. No strict direct claims.
|
||||
|
||||
The `detailed_decode_capabilities` feature token is subsumed by
|
||||
`video_evidence: "exact"` and removed. Audio passthrough entries stay optional:
|
||||
only `exact` audio evidence earns passthrough claims; `platform_attested`
|
||||
decode claims suffice for copy routes, which unblocks Apple's current
|
||||
never-passthrough outcome honestly (Apple simply cannot attest sink layouts —
|
||||
the tier records that instead of a stubbed-empty struct pretending to).
|
||||
|
||||
Terminal reasons must distinguish "your evidence tier cannot support this
|
||||
route" (`evidence_insufficient_for_direct`) from "your device cannot play
|
||||
this" so `declared`-tier clients get actionable degradation warnings rather
|
||||
than mystery transcodes.
|
||||
|
||||
### 3.4 Neutral device and output context
|
||||
|
||||
- `DeviceContextV3` (an `android.os.Build` dump: `sdk_int`, `abis`,
|
||||
`security_patch`, `build_display`, …) is replaced by:
|
||||
|
||||
```text
|
||||
platform e.g. "android", "ios", "tvos", "macos", "web"
|
||||
os_version bounded string
|
||||
manufacturer kept first-class: the quirk registry matches on it
|
||||
model kept first-class: the quirk registry matches on it
|
||||
form_factor existing field, unchanged
|
||||
platform_details bounded map<string,string> (≤16 entries, ≤128 chars each)
|
||||
```
|
||||
|
||||
Android moves `sdk_int`, `soc_model`, build fields into `platform_details`;
|
||||
the Fire TV quirks in `internal/playback/device_quirks_v3.go` keep working on
|
||||
`manufacturer`/`model` unchanged. The quirk mechanism (namespaced IDs,
|
||||
registry revision, applied-quirk reporting) already generalizes to `apple.*`
|
||||
and `web.*` quirks; nothing to change there.
|
||||
|
||||
- `output_route_generation` (int64, strictly cross-validated in two request
|
||||
locations, modeling Android's audio-route callback counter) becomes
|
||||
`output_context_id`: an optional bounded opaque string. The server only ever
|
||||
uses it to distinguish "same output route" from "route changed" in attempt
|
||||
keys and plan invalidation, which an opaque token does on every platform.
|
||||
Android supplies its route generation stringified; Apple supplies its
|
||||
existing synthetic sink hash (no longer masked into an int64); web omits it.
|
||||
The dual-location consistency validation is deleted.
|
||||
|
||||
- Dual-location feature advertisement (`client_features` at top level *and*
|
||||
`client_playback_context.features`) collapses to the top-level list only.
|
||||
`HasFeatureV3` call sites lose their second lookup.
|
||||
|
||||
### 3.5 Replan gains track and quality operations; legacy endpoints die
|
||||
|
||||
Extend `ReplanOperationV3` beyond failure recovery and seek:
|
||||
|
||||
- `track_change` — new `selected_tracks`, no failure classification required.
|
||||
Replaces `PATCH /playback/{session_id}/audio`.
|
||||
- `quality_change` — new `quality_preference`, no failure classification.
|
||||
Replaces the client-recipe half of `POST /playback/transcode/start`.
|
||||
|
||||
Both run through the existing replan transaction (validation → capacity
|
||||
reservation → staged successor → atomic commit), so they inherit idempotency,
|
||||
loop prevention, and restart safety for free.
|
||||
|
||||
To let clients render a quality menu without owning a bitrate table,
|
||||
`PlanV3` gains `available_qualities`: the server ladder rungs valid for this
|
||||
source and client (label, height, approximate bitrate, plus `original`).
|
||||
The web ladder in `web/src/player/hooks/useTranscodeQuality.ts` is deleted,
|
||||
not reconciled — resolving the original plan's §6.3 "one ladder" requirement
|
||||
in the server's favor.
|
||||
|
||||
### 3.6 Audio-only sources join the planner
|
||||
|
||||
The v3 planner currently terminals on sources without complete video metadata,
|
||||
which is why the audiobook player must stay on the legacy start path. Teach
|
||||
`PlanPlaybackV3` audio-only sources: when the effective file has no video
|
||||
track, skip video/HDR/subtitle-burn gates and plan `original_http` (validated
|
||||
audio decode) or an audio transformation route. This is what allows the legacy
|
||||
start path to be deleted entirely rather than kept alive for audiobooks, and
|
||||
it is the natural extension point for future music support.
|
||||
|
||||
### 3.7 Spec and fixtures move into this repository
|
||||
|
||||
- New normative spec: `docs/architecture/playback-protocol-v3.md` — endpoint
|
||||
contract, request/response schemas, evidence tiers, delivery semantics,
|
||||
timeline model, replan state machine, terminal reason registry, and the
|
||||
frozen track-identity ordering rules.
|
||||
- JSON Schemas for every wire body under `docs/design/schemas/playback-v3/`,
|
||||
following the existing `docs/design/schemas/client-diagnostics` convention.
|
||||
- Golden fixtures (`internal/playback/testdata/protocol_v3/`) are generated by
|
||||
a Go generator and consumed by Android and Apple CI as opaque expected
|
||||
values. The direction of authority is inverted: the server defines the
|
||||
contract, clients prove conformance.
|
||||
- Track identity stays ordinal-based (`file:{id}:{kind}:{ordinal}`) — churn is
|
||||
not worth it — but the combined-ordinal ordering rules are specified here
|
||||
instead of by reference to Android's `buildSubtitleURLs`. The known
|
||||
`SubtitleTrackMerge` undercount (non-PGS burn-in tracks omitted from
|
||||
`subtitle_urls` but still counted in the downloaded-track offset) is fixed
|
||||
server-side as part of this pass; the Apple-side "do NOT fix" annotation is
|
||||
then removed.
|
||||
|
||||
### 3.8 Legacy playback protocol deletion
|
||||
|
||||
With web (video + audiobook) on v3, delete:
|
||||
|
||||
- `handleStartPlaybackLegacy` and `startPlaybackRequest` /
|
||||
`playbackSessionResponse` (`internal/api/handlers/playback.go`); the
|
||||
protocol-version dispatch envelope in `HandleStartPlayback` is replaced by a
|
||||
strict v3 decode. A start without `protocol_version: 3` gets
|
||||
`426 upgrade_required` with code `client_upgrade_required` so outdated apps
|
||||
render a clear "update required" state.
|
||||
- `POST /playback/transcode/start` (`HandleStartTranscode`) and
|
||||
`PATCH /playback/{session_id}/audio` (`HandleChangeAudioTrack`).
|
||||
- The shadow planner (`internal/api/handlers/playback_v3_shadow.go`) and
|
||||
`playback.protocol_v3_shadow_enabled` — its purpose (compare v3 against
|
||||
legacy production routes) ends when legacy routes end.
|
||||
- `playback.protocol_v3_enabled` — once v3 is the only protocol, "disabled"
|
||||
would mean "no playback". Removing both settings rows is a new Goose
|
||||
migration (`make migrate-create NAME=remove_playback_protocol_v3_flags`).
|
||||
- Legacy `resolver.go` paths that only legacy start reached (verify with
|
||||
coverage before deleting; jellycompat has its own resolution surface and
|
||||
must be untouched).
|
||||
|
||||
Per the v1 API rules, every removed endpoint and the changed start-body
|
||||
requirement are recorded in the pre-lock removals table in
|
||||
`docs/architecture/v1-scope.md` before merge. `/api/v1` is not locked, so this
|
||||
is in scope; it stops being possible after lock.
|
||||
|
||||
Unchanged surfaces: progress, stop, HLS manifest/segment delivery, the
|
||||
realtime control socket, stream tokens and restart reconstruction, watch
|
||||
together, downloads, jellycompat.
|
||||
|
||||
## 4. Client repository work
|
||||
|
||||
**silo-android** — mostly deletion. Remove the attempt-key implementation and
|
||||
its fixtures-as-source-of-truth role, the engine self-description under
|
||||
`media3_*` keys (becomes `deliveries`), and the `Build` dump (moves to
|
||||
`platform_details`). Adopt `plan_attempt_key` echo, `output_context_id`,
|
||||
`video_evidence: "exact"`, and the two new replan operations (its quality/track
|
||||
UI currently routes through replan-with-failure or legacy paths). Consume Go
|
||||
fixtures in CI.
|
||||
|
||||
**silo-apple** — the shim shrinks to near nothing. Delete the Swift FNV hash,
|
||||
the Media3 alias table, and the hardcoded decode-capability fabrication;
|
||||
advertise `video_evidence: "platform_attested"` with honest VideoToolbox
|
||||
attestation, and `audio_evidence: "platform_attested"` (no passthrough claims).
|
||||
Keep the plan validator (`validatedForApple()`) — defensive validation of
|
||||
server plans is good practice, not translation tax. Remove the subtitle
|
||||
undercount workaround once the server fix lands.
|
||||
|
||||
**web (this repo)** — the real migration. Video player: replace the legacy
|
||||
start payload with a v3 request (`video_evidence: "declared"` from
|
||||
`isTypeSupported` probes, `deliveries: {original_http, progressive, hls}`),
|
||||
consume `PlanV3` (URL, timeline, tracks, warnings), switch quality/track
|
||||
changes to replan, delete `useTranscodeQuality`'s ladder and recipe posting,
|
||||
and implement `route-events` for at least plan-failed/terminal so web failures
|
||||
become visible in the same telemetry as the apps. Audiobook player: v3 start
|
||||
against the audio-only planner path (§3.6). `WEBTEST_KNOWN_FAILURES` may only
|
||||
shrink during this work.
|
||||
|
||||
## 5. Rollout
|
||||
|
||||
One coordinated release train; no compatibility window.
|
||||
|
||||
1. Land the server contract changes with v3 still dark. Fixtures and JSON
|
||||
Schemas merge first so client work can start against them.
|
||||
2. Land Android and Apple ports; both CI suites consume the Go fixtures.
|
||||
3. Land the web migration (video, then audiobooks) in this repo.
|
||||
4. On the release: server advertises the finalized contract via
|
||||
`GET /playback/capability`; legacy start returns `426`. App-store builds and
|
||||
the server release ship together; older apps show the update-required state.
|
||||
5. After the release train merges and soaks on a validation deployment, the
|
||||
contract is **frozen**: all future changes go through the additive feature
|
||||
tokens and capability endpoint that v3 already has. This pass is the last
|
||||
breaking window by design.
|
||||
|
||||
Rollback within the window is "fix forward or revert the train": with the
|
||||
legacy protocol deleted there is deliberately no protocol fallback. That is the
|
||||
accepted cost of the no-compatibility decision, and it is why step 4 gates on
|
||||
full fixture parity in all three repos, not on manual testing alone.
|
||||
|
||||
## 6. Testing
|
||||
|
||||
- Regenerate all planner/contract fixtures from the Go generator; add
|
||||
fixtures for: evidence-tier gating (exact vs platform_attested vs declared
|
||||
reaching different routes for the same source), `deliveries` negotiation,
|
||||
opaque attempt-key echo and loop rejection, `track_change`/`quality_change`
|
||||
replans (idempotent duplicates, concurrent, mid-seek), `available_qualities`
|
||||
correctness against the ladder, audio-only planning, `output_context_id`
|
||||
change invalidation, and `426` on legacy start bodies.
|
||||
- Keep the full existing v3 matrix from the original plan §10 (HDR/DV, audio,
|
||||
subtitles, recovery, restart, capacity) — the planner logic it exercises is
|
||||
unchanged; fixtures re-key from engine to delivery.
|
||||
- Fire TV quirk tests unchanged (manufacturer/model matching survives §3.4).
|
||||
- Web: player integration tests against a real backend via the
|
||||
`web-ui-testing` flow; jellycompat and audiobook suites must stay green.
|
||||
|
||||
Verification before each PR in the train:
|
||||
|
||||
```text
|
||||
make lint
|
||||
make test
|
||||
cd web && pnpm run lint && pnpm run format:check
|
||||
make verify-local-paths
|
||||
```
|
||||
|
||||
## 7. Sequencing within silo-server
|
||||
|
||||
Each step is one reviewable PR (`Part of` the playback-protocol epic):
|
||||
|
||||
1. **Spec + schemas + fixture generator** — docs, JSON Schemas, Go generator,
|
||||
no behavior change.
|
||||
2. **Attempt-key ownership** — `plan_attempt_key` in responses, opaque echo,
|
||||
delete `KotlinName()`, re-canonicalize, bump `PlanRecipeVersionV3`.
|
||||
3. **Engine removal + claim rename** — wire types, planner re-key, registry
|
||||
claim strings, node-advertisement test update.
|
||||
4. **Evidence tiers + neutral device/output context** — request schema,
|
||||
validation, planner gating, terminal reasons.
|
||||
5. **Replan operations + `available_qualities`** — planner and handler.
|
||||
6. **Audio-only planning.**
|
||||
7. **Web migration** (video, then audiobooks).
|
||||
8. **Legacy deletion + settings-flag removal migration + v1-scope table
|
||||
entries + subtitle-ordinal fix.**
|
||||
|
||||
Android/Apple ports proceed in parallel from step 1's artifacts; step 8 merges
|
||||
only after both client ports are green against the fixtures.
|
||||
|
||||
## 8. Definition of done
|
||||
|
||||
- No Media3, Kotlin, or `android.os.Build` identifier appears in the wire
|
||||
contract, the attempt-key canonical string, or the normative docs.
|
||||
- Clients treat `plan_attempt_key` as opaque; exactly one attempt-key
|
||||
implementation exists, in Go.
|
||||
- The same source file yields correct, tier-appropriate routes for an `exact`
|
||||
Android request, a `platform_attested` Apple request, and a `declared` web
|
||||
request in fixture tests.
|
||||
- Web video and audiobook playback run on v3; `useTranscodeQuality`'s ladder
|
||||
and recipe posting are deleted.
|
||||
- Legacy start, `transcode/start`, and the audio PATCH are removed and
|
||||
recorded in the v1-scope pre-lock removals table.
|
||||
- `docs/architecture/playback-protocol-v3.md` is sufficient for a third-party
|
||||
client to implement playback without reading any client repository.
|
||||
- Android and Apple CI consume the Go fixtures; the Apple shim's alias table
|
||||
and Swift hash are gone.
|
||||
- Existing jellycompat, watch-together, downloads, and restart-resilience
|
||||
tests remain green.
|
||||
@@ -235,9 +235,7 @@ DROP TABLE IF EXISTS public.download_artifacts;
|
||||
|
||||
`params_hash = sha256(format | container | codec_video | codec_audio | resolution | audio_track_index | subtitle_burn_in)`.
|
||||
Two devices (or a web user and a phone) requesting the same 1080p H.264/AAC of the same source share one
|
||||
artifact. `last_used_at` drives LRU cleanup. `output_path` remains the deterministic API-local
|
||||
fallback target; distributed preparation additionally stores an opaque artifact id plus its
|
||||
transcode-node origin and group, allowing an authenticated proxy relay without a shared filesystem. The
|
||||
artifact. `last_used_at` drives LRU cleanup; `output_path` is on a configured artifact volume. The
|
||||
`attempts`/`lease_*`/`next_retry_at` columns make the table a **durable, recoverable job queue** (see the
|
||||
"Durable artifact queue" subsection) so a crash mid-encode cannot strand a download in `preparing`.
|
||||
|
||||
@@ -246,8 +244,7 @@ transcode-node origin and group, allowing an authenticated proxy relay without a
|
||||
`server_settings` is key/value, so new keys need no migration — written when an admin saves them, parsed
|
||||
in `internal/config/db_loader.go`:
|
||||
- `download.transcode_enabled` (bool, default **false**) — server gate for transcode-to-file.
|
||||
- `download.artifact_dir` (string) — local artifact output volume; dedicated transcode nodes default
|
||||
to a protected directory inside their existing transcode volume.
|
||||
- `download.artifact_dir` (string) — artifact output volume; defaults under the existing transcode/temp root.
|
||||
- `download.max_concurrent_prepares` (int, default 2) — encode/remux worker-pool size.
|
||||
- `download.artifact_max_bytes` (int64, default 0 = unlimited) — LRU eviction budget for artifacts.
|
||||
|
||||
@@ -292,9 +289,9 @@ Decision tree:
|
||||
`ErrDownloadNotAllowed` (403). Missing artifact pipeline → `ErrQualityUnavailable` (501).
|
||||
4. `remux` and `transcode` as request values are invalid public qualities.
|
||||
|
||||
Target codec/resolution for compatibility artifacts and bitrate transcodes is chosen by reusing
|
||||
`playback.Resolve` (`internal/playback/resolver.go`) against the device's declared capabilities and
|
||||
the admin transcode ceilings, so download encoding matches streaming decisions exactly (no
|
||||
Target codec/resolution for compatibility artifacts and bitrate transcodes is chosen by reusing `playback.Resolve` /
|
||||
`playback.SelectVersion` (`internal/playback/resolver.go:60`) against the device's declared capabilities
|
||||
and the admin transcode ceilings, so download encoding matches streaming decisions exactly (no
|
||||
duplicated codec logic).
|
||||
|
||||
## Transcode-to-file pipeline (v1)
|
||||
|
||||
@@ -1,301 +0,0 @@
|
||||
# Plugin-backed watch sync providers
|
||||
|
||||
## Status
|
||||
|
||||
Implemented design for the expanded `silo-plugin-sdk` v0.13
|
||||
`watch_sync_provider.v1` contract. The server uses the immutable SDK commit
|
||||
associated with the v0.13 pull request until that version is released. This
|
||||
specification does not introduce a second watch synchronization pipeline.
|
||||
Plugin-backed providers adapt the public plugin RPC contract to Silo's existing
|
||||
`watchsync` service, connection repository, history exports, scrobble sessions,
|
||||
rate-limit handling, list reconciliation, and scheduled reconciliation.
|
||||
|
||||
## Goals
|
||||
|
||||
- Allow an enabled plugin capability to appear as a profile-scoped watch
|
||||
provider.
|
||||
- Reuse Silo's encrypted watch-provider connections for personal credentials.
|
||||
- Support API-key and device-code connection flows.
|
||||
- Import and export watched state, progress, favorites, and watchlists according
|
||||
to each plugin's advertised capabilities.
|
||||
- Deliver explicit watched/unwatched and list operations plus live playback
|
||||
start, pause, and stop events.
|
||||
- Preserve the existing durable history-export reconciliation path.
|
||||
- Preserve complete provider credential shapes, including token type, scopes,
|
||||
expiry, and opaque secret attributes.
|
||||
- Supply declared installation configuration to provider calls without mixing
|
||||
it with profile credentials.
|
||||
- Keep provider plugins stateless and prevent credentials from entering generic
|
||||
plugin configuration.
|
||||
- Avoid behavior changes for built-in Trakt, Simkl, and MDBList providers.
|
||||
|
||||
## Non-goals
|
||||
|
||||
- Authorization-code OAuth UI and callback routes.
|
||||
- A second outbox or worker implementation.
|
||||
- Allowing plugins to persist or own personal provider credentials.
|
||||
- Removing built-in Trakt, Simkl, or MDBList providers in the same change. They
|
||||
remain available while equivalent plugins are built and connections are
|
||||
migrated deliberately.
|
||||
|
||||
Plugins may implement any subset of the state families and operations. A
|
||||
provider such as Floppy can advertise watched import/export, progress import,
|
||||
and live scrobbling without claiming favorites, watchlists, or unwatch support.
|
||||
Silo exposes only executable capabilities from the descriptor.
|
||||
|
||||
## SDK boundary
|
||||
|
||||
Plugins advertise `watch_sync_provider.v1` with a typed descriptor containing:
|
||||
|
||||
- supported authentication methods;
|
||||
- import/export capabilities;
|
||||
- supported media types and external-ID namespaces;
|
||||
- maximum apply batch size.
|
||||
|
||||
The host uses `WatchSyncProvider` for the stable provider operations and a
|
||||
separate `WatchSyncDeviceAuthorizationService` for device-code start and poll.
|
||||
The split keeps direct Go implementations of the released v0.12 provider
|
||||
interface source-compatible. Together the services support:
|
||||
|
||||
- device authorization `Start` and `Poll`;
|
||||
- `ExchangeAPIKey`;
|
||||
- `RefreshCredentials`;
|
||||
- `GetAccount`;
|
||||
- `ApplyEvents` for watched, unwatched, favorite, watchlist, and live scrobble
|
||||
operations;
|
||||
- `ListRemoteState` for watched, progress, favorite, and watchlist state.
|
||||
|
||||
Authorization-code descriptors remain valid SDK contracts, but the host does
|
||||
not register a plugin that offers only authorization-code authentication until
|
||||
the public watch-provider callback flow exists.
|
||||
|
||||
Every provider RPC receives the complete current credentials and relevant
|
||||
installation configuration only for that call. Plugins must not persist or log
|
||||
credentials. Generic `Runtime.Configure` data is not a personal credential
|
||||
store. Returned credentials are an authoritative replacement, and the host
|
||||
persists them before interpreting results, pages, or faults from the same RPC.
|
||||
|
||||
## Discovery and lifecycle
|
||||
|
||||
At startup and after plugin lifecycle changes, Silo:
|
||||
|
||||
1. lists enabled, non-builtin plugin installations;
|
||||
2. selects `watch_sync_provider.v1` capabilities;
|
||||
3. decodes and validates their typed descriptors;
|
||||
4. constructs thin `watchsync.Provider` adapters;
|
||||
5. atomically replaces the registry's previous plugin-backed providers while
|
||||
preserving built-ins.
|
||||
|
||||
Provider keys bind persisted credentials to the installation and capability
|
||||
(`plugin:<installation-id>:<capability-id>`), while RPC routing continues to use
|
||||
the manifest capability ID. This prevents a subsequently installed plugin from
|
||||
inheriting credentials merely by reusing another plugin's capability ID.
|
||||
Provider keys must not shadow built-ins or other plugin providers. A conflicting
|
||||
lifecycle reload fails without partially replacing the registry. Invalid,
|
||||
unreadable, or currently unsupported descriptors are logged and omitted, and
|
||||
the successfully discovered set still replaces the previous plugin providers.
|
||||
This fail-closed behavior prevents a disabled or removed plugin from remaining
|
||||
registered because another installation could not be decoded.
|
||||
|
||||
## Existing watchsync interfaces
|
||||
|
||||
The adapter implements the existing interfaces corresponding to the
|
||||
descriptor's advertised capabilities:
|
||||
|
||||
- `Provider`;
|
||||
- `AuthProvider`, `APIKeyAuthProvider`, and device authorization;
|
||||
- watched import/export and unwatch export;
|
||||
- progress import;
|
||||
- favorite and watchlist import/export/removal, including ordered watchlists;
|
||||
- `Scrobbler` and `OrderedScrobbler` for start, pause, and stop delivery.
|
||||
|
||||
`LocalPlay` and `ScrobbleEvent` values become rich desired-state plugin events.
|
||||
The host supplies movie and series external IDs, season and episode numbers,
|
||||
local history identity, playback identity, timestamps, and completion values.
|
||||
The plugin never needs a Silo API key or a callback into catalog HTTP routes.
|
||||
|
||||
## Authentication and credentials
|
||||
|
||||
The existing watch-provider API-key connection route passes the entered token
|
||||
to `ExchangeAPIKey`. Device-code providers use the existing start and poll
|
||||
routes. The plugin validates or exchanges the credential and returns normalized
|
||||
credentials plus provider account identity.
|
||||
|
||||
Credential refresh remains host-initiated and serialized by the existing
|
||||
watchsync service. The host encrypts an authoritative credential bundle
|
||||
containing access token, refresh token, expiry, token type, scopes, and opaque
|
||||
secret attributes. Legacy access/refresh columns remain readable during the
|
||||
migration. Device codes are also encrypted at rest. A pending device poll may
|
||||
rotate its opaque provider state, interval, or expiry; the host validates and
|
||||
persists the replacement before another poll. Invalid-credential faults are
|
||||
persisted using only the plugin's safe message.
|
||||
|
||||
Authorization-code OAuth can be added separately to the existing watch-
|
||||
provider service after its client-secret storage and callback-state design are
|
||||
reviewed.
|
||||
|
||||
## Watched export flow
|
||||
|
||||
### Explicit mark watched
|
||||
|
||||
The existing manual watch path records leaf history entries and invokes
|
||||
`HandleLocalWatchEvent`. The existing history-export table is populated before
|
||||
provider I/O. The plugin adapter sends each pending `LocalPlay` as an absolute
|
||||
`MARK_WATCHED` desired-state event. The interactive path sends one bounded
|
||||
plugin batch; additional queued events are delivered by scheduled
|
||||
reconciliation.
|
||||
|
||||
### Playback completion
|
||||
|
||||
The existing playback path invokes `ScrobbleStop` with rich identity. For a
|
||||
completed event and a provider that exports watched state, Silo first upserts a
|
||||
pending history-export record, then dispatches the immediate stop operation.
|
||||
|
||||
On successful immediate delivery, the history export is marked
|
||||
`satisfied_by_scrobble`. If immediate delivery fails or the process exits, the
|
||||
existing scheduled history reconciliation retries the same local history. A
|
||||
compatibility playback path without a local history ID retains its own durable
|
||||
terminal event until the confirmed stop succeeds. The plugin operation is
|
||||
convergent, so an uncertain duplicate cannot lower progress or increment a play
|
||||
counter.
|
||||
|
||||
Start, pause, and incomplete stop calls are no-ops for providers that only
|
||||
advertise watched export. Providers advertising live scrobbling receive all
|
||||
three operations with playback position and duration.
|
||||
|
||||
If the remote stop succeeds but the local history-export transition fails, the
|
||||
stop is not dispatched again. The scrobble session records a durable pending
|
||||
history-reconciliation marker, and the sweeper retries only the local database
|
||||
transition.
|
||||
|
||||
## Remote state import and lists
|
||||
|
||||
The scheduled sync path requests one state family at a time. Each request
|
||||
contains the stable cursor for that family and an opaque page token. The host:
|
||||
|
||||
1. persists any credentials returned by the page;
|
||||
2. discards the page and retains its cursor on a top-level fault;
|
||||
3. applies valid items idempotently through existing watch-state and list
|
||||
services;
|
||||
4. advances the page token until the plugin reports no next page;
|
||||
5. commits the family cursor only after the traversal succeeds.
|
||||
|
||||
Incremental list pages do not imply deletion of absent items; they use explicit
|
||||
provider-key tombstones for removals. Complete snapshots may reconcile removals.
|
||||
Ordered watchlists preserve the plugin's list position and require complete
|
||||
snapshots because an incremental subset cannot define positions relative to
|
||||
omitted items. Traversals are bounded by both page and item count before their
|
||||
durable cursor advances.
|
||||
Progress items without a valid provider timestamp are rejected rather than
|
||||
being stamped with host time.
|
||||
|
||||
Imported history is tagged with the stable plugin provider key, not a generic
|
||||
import source. Echo suppression therefore filters only export back to the
|
||||
originating plugin; the same local event remains eligible for other connected
|
||||
providers.
|
||||
|
||||
## Provider configuration
|
||||
|
||||
Manifest-declared global configuration is resolved per installation before each
|
||||
provider call. Public fields are sent in `values`; secret and undeclared fields
|
||||
are sent in `secret_values`. Nested manifest fields use the stable
|
||||
`<config-key>.<field>` key form, such as `floppy.base_url`. Profile credentials
|
||||
remain separate and encrypted in watch-provider connection storage.
|
||||
|
||||
## Apply result handling
|
||||
|
||||
Each event has a stable ID. The adapter requires a matching result and maps it
|
||||
as follows:
|
||||
|
||||
- `APPLIED` and `NO_CHANGE`: export sent;
|
||||
- `REJECTED`: permanent not-found/unmappable export;
|
||||
- `RETRY` with a temporary fault: failed export eligible for existing retry handling;
|
||||
- top-level or per-event rate limit: existing `RateLimitedError` and account
|
||||
deferral, after committing any successfully applied events from the same RPC;
|
||||
- missing or unknown result: failed export eligible for retry, unless the same
|
||||
RPC reported a rate limit, in which case unmentioned events remain pending;
|
||||
- plugin transport, process availability, and top-level temporary faults:
|
||||
remain pending without consuming a per-event attempt.
|
||||
|
||||
A top-level invalid-credential fault records a typed safe connection error.
|
||||
A dedicated reconnect-required connection state is deferred as described
|
||||
above. Plugin messages persisted by Silo must be explicitly safe for operator
|
||||
display and must not contain response bodies or secrets. The host redacts the
|
||||
connection credentials, normalizes control characters and whitespace, and
|
||||
bounds the displayed message length; transport details are replaced with
|
||||
host-owned text.
|
||||
|
||||
## Ordering and batching
|
||||
|
||||
Immediate scrobbles are ordered by connection and stable series identity using
|
||||
the existing ordered-scrobble queue. History reconciliation is ordered by local
|
||||
watch timestamp.
|
||||
|
||||
Each synchronization run sends at most one plugin RPC, bounded by the
|
||||
descriptor's maximum batch size. The existing service commits every per-event
|
||||
result before a later run requests the next pending batch. Failures increment
|
||||
attempts only for events included in that RPC. This avoids partial-success loss,
|
||||
retry exhaustion within one run, and unbounded cumulative RPC time.
|
||||
|
||||
## Reliability boundaries
|
||||
|
||||
This design deliberately reuses the reliability guarantees currently accepted
|
||||
for built-in providers:
|
||||
|
||||
- encrypted profile-scoped connections;
|
||||
- durable local watch history;
|
||||
- durable history-export rows;
|
||||
- immediate scrobble sessions;
|
||||
- scheduled reconciliation;
|
||||
- bounded retry attempts and safe recorded errors;
|
||||
- provider/account rate-limit deferral.
|
||||
|
||||
It does not claim multi-node leased delivery or infinite retries. Those should
|
||||
be improved in the shared watchsync pipeline for built-in and plugin providers
|
||||
together rather than introduced only for plugins.
|
||||
|
||||
## Security requirements
|
||||
|
||||
- Personal tokens never enter plugin runtime config or user settings.
|
||||
- Tokens are decrypted only at the provider invocation boundary.
|
||||
- RPC request values containing credentials are never logged.
|
||||
- Plugin-returned errors are sanitized before persistence and API display;
|
||||
transport errors are replaced by a generic message.
|
||||
- Account/profile scope remains enforced by the existing connection lookup.
|
||||
- Credential AAD and provider lookup include installation identity, preventing
|
||||
sequential capability-ID reuse from exposing an old token to a new install.
|
||||
- Disabled plugins disappear from provider discovery; existing connections are
|
||||
unavailable until that same installation and capability return.
|
||||
|
||||
## Compatibility
|
||||
|
||||
The change is additive to `/api/v1`. Existing provider summaries and connection
|
||||
routes continue to work. A plugin provider appears through the same provider
|
||||
summary model and uses the existing API-key or device-code connection routes.
|
||||
No client changes are required because no existing fields or status codes
|
||||
change. SDK v0.12 plugins remain wire-compatible; descriptors only expose the
|
||||
capabilities the older contract can execute.
|
||||
|
||||
## Validation plan
|
||||
|
||||
- capability enforcement in the plugin host client;
|
||||
- atomic registry replacement and built-in collision tests;
|
||||
- API-key and device-code authentication, full credential replacement, and
|
||||
account identity conversion;
|
||||
- provider configuration routing and secret/public field classification;
|
||||
- rich movie and episode identity conversion;
|
||||
- watched, progress, favorite, and watchlist import pagination and cursor
|
||||
behavior;
|
||||
- unwatch, favorite, watchlist, and ordered-list event conversion;
|
||||
- provider-specific import source keys and cross-provider export behavior;
|
||||
- completed playback persistence before plugin I/O;
|
||||
- `satisfied_by_scrobble` transition after success;
|
||||
- durable retry of a failed local post-stop history transition without another
|
||||
remote stop;
|
||||
- immediate failure followed by scheduled history reconciliation;
|
||||
- typed rate-limit and invalid-credential handling;
|
||||
- complete credential encryption/decryption and legacy fallback;
|
||||
- plugin disable/re-enable lifecycle reload;
|
||||
- no regression in existing watchsync, pluginhost, and plugin service tests;
|
||||
- `go test`, targeted race tests, `go vet`, lint, formatting checks, and local
|
||||
path verification before proposing a merge request.
|
||||
@@ -1,13 +1,5 @@
|
||||
# Transcode Resolution Clamp Design
|
||||
|
||||
**Status: superseded — the invariant survives, the implementation described here
|
||||
does not.** `POST /api/v1/playback/transcode/start` and the handler-side helper
|
||||
were removed with the legacy playback protocol
|
||||
([spec](../../architecture/playback-protocol-v3.md),
|
||||
[plan](../plans/2026-07-30-playback-protocol-v3-neutral-contract.md)). The
|
||||
decision below still holds: read it for *why* the server clamps, and see
|
||||
"Where it lives now" for *where*.
|
||||
|
||||
## Problem
|
||||
|
||||
When video encoding is requested for a 2160p file while 4K transcoding is
|
||||
@@ -42,29 +34,14 @@ The normalization rules are:
|
||||
Recognized resolutions are the same tiers already supported by the transcode
|
||||
filter builders: 2160p, 1080p, 720p, 480p, 420p, and 328p.
|
||||
|
||||
## Where it lives now
|
||||
## Architecture and Data Flow
|
||||
|
||||
Under protocol v3 the client no longer names an output resolution, so there is
|
||||
no requested tier to clamp at the API boundary. The invariant moved into the
|
||||
planner, where it is enforced twice against the probed source:
|
||||
A small pure helper in `internal/api/handlers/playback.go` compares requested
|
||||
and effective-source resolution tiers. `HandleStartTranscode` calls it once
|
||||
after the 4K alternate guard has selected and probed the effective file.
|
||||
|
||||
- `availableQualitiesV3` (`internal/playback/plan_v3.go`) omits every ladder rung
|
||||
at or above the source height, so an over-source target is never offered.
|
||||
- The encode-target path clamps `targetHeight` to `source.Height` before building
|
||||
the recipe, so a stale or hand-built `quality_change` cannot reintroduce one.
|
||||
|
||||
Because the plan is the only way to reach FFmpeg, one clamp now covers session
|
||||
state, activity reporting, and restart reconstruction — the paths the original
|
||||
design had to reach through `req.TargetResolution`.
|
||||
|
||||
## Architecture and Data Flow (as originally shipped)
|
||||
|
||||
A small pure helper in `internal/api/handlers/playback.go` compared requested
|
||||
and effective-source resolution tiers. `HandleStartTranscode` called it once
|
||||
after the 4K alternate guard had selected and probed the effective file.
|
||||
|
||||
The normalized value replaced `req.TargetResolution`. Existing downstream
|
||||
paths then automatically used one consistent value for:
|
||||
The normalized value replaces `req.TargetResolution`. Existing downstream
|
||||
paths then automatically use one consistent value for:
|
||||
|
||||
- transcode-node planning and requests;
|
||||
- integrated/local `playback.TranscodeOpts`;
|
||||
|
||||
@@ -109,7 +109,7 @@ require (
|
||||
)
|
||||
|
||||
require (
|
||||
github.com/Silo-Server/silo-plugin-sdk v0.13.0
|
||||
github.com/Silo-Server/silo-plugin-sdk v0.12.0
|
||||
github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.7.14 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/internal/configsources v1.4.30 // indirect
|
||||
github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.7.30 // indirect
|
||||
|
||||
@@ -4,8 +4,8 @@ github.com/PuerkitoBio/goquery v1.8.0 h1:PJTF7AmFCFKk1N6V6jmKfrNH9tV5pNE6lZMkG0g
|
||||
github.com/PuerkitoBio/goquery v1.8.0/go.mod h1:ypIiRMtY7COPGk+I/YbZLbxsxn9g5ejnI2HSMtkjZvI=
|
||||
github.com/SherClockHolmes/webpush-go v1.4.0 h1:ocnzNKWN23T9nvHi6IfyrQjkIc0oJWv1B1pULsf9i3s=
|
||||
github.com/SherClockHolmes/webpush-go v1.4.0/go.mod h1:XSq8pKX11vNV8MJEMwjrlTkxhAj1zKfxmyhdV7Pd6UA=
|
||||
github.com/Silo-Server/silo-plugin-sdk v0.13.0 h1:BXf4cuNbOIIsrVJrRdlQnbc1m04X6lcPSZI+AFLMeK0=
|
||||
github.com/Silo-Server/silo-plugin-sdk v0.13.0/go.mod h1:etqmxLTwjxpFH9goAjBDfNDoqHMv2/sqUXu8yx3hNfA=
|
||||
github.com/Silo-Server/silo-plugin-sdk v0.12.0 h1:7MnaSIJBVdRE8FhfLXWx7Pe+Q2apJiaPMotfhb1VHoE=
|
||||
github.com/Silo-Server/silo-plugin-sdk v0.12.0/go.mod h1:etqmxLTwjxpFH9goAjBDfNDoqHMv2/sqUXu8yx3hNfA=
|
||||
github.com/abadojack/whatlanggo v1.0.1 h1:19N6YogDnf71CTHm3Mp2qhYfkRdyvbgwWdd2EPxJRG4=
|
||||
github.com/abadojack/whatlanggo v1.0.1/go.mod h1:66WiQbSbJBIlOZMsvbKe5m6pzQovxCH9B/K8tQB2uoc=
|
||||
github.com/agnivade/levenshtein v1.2.1 h1:EHBY3UOn1gwdy/VbFwgo4cxecRznFk7fKWN1KOX7eoM=
|
||||
|
||||
@@ -278,15 +278,6 @@ func (s stubStore) GetSeriesPlaybackPreference(context.Context, string, string)
|
||||
func (s stubStore) DeleteSeriesPlaybackPreference(context.Context, string, string) error {
|
||||
panic("unused")
|
||||
}
|
||||
func (s stubStore) SetCollectionSortPreference(context.Context, userstore.CollectionSortPreference) error {
|
||||
panic("unused")
|
||||
}
|
||||
func (s stubStore) GetCollectionSortPreference(context.Context, string, string, string) (*userstore.CollectionSortPreference, error) {
|
||||
panic("unused")
|
||||
}
|
||||
func (s stubStore) ClearCollectionSortPreference(context.Context, string, string, string) error {
|
||||
panic("unused")
|
||||
}
|
||||
func (s stubStore) GetLibraryPlaybackPreference(context.Context, string, int) (*userstore.LibraryPlaybackPreference, error) {
|
||||
panic("unused")
|
||||
}
|
||||
|
||||
@@ -9,7 +9,6 @@ import (
|
||||
)
|
||||
|
||||
func requestAccessFilter(r *http.Request) catalog.AccessFilter {
|
||||
deviceID := deviceMetadataFromRequest(r).DeviceID
|
||||
if scope, ok := access.GetScope(r.Context()); ok {
|
||||
return catalog.AccessFilter{
|
||||
AllowedLibraryIDs: scope.AllowedLibraryIDs,
|
||||
@@ -18,12 +17,10 @@ func requestAccessFilter(r *http.Request) catalog.AccessFilter {
|
||||
MaxPlaybackQuality: scope.MaxPlaybackQuality,
|
||||
UserID: apimw.GetUserID(r.Context()),
|
||||
ProfileID: apimw.GetProfileID(r.Context()),
|
||||
DeviceID: deviceID,
|
||||
}
|
||||
}
|
||||
return catalog.AccessFilter{
|
||||
UserID: apimw.GetUserID(r.Context()),
|
||||
ProfileID: apimw.GetProfileID(r.Context()),
|
||||
DeviceID: deviceID,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,18 +0,0 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestCatalogAccessFiltersCarryExplicitDeviceIdentity(t *testing.T) {
|
||||
req := httptest.NewRequest("GET", "/api/v1/items/movie-1", nil)
|
||||
req.Header.Set(deviceIDHeader, " apple-tv ")
|
||||
|
||||
if got := requestAccessFilter(req).DeviceID; got != "apple-tv" {
|
||||
t.Fatalf("requestAccessFilter().DeviceID = %q, want apple-tv", got)
|
||||
}
|
||||
if got := (&ItemsHandler{}).accessFilter(req).DeviceID; got != "apple-tv" {
|
||||
t.Fatalf("ItemsHandler.accessFilter().DeviceID = %q, want apple-tv", got)
|
||||
}
|
||||
}
|
||||
@@ -59,16 +59,6 @@ type catalogResponse struct {
|
||||
Items []itemListResponse `json:"items"`
|
||||
Snapshot string `json:"snapshot,omitempty"`
|
||||
SearchDiagnostics *searchDiagnostics `json:"search_diagnostics,omitempty"`
|
||||
// EffectiveSort reports the order a collection source actually resolved in
|
||||
// once the viewer's saved override and the collection's configured default
|
||||
// were applied. Omitted for non-collection sources and when the collection
|
||||
// resolved in its own source order.
|
||||
EffectiveSort *effectiveSortResponse `json:"effective_sort,omitempty"`
|
||||
}
|
||||
|
||||
type effectiveSortResponse struct {
|
||||
Field string `json:"field"`
|
||||
Order string `json:"order"`
|
||||
}
|
||||
|
||||
// searchDiagnostics is an additive, per-query observability object emitted on
|
||||
@@ -254,11 +244,6 @@ func (h *CatalogHandler) writeCatalogResponse(w http.ResponseWriter, result *cat
|
||||
}
|
||||
}
|
||||
|
||||
var effectiveSort *effectiveSortResponse
|
||||
if field := strings.TrimSpace(result.EffectiveSort.Field); field != "" {
|
||||
effectiveSort = &effectiveSortResponse{Field: field, Order: result.EffectiveSort.Order}
|
||||
}
|
||||
|
||||
writeJSON(w, http.StatusOK, catalogResponse{
|
||||
Total: result.Total,
|
||||
TotalExact: result.TotalExact && !groupedByWork,
|
||||
@@ -266,7 +251,6 @@ func (h *CatalogHandler) writeCatalogResponse(w http.ResponseWriter, result *cat
|
||||
Items: items,
|
||||
Snapshot: snapshot,
|
||||
SearchDiagnostics: diag,
|
||||
EffectiveSort: effectiveSort,
|
||||
})
|
||||
}
|
||||
|
||||
|
||||
@@ -1,195 +0,0 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"strings"
|
||||
|
||||
apimw "github.com/Silo-Server/silo-server/internal/api/middleware"
|
||||
"github.com/Silo-Server/silo-server/internal/catalog"
|
||||
"github.com/Silo-Server/silo-server/internal/models"
|
||||
"github.com/Silo-Server/silo-server/internal/userstore"
|
||||
)
|
||||
|
||||
type collectionPreferenceLibraryReader interface {
|
||||
GetByID(ctx context.Context, id string) (*models.LibraryCollection, error)
|
||||
}
|
||||
|
||||
// collectionSortPreferenceRequest saves the sort a viewer chose while browsing a
|
||||
// collection. An empty Field is meaningful — it pins the viewer to the
|
||||
// collection's own source order even if its creator later configures a default.
|
||||
// To go back to following the creator's default, DELETE the preference instead.
|
||||
type collectionSortPreferenceRequest struct {
|
||||
CollectionKind string `json:"collection_kind"`
|
||||
CollectionID string `json:"collection_id"`
|
||||
Field string `json:"field"`
|
||||
Order string `json:"order"`
|
||||
}
|
||||
|
||||
type collectionSortPreferenceResponse struct {
|
||||
CollectionKind string `json:"collection_kind"`
|
||||
CollectionID string `json:"collection_id"`
|
||||
Field string `json:"field"`
|
||||
Order string `json:"order"`
|
||||
}
|
||||
|
||||
// NormalizeCollectionSortConfig validates the default sort a collection's
|
||||
// creator configured and returns its canonical sort_config JSON. Shared by the
|
||||
// personal and library collection handlers so both id spaces accept exactly the
|
||||
// same vocabulary.
|
||||
//
|
||||
// allowPersonalized must be false for library collection defaults because
|
||||
// those defaults are shared across profiles. Viewer overrides are validated
|
||||
// separately and may use profile-scoped fields for either collection kind.
|
||||
func NormalizeCollectionSortConfig(raw json.RawMessage, allowPersonalized bool) (string, error) {
|
||||
trimmed := strings.TrimSpace(string(raw))
|
||||
if trimmed == "" || trimmed == jsonNullLiteral || trimmed == "{}" {
|
||||
return "{}", nil
|
||||
}
|
||||
var cfg struct {
|
||||
Field string `json:"field"`
|
||||
Order string `json:"order"`
|
||||
}
|
||||
if err := json.Unmarshal(raw, &cfg); err != nil {
|
||||
return "", errInvalidSortConfig
|
||||
}
|
||||
if strings.TrimSpace(cfg.Field) == "" {
|
||||
// sort_config predates default sorting and may contain independent
|
||||
// collection modes such as {"mode":"manual_pins"}. Preserve those
|
||||
// configurations byte-for-byte instead of erasing them merely because
|
||||
// they do not contain a sort field.
|
||||
return string(raw), nil
|
||||
}
|
||||
qs, ok := catalog.NormalizeCollectionSort(cfg.Field, cfg.Order, allowPersonalized)
|
||||
if !ok {
|
||||
return "", errInvalidSortConfig
|
||||
}
|
||||
return catalog.EncodeCollectionDefaultSort(qs, true)
|
||||
}
|
||||
|
||||
var errInvalidSortConfig = &sortConfigError{}
|
||||
|
||||
type sortConfigError struct{}
|
||||
|
||||
func (*sortConfigError) Error() string {
|
||||
return "sort_config must be {} or {\"field\":\"<supported sort>\",\"order\":\"asc|desc\"}"
|
||||
}
|
||||
|
||||
// HandleSetCollectionSortPreference handles PUT /collections/sort-preference.
|
||||
func (h *CollectionHandler) HandleSetCollectionSortPreference(w http.ResponseWriter, r *http.Request) {
|
||||
userID := apimw.GetUserID(r.Context())
|
||||
profileID := apimw.GetProfileID(r.Context())
|
||||
|
||||
var req collectionSortPreferenceRequest
|
||||
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "Invalid request body")
|
||||
return
|
||||
}
|
||||
|
||||
kind, collectionID, ok := normalizeCollectionRef(req.CollectionKind, req.CollectionID)
|
||||
if !ok {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "collection_kind must be 'library' or 'user' and collection_id is required")
|
||||
return
|
||||
}
|
||||
|
||||
field := strings.ToLower(strings.TrimSpace(req.Field))
|
||||
order := ""
|
||||
if field != "" {
|
||||
qs, valid := catalog.NormalizeCollectionSort(field, req.Order, true)
|
||||
if !valid {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "Unsupported sort field or order for this collection")
|
||||
return
|
||||
}
|
||||
field, order = qs.Field, qs.Order
|
||||
}
|
||||
|
||||
store, err := h.storeProvider.ForUser(r.Context(), userID)
|
||||
if err != nil {
|
||||
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to access user store")
|
||||
return
|
||||
}
|
||||
if !h.canSaveCollectionSortPreference(r, store, kind, collectionID) {
|
||||
// Use one not-found response for absent and inaccessible collections so
|
||||
// the preference endpoint cannot be used to enumerate hidden IDs.
|
||||
writeError(w, http.StatusNotFound, "not_found", "Collection not found")
|
||||
return
|
||||
}
|
||||
|
||||
if err := store.SetCollectionSortPreference(r.Context(), userstore.CollectionSortPreference{
|
||||
ProfileID: profileID,
|
||||
CollectionKind: kind,
|
||||
CollectionID: collectionID,
|
||||
SortField: field,
|
||||
SortOrder: order,
|
||||
}); err != nil {
|
||||
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to save sort preference")
|
||||
return
|
||||
}
|
||||
|
||||
writeJSON(w, http.StatusOK, collectionSortPreferenceResponse{
|
||||
CollectionKind: kind,
|
||||
CollectionID: collectionID,
|
||||
Field: field,
|
||||
Order: order,
|
||||
})
|
||||
}
|
||||
|
||||
func (h *CollectionHandler) canSaveCollectionSortPreference(
|
||||
r *http.Request,
|
||||
store userstore.UserStore,
|
||||
kind, collectionID string,
|
||||
) bool {
|
||||
switch kind {
|
||||
case userstore.CollectionKindLibrary:
|
||||
if h.LibraryCollections == nil {
|
||||
return false
|
||||
}
|
||||
collection, err := h.LibraryCollections.GetByID(r.Context(), collectionID)
|
||||
return err == nil && catalog.CanAccessLibraryCollection(collection, requestAccessFilter(r))
|
||||
case userstore.CollectionKindUser:
|
||||
collection, err := store.GetCollection(r.Context(), collectionID)
|
||||
return err == nil && catalog.ProfileCanAccessCollection(collection, apimw.GetProfileID(r.Context()))
|
||||
default:
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
// HandleClearCollectionSortPreference handles DELETE /collections/sort-preference,
|
||||
// returning the collection to whatever default its creator configured.
|
||||
func (h *CollectionHandler) HandleClearCollectionSortPreference(w http.ResponseWriter, r *http.Request) {
|
||||
userID := apimw.GetUserID(r.Context())
|
||||
profileID := apimw.GetProfileID(r.Context())
|
||||
|
||||
values := r.URL.Query()
|
||||
kind, collectionID, ok := normalizeCollectionRef(values.Get("collection_kind"), values.Get("collection_id"))
|
||||
if !ok {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "collection_kind must be 'library' or 'user' and collection_id is required")
|
||||
return
|
||||
}
|
||||
|
||||
store, err := h.storeProvider.ForUser(r.Context(), userID)
|
||||
if err != nil {
|
||||
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to access user store")
|
||||
return
|
||||
}
|
||||
|
||||
if err := store.ClearCollectionSortPreference(r.Context(), profileID, kind, collectionID); err != nil {
|
||||
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to clear sort preference")
|
||||
return
|
||||
}
|
||||
|
||||
w.WriteHeader(http.StatusNoContent)
|
||||
}
|
||||
|
||||
func normalizeCollectionRef(rawKind, rawID string) (string, string, bool) {
|
||||
kind := strings.ToLower(strings.TrimSpace(rawKind))
|
||||
if kind != userstore.CollectionKindLibrary && kind != userstore.CollectionKindUser {
|
||||
return "", "", false
|
||||
}
|
||||
collectionID := strings.TrimSpace(rawID)
|
||||
if collectionID == "" {
|
||||
return "", "", false
|
||||
}
|
||||
return kind, collectionID, true
|
||||
}
|
||||
@@ -1,302 +0,0 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"os"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
|
||||
"github.com/Silo-Server/silo-server/internal/access"
|
||||
"github.com/Silo-Server/silo-server/internal/api/middleware"
|
||||
"github.com/Silo-Server/silo-server/internal/auth"
|
||||
"github.com/Silo-Server/silo-server/internal/catalog"
|
||||
"github.com/Silo-Server/silo-server/internal/models"
|
||||
"github.com/Silo-Server/silo-server/internal/userstore"
|
||||
"github.com/Silo-Server/silo-server/internal/userstore/pgstore"
|
||||
)
|
||||
|
||||
type sortPrefLibraryReader struct {
|
||||
collection *models.LibraryCollection
|
||||
}
|
||||
|
||||
func (r sortPrefLibraryReader) GetByID(_ context.Context, id string) (*models.LibraryCollection, error) {
|
||||
if r.collection == nil || r.collection.ID != id {
|
||||
return nil, catalog.ErrLibraryCollectionNotFound
|
||||
}
|
||||
return r.collection, nil
|
||||
}
|
||||
|
||||
// These exercise the sort-preference endpoints through real HTTP handlers and a
|
||||
// real store, using middleware.SetClaims / SetProfileID to supply the auth
|
||||
// context the middleware would normally attach. Set SILO_TEST_DATABASE_URL to a
|
||||
// migrated database to run them.
|
||||
|
||||
func sortPrefHandlerPool(t *testing.T) *pgxpool.Pool {
|
||||
t.Helper()
|
||||
dsn := os.Getenv("SILO_TEST_DATABASE_URL")
|
||||
if dsn == "" {
|
||||
t.Skip("SILO_TEST_DATABASE_URL is not set")
|
||||
}
|
||||
pool, err := pgxpool.New(context.Background(), dsn)
|
||||
if err != nil {
|
||||
t.Fatalf("connect test database: %v", err)
|
||||
}
|
||||
t.Cleanup(pool.Close)
|
||||
var tableName *string
|
||||
if err := pool.QueryRow(context.Background(),
|
||||
`SELECT to_regclass('public.user_collection_sort_preferences')::text`).Scan(&tableName); err != nil {
|
||||
t.Fatalf("check preference table: %v", err)
|
||||
}
|
||||
if tableName == nil || *tableName == "" {
|
||||
t.Skip("test database has not applied the collection sort preference migration")
|
||||
}
|
||||
return pool
|
||||
}
|
||||
|
||||
func sortPrefFixtureUser(t *testing.T, pool *pgxpool.Pool) int {
|
||||
t.Helper()
|
||||
var userID int
|
||||
if err := pool.QueryRow(context.Background(), `
|
||||
INSERT INTO users (username, email, password_hash, role)
|
||||
VALUES ('sort-pref-handler-fixture', 'sort-pref-handler@invalid.test', '', 'user')
|
||||
RETURNING id
|
||||
`).Scan(&userID); err != nil {
|
||||
t.Fatalf("seed fixture user: %v", err)
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
_, _ = pool.Exec(context.Background(), `DELETE FROM users WHERE id = $1`, userID)
|
||||
})
|
||||
return userID
|
||||
}
|
||||
|
||||
// authed attaches the user + profile scope the middleware chain would normally
|
||||
// have put on the request.
|
||||
func authed(r *http.Request, userID int, profileID string) *http.Request {
|
||||
ctx := middleware.SetClaims(r.Context(), &auth.Claims{UserID: userID, Role: "user"})
|
||||
ctx = middleware.SetProfileID(ctx, profileID)
|
||||
return r.WithContext(ctx)
|
||||
}
|
||||
|
||||
func TestCollectionSortPreferenceEndpoints(t *testing.T) {
|
||||
pool := sortPrefHandlerPool(t)
|
||||
userID := sortPrefFixtureUser(t, pool)
|
||||
const profileID = "profile-http"
|
||||
const collectionID = "http-collection-1"
|
||||
|
||||
provider := pgstore.NewPostgresProvider(pool)
|
||||
handler := NewCollectionHandler(provider)
|
||||
handler.LibraryCollections = sortPrefLibraryReader{collection: &models.LibraryCollection{
|
||||
ID: collectionID, Visibility: "visible", LibraryIDs: []int{7},
|
||||
}}
|
||||
store, err := provider.ForUser(context.Background(), userID)
|
||||
if err != nil {
|
||||
t.Fatalf("user store: %v", err)
|
||||
}
|
||||
if err := store.CreateProfile(context.Background(), userstore.Profile{ID: profileID, Name: "HTTP sort preference"}); err != nil {
|
||||
t.Fatalf("seed profile: %v", err)
|
||||
}
|
||||
personalCollection, err := store.CreateCollection(context.Background(), userstore.CreateCollectionInput{
|
||||
CreatorProfileID: profileID,
|
||||
Name: "HTTP personal sort preference",
|
||||
CollectionType: "manual",
|
||||
})
|
||||
if err != nil {
|
||||
t.Fatalf("seed personal collection: %v", err)
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
_ = store.DeleteProfile(context.Background(), profileID)
|
||||
})
|
||||
|
||||
put := func(body string) *httptest.ResponseRecorder {
|
||||
req := authed(httptest.NewRequest(http.MethodPut, "/collections/sort-preference", strings.NewReader(body)), userID, profileID)
|
||||
rec := httptest.NewRecorder()
|
||||
handler.HandleSetCollectionSortPreference(rec, req)
|
||||
return rec
|
||||
}
|
||||
|
||||
t.Run("saves a sort the viewer picked", func(t *testing.T) {
|
||||
rec := put(`{"collection_kind":"library","collection_id":"` + collectionID + `","field":"title","order":"asc"}`)
|
||||
if rec.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, body = %s", rec.Code, rec.Body.String())
|
||||
}
|
||||
var resp collectionSortPreferenceResponse
|
||||
if err := json.Unmarshal(rec.Body.Bytes(), &resp); err != nil {
|
||||
t.Fatalf("decode: %v", err)
|
||||
}
|
||||
if resp.Field != "title" || resp.Order != "asc" {
|
||||
t.Fatalf("response = %+v", resp)
|
||||
}
|
||||
|
||||
// Read it back through the store, not the response, so the assertion
|
||||
// covers persistence rather than echo.
|
||||
pref, err := store.GetCollectionSortPreference(context.Background(), profileID, userstore.CollectionKindLibrary, collectionID)
|
||||
if err != nil || pref == nil {
|
||||
t.Fatalf("stored preference = %v, err = %v", pref, err)
|
||||
}
|
||||
if pref.SortField != "title" || pref.SortOrder != "asc" {
|
||||
t.Fatalf("stored preference = %+v", pref)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("fills in the field's default order", func(t *testing.T) {
|
||||
rec := put(`{"collection_kind":"library","collection_id":"` + collectionID + `","field":"year"}`)
|
||||
if rec.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, body = %s", rec.Code, rec.Body.String())
|
||||
}
|
||||
pref, _ := store.GetCollectionSortPreference(context.Background(), profileID, userstore.CollectionKindLibrary, collectionID)
|
||||
if pref == nil || pref.SortOrder != "desc" {
|
||||
t.Fatalf("stored preference = %+v, want year/desc", pref)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("an empty field pins to source order", func(t *testing.T) {
|
||||
rec := put(`{"collection_kind":"library","collection_id":"` + collectionID + `","field":""}`)
|
||||
if rec.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, body = %s", rec.Code, rec.Body.String())
|
||||
}
|
||||
pref, _ := store.GetCollectionSortPreference(context.Background(), profileID, userstore.CollectionKindLibrary, collectionID)
|
||||
if pref == nil {
|
||||
t.Fatal("pinning to source order removed the row; it must persist as an explicit choice")
|
||||
}
|
||||
if pref.SortField != "" {
|
||||
t.Fatalf("stored field = %q, want empty", pref.SortField)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("accepts a personalized viewer sort on a library collection", func(t *testing.T) {
|
||||
rec := put(`{"collection_kind":"library","collection_id":"` + collectionID + `","field":"progress"}`)
|
||||
if rec.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, body = %s", rec.Code, rec.Body.String())
|
||||
}
|
||||
pref, _ := store.GetCollectionSortPreference(context.Background(), profileID, userstore.CollectionKindLibrary, collectionID)
|
||||
if pref == nil || pref.SortField != "progress" || pref.SortOrder != "desc" {
|
||||
t.Fatalf("stored preference = %+v, want progress/desc", pref)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("rejects an invalid sort order", func(t *testing.T) {
|
||||
rec := put(`{"collection_kind":"library","collection_id":"` + collectionID + `","field":"title","order":"sideways"}`)
|
||||
if rec.Code != http.StatusBadRequest {
|
||||
t.Fatalf("status = %d, want 400; body = %s", rec.Code, rec.Body.String())
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("accepts a personalized sort on a personal collection", func(t *testing.T) {
|
||||
rec := put(`{"collection_kind":"user","collection_id":"` + personalCollection.ID + `","field":"progress"}`)
|
||||
if rec.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, body = %s", rec.Code, rec.Body.String())
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
_ = store.ClearCollectionSortPreference(context.Background(), profileID, userstore.CollectionKindUser, personalCollection.ID)
|
||||
})
|
||||
})
|
||||
|
||||
t.Run("rejects a nonexistent collection", func(t *testing.T) {
|
||||
rec := put(`{"collection_kind":"library","collection_id":"missing","field":"title"}`)
|
||||
if rec.Code != http.StatusNotFound {
|
||||
t.Fatalf("status = %d, want 404; body = %s", rec.Code, rec.Body.String())
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("rejects a library collection outside the viewer scope", func(t *testing.T) {
|
||||
req := authed(httptest.NewRequest(http.MethodPut, "/collections/sort-preference",
|
||||
strings.NewReader(`{"collection_kind":"library","collection_id":"`+collectionID+`","field":"title"}`)), userID, profileID)
|
||||
req = req.WithContext(access.SetScope(req.Context(), access.Scope{AllowedLibraryIDs: []int{99}}))
|
||||
rec := httptest.NewRecorder()
|
||||
handler.HandleSetCollectionSortPreference(rec, req)
|
||||
if rec.Code != http.StatusNotFound {
|
||||
t.Fatalf("status = %d, want 404; body = %s", rec.Code, rec.Body.String())
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("rejects an unknown collection kind", func(t *testing.T) {
|
||||
rec := put(`{"collection_kind":"nonsense","collection_id":"x","field":"title"}`)
|
||||
if rec.Code != http.StatusBadRequest {
|
||||
t.Fatalf("status = %d, want 400", rec.Code)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("clearing removes the override", func(t *testing.T) {
|
||||
req := authed(httptest.NewRequest(http.MethodDelete,
|
||||
"/collections/sort-preference?collection_kind=library&collection_id="+collectionID, nil), userID, profileID)
|
||||
rec := httptest.NewRecorder()
|
||||
handler.HandleClearCollectionSortPreference(rec, req)
|
||||
if rec.Code != http.StatusNoContent {
|
||||
t.Fatalf("status = %d, body = %s", rec.Code, rec.Body.String())
|
||||
}
|
||||
pref, err := store.GetCollectionSortPreference(context.Background(), profileID, userstore.CollectionKindLibrary, collectionID)
|
||||
if err != nil {
|
||||
t.Fatalf("reading cleared preference: %v", err)
|
||||
}
|
||||
if pref != nil {
|
||||
t.Fatalf("preference still present after clear: %+v", pref)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
// TestNormalizeCollectionSortConfigForCreators covers the validation the
|
||||
// collection create/update handlers apply to a creator-configured default.
|
||||
func TestNormalizeCollectionSortConfigForCreators(t *testing.T) {
|
||||
cases := []struct {
|
||||
name string
|
||||
raw string
|
||||
allowPersonalized bool
|
||||
want string
|
||||
wantErr bool
|
||||
}{
|
||||
{name: "absent", raw: "", want: "{}"},
|
||||
{name: "explicit null", raw: `null`, want: "{}"},
|
||||
{name: "legacy empty object", raw: `{}`, want: "{}"},
|
||||
{name: "empty field remains source order", raw: `{"field":""}`, want: `{"field":""}`},
|
||||
{name: "preserves manual pins mode", raw: `{"mode":"manual_pins"}`, want: `{"mode":"manual_pins"}`},
|
||||
{name: "canonicalizes", raw: `{"field":" Title ","order":"ASC"}`, want: `{"field":"title","order":"asc"}`},
|
||||
{name: "fills the default order", raw: `{"field":"year"}`, want: `{"field":"year","order":"desc"}`},
|
||||
{name: "rejects unknown fields", raw: `{"field":"not_a_sort"}`, wantErr: true},
|
||||
{name: "rejects invalid orders", raw: `{"field":"year","order":"sideways"}`, wantErr: true},
|
||||
{name: "rejects personalized for library", raw: `{"field":"progress"}`, wantErr: true},
|
||||
{
|
||||
name: "allows personalized for personal",
|
||||
raw: `{"field":"progress"}`,
|
||||
allowPersonalized: true,
|
||||
want: `{"field":"progress","order":"desc"}`,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
got, err := NormalizeCollectionSortConfig(json.RawMessage(tc.raw), tc.allowPersonalized)
|
||||
if tc.wantErr {
|
||||
if err == nil {
|
||||
t.Fatalf("expected an error, got %q", got)
|
||||
}
|
||||
return
|
||||
}
|
||||
if err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
if got != tc.want {
|
||||
t.Fatalf("got %s, want %s", got, tc.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestNormalizeCollectionSortConfigPreservesManualPinsAcrossUpdates(t *testing.T) {
|
||||
const manualPins = `{"mode":"manual_pins"}`
|
||||
created, err := NormalizeCollectionSortConfig(json.RawMessage(manualPins), false)
|
||||
if err != nil {
|
||||
t.Fatalf("normalize on create: %v", err)
|
||||
}
|
||||
updated, err := NormalizeCollectionSortConfig(json.RawMessage(created), false)
|
||||
if err != nil {
|
||||
t.Fatalf("normalize on update: %v", err)
|
||||
}
|
||||
if updated != manualPins {
|
||||
t.Fatalf("manual pins config changed across create/read/update: got %s, want %s", updated, manualPins)
|
||||
}
|
||||
}
|
||||
@@ -22,12 +22,11 @@ import (
|
||||
|
||||
// CollectionHandler handles personal collection CRUD endpoints.
|
||||
type CollectionHandler struct {
|
||||
storeProvider userstore.UserStoreProvider
|
||||
LibraryCollections collectionPreferenceLibraryReader
|
||||
Executor *catalog.QueryExecutor
|
||||
S3GP *s3client.Client
|
||||
HTTPClient *http.Client
|
||||
PresignTTL time.Duration
|
||||
storeProvider userstore.UserStoreProvider
|
||||
Executor *catalog.QueryExecutor
|
||||
S3GP *s3client.Client
|
||||
HTTPClient *http.Client
|
||||
PresignTTL time.Duration
|
||||
}
|
||||
|
||||
// NewCollectionHandler creates a new CollectionHandler.
|
||||
@@ -107,11 +106,8 @@ type collectionCapabilitiesResponse struct {
|
||||
// DisplayFilterFields are the catalog query fields a personal-collection
|
||||
// display filter may use. Clients build a display_query_definition fragment
|
||||
// from these rather than a bespoke enum.
|
||||
DisplayFilterFields []string `json:"display_filter_fields"`
|
||||
DisplayFilterPresets collectionDisplayFilterPresets `json:"display_filter_presets"`
|
||||
CollectionDefaultSort bool `json:"collection_default_sort"`
|
||||
CollectionSortPreferences bool `json:"collection_sort_preferences"`
|
||||
EffectiveCollectionSort bool `json:"effective_collection_sort"`
|
||||
DisplayFilterFields []string `json:"display_filter_fields"`
|
||||
DisplayFilterPresets collectionDisplayFilterPresets `json:"display_filter_presets"`
|
||||
}
|
||||
|
||||
type collectionDisplayFilterPresets struct {
|
||||
@@ -237,9 +233,6 @@ func (h *CollectionHandler) HandleCapabilities(w http.ResponseWriter, r *http.Re
|
||||
Watched: []string{"all", "watched", "unwatched"},
|
||||
Media: []string{"all", "movie", "series"},
|
||||
},
|
||||
CollectionDefaultSort: true,
|
||||
CollectionSortPreferences: true,
|
||||
EffectiveCollectionSort: true,
|
||||
})
|
||||
}
|
||||
|
||||
@@ -281,11 +274,7 @@ func (h *CollectionHandler) HandleCreateCollection(w http.ResponseWriter, r *htt
|
||||
}
|
||||
}
|
||||
queryDefinition := string(queryDefinitionJSON)
|
||||
sortConfig, err := NormalizeCollectionSortConfig(req.SortConfig, true)
|
||||
if err != nil {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", err.Error())
|
||||
return
|
||||
}
|
||||
sortConfig := string(defaultJSON(req.SortConfig))
|
||||
displayQueryDefinition, err := catalog.NormalizeDisplayQueryFragment(req.DisplayQueryDefinition)
|
||||
if err != nil {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", err.Error())
|
||||
@@ -369,11 +358,7 @@ func (h *CollectionHandler) HandleUpdateCollection(w http.ResponseWriter, r *htt
|
||||
input.QueryDefinition = &value
|
||||
}
|
||||
if len(req.SortConfig) > 0 {
|
||||
value, err := NormalizeCollectionSortConfig(req.SortConfig, true)
|
||||
if err != nil {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", err.Error())
|
||||
return
|
||||
}
|
||||
value := string(req.SortConfig)
|
||||
input.SortConfig = &value
|
||||
}
|
||||
input.IsShared = req.IsShared
|
||||
|
||||
@@ -1,25 +0,0 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestCollectionCapabilitiesAdvertiseSortSupport(t *testing.T) {
|
||||
rec := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodGet, "/collections/capabilities", nil)
|
||||
NewCollectionHandler(nil).HandleCapabilities(rec, req)
|
||||
|
||||
if rec.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, body = %s", rec.Code, rec.Body.String())
|
||||
}
|
||||
var got collectionCapabilitiesResponse
|
||||
if err := json.Unmarshal(rec.Body.Bytes(), &got); err != nil {
|
||||
t.Fatalf("decode response: %v", err)
|
||||
}
|
||||
if !got.CollectionDefaultSort || !got.CollectionSortPreferences || !got.EffectiveCollectionSort {
|
||||
t.Fatalf("sort capabilities not fully advertised: %+v", got)
|
||||
}
|
||||
}
|
||||
@@ -4,15 +4,9 @@ import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"log/slog"
|
||||
"net/http"
|
||||
"net/url"
|
||||
"path/filepath"
|
||||
"strconv"
|
||||
"strings"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"github.com/go-chi/chi/v5"
|
||||
|
||||
@@ -20,9 +14,7 @@ import (
|
||||
"github.com/Silo-Server/silo-server/internal/catalog"
|
||||
"github.com/Silo-Server/silo-server/internal/downloads"
|
||||
"github.com/Silo-Server/silo-server/internal/httpstream"
|
||||
"github.com/Silo-Server/silo-server/internal/nodepool"
|
||||
"github.com/Silo-Server/silo-server/internal/playback"
|
||||
"github.com/Silo-Server/silo-server/internal/streamtoken"
|
||||
)
|
||||
|
||||
// DownloadService is the interface that the download handler depends on. A
|
||||
@@ -52,51 +44,14 @@ type DownloadService interface {
|
||||
|
||||
// DownloadHandler handles download endpoints.
|
||||
type DownloadHandler struct {
|
||||
svc DownloadService
|
||||
nodePlanner nodepool.DownloadPlanner
|
||||
jwtSecret func() string
|
||||
proxyHTTPClient *http.Client
|
||||
preflightMu sync.Mutex
|
||||
preflightCache map[string]proxyPreflightResult
|
||||
}
|
||||
|
||||
type proxyPreflightResult struct {
|
||||
reachable bool
|
||||
expiresAt time.Time
|
||||
svc DownloadService
|
||||
}
|
||||
|
||||
// NewDownloadHandler creates a new DownloadHandler.
|
||||
func NewDownloadHandler(svc DownloadService) *DownloadHandler {
|
||||
return &DownloadHandler{
|
||||
svc: svc,
|
||||
preflightCache: make(map[string]proxyPreflightResult),
|
||||
proxyHTTPClient: &http.Client{
|
||||
Timeout: 3 * time.Second,
|
||||
CheckRedirect: func(_ *http.Request, _ []*http.Request) error {
|
||||
return http.ErrUseLastResponse
|
||||
},
|
||||
},
|
||||
}
|
||||
return &DownloadHandler{svc: svc}
|
||||
}
|
||||
|
||||
// SetProxyDelivery enables stateless proxy-node egress after the API service
|
||||
// has authorized and resolved a download target. It is optional; integrated
|
||||
// deployments continue to serve bytes locally.
|
||||
func (h *DownloadHandler) SetProxyDelivery(planner nodepool.DownloadPlanner, jwtSecret func() string) {
|
||||
h.nodePlanner = planner
|
||||
h.jwtSecret = jwtSecret
|
||||
}
|
||||
|
||||
type downloadFileResolver interface {
|
||||
ResolveDirectFile(ctx context.Context, userID, fileID int, format string, filter catalog.AccessFilter) (*downloads.FileTarget, error)
|
||||
ResolveManagedFile(ctx context.Context, userID int, profileID, deviceID, downloadID string, filter catalog.AccessFilter) (*downloads.FileTarget, error)
|
||||
}
|
||||
|
||||
const (
|
||||
proxyDownloadTokenTTL = 15 * time.Minute
|
||||
proxyPreflightCacheTTL = 5 * time.Second
|
||||
)
|
||||
|
||||
// downloadRequest represents the JSON body for POST /downloads.
|
||||
type downloadRequest struct {
|
||||
ContentID string `json:"content_id"`
|
||||
@@ -169,7 +124,6 @@ type downloadCapabilityResponse struct {
|
||||
SeasonDownload bool `json:"season_download"`
|
||||
SeriesMonitoring bool `json:"series_monitoring"`
|
||||
MonitoringModes []string `json:"monitoring_modes,omitempty"`
|
||||
ProxyDelivery bool `json:"proxy_delivery"`
|
||||
}
|
||||
|
||||
func toDownloadResponse(d *downloads.Download) downloadResponse {
|
||||
@@ -225,7 +179,6 @@ func (h *DownloadHandler) HandleCapability(w http.ResponseWriter, r *http.Reques
|
||||
return
|
||||
}
|
||||
|
||||
_, _, proxyDelivery := h.proxyTarget()
|
||||
writeJSON(w, http.StatusOK, downloadCapabilityResponse{
|
||||
Enabled: capInfo.Enabled,
|
||||
DownloadAllowed: capInfo.DownloadAllowed,
|
||||
@@ -235,7 +188,6 @@ func (h *DownloadHandler) HandleCapability(w http.ResponseWriter, r *http.Reques
|
||||
SeasonDownload: capInfo.SeasonDownload,
|
||||
SeriesMonitoring: capInfo.SeriesMonitoring,
|
||||
MonitoringModes: capInfo.MonitoringModes,
|
||||
ProxyDelivery: proxyDelivery,
|
||||
})
|
||||
}
|
||||
|
||||
@@ -430,17 +382,6 @@ func (h *DownloadHandler) HandlePatchDownload(w http.ResponseWriter, r *http.Req
|
||||
|
||||
// HandleDownloadFile handles GET /downloads/{id}/file.
|
||||
func (h *DownloadHandler) HandleDownloadFile(w http.ResponseWriter, r *http.Request) {
|
||||
h.handleDownloadFile(w, r, false)
|
||||
}
|
||||
|
||||
// HandleDownloadFileViaProxy serves the additive proxy-aware download route.
|
||||
// Clients opt into its 307 response only after discovering proxy_delivery in
|
||||
// the download capability; the established file route retains 200/206.
|
||||
func (h *DownloadHandler) HandleDownloadFileViaProxy(w http.ResponseWriter, r *http.Request) {
|
||||
h.handleDownloadFile(w, r, true)
|
||||
}
|
||||
|
||||
func (h *DownloadHandler) handleDownloadFile(w http.ResponseWriter, r *http.Request, delegate bool) {
|
||||
userID := apimw.GetUserID(r.Context())
|
||||
if userID == 0 {
|
||||
writeError(w, http.StatusUnauthorized, "unauthorized", "Authentication required")
|
||||
@@ -458,56 +399,35 @@ func (h *DownloadHandler) handleDownloadFile(w http.ResponseWriter, r *http.Requ
|
||||
|
||||
profileID, deviceID, _, _ := managedIdentity(r)
|
||||
filter := requestAccessFilter(r)
|
||||
if delegate && deviceID != "" {
|
||||
handled, err := h.redirectManagedDownload(r.Context(), w, r, userID, profileID, deviceID, id, filter)
|
||||
if err != nil {
|
||||
h.writeDownloadFileError(w, r, id, err)
|
||||
return
|
||||
}
|
||||
if handled {
|
||||
return
|
||||
}
|
||||
}
|
||||
// Full media downloads outlive the server's absolute WriteTimeout; roll
|
||||
// the write deadline with progress instead.
|
||||
sw := httpstream.NewRollingDeadlineWriter(w)
|
||||
if err := h.svc.ServeFile(r.Context(), sw, r, userID, profileID, deviceID, id, filter); err != nil {
|
||||
if errors.Is(err, downloads.ErrResponseCommitted) {
|
||||
if errors.Is(err, downloads.ErrNotFound) || errors.Is(err, catalog.ErrItemNotFound) {
|
||||
writeError(w, http.StatusNotFound, "not_found", "Download not found")
|
||||
return
|
||||
}
|
||||
if errors.Is(err, downloads.ErrDownloadNotActive) {
|
||||
writeError(w, http.StatusConflict, "download_inactive", "This download is no longer active")
|
||||
return
|
||||
}
|
||||
if errors.Is(err, downloads.ErrProfileRequired) {
|
||||
writeError(w, http.StatusBadRequest, "profile_required", "A profile is required for managed downloads")
|
||||
return
|
||||
}
|
||||
if errors.Is(err, downloads.ErrFeatureDisabled) || errors.Is(err, downloads.ErrDownloadNotAllowed) {
|
||||
writeError(w, http.StatusForbidden, "forbidden", "You are not allowed to download")
|
||||
return
|
||||
}
|
||||
h.writeDownloadFileError(w, r, id, err)
|
||||
}
|
||||
}
|
||||
|
||||
func (h *DownloadHandler) writeDownloadFileError(w http.ResponseWriter, r *http.Request, id string, err error) {
|
||||
switch {
|
||||
case errors.Is(err, downloads.ErrNotFound), errors.Is(err, catalog.ErrItemNotFound):
|
||||
writeError(w, http.StatusNotFound, "not_found", "Download not found")
|
||||
case errors.Is(err, downloads.ErrDownloadNotActive):
|
||||
writeError(w, http.StatusConflict, "download_inactive", "This download is no longer active")
|
||||
case errors.Is(err, downloads.ErrProfileRequired):
|
||||
writeError(w, http.StatusBadRequest, "profile_required", "A profile is required for managed downloads")
|
||||
case errors.Is(err, downloads.ErrFeatureDisabled), errors.Is(err, downloads.ErrDownloadNotAllowed):
|
||||
writeError(w, http.StatusForbidden, "forbidden", "You are not allowed to download")
|
||||
default:
|
||||
slog.ErrorContext(r.Context(), "failed to serve download file", "component", "api", "download_id", id, "error", err)
|
||||
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to serve download")
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// HandleDirectDownload handles GET /direct-download?file_id=N. A legacy
|
||||
// format=original query is accepted, but direct downloads remain original-only.
|
||||
func (h *DownloadHandler) HandleDirectDownload(w http.ResponseWriter, r *http.Request) {
|
||||
h.handleDirectDownload(w, r, false)
|
||||
}
|
||||
|
||||
// HandleDirectDownloadViaProxy serves the additive proxy-aware direct-download
|
||||
// route while the established endpoint retains its 200/206 response contract.
|
||||
func (h *DownloadHandler) HandleDirectDownloadViaProxy(w http.ResponseWriter, r *http.Request) {
|
||||
h.handleDirectDownload(w, r, true)
|
||||
}
|
||||
|
||||
func (h *DownloadHandler) handleDirectDownload(w http.ResponseWriter, r *http.Request, delegate bool) {
|
||||
userID := apimw.GetUserID(r.Context())
|
||||
if userID == 0 {
|
||||
writeError(w, http.StatusUnauthorized, "unauthorized", "Authentication required")
|
||||
@@ -526,163 +446,12 @@ func (h *DownloadHandler) handleDirectDownload(w http.ResponseWriter, r *http.Re
|
||||
}
|
||||
|
||||
filter := requestAccessFilter(r)
|
||||
if delegate {
|
||||
if handled, redirectErr := h.redirectDirectDownload(r.Context(), w, r, userID, fileID, r.URL.Query().Get("format"), filter); redirectErr != nil {
|
||||
h.writeDownloadError(w, redirectErr)
|
||||
return
|
||||
} else if handled {
|
||||
return
|
||||
}
|
||||
}
|
||||
if err := h.svc.ServeDirect(r.Context(), w, r, userID, fileID, r.URL.Query().Get("format"), filter); err != nil {
|
||||
h.writeDownloadError(w, err)
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
func (h *DownloadHandler) redirectDirectDownload(ctx context.Context, w http.ResponseWriter, r *http.Request, userID, fileID int, format string, filter catalog.AccessFilter) (bool, error) {
|
||||
resolver, secret, ok := h.proxyTarget()
|
||||
if !ok {
|
||||
return false, nil
|
||||
}
|
||||
target, err := resolver.ResolveDirectFile(ctx, userID, fileID, format, filter)
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
return h.redirectToProxy(w, r, secret, target, userID, "")
|
||||
}
|
||||
|
||||
func (h *DownloadHandler) redirectManagedDownload(ctx context.Context, w http.ResponseWriter, r *http.Request, userID int, profileID, deviceID, downloadID string, filter catalog.AccessFilter) (bool, error) {
|
||||
resolver, secret, ok := h.proxyTarget()
|
||||
if !ok {
|
||||
return false, nil
|
||||
}
|
||||
target, err := resolver.ResolveManagedFile(ctx, userID, profileID, deviceID, downloadID, filter)
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
return h.redirectToProxy(w, r, secret, target, userID, profileID)
|
||||
}
|
||||
|
||||
func (h *DownloadHandler) proxyTarget() (downloadFileResolver, string, bool) {
|
||||
resolver, ok := h.svc.(downloadFileResolver)
|
||||
if !ok || h.nodePlanner == nil || h.jwtSecret == nil {
|
||||
return nil, "", false
|
||||
}
|
||||
secret := strings.TrimSpace(h.jwtSecret())
|
||||
if secret == "" {
|
||||
return nil, "", false
|
||||
}
|
||||
return resolver, secret, true
|
||||
}
|
||||
|
||||
func (h *DownloadHandler) redirectToProxy(w http.ResponseWriter, r *http.Request, secret string, target *downloads.FileTarget, userID int, profileID string) (bool, error) {
|
||||
if target == nil || (strings.TrimSpace(target.Path) == "" && target.OriginArtifactID == "") {
|
||||
return false, fmt.Errorf("download target is empty")
|
||||
}
|
||||
if target.OriginArtifactID != "" && strings.TrimSpace(target.OriginNodeURL) == "" {
|
||||
return false, nil
|
||||
}
|
||||
if !target.ProxyEligible {
|
||||
return false, nil
|
||||
}
|
||||
reservationKey := target.DownloadID
|
||||
if reservationKey == "" {
|
||||
reservationKey = fmt.Sprintf("direct-%d-%d", userID, target.MediaFileID)
|
||||
}
|
||||
sessionID := fmt.Sprintf("download-%s-%d", reservationKey, time.Now().UnixNano())
|
||||
plan := h.nodePlanner.PlanDownload(sessionID, target.OriginNodeGroup)
|
||||
if plan.ProxyNode == nil {
|
||||
return false, nil
|
||||
}
|
||||
releaseReservation := func() { h.nodePlanner.ReleaseSession(sessionID) }
|
||||
mediaPath := target.Path
|
||||
downloadFilename := ""
|
||||
if target.OriginArtifactID != "" {
|
||||
mediaPath = ""
|
||||
if strings.TrimSpace(target.Path) != "" {
|
||||
downloadFilename = filepath.Base(target.Path)
|
||||
}
|
||||
}
|
||||
token, err := streamtoken.Sign(streamtoken.Claims{
|
||||
SessionID: sessionID,
|
||||
MediaPath: mediaPath,
|
||||
PlayMethod: streamtoken.PlayMethodDownload,
|
||||
TranscodeNode: target.OriginNodeURL,
|
||||
DownloadArtifactID: target.OriginArtifactID,
|
||||
DownloadArtifactRowID: target.ArtifactID,
|
||||
DownloadFilename: downloadFilename,
|
||||
UserID: userID,
|
||||
ProfileID: profileID,
|
||||
MediaFileID: target.MediaFileID,
|
||||
}, secret, proxyDownloadTokenTTL)
|
||||
if err != nil {
|
||||
releaseReservation()
|
||||
return false, fmt.Errorf("sign proxy download token: %w", err)
|
||||
}
|
||||
location := strings.TrimRight(plan.ProxyNode.URL, "/") + "/downloads/file/" + url.PathEscape(token)
|
||||
targetKey := target.Path
|
||||
if target.OriginArtifactID != "" {
|
||||
targetKey = target.OriginNodeURL + "\x00" + target.OriginArtifactID
|
||||
}
|
||||
cacheKey := strings.TrimRight(plan.ProxyNode.URL, "/") + "\x00" + targetKey
|
||||
if !h.proxyCanServe(r.Context(), cacheKey, location) {
|
||||
releaseReservation()
|
||||
return false, nil
|
||||
}
|
||||
// A HEAD request only proves that the proxy can read the selected path; the
|
||||
// proxy deliberately does not count it as an active transfer. Release the
|
||||
// provisional slot before redirecting so a probe cannot hold max_jobs
|
||||
// capacity until the planner's reservation bridge expires.
|
||||
if r.Method == http.MethodHead {
|
||||
releaseReservation()
|
||||
}
|
||||
http.Redirect(w, r, location, http.StatusTemporaryRedirect)
|
||||
return true, nil
|
||||
}
|
||||
|
||||
func (h *DownloadHandler) proxyCanServe(ctx context.Context, cacheKey, location string) bool {
|
||||
now := time.Now()
|
||||
h.preflightMu.Lock()
|
||||
for key, cached := range h.preflightCache {
|
||||
if !now.Before(cached.expiresAt) {
|
||||
delete(h.preflightCache, key)
|
||||
}
|
||||
}
|
||||
if cached, ok := h.preflightCache[cacheKey]; ok && now.Before(cached.expiresAt) {
|
||||
h.preflightMu.Unlock()
|
||||
return cached.reachable
|
||||
}
|
||||
h.preflightMu.Unlock()
|
||||
|
||||
req, err := http.NewRequestWithContext(ctx, http.MethodHead, location, nil)
|
||||
if err != nil {
|
||||
return false
|
||||
}
|
||||
client := h.proxyHTTPClient
|
||||
if client == nil {
|
||||
client = http.DefaultClient
|
||||
}
|
||||
resp, err := client.Do(req)
|
||||
reachable := false
|
||||
if err != nil {
|
||||
slog.DebugContext(ctx, "download proxy preflight failed; serving locally", "component", "api", "error", err)
|
||||
} else {
|
||||
_ = resp.Body.Close()
|
||||
reachable = resp.StatusCode >= http.StatusOK && resp.StatusCode < http.StatusMultipleChoices
|
||||
}
|
||||
if err == nil && !reachable {
|
||||
slog.DebugContext(ctx, "download proxy preflight unavailable; serving locally", "component", "api", "status", resp.StatusCode)
|
||||
}
|
||||
h.preflightMu.Lock()
|
||||
if h.preflightCache == nil {
|
||||
h.preflightCache = make(map[string]proxyPreflightResult)
|
||||
}
|
||||
h.preflightCache[cacheKey] = proxyPreflightResult{reachable: reachable, expiresAt: now.Add(proxyPreflightCacheTTL)}
|
||||
h.preflightMu.Unlock()
|
||||
return reachable
|
||||
}
|
||||
|
||||
// requireManaged validates a managed (device-scoped) request: authentication, a
|
||||
// configured service, and the device + profile identity (device_id from the
|
||||
// X-Silo-Device-Id header only, never the body). On failure it writes the error
|
||||
|
||||
@@ -4,10 +4,8 @@ import (
|
||||
"bytes"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/go-chi/chi/v5"
|
||||
@@ -16,8 +14,6 @@ import (
|
||||
"github.com/Silo-Server/silo-server/internal/auth"
|
||||
"github.com/Silo-Server/silo-server/internal/catalog"
|
||||
"github.com/Silo-Server/silo-server/internal/downloads"
|
||||
"github.com/Silo-Server/silo-server/internal/nodepool"
|
||||
"github.com/Silo-Server/silo-server/internal/streamtoken"
|
||||
)
|
||||
|
||||
// fakeDownloadService is a programmable DownloadService for handler tests. It
|
||||
@@ -35,7 +31,6 @@ type fakeDownloadService struct {
|
||||
deleteErr error
|
||||
patchErr error
|
||||
serveErr error
|
||||
serveBody string
|
||||
directErr error
|
||||
manifest *downloads.OfflineManifest
|
||||
batchManifests []*downloads.OfflineManifest
|
||||
@@ -86,21 +81,6 @@ type identityCall struct {
|
||||
downloadID string
|
||||
}
|
||||
|
||||
type proxyDownloadService struct {
|
||||
*fakeDownloadService
|
||||
directTarget *downloads.FileTarget
|
||||
managedTarget *downloads.FileTarget
|
||||
resolveErr error
|
||||
}
|
||||
|
||||
func (s *proxyDownloadService) ResolveDirectFile(context.Context, int, int, string, catalog.AccessFilter) (*downloads.FileTarget, error) {
|
||||
return s.directTarget, s.resolveErr
|
||||
}
|
||||
|
||||
func (s *proxyDownloadService) ResolveManagedFile(context.Context, int, string, string, string, catalog.AccessFilter) (*downloads.FileTarget, error) {
|
||||
return s.managedTarget, s.resolveErr
|
||||
}
|
||||
|
||||
func (f *fakeDownloadService) Capability(context.Context, int) (downloads.Capability, error) {
|
||||
return f.capability, nil
|
||||
}
|
||||
@@ -186,9 +166,6 @@ func (f *fakeDownloadService) ServeDirect(_ context.Context, w http.ResponseWrit
|
||||
|
||||
func (f *fakeDownloadService) ServeFile(_ context.Context, w http.ResponseWriter, _ *http.Request, userID int, profileID, deviceID, downloadID string, _ catalog.AccessFilter) error {
|
||||
f.gotServe = identityCall{userID, profileID, deviceID, downloadID}
|
||||
if f.serveBody != "" {
|
||||
_, _ = w.Write([]byte(f.serveBody))
|
||||
}
|
||||
if f.serveErr != nil {
|
||||
return f.serveErr
|
||||
}
|
||||
@@ -306,25 +283,6 @@ func TestHandleCapability(t *testing.T) {
|
||||
if len(resp.QualityPresets) != 1 || resp.QualityPresets[0] != downloads.QualityOriginal {
|
||||
t.Fatalf("quality presets = %v, want [original]", resp.QualityPresets)
|
||||
}
|
||||
if resp.ProxyDelivery {
|
||||
t.Fatal("proxy delivery advertised without a configured planner")
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleCapabilityAdvertisesAdditiveProxyDelivery(t *testing.T) {
|
||||
svc := &proxyDownloadService{fakeDownloadService: &fakeDownloadService{}}
|
||||
h := NewDownloadHandler(svc)
|
||||
h.SetProxyDelivery(nodepool.NewPlanner(nodepool.NewProxyPool(), nodepool.NewTranscodePool()), func() string { return "secret" })
|
||||
rec := httptest.NewRecorder()
|
||||
h.HandleCapability(rec, downloadTestRequest(http.MethodGet, "/downloads/capability", nil, 7, "", ""))
|
||||
|
||||
var resp downloadCapabilityResponse
|
||||
if err := json.Unmarshal(rec.Body.Bytes(), &resp); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if !resp.ProxyDelivery {
|
||||
t.Fatalf("capability = %+v", resp)
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleCapabilityUnauthorized(t *testing.T) {
|
||||
@@ -471,139 +429,6 @@ func TestManagedFileThreadsIdentity(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestManagedFileDoesNotAppendJSONAfterRelayResponseCommitted(t *testing.T) {
|
||||
svc := &fakeDownloadService{
|
||||
serveBody: "partial",
|
||||
serveErr: fmt.Errorf("remote relay failed: %w", downloads.ErrResponseCommitted),
|
||||
}
|
||||
h := NewDownloadHandler(svc)
|
||||
req := withChiID(downloadTestRequest(http.MethodGet, "/downloads/dl1/file", nil, 7, "pA", "devA"), "dl1")
|
||||
rec := httptest.NewRecorder()
|
||||
h.HandleDownloadFile(rec, req)
|
||||
|
||||
if rec.Code != http.StatusOK || rec.Body.String() != "partial" {
|
||||
t.Fatalf("response status=%d body=%q", rec.Code, rec.Body.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestManagedFileRedirectsAuthorizedArtifactToProxy(t *testing.T) {
|
||||
const secret = "download-proxy-secret"
|
||||
proxy := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.Method != http.MethodHead {
|
||||
t.Errorf("preflight method = %s", r.Method)
|
||||
}
|
||||
w.WriteHeader(http.StatusOK)
|
||||
}))
|
||||
defer proxy.Close()
|
||||
svc := &proxyDownloadService{
|
||||
fakeDownloadService: &fakeDownloadService{},
|
||||
managedTarget: &downloads.FileTarget{Path: "/artifacts/movie.mp4", DownloadID: "dl1", MediaFileID: 42, ProxyEligible: true},
|
||||
}
|
||||
proxies := nodepool.NewProxyPool()
|
||||
proxies.SetNodes([]*nodepool.Node{{URL: proxy.URL, Enabled: true, Healthy: true}})
|
||||
h := NewDownloadHandler(svc)
|
||||
h.SetProxyDelivery(nodepool.NewPlanner(proxies, nodepool.NewTranscodePool()), func() string { return secret })
|
||||
req := withChiID(downloadTestRequest(http.MethodGet, "/downloads/dl1/file-proxy", nil, 7, "pA", "devA"), "dl1")
|
||||
rec := httptest.NewRecorder()
|
||||
h.HandleDownloadFileViaProxy(rec, req)
|
||||
|
||||
if rec.Code != http.StatusTemporaryRedirect {
|
||||
t.Fatalf("status = %d, want 307 (body: %s)", rec.Code, rec.Body.String())
|
||||
}
|
||||
location := rec.Header().Get("Location")
|
||||
prefix := proxy.URL + "/downloads/file/"
|
||||
if !strings.HasPrefix(location, prefix) {
|
||||
t.Fatalf("Location = %q", location)
|
||||
}
|
||||
claims, err := streamtoken.Verify(strings.TrimPrefix(location, prefix), secret)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if claims.PlayMethod != streamtoken.PlayMethodDownload || claims.MediaPath != "/artifacts/movie.mp4" || claims.UserID != 7 || claims.ProfileID != "pA" {
|
||||
t.Fatalf("claims = %+v", claims)
|
||||
}
|
||||
if svc.gotServe != (identityCall{}) {
|
||||
t.Fatalf("local ServeFile was called: %+v", svc.gotServe)
|
||||
}
|
||||
}
|
||||
|
||||
func TestManagedFileRedirectsNodeLocalArtifactThroughSameGroupProxy(t *testing.T) {
|
||||
const secret = "download-proxy-secret"
|
||||
proxyA := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||
t.Error("wrong-group proxy was selected")
|
||||
w.WriteHeader(http.StatusOK)
|
||||
}))
|
||||
defer proxyA.Close()
|
||||
proxyB := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.Method != http.MethodHead {
|
||||
t.Errorf("preflight method = %s", r.Method)
|
||||
}
|
||||
w.WriteHeader(http.StatusOK)
|
||||
}))
|
||||
defer proxyB.Close()
|
||||
svc := &proxyDownloadService{
|
||||
fakeDownloadService: &fakeDownloadService{},
|
||||
managedTarget: &downloads.FileTarget{
|
||||
DownloadID: "dl-remote",
|
||||
ArtifactID: "artifact-row",
|
||||
Path: "/prepared/Movie Final.mp4",
|
||||
MediaFileID: 42,
|
||||
OriginNodeURL: "http://transcode-b.internal:8096",
|
||||
OriginNodeGroup: "host-b",
|
||||
OriginArtifactID: "artifact-remote",
|
||||
ProxyEligible: true,
|
||||
},
|
||||
}
|
||||
groupA, groupB := "host-a", "host-b"
|
||||
proxies := nodepool.NewProxyPool()
|
||||
proxies.SetNodes([]*nodepool.Node{
|
||||
{URL: proxyA.URL, Group: &groupA, Enabled: true, Healthy: true},
|
||||
{URL: proxyB.URL, Group: &groupB, Enabled: true, Healthy: true},
|
||||
})
|
||||
h := NewDownloadHandler(svc)
|
||||
h.SetProxyDelivery(nodepool.NewPlanner(proxies, nodepool.NewTranscodePool()), func() string { return secret })
|
||||
req := withChiID(downloadTestRequest(http.MethodGet, "/downloads/dl-remote/file-proxy", nil, 7, "pA", "devA"), "dl-remote")
|
||||
rec := httptest.NewRecorder()
|
||||
h.HandleDownloadFileViaProxy(rec, req)
|
||||
if rec.Code != http.StatusTemporaryRedirect {
|
||||
t.Fatalf("status = %d body=%s", rec.Code, rec.Body.String())
|
||||
}
|
||||
location := rec.Header().Get("Location")
|
||||
prefix := proxyB.URL + "/downloads/file/"
|
||||
if !strings.HasPrefix(location, prefix) {
|
||||
t.Fatalf("Location = %q, want proxy-b", location)
|
||||
}
|
||||
claims, err := streamtoken.Verify(strings.TrimPrefix(location, prefix), secret)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if claims.MediaPath != "" || claims.DownloadFilename != "Movie Final.mp4" || claims.TranscodeNode != "http://transcode-b.internal:8096" ||
|
||||
claims.DownloadArtifactID != "artifact-remote" || claims.DownloadArtifactRowID != "artifact-row" {
|
||||
t.Fatalf("claims = %+v", claims)
|
||||
}
|
||||
}
|
||||
|
||||
func TestManagedFileFallsBackWhenRemoteLocatorHasNoOriginURL(t *testing.T) {
|
||||
svc := &proxyDownloadService{
|
||||
fakeDownloadService: &fakeDownloadService{},
|
||||
managedTarget: &downloads.FileTarget{
|
||||
DownloadID: "dl-incomplete",
|
||||
OriginArtifactID: "artifact-without-origin",
|
||||
ProxyEligible: true,
|
||||
},
|
||||
}
|
||||
proxies := nodepool.NewProxyPool()
|
||||
proxies.SetNodes([]*nodepool.Node{{URL: "http://proxy.invalid", Enabled: true, Healthy: true}})
|
||||
h := NewDownloadHandler(svc)
|
||||
h.SetProxyDelivery(nodepool.NewPlanner(proxies, nodepool.NewTranscodePool()), func() string { return "secret" })
|
||||
req := withChiID(downloadTestRequest(http.MethodGet, "/downloads/dl-incomplete/file-proxy", nil, 7, "pA", "devA"), "dl-incomplete")
|
||||
rec := httptest.NewRecorder()
|
||||
h.HandleDownloadFileViaProxy(rec, req)
|
||||
if rec.Code != http.StatusOK || rec.Body.String() != "served" {
|
||||
t.Fatalf("status=%d body=%q", rec.Code, rec.Body.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestManagedListThreadsIdentity(t *testing.T) {
|
||||
svc := &fakeDownloadService{}
|
||||
h := NewDownloadHandler(svc)
|
||||
@@ -689,161 +514,6 @@ func TestHandleDirectDownloadThreadsOriginalFormat(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleDirectDownloadViaProxyRedirectsToProxy(t *testing.T) {
|
||||
const secret = "download-proxy-secret"
|
||||
maxJobs := 1
|
||||
proxy := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||
w.WriteHeader(http.StatusOK)
|
||||
}))
|
||||
defer proxy.Close()
|
||||
svc := &proxyDownloadService{
|
||||
fakeDownloadService: &fakeDownloadService{},
|
||||
directTarget: &downloads.FileTarget{Path: "/media/movie.mkv", MediaFileID: 42, ProxyEligible: true},
|
||||
}
|
||||
proxies := nodepool.NewProxyPool()
|
||||
proxies.SetNodes([]*nodepool.Node{{URL: proxy.URL + "/", Enabled: true, Healthy: true, MaxJobs: &maxJobs}})
|
||||
planner := nodepool.NewPlanner(proxies, nodepool.NewTranscodePool())
|
||||
h := NewDownloadHandler(svc)
|
||||
h.SetProxyDelivery(planner, func() string { return secret })
|
||||
rec := httptest.NewRecorder()
|
||||
h.HandleDirectDownloadViaProxy(rec, downloadTestRequest(http.MethodHead, "/direct-download-proxy?file_id=42", nil, 7, "", ""))
|
||||
|
||||
if rec.Code != http.StatusTemporaryRedirect {
|
||||
t.Fatalf("status = %d, want 307 (body: %s)", rec.Code, rec.Body.String())
|
||||
}
|
||||
location := rec.Header().Get("Location")
|
||||
claims, err := streamtoken.Verify(strings.TrimPrefix(location, proxy.URL+"/downloads/file/"), secret)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if claims.MediaPath != "/media/movie.mkv" || claims.MediaFileID != 42 {
|
||||
t.Fatalf("claims = %+v", claims)
|
||||
}
|
||||
if svc.gotDirectFileID != 0 {
|
||||
t.Fatalf("local ServeDirect called for file %d", svc.gotDirectFileID)
|
||||
}
|
||||
// HEAD never becomes an active proxy transfer, so it must return the only
|
||||
// available slot immediately rather than waiting for reservation expiry.
|
||||
if plan := planner.PlanDownload("after-head"); plan.ProxyNode == nil {
|
||||
t.Fatal("HEAD request retained the proxy's only job slot")
|
||||
}
|
||||
planner.ReleaseSession("after-head")
|
||||
}
|
||||
|
||||
func TestHandleDirectDownloadFallsBackWithoutHealthyProxy(t *testing.T) {
|
||||
svc := &proxyDownloadService{
|
||||
fakeDownloadService: &fakeDownloadService{},
|
||||
directTarget: &downloads.FileTarget{Path: "/media/movie.mkv", MediaFileID: 42, ProxyEligible: true},
|
||||
}
|
||||
proxies := nodepool.NewProxyPool()
|
||||
proxies.SetNodes([]*nodepool.Node{{URL: "https://proxy.example", Enabled: true, Healthy: false}})
|
||||
h := NewDownloadHandler(svc)
|
||||
h.SetProxyDelivery(nodepool.NewPlanner(proxies, nodepool.NewTranscodePool()), func() string { return "secret" })
|
||||
rec := httptest.NewRecorder()
|
||||
h.HandleDirectDownloadViaProxy(rec, downloadTestRequest(http.MethodGet, "/direct-download-proxy?file_id=42", nil, 7, "", ""))
|
||||
|
||||
if rec.Code != http.StatusOK || svc.gotDirectFileID != 42 {
|
||||
t.Fatalf("status = %d file = %d body = %s", rec.Code, svc.gotDirectFileID, rec.Body.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleDirectDownloadFallsBackWhenProxyCannotServePath(t *testing.T) {
|
||||
proxy := httptest.NewServer(http.NotFoundHandler())
|
||||
defer proxy.Close()
|
||||
svc := &proxyDownloadService{
|
||||
fakeDownloadService: &fakeDownloadService{},
|
||||
directTarget: &downloads.FileTarget{Path: "/media/movie.mkv", MediaFileID: 42, ProxyEligible: true},
|
||||
}
|
||||
proxies := nodepool.NewProxyPool()
|
||||
proxies.SetNodes([]*nodepool.Node{{URL: proxy.URL, Enabled: true, Healthy: true}})
|
||||
h := NewDownloadHandler(svc)
|
||||
h.SetProxyDelivery(nodepool.NewPlanner(proxies, nodepool.NewTranscodePool()), func() string { return "secret" })
|
||||
rec := httptest.NewRecorder()
|
||||
h.HandleDirectDownloadViaProxy(rec, downloadTestRequest(http.MethodGet, "/direct-download-proxy?file_id=42", nil, 7, "", ""))
|
||||
|
||||
if rec.Code != http.StatusOK || svc.gotDirectFileID != 42 {
|
||||
t.Fatalf("status = %d file = %d body = %s", rec.Code, svc.gotDirectFileID, rec.Body.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleDirectDownloadEstablishedRouteKeepsLocalSuccessStatus(t *testing.T) {
|
||||
proxyRequests := 0
|
||||
proxy := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||
proxyRequests++
|
||||
w.WriteHeader(http.StatusOK)
|
||||
}))
|
||||
defer proxy.Close()
|
||||
svc := &proxyDownloadService{
|
||||
fakeDownloadService: &fakeDownloadService{},
|
||||
directTarget: &downloads.FileTarget{Path: "/media/movie.mkv", MediaFileID: 42, ProxyEligible: true},
|
||||
}
|
||||
proxies := nodepool.NewProxyPool()
|
||||
proxies.SetNodes([]*nodepool.Node{{URL: proxy.URL, Enabled: true, Healthy: true}})
|
||||
h := NewDownloadHandler(svc)
|
||||
h.SetProxyDelivery(nodepool.NewPlanner(proxies, nodepool.NewTranscodePool()), func() string { return "secret" })
|
||||
rec := httptest.NewRecorder()
|
||||
h.HandleDirectDownload(rec, downloadTestRequest(http.MethodGet, "/direct-download?file_id=42", nil, 7, "", ""))
|
||||
|
||||
if rec.Code != http.StatusOK || svc.gotDirectFileID != 42 || proxyRequests != 0 {
|
||||
t.Fatalf("status = %d file = %d proxy requests = %d", rec.Code, svc.gotDirectFileID, proxyRequests)
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleDirectDownloadViaProxyStaysLocalWhenTargetIneligible(t *testing.T) {
|
||||
proxyRequests := 0
|
||||
proxy := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||
proxyRequests++
|
||||
w.WriteHeader(http.StatusOK)
|
||||
}))
|
||||
defer proxy.Close()
|
||||
svc := &proxyDownloadService{
|
||||
fakeDownloadService: &fakeDownloadService{},
|
||||
directTarget: &downloads.FileTarget{Path: "/media/movie.mkv", MediaFileID: 42, ProxyEligible: false},
|
||||
}
|
||||
proxies := nodepool.NewProxyPool()
|
||||
proxies.SetNodes([]*nodepool.Node{{URL: proxy.URL, Enabled: true, Healthy: true}})
|
||||
h := NewDownloadHandler(svc)
|
||||
h.SetProxyDelivery(nodepool.NewPlanner(proxies, nodepool.NewTranscodePool()), func() string { return "secret" })
|
||||
rec := httptest.NewRecorder()
|
||||
h.HandleDirectDownloadViaProxy(rec, downloadTestRequest(http.MethodGet, "/direct-download-proxy?file_id=42", nil, 7, "", ""))
|
||||
|
||||
if rec.Code != http.StatusOK || svc.gotDirectFileID != 42 || proxyRequests != 0 {
|
||||
t.Fatalf("status = %d file = %d proxy requests = %d", rec.Code, svc.gotDirectFileID, proxyRequests)
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleDirectDownloadViaProxyMapsResolverError(t *testing.T) {
|
||||
svc := &proxyDownloadService{fakeDownloadService: &fakeDownloadService{}, resolveErr: catalog.ErrItemNotFound}
|
||||
h := NewDownloadHandler(svc)
|
||||
h.SetProxyDelivery(nodepool.NewPlanner(nodepool.NewProxyPool(), nodepool.NewTranscodePool()), func() string { return "secret" })
|
||||
rec := httptest.NewRecorder()
|
||||
h.HandleDirectDownloadViaProxy(rec, downloadTestRequest(http.MethodGet, "/direct-download-proxy?file_id=42", nil, 7, "", ""))
|
||||
|
||||
if rec.Code != http.StatusNotFound {
|
||||
t.Fatalf("status = %d, body = %s", rec.Code, rec.Body.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestProxyPreflightCachesReachabilityByNodeAndPath(t *testing.T) {
|
||||
requests := 0
|
||||
proxy := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||
requests++
|
||||
w.WriteHeader(http.StatusOK)
|
||||
}))
|
||||
defer proxy.Close()
|
||||
h := NewDownloadHandler(&fakeDownloadService{})
|
||||
location := proxy.URL + "/downloads/file/token"
|
||||
if !h.proxyCanServe(context.Background(), proxy.URL+"\x00/media/movie.mkv", location) {
|
||||
t.Fatal("first preflight failed")
|
||||
}
|
||||
if !h.proxyCanServe(context.Background(), proxy.URL+"\x00/media/movie.mkv", location) {
|
||||
t.Fatal("cached preflight failed")
|
||||
}
|
||||
if requests != 1 {
|
||||
t.Fatalf("preflight requests = %d, want 1", requests)
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleDirectDownloadMissingFileID(t *testing.T) {
|
||||
h := NewDownloadHandler(&fakeDownloadService{})
|
||||
rec := httptest.NewRecorder()
|
||||
|
||||
@@ -2115,7 +2115,6 @@ func filterSortClause(sort, order string) string {
|
||||
}
|
||||
|
||||
func (h *ItemsHandler) accessFilter(r *http.Request) catalog.AccessFilter {
|
||||
deviceID := deviceMetadataFromRequest(r).DeviceID
|
||||
selectedFileID := 0
|
||||
if fileIDRaw := strings.TrimSpace(r.URL.Query().Get("fileId")); fileIDRaw != "" {
|
||||
if fileID, err := strconv.Atoi(fileIDRaw); err == nil && fileID > 0 {
|
||||
@@ -2142,7 +2141,6 @@ func (h *ItemsHandler) accessFilter(r *http.Request) catalog.AccessFilter {
|
||||
SelectedFileID: selectedFileID,
|
||||
UserID: apimw.GetUserID(r.Context()),
|
||||
ProfileID: apimw.GetProfileID(r.Context()),
|
||||
DeviceID: deviceID,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2170,7 +2168,6 @@ func (h *ItemsHandler) accessFilter(r *http.Request) catalog.AccessFilter {
|
||||
SelectedFileID: selectedFileID,
|
||||
UserID: apimw.GetUserID(r.Context()),
|
||||
ProfileID: apimw.GetProfileID(r.Context()),
|
||||
DeviceID: deviceID,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2264,42 +2261,17 @@ func (h *ItemsHandler) resolveWatchedTargets(ctx context.Context, contentID stri
|
||||
}}, nil
|
||||
}
|
||||
|
||||
// episodeTargets resolves the watched leaf targets for a season or series.
|
||||
// Durations come from one batched file lookup rather than a query per episode:
|
||||
// marking a long series used to issue one GetByEpisodeID per episode before it
|
||||
// wrote anything.
|
||||
func (h *ItemsHandler) episodeTargets(ctx context.Context, episodes []*models.Episode) []watchedLeafTarget {
|
||||
episodeIDs := make([]string, 0, len(episodes))
|
||||
for _, episode := range episodes {
|
||||
episodeIDs = append(episodeIDs, episode.ContentID)
|
||||
}
|
||||
filesByEpisode := h.listEpisodeFiles(ctx, episodeIDs)
|
||||
|
||||
targets := make([]watchedLeafTarget, 0, len(episodes))
|
||||
for _, episode := range episodes {
|
||||
targets = append(targets, watchedLeafTarget{
|
||||
ContentID: episode.ContentID,
|
||||
DurationSeconds: mediaFileDurationSeconds(filesByEpisode[episode.ContentID], episode.Runtime),
|
||||
DurationSeconds: h.contentDurationSeconds(ctx, "", episode.ContentID, episode.Runtime),
|
||||
})
|
||||
}
|
||||
return targets
|
||||
}
|
||||
|
||||
// mediaFileDurationSeconds picks a playable duration from an item's files,
|
||||
// falling back to the catalog runtime. Mirrors contentDurationSeconds's
|
||||
// preference order so the batched and single-item paths agree.
|
||||
func mediaFileDurationSeconds(files []*models.MediaFile, fallbackRuntimeMinutes int) float64 {
|
||||
for _, file := range files {
|
||||
if file != nil && file.Duration > 0 {
|
||||
return float64(file.Duration)
|
||||
}
|
||||
}
|
||||
if fallbackRuntimeMinutes > 0 {
|
||||
return float64(fallbackRuntimeMinutes * 60)
|
||||
}
|
||||
return 0
|
||||
}
|
||||
|
||||
func (h *ItemsHandler) contentDurationSeconds(ctx context.Context, contentID, episodeID string, fallbackRuntimeMinutes int) float64 {
|
||||
if h.fileRepo == nil {
|
||||
if fallbackRuntimeMinutes > 0 {
|
||||
@@ -2319,10 +2291,18 @@ func (h *ItemsHandler) contentDurationSeconds(ctx context.Context, contentID, ep
|
||||
case contentID != "":
|
||||
files, err = h.fileRepo.GetByContentID(ctx, contentID)
|
||||
}
|
||||
if err != nil {
|
||||
files = nil
|
||||
if err == nil {
|
||||
for _, file := range files {
|
||||
if file != nil && file.Duration > 0 {
|
||||
return float64(file.Duration)
|
||||
}
|
||||
}
|
||||
}
|
||||
return mediaFileDurationSeconds(files, fallbackRuntimeMinutes)
|
||||
|
||||
if fallbackRuntimeMinutes > 0 {
|
||||
return float64(fallbackRuntimeMinutes * 60)
|
||||
}
|
||||
return 0
|
||||
}
|
||||
|
||||
// isNotFound checks if an error is a "not found" sentinel.
|
||||
|
||||
@@ -33,28 +33,26 @@ import (
|
||||
"github.com/Silo-Server/silo-server/internal/s3client"
|
||||
"github.com/Silo-Server/silo-server/internal/sections"
|
||||
"github.com/Silo-Server/silo-server/internal/usercollections"
|
||||
"github.com/Silo-Server/silo-server/internal/userstore"
|
||||
)
|
||||
|
||||
type LibraryCollectionHandler struct {
|
||||
repo *catalog.LibraryCollectionRepository
|
||||
service *catalog.LibraryCollectionService
|
||||
itemRepo *catalog.ItemRepository
|
||||
Executor *catalog.QueryExecutor
|
||||
detailSvc *catalog.DetailService
|
||||
presignTTL time.Duration
|
||||
httpClient *http.Client
|
||||
s3GP *s3client.Client
|
||||
FrontendFS fs.FS
|
||||
SectionRepo *sections.Repository
|
||||
UserCollectionPool *pgxpool.Pool
|
||||
GroupRepo *catalog.LibraryCollectionGroupRepository
|
||||
FolderRepo *catalog.FolderRepository
|
||||
TemplateRegistry *templates.Registry
|
||||
SmartCountRefresher *catalog.SmartCountRefresher
|
||||
JobRepo *adminjob.Repository
|
||||
EventsHub *evt.Hub
|
||||
SortPreferenceCleaner *userstore.CollectionSortPreferenceCleaner
|
||||
repo *catalog.LibraryCollectionRepository
|
||||
service *catalog.LibraryCollectionService
|
||||
itemRepo *catalog.ItemRepository
|
||||
Executor *catalog.QueryExecutor
|
||||
detailSvc *catalog.DetailService
|
||||
presignTTL time.Duration
|
||||
httpClient *http.Client
|
||||
s3GP *s3client.Client
|
||||
FrontendFS fs.FS
|
||||
SectionRepo *sections.Repository
|
||||
UserCollectionPool *pgxpool.Pool
|
||||
GroupRepo *catalog.LibraryCollectionGroupRepository
|
||||
FolderRepo *catalog.FolderRepository
|
||||
TemplateRegistry *templates.Registry
|
||||
SmartCountRefresher *catalog.SmartCountRefresher
|
||||
JobRepo *adminjob.Repository
|
||||
EventsHub *evt.Hub
|
||||
}
|
||||
|
||||
var errLibraryCollectionInUse = errors.New("collection is used by one or more sections")
|
||||
@@ -379,22 +377,21 @@ type updateLibraryCollectionRequest struct {
|
||||
}
|
||||
|
||||
type importMDBListRequest struct {
|
||||
SortConfig json.RawMessage `json:"sort_config,omitempty"`
|
||||
LibraryID int `json:"library_id"`
|
||||
LibraryIDs []int `json:"library_ids"`
|
||||
Title string `json:"title"`
|
||||
Description string `json:"description"`
|
||||
URL string `json:"url"`
|
||||
Limit *int `json:"limit,omitempty"`
|
||||
Featured bool `json:"featured"`
|
||||
SortOrder int `json:"sort_order,omitempty"`
|
||||
PosterURL string `json:"poster_url"`
|
||||
PosterSourceURL string `json:"poster_source_url"`
|
||||
BackdropSourceURL string `json:"backdrop_source_url"`
|
||||
SyncSchedule string `json:"sync_schedule"`
|
||||
ManagementMode string `json:"management_mode,omitempty"`
|
||||
ManagementSource string `json:"management_source,omitempty"`
|
||||
ManagementKey string `json:"management_key,omitempty"`
|
||||
LibraryID int `json:"library_id"`
|
||||
LibraryIDs []int `json:"library_ids"`
|
||||
Title string `json:"title"`
|
||||
Description string `json:"description"`
|
||||
URL string `json:"url"`
|
||||
Limit *int `json:"limit,omitempty"`
|
||||
Featured bool `json:"featured"`
|
||||
SortOrder int `json:"sort_order,omitempty"`
|
||||
PosterURL string `json:"poster_url"`
|
||||
PosterSourceURL string `json:"poster_source_url"`
|
||||
BackdropSourceURL string `json:"backdrop_source_url"`
|
||||
SyncSchedule string `json:"sync_schedule"`
|
||||
ManagementMode string `json:"management_mode,omitempty"`
|
||||
ManagementSource string `json:"management_source,omitempty"`
|
||||
ManagementKey string `json:"management_key,omitempty"`
|
||||
// PosterFromTemplate marks the poster as supplied by a template bundle so
|
||||
// future template applies can refresh it. Set programmatically by
|
||||
// createCollectionFromTemplate; not user-settable via JSON.
|
||||
@@ -402,25 +399,24 @@ type importMDBListRequest struct {
|
||||
}
|
||||
|
||||
type importTMDBRequest struct {
|
||||
SortConfig json.RawMessage `json:"sort_config,omitempty"`
|
||||
LibraryID int `json:"library_id"`
|
||||
LibraryIDs []int `json:"library_ids"`
|
||||
Title string `json:"title"`
|
||||
Description string `json:"description"`
|
||||
Preset string `json:"preset"`
|
||||
TimeWindow string `json:"time_window"`
|
||||
MediaType string `json:"media_type"`
|
||||
Limit *int `json:"limit,omitempty"`
|
||||
Featured bool `json:"featured"`
|
||||
SortOrder int `json:"sort_order,omitempty"`
|
||||
PosterURL string `json:"poster_url"`
|
||||
PosterSourceURL string `json:"poster_source_url"`
|
||||
BackdropSourceURL string `json:"backdrop_source_url"`
|
||||
SyncSchedule string `json:"sync_schedule"`
|
||||
ManagementMode string `json:"management_mode,omitempty"`
|
||||
ManagementSource string `json:"management_source,omitempty"`
|
||||
ManagementKey string `json:"management_key,omitempty"`
|
||||
PosterFromTemplate bool `json:"-"`
|
||||
LibraryID int `json:"library_id"`
|
||||
LibraryIDs []int `json:"library_ids"`
|
||||
Title string `json:"title"`
|
||||
Description string `json:"description"`
|
||||
Preset string `json:"preset"`
|
||||
TimeWindow string `json:"time_window"`
|
||||
MediaType string `json:"media_type"`
|
||||
Limit *int `json:"limit,omitempty"`
|
||||
Featured bool `json:"featured"`
|
||||
SortOrder int `json:"sort_order,omitempty"`
|
||||
PosterURL string `json:"poster_url"`
|
||||
PosterSourceURL string `json:"poster_source_url"`
|
||||
BackdropSourceURL string `json:"backdrop_source_url"`
|
||||
SyncSchedule string `json:"sync_schedule"`
|
||||
ManagementMode string `json:"management_mode,omitempty"`
|
||||
ManagementSource string `json:"management_source,omitempty"`
|
||||
ManagementKey string `json:"management_key,omitempty"`
|
||||
PosterFromTemplate bool `json:"-"`
|
||||
}
|
||||
|
||||
// importTMDBFranchiseRequest is the request body for creating a collection
|
||||
@@ -491,14 +487,13 @@ type importTMDBDiscoverSpecBody struct {
|
||||
}
|
||||
|
||||
type importTraktRequest struct {
|
||||
SortConfig json.RawMessage `json:"sort_config,omitempty"`
|
||||
LibraryID int `json:"library_id"`
|
||||
LibraryIDs []int `json:"library_ids"`
|
||||
Title string `json:"title"`
|
||||
Description string `json:"description"`
|
||||
Preset string `json:"preset"`
|
||||
MediaType string `json:"media_type"`
|
||||
ProfileID string `json:"profile_id,omitempty"`
|
||||
LibraryID int `json:"library_id"`
|
||||
LibraryIDs []int `json:"library_ids"`
|
||||
Title string `json:"title"`
|
||||
Description string `json:"description"`
|
||||
Preset string `json:"preset"`
|
||||
MediaType string `json:"media_type"`
|
||||
ProfileID string `json:"profile_id,omitempty"`
|
||||
// ListURL selects a user-authored Trakt list
|
||||
// (https://trakt.tv/users/{user}/lists/{slug}) instead of a preset.
|
||||
ListURL string `json:"list_url,omitempty"`
|
||||
@@ -1142,14 +1137,6 @@ func (h *LibraryCollectionHandler) HandleCreateAdminCollection(w http.ResponseWr
|
||||
}
|
||||
}
|
||||
|
||||
// Library collections resolve with user scope stripped, so per-profile sort
|
||||
// fields are rejected here rather than failing at browse time.
|
||||
sortConfig, err := NormalizeCollectionSortConfig(req.SortConfig, false)
|
||||
if err != nil {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
var syncSchedule *string
|
||||
if s := strings.TrimSpace(req.SyncSchedule); s != "" {
|
||||
if err := catalog.ParseCronExpression(s); err != nil {
|
||||
@@ -1179,7 +1166,7 @@ func (h *LibraryCollectionHandler) HandleCreateAdminCollection(w http.ResponseWr
|
||||
BackdropURL: req.BackdropURL,
|
||||
SourceURL: req.SourceURL,
|
||||
QueryDefinition: queryDefinition,
|
||||
SortConfig: json.RawMessage(sortConfig),
|
||||
SortConfig: defaultJSON(req.SortConfig),
|
||||
SourceConfig: defaultCollectionSourceConfig(req.SourceConfig),
|
||||
ManagementMode: managementMode,
|
||||
ManagementSource: managementSource,
|
||||
@@ -1238,16 +1225,6 @@ func (h *LibraryCollectionHandler) HandleUpdateAdminCollection(w http.ResponseWr
|
||||
}
|
||||
}
|
||||
|
||||
sortConfig := req.SortConfig
|
||||
if len(req.SortConfig) > 0 {
|
||||
normalized, err := NormalizeCollectionSortConfig(req.SortConfig, false)
|
||||
if err != nil {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", err.Error())
|
||||
return
|
||||
}
|
||||
sortConfig = json.RawMessage(normalized)
|
||||
}
|
||||
|
||||
// Validate sync_schedule if provided.
|
||||
if req.SyncSchedule != nil && *req.SyncSchedule != "" {
|
||||
if err := catalog.ParseCronExpression(*req.SyncSchedule); err != nil {
|
||||
@@ -1280,7 +1257,7 @@ func (h *LibraryCollectionHandler) HandleUpdateAdminCollection(w http.ResponseWr
|
||||
BackdropURL: req.BackdropURL,
|
||||
SourceURL: req.SourceURL,
|
||||
QueryDefinition: queryDefinition,
|
||||
SortConfig: sortConfig,
|
||||
SortConfig: req.SortConfig,
|
||||
SourceConfig: req.SourceConfig,
|
||||
ManagementMode: normalizeOptionalCollectionManagementMode(req.ManagementMode),
|
||||
ManagementSource: req.ManagementSource,
|
||||
@@ -1454,13 +1431,7 @@ func (h *LibraryCollectionHandler) deleteServerCollection(ctx context.Context, c
|
||||
}
|
||||
}
|
||||
|
||||
if err := h.repo.Delete(ctx, collectionID); err != nil {
|
||||
return err
|
||||
}
|
||||
if h.SortPreferenceCleaner != nil {
|
||||
h.SortPreferenceCleaner.DeleteForCollection(ctx, userstore.CollectionKindLibrary, collectionID)
|
||||
}
|
||||
return nil
|
||||
return h.repo.Delete(ctx, collectionID)
|
||||
}
|
||||
|
||||
type adminReorderCollectionsRequest struct {
|
||||
@@ -2665,10 +2636,6 @@ func (h *LibraryCollectionHandler) createMDBListCollection(
|
||||
if err != nil {
|
||||
return nil, requestValidationError{err: err}
|
||||
}
|
||||
sortConfig, err := NormalizeCollectionSortConfig(req.SortConfig, false)
|
||||
if err != nil {
|
||||
return nil, requestValidationError{err: err}
|
||||
}
|
||||
collection, err := h.repo.Create(ctx, catalog.CreateLibraryCollectionInput{
|
||||
LibraryID: req.LibraryID,
|
||||
LibraryIDs: req.LibraryIDs,
|
||||
@@ -2676,7 +2643,6 @@ func (h *LibraryCollectionHandler) createMDBListCollection(
|
||||
Title: req.Title,
|
||||
Description: req.Description,
|
||||
CollectionType: "mdblist",
|
||||
SortConfig: json.RawMessage(sortConfig),
|
||||
Visibility: "visible",
|
||||
Featured: req.Featured,
|
||||
SortOrder: req.SortOrder,
|
||||
@@ -2730,10 +2696,6 @@ func (h *LibraryCollectionHandler) createTMDBCollection(
|
||||
if err != nil {
|
||||
return nil, requestValidationError{err: err}
|
||||
}
|
||||
tmdbSortConfig, err := NormalizeCollectionSortConfig(req.SortConfig, false)
|
||||
if err != nil {
|
||||
return nil, requestValidationError{err: err}
|
||||
}
|
||||
collection, err := h.repo.Create(ctx, catalog.CreateLibraryCollectionInput{
|
||||
LibraryID: req.LibraryID,
|
||||
LibraryIDs: req.LibraryIDs,
|
||||
@@ -2741,7 +2703,6 @@ func (h *LibraryCollectionHandler) createTMDBCollection(
|
||||
Title: req.Title,
|
||||
Description: req.Description,
|
||||
CollectionType: "tmdb",
|
||||
SortConfig: json.RawMessage(tmdbSortConfig),
|
||||
Visibility: "visible",
|
||||
Featured: req.Featured,
|
||||
SortOrder: req.SortOrder,
|
||||
@@ -3087,12 +3048,6 @@ func (h *LibraryCollectionHandler) HandleImportTraktCollection(w http.ResponseWr
|
||||
return
|
||||
}
|
||||
|
||||
traktSortConfig, err := NormalizeCollectionSortConfig(req.SortConfig, false)
|
||||
if err != nil {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
collection, err := h.repo.Create(r.Context(), catalog.CreateLibraryCollectionInput{
|
||||
LibraryID: req.LibraryID,
|
||||
LibraryIDs: req.LibraryIDs,
|
||||
@@ -3100,7 +3055,6 @@ func (h *LibraryCollectionHandler) HandleImportTraktCollection(w http.ResponseWr
|
||||
Title: req.Title,
|
||||
Description: req.Description,
|
||||
CollectionType: "trakt",
|
||||
SortConfig: json.RawMessage(traktSortConfig),
|
||||
Visibility: "visible",
|
||||
Featured: req.Featured,
|
||||
PosterURL: req.PosterURL,
|
||||
|
||||
+2328
-72
File diff suppressed because it is too large
Load Diff
@@ -51,22 +51,16 @@ func TestPlaybackSessionMissingResponsesUseStableErrorCode(t *testing.T) {
|
||||
handle: playbackHandler.HandleStopPlayback,
|
||||
},
|
||||
{
|
||||
name: "replan",
|
||||
name: "audio",
|
||||
request: func() *http.Request {
|
||||
return playbackTestRequest(
|
||||
http.MethodPost,
|
||||
"/api/v1/playback/"+missingSessionID+"/replan",
|
||||
// A fully valid replan body: the point of this case is the
|
||||
// missing session, so nothing earlier may reject it.
|
||||
[]byte(`{"protocol_version":3,"playback_attempt_id":"attempt-00000001",`+
|
||||
`"replan_request_id":"replan-00000001","failed_plan_id":"plan:00000000000000",`+
|
||||
`"plan_attempt_id":"plan-attempt-1","plan_attempt_key":"v3:0000000000000001",`+
|
||||
`"attempt_count":1,"failure":{"classification":"decoder_error"},`+
|
||||
`"client_capabilities":{"video_evidence":"exact","audio_evidence":"exact"}}`),
|
||||
http.MethodPatch,
|
||||
"/api/v1/playback/"+missingSessionID+"/audio",
|
||||
[]byte(`{"audio_track_index":1}`),
|
||||
map[string]string{"session_id": missingSessionID},
|
||||
)
|
||||
},
|
||||
handle: playbackHandler.HandleReplanPlaybackV3,
|
||||
handle: playbackHandler.HandleChangeAudioTrack,
|
||||
},
|
||||
{
|
||||
name: "websocket",
|
||||
@@ -104,6 +98,18 @@ func TestPlaybackSessionMissingResponsesUseStableErrorCode(t *testing.T) {
|
||||
},
|
||||
handle: streamHandler.HandleSubtitle,
|
||||
},
|
||||
{
|
||||
name: "transcode start",
|
||||
request: func() *http.Request {
|
||||
return playbackTestRequest(
|
||||
http.MethodPost,
|
||||
"/api/v1/playback/transcode/start",
|
||||
[]byte(`{"session_id":"`+missingSessionID+`","seek_seconds":0,"target_bitrate_kbps":0,"segment_duration":2,"subtitle_track_index":-1,"subtitle_burn_in":false}`),
|
||||
nil,
|
||||
)
|
||||
},
|
||||
handle: playbackHandler.HandleStartTranscode,
|
||||
},
|
||||
{
|
||||
name: "transcode manifest",
|
||||
request: func() *http.Request {
|
||||
|
||||
@@ -48,10 +48,7 @@ type playbackSessionRow struct {
|
||||
ClientIP string `json:"client_ip,omitempty"`
|
||||
ClientName string `json:"client_name,omitempty"`
|
||||
ClientVersion string `json:"client_version,omitempty"`
|
||||
ClientBuild string `json:"client_build,omitempty"`
|
||||
ClientChannel string `json:"client_channel,omitempty"`
|
||||
ClientLabel string `json:"client_label,omitempty"`
|
||||
ClientLabelFull string `json:"client_label_full,omitempty"`
|
||||
ClientUserAgent string `json:"client_user_agent,omitempty"`
|
||||
AudioTrackIndex int `json:"audio_track_index"`
|
||||
TranscodeAudio bool `json:"transcode_audio"`
|
||||
@@ -92,11 +89,6 @@ type playbackSessionsCapabilitiesResponse struct {
|
||||
EffectivePlayMethodValues []string `json:"effective_play_method_values"`
|
||||
// IsJellyfinClient reports that rows carry is_jellyfin_client.
|
||||
IsJellyfinClient bool `json:"is_jellyfin_client"`
|
||||
// ClientBuild reports that rows carry client_build (and the exact-version
|
||||
// client_label_full derived from it).
|
||||
ClientBuild bool `json:"client_build"`
|
||||
// ClientChannel reports that rows carry client_channel.
|
||||
ClientChannel bool `json:"client_channel"`
|
||||
}
|
||||
|
||||
// HandleGetSessionsCapabilities exposes additive feature support for the live
|
||||
@@ -106,8 +98,6 @@ func (h *AdminHandler) HandleGetSessionsCapabilities(w http.ResponseWriter, _ *h
|
||||
EffectivePlayMethod: true,
|
||||
EffectivePlayMethodValues: []string{"direct", "remux", "transcode", "audio"},
|
||||
IsJellyfinClient: true,
|
||||
ClientBuild: true,
|
||||
ClientChannel: true,
|
||||
})
|
||||
}
|
||||
|
||||
@@ -192,8 +182,6 @@ func (l *PlaybackSessionsLoader) Load(
|
||||
COALESCE(HOST(s.client_ip), ''),
|
||||
COALESCE(s.client_name, ''),
|
||||
COALESCE(s.client_version, ''),
|
||||
COALESCE(s.client_build, ''),
|
||||
COALESCE(s.client_channel, ''),
|
||||
COALESCE(s.client_user_agent, ''),
|
||||
COALESCE(s.audio_track_index, 0),
|
||||
COALESCE(s.transcode_audio, FALSE),
|
||||
@@ -251,7 +239,6 @@ func (l *PlaybackSessionsLoader) Load(
|
||||
&posterPath,
|
||||
&s.PlayMethod, &s.ReportingNode, &s.NodeDisplayName, &s.FileDuration, &s.StartedAt, &s.UpdatedAt,
|
||||
&s.PositionSeconds, &s.IsPaused, &s.HasPlaybackControl, &s.ClientIP, &s.ClientName, &s.ClientVersion,
|
||||
&s.ClientBuild, &s.ClientChannel,
|
||||
&s.ClientUserAgent, &s.AudioTrackIndex, &s.TranscodeAudio, &streamBitrateKbps,
|
||||
&s.TranscodeNodeURL, &s.TargetResolution, &s.TargetVideoCodec, &s.TargetAudioCodec, &targetBitrateKbps,
|
||||
&s.TranscodeHWAccel, &s.SourceContainer, &sourceBitrateKbps, &s.SourceVideoCodec, &s.SourceVideoResolution,
|
||||
@@ -266,13 +253,6 @@ func (l *PlaybackSessionsLoader) Load(
|
||||
s.SourceBitrateKbps = sourceBitrateKbps
|
||||
s.SourceAudioChannels = sourceAudioChannels
|
||||
s.ClientLabel = playbackClientDisplayName(s.ClientName, s.ClientVersion, s.ClientUserAgent)
|
||||
// Only worth the bytes when it says more than the compact label — which
|
||||
// it does not for any client without a build or a non-release channel,
|
||||
// i.e. most of a 200-row page. Clients read client_label when
|
||||
// client_label_full is absent, so omitting the duplicate costs nothing.
|
||||
if full := playbackClientFullDisplayName(s.ClientName, s.ClientVersion, s.ClientBuild, s.ClientChannel, s.ClientUserAgent); full != s.ClientLabel {
|
||||
s.ClientLabelFull = full
|
||||
}
|
||||
enrichPlaybackSessionRow(&s, audioTracksJSON)
|
||||
sessions = append(sessions, s)
|
||||
}
|
||||
@@ -467,47 +447,11 @@ func firstNonEmptyValue(values ...string) string {
|
||||
return ""
|
||||
}
|
||||
|
||||
// playbackClientFullDisplayName renders the client's exact identity — version,
|
||||
// opaque build, and non-default channel — for surfaces that can afford the
|
||||
// width (expanded session details, tooltips). The name-and-version half is
|
||||
// whatever the compact label resolved, so a client identified only by its user
|
||||
// agent still gets its build named: a client that bothered to report a build
|
||||
// has earned having it displayed, whether or not it also named itself.
|
||||
func playbackClientFullDisplayName(name, version, build, channel, userAgent string) string {
|
||||
label := playbackClientDisplayName(name, version, userAgent)
|
||||
if label == "" {
|
||||
return ""
|
||||
}
|
||||
|
||||
build = strings.TrimSpace(build)
|
||||
channel = strings.TrimSpace(channel)
|
||||
// "release" is the assumed channel, so naming it adds width without adding
|
||||
// information; every other channel is worth calling out.
|
||||
if strings.EqualFold(channel, "release") {
|
||||
channel = ""
|
||||
}
|
||||
var qualifiers []string
|
||||
if build != "" {
|
||||
qualifiers = append(qualifiers, "build "+build)
|
||||
}
|
||||
if channel != "" {
|
||||
qualifiers = append(qualifiers, channel)
|
||||
}
|
||||
if len(qualifiers) > 0 {
|
||||
label += " (" + strings.Join(qualifiers, ", ") + ")"
|
||||
}
|
||||
return label
|
||||
}
|
||||
|
||||
// playbackClientDisplayName renders the compact label the session lists show.
|
||||
// A client that reports its own name keeps its version verbatim — truncating
|
||||
// "1.0.0" to "1" hid the only field that identifies the running build. Labels
|
||||
// derived from a user agent stay shortened, where a full browser version
|
||||
// ("120.0.6099.109") is noise.
|
||||
func playbackClientDisplayName(name, version, userAgent string) string {
|
||||
name = strings.TrimSpace(name)
|
||||
version = shortPlaybackClientVersion(version)
|
||||
if name != "" {
|
||||
if version = strings.TrimSpace(version); version != "" {
|
||||
if version != "" {
|
||||
return name + " " + version
|
||||
}
|
||||
return name
|
||||
|
||||
@@ -4,12 +4,7 @@ import (
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strings"
|
||||
"testing"
|
||||
"unicode"
|
||||
"unicode/utf8"
|
||||
|
||||
"github.com/Silo-Server/silo-server/internal/playback"
|
||||
)
|
||||
|
||||
func TestSessionComponentDecisionLabelsCopiedAudioDuringHLSAsRemux(t *testing.T) {
|
||||
@@ -70,8 +65,8 @@ func TestSessionsCapabilitiesAdvertisesActivityFields(t *testing.T) {
|
||||
if err := json.Unmarshal(rr.Body.Bytes(), &resp); err != nil {
|
||||
t.Fatalf("decode capabilities: %v", err)
|
||||
}
|
||||
if !resp.EffectivePlayMethod || !resp.IsJellyfinClient || !resp.ClientBuild || !resp.ClientChannel {
|
||||
t.Fatalf("capabilities must advertise every additive field: %+v", resp)
|
||||
if !resp.EffectivePlayMethod || !resp.IsJellyfinClient {
|
||||
t.Fatalf("capabilities must advertise both fields: %+v", resp)
|
||||
}
|
||||
want := []string{"direct", "remux", "transcode", "audio"}
|
||||
if len(resp.EffectivePlayMethodValues) != len(want) {
|
||||
@@ -218,273 +213,6 @@ func TestPlaybackClientDisplayNameAndroidDevices(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestPlaybackClientDisplayNameKeepsNamedClientVersionExact(t *testing.T) {
|
||||
cases := []struct {
|
||||
name string
|
||||
clientName string
|
||||
clientVersion string
|
||||
want string
|
||||
}{
|
||||
{name: "patch version survives", clientName: "Silo Android TV", clientVersion: "1.0.0", want: "Silo Android TV 1.0.0"},
|
||||
{name: "prerelease suffix survives", clientName: "Silo iOS", clientVersion: "2.1.0-rc.3", want: "Silo iOS 2.1.0-rc.3"},
|
||||
{name: "no version", clientName: "Silo Android TV", clientVersion: "", want: "Silo Android TV"},
|
||||
}
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
got := playbackClientDisplayName(tc.clientName, tc.clientVersion, "")
|
||||
if got != tc.want {
|
||||
t.Fatalf("playbackClientDisplayName(%q, %q, \"\") = %q, want %q", tc.clientName, tc.clientVersion, got, tc.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestPlaybackClientFullDisplayName(t *testing.T) {
|
||||
cases := []struct {
|
||||
name string
|
||||
client string
|
||||
version string
|
||||
build string
|
||||
channel string
|
||||
userAgent string
|
||||
want string
|
||||
}{
|
||||
{
|
||||
name: "version build and channel",
|
||||
client: "Silo Android TV",
|
||||
version: "1.0.0",
|
||||
build: "5",
|
||||
channel: "dev",
|
||||
want: "Silo Android TV 1.0.0 (build 5, dev)",
|
||||
},
|
||||
{
|
||||
name: "release channel omitted",
|
||||
client: "Silo Android TV",
|
||||
version: "1.0.0",
|
||||
build: "5",
|
||||
channel: "release",
|
||||
want: "Silo Android TV 1.0.0 (build 5)",
|
||||
},
|
||||
{
|
||||
name: "release channel omitted case insensitively",
|
||||
client: "Silo Android TV",
|
||||
version: "1.0.0",
|
||||
build: "5",
|
||||
channel: "Release",
|
||||
want: "Silo Android TV 1.0.0 (build 5)",
|
||||
},
|
||||
{
|
||||
name: "empty channel omitted",
|
||||
client: "Silo Android TV",
|
||||
version: "1.0.0",
|
||||
build: "5",
|
||||
want: "Silo Android TV 1.0.0 (build 5)",
|
||||
},
|
||||
{
|
||||
name: "channel without build",
|
||||
client: "Silo Android TV",
|
||||
version: "1.0.0",
|
||||
channel: "dev",
|
||||
want: "Silo Android TV 1.0.0 (dev)",
|
||||
},
|
||||
{
|
||||
name: "build and channel empty",
|
||||
client: "Silo Android TV",
|
||||
version: "1.0.0",
|
||||
want: "Silo Android TV 1.0.0",
|
||||
},
|
||||
{
|
||||
name: "version empty",
|
||||
client: "Silo Android TV",
|
||||
want: "Silo Android TV",
|
||||
},
|
||||
{
|
||||
name: "opaque build is not parsed",
|
||||
client: "Silo tvOS",
|
||||
version: "1.0.0",
|
||||
build: "2026.08.13-abcdef",
|
||||
want: "Silo tvOS 1.0.0 (build 2026.08.13-abcdef)",
|
||||
},
|
||||
{
|
||||
// A client that reports a build but not a name is still named by its
|
||||
// build: the user-agent label supplies the product half, and dropping
|
||||
// the qualifiers would hide the exact field this surface exists for.
|
||||
name: "no client name keeps build and channel on the user agent label",
|
||||
userAgent: "Mozilla/5.0 (X11; Linux x86_64) Chrome/120.0.0.0 Safari/537.36",
|
||||
build: "5",
|
||||
channel: "dev",
|
||||
want: "Chrome 120 (build 5, dev)",
|
||||
},
|
||||
{
|
||||
name: "no client name and no qualifiers keeps the plain user agent label",
|
||||
userAgent: "Mozilla/5.0 (X11; Linux x86_64) Chrome/120.0.0.0 Safari/537.36",
|
||||
want: "Chrome 120",
|
||||
},
|
||||
{
|
||||
name: "no client name and no user agent",
|
||||
want: "",
|
||||
},
|
||||
}
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
got := playbackClientFullDisplayName(tc.client, tc.version, tc.build, tc.channel, tc.userAgent)
|
||||
if got != tc.want {
|
||||
t.Fatalf("playbackClientFullDisplayName() = %q, want %q", got, tc.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestPlaybackClientInfoForStartV3(t *testing.T) {
|
||||
cases := []struct {
|
||||
name string
|
||||
headers map[string]string
|
||||
context playback.ClientPlaybackContextV3
|
||||
want playback.ClientInfo
|
||||
}{
|
||||
{
|
||||
name: "headers win over the body",
|
||||
headers: map[string]string{"X-Silo-Client": "Silo iOS", "X-Silo-Client-Version": "2.1.0", "X-Silo-Client-Build": "9", "X-Silo-Client-Channel": "beta"},
|
||||
context: playback.ClientPlaybackContextV3{AppVersion: "1.0.0", AppBuild: "1", AppChannel: "release"},
|
||||
want: playback.ClientInfo{Name: "Silo iOS", Version: "2.1.0", Build: "9", Channel: "beta"},
|
||||
},
|
||||
{
|
||||
// The fallback is per field, not per struct: a client may set the
|
||||
// name and version headers on every request and still report the
|
||||
// build it only knows at start time in the body.
|
||||
name: "body fills only the fields the headers omit",
|
||||
headers: map[string]string{"X-Silo-Client": "Silo tvOS", "X-Silo-Client-Version": "2.1.0"},
|
||||
context: playback.ClientPlaybackContextV3{AppVersion: "1.0.0", AppBuild: "77", AppChannel: "sideload"},
|
||||
want: playback.ClientInfo{Name: "Silo tvOS", Version: "2.1.0", Build: "77", Channel: "sideload"},
|
||||
},
|
||||
{
|
||||
name: "body supplies everything but the name",
|
||||
headers: map[string]string{"X-Silo-Client": "Silo Android TV"},
|
||||
context: playback.ClientPlaybackContextV3{AppVersion: "1.0.0", AppBuild: "5", AppChannel: "dev"},
|
||||
want: playback.ClientInfo{Name: "Silo Android TV", Version: "1.0.0", Build: "5", Channel: "dev"},
|
||||
},
|
||||
{
|
||||
// The regression this guards: the web player reports the literal
|
||||
// "web" as its app_version and sends no X-Silo-Client. Taking the
|
||||
// body anyway would stamp "web" onto client_version — the one field
|
||||
// the contract promises is a marketing version — for every browser
|
||||
// session, and onto every route event and decision log with it.
|
||||
name: "nameless client keeps the body out of client_version",
|
||||
context: playback.ClientPlaybackContextV3{AppVersion: "web"},
|
||||
want: playback.ClientInfo{},
|
||||
},
|
||||
{
|
||||
name: "nameless client takes no build or channel either",
|
||||
context: playback.ClientPlaybackContextV3{AppVersion: "web", AppBuild: "5", AppChannel: "dev"},
|
||||
want: playback.ClientInfo{},
|
||||
},
|
||||
{
|
||||
name: "whitespace-only header falls through to the body",
|
||||
headers: map[string]string{"X-Silo-Client": "Silo iOS", "X-Silo-Client-Build": " "},
|
||||
context: playback.ClientPlaybackContextV3{AppBuild: " 42 "},
|
||||
want: playback.ClientInfo{Name: "Silo iOS", Build: "42"},
|
||||
},
|
||||
}
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
req := httptest.NewRequest(http.MethodPost, "/api/v1/playback/start", nil)
|
||||
for name, value := range tc.headers {
|
||||
req.Header.Set(name, value)
|
||||
}
|
||||
got := playbackClientInfoForStartV3(req, tc.context)
|
||||
got.UserAgent = ""
|
||||
if got != tc.want {
|
||||
t.Fatalf("playbackClientInfoForStartV3() = %+v, want %+v", got, tc.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestPlaybackClientInfoFromRequestClampsHeaders pins the bound at the request
|
||||
// boundary rather than at session creation. The resolved identity is written
|
||||
// straight to the plan-decision log and to playback_route_events, so a client
|
||||
// sending a header-sized build would reach both if the clamp only happened
|
||||
// where the session stamps its fields.
|
||||
func TestPlaybackClientInfoFromRequestClampsHeaders(t *testing.T) {
|
||||
req := httptest.NewRequest(http.MethodPost, "/api/v1/playback/start", nil)
|
||||
req.Header.Set("X-Silo-Client", " "+strings.Repeat("N", 200)+" ")
|
||||
req.Header.Set("X-Silo-Client-Version", strings.Repeat("v", 100))
|
||||
req.Header.Set("X-Silo-Client-Build", strings.Repeat("b", 100))
|
||||
req.Header.Set("X-Silo-Client-Channel", strings.Repeat("c", 100))
|
||||
|
||||
got := playbackClientInfoFromRequest(req)
|
||||
|
||||
for _, tc := range []struct {
|
||||
field string
|
||||
value string
|
||||
want int
|
||||
}{
|
||||
{"Name", got.Name, 128},
|
||||
{"Version", got.Version, 64},
|
||||
{"Build", got.Build, 64},
|
||||
{"Channel", got.Channel, 32},
|
||||
} {
|
||||
if len(tc.value) != tc.want {
|
||||
t.Errorf("%s length = %d, want %d", tc.field, len(tc.value), tc.want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestNormalizeClientMetadataCountsRunes guards the two ways a clamp can go
|
||||
// wrong on a client-supplied header: the published bound is JSON Schema
|
||||
// maxLength, which counts characters, and a byte-wise cut through a multi-byte
|
||||
// rune yields invalid UTF-8 that Postgres refuses — failing the whole per-node
|
||||
// session-sync transaction, not just the offending row.
|
||||
func TestNormalizeClientMetadataCountsRunes(t *testing.T) {
|
||||
req := httptest.NewRequest(http.MethodPost, "/api/v1/playback/start", nil)
|
||||
// 40 three-byte runes: within the 64-character channel bound as the schema
|
||||
// counts it, well past it as bytes.
|
||||
req.Header.Set("X-Silo-Client-Channel", strings.Repeat("δ", 40))
|
||||
|
||||
got := playbackClientInfoFromRequest(req)
|
||||
|
||||
if runes := utf8.RuneCountInString(got.Channel); runes != 32 {
|
||||
t.Errorf("Channel runes = %d, want the 32-character bound", runes)
|
||||
}
|
||||
if !utf8.ValidString(got.Channel) {
|
||||
t.Errorf("Channel = %q is not valid UTF-8; a text column would reject it", got.Channel)
|
||||
}
|
||||
}
|
||||
|
||||
// TestPlaybackClientInfoStripsControlCharacters guards the one malformed value
|
||||
// that reaches a text column looking perfectly well-formed. A JSON NUL escape in a
|
||||
// v3 start body decodes to a real NUL, which is valid UTF-8 — so the UTF-8
|
||||
// repair above leaves it and TrimSpace does not consider it whitespace — but
|
||||
// Postgres refuses NUL in text. The per-node session upserts share one
|
||||
// transaction, so one such start would stop every live session on that node
|
||||
// from reconciling. Headers cannot carry it (net/http rejects bytes below
|
||||
// 0x20), which is exactly why the body path needs its own guard.
|
||||
func TestPlaybackClientInfoStripsControlCharacters(t *testing.T) {
|
||||
req := httptest.NewRequest(http.MethodPost, "/api/v1/playback/start", nil)
|
||||
req.Header.Set("X-Silo-Client", "Silo Android TV")
|
||||
|
||||
got := playbackClientInfoForStartV3(req, playback.ClientPlaybackContextV3{
|
||||
AppVersion: "1.0\x00.0",
|
||||
AppBuild: "5\x00",
|
||||
AppChannel: "de\nv",
|
||||
})
|
||||
|
||||
if want := "1.0.0"; got.Version != want {
|
||||
t.Errorf("Version = %q, want %q", got.Version, want)
|
||||
}
|
||||
if want := "5"; got.Build != want {
|
||||
t.Errorf("Build = %q, want %q", got.Build, want)
|
||||
}
|
||||
if want := "dev"; got.Channel != want {
|
||||
t.Errorf("Channel = %q, want %q", got.Channel, want)
|
||||
}
|
||||
for _, field := range []string{got.Name, got.Version, got.Build, got.Channel} {
|
||||
if strings.ContainsFunc(field, unicode.IsControl) {
|
||||
t.Errorf("%q still carries a control character; a text column would reject it", field)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestEnrichPlaybackSessionRowUsesCompatOrigin(t *testing.T) {
|
||||
row := playbackSessionRow{
|
||||
ClientName: "Unrecognized Client",
|
||||
|
||||
@@ -0,0 +1,148 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/Silo-Server/silo-server/internal/models"
|
||||
)
|
||||
|
||||
func TestSubtitleURLExt(t *testing.T) {
|
||||
cases := []struct {
|
||||
codec string
|
||||
want string
|
||||
}{
|
||||
{"ass", ".ass"},
|
||||
{"ssa", ".ass"},
|
||||
{"pgs", ".sup"},
|
||||
{"hdmv_pgs_subtitle", ".sup"},
|
||||
{"subrip", ".vtt"},
|
||||
{"srt", ".vtt"},
|
||||
{"", ".vtt"},
|
||||
}
|
||||
for _, tc := range cases {
|
||||
if got := subtitleURLExt(tc.codec); got != tc.want {
|
||||
t.Errorf("subtitleURLExt(%q) = %q, want %q", tc.codec, got, tc.want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestBuildSubtitleURLs_IncludesAllBitmapTracksForBurnInClients(t *testing.T) {
|
||||
file := &models.MediaFile{
|
||||
ID: 42,
|
||||
SubtitleTracks: []models.SubtitleTrack{
|
||||
{Index: 0, Language: "en", Codec: "subrip"},
|
||||
{Index: 1, Language: "en", Codec: "hdmv_pgs_subtitle"},
|
||||
{Index: 2, Language: "fr", Codec: "dvd_subtitle"},
|
||||
{Index: 3, Language: "de", Codec: "dvb_subtitle"},
|
||||
},
|
||||
}
|
||||
|
||||
urls := buildSubtitleURLs("sess-1", file, nil, true)
|
||||
|
||||
// Every bitmap track is deliverable now that server-side burn-in supports
|
||||
// bitmap codecs; PGS additionally streams as .sup for client rendering.
|
||||
if len(urls) != 4 {
|
||||
t.Fatalf("expected 4 subtitle URLs (text + PGS + DVD + DVB), got %d: %+v", len(urls), urls)
|
||||
}
|
||||
|
||||
srt := urls[0]
|
||||
if srt.MediaFileID != file.ID || srt.Codec != "subrip" || srt.URL != "/stream/sess-1/subtitles/0.vtt?file_id=42" {
|
||||
t.Errorf("unexpected text track entry: %+v", srt)
|
||||
}
|
||||
|
||||
pgs := urls[1]
|
||||
if pgs.MediaFileID != file.ID || pgs.Codec != "hdmv_pgs_subtitle" {
|
||||
t.Errorf("expected PGS track to be included, got %+v", pgs)
|
||||
}
|
||||
if pgs.URL != "/stream/sess-1/subtitles/1.sup?file_id=42" {
|
||||
t.Errorf("PGS track should get a .sup URL, got %q", pgs.URL)
|
||||
}
|
||||
if pgs.FontBundleURL != "" {
|
||||
t.Errorf("PGS track must not advertise a font bundle, got %q", pgs.FontBundleURL)
|
||||
}
|
||||
|
||||
if dvd := urls[2]; dvd.Codec != "dvd_subtitle" || dvd.Index != 2 {
|
||||
t.Errorf("expected DVD bitmap track to be listed for burn-in selection, got %+v", dvd)
|
||||
}
|
||||
if dvb := urls[3]; dvb.Codec != "dvb_subtitle" || dvb.Index != 3 {
|
||||
t.Errorf("expected DVB bitmap track to be listed for burn-in selection, got %+v", dvb)
|
||||
}
|
||||
}
|
||||
|
||||
func TestBuildSubtitleURLs_HidesBurnInOnlyTracksByDefault(t *testing.T) {
|
||||
file := &models.MediaFile{
|
||||
ID: 43,
|
||||
SubtitleTracks: []models.SubtitleTrack{
|
||||
{Index: 0, Language: "en", Codec: "subrip"},
|
||||
{Index: 1, Language: "en", Codec: "hdmv_pgs_subtitle"},
|
||||
{Index: 2, Language: "fr", Codec: "dvd_subtitle"},
|
||||
{Index: 3, Language: "de", Codec: "dvb_subtitle"},
|
||||
},
|
||||
}
|
||||
|
||||
urls := buildSubtitleURLs("sess-native", file, nil, false)
|
||||
if len(urls) != 2 {
|
||||
t.Fatalf("expected text and PGS only, got %d: %+v", len(urls), urls)
|
||||
}
|
||||
if urls[0].Codec != "subrip" || urls[1].Codec != "hdmv_pgs_subtitle" {
|
||||
t.Fatalf("unexpected default subtitle URLs: %+v", urls)
|
||||
}
|
||||
}
|
||||
|
||||
func TestBuildSubtitleURLs_PGSIndexAccountsForExternalOffset(t *testing.T) {
|
||||
file := &models.MediaFile{
|
||||
ID: 44,
|
||||
ExternalSubtitles: []models.ExternalSubtitle{
|
||||
{Path: "/media/movie.en.srt", Language: "en", Format: "srt"},
|
||||
},
|
||||
SubtitleTracks: []models.SubtitleTrack{
|
||||
{Index: 0, Language: "en", Codec: "pgs"},
|
||||
},
|
||||
}
|
||||
|
||||
urls := buildSubtitleURLs("sess-2", file, nil, false)
|
||||
|
||||
if len(urls) != 2 {
|
||||
t.Fatalf("expected 2 subtitle URLs, got %d: %+v", len(urls), urls)
|
||||
}
|
||||
pgs := urls[1]
|
||||
if pgs.Index != 1 || pgs.URL != "/stream/sess-2/subtitles/1.sup?file_id=44" {
|
||||
t.Errorf("PGS track index should include the external offset, got %+v", pgs)
|
||||
}
|
||||
}
|
||||
|
||||
func TestResolveBurnInSubtitle_RemapsAlternateVersionByStableTraits(t *testing.T) {
|
||||
requested := &models.MediaFile{
|
||||
ID: 1,
|
||||
SubtitleTracks: []models.SubtitleTrack{
|
||||
{Language: "en", Codec: "subrip", Title: "English"},
|
||||
{Language: "ja", Codec: "hdmv_pgs_subtitle", Title: "Japanese", Forced: true},
|
||||
},
|
||||
}
|
||||
effective := &models.MediaFile{
|
||||
ID: 2,
|
||||
SubtitleTracks: []models.SubtitleTrack{
|
||||
{Language: "ja", Codec: "hdmv_pgs_subtitle", Title: "Japanese", Forced: true},
|
||||
{Language: "en", Codec: "subrip", Title: "English"},
|
||||
},
|
||||
}
|
||||
|
||||
index, codec, ok := resolveBurnInSubtitle(requested, effective, 1)
|
||||
if !ok || index != 0 || codec != "hdmv_pgs_subtitle" {
|
||||
t.Fatalf("resolveBurnInSubtitle() = (%d, %q, %v), want (0, hdmv_pgs_subtitle, true)", index, codec, ok)
|
||||
}
|
||||
}
|
||||
|
||||
func TestResolveBurnInSubtitle_RejectsMissingAlternateTrack(t *testing.T) {
|
||||
requested := &models.MediaFile{
|
||||
ID: 1,
|
||||
SubtitleTracks: []models.SubtitleTrack{
|
||||
{Language: "ja", Codec: "hdmv_pgs_subtitle", Title: "Japanese"},
|
||||
},
|
||||
}
|
||||
effective := &models.MediaFile{ID: 2}
|
||||
|
||||
if index, codec, ok := resolveBurnInSubtitle(requested, effective, 0); ok || index != -1 || codec != "" {
|
||||
t.Fatalf("resolveBurnInSubtitle() = (%d, %q, %v), want unavailable", index, codec, ok)
|
||||
}
|
||||
}
|
||||
+2833
-283
File diff suppressed because it is too large
Load Diff
+245
-1499
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,121 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"context"
|
||||
"log/slog"
|
||||
"runtime/debug"
|
||||
"time"
|
||||
|
||||
"github.com/Silo-Server/silo-server/internal/models"
|
||||
"github.com/Silo-Server/silo-server/internal/playback"
|
||||
)
|
||||
|
||||
const playbackV3ShadowSetting = "playback.protocol_v3_shadow_enabled"
|
||||
|
||||
func (h *PlaybackHandler) protocolV3ShadowEnabled(ctx context.Context) bool {
|
||||
return h.settingFlagCachedV3(ctx, playbackV3ShadowSetting)
|
||||
}
|
||||
|
||||
// shadowLegacyPlaybackV3 compares the production legacy route with a v3 plan
|
||||
// without advertising or executing that plan. Legacy capabilities lack the
|
||||
// detailed v3 fields, so exact source facts are used only as an explicitly
|
||||
// labelled validation inference; this is never a production compatibility
|
||||
// claim and cannot enable v3 playback.
|
||||
func (h *PlaybackHandler) shadowLegacyPlaybackV3(ctx context.Context, req startPlaybackRequest, requestedFile, effectiveFile *models.MediaFile, audioIndex int, productionMethod playback.PlayMethod, productionTranscodeAudio bool, sessionID string) {
|
||||
// The shadow planner runs on a bare goroutine off the production start
|
||||
// path; an escaped panic here would take down the whole process for a
|
||||
// telemetry-only comparison, so it must fail closed instead.
|
||||
defer func() {
|
||||
if recovered := recover(); recovered != nil {
|
||||
slog.ErrorContext(ctx, "playback v3 shadow planner panicked",
|
||||
"component", "playback", "playback_session_id", sessionID,
|
||||
"panic", recovered, "stack", string(debug.Stack()))
|
||||
}
|
||||
}()
|
||||
if !h.protocolV3ShadowEnabled(ctx) || requestedFile == nil || effectiveFile == nil {
|
||||
return
|
||||
}
|
||||
request := legacyShadowRequestV3(req, effectiveFile, audioIndex, sessionID)
|
||||
result := playback.PlanPlaybackV3(playback.PlannerInputV3{
|
||||
Request: request,
|
||||
RequestedFile: requestedFile,
|
||||
EffectiveFile: effectiveFile,
|
||||
AudioTrackIndex: audioIndex,
|
||||
Settings: h.plannerSettingsV3(ctx),
|
||||
Registry: h.transformationRegistryV3(ctx),
|
||||
HLSRegistry: h.lazyHLSPlanningRegistryV3(ctx),
|
||||
Now: time.Now(),
|
||||
})
|
||||
attrs := []any{
|
||||
"component", "playback",
|
||||
"playback_session_id", sessionID,
|
||||
"requested_file_id", requestedFile.ID,
|
||||
"effective_file_id", effectiveFile.ID,
|
||||
"production_method", productionMethod,
|
||||
"production_transcode_audio", productionTranscodeAudio,
|
||||
"capability_basis", "legacy_source_exact_inference",
|
||||
}
|
||||
if result.Plan != nil {
|
||||
attrs = append(attrs,
|
||||
"shadow_plan_id", result.Plan.PlanID,
|
||||
"shadow_delivery", result.Plan.Delivery,
|
||||
"shadow_method", result.PlayMethod,
|
||||
"shadow_transcode_audio", result.TranscodeAudio,
|
||||
"shadow_reason", result.Plan.DecisionReason,
|
||||
"route_match", result.PlayMethod == productionMethod && result.TranscodeAudio == productionTranscodeAudio,
|
||||
)
|
||||
} else if result.Terminal != nil {
|
||||
attrs = append(attrs, "shadow_terminal", result.Terminal.Reason, "route_match", false)
|
||||
}
|
||||
slog.InfoContext(ctx, "playback v3 shadow decision", attrs...)
|
||||
}
|
||||
|
||||
func legacyShadowRequestV3(req startPlaybackRequest, file *models.MediaFile, audioIndex int, sessionID string) playback.StartRequestV3 {
|
||||
source := playback.SourceDescriptorFromFileV3(file, audioIndex)
|
||||
hdr := legacyShadowHDRV3(req)
|
||||
features := []string{playback.FeaturePlaybackPlanV3, playback.FeatureMedia3Only, playback.FeatureDetailedDecodeV3}
|
||||
capabilities := playback.ClientCodecCapabilitiesV3{
|
||||
CodecsVideo: append([]string(nil), req.CodecsVideo...),
|
||||
CodecsAudio: append([]string(nil), req.CodecsAudio...),
|
||||
Containers: append([]string(nil), req.Containers...),
|
||||
MaxResolution: req.MaxResolution,
|
||||
HDR: req.HDR,
|
||||
HDRDetails: hdr,
|
||||
}
|
||||
if containsStringFoldV3(req.CodecsVideo, source.VideoCodec) {
|
||||
capabilities.VideoDecode = []playback.VideoDecodeCapabilityV3{{
|
||||
Codec: source.VideoCodec, Profiles: []string{source.VideoProfile}, Levels: []int{source.VideoLevel}, BitDepths: []int{source.BitDepth},
|
||||
MaxWidth: source.Width, MaxHeight: source.Height, MaxFrameRate: source.FrameRate, MaxBitrateKbps: source.BitrateKbps, Hardware: true,
|
||||
}}
|
||||
}
|
||||
var passthrough *playback.AudioPassthroughV3
|
||||
if req.AudioPassthrough != nil {
|
||||
passthrough = &playback.AudioPassthroughV3{PassthroughCodecs: append([]string(nil), req.AudioPassthrough.PassthroughCodecs...), SpatializerEnabled: req.AudioPassthrough.SpatializerEnabled, MaxChannels: req.AudioPassthrough.MaxChannels}
|
||||
if containsStringFoldV3(req.AudioPassthrough.PassthroughCodecs, source.AudioCodec) && source.AudioChannels > 0 && source.AudioLayout != "" && source.AudioChannels <= req.AudioPassthrough.MaxChannels {
|
||||
passthrough.Entries = []playback.AudioPassthroughEntryV3{{Codec: source.AudioCodec, ChannelCounts: []int{source.AudioChannels}, Layouts: []string{source.AudioLayout}}}
|
||||
features = append(features, playback.FeatureLayoutPassthrough)
|
||||
}
|
||||
capabilities.AudioPassthrough = passthrough
|
||||
}
|
||||
engines := map[string]playback.EngineCapabilityV3{
|
||||
string(playback.EngineMedia3DirectV3): {Enabled: true, SupportedOnDevice: true, Subtitles: playback.EngineSubtitleCapabilitiesV3{EmbeddedText: true, SidecarText: true, EmbeddedBitmap: true, SidecarBitmap: true}},
|
||||
string(playback.EngineMedia3ProgressiveRemuxV3): {Enabled: true, SupportedOnDevice: true},
|
||||
string(playback.EngineMedia3HLSV3): {Enabled: true, SupportedOnDevice: true},
|
||||
}
|
||||
return playback.StartRequestV3{
|
||||
ProtocolVersion: playback.ProtocolV3, ClientFeatures: features, FileID: file.ID, ProfileID: req.ProfileID,
|
||||
PlaybackAttemptID: "shadow-" + sessionID, QualityPreference: "original", SubtitleFidelityPreference: playback.SubtitleFidelityCompatibleV3,
|
||||
StartPosition: req.StartPosition, AudioTrackIndex: &audioIndex, Capabilities: capabilities,
|
||||
ClientPlaybackContext: playback.ClientPlaybackContextV3{ProtocolVersion: playback.ProtocolV3, Features: features, Platform: "legacy-shadow", Output: playback.OutputContextV3{HDRDetails: hdr, AudioPassthrough: passthrough}, Engines: engines},
|
||||
}
|
||||
}
|
||||
|
||||
func legacyShadowHDRV3(req startPlaybackRequest) *playback.HDRCapabilitiesV3 {
|
||||
if req.HdrDetails != nil {
|
||||
return &playback.HDRCapabilitiesV3{HDR10: req.HdrDetails.HDR10, HDR10Plus: req.HdrDetails.HDR10Plus, HLG: req.HdrDetails.HLG, DolbyVisionProfiles: append([]int(nil), req.HdrDetails.DolbyVisionProfiles...)}
|
||||
}
|
||||
if req.HDR {
|
||||
return &playback.HDRCapabilitiesV3{HDR10: true}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
@@ -33,7 +33,7 @@ func TestHLSPlanningRegistryV3UnionsPooledNodeCapabilities(t *testing.T) {
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusOK, playback.HWAccelInfo{Transformations: []playback.TransformationV3{
|
||||
{Name: "video_to_h264", Executor: "server", RecipeVersion: "2"},
|
||||
{Name: "video_to_h264", Executor: "server", RecipeVersion: "1"},
|
||||
{Name: "audio_to_aac", Executor: "server", RecipeVersion: "1"},
|
||||
}})
|
||||
}))
|
||||
@@ -42,7 +42,7 @@ func TestHLSPlanningRegistryV3UnionsPooledNodeCapabilities(t *testing.T) {
|
||||
handler := NewPlaybackHandler(playback.NewSessionManager(0, 0))
|
||||
handler.JWTSecret = "test-secret"
|
||||
presetLocalRegistryV3(handler, playback.NewTransformationRegistryV3([]playback.TransformationSpecV3{
|
||||
{Name: "video_to_h264", RecipeVersion: "2"},
|
||||
{Name: "video_to_h264", RecipeVersion: "1"},
|
||||
{Name: "audio_to_aac", RecipeVersion: "1"},
|
||||
{Name: "server_dv7_to_hdr10", RecipeVersion: "1"},
|
||||
}))
|
||||
@@ -123,7 +123,7 @@ func TestRemoteTransformationsV3FailureCacheSplit(t *testing.T) {
|
||||
func TestPlanNodeSessionV3PrefersCapabilityMatchingNode(t *testing.T) {
|
||||
capable := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
writeJSON(w, http.StatusOK, playback.HWAccelInfo{Transformations: []playback.TransformationV3{
|
||||
{Name: "video_to_h264", Executor: "server", RecipeVersion: "2"},
|
||||
{Name: "video_to_h264", Executor: "server", RecipeVersion: "1"},
|
||||
{Name: "audio_to_aac", Executor: "server", RecipeVersion: "1"},
|
||||
}})
|
||||
}))
|
||||
@@ -146,7 +146,7 @@ func TestPlanNodeSessionV3PrefersCapabilityMatchingNode(t *testing.T) {
|
||||
PlanID: "plan:heterogeneous",
|
||||
Delivery: playback.DeliveryTranscodeHLSV3,
|
||||
Transformations: []playback.TransformationV3{
|
||||
{Name: "video_to_h264", Executor: "server", RecipeVersion: "2"},
|
||||
{Name: "video_to_h264", Executor: "server", RecipeVersion: "1"},
|
||||
{Name: "audio_to_aac", Executor: "server", RecipeVersion: "1"},
|
||||
},
|
||||
}
|
||||
@@ -165,14 +165,14 @@ func TestPlanNodeSessionV3PrefersCapabilityMatchingNode(t *testing.T) {
|
||||
func TestPrepareTransportV3LocalFallbackRejectsUnavailableTransformations(t *testing.T) {
|
||||
handler := NewPlaybackHandler(playback.NewSessionManager(0, 0))
|
||||
presetLocalRegistryV3(handler, playback.NewTransformationRegistryV3([]playback.TransformationSpecV3{
|
||||
{Name: "video_to_h264", RecipeVersion: "2"},
|
||||
{Name: "video_to_h264", RecipeVersion: "1"},
|
||||
{Name: "audio_to_aac", RecipeVersion: "1"},
|
||||
}))
|
||||
plan := &playback.PlanV3{
|
||||
PlanID: "plan:local-capability",
|
||||
Delivery: playback.DeliveryTranscodeHLSV3,
|
||||
Transformations: []playback.TransformationV3{
|
||||
{Name: "video_to_h264", Executor: "server", RecipeVersion: "2"},
|
||||
{Name: "video_to_h264", Executor: "server", RecipeVersion: "1"},
|
||||
{Name: "audio_to_aac", Executor: "server", RecipeVersion: "1"},
|
||||
},
|
||||
}
|
||||
|
||||
@@ -79,8 +79,7 @@ func TestUpdateProfileSyncsCanonicalMetadataLanguage(t *testing.T) {
|
||||
|
||||
// TestUpdateProfileSyncsCanonicalAudioLanguage is the playback-start half: a
|
||||
// profile that never had a backfilled row chooses a spoken language, and the
|
||||
// canonical store — which preferredAudioTrackIndexV3 resolves when a start omits
|
||||
// the audio track — must carry it.
|
||||
// canonical store — which handleStartPlaybackLegacy resolves — must carry it.
|
||||
func TestUpdateProfileSyncsCanonicalAudioLanguage(t *testing.T) {
|
||||
store := newProfileTestStore(t)
|
||||
handler := NewProfileHandler(testUserStoreProvider{store: store})
|
||||
|
||||
@@ -23,19 +23,18 @@ import (
|
||||
|
||||
// SectionHandler handles section management and batch section endpoints.
|
||||
type SectionHandler struct {
|
||||
repo *sections.Repository
|
||||
fetcher *sections.Fetcher
|
||||
previewFetcher sectionPreviewFetcher // set to fetcher at construction; separate for test injection
|
||||
episodeFetcher sectionEpisodeFetcher
|
||||
FolderRepo *catalog.FolderRepository
|
||||
EpisodeRepo *catalog.EpisodeRepository
|
||||
StoreProvider userstore.UserStoreProvider
|
||||
UserRepo *auth.UserRepository
|
||||
DetailSvc *catalog.DetailService
|
||||
Settings catalog.SettingsStore
|
||||
CollectionRepo *catalog.LibraryCollectionRepository
|
||||
SortPreferenceCleaner *userstore.CollectionSortPreferenceCleaner
|
||||
EbookProgress EbookReaderProgressLister
|
||||
repo *sections.Repository
|
||||
fetcher *sections.Fetcher
|
||||
previewFetcher sectionPreviewFetcher // set to fetcher at construction; separate for test injection
|
||||
episodeFetcher sectionEpisodeFetcher
|
||||
FolderRepo *catalog.FolderRepository
|
||||
EpisodeRepo *catalog.EpisodeRepository
|
||||
StoreProvider userstore.UserStoreProvider
|
||||
UserRepo *auth.UserRepository
|
||||
DetailSvc *catalog.DetailService
|
||||
Settings catalog.SettingsStore
|
||||
CollectionRepo *catalog.LibraryCollectionRepository
|
||||
EbookProgress EbookReaderProgressLister
|
||||
}
|
||||
|
||||
// NewSectionHandler creates a new SectionHandler.
|
||||
@@ -406,8 +405,6 @@ func (h *SectionHandler) deleteUnreferencedSectionManagedCollection(ctx context.
|
||||
}
|
||||
if err := h.CollectionRepo.Delete(ctx, collectionID); err != nil && !errors.Is(err, catalog.ErrLibraryCollectionNotFound) {
|
||||
slog.WarnContext(ctx, "failed to delete unreferenced section-managed collection", "component", "api", "collection_id", collectionID, "error", err)
|
||||
} else if err == nil && h.SortPreferenceCleaner != nil {
|
||||
h.SortPreferenceCleaner.DeleteForCollection(ctx, userstore.CollectionKindLibrary, collectionID)
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
+40
-191
@@ -20,12 +20,6 @@ import (
|
||||
"github.com/Silo-Server/silo-server/internal/subtitles"
|
||||
)
|
||||
|
||||
const (
|
||||
subtitleFormatASS = "ass"
|
||||
subtitleFormatSSA = "ssa"
|
||||
subtitleFormatSUP = "sup"
|
||||
)
|
||||
|
||||
// FilePathResolver looks up a media file by its ID.
|
||||
type FilePathResolver interface {
|
||||
GetByID(ctx context.Context, id int) (*models.MediaFile, error)
|
||||
@@ -165,18 +159,7 @@ func (h *StreamHandler) HandleStream(w http.ResponseWriter, r *http.Request) {
|
||||
seekSeconds = s
|
||||
}
|
||||
}
|
||||
// An audio-only source muxes an audio-only fMP4. The v3 plan promises
|
||||
// audio/mp4 for it, and a declared-tier client refuses to attach a
|
||||
// source buffer whose advertised type its probe rejected — so the
|
||||
// response has to keep the same promise the plan made.
|
||||
if err := playback.ServeRemuxWithOptions(w, r, file.FilePath, "mp4", seekSeconds, session.TranscodeAudio, session.AudioTrackIndex, file.PrimaryDVProfile(), playback.RemuxServeOptions{
|
||||
DVMode: session.RemuxDVMode,
|
||||
FFmpegPath: h.ffmpegPath(),
|
||||
ContentType: playback.RemuxContentType(file.IsAudioOnly()),
|
||||
AudioOnly: file.IsAudioOnly(),
|
||||
TargetAudioChannels: session.TargetAudioChannels,
|
||||
TargetAudioBitrateKbps: session.TargetAudioBitrateKbps,
|
||||
}); err != nil {
|
||||
if err := playback.ServeRemuxWithDVMode(w, r, file.FilePath, "mp4", seekSeconds, session.TranscodeAudio, session.AudioTrackIndex, file.PrimaryDVProfile(), session.RemuxDVMode, h.ffmpegPath()); err != nil {
|
||||
h.handleTransportStartFailure(r.Context(), session, file, err)
|
||||
}
|
||||
|
||||
@@ -236,58 +219,9 @@ func (h *StreamHandler) HandleSubtitle(w http.ResponseWriter, r *http.Request) {
|
||||
return
|
||||
}
|
||||
|
||||
// trackIndex is a combined ordinal, resolved through the same three
|
||||
// consecutive ranges playback.BuildSubtitleInventoryV3 assigns them from:
|
||||
// externals, then embedded container tracks, then downloaded ones. The
|
||||
// ranges cover the full track arrays — including bitmap tracks that have no
|
||||
// sidecar shape — so an ordinal always names the same track here as it does
|
||||
// in the published inventory.
|
||||
// Downloaded subtitle URLs additionally bind that ordinal to a stable row
|
||||
// identity. The path ordinal remains for compatibility and display, but it
|
||||
// must not be re-resolved against a mutable inventory after a seek reanchor.
|
||||
if rawID := strings.TrimSpace(r.URL.Query().Get(playback.DownloadedSubtitleIDParamV3)); rawID != "" {
|
||||
downloadedID, parseErr := strconv.Atoi(rawID)
|
||||
if parseErr != nil || downloadedID <= 0 {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", "Invalid downloaded subtitle identity")
|
||||
return
|
||||
}
|
||||
if h.SubtitleRepo == nil || h.S3Client == nil {
|
||||
writeError(w, http.StatusNotFound, "not_found", "Subtitle track not found")
|
||||
return
|
||||
}
|
||||
downloaded, lookupErr := h.SubtitleRepo.GetDownloadedSubtitle(r.Context(), downloadedID)
|
||||
if lookupErr != nil {
|
||||
slog.ErrorContext(r.Context(), "get downloaded subtitle failed", "component", "api",
|
||||
"file_id", file.ID,
|
||||
"downloaded_subtitle_id", downloadedID,
|
||||
"error", lookupErr,
|
||||
)
|
||||
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to load downloaded subtitle")
|
||||
return
|
||||
}
|
||||
if downloaded == nil || downloaded.MediaFileID != file.ID {
|
||||
writeError(w, http.StatusNotFound, "not_found", "Subtitle track not found")
|
||||
return
|
||||
}
|
||||
if r.Method == http.MethodHead {
|
||||
writeSubtitleRepresentationHead(w, requestedFormat)
|
||||
return
|
||||
}
|
||||
h.serveDownloadedSubtitle(w, r, *downloaded, requestedFormat)
|
||||
return
|
||||
}
|
||||
externalCount := len(file.ExternalSubtitles)
|
||||
if trackIndex < externalCount {
|
||||
sub := file.ExternalSubtitles[trackIndex]
|
||||
if !subtitleSidecarFormatSupported(sub.Format, requestedFormat, false) {
|
||||
writeError(w, http.StatusUnsupportedMediaType, "unsupported_media_type",
|
||||
"Requested subtitle extension does not match the selected track")
|
||||
return
|
||||
}
|
||||
if r.Method == http.MethodHead {
|
||||
writeSubtitleRepresentationHead(w, requestedFormat)
|
||||
return
|
||||
}
|
||||
|
||||
// Serve ASS/SSA external subtitles as raw data for client-side rendering.
|
||||
if playback.IsASS(sub.Format) && requestedFormat != "vtt" {
|
||||
@@ -297,7 +231,7 @@ func (h *StreamHandler) HandleSubtitle(w http.ResponseWriter, r *http.Request) {
|
||||
"Failed to load external subtitle")
|
||||
return
|
||||
}
|
||||
playback.ServeSubtitle(w, data, subtitleFormatASS)
|
||||
playback.ServeSubtitle(w, data, "ass")
|
||||
return
|
||||
}
|
||||
|
||||
@@ -324,15 +258,6 @@ func (h *StreamHandler) HandleSubtitle(w http.ResponseWriter, r *http.Request) {
|
||||
"Bitmap subtitle tracks cannot be extracted as text")
|
||||
return
|
||||
}
|
||||
if !subtitleSidecarFormatSupported(track.Codec, requestedFormat, true) {
|
||||
writeError(w, http.StatusUnsupportedMediaType, "unsupported_media_type",
|
||||
"Requested subtitle extension does not match the selected track")
|
||||
return
|
||||
}
|
||||
if r.Method == http.MethodHead && requestedFormat != subtitleFormatSUP {
|
||||
writeSubtitleRepresentationHead(w, requestedFormat)
|
||||
return
|
||||
}
|
||||
|
||||
// Dedicated streaming extract — ffmpeg seeks to the current
|
||||
// playback position and pipes cues to the response as they're
|
||||
@@ -362,11 +287,32 @@ func (h *StreamHandler) HandleSubtitle(w http.ResponseWriter, r *http.Request) {
|
||||
|
||||
downloadedIndex := embeddedIndex - len(file.SubtitleTracks)
|
||||
if downloadedIndex >= 0 && downloadedIndex < len(downloaded) {
|
||||
if r.Method == http.MethodHead {
|
||||
writeSubtitleRepresentationHead(w, requestedFormat)
|
||||
dl := downloaded[downloadedIndex]
|
||||
data, err := h.S3Client.GetObject(r.Context(), h.S3Bucket, dl.S3Key)
|
||||
if err != nil {
|
||||
writeError(w, http.StatusBadGateway, "s3_error", "Failed to load subtitle from storage")
|
||||
return
|
||||
}
|
||||
h.serveDownloadedSubtitle(w, r, downloaded[downloadedIndex], requestedFormat)
|
||||
|
||||
// Serve ASS/SSA downloaded subtitles as raw data.
|
||||
if playback.IsASS(string(dl.Format)) && requestedFormat != "vtt" {
|
||||
playback.ServeSubtitle(w, data, "ass")
|
||||
return
|
||||
}
|
||||
|
||||
// If the subtitle is already VTT, serve directly.
|
||||
if dl.Format == subtitles.FormatVTT {
|
||||
playback.ServeSubtitle(w, data, "vtt")
|
||||
return
|
||||
}
|
||||
|
||||
// Convert to VTT using the playback conversion pipeline.
|
||||
vttData, err := playback.ConvertToVTTWithFFmpeg(r.Context(), data, string(dl.Format), h.ffmpegPath())
|
||||
if err != nil {
|
||||
writeError(w, http.StatusInternalServerError, "convert_error", "Failed to convert subtitle")
|
||||
return
|
||||
}
|
||||
playback.ServeSubtitle(w, vttData, "vtt")
|
||||
return
|
||||
}
|
||||
}
|
||||
@@ -374,73 +320,6 @@ func (h *StreamHandler) HandleSubtitle(w http.ResponseWriter, r *http.Request) {
|
||||
writeError(w, http.StatusNotFound, "not_found", "Subtitle track not found")
|
||||
}
|
||||
|
||||
func (h *StreamHandler) serveDownloadedSubtitle(w http.ResponseWriter, r *http.Request, subtitle subtitles.DownloadedSubtitle, requestedFormat string) {
|
||||
if !subtitleSidecarFormatSupported(string(subtitle.Format), requestedFormat, false) {
|
||||
writeError(w, http.StatusUnsupportedMediaType, "unsupported_media_type",
|
||||
"Requested subtitle extension does not match the selected track")
|
||||
return
|
||||
}
|
||||
data, err := h.S3Client.GetObject(r.Context(), h.S3Bucket, subtitle.S3Key)
|
||||
if err != nil {
|
||||
writeError(w, http.StatusBadGateway, "s3_error", "Failed to load subtitle from storage")
|
||||
return
|
||||
}
|
||||
|
||||
// Serve ASS/SSA downloaded subtitles as raw data.
|
||||
if playback.IsASS(string(subtitle.Format)) && requestedFormat != "vtt" {
|
||||
playback.ServeSubtitle(w, data, subtitleFormatASS)
|
||||
return
|
||||
}
|
||||
|
||||
// If the subtitle is already VTT, serve directly.
|
||||
if subtitle.Format == subtitles.FormatVTT {
|
||||
playback.ServeSubtitle(w, data, "vtt")
|
||||
return
|
||||
}
|
||||
|
||||
// Convert other text formats to VTT using the playback conversion pipeline.
|
||||
vttData, err := playback.ConvertToVTTWithFFmpeg(r.Context(), data, string(subtitle.Format), h.ffmpegPath())
|
||||
if err != nil {
|
||||
writeError(w, http.StatusInternalServerError, "convert_error", "Failed to convert subtitle")
|
||||
return
|
||||
}
|
||||
playback.ServeSubtitle(w, vttData, "vtt")
|
||||
}
|
||||
|
||||
// subtitleSidecarFormatSupported keeps bitmap and styled-text requests within
|
||||
// the representations the server can produce. Plain text tracks preserve the
|
||||
// v1 endpoint's permissive extension behavior and are always returned as VTT;
|
||||
// ASS/SSA may also be served losslessly, and only an embedded PGS track has a
|
||||
// binary .sup representation.
|
||||
func subtitleSidecarFormatSupported(codec, requestedFormat string, embeddedPGS bool) bool {
|
||||
requestedFormat = strings.ToLower(strings.TrimSpace(requestedFormat))
|
||||
if requestedFormat == "" {
|
||||
return true
|
||||
}
|
||||
if playback.IsPGS(codec) {
|
||||
return embeddedPGS && requestedFormat == subtitleFormatSUP
|
||||
}
|
||||
if playback.NeedsBurnIn(codec) {
|
||||
return false
|
||||
}
|
||||
if playback.IsASS(codec) {
|
||||
return requestedFormat == subtitleFormatASS || requestedFormat == subtitleFormatSSA || requestedFormat == "vtt"
|
||||
}
|
||||
return true
|
||||
}
|
||||
|
||||
func writeSubtitleRepresentationHead(w http.ResponseWriter, requestedFormat string) {
|
||||
switch strings.ToLower(strings.TrimSpace(requestedFormat)) {
|
||||
case subtitleFormatASS, subtitleFormatSSA:
|
||||
w.Header().Set("Content-Type", "text/x-ssa; charset=utf-8")
|
||||
case subtitleFormatSUP:
|
||||
w.Header().Set("Content-Type", "application/octet-stream")
|
||||
default:
|
||||
w.Header().Set("Content-Type", "text/vtt; charset=utf-8")
|
||||
}
|
||||
w.WriteHeader(http.StatusOK)
|
||||
}
|
||||
|
||||
// subtitleSourceFileID pins a subtitle URL to the file whose track list was
|
||||
// used to create it. A quality/seek restart may change session.MediaFileID to
|
||||
// an alternate version; interpreting the old combined track index against the
|
||||
@@ -611,13 +490,7 @@ func (h *StreamHandler) handleTransportStartFailure(ctx context.Context, session
|
||||
// pipeline, it works the same for direct play, remux, and transcode.
|
||||
func (h *StreamHandler) streamEmbeddedSubtitle(w http.ResponseWriter, r *http.Request, file *models.MediaFile, embeddedIndex int, session *playback.Session, requestedFormat ...string) {
|
||||
track := file.SubtitleTracks[embeddedIndex]
|
||||
outFormat := "vtt"
|
||||
switch {
|
||||
case playback.IsASS(track.Codec):
|
||||
outFormat = subtitleFormatASS
|
||||
case playback.IsPGS(track.Codec):
|
||||
outFormat = subtitleFormatSUP
|
||||
}
|
||||
_, outFormat := playback.StreamExtractOutput(track.Codec, requestedFormat...)
|
||||
|
||||
// ASS is fetched exactly once and consumed whole by its client-side
|
||||
// renderer (JASSUB), so it must never be windowed. PGS defaults to
|
||||
@@ -632,11 +505,11 @@ func (h *StreamHandler) streamEmbeddedSubtitle(w http.ResponseWriter, r *http.Re
|
||||
// misleading nonzero seek here.
|
||||
var seek, duration float64
|
||||
var allowWindow bool
|
||||
switch outFormat {
|
||||
case "vtt":
|
||||
switch {
|
||||
case outFormat == "webvtt" && !playback.IsASS(track.Codec):
|
||||
seek = subtitleSeekPosition(r, session)
|
||||
duration = subtitleWindowDuration(r)
|
||||
case subtitleFormatSUP:
|
||||
case outFormat == "sup":
|
||||
allowWindow, seek, duration = playback.PGSWindowRequest(r.URL.Query())
|
||||
}
|
||||
slog.InfoContext(r.Context(), "subtitle stream requested", "component", "api",
|
||||
@@ -670,38 +543,16 @@ func (h *StreamHandler) streamEmbeddedSubtitle(w http.ResponseWriter, r *http.Re
|
||||
return
|
||||
}
|
||||
opts.TargetFormat = "vtt"
|
||||
outFormat = "vtt"
|
||||
}
|
||||
|
||||
w.Header().Set("Access-Control-Allow-Origin", "*")
|
||||
|
||||
// Full-track PGS extracts are expensive (whole-file demux) and byte-
|
||||
// identical across requests, so they are served from / teed into the
|
||||
// subtitle cache; windowed PGS requests extract their slice from the
|
||||
// cached full track when present (warming it in the background when
|
||||
// not). All other formats stream uncached: VTT is already windowed
|
||||
// and fast, ASS is small.
|
||||
if outFormat == subtitleFormatSUP {
|
||||
err := h.SubtitleCache.ServeSUPExtract(w, r, opts, playback.StreamExtractSubtitle)
|
||||
playback.LogSubtitleStreamError(r.Context(), err, file.ID, embeddedIndex)
|
||||
return
|
||||
}
|
||||
|
||||
switch outFormat {
|
||||
case subtitleFormatASS:
|
||||
w.Header().Set("Content-Type", "text/x-ssa; charset=utf-8")
|
||||
default:
|
||||
w.Header().Set("Content-Type", "text/vtt; charset=utf-8")
|
||||
}
|
||||
w.Header().Set("Cache-Control", "no-store")
|
||||
w.WriteHeader(http.StatusOK)
|
||||
|
||||
opts.Writer = w
|
||||
if err := playback.StreamExtractSubtitle(r.Context(), opts); err != nil {
|
||||
// Headers already committed — best we can do is log and let
|
||||
// the client see a truncated response.
|
||||
playback.LogSubtitleStreamError(r.Context(), err, file.ID, embeddedIndex)
|
||||
}
|
||||
// Embedded extracts are served from or teed into the subtitle cache.
|
||||
// Requests whose effective ffmpeg argv includes seek/duration are never
|
||||
// canonical: they stream uncached and warm a seek-0/duration-0 artifact,
|
||||
// or re-extract from that artifact when it is already present.
|
||||
err := h.SubtitleCache.ServeExtract(w, r, opts, playback.StreamExtractSubtitle)
|
||||
playback.LogSubtitleStreamError(r.Context(), err, file.ID, embeddedIndex)
|
||||
}
|
||||
|
||||
// subtitleSeekPosition picks the best-known starting position for a
|
||||
@@ -720,12 +571,10 @@ func subtitleSeekPosition(r *http.Request, session *playback.Session) float64 {
|
||||
return 0
|
||||
}
|
||||
|
||||
// subtitleWindowDuration picks the bounded extract length. The client
|
||||
// overrides via ?duration=; absent that we use a 10-minute window,
|
||||
// which is long enough that a single fetch covers many minutes of
|
||||
// uninterrupted playback but short enough that the ffmpeg process
|
||||
// finishes (and frees its input handle) well before the next window
|
||||
// is requested.
|
||||
// subtitleWindowDuration picks the compatibility duration argument. The
|
||||
// client overrides via ?duration=; absent that we pass 10 minutes. ffmpeg
|
||||
// currently ignores this input-side -t for subtitle extracts and runs to EOF;
|
||||
// changing it would alter the whole-track response native clients depend on.
|
||||
func subtitleWindowDuration(r *http.Request) float64 {
|
||||
const defaultDuration = 600.0
|
||||
const maxDuration = 3600.0
|
||||
|
||||
@@ -7,17 +7,13 @@ import (
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/go-chi/chi/v5"
|
||||
|
||||
"github.com/Silo-Server/silo-server/internal/config"
|
||||
"github.com/Silo-Server/silo-server/internal/models"
|
||||
"github.com/Silo-Server/silo-server/internal/playback"
|
||||
"github.com/Silo-Server/silo-server/internal/subtitles"
|
||||
)
|
||||
|
||||
type hookedSessionManager struct {
|
||||
@@ -201,77 +197,6 @@ func TestHandleStream_KeepsSessionWhenLookupFailsForNonMissingReason(t *testing.
|
||||
}
|
||||
}
|
||||
|
||||
// A v3 plan for an audio-only source promises audio/mp4, because a
|
||||
// declared-tier client probes the advertised MIME with isTypeSupported before
|
||||
// it will attach a source buffer and "video/mp4" for a stream carrying no video
|
||||
// track is exactly the mismatch that makes that probe lie. The remux response
|
||||
// has to keep the promise the plan made.
|
||||
func TestHandleStream_AudioOnlyRemuxServesAudioContentType(t *testing.T) {
|
||||
for _, tc := range []struct {
|
||||
name string
|
||||
file *models.MediaFile
|
||||
wantContent string
|
||||
}{
|
||||
{
|
||||
name: "audio only source",
|
||||
file: &models.MediaFile{
|
||||
ID: 42,
|
||||
ContentID: "audiobook-1",
|
||||
BaseType: "audiobook",
|
||||
CodecAudio: "flac",
|
||||
Duration: 39600,
|
||||
},
|
||||
wantContent: playback.AudioOnlyRemuxMIMEV3,
|
||||
},
|
||||
{
|
||||
name: "video source",
|
||||
file: &models.MediaFile{
|
||||
ID: 42,
|
||||
ContentID: "movie-1",
|
||||
CodecVideo: "h264",
|
||||
CodecAudio: "flac",
|
||||
VideoTracks: []models.VideoTrack{{Codec: "h264"}},
|
||||
Duration: 3600,
|
||||
},
|
||||
wantContent: "video/mp4",
|
||||
},
|
||||
} {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
file := *tc.file
|
||||
file.FilePath = writePlaybackTestMediaFile(t, "source.mkv")
|
||||
|
||||
sessionMgr := playback.NewSessionManager(0, 0)
|
||||
session, err := sessionMgr.StartSession(1, "profile-1", file.ID, playback.PlayRemux, true)
|
||||
if err != nil {
|
||||
t.Fatalf("StartSession: %v", err)
|
||||
}
|
||||
|
||||
ffmpeg := filepath.Join(t.TempDir(), "ffmpeg")
|
||||
if err := os.WriteFile(ffmpeg, []byte("#!/bin/sh\nprintf muxed\n"), 0o755); err != nil {
|
||||
t.Fatalf("write fake ffmpeg: %v", err)
|
||||
}
|
||||
handler := NewStreamHandler(sessionMgr, testPlaybackFileResolver{file: &file})
|
||||
handler.PlaybackConfig = func() config.PlaybackConfig {
|
||||
return config.PlaybackConfig{FFmpegPath: ffmpeg}
|
||||
}
|
||||
|
||||
req := httptest.NewRequest(http.MethodGet, "/api/v1/stream/"+session.ID, nil)
|
||||
req = req.WithContext(newAuthorizedPlaybackContext())
|
||||
req = withPlaybackRouteParam(req, "session_id", session.ID)
|
||||
|
||||
rr := httptest.NewRecorder()
|
||||
handler.HandleStream(rr, req)
|
||||
|
||||
if rr.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, body = %s", rr.Code, rr.Body.String())
|
||||
}
|
||||
if got := rr.Header().Get("Content-Type"); got != tc.wantContent {
|
||||
t.Fatalf("Content-Type = %q, want %q", got, tc.wantContent)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestHandleSubtitle_ListDownloadedSubtitlesErrorReturns500 pins the fix for
|
||||
// issue #248: a failure listing downloaded subtitles must surface as a 500 with
|
||||
// an "internal_error" code, not be swallowed and reported to the client as a
|
||||
@@ -321,53 +246,6 @@ func TestHandleSubtitle_ListDownloadedSubtitlesErrorReturns500(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleSubtitleUsesBoundDownloadedIdentityAfterInventoryReorder(t *testing.T) {
|
||||
file := &models.MediaFile{ID: 42, ContentID: "movie-1", FilePath: "/tmp/movie.mkv", Duration: 3600}
|
||||
baseMgr := playback.NewSessionManager(0, 0)
|
||||
session, err := baseMgr.StartSession(1, "profile-1", 42, playback.PlayDirect, false)
|
||||
if err != nil {
|
||||
t.Fatalf("StartSession: %v", err)
|
||||
}
|
||||
repo := newMockSubtitleRepoForHandler()
|
||||
repo.subtitles[71] = &subtitles.DownloadedSubtitle{ID: 71, MediaFileID: 42, Format: subtitles.FormatVTT, S3Key: "selected-71.vtt"}
|
||||
// The mutable ordinal now points at a different subtitle. An ID-bound URL
|
||||
// must still fetch 71 without consulting this reordered list.
|
||||
repo.list = []subtitles.DownloadedSubtitle{
|
||||
{ID: 72, MediaFileID: 42, Format: subtitles.FormatVTT, S3Key: "other-72.vtt"},
|
||||
{ID: 71, MediaFileID: 42, Format: subtitles.FormatVTT, S3Key: "selected-71.vtt"},
|
||||
}
|
||||
handler := NewStreamHandler(baseMgr, testPlaybackFileResolver{file: file})
|
||||
handler.SubtitleRepo = repo
|
||||
handler.S3Client = subtitleContentS3Client{objects: map[string][]byte{
|
||||
"selected-71.vtt": []byte("WEBVTT\n\n00:00.000 --> 00:01.000\nselected-71\n"),
|
||||
"other-72.vtt": []byte("WEBVTT\n\n00:00.000 --> 00:01.000\nother-72\n"),
|
||||
}}
|
||||
handler.S3Bucket = "test-bucket"
|
||||
|
||||
req := httptest.NewRequest(http.MethodGet, "/api/v1/stream/"+session.ID+"/subtitles/0.vtt?file_id=42&downloaded_subtitle_id=71", nil)
|
||||
req = req.WithContext(newAuthorizedPlaybackContext())
|
||||
routeCtx := chi.NewRouteContext()
|
||||
routeCtx.URLParams.Add("session_id", session.ID)
|
||||
routeCtx.URLParams.Add("track", "0.vtt")
|
||||
req = req.WithContext(context.WithValue(req.Context(), chi.RouteCtxKey, routeCtx))
|
||||
|
||||
rr := httptest.NewRecorder()
|
||||
handler.HandleSubtitle(rr, req)
|
||||
if rr.Code != http.StatusOK || !strings.Contains(rr.Body.String(), "selected-71") || strings.Contains(rr.Body.String(), "other-72") {
|
||||
t.Fatalf("status = %d, body = %q", rr.Code, rr.Body.String())
|
||||
}
|
||||
}
|
||||
|
||||
type subtitleContentS3Client struct {
|
||||
objects map[string][]byte
|
||||
}
|
||||
|
||||
func (subtitleContentS3Client) PutObject(context.Context, string, string, []byte) error { return nil }
|
||||
func (c subtitleContentS3Client) GetObject(_ context.Context, _, key string) ([]byte, error) {
|
||||
return append([]byte(nil), c.objects[key]...), nil
|
||||
}
|
||||
func (subtitleContentS3Client) DeleteObject(context.Context, string, string) error { return nil }
|
||||
|
||||
func TestHandleSubtitle_NilMediaFileReturns404(t *testing.T) {
|
||||
baseMgr := playback.NewSessionManager(0, 0)
|
||||
session, err := baseMgr.StartSession(1, "profile-1", 42, playback.PlayDirect, false)
|
||||
@@ -436,166 +314,6 @@ func TestHandleSubtitle_BitmapTrackVTTRequestReturns415(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleSubtitle_ExternalTextTrackSRTRequestReturnsVTT(t *testing.T) {
|
||||
subtitlePath := filepath.Join(t.TempDir(), "movie.en.srt")
|
||||
if err := os.WriteFile(subtitlePath, []byte("1\n00:00:01,000 --> 00:00:02,000\nHello\n"), 0o644); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
file := &models.MediaFile{
|
||||
ID: 42,
|
||||
ContentID: "movie-1",
|
||||
FilePath: "/tmp/movie.mkv",
|
||||
Duration: 3600,
|
||||
ExternalSubtitles: []models.ExternalSubtitle{
|
||||
{Path: subtitlePath, Language: "eng", Format: "srt"},
|
||||
},
|
||||
}
|
||||
baseMgr := playback.NewSessionManager(0, 0)
|
||||
session, err := baseMgr.StartSession(1, "profile-1", 42, playback.PlayDirect, false)
|
||||
if err != nil {
|
||||
t.Fatalf("StartSession: %v", err)
|
||||
}
|
||||
handler := NewStreamHandler(baseMgr, testPlaybackFileResolver{file: file})
|
||||
req := httptest.NewRequest(http.MethodGet, "/api/v1/stream/"+session.ID+"/subtitles/0.srt", nil)
|
||||
req = req.WithContext(newAuthorizedPlaybackContext())
|
||||
routeCtx := chi.NewRouteContext()
|
||||
routeCtx.URLParams.Add("session_id", session.ID)
|
||||
routeCtx.URLParams.Add("track", "0.srt")
|
||||
req = req.WithContext(context.WithValue(req.Context(), chi.RouteCtxKey, routeCtx))
|
||||
rr := httptest.NewRecorder()
|
||||
handler.HandleSubtitle(rr, req)
|
||||
if rr.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, content-type = %q, body = %s; want 200", rr.Code, rr.Header().Get("Content-Type"), rr.Body.String())
|
||||
}
|
||||
if got := rr.Header().Get("Content-Type"); !strings.HasPrefix(got, "text/vtt") {
|
||||
t.Fatalf("content type = %q, want WebVTT", got)
|
||||
}
|
||||
if body := rr.Body.String(); !strings.HasPrefix(body, "WEBVTT") || !strings.Contains(body, "Hello") {
|
||||
t.Fatalf("body = %q, want converted WebVTT", body)
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleSubtitle_ExternalASSTrackASSRequestReturnsRawASS(t *testing.T) {
|
||||
const assBody = "[Script Info]\nTitle: Test\n"
|
||||
subtitlePath := filepath.Join(t.TempDir(), "movie.en.ass")
|
||||
if err := os.WriteFile(subtitlePath, []byte(assBody), 0o644); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
file := &models.MediaFile{
|
||||
ID: 42,
|
||||
ContentID: "movie-1",
|
||||
FilePath: "/tmp/movie.mkv",
|
||||
Duration: 3600,
|
||||
ExternalSubtitles: []models.ExternalSubtitle{{Path: subtitlePath, Language: "eng", Format: "ass"}},
|
||||
}
|
||||
baseMgr := playback.NewSessionManager(0, 0)
|
||||
session, err := baseMgr.StartSession(1, "profile-1", 42, playback.PlayDirect, false)
|
||||
if err != nil {
|
||||
t.Fatalf("StartSession: %v", err)
|
||||
}
|
||||
handler := NewStreamHandler(baseMgr, testPlaybackFileResolver{file: file})
|
||||
req := httptest.NewRequest(http.MethodGet, "/api/v1/stream/"+session.ID+"/subtitles/0.ass", nil)
|
||||
req = req.WithContext(newAuthorizedPlaybackContext())
|
||||
routeCtx := chi.NewRouteContext()
|
||||
routeCtx.URLParams.Add("session_id", session.ID)
|
||||
routeCtx.URLParams.Add("track", "0.ass")
|
||||
req = req.WithContext(context.WithValue(req.Context(), chi.RouteCtxKey, routeCtx))
|
||||
rr := httptest.NewRecorder()
|
||||
handler.HandleSubtitle(rr, req)
|
||||
if rr.Code != http.StatusOK || rr.Body.String() != assBody {
|
||||
t.Fatalf("status = %d, content-type = %q, body = %q; want raw ASS", rr.Code, rr.Header().Get("Content-Type"), rr.Body.String())
|
||||
}
|
||||
if got := rr.Header().Get("Content-Type"); !strings.HasPrefix(got, "text/x-ssa") {
|
||||
t.Fatalf("content type = %q, want raw ASS", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleSubtitle_ExternalTextHEADDoesNotLoadTheArtifact(t *testing.T) {
|
||||
file := &models.MediaFile{
|
||||
ID: 42,
|
||||
ContentID: "movie-1",
|
||||
FilePath: "/missing/movie.mkv",
|
||||
Duration: 3600,
|
||||
ExternalSubtitles: []models.ExternalSubtitle{{Path: "/missing/movie.en.srt", Language: "eng", Format: "srt"}},
|
||||
}
|
||||
baseMgr := playback.NewSessionManager(0, 0)
|
||||
session, err := baseMgr.StartSession(1, "profile-1", file.ID, playback.PlayDirect, false)
|
||||
if err != nil {
|
||||
t.Fatalf("StartSession: %v", err)
|
||||
}
|
||||
handler := NewStreamHandler(baseMgr, testPlaybackFileResolver{file: file})
|
||||
req := httptest.NewRequest(http.MethodHead, "/api/v1/stream/"+session.ID+"/subtitles/0.vtt", nil)
|
||||
req = req.WithContext(newAuthorizedPlaybackContext())
|
||||
routeCtx := chi.NewRouteContext()
|
||||
routeCtx.URLParams.Add("session_id", session.ID)
|
||||
routeCtx.URLParams.Add("track", "0.vtt")
|
||||
req = req.WithContext(context.WithValue(req.Context(), chi.RouteCtxKey, routeCtx))
|
||||
rr := httptest.NewRecorder()
|
||||
handler.HandleSubtitle(rr, req)
|
||||
|
||||
if rr.Code != http.StatusOK || rr.Body.Len() != 0 || !strings.HasPrefix(rr.Header().Get("Content-Type"), "text/vtt") {
|
||||
t.Fatalf("HEAD status=%d type=%q body=%q", rr.Code, rr.Header().Get("Content-Type"), rr.Body.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleSubtitle_EmbeddedPGSSupportsCachedHEADAndRange(t *testing.T) {
|
||||
file := &models.MediaFile{
|
||||
ID: 42,
|
||||
ContentID: "movie-1",
|
||||
FilePath: writePlaybackTestMediaFile(t, "movie.mkv"),
|
||||
Duration: 3600,
|
||||
// The external track deliberately occupies combined ordinal 0. The PGS
|
||||
// container track is therefore addressed as ordinal 1, even though its
|
||||
// embedded subtitle-stream index is 0.
|
||||
ExternalSubtitles: []models.ExternalSubtitle{{Path: "/tmp/movie.en.srt", Format: "srt"}},
|
||||
SubtitleTracks: []models.SubtitleTrack{{Index: 2, Language: "eng", Codec: "hdmv_pgs_subtitle"}},
|
||||
}
|
||||
baseMgr := playback.NewSessionManager(0, 0)
|
||||
session, err := baseMgr.StartSession(1, "profile-1", file.ID, playback.PlayDirect, false)
|
||||
if err != nil {
|
||||
t.Fatalf("StartSession: %v", err)
|
||||
}
|
||||
cacheRoot := t.TempDir()
|
||||
cache := playback.NewSubtitleCache(func() string { return cacheRoot })
|
||||
warmReq := httptest.NewRequest(http.MethodGet, "/sub.sup", nil)
|
||||
warmRR := httptest.NewRecorder()
|
||||
if err := cache.ServeSUPExtract(warmRR, warmReq, playback.StreamExtractOpts{
|
||||
InputPath: file.FilePath, TrackIndex: 0, SourceCodec: "hdmv_pgs_subtitle",
|
||||
}, func(_ context.Context, opts playback.StreamExtractOpts) error {
|
||||
_, err := opts.Writer.Write([]byte("SUP PAYLOAD"))
|
||||
return err
|
||||
}); err != nil {
|
||||
t.Fatalf("warm PGS cache: %v", err)
|
||||
}
|
||||
|
||||
handler := NewStreamHandler(baseMgr, testPlaybackFileResolver{file: file})
|
||||
handler.SubtitleCache = cache
|
||||
request := func(method, rangeHeader string) *httptest.ResponseRecorder {
|
||||
t.Helper()
|
||||
req := httptest.NewRequest(method, "/api/v1/stream/"+session.ID+"/subtitles/1.sup?file_id=42", nil)
|
||||
req = req.WithContext(newAuthorizedPlaybackContext())
|
||||
if rangeHeader != "" {
|
||||
req.Header.Set("Range", rangeHeader)
|
||||
}
|
||||
routeCtx := chi.NewRouteContext()
|
||||
routeCtx.URLParams.Add("session_id", session.ID)
|
||||
routeCtx.URLParams.Add("track", "1.sup")
|
||||
req = req.WithContext(context.WithValue(req.Context(), chi.RouteCtxKey, routeCtx))
|
||||
rr := httptest.NewRecorder()
|
||||
handler.HandleSubtitle(rr, req)
|
||||
return rr
|
||||
}
|
||||
|
||||
head := request(http.MethodHead, "")
|
||||
if head.Code != http.StatusOK || head.Body.Len() != 0 || head.Header().Get("Content-Type") != "application/octet-stream" || head.Header().Get("Content-Length") != "11" {
|
||||
t.Fatalf("HEAD status=%d type=%q length=%q body=%q", head.Code, head.Header().Get("Content-Type"), head.Header().Get("Content-Length"), head.Body.String())
|
||||
}
|
||||
ranged := request(http.MethodGet, "bytes=4-10")
|
||||
if ranged.Code != http.StatusPartialContent || ranged.Body.String() != "PAYLOAD" || ranged.Header().Get("Content-Type") != "application/octet-stream" {
|
||||
t.Fatalf("Range status=%d type=%q body=%q", ranged.Code, ranged.Header().Get("Content-Type"), ranged.Body.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestSubtitleSourceFileIDPinsURLAcrossEffectiveFileSwitch(t *testing.T) {
|
||||
session := &playback.Session{MediaFileID: 200, RequestedMediaFileID: 100}
|
||||
|
||||
|
||||
@@ -1,54 +0,0 @@
|
||||
package handlers
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
|
||||
"github.com/Silo-Server/silo-server/internal/models"
|
||||
"github.com/Silo-Server/silo-server/internal/playback"
|
||||
"github.com/Silo-Server/silo-server/internal/subtitles"
|
||||
)
|
||||
|
||||
// SubtitleInventoryResolver supplies the playback package with the two
|
||||
// repositories it needs to rebuild a file's combined-ordinal subtitle
|
||||
// inventory outside a request: the media file itself and the downloaded
|
||||
// subtitle rows that occupy the tail of the ordinal space.
|
||||
//
|
||||
// It exists so realtime subtitle events can publish the ordinal a newly
|
||||
// generated track will hold in the next plan, instead of leaving each client to
|
||||
// reconstruct one by counting the tracks it can see.
|
||||
type SubtitleInventoryResolver struct {
|
||||
files FilePathResolver
|
||||
subtitles subtitles.Repository
|
||||
}
|
||||
|
||||
// NewSubtitleInventoryResolver returns a resolver, or nil when no file lookup
|
||||
// is available. A nil subtitle repository is fine: the inventory then covers
|
||||
// only the file's external and embedded tracks.
|
||||
func NewSubtitleInventoryResolver(files FilePathResolver, repo subtitles.Repository) *SubtitleInventoryResolver {
|
||||
if files == nil {
|
||||
return nil
|
||||
}
|
||||
return &SubtitleInventoryResolver{files: files, subtitles: repo}
|
||||
}
|
||||
|
||||
// MediaFile loads the file whose subtitle inventory is being resolved.
|
||||
func (r *SubtitleInventoryResolver) MediaFile(ctx context.Context, fileID int) (*models.MediaFile, error) {
|
||||
if r == nil || r.files == nil {
|
||||
return nil, errors.New("subtitle inventory resolver has no media file lookup")
|
||||
}
|
||||
return r.files.GetByID(ctx, fileID)
|
||||
}
|
||||
|
||||
// AdditionalSubtitles returns the downloaded and generated tracks that follow
|
||||
// the file's external and embedded tracks in the combined ordinal space.
|
||||
func (r *SubtitleInventoryResolver) AdditionalSubtitles(ctx context.Context, file *models.MediaFile) ([]playback.SubtitleInventoryEntryV3, error) {
|
||||
if r == nil || r.subtitles == nil || file == nil {
|
||||
return nil, nil
|
||||
}
|
||||
downloaded, err := r.subtitles.ListDownloadedSubtitles(ctx, file.ID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return downloadedSubtitleEntriesV3(file, downloaded), nil
|
||||
}
|
||||
@@ -98,62 +98,6 @@ func (h *SubtitleSearchHandler) authorizeMediaFile(w http.ResponseWriter, r *htt
|
||||
return authorizeMediaFileAccess(w, r, h.FileAuthorizer, fileID)
|
||||
}
|
||||
|
||||
// subtitleProviderStatusResponse tells a client whether this deployment can
|
||||
// search external subtitle providers at all, following the per-subsystem
|
||||
// capability convention (/subtitles/ai/status, /items/trailers/capability).
|
||||
//
|
||||
// Without it a search on a server with no providers configured answers exactly
|
||||
// like a search that ran and matched nothing, so a player has no way to tell
|
||||
// "this server cannot do that" from "nothing found for this file" and ends up
|
||||
// offering an entry point that can never succeed. A client that finds enabled
|
||||
// false should disable the search action and say why rather than let the user
|
||||
// run a query that is guaranteed to come back empty.
|
||||
//
|
||||
// Provider names are safe to return to any authenticated viewer: they already
|
||||
// travel in every SubtitleResult.provider and DownloadedSubtitle.provider. The
|
||||
// credentials behind them stay in the admin-only provider config.
|
||||
type subtitleProviderStatusResponse struct {
|
||||
SchemaVersion int `json:"schema_version"`
|
||||
// Enabled reports that at least one provider is registered, so
|
||||
// POST /subtitles/search can actually reach an upstream.
|
||||
Enabled bool `json:"enabled"`
|
||||
// Providers is the registered provider identifiers, sorted. Always a
|
||||
// list — empty rather than null — so clients can iterate it unguarded.
|
||||
Providers []string `json:"providers"`
|
||||
}
|
||||
|
||||
// HandleProviderStatus reports whether external subtitle search is available
|
||||
// here, so the player can show or hide the entry point.
|
||||
// GET /api/v1/subtitles/providers/status
|
||||
//
|
||||
// It answers even when the subtitle subsystem is unwired, because enabled:false
|
||||
// is the answer in that case; the router registers a fallback so a client never
|
||||
// has to interpret a 404 on the probe itself.
|
||||
func (h *SubtitleSearchHandler) HandleProviderStatus(w http.ResponseWriter, _ *http.Request) {
|
||||
providers := []string{}
|
||||
if h != nil && h.manager != nil {
|
||||
providers = h.manager.ProviderNames()
|
||||
}
|
||||
writeJSON(w, http.StatusOK, subtitleProviderStatusResponse{
|
||||
SchemaVersion: 1,
|
||||
Enabled: len(providers) > 0,
|
||||
Providers: providers,
|
||||
})
|
||||
}
|
||||
|
||||
// WriteSubtitleProvidersDisabledStatus answers the subtitle provider capability
|
||||
// probe with a 200 {"enabled": false, "providers": []} when no subtitle handler
|
||||
// is wired, so the client gets a clean negative instead of a 404 (the 2-segment
|
||||
// /providers/status path is not shadowed by the 1-segment /{media_file_id}
|
||||
// route — they never compete in chi's router).
|
||||
func WriteSubtitleProvidersDisabledStatus(w http.ResponseWriter, _ *http.Request) {
|
||||
writeJSON(w, http.StatusOK, subtitleProviderStatusResponse{
|
||||
SchemaVersion: 1,
|
||||
Enabled: false,
|
||||
Providers: []string{},
|
||||
})
|
||||
}
|
||||
|
||||
// HandleSearch handles POST /api/v1/subtitles/search
|
||||
func (h *SubtitleSearchHandler) HandleSearch(w http.ResponseWriter, r *http.Request) {
|
||||
var req searchSubtitlesRequest
|
||||
|
||||
@@ -235,122 +235,13 @@ func TestHandleDeleteRequiresAccessToMediaFile(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
// stubSubtitleProvider is a registerable no-op provider; only its name matters
|
||||
// to the capability probe.
|
||||
type stubSubtitleProvider struct {
|
||||
name string
|
||||
}
|
||||
|
||||
func (s stubSubtitleProvider) Name() string { return s.name }
|
||||
|
||||
func (s stubSubtitleProvider) Search(context.Context, subtitles.SearchRequest) ([]subtitles.SubtitleResult, error) {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
func (s stubSubtitleProvider) Download(context.Context, string) ([]byte, subtitles.SubtitleFormat, error) {
|
||||
return nil, subtitles.FormatSRT, nil
|
||||
}
|
||||
|
||||
func decodeProviderStatus(t *testing.T, rr *httptest.ResponseRecorder) struct {
|
||||
SchemaVersion int `json:"schema_version"`
|
||||
Enabled bool `json:"enabled"`
|
||||
Providers []string `json:"providers"`
|
||||
} {
|
||||
t.Helper()
|
||||
|
||||
var resp struct {
|
||||
SchemaVersion int `json:"schema_version"`
|
||||
Enabled bool `json:"enabled"`
|
||||
Providers []string `json:"providers"`
|
||||
}
|
||||
if rr.Code != http.StatusOK {
|
||||
t.Fatalf("status = %d, body = %s", rr.Code, rr.Body.String())
|
||||
}
|
||||
if err := json.Unmarshal(rr.Body.Bytes(), &resp); err != nil {
|
||||
t.Fatalf("decode response: %v", err)
|
||||
}
|
||||
if resp.SchemaVersion != 1 {
|
||||
t.Fatalf("schema_version = %d, want 1", resp.SchemaVersion)
|
||||
}
|
||||
return resp
|
||||
}
|
||||
|
||||
func TestHandleProviderStatusWithoutProviders(t *testing.T) {
|
||||
repo := newMockSubtitleRepoForHandler()
|
||||
manager := subtitles.NewManager(repo, newMockS3ClientForHandler(), "test-bucket")
|
||||
handler := NewSubtitleSearchHandler(manager, repo, stubSubtitleMediaResolver{})
|
||||
|
||||
rr := httptest.NewRecorder()
|
||||
handler.HandleProviderStatus(rr, newSubtitleAuthRequest(http.MethodGet, "/subtitles/providers/status", nil))
|
||||
|
||||
resp := decodeProviderStatus(t, rr)
|
||||
if resp.Enabled {
|
||||
t.Fatal("enabled = true, want false with no providers registered")
|
||||
}
|
||||
if len(resp.Providers) != 0 {
|
||||
t.Fatalf("providers = %v, want empty", resp.Providers)
|
||||
}
|
||||
// The empty list must reach the wire as [] — a null would read to a
|
||||
// client as a missing field rather than "no providers here".
|
||||
if !bytes.Contains(rr.Body.Bytes(), []byte(`"providers":[]`)) {
|
||||
t.Fatalf("body = %s, want providers serialized as []", rr.Body.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandleProviderStatusWithProviders(t *testing.T) {
|
||||
repo := newMockSubtitleRepoForHandler()
|
||||
manager := subtitles.NewManager(repo, newMockS3ClientForHandler(), "test-bucket")
|
||||
manager.RegisterProvider(stubSubtitleProvider{name: "subdl"})
|
||||
manager.RegisterProvider(stubSubtitleProvider{name: "opensubtitles"})
|
||||
handler := NewSubtitleSearchHandler(manager, repo, stubSubtitleMediaResolver{})
|
||||
|
||||
rr := httptest.NewRecorder()
|
||||
handler.HandleProviderStatus(rr, newSubtitleAuthRequest(http.MethodGet, "/subtitles/providers/status", nil))
|
||||
|
||||
resp := decodeProviderStatus(t, rr)
|
||||
if !resp.Enabled {
|
||||
t.Fatal("enabled = false, want true with providers registered")
|
||||
}
|
||||
want := []string{"opensubtitles", "subdl"}
|
||||
if len(resp.Providers) != len(want) {
|
||||
t.Fatalf("providers = %v, want %v", resp.Providers, want)
|
||||
}
|
||||
for i, name := range want {
|
||||
if resp.Providers[i] != name {
|
||||
t.Fatalf("providers = %v, want %v (sorted)", resp.Providers, want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestWriteSubtitleProvidersDisabledStatus(t *testing.T) {
|
||||
rr := httptest.NewRecorder()
|
||||
WriteSubtitleProvidersDisabledStatus(rr, newSubtitleAuthRequest(http.MethodGet, "/subtitles/providers/status", nil))
|
||||
|
||||
resp := decodeProviderStatus(t, rr)
|
||||
if resp.Enabled {
|
||||
t.Fatal("enabled = true, want false from the disabled fallback")
|
||||
}
|
||||
if len(resp.Providers) != 0 {
|
||||
t.Fatalf("providers = %v, want empty", resp.Providers)
|
||||
}
|
||||
if !bytes.Contains(rr.Body.Bytes(), []byte(`"providers":[]`)) {
|
||||
t.Fatalf("body = %s, want providers serialized as []", rr.Body.String())
|
||||
}
|
||||
}
|
||||
|
||||
type handlerMockSubtitleRepo struct {
|
||||
subtitles map[int]*subtitles.DownloadedSubtitle
|
||||
nextID int
|
||||
byKey map[string]*subtitles.DownloadedSubtitle
|
||||
// getErr, when set, is returned by GetDownloadedSubtitle to simulate a
|
||||
// backing-store failure.
|
||||
getErr error
|
||||
// listErr, when set, is returned by ListDownloadedSubtitles to simulate a
|
||||
// backing-store failure.
|
||||
listErr error
|
||||
list []subtitles.DownloadedSubtitle
|
||||
listResults [][]subtitles.DownloadedSubtitle
|
||||
listCalls int
|
||||
listErr error
|
||||
}
|
||||
|
||||
func newMockSubtitleRepoForHandler() *handlerMockSubtitleRepo {
|
||||
@@ -369,9 +260,6 @@ func (m *handlerMockSubtitleRepo) InsertDownloadedSubtitle(_ context.Context, su
|
||||
}
|
||||
|
||||
func (m *handlerMockSubtitleRepo) GetDownloadedSubtitle(_ context.Context, id int) (*subtitles.DownloadedSubtitle, error) {
|
||||
if m.getErr != nil {
|
||||
return nil, m.getErr
|
||||
}
|
||||
if sub, ok := m.subtitles[id]; ok {
|
||||
copy := *sub
|
||||
return ©, nil
|
||||
@@ -380,15 +268,10 @@ func (m *handlerMockSubtitleRepo) GetDownloadedSubtitle(_ context.Context, id in
|
||||
}
|
||||
|
||||
func (m *handlerMockSubtitleRepo) ListDownloadedSubtitles(context.Context, int) ([]subtitles.DownloadedSubtitle, error) {
|
||||
m.listCalls++
|
||||
if m.listErr != nil {
|
||||
return nil, m.listErr
|
||||
}
|
||||
if len(m.listResults) > 0 {
|
||||
index := min(m.listCalls-1, len(m.listResults)-1)
|
||||
return append([]subtitles.DownloadedSubtitle(nil), m.listResults[index]...), nil
|
||||
}
|
||||
return append([]subtitles.DownloadedSubtitle(nil), m.list...), nil
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
func (m *handlerMockSubtitleRepo) DeleteDownloadedSubtitle(_ context.Context, id int) (*subtitles.DownloadedSubtitle, error) {
|
||||
|
||||
@@ -75,7 +75,6 @@ type userImportSharedFields struct {
|
||||
PosterURL string `json:"poster_url"`
|
||||
LibraryIDs []int `json:"library_ids,omitempty"`
|
||||
DisplayQueryDefinition json.RawMessage `json:"display_query_definition,omitempty"`
|
||||
SortConfig json.RawMessage `json:"sort_config,omitempty"`
|
||||
}
|
||||
|
||||
type userImportMDBListRequest struct {
|
||||
@@ -218,11 +217,6 @@ func (h *UserCollectionImportHandler) createImportedCollection(
|
||||
writeError(w, http.StatusBadRequest, "bad_request", err.Error())
|
||||
return
|
||||
}
|
||||
sortConfig, err := NormalizeCollectionSortConfig(shared.SortConfig, true)
|
||||
if err != nil {
|
||||
writeError(w, http.StatusBadRequest, "bad_request", err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
collection, err := store.CreateCollection(r.Context(), userstore.CreateCollectionInput{
|
||||
CreatorProfileID: profileID,
|
||||
@@ -231,7 +225,7 @@ func (h *UserCollectionImportHandler) createImportedCollection(
|
||||
CollectionType: collectionType,
|
||||
IsShared: shared.IsShared,
|
||||
QueryDefinition: "{}",
|
||||
SortConfig: sortConfig,
|
||||
SortConfig: "{}",
|
||||
SourceURL: cfg.DisplayURL(),
|
||||
SourceConfig: sourceConfigJSON,
|
||||
SyncSchedule: schedule,
|
||||
|
||||
@@ -6,7 +6,6 @@ import (
|
||||
"errors"
|
||||
"net/http"
|
||||
"strconv"
|
||||
"time"
|
||||
|
||||
apimw "github.com/Silo-Server/silo-server/internal/api/middleware"
|
||||
"github.com/Silo-Server/silo-server/internal/watchsync"
|
||||
@@ -28,15 +27,6 @@ type WatchProviderHandler struct {
|
||||
service WatchProviderService
|
||||
}
|
||||
|
||||
type watchProviderDeviceAuthResponse struct {
|
||||
ID string `json:"id"`
|
||||
Provider string `json:"provider"`
|
||||
UserCode string `json:"user_code"`
|
||||
VerificationURL string `json:"verification_url"`
|
||||
IntervalSeconds int `json:"interval_seconds"`
|
||||
ExpiresAt time.Time `json:"expires_at"`
|
||||
}
|
||||
|
||||
func NewWatchProviderHandler(service WatchProviderService) *WatchProviderHandler {
|
||||
return &WatchProviderHandler{service: service}
|
||||
}
|
||||
@@ -107,14 +97,7 @@ func (h *WatchProviderHandler) HandleStartDeviceAuth(w http.ResponseWriter, r *h
|
||||
writeError(w, http.StatusBadRequest, "watch_provider_error", err.Error())
|
||||
return
|
||||
}
|
||||
writeJSON(w, http.StatusOK, watchProviderDeviceAuthResponse{
|
||||
ID: session.ID,
|
||||
Provider: session.Provider,
|
||||
UserCode: session.UserCode,
|
||||
VerificationURL: session.VerificationURL,
|
||||
IntervalSeconds: session.IntervalSeconds,
|
||||
ExpiresAt: session.ExpiresAt,
|
||||
})
|
||||
writeJSON(w, http.StatusOK, session)
|
||||
}
|
||||
|
||||
func (h *WatchProviderHandler) HandlePollDeviceAuth(w http.ResponseWriter, r *http.Request) {
|
||||
|
||||
@@ -159,11 +159,6 @@ func TestWatchProviderHandlerStartsDeviceAuthWithFrontendJSONShape(t *testing.T)
|
||||
t.Fatalf("response contains Go-style key %q: %#v", key, resp)
|
||||
}
|
||||
}
|
||||
for _, key := range []string{"device_code", "user_id", "profile_id", "completed_at"} {
|
||||
if _, ok := resp[key]; ok {
|
||||
t.Fatalf("response exposes host-private field %q: %#v", key, resp)
|
||||
}
|
||||
}
|
||||
if resp["id"] != "auth-1" {
|
||||
t.Fatalf("id = %#v, want auth-1", resp["id"])
|
||||
}
|
||||
|
||||
+3
-57
@@ -1037,22 +1037,7 @@ func NewRouter(deps Dependencies) chi.Router {
|
||||
playbackHandler.MarkerUpserter = deps.FileRepo
|
||||
}
|
||||
playbackHandler.MarkerUpdateNotifier = playback.NewMarkerUpdateNotifier(deps.SessionMgr, realtimeHub)
|
||||
// A resolver lets subtitle realtime events carry the combined ordinal
|
||||
// the new track will hold in the next plan. Without a file repository
|
||||
// the notifier still fires; its events just omit the track block.
|
||||
var subtitleInventoryResolver playback.SubtitleInventoryResolver
|
||||
if deps.FileRepo != nil {
|
||||
// subtitleRepo is a concrete pointer: pass it only when non-nil so
|
||||
// the resolver holds a nil interface rather than a typed nil.
|
||||
var subtitleReader subtitles.Repository
|
||||
if subtitleRepo != nil {
|
||||
subtitleReader = subtitleRepo
|
||||
}
|
||||
if resolver := handlers.NewSubtitleInventoryResolver(deps.FileRepo, subtitleReader); resolver != nil {
|
||||
subtitleInventoryResolver = resolver
|
||||
}
|
||||
}
|
||||
subtitleAINotifier = playback.NewSubtitleReadyNotifier(deps.SessionMgr, realtimeHub, subtitleInventoryResolver)
|
||||
subtitleAINotifier = playback.NewSubtitleReadyNotifier(deps.SessionMgr, realtimeHub)
|
||||
adminPlaybackControlHandler = handlers.NewAdminPlaybackControlHandler(playbackHandler)
|
||||
|
||||
if deps.DB != nil && deps.FileRepo != nil && viewerResolver != nil && deps.Config != nil && detailSvc != nil {
|
||||
@@ -1438,14 +1423,6 @@ func NewRouter(deps Dependencies) chi.Router {
|
||||
}
|
||||
|
||||
libraryCollectionRepo := catalog.NewLibraryCollectionRepository(deps.DB)
|
||||
var collectionSortCleaner *userstore.CollectionSortPreferenceCleaner
|
||||
if userRepo != nil && deps.UserStoreProvider != nil {
|
||||
collectionSortCleaner = userstore.NewCollectionSortPreferenceCleaner(userRepo, deps.UserStoreProvider)
|
||||
}
|
||||
if collectionHandler != nil {
|
||||
collectionHandler.LibraryCollections = libraryCollectionRepo
|
||||
}
|
||||
sectionHandler.SortPreferenceCleaner = collectionSortCleaner
|
||||
if libraryCollectionService == nil {
|
||||
libraryCollectionService = catalog.NewLibraryCollectionService(
|
||||
libraryCollectionRepo,
|
||||
@@ -1545,7 +1522,6 @@ func NewRouter(deps Dependencies) chi.Router {
|
||||
libraryCollectionHandler.SectionRepo = sectionRepo
|
||||
libraryCollectionHandler.UserCollectionPool = deps.DB
|
||||
libraryCollectionHandler.EventsHub = deps.EventsHub
|
||||
libraryCollectionHandler.SortPreferenceCleaner = collectionSortCleaner
|
||||
if deps.FolderRepo != nil {
|
||||
libraryCollectionHandler.FolderRepo = deps.FolderRepo
|
||||
} else {
|
||||
@@ -1680,15 +1656,6 @@ func NewRouter(deps Dependencies) chi.Router {
|
||||
// background worker.
|
||||
downloadSvc.SetSubscriptions(downloads.NewSubscriptionRepository(deps.DB))
|
||||
downloadHandler = handlers.NewDownloadHandler(downloadSvc)
|
||||
if deps.NodePlanner != nil {
|
||||
downloadHandler.SetProxyDelivery(deps.NodePlanner, func() string {
|
||||
cfg := deps.CurrentConfig()
|
||||
if cfg == nil {
|
||||
return ""
|
||||
}
|
||||
return cfg.Auth.JWTSecret
|
||||
})
|
||||
}
|
||||
if profileHandler != nil {
|
||||
// Profiles may live outside Postgres (sqlite userdb backend), so
|
||||
// deleting one cannot FK-cascade the shared user_devices table;
|
||||
@@ -2300,8 +2267,6 @@ func NewRouter(deps Dependencies) chi.Router {
|
||||
r.Use(apimw.RequireProfile)
|
||||
r.Get("/", collectionHandler.HandleListCollections)
|
||||
r.Get("/capabilities", collectionHandler.HandleCapabilities)
|
||||
r.Put("/sort-preference", collectionHandler.HandleSetCollectionSortPreference)
|
||||
r.Delete("/sort-preference", collectionHandler.HandleClearCollectionSortPreference)
|
||||
if libraryCollectionHandler != nil {
|
||||
// Aggregated server (admin-curated) collections across
|
||||
// every accessible library. Separate from "/" (personal,
|
||||
@@ -2586,11 +2551,6 @@ func NewRouter(deps Dependencies) chi.Router {
|
||||
}
|
||||
}
|
||||
r.Route("/subtitles", func(r chi.Router) {
|
||||
// Capability probe for external subtitle search. Two
|
||||
// segments on purpose: a bare /providers would shadow
|
||||
// the /{media_file_id} route below, while
|
||||
// /providers/status never competes with it in chi.
|
||||
r.Get("/providers/status", subtitleSearchHandler.HandleProviderStatus)
|
||||
r.Post("/search", subtitleSearchHandler.HandleSearch)
|
||||
r.Post("/download", subtitleSearchHandler.HandleDownload)
|
||||
r.Post("/upload", subtitleSearchHandler.HandleUpload)
|
||||
@@ -2611,17 +2571,6 @@ func NewRouter(deps Dependencies) chi.Router {
|
||||
r.Get("/{media_file_id}", subtitleSearchHandler.HandleList)
|
||||
r.Delete("/{id}", subtitleSearchHandler.HandleDelete)
|
||||
})
|
||||
} else {
|
||||
// The whole group above is conditional (it needs the DB,
|
||||
// S3 and the subtitle repo), so on a storage-less
|
||||
// deployment the capability probe would 404 — leaving a
|
||||
// client to interpret the same ambiguous status the probe
|
||||
// exists to replace. Mount the probe alone, answering
|
||||
// enabled:false, so feature detection always gets a real
|
||||
// answer.
|
||||
r.Route("/subtitles", func(r chi.Router) {
|
||||
r.Get("/providers/status", handlers.WriteSubtitleProvidersDisabledStatus)
|
||||
})
|
||||
}
|
||||
|
||||
// Playback routes.
|
||||
@@ -2650,7 +2599,9 @@ func NewRouter(deps Dependencies) chi.Router {
|
||||
r.Post("/{session_id}/replan", playbackHandler.HandleReplanPlaybackV3)
|
||||
r.Post("/route-events", playbackHandler.HandlePlaybackRouteEventV3)
|
||||
r.Post("/{session_id}/progress", playbackHandler.HandleUpdateProgress)
|
||||
r.Patch("/{session_id}/audio", playbackHandler.HandleChangeAudioTrack)
|
||||
r.Delete("/{session_id}", playbackHandler.HandleStopPlayback)
|
||||
r.Post("/transcode/start", playbackHandler.HandleStartTranscode)
|
||||
})
|
||||
})
|
||||
}
|
||||
@@ -2681,7 +2632,6 @@ func NewRouter(deps Dependencies) chi.Router {
|
||||
r.Get("/stream/{session_id}", streamHandler.HandleStream)
|
||||
r.Head("/stream/{session_id}", streamHandler.HandleStream)
|
||||
r.Get("/stream/{session_id}/subtitles/{track}", streamHandler.HandleSubtitle)
|
||||
r.Head("/stream/{session_id}/subtitles/{track}", streamHandler.HandleSubtitle)
|
||||
r.Get("/stream/{session_id}/subtitles/{track}/fonts", streamHandler.HandleSubtitleFonts)
|
||||
}
|
||||
|
||||
@@ -2708,16 +2658,12 @@ func NewRouter(deps Dependencies) chi.Router {
|
||||
// HEAD natively.
|
||||
r.Get("/{id}/file", downloadHandler.HandleDownloadFile)
|
||||
r.Head("/{id}/file", downloadHandler.HandleDownloadFile)
|
||||
r.Get("/{id}/file-proxy", downloadHandler.HandleDownloadFileViaProxy)
|
||||
r.Head("/{id}/file-proxy", downloadHandler.HandleDownloadFileViaProxy)
|
||||
r.Get("/{id}/manifest", downloadHandler.HandleManifest)
|
||||
r.Get("/{id}/artwork/{kind}", downloadHandler.HandleArtwork)
|
||||
r.Get("/{id}/subtitles/{ref}", downloadHandler.HandleSubtitle)
|
||||
})
|
||||
r.Get("/direct-download", downloadHandler.HandleDirectDownload)
|
||||
r.Head("/direct-download", downloadHandler.HandleDirectDownload)
|
||||
r.Get("/direct-download-proxy", downloadHandler.HandleDirectDownloadViaProxy)
|
||||
r.Head("/direct-download-proxy", downloadHandler.HandleDirectDownloadViaProxy)
|
||||
|
||||
// Recipe gallery catalog (no profile required — purely static metadata).
|
||||
recipeHandler := &handlers.RecipeHandler{}
|
||||
|
||||
@@ -8,8 +8,6 @@ import (
|
||||
"github.com/Silo-Server/silo-server/internal/models"
|
||||
)
|
||||
|
||||
const LibraryCollectionVisibilityVisible = "visible"
|
||||
|
||||
// AccessFilter captures effective viewer access constraints for catalog reads.
|
||||
type AccessFilter struct {
|
||||
AllowedLibraryIDs []int
|
||||
@@ -32,9 +30,6 @@ type AccessFilter struct {
|
||||
SelectedFileID int
|
||||
UserID int
|
||||
ProfileID string
|
||||
// DeviceID identifies the requesting client for device-scoped setting
|
||||
// resolution. It does not participate in catalog access control.
|
||||
DeviceID string
|
||||
// NamePrefix, when non-empty, restricts results to items whose
|
||||
// LOWER(COALESCE(NULLIF(BTRIM(sort_title),''), title)) starts with the
|
||||
// given (case-insensitive) prefix. Pushed into the SQL WHERE clause so
|
||||
@@ -47,29 +42,6 @@ type AccessFilter struct {
|
||||
ExcludedMediaTypes []string
|
||||
}
|
||||
|
||||
// CanAccessLibraryCollection reports whether a visible server collection is
|
||||
// reachable through at least one library in the viewer's effective scope.
|
||||
// Collections without explicit library scope retain their legacy unrestricted
|
||||
// visibility, but restricted viewers cannot address them by ID.
|
||||
func CanAccessLibraryCollection(collection *models.LibraryCollection, filter AccessFilter) bool {
|
||||
if collection == nil || collection.Visibility != LibraryCollectionVisibilityVisible {
|
||||
return false
|
||||
}
|
||||
if len(collection.LibraryIDs) == 0 {
|
||||
return filter.AllowedLibraryIDs == nil && len(filter.DisabledLibraryIDs) == 0
|
||||
}
|
||||
for _, libraryID := range collection.LibraryIDs {
|
||||
if filter.AllowedLibraryIDs != nil && !intInSlice(libraryID, filter.AllowedLibraryIDs) {
|
||||
continue
|
||||
}
|
||||
if intInSlice(libraryID, filter.DisabledLibraryIDs) {
|
||||
continue
|
||||
}
|
||||
return true
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
func applyAccessFilter(alias string, filter AccessFilter, conditions *[]string, args *[]any, argIdx *int) {
|
||||
if filter.MaxContentRating != "" {
|
||||
allowedRatings := access.AllowedRatingsUpTo(filter.MaxContentRating)
|
||||
|
||||
@@ -37,12 +37,6 @@ type CatalogResult struct {
|
||||
SemanticUsed bool
|
||||
FallbackReason string
|
||||
IndexPendingEvents int
|
||||
// EffectiveSort is the order collection sources actually resolved in, after
|
||||
// applying the request's own sort, the viewer's saved override, and the
|
||||
// collection's configured default in that order. An empty Field means the
|
||||
// collection's source order. Only collection sources populate it; clients
|
||||
// use it to show which sort is active when the request carried none.
|
||||
EffectiveSort QuerySort
|
||||
}
|
||||
|
||||
type CatalogFiltersResult struct {
|
||||
@@ -493,25 +487,10 @@ func (r *CatalogResolver) resolveSectionBrowseSource(ctx context.Context, req Ca
|
||||
func (r *CatalogResolver) resolveLibraryCollectionSource(ctx context.Context, req CatalogRequest, access AccessFilter) (*CatalogResult, error) {
|
||||
collectionRepo := NewLibraryCollectionRepository(r.itemRepo.pool)
|
||||
collection, err := collectionRepo.GetByID(ctx, req.CollectionID)
|
||||
if err != nil || !CanAccessLibraryCollection(collection, access) {
|
||||
if err != nil || collection.Visibility != "visible" {
|
||||
return nil, ErrCatalogSourceNotFound
|
||||
}
|
||||
|
||||
return r.resolveCollectionWithEffectiveSort(
|
||||
ctx, req, access, userstore.CollectionKindLibrary, collection.ID, collection.SortConfig,
|
||||
func(req CatalogRequest) (*CatalogResult, error) {
|
||||
return r.resolveLibraryCollectionItems(ctx, req, access, collection, collectionRepo)
|
||||
},
|
||||
)
|
||||
}
|
||||
|
||||
func (r *CatalogResolver) resolveLibraryCollectionItems(
|
||||
ctx context.Context,
|
||||
req CatalogRequest,
|
||||
access AccessFilter,
|
||||
collection *models.LibraryCollection,
|
||||
collectionRepo *LibraryCollectionRepository,
|
||||
) (*CatalogResult, error) {
|
||||
if IsLiveQueryType(collection.CollectionType) {
|
||||
return r.resolveLiveLibraryCollectionSource(ctx, req, access, collection)
|
||||
}
|
||||
@@ -565,55 +544,10 @@ func (r *CatalogResolver) resolveUserCollectionSource(ctx context.Context, req C
|
||||
}
|
||||
|
||||
collection, err := store.GetCollection(ctx, req.CollectionID)
|
||||
if err != nil || !ProfileCanAccessCollection(collection, access.ProfileID) {
|
||||
if err != nil || !catalogProfileCanAccessCollection(collection, access.ProfileID) {
|
||||
return nil, ErrCatalogSourceNotFound
|
||||
}
|
||||
|
||||
return r.resolveCollectionWithEffectiveSort(
|
||||
ctx, req, access, userstore.CollectionKindUser, collection.ID, []byte(collection.SortConfig),
|
||||
func(req CatalogRequest) (*CatalogResult, error) {
|
||||
return r.resolveUserCollectionItems(ctx, req, access, store, collection)
|
||||
},
|
||||
)
|
||||
}
|
||||
|
||||
// resolveCollectionWithEffectiveSort applies the shared collection-sort
|
||||
// precedence, delegates item resolution, and stamps the resolved order on the
|
||||
// response. Keeping this sequence in one place prevents the library and
|
||||
// personal collection paths from drifting.
|
||||
func (r *CatalogResolver) resolveCollectionWithEffectiveSort(
|
||||
ctx context.Context,
|
||||
req CatalogRequest,
|
||||
access AccessFilter,
|
||||
kind, collectionID string,
|
||||
sortConfig []byte,
|
||||
resolve func(CatalogRequest) (*CatalogResult, error),
|
||||
) (*CatalogResult, error) {
|
||||
// A sort in the request is the viewer's live choice and always wins; only
|
||||
// when there is none do the saved override and the collection's configured
|
||||
// default come into play.
|
||||
if req.UseSourceOrder {
|
||||
if qs, ok := r.EffectiveCollectionSort(ctx, access, kind, collectionID, sortConfig); ok {
|
||||
req.Query.Sort = qs
|
||||
req.UseSourceOrder = false
|
||||
}
|
||||
}
|
||||
|
||||
result, err := resolve(req)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result.EffectiveSort = req.Query.Sort
|
||||
return result, nil
|
||||
}
|
||||
|
||||
func (r *CatalogResolver) resolveUserCollectionItems(
|
||||
ctx context.Context,
|
||||
req CatalogRequest,
|
||||
access AccessFilter,
|
||||
store userstore.UserStore,
|
||||
collection *userstore.Collection,
|
||||
) (*CatalogResult, error) {
|
||||
if IsLiveQueryType(collection.CollectionType) {
|
||||
def, err := parseCatalogCollectionQueryDefinition([]byte(collection.QueryDefinition))
|
||||
if err != nil {
|
||||
@@ -1752,10 +1686,7 @@ func (r *CatalogResolver) catalogStoreForAccess(ctx context.Context, access Acce
|
||||
return store, nil
|
||||
}
|
||||
|
||||
// ProfileCanAccessCollection reports whether profileID may view a personal
|
||||
// collection. Creator access is represented in AllowedProfileIDs at write time,
|
||||
// so this is the canonical check for both browse and preference endpoints.
|
||||
func ProfileCanAccessCollection(collection *userstore.Collection, profileID string) bool {
|
||||
func catalogProfileCanAccessCollection(collection *userstore.Collection, profileID string) bool {
|
||||
if collection == nil || strings.TrimSpace(profileID) == "" {
|
||||
return false
|
||||
}
|
||||
@@ -1875,7 +1806,7 @@ func (r *CatalogResolver) loadCollectionSourceBaseItems(ctx context.Context, req
|
||||
case CatalogSourceLibraryCollection:
|
||||
collectionRepo := NewLibraryCollectionRepository(r.itemRepo.pool)
|
||||
collection, err := collectionRepo.GetByID(ctx, req.CollectionID)
|
||||
if err != nil || collection.Visibility != LibraryCollectionVisibilityVisible {
|
||||
if err != nil || collection.Visibility != "visible" {
|
||||
return nil, ErrCatalogSourceNotFound
|
||||
}
|
||||
if IsLiveQueryType(collection.CollectionType) || catalogCollectionUsesLiveQuery(collection.QueryDefinition) {
|
||||
@@ -1906,7 +1837,7 @@ func (r *CatalogResolver) loadCollectionSourceBaseItems(ctx context.Context, req
|
||||
return nil, err
|
||||
}
|
||||
collection, err := store.GetCollection(ctx, req.CollectionID)
|
||||
if err != nil || !ProfileCanAccessCollection(collection, access.ProfileID) {
|
||||
if err != nil || !catalogProfileCanAccessCollection(collection, access.ProfileID) {
|
||||
return nil, ErrCatalogSourceNotFound
|
||||
}
|
||||
var items []*models.MediaItem
|
||||
|
||||
@@ -1,185 +0,0 @@
|
||||
package catalog
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"log/slog"
|
||||
"strings"
|
||||
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
|
||||
"github.com/Silo-Server/silo-server/internal/models"
|
||||
"github.com/Silo-Server/silo-server/internal/userstore"
|
||||
)
|
||||
|
||||
// QueryCollectionItemsBySort loads collection members through the catalog
|
||||
// query executor, applying an optional personal-collection display filter and
|
||||
// the resolved sort before the database limit. This keeps rail queries bounded
|
||||
// without changing the full-match total returned to callers.
|
||||
func QueryCollectionItemsBySort(
|
||||
ctx context.Context,
|
||||
pool *pgxpool.Pool,
|
||||
contentIDs []string,
|
||||
qs QuerySort,
|
||||
access AccessFilter,
|
||||
limit int,
|
||||
displayQueryDefinition string,
|
||||
) ([]*models.MediaItem, int, error) {
|
||||
if len(contentIDs) == 0 {
|
||||
return []*models.MediaItem{}, 0, nil
|
||||
}
|
||||
|
||||
def := QueryDefinition{Sort: qs}
|
||||
if trimmed := strings.TrimSpace(displayQueryDefinition); trimmed != "" {
|
||||
if err := json.Unmarshal([]byte(trimmed), &def); err != nil {
|
||||
return nil, 0, fmt.Errorf("parsing collection display_query_definition: %w", err)
|
||||
}
|
||||
// Display fragments are filter-only. Never let stale or malformed stored
|
||||
// execution fields expand scope, replace the selected sort, or set a
|
||||
// different limit.
|
||||
def.MediaScope = ""
|
||||
def.LibraryIDs = nil
|
||||
def.Sort = qs
|
||||
def.Limit = nil
|
||||
}
|
||||
|
||||
queryAccess := access
|
||||
if access.AllowedContentIDs != nil {
|
||||
queryAccess.AllowedContentIDs = intersectContentIDs(contentIDs, access.AllowedContentIDs)
|
||||
} else {
|
||||
queryAccess.AllowedContentIDs = contentIDs
|
||||
}
|
||||
|
||||
if limit <= 0 || limit > len(contentIDs) {
|
||||
limit = len(contentIDs)
|
||||
}
|
||||
executor := &QueryExecutor{Pool: pool}
|
||||
items, total, err := executor.Preview(ctx, def.Normalize(), queryAccess, limit)
|
||||
if err != nil {
|
||||
return nil, 0, fmt.Errorf("querying collection items by %q: %w", qs.Field, err)
|
||||
}
|
||||
return items, total, nil
|
||||
}
|
||||
|
||||
// EffectiveCollectionSort resolves the order a collection's items are shown in
|
||||
// when the request itself carries no sort. Precedence, highest first:
|
||||
//
|
||||
// 1. the viewing profile's saved override — set by changing the sort while
|
||||
// browsing the collection, and sticky from then on;
|
||||
// 2. the default sort the collection's creator configured (sort_config);
|
||||
// 3. the collection's own source order, signaled by ok == false.
|
||||
//
|
||||
// An override row with an empty sort field is a real choice ("keep source
|
||||
// order") and short-circuits the creator's default, which is why it returns
|
||||
// false rather than falling through.
|
||||
//
|
||||
// Creator defaults for library collections stay user-agnostic because they are
|
||||
// shared. A viewer override is profile-scoped, however, so personalized fields
|
||||
// (progress, date viewed, plays) are valid for either collection kind.
|
||||
func (r *CatalogResolver) EffectiveCollectionSort(
|
||||
ctx context.Context,
|
||||
access AccessFilter,
|
||||
kind string,
|
||||
collectionID string,
|
||||
sortConfig []byte,
|
||||
) (QuerySort, bool) {
|
||||
if pref := r.collectionSortOverride(ctx, access, kind, collectionID); pref != nil {
|
||||
if strings.TrimSpace(pref.SortField) == "" {
|
||||
return QuerySort{}, false
|
||||
}
|
||||
if qs, ok := NormalizeCollectionSort(pref.SortField, pref.SortOrder, true); ok {
|
||||
return qs, true
|
||||
}
|
||||
// A stored override that no longer validates (a sort field retired from
|
||||
// the vocabulary) falls back to the creator's default rather than
|
||||
// failing the browse.
|
||||
}
|
||||
|
||||
return ParseCollectionDefaultSort(sortConfig, kind == userstore.CollectionKindUser)
|
||||
}
|
||||
|
||||
// OrderCollectionItemsBySort reorders already-loaded collection members by a
|
||||
// resolved sort, returning them in that order.
|
||||
//
|
||||
// Ordering runs through the catalog query executor constrained to the member
|
||||
// IDs, so a rail orders items exactly as the collection's browse page does —
|
||||
// same NULLS LAST handling, same sort_title collation — rather than through a
|
||||
// second, drifting in-memory comparator. An empty sort field returns items
|
||||
// untouched (source order). Items the executor does not return (no longer
|
||||
// visible to this access scope) are dropped, matching the browse path.
|
||||
func OrderCollectionItemsBySort(
|
||||
ctx context.Context,
|
||||
pool *pgxpool.Pool,
|
||||
items []*models.MediaItem,
|
||||
qs QuerySort,
|
||||
access AccessFilter,
|
||||
) ([]*models.MediaItem, error) {
|
||||
if strings.TrimSpace(qs.Field) == "" || len(items) == 0 {
|
||||
return items, nil
|
||||
}
|
||||
|
||||
ids := make([]string, 0, len(items))
|
||||
for _, item := range items {
|
||||
if item != nil && strings.TrimSpace(item.ContentID) != "" {
|
||||
ids = append(ids, item.ContentID)
|
||||
}
|
||||
}
|
||||
if len(ids) == 0 {
|
||||
return items, nil
|
||||
}
|
||||
|
||||
ordered, _, err := QueryCollectionItemsBySort(ctx, pool, ids, qs, access, len(ids), "")
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("ordering collection items by %q: %w", qs.Field, err)
|
||||
}
|
||||
|
||||
// Preview returns freshly loaded rows; re-project onto the caller's items so
|
||||
// any enrichment already applied to them survives the reorder.
|
||||
byID := make(map[string]*models.MediaItem, len(items))
|
||||
for _, item := range items {
|
||||
if item != nil {
|
||||
byID[item.ContentID] = item
|
||||
}
|
||||
}
|
||||
result := make([]*models.MediaItem, 0, len(ordered))
|
||||
for _, item := range ordered {
|
||||
if item == nil {
|
||||
continue
|
||||
}
|
||||
if original, ok := byID[item.ContentID]; ok {
|
||||
result = append(result, original)
|
||||
}
|
||||
}
|
||||
return result, nil
|
||||
}
|
||||
|
||||
// collectionSortOverride loads the viewing profile's saved sort for a
|
||||
// collection, or nil when there is none. A lookup failure is logged and treated
|
||||
// as "no override": a browse must not fail because a preference row could not
|
||||
// be read.
|
||||
func (r *CatalogResolver) collectionSortOverride(
|
||||
ctx context.Context,
|
||||
access AccessFilter,
|
||||
kind string,
|
||||
collectionID string,
|
||||
) *userstore.CollectionSortPreference {
|
||||
if r.storeProvider == nil || access.UserID <= 0 || strings.TrimSpace(access.ProfileID) == "" {
|
||||
return nil
|
||||
}
|
||||
store, err := r.storeProvider.ForUser(ctx, access.UserID)
|
||||
if err != nil || store == nil {
|
||||
if err != nil {
|
||||
slog.WarnContext(ctx, "loading user store for collection sort preference",
|
||||
"collection_kind", kind, "collection_id", collectionID, "error", err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
pref, err := store.GetCollectionSortPreference(ctx, access.ProfileID, kind, collectionID)
|
||||
if err != nil {
|
||||
slog.WarnContext(ctx, "loading collection sort preference",
|
||||
"collection_kind", kind, "collection_id", collectionID, "error", err)
|
||||
return nil
|
||||
}
|
||||
return pref
|
||||
}
|
||||
@@ -1,289 +0,0 @@
|
||||
package catalog
|
||||
|
||||
import (
|
||||
"context"
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
"github.com/jackc/pgx/v5/pgxpool"
|
||||
|
||||
"github.com/Silo-Server/silo-server/internal/models"
|
||||
"github.com/Silo-Server/silo-server/internal/userstore"
|
||||
"github.com/Silo-Server/silo-server/internal/userstore/pgstore"
|
||||
)
|
||||
|
||||
// These tests run the default-sort / saved-override flow against a real
|
||||
// Postgres: real SQL ordering through the query executor, and a real
|
||||
// PostgresUserStore writing the override row. They cover the reported
|
||||
// behavior end to end — a collection's creator picks a default order, a viewer
|
||||
// re-sorts, and the viewer's choice survives a fresh read.
|
||||
//
|
||||
// Set SILO_TEST_DATABASE_URL to a migrated database to run them.
|
||||
|
||||
func collectionSortTestPool(t *testing.T) *pgxpool.Pool {
|
||||
t.Helper()
|
||||
dsn := os.Getenv("SILO_TEST_DATABASE_URL")
|
||||
if dsn == "" {
|
||||
t.Skip("SILO_TEST_DATABASE_URL is not set")
|
||||
}
|
||||
ctx := context.Background()
|
||||
pool, err := pgxpool.New(ctx, dsn)
|
||||
if err != nil {
|
||||
t.Fatalf("connect test database: %v", err)
|
||||
}
|
||||
t.Cleanup(pool.Close)
|
||||
var tableName *string
|
||||
if err := pool.QueryRow(ctx, `SELECT to_regclass('public.user_collection_sort_preferences')::text`).Scan(&tableName); err != nil {
|
||||
t.Fatalf("check user_collection_sort_preferences table: %v", err)
|
||||
}
|
||||
if tableName == nil || *tableName == "" {
|
||||
t.Skip("test database has not applied the collection sort preference migration")
|
||||
}
|
||||
return pool
|
||||
}
|
||||
|
||||
// seedSortableItem inserts one sortable item. Callers choose title/year pairs
|
||||
// that make a title sort and a year sort disagree, so an order assertion cannot
|
||||
// pass by coincidence.
|
||||
func seedSortableItem(t *testing.T, pool *pgxpool.Pool, contentID, title string, year int) {
|
||||
t.Helper()
|
||||
ctx := context.Background()
|
||||
if _, err := pool.Exec(ctx, `
|
||||
INSERT INTO media_items (content_id, type, title, sort_title, year, genres)
|
||||
VALUES ($1, 'movie', $2, $2, $3, '{}'::text[])
|
||||
`, contentID, title, year); err != nil {
|
||||
t.Fatalf("seed media item %s: %v", contentID, err)
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
_, _ = pool.Exec(context.Background(), `DELETE FROM media_items WHERE content_id = $1`, contentID)
|
||||
})
|
||||
}
|
||||
|
||||
func seedSortTestUser(t *testing.T, pool *pgxpool.Pool) int {
|
||||
t.Helper()
|
||||
ctx := context.Background()
|
||||
var userID int
|
||||
// A bare fixture row: the override table has an FK to users(id) and the
|
||||
// test needs something to point at. No credentials are set.
|
||||
if err := pool.QueryRow(ctx, `
|
||||
INSERT INTO users (username, email, password_hash, role)
|
||||
VALUES ('collection-sort-fixture', 'collection-sort-fixture@invalid.test', '', 'user')
|
||||
RETURNING id
|
||||
`).Scan(&userID); err != nil {
|
||||
t.Fatalf("seed fixture user: %v", err)
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
_, _ = pool.Exec(context.Background(), `DELETE FROM users WHERE id = $1`, userID)
|
||||
})
|
||||
return userID
|
||||
}
|
||||
|
||||
func itemsForSort(contentIDs ...string) []*models.MediaItem {
|
||||
items := make([]*models.MediaItem, 0, len(contentIDs))
|
||||
for _, id := range contentIDs {
|
||||
items = append(items, &models.MediaItem{ContentID: id})
|
||||
}
|
||||
return items
|
||||
}
|
||||
|
||||
func orderedIDs(items []*models.MediaItem) []string {
|
||||
ids := make([]string, 0, len(items))
|
||||
for _, item := range items {
|
||||
ids = append(ids, item.ContentID)
|
||||
}
|
||||
return ids
|
||||
}
|
||||
|
||||
func assertOrder(t *testing.T, got []string, want ...string) {
|
||||
t.Helper()
|
||||
if len(got) != len(want) {
|
||||
t.Fatalf("order = %v, want %v", got, want)
|
||||
}
|
||||
for i := range want {
|
||||
if got[i] != want[i] {
|
||||
t.Fatalf("order = %v, want %v", got, want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// TestCollectionDefaultSortAndOverrideEndToEnd walks the whole reported
|
||||
// scenario against real Postgres, for both collection kinds.
|
||||
func TestCollectionDefaultSortAndOverrideEndToEnd(t *testing.T) {
|
||||
pool := collectionSortTestPool(t)
|
||||
ctx := context.Background()
|
||||
|
||||
// Years are shuffled against titles on purpose: title-asc gives A,B,C but
|
||||
// year-desc gives B,C,A. If the two agreed, an assertion on the override's
|
||||
// order would also pass when the override was ignored entirely.
|
||||
seedSortableItem(t, pool, "cs-a", "Alpha", 2001)
|
||||
seedSortableItem(t, pool, "cs-b", "Bravo", 2003)
|
||||
seedSortableItem(t, pool, "cs-c", "Charlie", 2002)
|
||||
|
||||
// Source order is deliberately neither sorted order.
|
||||
sourceOrder := itemsForSort("cs-c", "cs-a", "cs-b")
|
||||
limited, total, err := QueryCollectionItemsBySort(
|
||||
ctx,
|
||||
pool,
|
||||
[]string{"cs-c", "cs-a", "cs-b"},
|
||||
QuerySort{Field: "title", Order: "asc"},
|
||||
AccessFilter{},
|
||||
2,
|
||||
"",
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("querying limited sorted collection: %v", err)
|
||||
}
|
||||
assertOrder(t, orderedIDs(limited), "cs-a", "cs-b")
|
||||
if total != 3 {
|
||||
t.Fatalf("limited sorted collection total = %d, want 3", total)
|
||||
}
|
||||
|
||||
userID := seedSortTestUser(t, pool)
|
||||
provider := pgstore.NewPostgresProvider(pool)
|
||||
store, err := provider.ForUser(ctx, userID)
|
||||
if err != nil {
|
||||
t.Fatalf("user store: %v", err)
|
||||
}
|
||||
if err := store.CreateProfile(ctx, userstore.Profile{ID: "profile-e2e", Name: "E2E sort profile"}); err != nil {
|
||||
t.Fatalf("seed profile: %v", err)
|
||||
}
|
||||
t.Cleanup(func() { _ = store.DeleteProfile(context.Background(), "profile-e2e") })
|
||||
|
||||
resolver := &CatalogResolver{storeProvider: provider}
|
||||
access := AccessFilter{UserID: userID, ProfileID: "profile-e2e"}
|
||||
|
||||
for _, kind := range []string{userstore.CollectionKindLibrary, userstore.CollectionKindUser} {
|
||||
t.Run(kind, func(t *testing.T) {
|
||||
collectionID := "cs-collection-" + kind
|
||||
t.Cleanup(func() {
|
||||
_ = store.ClearCollectionSortPreference(ctx, access.ProfileID, kind, collectionID)
|
||||
})
|
||||
|
||||
// 1. No default, no override — the collection keeps source order.
|
||||
if _, ok := resolver.EffectiveCollectionSort(ctx, access, kind, collectionID, []byte(`{}`)); ok {
|
||||
t.Fatal("a collection with no default reported a sort")
|
||||
}
|
||||
|
||||
// 2. The creator sets a default of Title (A→Z).
|
||||
defaultSort := []byte(`{"field":"title","order":"asc"}`)
|
||||
qs, ok := resolver.EffectiveCollectionSort(ctx, access, kind, collectionID, defaultSort)
|
||||
if !ok {
|
||||
t.Fatal("configured default sort was not applied")
|
||||
}
|
||||
ordered, err := OrderCollectionItemsBySort(ctx, pool, sourceOrder, qs, access)
|
||||
if err != nil {
|
||||
t.Fatalf("ordering by default sort: %v", err)
|
||||
}
|
||||
assertOrder(t, orderedIDs(ordered), "cs-a", "cs-b", "cs-c")
|
||||
|
||||
// 3. The viewer re-sorts to Year (newest first) and it is saved.
|
||||
if err := store.SetCollectionSortPreference(ctx, userstore.CollectionSortPreference{
|
||||
ProfileID: access.ProfileID,
|
||||
CollectionKind: kind,
|
||||
CollectionID: collectionID,
|
||||
SortField: "year",
|
||||
SortOrder: "desc",
|
||||
}); err != nil {
|
||||
t.Fatalf("saving override: %v", err)
|
||||
}
|
||||
|
||||
// 4. A fresh resolution — the "leave and come back" case — reads the
|
||||
// override back out of the database and beats the creator's default.
|
||||
freshResolver := &CatalogResolver{storeProvider: pgstore.NewPostgresProvider(pool)}
|
||||
qs, ok = freshResolver.EffectiveCollectionSort(ctx, access, kind, collectionID, defaultSort)
|
||||
if !ok {
|
||||
t.Fatal("saved override was not applied on a fresh read")
|
||||
}
|
||||
if qs.Field != "year" || qs.Order != "desc" {
|
||||
t.Fatalf("effective sort = %q/%q, want year/desc", qs.Field, qs.Order)
|
||||
}
|
||||
ordered, err = OrderCollectionItemsBySort(ctx, pool, sourceOrder, qs, access)
|
||||
if err != nil {
|
||||
t.Fatalf("ordering by override: %v", err)
|
||||
}
|
||||
// Distinct from both the default's A,B,C and source order's C,A,B.
|
||||
assertOrder(t, orderedIDs(ordered), "cs-b", "cs-c", "cs-a")
|
||||
assertOrder(t, orderedIDs(sourceOrder), "cs-c", "cs-a", "cs-b")
|
||||
|
||||
// 5. The viewer pins back to the collection's own order. That is a
|
||||
// real choice and must suppress the creator's default, not fall
|
||||
// through to it.
|
||||
if err := store.SetCollectionSortPreference(ctx, userstore.CollectionSortPreference{
|
||||
ProfileID: access.ProfileID,
|
||||
CollectionKind: kind,
|
||||
CollectionID: collectionID,
|
||||
SortField: "",
|
||||
SortOrder: "",
|
||||
}); err != nil {
|
||||
t.Fatalf("pinning to source order: %v", err)
|
||||
}
|
||||
if _, ok := resolver.EffectiveCollectionSort(ctx, access, kind, collectionID, defaultSort); ok {
|
||||
t.Fatal("source-order override fell through to the creator's default")
|
||||
}
|
||||
|
||||
// 6. Clearing the override returns the viewer to the default.
|
||||
if err := store.ClearCollectionSortPreference(ctx, access.ProfileID, kind, collectionID); err != nil {
|
||||
t.Fatalf("clearing override: %v", err)
|
||||
}
|
||||
qs, ok = resolver.EffectiveCollectionSort(ctx, access, kind, collectionID, defaultSort)
|
||||
if !ok || qs.Field != "title" {
|
||||
t.Fatalf("after clearing, effective sort = %q (ok=%v), want title", qs.Field, ok)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestCollectionSortOverrideIsPerProfile guards the isolation that makes a
|
||||
// server-wide collection safe to re-sort: one profile's choice must not change
|
||||
// what another profile sees.
|
||||
func TestCollectionSortOverrideIsPerProfile(t *testing.T) {
|
||||
pool := collectionSortTestPool(t)
|
||||
ctx := context.Background()
|
||||
|
||||
userID := seedSortTestUser(t, pool)
|
||||
provider := pgstore.NewPostgresProvider(pool)
|
||||
store, err := provider.ForUser(ctx, userID)
|
||||
if err != nil {
|
||||
t.Fatalf("user store: %v", err)
|
||||
}
|
||||
for _, profile := range []userstore.Profile{
|
||||
{ID: "profile-one", Name: "Profile One"},
|
||||
{ID: "profile-two", Name: "Profile Two"},
|
||||
} {
|
||||
if err := store.CreateProfile(ctx, profile); err != nil {
|
||||
t.Fatalf("seed profile %s: %v", profile.ID, err)
|
||||
}
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
_ = store.DeleteProfile(context.Background(), "profile-two")
|
||||
_ = store.DeleteProfile(context.Background(), "profile-one")
|
||||
})
|
||||
resolver := &CatalogResolver{storeProvider: provider}
|
||||
|
||||
const collectionID = "cs-shared-collection"
|
||||
defaultSort := []byte(`{"field":"title","order":"asc"}`)
|
||||
kind := userstore.CollectionKindLibrary
|
||||
|
||||
if err := store.SetCollectionSortPreference(ctx, userstore.CollectionSortPreference{
|
||||
ProfileID: "profile-one",
|
||||
CollectionKind: kind,
|
||||
CollectionID: collectionID,
|
||||
SortField: "year",
|
||||
SortOrder: "desc",
|
||||
}); err != nil {
|
||||
t.Fatalf("saving override: %v", err)
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
_ = store.ClearCollectionSortPreference(context.Background(), "profile-one", kind, collectionID)
|
||||
})
|
||||
|
||||
one, ok := resolver.EffectiveCollectionSort(ctx, AccessFilter{UserID: userID, ProfileID: "profile-one"}, kind, collectionID, defaultSort)
|
||||
if !ok || one.Field != "year" {
|
||||
t.Fatalf("profile-one sort = %q (ok=%v), want year", one.Field, ok)
|
||||
}
|
||||
|
||||
two, ok := resolver.EffectiveCollectionSort(ctx, AccessFilter{UserID: userID, ProfileID: "profile-two"}, kind, collectionID, defaultSort)
|
||||
if !ok || two.Field != "title" {
|
||||
t.Fatalf("profile-two sort = %q (ok=%v), want the collection default title", two.Field, ok)
|
||||
}
|
||||
}
|
||||
@@ -1,189 +0,0 @@
|
||||
package catalog
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"testing"
|
||||
|
||||
"github.com/Silo-Server/silo-server/internal/userstore"
|
||||
)
|
||||
|
||||
// sortPrefStore is a UserStore that only answers collection-sort-preference
|
||||
// lookups; every other method panics so a test that strays off this path fails
|
||||
// loudly rather than silently exercising unrelated behavior.
|
||||
type sortPrefStore struct {
|
||||
userstore.UserStore
|
||||
pref *userstore.CollectionSortPreference
|
||||
err error
|
||||
// calls records the lookups made, so tests can assert the store is not
|
||||
// consulted when there is no user scope to consult it with.
|
||||
calls int
|
||||
}
|
||||
|
||||
func (s *sortPrefStore) GetCollectionSortPreference(_ context.Context, _, _, _ string) (*userstore.CollectionSortPreference, error) {
|
||||
s.calls++
|
||||
if s.err != nil {
|
||||
return nil, s.err
|
||||
}
|
||||
return s.pref, nil
|
||||
}
|
||||
|
||||
type sortPrefProvider struct {
|
||||
store *sortPrefStore
|
||||
err error
|
||||
}
|
||||
|
||||
func (p *sortPrefProvider) ForUser(context.Context, int) (userstore.UserStore, error) {
|
||||
if p.err != nil {
|
||||
return nil, p.err
|
||||
}
|
||||
return p.store, nil
|
||||
}
|
||||
|
||||
func (p *sortPrefProvider) Close() error { return nil }
|
||||
|
||||
func TestEffectiveCollectionSortPrecedence(t *testing.T) {
|
||||
const (
|
||||
libraryDefault = `{"field":"added_at","order":"desc"}`
|
||||
noDefault = `{}`
|
||||
)
|
||||
scopedAccess := AccessFilter{UserID: 7, ProfileID: "profile-1"}
|
||||
|
||||
cases := []struct {
|
||||
name string
|
||||
access AccessFilter
|
||||
sortConfig string
|
||||
pref *userstore.CollectionSortPreference
|
||||
storeErr error
|
||||
wantOK bool
|
||||
wantField string
|
||||
wantOrder string
|
||||
wantCalls int
|
||||
}{
|
||||
{
|
||||
name: "no override falls back to the collection default",
|
||||
access: scopedAccess,
|
||||
sortConfig: libraryDefault,
|
||||
wantOK: true,
|
||||
wantField: "added_at",
|
||||
wantOrder: "desc",
|
||||
wantCalls: 1,
|
||||
},
|
||||
{
|
||||
// The reported behavior: admin defaults to Date Added, the viewer
|
||||
// switches to Title, and Title is what they get from then on.
|
||||
name: "viewer override beats the collection default",
|
||||
access: scopedAccess,
|
||||
sortConfig: libraryDefault,
|
||||
pref: &userstore.CollectionSortPreference{SortField: "title", SortOrder: "asc"},
|
||||
wantOK: true,
|
||||
wantField: "title",
|
||||
wantOrder: "asc",
|
||||
wantCalls: 1,
|
||||
},
|
||||
{
|
||||
// An empty stored field is a deliberate "put it back to the list's
|
||||
// own order" and must not fall through to the creator's default.
|
||||
name: "override pinned to source order suppresses the default",
|
||||
access: scopedAccess,
|
||||
sortConfig: libraryDefault,
|
||||
pref: &userstore.CollectionSortPreference{SortField: "", SortOrder: ""},
|
||||
wantCalls: 1,
|
||||
},
|
||||
{
|
||||
name: "no override and no default means source order",
|
||||
access: scopedAccess,
|
||||
sortConfig: noDefault,
|
||||
wantCalls: 1,
|
||||
},
|
||||
{
|
||||
name: "personalized viewer override is valid on a library collection",
|
||||
access: scopedAccess,
|
||||
sortConfig: libraryDefault,
|
||||
pref: &userstore.CollectionSortPreference{SortField: "progress", SortOrder: "desc"},
|
||||
wantOK: true,
|
||||
wantField: "progress",
|
||||
wantOrder: "desc",
|
||||
wantCalls: 1,
|
||||
},
|
||||
{
|
||||
name: "unusable override falls back to the default",
|
||||
access: scopedAccess,
|
||||
sortConfig: libraryDefault,
|
||||
pref: &userstore.CollectionSortPreference{SortField: "retired_sort", SortOrder: "desc"},
|
||||
wantOK: true,
|
||||
wantField: "added_at",
|
||||
wantOrder: "desc",
|
||||
wantCalls: 1,
|
||||
},
|
||||
{
|
||||
name: "store failure degrades to the default",
|
||||
access: scopedAccess,
|
||||
sortConfig: libraryDefault,
|
||||
storeErr: errors.New("boom"),
|
||||
wantOK: true,
|
||||
wantField: "added_at",
|
||||
wantOrder: "desc",
|
||||
wantCalls: 1,
|
||||
},
|
||||
{
|
||||
// Unauthenticated / profile-less reads (jellycompat, public paths)
|
||||
// have no override to look up and must not query for one.
|
||||
name: "no user scope skips the override lookup",
|
||||
access: AccessFilter{},
|
||||
sortConfig: libraryDefault,
|
||||
pref: &userstore.CollectionSortPreference{SortField: "title", SortOrder: "asc"},
|
||||
wantOK: true,
|
||||
wantField: "added_at",
|
||||
wantOrder: "desc",
|
||||
wantCalls: 0,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
store := &sortPrefStore{pref: tc.pref, err: tc.storeErr}
|
||||
resolver := &CatalogResolver{storeProvider: &sortPrefProvider{store: store}}
|
||||
|
||||
qs, ok := resolver.EffectiveCollectionSort(
|
||||
context.Background(),
|
||||
tc.access,
|
||||
userstore.CollectionKindLibrary,
|
||||
"collection-1",
|
||||
[]byte(tc.sortConfig),
|
||||
)
|
||||
|
||||
if ok != tc.wantOK {
|
||||
t.Fatalf("ok = %v, want %v", ok, tc.wantOK)
|
||||
}
|
||||
if store.calls != tc.wantCalls {
|
||||
t.Fatalf("override lookups = %d, want %d", store.calls, tc.wantCalls)
|
||||
}
|
||||
if !tc.wantOK {
|
||||
return
|
||||
}
|
||||
if qs.Field != tc.wantField || qs.Order != tc.wantOrder {
|
||||
t.Fatalf("got %q/%q, want %q/%q", qs.Field, qs.Order, tc.wantField, tc.wantOrder)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestEffectiveCollectionSortAllowsPersonalizedOnUserCollections(t *testing.T) {
|
||||
store := &sortPrefStore{pref: &userstore.CollectionSortPreference{SortField: "progress", SortOrder: "desc"}}
|
||||
resolver := &CatalogResolver{storeProvider: &sortPrefProvider{store: store}}
|
||||
|
||||
qs, ok := resolver.EffectiveCollectionSort(
|
||||
context.Background(),
|
||||
AccessFilter{UserID: 7, ProfileID: "profile-1"},
|
||||
userstore.CollectionKindUser,
|
||||
"collection-1",
|
||||
[]byte(`{}`),
|
||||
)
|
||||
if !ok {
|
||||
t.Fatal("personalized override rejected on a personal collection")
|
||||
}
|
||||
if qs.Field != "progress" || qs.Order != "desc" {
|
||||
t.Fatalf("got %q/%q, want progress/desc", qs.Field, qs.Order)
|
||||
}
|
||||
}
|
||||
@@ -1,105 +0,0 @@
|
||||
package catalog
|
||||
|
||||
import "testing"
|
||||
|
||||
func TestNormalizeCollectionSort(t *testing.T) {
|
||||
cases := []struct {
|
||||
name string
|
||||
field string
|
||||
order string
|
||||
allowPersonalized bool
|
||||
wantOK bool
|
||||
wantField string
|
||||
wantOrder string
|
||||
}{
|
||||
{name: "applies the field's default order", field: "release_date", wantOK: true, wantField: "release_date", wantOrder: "desc"},
|
||||
{name: "title defaults ascending", field: "title", wantOK: true, wantField: "title", wantOrder: "asc"},
|
||||
{name: "explicit order wins", field: "title", order: "desc", wantOK: true, wantField: "title", wantOrder: "desc"},
|
||||
{name: "trims and lowercases", field: " Title ", order: "ASC", wantOK: true, wantField: "title", wantOrder: "asc"},
|
||||
{name: "garbage order is rejected", field: "year", order: "sideways"},
|
||||
{name: "empty field means source order", field: ""},
|
||||
{name: "unknown field is rejected", field: "not_a_sort"},
|
||||
{name: "personalized rejected for library collections", field: "progress"},
|
||||
{
|
||||
name: "personalized allowed for personal collections",
|
||||
field: "progress",
|
||||
allowPersonalized: true,
|
||||
wantOK: true,
|
||||
wantField: "progress",
|
||||
wantOrder: "desc",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
qs, ok := NormalizeCollectionSort(tc.field, tc.order, tc.allowPersonalized)
|
||||
if ok != tc.wantOK {
|
||||
t.Fatalf("ok = %v, want %v", ok, tc.wantOK)
|
||||
}
|
||||
if !tc.wantOK {
|
||||
return
|
||||
}
|
||||
if qs.Field != tc.wantField || qs.Order != tc.wantOrder {
|
||||
t.Fatalf("got %q/%q, want %q/%q", qs.Field, qs.Order, tc.wantField, tc.wantOrder)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseCollectionDefaultSort(t *testing.T) {
|
||||
cases := []struct {
|
||||
name string
|
||||
raw string
|
||||
wantOK bool
|
||||
wantField string
|
||||
wantOrder string
|
||||
}{
|
||||
{name: "empty column", raw: ""},
|
||||
{name: "legacy empty object", raw: `{}`},
|
||||
{name: "json null", raw: `null`},
|
||||
{name: "unparseable json", raw: `{`},
|
||||
// The unimplemented manual-pin mode carries no field, so it must not be
|
||||
// mistaken for a configured sort.
|
||||
{name: "manual pins mode", raw: `{"mode":"manual_pins"}`},
|
||||
{name: "configured sort", raw: `{"field":"title","order":"asc"}`, wantOK: true, wantField: "title", wantOrder: "asc"},
|
||||
{name: "order filled in", raw: `{"field":"added_at"}`, wantOK: true, wantField: "added_at", wantOrder: "desc"},
|
||||
{name: "invalid order is rejected", raw: `{"field":"title","order":"sideways"}`},
|
||||
}
|
||||
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
qs, ok := ParseCollectionDefaultSort([]byte(tc.raw), false)
|
||||
if ok != tc.wantOK {
|
||||
t.Fatalf("ok = %v, want %v", ok, tc.wantOK)
|
||||
}
|
||||
if !tc.wantOK {
|
||||
return
|
||||
}
|
||||
if qs.Field != tc.wantField || qs.Order != tc.wantOrder {
|
||||
t.Fatalf("got %q/%q, want %q/%q", qs.Field, qs.Order, tc.wantField, tc.wantOrder)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestEncodeCollectionDefaultSort(t *testing.T) {
|
||||
encoded, err := EncodeCollectionDefaultSort(QuerySort{Field: "title", Order: "asc"}, true)
|
||||
if err != nil {
|
||||
t.Fatalf("encoding: %v", err)
|
||||
}
|
||||
if encoded != `{"field":"title","order":"asc"}` {
|
||||
t.Fatalf("encoded = %s", encoded)
|
||||
}
|
||||
|
||||
// Source order round-trips through the empty object the column defaults to.
|
||||
encoded, err = EncodeCollectionDefaultSort(QuerySort{}, false)
|
||||
if err != nil {
|
||||
t.Fatalf("encoding source order: %v", err)
|
||||
}
|
||||
if encoded != "{}" {
|
||||
t.Fatalf("source order encoded = %s, want {}", encoded)
|
||||
}
|
||||
if _, ok := ParseCollectionDefaultSort([]byte(encoded), false); ok {
|
||||
t.Fatal("re-parsing the source-order encoding reported a configured sort")
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user