@djodjonx/x32-simulator 0.0.2 → 0.0.4

package/src/application/use-cases/BroadcastUpdatesUseCase.ts

@@ -1,120 +0,0 @@
-import { SubscriptionManager } from '../../domain/entities/SubscriptionManager';
-import { INetworkGateway } from '../../domain/ports/INetworkGateway';
-import { X32State } from '../../domain/entities/X32State';
-import { SchemaRegistry } from '../../domain/services/SchemaRegistry';
-import { MeterService } from '../../domain/services/MeterService';
-import { ILogger, LogCategory } from '../../domain/ports/ILogger';
-
-export class BroadcastUpdatesUseCase {
-    constructor(
-        private subscriptionManager: SubscriptionManager,
-        private state: X32State,
-        private gateway: INetworkGateway,
-        private logger: ILogger,
-        private meterService: MeterService,
-        private schemaRegistry: SchemaRegistry
-    ) {}
-
-    public execute(): void {
-        this.subscriptionManager.getSubscribers().forEach(sub => {
-            if (sub.type === 'path' || !sub.alias) {
-                 if (sub.type === 'meter' && sub.meterPath) {
-                     const meterData = this.meterService.generateMeterData(sub.meterPath, this.state);
-                     this.gateway.send({ address: sub.address, port: sub.port }, sub.meterPath, [meterData.toBlob()]);
-                 }
-                 return; 
-            }
-  
-            const rinfo = { address: sub.address, port: sub.port };
-            
-            if (sub.type === 'batch' && sub.paths) {
-               if (sub.paths.length === 1 && sub.paths[0].startsWith('/meters')) {
-                   const meterData = this.meterService.generateMeterData(sub.paths[0], this.state);
-                   this.gateway.send(rinfo, sub.alias, [meterData.toBlob()]);
-                   return;
-               }
-  
-               let stride: number;
-               const dataSize = sub.paths.length * 4;
-               const factor = sub.factor || 0;
-               const count = sub.count || 0;
-  
-               if (factor > 0) {
-                   stride = Math.max(factor * 4, dataSize);
-               } else {
-                   stride = (sub.paths.length === 3) ? 16 : dataSize;
-               }
-               
-               const blobSize = count * stride;
-               if (isNaN(blobSize) || blobSize < 0) {
-                   this.logger.error(LogCategory.SYSTEM, `Invalid blob size`, { alias: sub.alias, blobSize, count, stride, factor, dataSize });
-                   return;
-               }
-  
-               const blob = Buffer.alloc(blobSize);
-               
-               for (let i = 0; i < count; i++) {
-                  const root = this.schemaRegistry.getRootFromIndex(sub.start! + i);
-                  let currentOffset = i * stride;
-                  
-                  if (!root) { continue; }
-                  
-                  sub.paths.forEach((s, pIdx) => {
-                      if (pIdx * 4 >= stride) return;
-  
-                      if (s.startsWith('/meters')) {
-                          blob.writeFloatLE(0.0, currentOffset);
-                      } else {
-                          const target = `${root}${s}`;
-                          const node = this.schemaRegistry.getNode(target);
-                          let val = this.state.get(target);
-                          if (val === undefined) val = node ? node.default : 0;
-                          
-                          if (typeof val === 'number') {
-                              if (node && node.type === 'f') {
-                                  blob.writeFloatLE(val, currentOffset);
-                              }
-                              else blob.writeInt32LE(val, currentOffset);
-                          } else blob.writeInt32LE(0, currentOffset);
-                      }
-                      currentOffset += 4;
-                  });
-               }
-               this.gateway.send(rinfo, sub.alias, [blob]);
-            } else if (sub.type === 'format' && sub.pattern) {
-               const stride = sub.factor ? sub.factor * 4 : 4;
-               const start = sub.start || 0;
-               const count = sub.count || 0;
-               
-               const totalSize = (start + count) * stride;
-               if (isNaN(totalSize) || totalSize < 0) return;
-  
-               const blob = Buffer.alloc(totalSize);
-               let offset = start * stride;
-               
-               for (let i = start; i < start + count; i++) {
-                  const id = i.toString().padStart(2, '0');
-                  const target = sub.pattern!.replace(/\*\*?/, id);
-                  let val = this.state.get(target);
-                  if (val === undefined) val = 0;
-                  if (typeof val === 'number') {
-                      const node = this.schemaRegistry.getNode(target);
-                      if (node && node.type === 'f') blob.writeFloatLE(val, offset);
-                      else blob.writeInt32LE(val, offset);
-                  } else blob.writeInt32LE(0, offset);
-                  offset += stride;
-               }
-               this.gateway.send(rinfo, sub.alias, [blob]);
-            }
-        });
-    }
-
-    public broadcastSingleChange(path: string, value: number | string): void {
-        this.subscriptionManager.getSubscribers().forEach(sub => {
-            const match = path === sub.path || sub.path === '/xremote' || (sub.path && sub.path.includes('*') && path.startsWith(sub.path.split('*')[0]));
-            if (match) {
-                this.gateway.send({ address: sub.address, port: sub.port }, path, [value]);
-            }
-        });
-    }
-}

package/src/application/use-cases/ManageSessionsUseCase.ts

@@ -1,9 +0,0 @@
-import { SubscriptionManager } from '../../domain/entities/SubscriptionManager';
-
-export class ManageSessionsUseCase {
-    constructor(private subscriptionManager: SubscriptionManager) {}
-
-    public cleanup(): void {
-        this.subscriptionManager.cleanup();
-    }
-}

package/src/application/use-cases/ProcessPacketUseCase.ts

@@ -1,26 +0,0 @@
-import { OscPacket, OscArgument, RemoteClient } from '../../domain/models/types';
-import { OscMessageHandler } from '../../domain/services/OscMessageHandler';
-import { INetworkGateway } from '../../domain/ports/INetworkGateway';
-
-export class ProcessPacketUseCase {
-    constructor(
-        private messageHandler: OscMessageHandler,
-        private gateway: INetworkGateway
-    ) {}
-
-    public execute(packet: OscPacket, rinfo: RemoteClient): void {
-        if (packet.oscType === 'bundle') {
-            packet.elements?.forEach((el: OscPacket) => this.execute(el, rinfo));
-        } else if (packet.oscType === 'message') {
-            const args = packet.args.map((arg: OscArgument) => {
-                if (typeof arg === 'object' && arg !== null && 'value' in arg) return arg.value;
-                return arg;
-            });
-
-            const replies = this.messageHandler.handle({ address: packet.address, args }, rinfo);
-            replies.forEach(reply => {
-                this.gateway.send(rinfo, reply.address, reply.args);
-            });
-        }
-    }
-}

package/src/application/use-cases/SimulationService.ts

@@ -1,122 +0,0 @@
-import { ProcessPacketUseCase } from './ProcessPacketUseCase';
-import { BroadcastUpdatesUseCase } from './BroadcastUpdatesUseCase';
-import { ManageSessionsUseCase } from './ManageSessionsUseCase';
-import { INetworkGateway } from '../../domain/ports/INetworkGateway';
-import { ILogger, LogCategory } from '../../domain/ports/ILogger';
-import { IStateRepository } from '../../domain/ports/IStateRepository';
-import { SubscriptionManager } from '../../domain/entities/SubscriptionManager';
-import { OscMessageHandler } from '../../domain/services/OscMessageHandler';
-import { MeterService } from '../../domain/services/MeterService';
-import { SchemaRegistry } from '../../domain/services/SchemaRegistry';
-import { StaticResponseService } from '../../domain/services/StaticResponseService';
-import * as os from 'os';
-
-/**
- * Gets the first non-internal IPv4 address found on this machine.
- * @returns Detected IP or localhost.
- */
-function getLocalIp(): string {
-    const interfaces = os.networkInterfaces();
-    for (const name of Object.keys(interfaces)) {
-        for (const iface of interfaces[name]!) {
-            if (iface.family === 'IPv4' && !iface.internal) {
-                return iface.address;
-            }
-        }
-    }
-    return '127.0.0.1';
-}
-
-export class SimulationService {
-    private subscriptionManager: SubscriptionManager;
-    private messageHandler: OscMessageHandler;
-    
-    // Use Cases
-    private processPacket: ProcessPacketUseCase;
-    private broadcastUpdates: BroadcastUpdatesUseCase;
-    private manageSessions: ManageSessionsUseCase;
-
-    // Services
-    private meterService: MeterService;
-    private staticResponseService: StaticResponseService;
-
-    private updateInterval: NodeJS.Timeout | null = null;
-    private cleanupInterval: NodeJS.Timeout | null = null;
-
-    constructor(
-        private gateway: INetworkGateway,
-        private logger: ILogger,
-        private stateRepo: IStateRepository,
-        private schemaRegistry: SchemaRegistry,
-        private port: number = 10023,
-        private ip: string = '0.0.0.0',
-        name: string = 'osc-server',
-        model: string = 'X32'
-    ) {
-        // Initialize Domain Entities
-        const state = this.stateRepo.getState();
-        this.subscriptionManager = new SubscriptionManager(logger);
-        
-        // Initialize Services
-        this.meterService = new MeterService();
-        this.staticResponseService = new StaticResponseService();
-
-        const reportedIp = (this.ip === '0.0.0.0') ? getLocalIp() : this.ip;
-        this.messageHandler = new OscMessageHandler(
-            state,
-            this.subscriptionManager,
-            logger,
-            reportedIp,
-            name,
-            model,
-            this.meterService,
-            this.schemaRegistry,
-            this.staticResponseService
-        );
-
-        // Initialize Use Cases
-        this.processPacket = new ProcessPacketUseCase(this.messageHandler, gateway);
-        this.broadcastUpdates = new BroadcastUpdatesUseCase(
-            this.subscriptionManager, 
-            state, 
-            gateway, 
-            logger,
-            this.meterService,
-            this.schemaRegistry
-        );
-        this.manageSessions = new ManageSessionsUseCase(this.subscriptionManager);
-
-        // Bind State Changes to Broadcast
-        state.on('change', (evt: { address: string, value: number | string }) => {
-            this.logger.info(LogCategory.STATE, `State Changed`, evt);
-            this.broadcastUpdates.broadcastSingleChange(evt.address, evt.value);
-        });
-
-        // Bind Gateway Packet Handling
-        this.gateway.onPacket((packet, source) => this.processPacket.execute(packet, source));
-    }
-
-    public async start(): Promise<void> {
-        await this.gateway.start(this.port, this.ip);
-        
-        // Cleanup expired subscribers every 5s
-        this.cleanupInterval = setInterval(() => {
-            this.manageSessions.cleanup();
-        }, 5000);
-
-        // Send updates every 100ms
-        this.updateInterval = setInterval(() => {
-            this.broadcastUpdates.execute();
-        }, 100);
-    }
-
-    public async stop(): Promise<void> {
-        if (this.updateInterval) clearInterval(this.updateInterval);
-        if (this.cleanupInterval) clearInterval(this.cleanupInterval);
-        await this.gateway.stop();
-    }
-
-    public resetState() {
-        this.stateRepo.reset();
-    }
-}

package/src/domain/entities/SubscriptionManager.ts

@@ -1,126 +0,0 @@
-import { Subscriber, RemoteClient } from '../models/types';
-import { ILogger, LogCategory } from '../ports/ILogger';
-
-/**
- * Manages OSC client subscriptions and their lifecycle.
- */
-export class SubscriptionManager {
-  private logger: ILogger;
-  private subscribers: Subscriber[] = [];
-
-  constructor(logger: ILogger) {
-      this.logger = logger;
-  }
-
-  /**
-   * Cleans up expired subscriptions.
-   * Standard X32 subscriptions last 10 seconds.
-   */
-  public cleanup() {
-    const now = Date.now();
-    const initialCount = this.subscribers.length;
-    this.subscribers = this.subscribers.filter(s => {
-        const active = s.expires > now;
-        if (!active) {
-            this.logger.debug(LogCategory.SUB, `Expired subscriber`, { type: s.type, ip: s.address, port: s.port, path: 'path' in s ? s.path : s.alias });
-        }
-        return active;
-    });
-    if (this.subscribers.length !== initialCount) {
-        this.logger.info(LogCategory.SUB, `Cleanup finished`, { removed: initialCount - this.subscribers.length, remaining: this.subscribers.length });
-    }
-  }
-
-  /**
-   * Gets all active subscribers.
-   * @returns Array of subscribers.
-   */
-  public getSubscribers(): Subscriber[] {
-    return this.subscribers;
-  }
-
-  /**
-   * Adds or renews a path-based subscription (e.g. /subscribe or /xremote).
-   * @param rinfo - Client remote info.
-   * @param path - Subscription path.
-   */
-  public addPathSubscriber(rinfo: RemoteClient, path: string) {
-    const key = `${rinfo.address}:${rinfo.port}:${path}`;
-    const expires = Date.now() + 10000;
-    const existing = this.subscribers.find(s => s.type === 'path' && `${s.address}:${s.port}:${s.path}` === key);
-
-    if (existing) {
-        existing.expires = expires;
-        this.logger.debug(LogCategory.SUB, `Renewed subscription`, { ip: rinfo.address, path });
-    } else {
-        this.subscribers.push({ type: 'path', address: rinfo.address, port: rinfo.port, path, expires });
-        this.logger.info(LogCategory.SUB, `New subscription`, { ip: rinfo.address, path });
-    }
-  }
-
-  /**
-   * Adds or renews a batch subscription.
-   * @param rinfo - Client remote info.
-   * @param alias - Response alias.
-   * @param paths - Target paths.
-   * @param start - Start index.
-   * @param count - Count.
-   * @param factor - Frequency factor.
-   * @param args - Command arguments.
-   */
-  public addBatchSubscriber(rinfo: RemoteClient, alias: string, paths: string[], start: number, count: number, factor?: number, args?: number[]) {
-        const expires = Date.now() + 10000;
-        this.subscribers = this.subscribers.filter(s => !(s.type === 'batch' && s.alias === alias && s.address === rinfo.address));
-
-        this.subscribers.push({ type: 'batch', address: rinfo.address, port: rinfo.port, alias, paths, start, count, factor, expires, args });
-        this.logger.info(LogCategory.SUB, `Batch subscription`, { alias, count: paths.length, factor, ip: rinfo.address, args });
-    }
-
-    /**
-     * Adds or renews a format subscription.
-     * @param rinfo - Client remote info.
-     * @param alias - Response alias.
-     * @param pattern - Path pattern.
-     * @param start - Start index.
-     * @param count - Count.
-     * @param factor - Frequency factor.
-     */
-    public addFormatSubscriber(rinfo: RemoteClient, alias: string, pattern: string, start: number, count: number, factor?: number) {
-        const expires = Date.now() + 10000;
-        this.subscribers = this.subscribers.filter(s => !(s.type === 'format' && s.alias === alias && s.address === rinfo.address));
-        this.subscribers.push({ type: 'format', address: rinfo.address, port: rinfo.port, alias, pattern, start, count, factor, expires });
-        this.logger.info(LogCategory.SUB, `Format subscription`, { alias, pattern, factor, ip: rinfo.address });
-    }
-
-  /**
-   * Adds or renews a high-frequency meter subscription.
-   * @param rinfo - Client remote info.
-   * @param meterPath - Target meter path.
-   */
-  public addMeterSubscriber(rinfo: RemoteClient, meterPath: string) {
-      const expires = Date.now() + 10000;
-      const existing = this.subscribers.find(s => s.type === 'meter' && s.meterPath === meterPath && s.address === rinfo.address);
-
-      this.subscribers = this.subscribers.filter(s => !(s.type === 'meter' && s.meterPath === meterPath && s.address === rinfo.address));
-      this.subscribers.push({ type: 'meter', address: rinfo.address, port: rinfo.port, meterPath, expires });
-
-      if (!existing) {
-          this.logger.info(LogCategory.SUB, `Meter subscription`, { path: meterPath, ip: rinfo.address });
-      } else {
-          this.logger.debug(LogCategory.SUB, `Meter renewal`, { path: meterPath, ip: rinfo.address });
-      }
-  }
-
-  /**
-   * Removes a subscription.
-   * @param rinfo - Client remote info.
-   * @param path - Subscription path.
-   */
-  public removeSubscriber(rinfo: RemoteClient, path: string) {
-      const initial = this.subscribers.length;
-      this.subscribers = this.subscribers.filter(s => !(s.address === rinfo.address && s.port === rinfo.port && s.path === path));
-      if (this.subscribers.length < initial) {
-          this.logger.info(LogCategory.SUB, `Unsubscribed`, { path, ip: rinfo.address });
-      }
-  }
-}

package/src/domain/entities/X32State.ts

@@ -1,78 +0,0 @@
-import { EventEmitter } from 'node:events';
-import { X32Node } from '../models/X32Node';
-
-/**
- * Manages the internal "Digital Twin" state of the X32 console.
- * acts as a single source of truth for all parameters.
- * Emits 'change' events whenever a value is updated.
- */
-export class X32State extends EventEmitter {
-  /** Map storing all OSC paths and their current values. */
-  private state = new Map<string, number | string>();
-  private readonly defaultState: Map<string, number | string> = new Map();
-
-  /**
-   * Initializes the state with default values from the schema.
-   * @param schema - The schema definition map.
-   */
-  constructor(schema: Record<string, X32Node>) {
-    super();
-    // Pre-calculate default state
-    for (const [addr, def] of Object.entries(schema)) {
-        this.defaultState.set(addr, def.default);
-    }
-    this.reset();
-  }
-
-  /**
-   * Resets all state parameters to their default values defined in the schema.
-   */
-  public reset() {
-    this.state.clear();
-    this.defaultState.forEach((val, key) => {
-        this.state.set(key, val);
-    });
-  }
-
-  /**
-   * Retrieves the value of a specific OSC node.
-   * @param address - The full OSC address path.
-   * @returns The stored value (number or string) or undefined if not found.
-   */
-  public get(address: string): number | string | undefined {
-    return this.state.get(address);
-  }
-
-  /**
-   * Updates the value of a specific OSC node and notifies subscribers.
-   * @param address - The full OSC address path.
-   * @param value - The new value to store.
-   */
-  public set(address: string, value: number | string) {
-    this.state.set(address, value);
-    this.emit('change', { address, value });
-  }
-
-  /**
-   * Specialized logic to handle X32 Mute Groups side-effects.
-   * When a mute group is toggled, it iterates through all channels
-   * assigned to that group and updates their individual mute status.
-   * @param groupIdx - The index of the mute group (1-6).
-   * @param isOn - The new state of the group master switch (0 or 1).
-   */
-  public handleMuteGroupChange(groupIdx: number, isOn: number) {
-      for(let i=1; i<=32; i++) {
-          const ch = i.toString().padStart(2, '0');
-          const grpVal = this.get(`/ch/${ch}/grp/mute`);
-
-          if (typeof grpVal === 'number') {
-              if ((grpVal & (1 << (groupIdx - 1))) !== 0) {
-                   const targetMute = isOn === 1 ? 0 : 1;
-                   const muteAddr = `/ch/${ch}/mix/on`;
-                   // This set calls emit('change') which will trigger broadcast
-                   this.set(muteAddr, targetMute);
-              }
-          }
-      }
-  }
-}

package/src/domain/models/MeterConfig.ts

@@ -1,22 +0,0 @@
-/**
- * Configuration for meter counts per path.
- */
-export const METER_COUNTS: Record<string, number> = {
-    '/meters/0': 70,
-    '/meters/1': 96,
-    '/meters/2': 49,
-    '/meters/3': 22,
-    '/meters/4': 82,
-    '/meters/5': 27,
-    '/meters/6': 4,
-    '/meters/7': 16,
-    '/meters/8': 6,
-    '/meters/9': 32,
-    '/meters/10': 32,
-    '/meters/11': 5,
-    '/meters/12': 4,
-    '/meters/13': 48,
-    '/meters/14': 80,
-    '/meters/15': 50,
-    '/meters/16': 48,
-};

package/src/domain/models/MeterData.ts

@@ -1,59 +0,0 @@
-/**
- * Represents a set of meter values for a specific meter path.
- * Handles the storage of float values and serialization to X32-specific binary blobs.
- */
-export class MeterData {
-    private readonly _path: string;
-    private readonly _values: number[];
-    
-    // Cache for the binary buffer to avoid re-allocation if values haven't changed (optional optimization, 
-    // but here we mainly cache the structure or just generate on demand). 
-    // Given the previous util had a static cache, we can keep it simple here.
-    
-    /**
-     * Creates a new MeterData instance.
-     * @param path - The meter OSC path (e.g., "/meters/1").
-     * @param values - The array of float values (0.0 - 1.0 or similar).
-     */
-    constructor(path: string, values: number[]) {
-        this._path = path;
-        this._values = values;
-    }
-
-    /**
-     * Gets the meter path.
-     */
-    get path(): string {
-        return this._path;
-    }
-
-    /**
-     * Gets the values.
-     */
-    get values(): number[] {
-        return [...this._values];
-    }
-
-    /**
-     * Generates an optimized binary blob for X32 meters (mixed endianness).
-     * Structure: [Size (Int32BE)] [Count (Int32LE)] [Float1 (LE)] [Float2 (LE)] ...
-     * @returns Buffer containing the OSC blob.
-     */
-    toBlob(): Buffer {
-        const count = this._values.length;
-        const totalSize = 4 + 4 + (count * 4);
-        
-        const blob = Buffer.alloc(totalSize);
-        
-        // Header: Size (BE) + Count (LE)
-        blob.writeInt32BE(totalSize, 0);
-        blob.writeInt32LE(count, 4);
-        
-        // Body: Floats (LE)
-        for (let i = 0; i < count; i++) {
-            blob.writeFloatLE(this._values[i], 8 + (i * 4));
-        }
-        
-        return blob;
-    }
-}

package/src/domain/models/OscMessage.ts

@@ -1,93 +0,0 @@
-import { OscArgumentValue, OscPacket } from './types';
-
-/**
- * Represents a parsed OSC message ready for handling.
- * Encapsulates the address and arguments, providing helper methods for validation and extraction.
- */
-export class OscMessage {
-    private readonly _address: string;
-    private readonly _args: OscArgumentValue[];
-
-    /**
-     * Creates a new OscMessage instance.
-     * @param address - The OSC address string.
-     * @param args - The list of arguments.
-     */
-    constructor(address: string, args: OscArgumentValue[]) {
-        this._address = address;
-        this._args = args;
-    }
-
-    /**
-     * Gets the OSC address.
-     * @returns The address string.
-     */
-    get address(): string {
-        return this._address;
-    }
-
-    /**
-     * Gets the message arguments.
-     * @returns Copy of the arguments array.
-     */
-    get args(): OscArgumentValue[] {
-        return [...this._args]; // Return copy to preserve immutability
-    }
-
-    /**
-     * Checks if the address starts with the given prefix.
-     * @param prefix - The prefix to check.
-     * @returns True if it starts with the prefix.
-     */
-    startsWith(prefix: string): boolean {
-        return this._address.startsWith(prefix);
-    }
-
-    /**
-     * Gets an argument at a specific index, safely.
-     * @param index - The index of the argument.
-     * @returns The argument value or undefined.
-     */
-    getArg(index: number): OscArgumentValue | undefined {
-        return this._args[index];
-    }
-
-    /**
-     * Gets an argument as a number, or throws if missing/invalid.
-     * @param index - The index.
-     * @returns The number value.
-     */
-    getArgAsNumber(index: number): number {
-        const val = this._args[index];
-        if (typeof val !== 'number') {
-            throw new Error(`Argument at index ${index} is not a number.`);
-        }
-        return val;
-    }
-
-    /**
-     * Gets an argument as a string, or throws if missing/invalid.
-     * @param index - The index.
-     * @returns The string value.
-     */
-    getArgAsString(index: number): string {
-        const val = this._args[index];
-        if (typeof val !== 'string') {
-            throw new Error(`Argument at index ${index} is not a string.`);
-        }
-        return val;
-    }
-
-    /**
-     * Factory method to create an OscMessage from a raw packet.
-     * @param packet - The raw OSC packet.
-     * @returns A new OscMessage instance.
-     */
-    static fromPacket(packet: OscPacket): OscMessage {
-        const values = packet.args.map(arg => 
-            (typeof arg === 'object' && arg !== null && 'value' in arg) ? arg.value : arg
-        ) as OscArgumentValue[];
-        
-        return new OscMessage(packet.address, values);
-    }
-}