@danything/arib 2.1.0 → 2.2.0

package/dist/tlv-ip.d.ts

@@ -0,0 +1,44 @@
+/**
+ * TLV パケットに入った IP を読み、UDP の中身 (MMTP・NTP) を返す (ARIB STD-B32 第 3 部)。
+ *
+ * 4K の放送の映像・音声・信号は、IPv6 の UDP で運ぶ MMTP に入っている。帯域を節約するため、
+ * ほとんどのパケットは IP と UDP のヘッダーを省いた「ヘッダー圧縮した IP」(TLV の種類 0x03) で来る。
+ * 同じ宛先の並びには CID (context_id) が振られ、ときどき来る全部のヘッダー (圧縮の種類 0x60) で
+ * 宛先を知らせ、あいだは CID だけ (0x61) になる。
+ *
+ * 実機 (ケーブルで受けた BS4K) で来たのは、0x60 と 0x61 のほかは NTP を運ぶ素の IPv6 だけだった。
+ * IPv4 の圧縮 (0x20・0x21) は来ていないので読まない。
+ */
+import { type TlvPacket } from "./tlv.js";
+/** UDP の宛先と送り元 */
+export interface UdpAddress {
+    source: string;
+    destination: string;
+    sourcePort: number;
+    destinationPort: number;
+}
+export interface UdpDatagram {
+    /**
+     * 同じ宛先の並びを見分けるキー。圧縮したものは `cid:<CID>`、圧縮していないものは宛先のアドレスとポート。
+     * MMTP の packet_id はこの並びの中でだけ決まっている
+     */
+    flow: string;
+    /** 宛先と送り元。0x61 の CID の 0x60 をまだ受けていなければ null */
+    address: UdpAddress | null;
+    payload: Uint8Array;
+}
+/** IPv6 のアドレス 16 バイトを文字列に (0 の続く所は縮めず、各グループの先頭の 0 だけ落とす) */
+export declare function ipv6Text(data: Uint8Array, at: number): string;
+/**
+ * TLV パケットから UDP を取り出す。**CID ごとの宛先を覚える**ので、1 つの TLV のストリームに 1 つ使う。
+ *
+ * 圧縮したものは、CID の宛先をまだ知らなくても中身を返す (`address` が null)。
+ * 圧縮できるのは UDP だけなので中身は UDP の中身と決まっていて、MMTP は宛先を知らなくても読める。
+ * 全部のヘッダーは 1 秒に 10 回ほどしか来ないので、待つと選局したての 0.1 秒ぶんを捨てることになる
+ */
+export declare class TlvIpReader {
+    private readonly contexts;
+    /** IP を運ぶ TLV パケットでなければ・UDP でなければ null */
+    read(packet: TlvPacket): UdpDatagram | null;
+    private compressed;
+}

package/dist/tlv-ip.js

@@ -0,0 +1,118 @@
+/**
+ * TLV パケットに入った IP を読み、UDP の中身 (MMTP・NTP) を返す (ARIB STD-B32 第 3 部)。
+ *
+ * 4K の放送の映像・音声・信号は、IPv6 の UDP で運ぶ MMTP に入っている。帯域を節約するため、
+ * ほとんどのパケットは IP と UDP のヘッダーを省いた「ヘッダー圧縮した IP」(TLV の種類 0x03) で来る。
+ * 同じ宛先の並びには CID (context_id) が振られ、ときどき来る全部のヘッダー (圧縮の種類 0x60) で
+ * 宛先を知らせ、あいだは CID だけ (0x61) になる。
+ *
+ * 実機 (ケーブルで受けた BS4K) で来たのは、0x60 と 0x61 のほかは NTP を運ぶ素の IPv6 だけだった。
+ * IPv4 の圧縮 (0x20・0x21) は来ていないので読まない。
+ */
+import { u16 } from "./bytes.js";
+import { TLV_COMPRESSED_IP, TLV_IPV4, TLV_IPV6, } from "./tlv.js";
+/** 0x60: IPv6 のヘッダー (payload_length を除いた 38 バイト) と UDP のヘッダー (length と checksum を除いた 4 バイト) */
+const COMPRESSED_IPV6_UDP = 0x60;
+/** 0x61: ヘッダー無し。宛先は同じ CID の 0x60 で知らせたもの */
+const COMPRESSED_NONE = 0x61;
+const COMPRESSED_HEAD = 3;
+const PARTIAL_IPV6 = 38;
+const PARTIAL_UDP = 4;
+const IPV6_HEADER = 40;
+const UDP_HEADER = 8;
+const PROTOCOL_UDP = 17;
+/** IPv6 のアドレス 16 バイトを文字列に (0 の続く所は縮めず、各グループの先頭の 0 だけ落とす) */
+export function ipv6Text(data, at) {
+    const groups = [];
+    for (let i = 0; i < 16; i += 2)
+        groups.push(u16(data, at + i).toString(16));
+    return groups.join(":");
+}
+function ipv4Text(data, at) {
+    return [0, 1, 2, 3].map((i) => data[at + i]).join(".");
+}
+/**
+ * TLV パケットから UDP を取り出す。**CID ごとの宛先を覚える**ので、1 つの TLV のストリームに 1 つ使う。
+ *
+ * 圧縮したものは、CID の宛先をまだ知らなくても中身を返す (`address` が null)。
+ * 圧縮できるのは UDP だけなので中身は UDP の中身と決まっていて、MMTP は宛先を知らなくても読める。
+ * 全部のヘッダーは 1 秒に 10 回ほどしか来ないので、待つと選局したての 0.1 秒ぶんを捨てることになる
+ */
+export class TlvIpReader {
+    contexts = new Map();
+    /** IP を運ぶ TLV パケットでなければ・UDP でなければ null */
+    read(packet) {
+        const data = packet.payload;
+        switch (packet.type) {
+            case TLV_COMPRESSED_IP:
+                return this.compressed(data);
+            case TLV_IPV6:
+                return ipv6(data);
+            case TLV_IPV4:
+                return ipv4(data);
+            default:
+                return null;
+        }
+    }
+    compressed(data) {
+        if (data.length < COMPRESSED_HEAD)
+            return null;
+        // CID (12 ビット) と sequence number (4 ビット)、圧縮の種類
+        const cid = u16(data, 0) >> 4;
+        const flow = `cid:${cid}`;
+        switch (data[2]) {
+            case COMPRESSED_IPV6_UDP: {
+                const at = COMPRESSED_HEAD;
+                const payloadAt = at + PARTIAL_IPV6 + PARTIAL_UDP;
+                if (data.length < payloadAt)
+                    return null;
+                // 38 バイトの並びは version・traffic class・flow label (4)、next header (1)、hop limit (1)、送り元 (16)、宛先 (16)
+                const address = {
+                    source: ipv6Text(data, at + 6),
+                    destination: ipv6Text(data, at + 22),
+                    sourcePort: u16(data, at + PARTIAL_IPV6),
+                    destinationPort: u16(data, at + PARTIAL_IPV6 + 2),
+                };
+                this.contexts.set(cid, address);
+                return { flow, address, payload: data.subarray(payloadAt) };
+            }
+            case COMPRESSED_NONE:
+                return {
+                    flow,
+                    address: this.contexts.get(cid) ?? null,
+                    payload: data.subarray(COMPRESSED_HEAD),
+                };
+            default:
+                return null;
+        }
+    }
+}
+/** 素の IPv6 の UDP。拡張ヘッダーの付いたものは読まない (来ていない) */
+function ipv6(data) {
+    if (data.length < IPV6_HEADER + UDP_HEADER || data[6] !== PROTOCOL_UDP)
+        return null;
+    const end = Math.min(data.length, IPV6_HEADER + u16(data, 4));
+    return udp(data, ipv6Text(data, 8), ipv6Text(data, 24), IPV6_HEADER, end);
+}
+function ipv4(data) {
+    if (data.length < 20 || data[9] !== PROTOCOL_UDP)
+        return null;
+    const header = (data[0] & 0x0f) * 4;
+    const end = Math.min(data.length, u16(data, 2));
+    return udp(data, ipv4Text(data, 12), ipv4Text(data, 16), header, end);
+}
+function udp(data, source, destination, at, end) {
+    if (at + UDP_HEADER > end)
+        return null;
+    const address = {
+        source,
+        destination,
+        sourcePort: u16(data, at),
+        destinationPort: u16(data, at + 2),
+    };
+    return {
+        flow: `${destination}:${address.destinationPort}`,
+        address,
+        payload: data.subarray(at + UDP_HEADER, Math.min(end, at + u16(data, at + 4))),
+    };
+}

package/dist/tlv.d.ts

@@ -0,0 +1,43 @@
+/**
+ * TLV パケット (ARIB STD-B32 第 3 部) を切り出す。4K の放送 (MMT/TLV) の土台で、TS の `PacketStream` と同じ役。
+ *
+ * TLV パケットは `0x7F`・種類 (1 バイト)・長さ (2 バイト) のヘッダーと、長さぶんの中身でできている。
+ * 長さが毎回違うので、TS のように決まった間隔で同期のバイトを探すことはできない。
+ * エージェントはケーブルの分割 TLV を組み立て直した TLV のバイト列を流す
+ * ([agent.md](https://github.com/danything/denpa/blob/main/docs/agent.md))。
+ */
+export declare const TLV_IPV4 = 1;
+export declare const TLV_IPV6 = 2;
+/** ヘッダー圧縮した IP (`tlv-ip.ts`) */
+export declare const TLV_COMPRESSED_IP = 3;
+/** 伝送制御信号 (TLV-SI。TLV-NIT・AMT のセクションが並ぶ) */
+export declare const TLV_SIGNALING = 254;
+export declare const TLV_NULL = 255;
+export interface TlvPacket {
+    type: number;
+    /** ヘッダーを除いた中身 */
+    payload: Uint8Array;
+    /** ヘッダーを含めたパケット全体。1 局に絞るとき (`mmt-service-filter.ts`) はこれをそのまま出す */
+    bytes: Uint8Array;
+}
+/**
+ * 任意の長さで届く TLV のバイト列を TLV パケットに切り分ける。
+ *
+ * **先頭がパケットの先頭とは限らない。** 共有に途中から入った利用者は、TLV パケットの途中から受け取る
+ * ([agent.md](https://github.com/danything/denpa/blob/main/docs/agent.md))。そこで、同期が取れていないときは
+ * 先頭のバイトと種類が合い、**長さの先にある次のパケットの先頭も合う**位置を探して合わせる。
+ * 1 か所だけで決めると、中身にたまたまある `7F 03` を先頭と取り違える。そのため、同期を取る最初のパケットは次のパケットの先頭が届くまで出さない。
+ * 同期が取れたあとは、先頭が合わなくなるまでヘッダーの長さのとおりに進む。
+ *
+ * 出すパケットの中身は、渡されたチャンクか前の残りの一部を指す (コピーしない)。
+ * **次の `feed` より後まで持つならコピーすること** (`PacketStream` と同じ)
+ */
+export declare class TlvStream {
+    private rest;
+    private synced;
+    /** 合わせるために読み飛ばしたバイトの合計 */
+    skipped: number;
+    /** 同期を失って合わせ直した回数 */
+    resyncs: number;
+    feed(chunk: Uint8Array): Generator<TlvPacket>;
+}

package/dist/tlv.js

@@ -0,0 +1,119 @@
+/**
+ * TLV パケット (ARIB STD-B32 第 3 部) を切り出す。4K の放送 (MMT/TLV) の土台で、TS の `PacketStream` と同じ役。
+ *
+ * TLV パケットは `0x7F`・種類 (1 バイト)・長さ (2 バイト) のヘッダーと、長さぶんの中身でできている。
+ * 長さが毎回違うので、TS のように決まった間隔で同期のバイトを探すことはできない。
+ * エージェントはケーブルの分割 TLV を組み立て直した TLV のバイト列を流す
+ * ([agent.md](https://github.com/danything/denpa/blob/main/docs/agent.md))。
+ */
+import { concatBytes, u16 } from "./bytes.js";
+/** TLV パケットの先頭のバイト (上位 2 ビットが 01、残りは予約で 1) */
+const TLV_SYNC = 0x7f;
+const HEADER = 4;
+export const TLV_IPV4 = 0x01;
+export const TLV_IPV6 = 0x02;
+/** ヘッダー圧縮した IP (`tlv-ip.ts`) */
+export const TLV_COMPRESSED_IP = 0x03;
+/** 伝送制御信号 (TLV-SI。TLV-NIT・AMT のセクションが並ぶ) */
+export const TLV_SIGNALING = 0xfe;
+export const TLV_NULL = 0xff;
+const TYPES = new Set([
+    TLV_IPV4,
+    TLV_IPV6,
+    TLV_COMPRESSED_IP,
+    TLV_SIGNALING,
+    TLV_NULL,
+]);
+/** `at` が TLV パケットの先頭に見えるか (先頭のバイトと種類) */
+function looksLikeHead(data, at) {
+    return data[at] === TLV_SYNC && TYPES.has(data[at + 1]);
+}
+/**
+ * 任意の長さで届く TLV のバイト列を TLV パケットに切り分ける。
+ *
+ * **先頭がパケットの先頭とは限らない。** 共有に途中から入った利用者は、TLV パケットの途中から受け取る
+ * ([agent.md](https://github.com/danything/denpa/blob/main/docs/agent.md))。そこで、同期が取れていないときは
+ * 先頭のバイトと種類が合い、**長さの先にある次のパケットの先頭も合う**位置を探して合わせる。
+ * 1 か所だけで決めると、中身にたまたまある `7F 03` を先頭と取り違える。そのため、同期を取る最初のパケットは次のパケットの先頭が届くまで出さない。
+ * 同期が取れたあとは、先頭が合わなくなるまでヘッダーの長さのとおりに進む。
+ *
+ * 出すパケットの中身は、渡されたチャンクか前の残りの一部を指す (コピーしない)。
+ * **次の `feed` より後まで持つならコピーすること** (`PacketStream` と同じ)
+ */
+export class TlvStream {
+    rest = new Uint8Array(0);
+    synced = false;
+    /** 合わせるために読み飛ばしたバイトの合計 */
+    skipped = 0;
+    /** 同期を失って合わせ直した回数 */
+    resyncs = 0;
+    *feed(chunk) {
+        let data = chunk;
+        if (this.rest.length > 0) {
+            /*
+             * 前の残りが同期の取れたパケットの途中なら、そのパケットだけをチャンクの先頭と繋ぐ。
+             * **チャンクの全体は写さない** (38 Mbps を毎回写すことになる)
+             */
+            const head = concatBytes([this.rest, chunk.subarray(0, HEADER)]);
+            if (this.synced && head.length >= HEADER && looksLikeHead(head, 0)) {
+                const used = HEADER + u16(head, 2) - this.rest.length;
+                if (used > chunk.length) {
+                    this.rest = concatBytes([this.rest, chunk]);
+                    return;
+                }
+                const packet = concatBytes([this.rest, chunk.subarray(0, used)]);
+                yield {
+                    type: packet[1],
+                    payload: packet.subarray(HEADER),
+                    bytes: packet,
+                };
+                data = chunk.subarray(used);
+            }
+            else
+                data = concatBytes([this.rest, chunk]);
+        }
+        let at = 0;
+        for (;;) {
+            if (!this.synced) {
+                const found = findHead(data, at);
+                // 見つからなければ、次のチャンクと繋げて探せるよう末尾の 3 バイトだけを残す
+                const next = found?.at ?? Math.max(at, data.length - (HEADER - 1));
+                this.skipped += next - at;
+                at = next;
+                if (found === null || found.wait)
+                    break;
+                this.synced = true;
+            }
+            if (at + HEADER > data.length)
+                break;
+            if (!looksLikeHead(data, at)) {
+                this.synced = false;
+                this.resyncs++;
+                continue;
+            }
+            const end = at + HEADER + u16(data, at + 2);
+            if (end > data.length)
+                break;
+            yield {
+                type: data[at + 1],
+                payload: data.subarray(at + HEADER, end),
+                bytes: data.subarray(at, end),
+            };
+            at = end;
+        }
+        this.rest = data.slice(at);
+    }
+}
+/** `from` から、先頭と次のパケットの先頭がどちらも合う位置を探す */
+function findHead(data, from) {
+    for (let at = from; at + HEADER <= data.length; at++) {
+        if (!looksLikeHead(data, at))
+            continue;
+        const next = at + HEADER + u16(data, at + 2);
+        if (next + 2 > data.length)
+            return { at, wait: true };
+        if (looksLikeHead(data, next))
+            return { at, wait: false };
+    }
+    return null;
+}

package/dist/ttml.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 4K の放送 (MMT/TLV) の字幕 (ARIB STD-B62 の TTML) を、字幕の文字の配置 (`caption-text.ts`) にする。
+ * TS の字幕の `b24caption.ts` に当たり、受け側は TS の字幕と同じように描くだけで済む。
+ *
+ * 字幕の文書は MPU 1 つに 1 つ来る (`mmt-media.ts` の `CaptionUnit`)。文書の中の時刻 (begin・end・dur) は、
+ * MPU の最初の提示時刻からのずれとして読む (推定。字幕のパケットは実機の録りにまだ来ていない)。
+ *
+ * 読むのは文字・位置 (region の origin・extent、textAlign・displayAlign)・大きさ (fontSize・lineHeight)・
+ * 色 (color・backgroundColor・textOutline)・太字・斜体・下線・ルビ。画像を参照する字幕 (PNG) と
+ * 縦書き・アニメーション (set) は読まない
+ */
+import { type CaptionPage } from "./caption-text.js";
+/** 字幕 1 枚と、出す時刻 (90 kHz) */
+export interface TimedCaptionPage {
+    at: number;
+    page: CaptionPage;
+}
+/**
+ * TTML の文書を、出す時刻ごとの字幕の文字の配置にする。`start` は文書の時刻の始まり (MPU の最初の提示時刻、90 kHz)。
+ *
+ * 段落 (p) の出る・消える時刻ごとに 1 枚を作る (`CaptionPage` は前の 1 枚を丸ごと置き換えるので、
+ * その時刻に出ている段落を全部並べる)。最初の 1 枚は `start` で、何も出ていなければ空 (前の文書の字幕を消す)。
+ * 読めない文書は空の並びを返す
+ */
+export declare function ttmlPages(document: string, start: number): TimedCaptionPage[];