@9c5s/node-tcnet 0.5.1 → 0.6.0

package/dist/index.d.mts

@@ -1,325 +1,440 @@
 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>;
+type CuePoint = {
+    index: number;
+    type: number;
+    inTime: number;
+    outTime: number;
+    color: {
+        r: number;
+        g: number;
+        b: number;
+    };
+};
+type CueData = {
+    loopInTime: number;
+    loopOutTime: number;
+    cues: CuePoint[];
+};
+type WaveformBar = {
+    level: number;
+    color: number;
+};
+type WaveformData = {
+    bars: WaveformBar[];
+};
+type BeatGridEntry = {
+    beatNumber: number;
+    beatType: number;
+    timestampMs: number;
+};
+type BeatGridData = {
+    entries: BeatGridEntry[];
+};
+type MixerChannel = {
+    sourceSelect: number;
+    audioLevel: number;
+    faderLevel: number;
+    trimLevel: number;
+    compLevel: number;
+    eqHi: number;
+    eqHiMid: number;
+    eqLowMid: number;
+    eqLow: number;
+    filterColor: number;
+    send: number;
+    cueA: number;
+    cueB: number;
+    crossfaderAssign: number;
+};
+type MixerData = {
+    mixerId: number;
+    mixerType: number;
+    mixerName: string;
+    masterAudioLevel: number;
+    masterFaderLevel: number;
+    masterFilter: number;
+    masterIsolatorOn: boolean;
+    masterIsolatorHi: number;
+    masterIsolatorMid: number;
+    masterIsolatorLow: number;
+    filterHpf: number;
+    filterLpf: number;
+    filterResonance: number;
+    crossFader: number;
+    crossFaderCurve: number;
+    channelFaderCurve: number;
+    beatFxOn: boolean;
+    beatFxSelect: number;
+    beatFxLevelDepth: number;
+    beatFxChannelSelect: number;
+    headphonesALevel: number;
+    headphonesBLevel: number;
+    boothLevel: number;
+    channels: MixerChannel[];
+};
+
+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;
+}
+declare class TCNetDataPacketCUE extends TCNetDataPacket {
+    data: CueData | null;
+    read(): void;
+    write(): void;
+    length(): number;
+}
+declare class TCNetDataPacketSmallWaveForm extends TCNetDataPacket {
+    data: WaveformData | null;
+    read(): void;
+    write(): void;
+    length(): number;
+}
+declare class TCNetDataPacketMixer extends TCNetDataPacket {
+    data: MixerData | null;
+    read(): void;
+    write(): void;
+    length(): number;
+}
+declare class TCNetDataPacketBeatGrid extends TCNetDataPacket {
+    data: BeatGridData | null;
+    read(): void;
+    readAssembled(assembled: Buffer): void;
+    private readFromOffset;
+    write(): void;
+    length(): number;
+}
+declare class TCNetDataPacketBigWaveForm extends TCNetDataPacket {
+    data: WaveformData | null;
+    read(): void;
+    readAssembled(assembled: Buffer): 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>;
+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>;
+}
+
+declare class MultiPacketAssembler {
+    private packets;
+    private totalPackets;
+    add(buffer: Buffer): boolean;
+    assemble(): Buffer;
+    reset(): void;
 }
 
-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 };
+export { type BeatGridData, type BeatGridEntry, type Constructable, type CueData, type CuePoint, type MixerChannel, type MixerData, MultiPacketAssembler, NodeType, TCNetClient, TCNetConfiguration, TCNetDataPacket, TCNetDataPacketBeatGrid, TCNetDataPacketBigWaveForm, TCNetDataPacketCUE, TCNetDataPacketMetadata, TCNetDataPacketMetrics, TCNetDataPacketMixer, TCNetDataPacketSmallWaveForm, TCNetDataPacketType, TCNetDataPackets, TCNetLayerStatus, TCNetLayerSyncMaster, TCNetManagementHeader, TCNetMessageType, TCNetOptInPacket, TCNetOptOutPacket, TCNetPacket, TCNetPackets, TCNetRequestPacket, TCNetStatusPacket, TCNetTimePacket, type TCNetTimePacketLayer, TCNetTimecode, TCNetTimecodeState, type WaveformBar, type WaveformData };