@9c5s/node-tcnet 0.5.1

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2021 Christopher Dziomba
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.MD

@@ -0,0 +1,76 @@
+# node-tcnet
+
+> フォーク元: <https://github.com/chdxD1/node-tcnet>
+
+TCNetプロトコルのNode.js実装。Pioneer DJ / ShowKontrol / Event Imagineering GroupのTCNet仕様に準拠。
+
+## インストール
+
+```bash
+npm install @9c5s/node-tcnet
+```
+
+## 使い方
+
+```typescript
+import { TCNetClient, TCNetConfiguration, TCNetDataPacketType, TCNetDataPacketMetadata } from "@9c5s/node-tcnet";
+
+async function main() {
+  const config = new TCNetConfiguration();
+  config.broadcastInterface = "10GbE"; // ネットワークインターフェース名
+
+  const client = new TCNetClient(config);
+
+  client.on("broadcast", (packet) => console.log(packet));
+  client.on("data", (packet) => console.log(packet));
+
+  await client.connect();
+
+  // メタデータ取得 (layer: 0-based)
+  const meta = await client.requestData(TCNetDataPacketType.MetaData, 0);
+  if (meta instanceof TCNetDataPacketMetadata && meta.info) {
+    console.log(meta.info.trackArtist, meta.info.trackTitle);
+  }
+
+  await client.disconnect();
+}
+
+main().catch(console.error);
+```
+
+## 前提条件
+
+以下のいずれかが必要:
+
+- [PRO DJ LINK Bridge](https://www.pioneerdj.com/en/product/software/pro-dj-link-bridge/software/) (Windows / Mac)
+- [ShowKontrol / Beatkontrol](https://www.tc-supply.com/home) (Mac)
+
+## 機能
+
+- [x] TCNetネットワーク接続
+- [x] ステータスイベント受信
+- [x] メタデータリクエスト (アーティスト名、曲名)
+- [x] メトリクスリクエスト
+- [x] タイムスタンプ受信
+- [ ] Time Sync (NTP/PTP相当)
+- [ ] Beat Grid / Wave Formリクエスト
+- [ ] Control機能 (レイヤー制御)
+
+## ドキュメント
+
+詳細は[Wiki](https://github.com/9c5s/node-tcnet/wiki)を参照:
+
+- [Getting Started](https://github.com/9c5s/node-tcnet/wiki/Getting-Started) -- 導入ガイド
+- [API Reference](https://github.com/9c5s/node-tcnet/wiki/API-Reference) -- APIリファレンス
+- [PRO DJ LINK Bridge](https://github.com/9c5s/node-tcnet/wiki/PRO-DJ-LINK-Bridge) -- Bridge固有の制限
+- [TCNet Protocol](https://github.com/9c5s/node-tcnet/wiki/TCNet-Protocol) -- プロトコル仕様
+- [Contributing](https://github.com/9c5s/node-tcnet/wiki/Contributing) -- 開発への参加
+
+## 関連プロジェクト
+
+- [prolink-connect](https://github.com/EvanPurkhiser/prolink-connect) (JS) -- Pro DJ Linkプロトコル直接実装
+- [dysentery](https://github.com/Deep-Symmetry/dysentery) (Java) -- 同上
+
+## 免責事項
+
+Pioneer DJおよびEvent Imagineering Groupの支援・承認を受けていない。製品名・企業名は各所有者の商標または登録商標。

package/dist/index.d.mts

@@ -0,0 +1,325 @@
+import EventEmitter from 'events';
+
+declare enum TCNetMessageType {
+    OptIn = 2,
+    OptOut = 3,
+    Status = 5,
+    TimeSync = 10,
+    Error = 13,
+    Request = 20,
+    ApplicationData = 30,
+    Control = 101,
+    Text = 128,
+    Keyboard = 132,
+    Data = 200,
+    File = 204,
+    Time = 254
+}
+declare enum TCNetDataPacketType {
+    MetricsData = 2,
+    MetaData = 4,
+    BeatGridData = 8,
+    CUEData = 12,
+    SmallWaveFormData = 16,
+    BigWaveFormData = 32,
+    MixerData = 150
+}
+declare enum NodeType {
+    Auto = 1,
+    Master = 2,
+    Slave = 4,
+    Repeater = 8
+}
+interface TCNetReaderWriter {
+    read(): void;
+    write(): void;
+}
+declare abstract class TCNetPacket implements TCNetReaderWriter {
+    buffer: Buffer;
+    header: TCNetManagementHeader;
+    abstract read(): void;
+    abstract write(): void;
+    abstract length(): number;
+    abstract type(): number;
+}
+declare class TCNetManagementHeader implements TCNetReaderWriter {
+    static MAJOR_VERSION: number;
+    static MAGIC_HEADER: string;
+    buffer: Buffer;
+    nodeId: number;
+    minorVersion: number;
+    messageType: TCNetMessageType;
+    nodeName: string;
+    seq: number;
+    nodeType: number;
+    nodeOptions: number;
+    timestamp: number;
+    constructor(buffer: Buffer);
+    read(): void;
+    write(): void;
+}
+declare class TCNetOptInPacket extends TCNetPacket {
+    nodeCount: number;
+    nodeListenerPort: number;
+    uptime: number;
+    vendorName: string;
+    appName: string;
+    majorVersion: number;
+    minorVersion: number;
+    bugVersion: number;
+    read(): void;
+    write(): void;
+    length(): number;
+    type(): number;
+}
+declare class TCNetOptOutPacket extends TCNetPacket {
+    nodeCount: number;
+    nodeListenerPort: number;
+    read(): void;
+    write(): void;
+    length(): number;
+    type(): number;
+}
+declare enum TCNetLayerStatus {
+    IDLE = 0,
+    PLAYING = 3,
+    LOOPING = 4,
+    PAUSED = 5,
+    STOPPED = 6,
+    CUEDOWN = 7,
+    PLATTERDOWN = 8,
+    FFWD = 9,
+    FFRV = 10,
+    HOLD = 11
+}
+declare class TCNetStatusPacket extends TCNetPacket {
+    data: null | {
+        nodeCount: number;
+        nodeListenerPort: number;
+        smpteMode: number;
+        autoMasterMode: number;
+    };
+    layers: Array<{
+        source: number;
+        status: TCNetLayerStatus;
+        trackID: number;
+        name: string;
+    }>;
+    read(): void;
+    write(): void;
+    length(): number;
+    type(): number;
+}
+declare class TCNetRequestPacket extends TCNetPacket {
+    dataType: number;
+    layer: number;
+    read(): void;
+    write(): void;
+    length(): number;
+    type(): number;
+}
+declare enum TCNetTimecodeState {
+    Stopped = 0,
+    Running = 1,
+    ForceReSync = 2
+}
+declare class TCNetTimecode {
+    mode: number;
+    state: TCNetTimecodeState;
+    hours: number;
+    minutes: number;
+    seconds: number;
+    frames: number;
+    read(buffer: Buffer, offset: number): void;
+}
+type TCNetTimePacketLayer = {
+    currentTimeMillis: number;
+    totalTimeMillis: number;
+    beatMarker: number;
+    state: TCNetLayerStatus;
+    onAir: number;
+};
+declare class TCNetTimePacket extends TCNetPacket {
+    private _layers;
+    private _generalSMPTEMode;
+    read(): void;
+    write(): void;
+    length(): number;
+    type(): number;
+    get layers(): TCNetTimePacketLayer[];
+    get generalSMPTEMode(): number;
+}
+declare class TCNetDataPacket extends TCNetPacket {
+    dataType: TCNetDataPacketType;
+    /**
+     * 0-indexed layer ID (0-7)
+     */
+    layer: number;
+    read(): void;
+    write(): void;
+    length(): number;
+    type(): number;
+}
+declare enum TCNetLayerSyncMaster {
+    Slave = 0,
+    Master = 1
+}
+declare class TCNetDataPacketMetrics extends TCNetDataPacket {
+    data: {
+        state: TCNetLayerStatus;
+        syncMaster: TCNetLayerSyncMaster;
+        beatMarker: number;
+        trackLength: number;
+        currentPosition: number;
+        speed: number;
+        beatNumber: number;
+        bpm: number;
+        pitchBend: number;
+        trackID: number;
+    } | null;
+    read(): void;
+    write(): void;
+    length(): number;
+}
+declare class TCNetDataPacketMetadata extends TCNetDataPacket {
+    info: {
+        trackArtist: string;
+        trackTitle: string;
+        trackKey: number;
+        trackID: number;
+    } | null;
+    read(): void;
+    write(): void;
+    length(): number;
+}
+interface Constructable<T> {
+    new (...args: unknown[]): T;
+}
+declare const TCNetPackets: Record<TCNetMessageType, Constructable<TCNetPacket> | null>;
+declare const TCNetDataPackets: Record<TCNetDataPacketType, typeof TCNetDataPacket | null>;
+
+type TCNetLogger = {
+    error: (error: Error) => void;
+    debug: (message: string) => void;
+};
+declare class TCNetConfiguration {
+    logger: TCNetLogger | null;
+    unicastPort: number;
+    applicationCode: number;
+    nodeId: number;
+    nodeName: string;
+    vendorName: string;
+    appName: string;
+    broadcastInterface: string | null;
+    broadcastAddress: string;
+    broadcastListeningAddress: string;
+    requestTimeout: number;
+}
+/**
+ * Low level implementation of the TCNet protocol
+ */
+declare class TCNetClient extends EventEmitter {
+    private config;
+    private broadcastSocket;
+    private unicastSocket;
+    private timestampSocket;
+    private server;
+    private seq;
+    private uptime;
+    private connected;
+    private connectedHandler;
+    private requests;
+    private announcementInterval;
+    /**
+     *
+     * @param config configuration for TCNet access
+     */
+    constructor(config?: TCNetConfiguration);
+    get log(): TCNetLogger | null;
+    /**
+     * Wrapper method to bind a socket with a Promise
+     * @param socket socket to bind
+     * @param port port to bind to
+     * @param address address to bind to
+     * @returns Promise which always resolves (no errors in callback)
+     */
+    private bindSocket;
+    /**
+     * Connect to the TCNet networks
+     */
+    connect(): Promise<void>;
+    /**
+     * Disconnects from TCNet network
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Waiting for unicast from a master
+     */
+    private waitConnected;
+    /**
+     * Parse a packet from a ManagementHeader
+     * @param header the received management header
+     * @returns the parsed packet
+     */
+    private parsePacket;
+    /**
+     * Callback method to receive datagrams on the broadcast socket
+     *
+     * @param msg datagram buffer
+     * @param rinfo remoteinfo
+     */
+    private receiveBroadcast;
+    /**
+     * Callback method to receive datagrams on the unicast socket
+     *
+     * @param msg datagram buffer
+     * @param rinfo remoteinfo
+     */
+    private receiveUnicast;
+    /**
+     * Callback method to receive datagrams on the timestamp socket
+     * @param msg datagram buffer
+     * @param rinfo remoteinfo
+     */
+    private receiveTimestamp;
+    /**
+     * Fill headers of a packet
+     *
+     * @param packet Packet that needs header information
+     */
+    private fillHeader;
+    /**
+     * Generalized method to send packets to a given destination on a given socket
+     *
+     * @param packet Packet to send
+     * @param socket Socket to send on
+     * @param port Destination Port
+     * @param address Destination Address
+     */
+    private sendPacket;
+    /**
+     * Sends a packet to the discovered server
+     * @param packet Packet to send
+     */
+    sendServer(packet: TCNetPacket): Promise<void>;
+    /**
+     * Called every second to announce our app on the network
+     */
+    private announceApp;
+    /**
+     * Broadcasts a packet to the network
+     *
+     * @param packet packet to broadcast
+     */
+    broadcastPacket(packet: TCNetPacket): Promise<void>;
+    /**
+     * Sends a request packet to the discovered server
+     *
+     * @param dataType requested data type
+     * @param layer requested layer
+     * @returns Promise to wait for answer on request
+     */
+    requestData(dataType: number, layer: number): Promise<TCNetDataPacket>;
+}
+
+export { type Constructable, NodeType, TCNetClient, TCNetConfiguration, TCNetDataPacket, TCNetDataPacketMetadata, TCNetDataPacketMetrics, TCNetDataPacketType, TCNetDataPackets, TCNetLayerStatus, TCNetLayerSyncMaster, TCNetManagementHeader, TCNetMessageType, TCNetOptInPacket, TCNetOptOutPacket, TCNetPacket, TCNetPackets, TCNetRequestPacket, TCNetStatusPacket, TCNetTimePacket, type TCNetTimePacketLayer, TCNetTimecode, TCNetTimecodeState };