@blockcast/mmt-container 0.1.0-main.0399efef1f07

package/package.json

@@ -0,0 +1,203 @@
+{
+  "name": "@blockcast/mmt-container",
+  "version": "0.1.0-main.0399efef1f07",
+  "description": "MMTP/LOC container parsing for MMT over MoQ and SSM",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./browser-runtime": {
+      "import": "./dist/browser-runtime.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./source-auth": {
+      "import": "./dist/source-auth.js",
+      "types": "./dist/source-auth.d.ts"
+    },
+    "./mfu": {
+      "import": "./dist/mfu-reassembler.js",
+      "types": "./dist/mfu-reassembler.d.ts"
+    },
+    "./loc": {
+      "import": "./dist/loc.js",
+      "types": "./dist/loc.d.ts"
+    },
+    "./codec-utils": {
+      "import": "./dist/codec-utils.js",
+      "types": "./dist/codec-utils.d.ts"
+    },
+    "./fec-manager": {
+      "import": "./dist/fec-manager.js",
+      "types": "./dist/fec-manager.d.ts"
+    },
+    "./mmtp-router": {
+      "import": "./dist/mmtp-router.js",
+      "types": "./dist/mmtp-router.d.ts"
+    },
+    "./multicast-transport": {
+      "import": "./dist/multicast-transport.js",
+      "types": "./dist/multicast-transport.d.ts"
+    },
+    "./multicast-manager": {
+      "import": "./dist/multicast-manager.js",
+      "types": "./dist/multicast-manager.d.ts"
+    },
+    "./media-router": {
+      "import": "./dist/media-router.js",
+      "types": "./dist/media-router.d.ts"
+    },
+    "./multicast-unwrap": {
+      "import": "./dist/multicast-unwrap.js",
+      "types": "./dist/multicast-unwrap.d.ts"
+    },
+    "./signaling": {
+      "import": "./dist/signaling.js",
+      "types": "./dist/signaling.d.ts"
+    },
+    "./mmtp-container-parser": {
+      "import": "./dist/mmtp-container-parser.js",
+      "types": "./dist/mmtp-container-parser.d.ts"
+    },
+    "./mfu-reassembly-policy": {
+      "import": "./dist/mfu-reassembly-policy.js",
+      "types": "./dist/mfu-reassembly-policy.d.ts"
+    },
+    "./wasm-mfu-reassembler": {
+      "import": "./dist/wasm-mfu-reassembler.js",
+      "types": "./dist/wasm-mfu-reassembler.d.ts"
+    },
+    "./wasm-mmtp-container-parser": {
+      "import": "./dist/wasm-mmtp-container-parser.js",
+      "types": "./dist/wasm-mmtp-container-parser.d.ts"
+    },
+    "./fec-codec": {
+      "import": "./dist/fec-codec.js",
+      "types": "./dist/fec-codec.d.ts"
+    },
+    "./cmcd-producer": {
+      "import": "./dist/cmcd-producer.js",
+      "types": "./dist/cmcd-producer.d.ts"
+    },
+    "./cmaf-group-batcher": {
+      "import": "./dist/cmaf-group-batcher.js",
+      "types": "./dist/cmaf-group-batcher.d.ts"
+    },
+    "./carp-catalog": {
+      "import": "./dist/carp-catalog.js",
+      "types": "./dist/carp-catalog.d.ts"
+    },
+    "./multicast-auth-catalog": {
+      "import": "./dist/multicast-auth-catalog.js",
+      "types": "./dist/multicast-auth-catalog.d.ts"
+    },
+    "./manifest-auth-plan": {
+      "import": "./dist/manifest-auth-plan.js",
+      "types": "./dist/manifest-auth-plan.d.ts"
+    },
+    "./catalog-validator": {
+      "import": "./dist/catalog-validator.js",
+      "types": "./dist/catalog-validator.d.ts"
+    },
+    "./switching-set-alignment": {
+      "import": "./dist/switching-set-alignment.js",
+      "types": "./dist/switching-set-alignment.d.ts"
+    },
+    "./phase14-catalog-override": {
+      "import": "./dist/phase14-catalog-override.js",
+      "types": "./dist/phase14-catalog-override.d.ts"
+    },
+    "./align": {
+      "import": "./dist/align.js",
+      "types": "./dist/align.d.ts"
+    },
+    "./mmtp-decode-pipeline": {
+      "import": "./dist/mmtp-decode-pipeline.js",
+      "types": "./dist/mmtp-decode-pipeline.d.ts"
+    },
+    "./mmtp-to-cmaf": {
+      "import": "./dist/mmtp-to-cmaf.js",
+      "types": "./dist/mmtp-to-cmaf.d.ts"
+    },
+    "./track-pipeline-setup": {
+      "import": "./dist/track-pipeline-setup.js",
+      "types": "./dist/track-pipeline-setup.d.ts"
+    },
+    "./track-session": {
+      "import": "./dist/track-session.js",
+      "types": "./dist/track-session.d.ts"
+    },
+    "./catalog-fec-params": {
+      "import": "./dist/catalog-fec-params.js",
+      "types": "./dist/catalog-fec-params.d.ts"
+    },
+    "./catalog-network-source": {
+      "import": "./dist/catalog-network-source.js",
+      "types": "./dist/catalog-network-source.d.ts"
+    },
+    "./catalog.schema.json": "./schemas/catalog.schema.json",
+    "./test-vectors/catalog-validation.json": "./test-vectors/catalog-validation.json",
+    "./test-vectors/align.json": "./test-vectors/align.json"
+  },
+  "files": [
+    "dist",
+    "schemas",
+    "src",
+    "test-vectors",
+    "!src/**/*.test.ts",
+    "!src/**/*.spec.ts",
+    "!src/**/__tests__",
+    "!dist/**/*.test.*",
+    "!dist/**/*.spec.*"
+  ],
+  "scripts": {
+    "build": "tsc --emitDeclarationOnly && node build.mjs",
+    "dev": "tsc --watch",
+    "clean": "rm -rf dist",
+    "bench:source-auth": "node bench/source-auth-wasm.mjs",
+    "test:catalog-validator-public-api": "node test-vectors/catalog-validator-public-api.mjs",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "dependencies": {
+    "@noble/hashes": "^1.8.0",
+    "@blockcast/mmt-fec": "0.1.0-main.0399efef1f07",
+    "@blockcast/mmt-manifest-verify": "0.1.1-main.0399efef1f07",
+    "@blockcast/fec-worker": "0.1.0-main.0399efef1f07",
+    "@blockcast/mmt-alta-parse": "0.1.0-main.0399efef1f07",
+    "@blockcast/mmt-base": "0.1.0-main.0399efef1f07",
+    "ajv": "^8.17.1",
+    "ajv-formats": "^3.0.1"
+  },
+  "bundledDependencies": [
+    "@blockcast/mmt-fec",
+    "@blockcast/mmt-manifest-verify",
+    "@blockcast/fec-worker",
+    "@blockcast/mmt-alta-parse",
+    "@blockcast/mmt-base"
+  ],
+  "devDependencies": {
+    "@blockcast/mmt-transport": "file:../transport",
+    "esbuild": "^0.28.0",
+    "hash-wasm": "^4.12.0",
+    "typescript": "^5.3.0",
+    "vitest": "^1.0.0"
+  },
+  "keywords": [
+    "mmt",
+    "mmtp",
+    "loc",
+    "container",
+    "streaming",
+    "iso23008-1"
+  ],
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Blockcast/libmmt.git",
+    "directory": "packages/container"
+  }
+}

package/schemas/catalog.schema.json

@@ -0,0 +1,360 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://blockcast.net/schemas/moq-mmtp-catalog-v1.schema.json",
+  "title": "MoQ MMTP Catalog v1",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["version", "tracks"],
+  "properties": {
+    "version": { "const": 1 },
+    "streamingFormat": { "const": "mmtp" },
+    "streamingFormatVersion": { "type": "string", "minLength": 1 },
+    "supportsDeltaUpdates": { "type": "boolean" },
+    "tracks": {
+      "type": "array",
+      "minItems": 1,
+      "items": { "$ref": "#/$defs/track" }
+    },
+    "multicast": { "$ref": "#/$defs/multicast" },
+    "multicast.auth": { "$ref": "#/$defs/multicastAuth" }
+  },
+  "$defs": {
+    "positiveInteger": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 9007199254740991
+    },
+    "nonNegativeNumber": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 9007199254740991
+    },
+    "track": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["name", "packaging"],
+      "properties": {
+        "namespace": { "type": "string", "minLength": 1 },
+        "name": { "type": "string", "minLength": 1 },
+        "packaging": { "enum": ["mmtp", "fec-repair", "condensed"] },
+        "isLive": {
+          "type": "boolean",
+          "default": true,
+          "description": "Whether the track is live; omission defaults to true."
+        },
+        "codec": { "type": "string", "minLength": 1 },
+        "role": { "enum": ["video", "audio", "repair"] },
+        "trackRole": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Publisher ownership role. Canonical values include base, delta, repair, audio, and abr-rung:<track name>."
+        },
+        "mimeType": { "type": "string", "minLength": 1 },
+        "samplerate": { "$ref": "#/$defs/positiveInteger" },
+        "channelConfig": { "type": "string", "minLength": 1 },
+        "framerate": { "type": "number", "exclusiveMinimum": 0 },
+        "bitrate": { "$ref": "#/$defs/positiveInteger" },
+        "width": { "$ref": "#/$defs/positiveInteger" },
+        "height": { "$ref": "#/$defs/positiveInteger" },
+        "renderGroup": { "type": "integer", "minimum": 0 },
+        "altGroup": { "type": "integer", "minimum": 0 },
+        "depends": {
+          "type": "array",
+          "uniqueItems": true,
+          "items": { "type": "string", "minLength": 1 }
+        },
+        "initData": { "type": "string", "minLength": 1 },
+        "initTrack": { "type": "string", "minLength": 1 },
+        "priority": { "type": "integer", "minimum": 0, "maximum": 255 },
+        "repairLayer": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 16777215,
+          "description": "fec-repair only. Base repair layer index; layer 0 is the track named by the source's fec.repairTrack. Layers 1..n are contiguous per source (draft-ramadan-moq-fec 6.3)."
+        },
+        "repairSymbols": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 16777215,
+          "description": "fec-repair only. Repair symbols per block carried by this layer or overlay (P_i)."
+        },
+        "sourceSymbols": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 56403,
+          "description": "fec-repair overlay only. Source symbols per block of the overlay FEC instance (K_overlay)."
+        },
+        "scope": {
+          "const": "keyframe",
+          "description": "fec-repair only. Marks a keyframe overlay: a separate FEC instance over random access point fragments."
+        },
+        "mmtpMode": { "enum": ["mpu", "mfu"] },
+        "timescale": { "$ref": "#/$defs/positiveInteger" },
+        "groupDurationMs": { "$ref": "#/$defs/positiveInteger" },
+        "groupDurationTicks": { "$ref": "#/$defs/positiveInteger" },
+        "keyframeIntervalMs": { "$ref": "#/$defs/positiveInteger" },
+        "fec": { "$ref": "#/$defs/fec" }
+      },
+      "allOf": [
+        {
+          "if": { "properties": { "packaging": { "const": "mmtp" } }, "required": ["packaging"] },
+          "then": {
+            "required": ["mmtpMode", "timescale"],
+            "properties": {
+              "mmtpMode": { "enum": ["mpu", "mfu"] },
+              "timescale": { "$ref": "#/$defs/positiveInteger" },
+              "groupDurationMs": { "$ref": "#/$defs/positiveInteger" }
+            },
+            "not": {
+              "anyOf": [
+                { "properties": { "repairLayer": true }, "required": ["repairLayer"] },
+                { "properties": { "repairSymbols": true }, "required": ["repairSymbols"] },
+                { "properties": { "sourceSymbols": true }, "required": ["sourceSymbols"] },
+                { "properties": { "scope": true }, "required": ["scope"] }
+              ]
+            },
+            "anyOf": [
+              {
+                "properties": { "groupDurationMs": { "$ref": "#/$defs/positiveInteger" } },
+                "required": ["groupDurationMs"]
+              },
+              {
+                "properties": { "groupDurationTicks": { "$ref": "#/$defs/positiveInteger" } },
+                "required": ["groupDurationTicks"]
+              }
+            ]
+          }
+        },
+        {
+          "if": { "properties": { "packaging": { "const": "fec-repair" } }, "required": ["packaging"] },
+          "then": {
+            "properties": {
+              "priority": {
+                "type": "integer",
+                "minimum": 192,
+                "maximum": 255,
+                "description": "MoQT-scale delivery priority, lower first. Optional on base layer 0 (240 when absent); required on layers 1..n and overlays."
+              },
+              "depends": {
+                "type": "array",
+                "minItems": 1,
+                "maxItems": 1,
+                "description": "Exactly one source track: an mmtp track carrying an fec object."
+              }
+            },
+            "not": {
+              "anyOf": [
+                { "properties": { "mmtpMode": true }, "required": ["mmtpMode"] },
+                { "properties": { "timescale": true }, "required": ["timescale"] },
+                { "properties": { "groupDurationMs": true }, "required": ["groupDurationMs"] },
+                { "properties": { "groupDurationTicks": true }, "required": ["groupDurationTicks"] },
+                { "properties": { "keyframeIntervalMs": true }, "required": ["keyframeIntervalMs"] },
+                { "properties": { "fec": true }, "required": ["fec"] }
+              ]
+            },
+            "allOf": [
+              {
+                "if": { "properties": { "scope": true }, "required": ["scope"] },
+                "then": {
+                  "properties": { "depends": true, "sourceSymbols": true, "repairSymbols": true, "priority": true },
+                  "required": ["depends", "sourceSymbols", "repairSymbols", "priority"],
+                  "not": { "properties": { "repairLayer": true }, "required": ["repairLayer"] }
+                }
+              },
+              {
+                "if": { "properties": { "sourceSymbols": true }, "required": ["sourceSymbols"] },
+                "then": { "properties": { "scope": true }, "required": ["scope"] }
+              },
+              {
+                "if": {
+                  "properties": { "repairLayer": { "type": "integer", "minimum": 1 } },
+                  "required": ["repairLayer"]
+                },
+                "then": {
+                  "properties": { "depends": true, "repairSymbols": true, "priority": true },
+                  "required": ["depends", "repairSymbols", "priority"]
+                }
+              }
+            ]
+          }
+        },
+        {
+          "if": { "properties": { "packaging": { "const": "condensed" } }, "required": ["packaging"] },
+          "then": {
+            "required": ["timescale", "role"],
+            "properties": {
+              "role": { "const": "repair" },
+              "timescale": { "$ref": "#/$defs/positiveInteger" }
+            },
+            "anyOf": [
+              {
+                "properties": { "groupDurationMs": { "$ref": "#/$defs/positiveInteger" } },
+                "required": ["groupDurationMs"]
+              },
+              {
+                "properties": { "groupDurationTicks": { "$ref": "#/$defs/positiveInteger" } },
+                "required": ["groupDurationTicks"]
+              }
+            ],
+            "not": {
+              "anyOf": [
+                { "properties": { "mmtpMode": true }, "required": ["mmtpMode"] },
+                { "properties": { "fec": true }, "required": ["fec"] },
+                { "properties": { "repairLayer": true }, "required": ["repairLayer"] },
+                { "properties": { "repairSymbols": true }, "required": ["repairSymbols"] },
+                { "properties": { "sourceSymbols": true }, "required": ["sourceSymbols"] },
+                { "properties": { "scope": true }, "required": ["scope"] }
+              ]
+            }
+          }
+        }
+      ]
+    },
+    "fec": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["algorithm", "sourceSymbols", "repairSymbols", "symbolSize", "repairTrack"],
+      "properties": {
+        "algorithm": { "enum": ["raptorq", "reed-solomon"] },
+        "sourceSymbols": { "$ref": "#/$defs/positiveInteger" },
+        "repairSymbols": { "$ref": "#/$defs/positiveInteger" },
+        "symbolSize": { "$ref": "#/$defs/positiveInteger" },
+        "interleaveDepthMs": { "$ref": "#/$defs/positiveInteger" },
+        "reorderToleranceMs": { "$ref": "#/$defs/nonNegativeNumber" },
+        "repairTrack": { "type": "string", "minLength": 1 },
+        "repairContainer": { "const": "native" },
+        "mode": { "enum": ["interleaved", "object"] }
+      },
+      "allOf": [
+        {
+          "if": { "properties": { "algorithm": { "const": "raptorq" } }, "required": ["algorithm"] },
+          "then": {
+            "properties": {
+              "symbolSize": { "type": "integer", "minimum": 1, "multipleOf": 8 },
+              "sourceSymbols": { "type": "integer", "maximum": 56403 },
+              "repairSymbols": { "type": "integer", "maximum": 16777215 }
+            }
+          }
+        }
+      ]
+    },
+    "endpointTrack": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["name", "packetId"],
+      "properties": {
+        "name": { "type": "string", "minLength": 1 },
+        "packetId": { "type": "integer", "minimum": 0, "maximum": 65535 }
+      }
+    },
+    "endpoint": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["groupAddress", "port", "tracks"],
+      "properties": {
+        "protocol": { "enum": ["ssm", "asm", "amt", "atsc3"] },
+        "sourceAddress": { "type": "string", "minLength": 1 },
+        "groupAddress": { "type": "string", "minLength": 1 },
+        "port": { "type": "integer", "minimum": 1, "maximum": 65535 },
+        "tracks": {
+          "type": "array",
+          "minItems": 1,
+          "items": { "$ref": "#/$defs/endpointTrack" }
+        },
+        "bandwidth": { "$ref": "#/$defs/positiveInteger" }
+      },
+      "allOf": [
+        {
+          "anyOf": [
+            { "properties": { "protocol": true }, "required": ["protocol"] },
+            { "properties": { "sourceAddress": true }, "required": ["sourceAddress"] }
+          ]
+        },
+        {
+          "if": { "properties": { "protocol": { "const": "ssm" } }, "required": ["protocol"] },
+          "then": {
+            "required": ["sourceAddress"],
+            "properties": { "sourceAddress": { "type": "string", "minLength": 1 } }
+          }
+        }
+      ]
+    },
+    "networkSource": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["type", "discovery"],
+          "properties": {
+            "type": { "const": "amt" },
+            "discovery": { "enum": ["driad", "manual"] },
+            "relay": { "type": "string", "minLength": 1 },
+            "port": { "type": "integer", "minimum": 1, "maximum": 65535 }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["type", "frequency", "plpId", "serviceId", "slsUri"],
+          "properties": {
+            "type": { "const": "atsc3" },
+            "frequency": { "$ref": "#/$defs/positiveInteger" },
+            "plpId": { "type": "integer", "minimum": 0, "maximum": 63 },
+            "serviceId": { "type": "integer", "minimum": 0, "maximum": 65535 },
+            "slsUri": { "type": "string", "format": "uri" }
+          }
+        }
+      ]
+    },
+    "multicastAuthTrack": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["mediaTrack", "manifestTrack", "authScope", "sourceSymbolFormat"],
+      "properties": {
+        "mediaTrack": { "type": "string", "minLength": 1 },
+        "manifestTrack": { "type": "string", "minLength": 1 },
+        "authScope": { "type": "string", "pattern": "^[A-Za-z0-9_-]{42}[AEIMQUYcgkosw048]$" },
+        "sourceSymbolFormat": { "type": "string", "minLength": 1 }
+      }
+    },
+    "multicastAuth": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["scheme", "hash", "sig", "publicKey", "keyId", "compaction", "tracks"],
+      "properties": {
+        "scheme": { "const": "bc-provenance" },
+        "hash": { "const": "blake3" },
+        "sig": { "const": "ed25519" },
+        "publicKey": { "type": "string", "pattern": "^[A-Za-z0-9_-]{42}[AEIMQUYcgkosw048]$" },
+        "keyId": { "type": "string", "minLength": 1 },
+        "previousKey": { "type": "string", "pattern": "^[A-Za-z0-9_-]{42}[AEIMQUYcgkosw048]$" },
+        "compaction": { "enum": ["merkle", "none"] },
+        "enforcement": { "enum": ["shadow", "enforce"] },
+        "tracks": {
+          "type": "array",
+          "minItems": 1,
+          "uniqueItems": true,
+          "uniqueMulticastAuthTrackBindings": true,
+          "items": { "$ref": "#/$defs/multicastAuthTrack" }
+        }
+      }
+    },
+    "multicast": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["endpoints", "networkSource"],
+      "properties": {
+        "endpoints": {
+          "type": "array",
+          "minItems": 1,
+          "items": { "$ref": "#/$defs/endpoint" }
+        },
+        "networkSource": {
+          "type": "array",
+          "minItems": 1,
+          "items": { "$ref": "#/$defs/networkSource" }
+        }
+      }
+    }
+  }
+}