lox-airplay-sender 0.2.1 → 0.3.1

package/README.md

@@ -57,11 +57,13 @@ Creates and starts a sender for one AirPlay device. Returns the instance so you
 - `startTimeMs` (number) Unix ms to align playback across devices.
 - `debug` (boolean) Verbose logging from the transport stack.
 - `log` `(level, message, data?) => void` Hook for library logs.
+- `config` (partial) Override buffer/sync/RTSP tuning at runtime (see `src/utils/config.ts` for keys like `packets_in_buffer`, `stream_latency`, `sync_period`, retry/backoff, etc.).
 
 **Events** (sent to `onEvent` callback)
 - `device`: `{ event: "device", message: status, detail: { key, desc } }`
 - `buffer`: `{ event: "buffer", message: status }` where status is `buffering|playing|drain|end`
 - `error`: `{ event: "error", message }`
+- `metrics`: `{ event: "metrics", detail }` sync drift snapshots emitted on each sync tick when enabled.
 
 ### `LoxAirplaySender` methods
 - `sendPcm(chunk: Buffer)`: Push raw PCM audio. If `inputCodec` is `"alac"` you can push ALAC frames.
@@ -82,4 +84,4 @@ Use `startTimeMs` to align multiple senders to the same start clock (Unix ms). F
 npm install
 npm run build
 npm run clean   # remove dist
-```
+```

package/dist/core/audioOut.js

@@ -42,6 +42,10 @@ class AudioOut extends node_events_1.EventEmitter {
             packet.timestamp = (0, numUtil_1.low32)(seq * config_1.default.frames_per_packet + 2 * config_1.default.sampling_rate);
             if (this.hasAirTunes && seq % config_1.default.sync_period === 0) {
                 this.emit('need_sync', seq);
+                const expectedTimeMs = this.rtpTimeRef +
+                    ((seq * config_1.default.frames_per_packet) / config_1.default.sampling_rate) * 1000;
+                const deltaMs = Date.now() - expectedTimeMs;
+                this.emit('metrics', { type: 'sync', seq, deltaMs, latencyFrames: this.latencyFrames });
             }
             this.emit('packet', packet);
             packet.release();

package/dist/core/index.d.ts

@@ -1,5 +1,6 @@
 import { Duplex } from 'node:stream';
 import Devices from './devices';
+import { type AirplayConfig } from '../utils/config';
 /**
  * High-level RAOP/AirPlay sender that wires together devices, buffering, and output.
  * Acts as a Duplex stream: write PCM/ALAC chunks, listen to status events.
@@ -14,6 +15,7 @@ declare class AirTunes extends Duplex {
     constructor(options?: {
         packetSize?: number;
         startTimeMs?: number;
+        config?: Partial<AirplayConfig>;
     });
     /** Register an AirTunes (RAOP) device and start streaming to it. */
     add(host: string, options: Record<string, unknown>, mode?: number, txt?: string[] | string): any;

package/dist/core/index.js

@@ -1,11 +1,44 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const node_stream_1 = require("node:stream");
 const devices_1 = __importDefault(require("./devices"));
-const config_1 = __importDefault(require("../utils/config"));
+const config_1 = __importStar(require("../utils/config"));
 const circularBuffer_1 = __importDefault(require("../utils/circularBuffer"));
 const audioOut_1 = __importDefault(require("./audioOut"));
 /**
@@ -21,6 +54,9 @@ class AirTunes extends node_stream_1.Duplex {
      */
     constructor(options = {}) {
         super({ readableObjectMode: false, writableObjectMode: false });
+        if (options.config) {
+            (0, config_1.applyConfig)(options.config);
+        }
         const audioOut = new audioOut_1.default();
         this.devices = new devices_1.default(audioOut);
         this.devices.init();
@@ -33,6 +69,9 @@ class AirTunes extends node_stream_1.Duplex {
             this.emit('buffer', status);
         });
         audioOut.init(this.devices, this.circularBuffer, options.startTimeMs);
+        audioOut.on('metrics', (metrics) => {
+            this.emit('metrics', metrics);
+        });
         this.circularBuffer.on('drain', () => {
             this.emit('drain');
         });

package/dist/esm/core/audioOut.js

@@ -42,6 +42,10 @@ class AudioOut extends node_events_1.EventEmitter {
             packet.timestamp = (0, numUtil_1.low32)(seq * config_1.default.frames_per_packet + 2 * config_1.default.sampling_rate);
             if (this.hasAirTunes && seq % config_1.default.sync_period === 0) {
                 this.emit('need_sync', seq);
+                const expectedTimeMs = this.rtpTimeRef +
+                    ((seq * config_1.default.frames_per_packet) / config_1.default.sampling_rate) * 1000;
+                const deltaMs = Date.now() - expectedTimeMs;
+                this.emit('metrics', { type: 'sync', seq, deltaMs, latencyFrames: this.latencyFrames });
             }
             this.emit('packet', packet);
             packet.release();

package/dist/esm/core/index.js

@@ -1,11 +1,44 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const node_stream_1 = require("node:stream");
 const devices_1 = __importDefault(require("./devices"));
-const config_1 = __importDefault(require("../utils/config"));
+const config_1 = __importStar(require("../utils/config"));
 const circularBuffer_1 = __importDefault(require("../utils/circularBuffer"));
 const audioOut_1 = __importDefault(require("./audioOut"));
 /**
@@ -21,6 +54,9 @@ class AirTunes extends node_stream_1.Duplex {
      */
     constructor(options = {}) {
         super({ readableObjectMode: false, writableObjectMode: false });
+        if (options.config) {
+            (0, config_1.applyConfig)(options.config);
+        }
         const audioOut = new audioOut_1.default();
         this.devices = new devices_1.default(audioOut);
         this.devices.init();
@@ -33,6 +69,9 @@ class AirTunes extends node_stream_1.Duplex {
             this.emit('buffer', status);
         });
         audioOut.init(this.devices, this.circularBuffer, options.startTimeMs);
+        audioOut.on('metrics', (metrics) => {
+            this.emit('metrics', metrics);
+        });
         this.circularBuffer.on('drain', () => {
             this.emit('drain');
         });

package/dist/esm/index.js

@@ -1,4 +1,37 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -8,7 +41,7 @@ exports.start = start;
 const node_events_1 = require("node:events");
 // Airtunes implementation (node_airtunes2 port) in src/core.
 const index_1 = __importDefault(require("./core/index"));
-const config_1 = __importDefault(require("./utils/config"));
+const config_1 = __importStar(require("./utils/config"));
 class LoxAirplaySender extends node_events_1.EventEmitter {
     airtunes = null;
     deviceKey = null;
@@ -32,11 +65,15 @@ class LoxAirplaySender extends node_events_1.EventEmitter {
             this.stop();
         }
         this.log = options.log;
+        if (options.config) {
+            (0, config_1.applyConfig)(options.config);
+        }
         const inputCodec = options.inputCodec ?? 'pcm';
         config_1.default.packet_size = inputCodec === 'alac' ? config_1.default.alac_packet_size : config_1.default.pcm_packet_size;
         this.airtunes = new index_1.default({
             packetSize: config_1.default.packet_size,
             startTimeMs: options.startTimeMs,
+            config: options.config,
         });
         this.airtunes.on('device', (key, status, desc) => {
             onEvent?.({ event: 'device', message: status, detail: { key, desc } });
@@ -47,6 +84,9 @@ class LoxAirplaySender extends node_events_1.EventEmitter {
         this.airtunes.on('error', (err) => {
             onEvent?.({ event: 'error', message: err instanceof Error ? err.message : String(err) });
         });
+        this.airtunes.on('metrics', (detail) => {
+            onEvent?.({ event: 'metrics', detail });
+        });
         const dev = this.airtunes.add(options.host, {
             port: options.port,
             name: options.name,

package/dist/esm/utils/config.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.config = void 0;
+exports.applyConfig = applyConfig;
 const numUtil_1 = require("./numUtil");
 exports.config = {
     user_agent: 'iTunes/11.3.1 (Windows; Microsoft Windows 10 x64 (Build 19044); x64) (dt:2)',
@@ -31,4 +32,8 @@ exports.config = {
     iv_base64: 'ePRBLI0XN5ArFaaz7ncNZw',
     rsa_aeskey_base64: 'VjVbxWcmYgbBbhwBNlCh3K0CMNtWoB844BuiHGUJT51zQS7SDpMnlbBIobsKbfEJ3SCgWHRXjYWf7VQWRYtEcfx7ejA8xDIk5PSBYTvXP5dU2QoGrSBv0leDS6uxlEWuxBq3lIxCxpWO2YswHYKJBt06Uz9P2Fq2hDUwl3qOQ8oXb0OateTKtfXEwHJMprkhsJsGDrIc5W5NJFMAo6zCiM9bGSDeH2nvTlyW6bfI/Q0v0cDGUNeY3ut6fsoafRkfpCwYId+bg3diJh+uzw5htHDyZ2sN+BFYHzEfo8iv4KDxzeya9llqg6fRNQ8d5YjpvTnoeEQ9ye9ivjkBjcAfVw',
 };
+function applyConfig(overrides) {
+    Object.assign(exports.config, overrides);
+    return exports.config;
+}
 exports.default = exports.config;

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { EventEmitter } from 'node:events';
 import { Readable } from 'node:stream';
+import { type AirplayConfig } from './utils/config';
 /**
  * Configuration for a single AirPlay sender.
  */
@@ -31,6 +32,8 @@ export interface LoxAirplaySenderOptions {
     startTimeMs?: number;
     /** Logger hook for internal messages. */
     log?: (level: 'debug' | 'info' | 'warn' | 'error', message: string, data?: unknown) => void;
+    /** Override transport/buffer tuning without patching the module. */
+    config?: Partial<AirplayConfig>;
 }
 /**
  * Metadata sent to receivers for UI display.

package/dist/index.js

@@ -1,4 +1,37 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -8,7 +41,7 @@ exports.start = start;
 const node_events_1 = require("node:events");
 // Airtunes implementation (node_airtunes2 port) in src/core.
 const index_1 = __importDefault(require("./core/index"));
-const config_1 = __importDefault(require("./utils/config"));
+const config_1 = __importStar(require("./utils/config"));
 class LoxAirplaySender extends node_events_1.EventEmitter {
     airtunes = null;
     deviceKey = null;
@@ -32,11 +65,15 @@ class LoxAirplaySender extends node_events_1.EventEmitter {
             this.stop();
         }
         this.log = options.log;
+        if (options.config) {
+            (0, config_1.applyConfig)(options.config);
+        }
         const inputCodec = options.inputCodec ?? 'pcm';
         config_1.default.packet_size = inputCodec === 'alac' ? config_1.default.alac_packet_size : config_1.default.pcm_packet_size;
         this.airtunes = new index_1.default({
             packetSize: config_1.default.packet_size,
             startTimeMs: options.startTimeMs,
+            config: options.config,
         });
         this.airtunes.on('device', (key, status, desc) => {
             onEvent?.({ event: 'device', message: status, detail: { key, desc } });
@@ -47,6 +84,9 @@ class LoxAirplaySender extends node_events_1.EventEmitter {
         this.airtunes.on('error', (err) => {
             onEvent?.({ event: 'error', message: err instanceof Error ? err.message : String(err) });
         });
+        this.airtunes.on('metrics', (detail) => {
+            onEvent?.({ event: 'metrics', detail });
+        });
         const dev = this.airtunes.add(options.host, {
             port: options.port,
             name: options.name,

package/dist/utils/config.d.ts

@@ -28,4 +28,5 @@ export interface AirplayConfig {
     rsa_aeskey_base64: string;
 }
 export declare const config: AirplayConfig;
+export declare function applyConfig(overrides: Partial<AirplayConfig>): AirplayConfig;
 export default config;

package/dist/utils/config.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.config = void 0;
+exports.applyConfig = applyConfig;
 const numUtil_1 = require("./numUtil");
 exports.config = {
     user_agent: 'iTunes/11.3.1 (Windows; Microsoft Windows 10 x64 (Build 19044); x64) (dt:2)',
@@ -31,4 +32,8 @@ exports.config = {
     iv_base64: 'ePRBLI0XN5ArFaaz7ncNZw',
     rsa_aeskey_base64: 'VjVbxWcmYgbBbhwBNlCh3K0CMNtWoB844BuiHGUJT51zQS7SDpMnlbBIobsKbfEJ3SCgWHRXjYWf7VQWRYtEcfx7ejA8xDIk5PSBYTvXP5dU2QoGrSBv0leDS6uxlEWuxBq3lIxCxpWO2YswHYKJBt06Uz9P2Fq2hDUwl3qOQ8oXb0OateTKtfXEwHJMprkhsJsGDrIc5W5NJFMAo6zCiM9bGSDeH2nvTlyW6bfI/Q0v0cDGUNeY3ut6fsoafRkfpCwYId+bg3diJh+uzw5htHDyZ2sN+BFYHzEfo8iv4KDxzeya9llqg6fRNQ8d5YjpvTnoeEQ9ye9ivjkBjcAfVw',
 };
+function applyConfig(overrides) {
+    Object.assign(exports.config, overrides);
+    return exports.config;
+}
 exports.default = exports.config;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lox-airplay-sender",
-  "version": "0.2.1",
+  "version": "0.3.1",
   "description": "AirPlay sender (RAOP/AirPlay 1 + AirPlay 2 auth flows) ",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",