@moqtap/codec 0.1.1 → 0.2.1

package/src/drafts/draft11/data-streams.ts

@@ -0,0 +1,269 @@
+import { BufferReader } from "../../core/buffer-reader.js";
+import { BufferWriter } from "../../core/buffer-writer.js";
+import type { DecodeResult } from "../../core/types.js";
+import { DecodeError } from "../../core/types.js";
+import type {
+  DatagramObject,
+  Draft11DataStream,
+  FetchObjectPayload,
+  FetchStream,
+  ObjectPayload,
+  SubgroupStream,
+} from "./types.js";
+
+// ─── Data Stream Encoding/Decoding ─────────────────────────────────────────────
+
+const FETCH_STREAM_TYPE = 0x05n;
+
+export function encodeSubgroupStream(stream: SubgroupStream): Uint8Array {
+  const w = new BufferWriter();
+  const typeId = stream.streamTypeId;
+  w.writeVarInt(BigInt(typeId));
+  w.writeVarInt(stream.trackAlias);
+  w.writeVarInt(stream.groupId);
+  const extensionsPresent = (typeId & 0x01) !== 0;
+  const hasSubgroupField = (typeId & 0x04) !== 0;
+  if (hasSubgroupField) w.writeVarInt(stream.subgroupId);
+  w.writeUint8(stream.publisherPriority);
+  for (const obj of stream.objects) {
+    w.writeVarInt(obj.objectId);
+    if (extensionsPresent) {
+      w.writeVarInt(BigInt(obj.extensionData.length));
+      if (obj.extensionData.length > 0) w.writeBytes(obj.extensionData);
+    }
+    w.writeVarInt(obj.payloadLength);
+    if (obj.payloadLength === 0 && obj.status !== undefined) {
+      w.writeVarInt(obj.status);
+    } else {
+      w.writeBytes(obj.payload);
+    }
+  }
+  return w.finish();
+}
+
+export function encodeDatagram(dg: DatagramObject): Uint8Array {
+  const w = new BufferWriter();
+  w.writeVarInt(BigInt(dg.streamTypeId));
+  w.writeVarInt(dg.trackAlias);
+  w.writeVarInt(dg.groupId);
+  w.writeVarInt(dg.objectId);
+  w.writeUint8(dg.publisherPriority);
+  if (dg.streamTypeId === 0x02) {
+    // Datagram status — write status varint
+    w.writeVarInt(dg.objectStatus ?? 0n);
+  } else {
+    w.writeBytes(dg.payload);
+  }
+  return w.finish();
+}
+
+export function encodeFetchStream(stream: FetchStream): Uint8Array {
+  const w = new BufferWriter();
+  w.writeVarInt(FETCH_STREAM_TYPE);
+  w.writeVarInt(stream.requestId);
+  for (const obj of stream.objects) {
+    w.writeVarInt(obj.groupId);
+    w.writeVarInt(obj.subgroupId);
+    w.writeVarInt(obj.objectId);
+    w.writeUint8(obj.publisherPriority);
+    w.writeVarInt(BigInt(obj.extensionData.length));
+    if (obj.extensionData.length > 0) w.writeBytes(obj.extensionData);
+    w.writeVarInt(obj.payloadLength);
+    w.writeBytes(obj.payload);
+  }
+  return w.finish();
+}
+
+export function decodeSubgroupStream(bytes: Uint8Array): DecodeResult<SubgroupStream> {
+  try {
+    const r = new BufferReader(bytes);
+    const streamTypeId = Number(r.readVarInt());
+    if (streamTypeId < 0x08 || streamTypeId > 0x0d) {
+      return {
+        ok: false,
+        error: new DecodeError(
+          "CONSTRAINT_VIOLATION",
+          `Expected subgroup type 0x08-0x0D, got 0x${streamTypeId.toString(16)}`,
+          0,
+        ),
+      };
+    }
+    const extensionsPresent = (streamTypeId & 0x01) !== 0;
+    const hasSubgroupField = (streamTypeId & 0x04) !== 0;
+    const subgroupIsFirstObjId = (streamTypeId & 0x02) !== 0 && !hasSubgroupField;
+    const trackAlias = r.readVarInt();
+    const groupId = r.readVarInt();
+    let subgroupId = 0n;
+    if (hasSubgroupField) subgroupId = r.readVarInt();
+    const publisherPriority = r.readUint8();
+    const objects: ObjectPayload[] = [];
+    let firstObject = true;
+    while (r.remaining > 0) {
+      const byteOffset = r.offset;
+      const objectId = r.readVarInt();
+      if (firstObject && subgroupIsFirstObjId) {
+        subgroupId = objectId;
+        firstObject = false;
+      }
+      let extensionData = new Uint8Array(0);
+      if (extensionsPresent) {
+        const extLen = Number(r.readVarInt());
+        extensionData = extLen > 0 ? r.readBytes(extLen) : new Uint8Array(0);
+      }
+      const payloadLength = Number(r.readVarInt());
+      let payload: Uint8Array;
+      let status: bigint | undefined;
+      let payloadByteOffset: number;
+      if (payloadLength === 0) {
+        status = r.readVarInt();
+        payloadByteOffset = r.offset;
+        payload = new Uint8Array(0);
+      } else {
+        payloadByteOffset = r.offset;
+        payload = r.readBytes(payloadLength);
+      }
+      const obj: ObjectPayload = { type: "object", byteOffset, payloadByteOffset, objectId, extensionData, payloadLength, payload };
+      if (status !== undefined) (obj as unknown as Record<string, unknown>).status = status;
+      objects.push(obj);
+    }
+    return {
+      ok: true,
+      value: {
+        type: "subgroup",
+        streamTypeId,
+        trackAlias,
+        groupId,
+        subgroupId,
+        publisherPriority,
+        objects,
+      },
+      bytesRead: r.offset,
+    };
+  } catch (e) {
+    if (e instanceof DecodeError) return { ok: false, error: e };
+    throw e;
+  }
+}
+
+export function decodeDatagram(bytes: Uint8Array): DecodeResult<DatagramObject> {
+  try {
+    const r = new BufferReader(bytes);
+    const streamTypeId = Number(r.readVarInt());
+    if (streamTypeId !== 0x00 && streamTypeId !== 0x02) {
+      return {
+        ok: false,
+        error: new DecodeError(
+          "CONSTRAINT_VIOLATION",
+          `Expected datagram type 0x00 or 0x02, got 0x${streamTypeId.toString(16)}`,
+          0,
+        ),
+      };
+    }
+    const trackAlias = r.readVarInt();
+    const groupId = r.readVarInt();
+    const objectId = r.readVarInt();
+    const publisherPriority = r.readUint8();
+    let objectStatus: bigint | undefined;
+    let payload: Uint8Array;
+    if (streamTypeId === 0x02) {
+      objectStatus = r.readVarInt();
+      payload = new Uint8Array(0);
+    } else {
+      payload = r.readBytes(r.remaining);
+    }
+    const result: DatagramObject = {
+      type: "datagram",
+      streamTypeId,
+      trackAlias,
+      groupId,
+      objectId,
+      publisherPriority,
+      payloadLength: payload.byteLength,
+      payload,
+    };
+    if (objectStatus !== undefined)
+      (result as unknown as Record<string, unknown>).objectStatus = objectStatus;
+    return { ok: true, value: result, bytesRead: r.offset };
+  } catch (e) {
+    if (e instanceof DecodeError) return { ok: false, error: e };
+    throw e;
+  }
+}
+
+export function decodeFetchStream(bytes: Uint8Array): DecodeResult<FetchStream> {
+  try {
+    const r = new BufferReader(bytes);
+    const streamType = r.readVarInt();
+    if (streamType !== FETCH_STREAM_TYPE) {
+      return {
+        ok: false,
+        error: new DecodeError(
+          "CONSTRAINT_VIOLATION",
+          `Expected fetch type 0x05, got 0x${streamType.toString(16)}`,
+          0,
+        ),
+      };
+    }
+    const requestId = r.readVarInt();
+    const objects: FetchObjectPayload[] = [];
+    while (r.remaining > 0) {
+      const byteOffset = r.offset;
+      const groupId = r.readVarInt();
+      const subgroupId = r.readVarInt();
+      const objectId = r.readVarInt();
+      const publisherPriority = r.readUint8();
+      const extensionHeadersLength = r.readVarInt();
+      const extensionData = extensionHeadersLength > 0n ? r.readBytes(Number(extensionHeadersLength)) : new Uint8Array(0);
+      const payloadLength = Number(r.readVarInt());
+      let payload: Uint8Array;
+      let objectStatus: bigint | undefined;
+      let payloadByteOffset: number;
+      if (payloadLength === 0) {
+        objectStatus = r.readVarInt();
+        payloadByteOffset = r.offset;
+        payload = new Uint8Array(0);
+      } else {
+        payloadByteOffset = r.offset;
+        payload = r.readBytes(payloadLength);
+      }
+      const obj: FetchObjectPayload = {
+        type: "object",
+        byteOffset,
+        payloadByteOffset,
+        groupId,
+        subgroupId,
+        objectId,
+        publisherPriority,
+        extensionHeadersLength,
+        extensionData,
+        payloadLength,
+        payload,
+      };
+      if (objectStatus !== undefined)
+        (obj as unknown as Record<string, unknown>).objectStatus = objectStatus;
+      objects.push(obj);
+    }
+    return { ok: true, value: { type: "fetch", requestId, objects }, bytesRead: r.offset };
+  } catch (e) {
+    if (e instanceof DecodeError) return { ok: false, error: e };
+    throw e;
+  }
+}
+
+export function decodeDataStream(
+  streamType: "subgroup" | "datagram" | "fetch",
+  bytes: Uint8Array,
+): DecodeResult<Draft11DataStream> {
+  switch (streamType) {
+    case "subgroup":
+      return decodeSubgroupStream(bytes);
+    case "datagram":
+      return decodeDatagram(bytes);
+    case "fetch":
+      return decodeFetchStream(bytes);
+    default: {
+      const _: never = streamType;
+      throw new Error(`Unknown: ${_}`);
+    }
+  }
+}

package/src/drafts/draft11/index.ts

@@ -0,0 +1,123 @@
+export type { Draft11Codec } from "./codec.js";
+export {
+  createDraft11Codec,
+  createStreamDecoder,
+  decodeDatagram,
+  decodeDataStream,
+  decodeFetchStream,
+  decodeMessage,
+  decodeSubgroupStream,
+  encodeDatagram,
+  encodeFetchStream,
+  encodeMessage,
+  encodeSubgroupStream,
+} from "./codec.js";
+export {
+  MESSAGE_ID_MAP,
+  MESSAGE_TYPE_MAP,
+  MSG_ANNOUNCE,
+  MSG_ANNOUNCE_CANCEL,
+  MSG_ANNOUNCE_ERROR,
+  MSG_ANNOUNCE_OK,
+  MSG_CLIENT_SETUP,
+  MSG_FETCH,
+  MSG_FETCH_CANCEL,
+  MSG_FETCH_ERROR,
+  MSG_FETCH_OK,
+  MSG_GOAWAY,
+  MSG_MAX_REQUEST_ID,
+  MSG_REQUESTS_BLOCKED,
+  MSG_SERVER_SETUP,
+  MSG_SUBSCRIBE,
+  MSG_SUBSCRIBE_ANNOUNCES,
+  MSG_SUBSCRIBE_ANNOUNCES_ERROR,
+  MSG_SUBSCRIBE_ANNOUNCES_OK,
+  MSG_SUBSCRIBE_DONE,
+  MSG_SUBSCRIBE_ERROR,
+  MSG_SUBSCRIBE_OK,
+  MSG_SUBSCRIBE_UPDATE,
+  MSG_TRACK_STATUS,
+  MSG_TRACK_STATUS_REQUEST,
+  MSG_UNANNOUNCE,
+  MSG_UNSUBSCRIBE,
+  MSG_UNSUBSCRIBE_ANNOUNCES,
+  PARAM_AUTHORIZATION_TOKEN,
+  PARAM_DELIVERY_TIMEOUT,
+  SETUP_PARAM_MAX_REQUEST_ID,
+  SETUP_PARAM_PATH,
+} from "./messages.js";
+export {
+  BIDIRECTIONAL_MESSAGES,
+  CLIENT_ONLY_MESSAGES,
+  CONTROL_MESSAGES,
+  getLegalIncoming,
+  getLegalOutgoing,
+  SERVER_ONLY_MESSAGES,
+} from "./rules.js";
+export type {
+  AnnouncePhase,
+  AnnounceState,
+  FetchPhase,
+  FetchState,
+  ProtocolViolation,
+  ProtocolViolationCode,
+  SessionPhase,
+  SessionState,
+  SessionStateOptions,
+  SideEffect,
+  SubscriptionPhase,
+  SubscriptionState,
+  TransitionResult,
+  ValidationResult,
+} from "./session.js";
+// Session state machine
+export { createDraft11SessionState } from "./session.js";
+export { Draft11SessionFSM } from "./session-fsm.js";
+export type {
+  AuthorizationToken,
+  DatagramObject,
+  DataStreamEvent,
+  DataStreamHeader,
+  Draft11Announce,
+  Draft11AnnounceCancel,
+  Draft11AnnounceError,
+  Draft11AnnounceOk,
+  Draft11BaseMessage,
+  Draft11ClientSetup,
+  Draft11DataStream,
+  Draft11Fetch,
+  Draft11FetchCancel,
+  Draft11FetchError,
+  Draft11FetchOk,
+  Draft11GoAway,
+  Draft11MaxRequestId,
+  Draft11Message,
+  Draft11MessageType,
+  Draft11Params,
+  Draft11RequestsBlocked,
+  Draft11ServerSetup,
+  Draft11SetupParams,
+  Draft11Subscribe,
+  Draft11SubscribeAnnounces,
+  Draft11SubscribeAnnouncesError,
+  Draft11SubscribeAnnouncesOk,
+  Draft11SubscribeDone,
+  Draft11SubscribeError,
+  Draft11SubscribeOk,
+  Draft11SubscribeUpdate,
+  Draft11TrackStatus,
+  Draft11TrackStatusRequest,
+  Draft11Unannounce,
+  Draft11Unsubscribe,
+  Draft11UnsubscribeAnnounces,
+  FetchObjectPayload,
+  FetchStream,
+  FetchStreamHeader,
+  JoiningFetch,
+  LargestLocation,
+  ObjectPayload,
+  StandaloneFetch,
+  SubgroupStream,
+  SubgroupStreamHeader,
+  UnknownParam,
+} from "./types.js";

package/src/drafts/draft11/messages.ts

@@ -0,0 +1,71 @@
+// Draft-11 message type wire IDs
+
+export const MSG_SUBSCRIBE_UPDATE = 0x02n;
+export const MSG_SUBSCRIBE = 0x03n;
+export const MSG_SUBSCRIBE_OK = 0x04n;
+export const MSG_SUBSCRIBE_ERROR = 0x05n;
+export const MSG_ANNOUNCE = 0x06n;
+export const MSG_ANNOUNCE_OK = 0x07n;
+export const MSG_ANNOUNCE_ERROR = 0x08n;
+export const MSG_UNANNOUNCE = 0x09n;
+export const MSG_UNSUBSCRIBE = 0x0an;
+export const MSG_SUBSCRIBE_DONE = 0x0bn;
+export const MSG_ANNOUNCE_CANCEL = 0x0cn;
+export const MSG_TRACK_STATUS_REQUEST = 0x0dn;
+export const MSG_TRACK_STATUS = 0x0en;
+export const MSG_GOAWAY = 0x10n;
+export const MSG_SUBSCRIBE_ANNOUNCES = 0x11n;
+export const MSG_SUBSCRIBE_ANNOUNCES_OK = 0x12n;
+export const MSG_SUBSCRIBE_ANNOUNCES_ERROR = 0x13n;
+export const MSG_UNSUBSCRIBE_ANNOUNCES = 0x14n;
+export const MSG_MAX_REQUEST_ID = 0x15n;
+export const MSG_FETCH = 0x16n;
+export const MSG_FETCH_CANCEL = 0x17n;
+export const MSG_FETCH_OK = 0x18n;
+export const MSG_FETCH_ERROR = 0x19n;
+export const MSG_REQUESTS_BLOCKED = 0x1an;
+export const MSG_CLIENT_SETUP = 0x20n;
+export const MSG_SERVER_SETUP = 0x21n;
+
+// Setup parameter type IDs (even/odd encoding)
+export const SETUP_PARAM_PATH = 0x01n; // odd: length-prefixed
+export const SETUP_PARAM_MAX_REQUEST_ID = 0x02n; // even: varint
+
+// Version-specific parameter type IDs (all length-prefixed)
+export const PARAM_AUTHORIZATION_TOKEN = 0x01n;
+export const PARAM_DELIVERY_TIMEOUT = 0x02n;
+
+// Map from wire ID to message type name
+export const MESSAGE_TYPE_MAP: ReadonlyMap<bigint, string> = new Map([
+  [MSG_CLIENT_SETUP, "client_setup"],
+  [MSG_SERVER_SETUP, "server_setup"],
+  [MSG_SUBSCRIBE, "subscribe"],
+  [MSG_SUBSCRIBE_OK, "subscribe_ok"],
+  [MSG_SUBSCRIBE_ERROR, "subscribe_error"],
+  [MSG_SUBSCRIBE_UPDATE, "subscribe_update"],
+  [MSG_SUBSCRIBE_DONE, "subscribe_done"],
+  [MSG_UNSUBSCRIBE, "unsubscribe"],
+  [MSG_ANNOUNCE, "announce"],
+  [MSG_ANNOUNCE_OK, "announce_ok"],
+  [MSG_ANNOUNCE_ERROR, "announce_error"],
+  [MSG_UNANNOUNCE, "unannounce"],
+  [MSG_ANNOUNCE_CANCEL, "announce_cancel"],
+  [MSG_SUBSCRIBE_ANNOUNCES, "subscribe_announces"],
+  [MSG_SUBSCRIBE_ANNOUNCES_OK, "subscribe_announces_ok"],
+  [MSG_SUBSCRIBE_ANNOUNCES_ERROR, "subscribe_announces_error"],
+  [MSG_UNSUBSCRIBE_ANNOUNCES, "unsubscribe_announces"],
+  [MSG_FETCH, "fetch"],
+  [MSG_FETCH_OK, "fetch_ok"],
+  [MSG_FETCH_ERROR, "fetch_error"],
+  [MSG_FETCH_CANCEL, "fetch_cancel"],
+  [MSG_TRACK_STATUS_REQUEST, "track_status_request"],
+  [MSG_TRACK_STATUS, "track_status"],
+  [MSG_GOAWAY, "goaway"],
+  [MSG_MAX_REQUEST_ID, "max_request_id"],
+  [MSG_REQUESTS_BLOCKED, "requests_blocked"],
+]);
+
+// Reverse map
+export const MESSAGE_ID_MAP: ReadonlyMap<string, bigint> = new Map(
+  [...MESSAGE_TYPE_MAP.entries()].map(([id, name]) => [name, id]),
+);

package/src/drafts/draft11/rules.ts

@@ -0,0 +1,100 @@
+import type { Draft11MessageType } from "./types.js";
+
+// All draft-11 control messages
+export const CONTROL_MESSAGES: ReadonlySet<Draft11MessageType> = new Set([
+  "client_setup",
+  "server_setup",
+  "subscribe",
+  "subscribe_ok",
+  "subscribe_error",
+  "subscribe_update",
+  "subscribe_done",
+  "unsubscribe",
+  "announce",
+  "announce_ok",
+  "announce_error",
+  "unannounce",
+  "announce_cancel",
+  "subscribe_announces",
+  "subscribe_announces_ok",
+  "subscribe_announces_error",
+  "unsubscribe_announces",
+  "fetch",
+  "fetch_ok",
+  "fetch_error",
+  "fetch_cancel",
+  "track_status_request",
+  "track_status",
+  "goaway",
+  "max_request_id",
+  "requests_blocked",
+]);
+
+// Draft-11 is symmetric: only setup messages are role-restricted.
+export const CLIENT_ONLY_MESSAGES: ReadonlySet<Draft11MessageType> = new Set(["client_setup"]);
+
+export const SERVER_ONLY_MESSAGES: ReadonlySet<Draft11MessageType> = new Set(["server_setup"]);
+
+// Messages that are bidirectional (both client and server can send)
+export const BIDIRECTIONAL_MESSAGES: ReadonlySet<Draft11MessageType> = new Set([
+  "subscribe",
+  "subscribe_ok",
+  "subscribe_error",
+  "subscribe_update",
+  "subscribe_done",
+  "unsubscribe",
+  "announce",
+  "announce_ok",
+  "announce_error",
+  "unannounce",
+  "announce_cancel",
+  "subscribe_announces",
+  "subscribe_announces_ok",
+  "subscribe_announces_error",
+  "unsubscribe_announces",
+  "fetch",
+  "fetch_ok",
+  "fetch_error",
+  "fetch_cancel",
+  "track_status_request",
+  "track_status",
+  "goaway",
+  "max_request_id",
+  "requests_blocked",
+]);
+
+// Messages legal in each session phase -- for outbound validation
+export function getLegalOutgoing(
+  phase: string,
+  role: "client" | "server",
+): Set<Draft11MessageType> {
+  const legal = new Set<Draft11MessageType>();
+
+  switch (phase) {
+    case "idle":
+      if (role === "client") legal.add("client_setup");
+      break;
+    case "setup":
+      if (role === "server") legal.add("server_setup");
+      break;
+    case "ready": {
+      legal.add("goaway");
+      for (const msg of BIDIRECTIONAL_MESSAGES) {
+        legal.add(msg);
+      }
+      break;
+    }
+    case "draining":
+      break;
+  }
+
+  return legal;
+}
+
+export function getLegalIncoming(
+  phase: string,
+  role: "client" | "server",
+): Set<Draft11MessageType> {
+  const remoteRole = role === "client" ? "server" : "client";
+  return getLegalOutgoing(phase, remoteRole);
+}