@danything/arib 0.0.0-stage → 0.1.0

package/dist/bml-protocol.d.ts

@@ -0,0 +1,143 @@
+/**
+ * データ放送の通知の形式。**デコードする側 ([bml.ts](bml.ts)) と描く側の取り決め。**
+ *
+ * もとは web-bml の `protocol` (`ws_api.ts`) を借りていた。形式はそのまま写してある —
+ * 録画の隣に置いた `.bml.jsonl` はこの形式の JSON を1行ずつ持っているので、
+ * **形式を変えると前に録ったものが読めなくなる**。足すのはよいが、名前や意味は変えない。
+ *
+ * 載せるのは denpa が実際に作るものだけ (PMT・モジュール一覧・揃ったモジュール・
+ * ストリーム記述子のイベント・番組の名乗り・放送の時刻)。web-bml が自前の
+ * TS 解析のために持っていた PCR・PES・BIT・映像の URL は作らないので持たない。
+ */
+/** PMT の ES 1本。**部品タグ (`componentId`) を持つものだけ**並ぶ (bml.ts の `parsePmt`) */
+export interface ComponentPMT {
+    pid: number;
+    componentId: number;
+    bxmlInfo?: AdditionalAribBXMLInfo;
+    streamType: number;
+    dataComponentId?: number;
+}
+/** データ符号化方式記述子の後半 (bml.ts の `parseBxmlInfo`) */
+export interface AdditionalAribBXMLInfo {
+    transmissionFormat: number;
+    entryPointFlag: boolean;
+    entryPointInfo?: AdditionalAribBXMLEntryPointInfo;
+    additionalAribCarouselInfo?: AdditionalAribCarouselInfo;
+}
+export interface AdditionalAribBXMLEntryPointInfo {
+    autoStartFlag: boolean;
+    documentResolution: number;
+    useXML: boolean;
+    defaultVersionFlag: boolean;
+    independentFlag: boolean;
+    styleForTVFlag: boolean;
+    bmlMajorVersion: number;
+    bmlMinorVersion: number;
+    bxmlMajorVersion?: number;
+    bxmlMinorVersion?: number;
+}
+export interface AdditionalAribCarouselInfo {
+    dataEventId: number;
+    eventSectionFlag: boolean;
+    ondemandRetrievalFlag: boolean;
+    fileStorableFlag: boolean;
+    startPriority: number;
+}
+/**
+ * `Content-Type` を読んだもの。名前は小文字にそろえ、元の綴りも持つ
+ * ([multipart.ts](multipart.ts) の `parseMediaType`)
+ */
+export interface MediaType {
+    type: string;
+    originalType: string;
+    subtype: string;
+    originalSubtype: string;
+    parameters: MediaTypeParameter[];
+}
+export interface MediaTypeParameter {
+    attribute: string;
+    originalAttribute: string;
+    value: string;
+}
+/** モジュールの中のファイル1つ。中身は base64 (JSON で運ぶため) */
+export interface ModuleFile {
+    contentLocation: string | null;
+    contentType: MediaType;
+    dataBase64: string;
+}
+export interface PMTMessage {
+    type: "pmt";
+    components: ComponentPMT[];
+}
+export interface ModuleDownloadedMessage {
+    type: "moduleDownloaded";
+    componentId: number;
+    moduleId: number;
+    files: ModuleFile[];
+    version: number;
+    dataEventId: number;
+}
+export interface ModuleListEntry {
+    id: number;
+    version: number;
+    size: number;
+}
+export interface ModuleListUpdatedMessage {
+    type: "moduleListUpdated";
+    componentId: number;
+    modules: ModuleListEntry[];
+    dataEventId: number;
+    returnToEntryFlag?: boolean;
+}
+export type ESEvent = ESImmediateEvent | ESNPTEvent | NPTReference;
+export interface ESImmediateEvent {
+    type: "immediateEvent";
+    eventMessageGroupId: number;
+    timeMode: 0;
+    eventMessageType: number;
+    eventMessageId: number;
+    privateDataByte: number[];
+}
+export interface ESNPTEvent {
+    type: "nptEvent";
+    eventMessageGroupId: number;
+    timeMode: 2;
+    eventMessageNPT: number;
+    eventMessageType: number;
+    eventMessageId: number;
+    privateDataByte: number[];
+}
+export interface NPTReference {
+    type: "nptReference";
+    postDiscontinuityIndicator: boolean;
+    dsmContentId: number;
+    STCReference: number;
+    NPTReference: number;
+    scaleNumerator: number;
+    scaleDenominator: number;
+}
+export interface ESEventUpdatedMessage {
+    type: "esEventUpdated";
+    componentId: number;
+    events: ESEvent[];
+    dataEventId: number;
+}
+/** 番組の名乗り。TS からではなく DB から組む (`server/live.ts`・`server/recorded-bml.ts`) */
+export interface ProgramInfoMessage {
+    type: "programInfo";
+    originalNetworkId: number | null;
+    transportStreamId: number | null;
+    serviceId: number | null;
+    eventId: number | null;
+    eventName: string | null;
+    startTimeUnixMillis: number | null;
+    durationSeconds: number | null;
+    indefiniteDuration: boolean | null;
+    networkId: number | null;
+}
+/** 放送の時刻 (TDT/TOT) */
+export interface CurrentTime {
+    type: "currentTime";
+    timeUnixMillis: number;
+}
+export type ResponseMessage = PMTMessage | ModuleDownloadedMessage | ModuleListUpdatedMessage | ESEventUpdatedMessage | ProgramInfoMessage | CurrentTime;

package/dist/bml-protocol.js

@@ -0,0 +1,12 @@
+/**
+ * データ放送の通知の形式。**デコードする側 ([bml.ts](bml.ts)) と描く側の取り決め。**
+ *
+ * もとは web-bml の `protocol` (`ws_api.ts`) を借りていた。形式はそのまま写してある —
+ * 録画の隣に置いた `.bml.jsonl` はこの形式の JSON を1行ずつ持っているので、
+ * **形式を変えると前に録ったものが読めなくなる**。足すのはよいが、名前や意味は変えない。
+ *
+ * 載せるのは denpa が実際に作るものだけ (PMT・モジュール一覧・揃ったモジュール・
+ * ストリーム記述子のイベント・番組の名乗り・放送の時刻)。web-bml が自前の
+ * TS 解析のために持っていた PCR・PES・BIT・映像の URL は作らないので持たない。
+ */
+export {};

package/dist/bml.d.ts

@@ -0,0 +1,87 @@
+/**
+ * データ放送 (ARIB STD-B24 の BML) をデコードする。**1局に絞った TS を食わせると、
+ * 組み立て終わったファイルが出てくる。**
+ *
+ *     TS → PAT → PMT → データ符号化方式記述子 (0xFD) の付いた ES
+ *                       → DII/DDB (カルーセル) → モジュール → ファイル
+ *
+ * ## なぜ自前なのか
+ *
+ * **運び方は衛星のロゴと同じ DSM-CC** で、denpa はそれを既に持っている
+ * ([dsmcc.ts](dsmcc.ts) / [logo-dsmcc.ts](https://github.com/danything/denpa/blob/main/src/lib/ts/logo-dsmcc.ts))。
+ * [web-bml](https://github.com/otya128/web-bml) の `decode_ts.ts` は使わない — 要るのは
+ * その一部だけで、残り (EIT/SDT/NIT・字幕の PES) は自前で読んでおり
+ * ([eit.ts](eit.ts) / [psi.ts](psi.ts) / ffmpeg)、`@chinachu/aribts` も抱えずに済む。
+ *
+ * **出す形式は web-bml の頃のまま** ([bml-protocol.ts](bml-protocol.ts))。録画の隣の
+ * `.bml.jsonl` がこの形式で残っているので、変えると前に録ったものが読めなくなる。
+ * モジュールの中身 (multipart) は [multipart.ts](multipart.ts) がデコードする。
+ */
+import type { AdditionalAribBXMLInfo, ModuleFile, ResponseMessage } from "./bml-protocol.js";
+/**
+ * データ符号化方式記述子の後半を読む。
+ *
+ * 地上波は TR-B14 第二分冊 2.1.4 表2-3、BS/CS は TR-B15 第一分冊 5.1.5 表5-4。
+ *
+ * **`data_component_id` は16ビット** (aribts は8ビットで読んでいる)。
+ */
+export declare function parseBxmlInfo(data: Uint8Array): AdditionalAribBXMLInfo;
+/**
+ * 1局に絞った TS を食わせると、データ放送の通知が出てくる。
+ *
+ * **1つの選局に1つ。** 局を変えたら作り直す — カルーセルは局ごとに別物で、
+ * 組み立て中のものを持ち越すと混ざる。
+ */
+export declare class BmlDecoder {
+    private readonly send;
+    private readonly packets;
+    /** **1局に絞ったあとを食わせる前提。** 入っているサービスは1つなので、最初の局の PMT を追う */
+    private readonly pmt;
+    private readonly time;
+    /** カルーセルが流れている ES。PID ごと */
+    private readonly components;
+    /** 最後に配った PMT。**変わったときだけ配る** */
+    private sent;
+    constructor(send: (message: ResponseMessage) => void);
+    /** 1局に絞った TS を食わせる */
+    feed(chunk: Uint8Array): void;
+    /**
+     * 切り分け済みのパケットを1つ。ライブは同じ TS を時計や Hybridcast とも
+     * 分け合うので、切り分けは1回で済ませて配る (`server/live.ts` の `tap`)。
+     *
+     * **PID で行き先を引く。** 組み立て役を全部に回していた頃は、データ放送と
+     * 関係ない映像のパケットのたびにカルーセルの数だけ呼んでいた。
+     *
+     * `packet` は呼び手の塊の上の窓 (`psi.ts` の `PacketStream`)。**返ったあとまで
+     * 持つなら写すこと** — 塊の入れ物は使い回される
+     */
+    feedPacket(packet: Uint8Array): void;
+    private onPmt;
+    /** TDT / TOT。読み方は [eit.ts](eit.ts) にまとめてある */
+    private onTime;
+    private onCarousel;
+    private onDii;
+    /** 今の DII の一覧を配る。**諦めたモジュールは載せない** */
+    private sendList;
+    /**
+     * **来ないモジュールを諦める** (`GIVE_UP_ROUNDS`)。待っている受け側 (`Resources` の `wait`) は、
+     * DII に無いモジュールを「もう来ない」と決める (`gone`) ので、諦めたものを除いた一覧を配り直して
+     * 待ちを終わらせる。前の DII で配り終えた版のままのもの (受け側が持っている) は一覧から外さず、
+     * 組み立てるのをやめるだけ。次に DII の版が変われば、また待つ
+     */
+    private giveUp;
+    private onDdb;
+    /** 揃ったモジュールを配る */
+    private finish;
+}
+/**
+ * 揃ったモジュールをファイルに分ける。
+ *
+ * **多くは `multipart/mixed`** で、1つのモジュールに BML と画像がまとめて
+ * 入っている。Type 記述子が無いときも中身は multipart なので、同じ扱いにする。
+ */
+export declare function moduleFiles(data: Uint8Array, contentType: string | null): ModuleFile[];
+/** zlib で縮めてあれば伸ばす。伸ばせなければ諦めて null */
+export declare function inflate(data: Uint8Array, compression: {
+    type: number;
+} | null): Uint8Array | null;