import { integerInRange, objectValidator } from "../core/index.js";
import type { OptionalModuleDefinition } from "../modules/index.js";

export interface StreamModuleConfig {
  readonly fps: number;
  readonly maxDimension: number;
  readonly bitrateKbps: number;
}

// why: the module is called `stream`, so its capability, its relay target and its route segment are
// one word; the picture settings are what a worker encodes with, and a gateway that only relays a
// stream reads none of them.
const STREAM_HEADERS = {
  "simlock-stream-codec": "The codec of the body: h264 or mjpeg.",
  "simlock-stream-fps": "Frames per second.",
  "simlock-stream-height":
    "Picture height in pixels when the stream opens; a meta frame in the body gives each later size.",
  "simlock-stream-width":
    "Picture width in pixels when the stream opens; a meta frame in the body gives each later size.",
};

export const streamModule: OptionalModuleDefinition<StreamModuleConfig> = {
  config: {
    defaults: { bitrateKbps: 1_500, fps: 30, maxDimension: 720 },
    gatewayKeys: [],
    validator: objectValidator({
      bitrateKbps: integerInRange(100, 40_000),
      fps: integerInRange(1, 60),
      maxDimension: integerInRange(96, 4096),
    }),
  },
  http: {
    routes: [
      {
        method: "get",
        path: "/v1/stream/workers/{workerId}/devices/{deviceId}",
        description:
          "Watch the screen of a running device, leased or not: operator tokens only. A single worker answers for its own id; a gateway relays to the named worker. Served only when capabilities.stream.enabled is true. A gateway keeps a worker's refusal with its code.",
        statuses: {
          200: {
            description: "The picture, as a binary body of frames; its codec and size are headers.",
            contentTypes: [
              "application/vnd.simlock.stream+h264",
              "application/vnd.simlock.stream+mjpeg",
            ],
            headers: STREAM_HEADERS,
          },
          404: {
            description: "No such device or worker, or no such stream path.",
            errorCodes: ["UNKNOWN_DEVICE", "UNKNOWN_WORKER"],
          },
          405: { description: "A stream is read, not written.", errorCodes: ["BAD_REQUEST"] },
          409: {
            description: "The device is not ready or leased.",
            errorCodes: ["DEVICE_NOT_RUNNING"],
          },
          415: {
            description: "The device cannot be streamed.",
            errorCodes: ["STREAM_NOT_SUPPORTED"],
          },
          500: { description: "The stream failed unexpectedly.", errorCodes: ["INTERNAL"] },
          502: {
            description: "A gateway's worker answered success with no picture.",
            errorCodes: ["STREAM_UNAVAILABLE"],
          },
          503: {
            description: "The stream is not available, or a gateway cannot reach the worker.",
            errorCodes: ["STREAM_UNAVAILABLE", "WORKER_UNREACHABLE"],
          },
        },
      },
      {
        method: "get",
        path: "/v1/leases/{id}/stream",
        description:
          "Watch the screen of a lease's device: the lease's holder or an operator. A lease the caller does not own answers 404, as an unknown one does. The last frame of a stream a lease end stopped is a 0x07 frame holding JSON {\"reason\"}: explicit, killed, expired or device-lost. Served only when capabilities.stream.enabled is true on the daemon that answers; through a gateway the lease's worker needs it too.",
        statuses: {
          200: {
            description: "The picture, as a binary body of frames; its codec and size are headers.",
            contentTypes: [
              "application/vnd.simlock.stream+h264",
              "application/vnd.simlock.stream+mjpeg",
            ],
            headers: STREAM_HEADERS,
          },
          404: {
            description: "No such lease, or not the caller's.",
            errorCodes: ["UNKNOWN_LEASE"],
          },
          405: { description: "A stream is read, not written.", errorCodes: ["BAD_REQUEST"] },
          409: {
            description: "The lease's device is not running.",
            errorCodes: ["DEVICE_NOT_RUNNING"],
          },
          415: {
            description: "The device cannot be streamed.",
            errorCodes: ["STREAM_NOT_SUPPORTED"],
          },
          500: { description: "The stream failed unexpectedly.", errorCodes: ["INTERNAL"] },
          502: {
            description: "A gateway's worker answered success with no picture.",
            errorCodes: ["STREAM_UNAVAILABLE"],
          },
          503: {
            description: "The stream is not available, or a gateway cannot reach the worker.",
            errorCodes: ["STREAM_UNAVAILABLE", "WORKER_UNREACHABLE"],
          },
        },
      },
    ],
  },
  loadGateway: () => import("./gateway.js"),
  loadWorker: () => import("./worker.js"),
  name: "stream",
};