@danything/arib 1.0.2 → 1.2.1

package/dist/psi.d.ts

@@ -1,10 +1,12 @@
 /**
  * TS の土台 (パケットの切り出し・セクションの組み立て・PAT/PMT) と、局の一覧。
  * 局の一覧はチャンネルスキャンで「この物理チャンネルに何が入っているか」を知るために使い、
- * 読むのは NIT と SDT の2つ。
+ * 読むのは NIT と SDT の 2 つ。
  *
- * - NIT (PID 0x0010) … ネットワークID と、地上波ならリモコン番号
- * - SDT (PID 0x0011) … その TS に入っているサービスのIDと種別
+ * - NIT (PID 0x0010) … ネットワーク ID と、地上波ならリモコン番号。衛星はネットワークの全部の TS
+ *   (TSID・周波数・サービスの一覧) が載っている (`NitReader`)
+ * - SDT (PID 0x0011) … その TS に入っているサービスの ID と種別。衛星はほかの TS のぶん
+ *   (SDT[other]) も流れている (`SdtReader`)
  *
  * 局名も SDT から読む。ARIB の文字符号は独自だが、番組表を自分で集めるなら
  * どのみち要るので [aribtext.ts](aribtext.ts) に寄せてある。
@@ -15,16 +17,26 @@ export declare const SYNC = 71;
 export declare function packetPid(packet: Uint8Array): number;
 /** PAT。どの PID に PMT があるかを持つ。**入口はいつもここ** */
 export declare const PID_PAT = 0;
+export declare const PID_NIT = 16;
 export declare const PID_SDT = 17;
 export declare const TABLE_PAT = 0;
 export declare const TABLE_PMT = 2;
+export declare const TABLE_NIT_ACTUAL = 64;
+export declare const TABLE_NIT_OTHER = 65;
 export declare const TABLE_SDT_ACTUAL = 66;
+export declare const TABLE_SDT_OTHER = 70;
+/**
+ * スキャンで残すサービス種別。Mirakurun のスキャンが通しているものと同じで、
+ * ラジオ (0x02) とデータ (0xc0) も入る。映像の無いものを番組表に並べないのは
+ * 取り込むほう (denpa の epg.ts の DIGITAL_TV)
+ */
+export declare const SERVICE_TYPES: Set<number>;
 /**
  * セクション本体に CRC32 を付けて仕上げる。`section_length` も実長に直す。
  *
- * **書く側が2つある。** PAT を書き直して流す `service-filter.ts` と、
+ * **書く側が 2 つある。** PAT を書き直して流す `service-filter.ts` と、
  * 偽の放送を組み立てる `synth.ts`。長さの直し方を間違えると読む側が黙って
- * 捨てるだけなので、1箇所に置く。
+ * 捨てるだけなので、1 箇所に置く。
  */
 export declare function withCrc(body: number[]): Uint8Array;
 export interface Service {
@@ -48,26 +60,26 @@ export interface NetworkInfo {
  *
  * セクションは TS パケットをまたいで運ばれ、パケットの切れ目とは無関係な
  * 位置で終わる。payload_unit_start_indicator と pointer_field を見て
- * 頭を合わせ、section_length ぶん溜まったら1本として吐く。
+ * 頭を合わせ、section_length ぶん溜まったら 1 本として返す。
  */
 export declare class SectionAssembler {
     private readonly pid;
     private readonly crc;
     private buffer;
     /**
-     * @param pid 読むPID
+     * @param pid 読む PID
      * @param crc CRC の見方。
-     *   `always` … 末尾4バイトを CRC32 とみなして必ず確かめる (PSI はこちら)
+     *   `always` … 末尾 4 バイトを CRC32 とみなして必ず確かめる (PSI はこちら)
      *   `syntax` … `section_syntax_indicator` が立っているときだけ確かめる。
      *     DSM-CC は立っていないと末尾が CRC ではなく Checksum なので、
      *     いつも確かめると**全部捨ててしまう**
      */
     constructor(pid: number, crc?: "always" | "syntax");
     /**
-     * パケットを1つ食わせる。組み上がったセクションを返す。
+     * パケットを 1 つ渡す。組み上がったセクションを返す。
      *
      * 返りは**読むだけ**にすること。何も組み上がらないとき (ほとんどのパケット) は
-     * 使い回しの空配列を返す — 関係ないパケットのたびに配列を作っていた
+     * 使い回しの空配列を返す (関係ないパケットのたびに配列を作っていた)
      */
     feed(packet: Uint8Array): readonly Uint8Array[];
     private append;
@@ -79,7 +91,7 @@ export declare function findSync(data: Uint8Array, from?: number, until?: number
  * 任意の長さで届くバイト列を 188 バイトのパケットに切り分ける。
  *
  * 頭が必ずパケットの先頭とは限らず、電波が弱いと途中で数バイト落ちる。
- * ずれたままだと**以降ずっと1パケットも読めなくなる**ので、頭が 0x47 でなければ
+ * ずれたままだと**以降ずっと 1 パケットも読めなくなる**ので、頭が 0x47 でなければ
  * 取り直す。普段は先頭が 0x47 なので、探しに行くのはずれたときだけ。
  *
  * **出すパケットは渡された塊の上の窓** (写しではない。写すと録画の処理の 1/3 を食う)。
@@ -92,8 +104,8 @@ export declare class PacketStream {
     feed(chunk: Uint8Array): Generator<Uint8Array>;
 }
 /**
- * PAT から1つの局の PMT を追う。`serviceId` を渡さなければ PAT の最初の局
- * (1局に絞った TS を食わせるところ)。PAT で PMT の PID が替われば組み立て直す
+ * PAT から 1 つの局の PMT を追う。`serviceId` を渡さなければ PAT の最初の局
+ * (1 局に絞った TS を渡すところ)。PAT で PMT の PID が替われば組み立て直す
  */
 export declare class PmtTracker {
     private readonly serviceId?;
@@ -102,7 +114,7 @@ export declare class PmtTracker {
     /** 追っている PMT の PID。PAT を読むまでは null。替わったかは呼ぶ前後で比べる */
     pid: number | null;
     constructor(serviceId?: number | undefined);
-    /** パケットを1つ (`pid` はその PID)。組み上がった PMT のセクションを返す */
+    /** パケットを 1 つ (`pid` はその PID)。組み上がった PMT のセクションを返す */
     feed(packet: Uint8Array, pid: number): readonly Uint8Array[];
 }
 /** 記述子の並びを (tag, 中身) に切り分ける */
@@ -112,8 +124,8 @@ export declare const DESC_DIGITAL_COPY_CONTROL = 193;
 /**
  * デジタルコピー制御記述子の中身 (タグと長さを除いたもの) から、**コピー禁止か**を読む。
  *
- * 先頭2ビットの digital_recording_control_data が 11 なら禁止
- * (00 コピー可、01 事業者定義、10 1世代のみ)。禁止の番組は録らない
+ * 先頭 2 ビットの digital_recording_control_data が 11 なら禁止
+ * (00 コピー可、01 事業者定義、10 1 世代のみ)。禁止の番組は録らない
  * ([data.md](https://github.com/danything/denpa/blob/main/docs/data.md)「コピー禁止の番組は録らない」)
  */
 export declare function isCopyNever(data: Uint8Array): boolean;
@@ -130,26 +142,152 @@ export declare function pmtProgramInfo(section: Uint8Array): Uint8Array;
  * だけ**にして、選り分けは呼ぶ側に置いてあります。
  */
 export declare function pmtStreams(section: Uint8Array): Generator<[number, number, Uint8Array]>;
-/** PAT から `サービスID → PMT の PID`。サービス0 は NIT なので飛ばす */
+/** PAT から `サービスID → PMT の PID`。サービス 0 は NIT なので飛ばす */
 export declare function parsePat(section: Uint8Array): Map<number, number>;
 /**
  * SDT のサービスの並びを (service_id, 記述子の並び) に切り分ける。
  *
- * **読む側が2つある。** 局名 (`parseSdt`) とロゴの対応 (denpa の `ts/logo.ts`) で、
- * 欲しい記述子が違うだけで歩き方は同じ。並びの読み方をここ1箇所に置く。
+ * **読む側が 2 つある。** 局名 (`parseSdt`) とロゴの対応 (denpa の `ts/logo.ts`) で、
+ * 欲しい記述子が違うだけで歩き方は同じ。並びの読み方をここ 1 箇所に置く。
  */
 export declare function sdtServices(section: Uint8Array): Generator<[number, Uint8Array]>;
 /** SDT からサービスの一覧を読む。自分の TS のものだけ */
 export declare function parseSdt(section: Uint8Array): TransportInfo | null;
-/** NIT からネットワークIDとリモコン番号、他の TS の顔ぶれを読む */
+/**
+ * SDT[other] からサービスの一覧を読む。**ほかの TS のもの。**
+ *
+ * 衛星は、どの TS にもネットワークのほかの TS の局名を流している (番組表の EIT[other] と同じ考え)。
+ * 開いていない TS の局名をこれで知る。TS ごとに別のセクションで来るので、集めるのは `SdtReader`
+ */
+export declare function parseSdtOther(section: Uint8Array): TransportInfo | null;
+/** 衛星の分配の記述子 (0x43)。どの周波数で流れているか */
+export interface SatelliteDelivery {
+    kind: "satellite";
+    /**
+     * 周波数 (kHz)。**放送の周波数そのもの** (BS-1 は 11727480)。
+     * チューナーに渡す中間周波数は、ここから LNB の局発の周波数 (BS・CS は 10678 MHz) を引いたもの
+     */
+    frequency: number;
+    /** 軌道位置 (0.1 度単位。東経 110 度は 1100) */
+    orbitalPosition: number;
+    /** 東経なら true */
+    east: boolean;
+    /** 偏波。0 水平・1 垂直・2 左旋・3 右旋 */
+    polarization: number;
+    /** 変調方式 (ARIB STD-B10 の値のまま) */
+    modulation: number;
+    /** シンボルレート (シンボル/秒) */
+    symbolRate: number;
+    /** 内符号 (ARIB STD-B10 の値のまま) */
+    fec: number;
+}
+/** 地上の分配の記述子 (0xFA)。地上波は自分の TS のぶんしか載らない */
+export interface TerrestrialDelivery {
+    kind: "terrestrial";
+    /** 地域の識別 (ARIB STD-B10 の area_code) */
+    areaCode: number;
+    guardInterval: number;
+    transmissionMode: number;
+    /** 周波数 (Hz)。中継局ごとに並ぶことがある。放送は 1/7 MHz 単位で書く */
+    frequencies: number[];
+}
+export type Delivery = SatelliteDelivery | TerrestrialDelivery;
+/** NIT の TS の 1 件。サービスの一覧に、どこで流れているかが付く */
+export interface NetworkTransport extends TransportInfo {
+    delivery: Delivery | null;
+}
+/** NIT のセクション 1 つ。表は何本かのセクションに分かれて来るので、そろえるのは `NitReader` */
+export interface NitSection {
+    /** NIT[other] (ほかのネットワークのもの) なら true */
+    other: boolean;
+    networkId: number;
+    version: number;
+    /** current_next_indicator。0 (これから使う表) のものは `NitReader` が読まない */
+    current: boolean;
+    sectionNumber: number;
+    lastSectionNumber: number;
+    remoteControlKeyId: number | null;
+    transportStreams: NetworkTransport[];
+}
+/** NIT のセクションを 1 つ読む。actual (0x40) と other (0x41) のどちらも */
+export declare function parseNitSection(section: Uint8Array): NitSection | null;
+/**
+ * NIT からネットワーク ID とリモコン番号、他の TS の顔ぶれを読む。**セクション 1 つぶん。**
+ * スキャンで「どのネットワークか」を知るにはこれで足りる。ネットワークの全部の TS が要るなら `NitReader`
+ */
 export declare function parseNit(section: Uint8Array): NetworkInfo | null;
+/** そろった NIT。セクションをつないだもの */
+export interface Network {
+    /** NIT[other] なら true */
+    other: boolean;
+    networkId: number;
+    version: number;
+    remoteControlKeyId: number | null;
+    transportStreams: NetworkTransport[];
+}
+/**
+ * NIT を**全部のセクション**そろえて読む。
+ *
+ * 衛星の NIT[actual] には、そのネットワークの全部の TS (TSID・周波数・サービスの一覧) が載っている。
+ * TS が多いと 1 セクション (1024 バイトまで) に収まらないので、ネットワークごとに (actual と other を
+ * 分けて) 集め、そろったものを返す。
+ *
+ * **version が変わっても、新しい表がそろうまでは前の表を返す。** 読む側が見るのは、いつも 1 つの
+ * version でそろった表。全部のセクションが 1 回りするまで (NIT は 10 秒に 1 回は流れるので、長くて 10 秒ほど) は何も返らない。
+ *
+ * 置き換えた 1 つ前の version のセクションが遅れて届いても読まない。読むと、そろったときに表が前に戻る。
+ *
+ * 1 つの中継を読む前提で作ってある。別の中継へ移るときは作り直す。`actual` は、最初にそろった自分のネットワークの表を返す
+ */
+export declare class NitReader {
+    private readonly assembler;
+    private readonly packets;
+    private readonly pending;
+    private readonly done;
+    /** 置き換えた表の version (表ごと) */
+    private readonly replaced;
+    /** 任意の長さのバイト列を渡す。そろった表が増えたか変わったら true */
+    feed(chunk: Uint8Array): boolean;
+    private add;
+    /** 自分のネットワークの表 (NIT[actual])。まだそろっていなければ null */
+    get actual(): Network | null;
+    /** そろった表を全部。actual が先 */
+    networks(): Network[];
+}
+/** そろった SDT。TS 1 本ぶん */
+export interface ServiceTable extends TransportInfo {
+    /** SDT[other] (ほかの TS のもの) なら true */
+    other: boolean;
+    version: number;
+}
+/**
+ * SDT を TS ごとに**全部のセクション**そろえて読む。自分の TS (actual) とほかの TS (other) の両方。
+ *
+ * 衛星はほかの TS の局名も流しているので、1 つの TS を開けばネットワークの局名がそろう
+ * (そろうかは放送しだい。来なかった TS は返らない)。version の扱いと、1 つの中継を読む前提は `NitReader` と同じ
+ */
+export declare class SdtReader {
+    private readonly assembler;
+    private readonly packets;
+    private readonly pending;
+    private readonly done;
+    /** 置き換えた表の version (TS ごと) */
+    private readonly replaced;
+    /** 任意の長さのバイト列を渡す。そろった表が増えたか変わったら true */
+    feed(chunk: Uint8Array): boolean;
+    private add;
+    /** 自分の TS の表 (SDT[actual])。まだそろっていなければ null */
+    get actual(): ServiceTable | null;
+    /** そろった表を全部。actual が先、あとはネットワーク・TSID の順 */
+    tables(): ServiceTable[];
+}
 export interface FoundService extends Service {
     networkId: number;
     transportStreamId: number;
     remoteControlKeyId: number | null;
 }
 /**
- * 流れてくる TS を食べて、NIT と SDT が揃うまで待つ。
+ * 流れてくる TS を読んで、NIT と SDT が揃うまで待つ。
  *
  * Mirakurun のスキャンと同じで、**両方**揃って初めてそのチャンネルを
  * 「受信できた」とみなす。SDT だけ取れても、どのネットワークのものか
@@ -162,7 +300,7 @@ export declare class ServiceReader {
     network: NetworkInfo | null;
     transport: TransportInfo | null;
     get complete(): boolean;
-    /** 任意の長さのバイト列を食わせる。揃ったら true */
+    /** 任意の長さのバイト列を渡す。揃ったら true */
     feed(chunk: Uint8Array): boolean;
     /** 録るに値するサービスだけ。リモコン番号は NIT のものを配る */
     services(): FoundService[];