grandi 1.3.1 → 2.0.0

package/dist/index.mjs

@@ -2,89 +2,190 @@ import { createRequire } from "node:module";
 import path from "node:path";
 import { fileURLToPath } from "node:url";
 import nodeGypBuild from "node-gyp-build";
-
-//#region rolldown:runtime
-var __require = /* @__PURE__ */ createRequire(import.meta.url);
-
+//#region \0rolldown/runtime.js
+var __require = /* #__PURE__ */ (() => createRequire(import.meta.url))();
 //#endregion
 //#region node_modules/tsdown/esm-shims.js
 const getFilename = () => fileURLToPath(import.meta.url);
 const getDirname = () => path.dirname(getFilename());
 const __dirname = /* @__PURE__ */ getDirname();
-
+//#endregion
+//#region src/platforms.json
+var platforms_default = [
+	{
+		"key": "linux-x64",
+		"platform": "linux",
+		"arch": "x64",
+		"gypArch": "x64",
+		"packageName": "@grandi/linux-x64",
+		"packageDir": "packages/linux-x64",
+		"sources": [
+			"ndi/lib/lnx-x64/libndi.so.6",
+			"ndi/lib/LICENSE",
+			"ndi/lib/libndi_licenses.txt"
+		]
+	},
+	{
+		"key": "linux-arm64",
+		"platform": "linux",
+		"arch": "arm64",
+		"gypArch": "arm64",
+		"packageName": "@grandi/linux-arm64",
+		"packageDir": "packages/linux-arm64",
+		"sources": [
+			"ndi/lib/lnx-arm64/libndi.so.6",
+			"ndi/lib/LICENSE",
+			"ndi/lib/libndi_licenses.txt"
+		]
+	},
+	{
+		"key": "linux-arm",
+		"platform": "linux",
+		"arch": "arm",
+		"gypArch": "arm",
+		"packageName": "@grandi/linux-armv7l",
+		"packageDir": "packages/linux-armv7l",
+		"sources": [
+			"ndi/lib/lnx-armv7l/libndi.so.6",
+			"ndi/lib/LICENSE",
+			"ndi/lib/libndi_licenses.txt"
+		]
+	},
+	{
+		"key": "win32-x64",
+		"platform": "win32",
+		"arch": "x64",
+		"gypArch": "x64",
+		"packageName": "@grandi/win32-x64",
+		"packageDir": "packages/win32-x64",
+		"sources": [
+			"ndi/lib/win-x64/Processing.NDI.Lib.x64.dll",
+			"ndi/lib/win-x64/Processing.NDI.Lib.x64.lib",
+			"ndi/lib/LICENSE.pdf",
+			"ndi/lib/libndi_licenses.txt"
+		]
+	},
+	{
+		"key": "win32-ia32",
+		"platform": "win32",
+		"arch": "ia32",
+		"gypArch": "ia32",
+		"nodeTarget": "20.20.2",
+		"packageName": "@grandi/win32-ia32",
+		"packageDir": "packages/win32-ia32",
+		"sources": [
+			"ndi/lib/win-x86/Processing.NDI.Lib.x86.dll",
+			"ndi/lib/win-x86/Processing.NDI.Lib.x86.lib",
+			"ndi/lib/LICENSE.pdf",
+			"ndi/lib/libndi_licenses.txt"
+		]
+	},
+	{
+		"key": "darwin-arm64",
+		"platform": "darwin",
+		"arch": "arm64",
+		"gypArch": "arm64",
+		"packageName": "@grandi/darwin-arm64",
+		"packageDir": "packages/darwin-arm64",
+		"sources": [
+			"ndi/lib/macOS/libndi.dylib",
+			"ndi/lib/LICENSE.pdf",
+			"ndi/lib/libndi_licenses.txt"
+		]
+	},
+	{
+		"key": "darwin-x64",
+		"platform": "darwin",
+		"arch": "x64",
+		"gypArch": "x64",
+		"packageName": "@grandi/darwin-x64",
+		"packageDir": "packages/darwin-x64",
+		"sources": [
+			"ndi/lib/macOS/libndi.dylib",
+			"ndi/lib/LICENSE.pdf",
+			"ndi/lib/libndi_licenses.txt"
+		]
+	}
+];
 //#endregion
 //#region src/types.ts
-let FrameType = /* @__PURE__ */ function(FrameType$1) {
-	FrameType$1[FrameType$1["Interlaced"] = 0] = "Interlaced";
-	FrameType$1[FrameType$1["Progressive"] = 1] = "Progressive";
-	FrameType$1[FrameType$1["Field0"] = 2] = "Field0";
-	FrameType$1[FrameType$1["Field1"] = 3] = "Field1";
-	return FrameType$1;
+let FrameType = /* @__PURE__ */ function(FrameType) {
+	FrameType[FrameType["Interlaced"] = 0] = "Interlaced";
+	FrameType[FrameType["Progressive"] = 1] = "Progressive";
+	FrameType[FrameType["Field0"] = 2] = "Field0";
+	FrameType[FrameType["Field1"] = 3] = "Field1";
+	return FrameType;
 }({});
-let ColorFormat = /* @__PURE__ */ function(ColorFormat$1) {
-	ColorFormat$1[ColorFormat$1["BGRX_BGRA"] = 0] = "BGRX_BGRA";
-	ColorFormat$1[ColorFormat$1["UYVY_BGRA"] = 1] = "UYVY_BGRA";
-	ColorFormat$1[ColorFormat$1["RGBX_RGBA"] = 2] = "RGBX_RGBA";
-	ColorFormat$1[ColorFormat$1["UYVY_RGBA"] = 3] = "UYVY_RGBA";
-	ColorFormat$1[ColorFormat$1["Fastest"] = 100] = "Fastest";
-	ColorFormat$1[ColorFormat$1["Best"] = 101] = "Best";
-	ColorFormat$1[ColorFormat$1["BGRX_BGRA_FLIPPED"] = 1e3] = "BGRX_BGRA_FLIPPED";
-	return ColorFormat$1;
+let ColorFormat = /* @__PURE__ */ function(ColorFormat) {
+	ColorFormat[ColorFormat["BGRX_BGRA"] = 0] = "BGRX_BGRA";
+	ColorFormat[ColorFormat["UYVY_BGRA"] = 1] = "UYVY_BGRA";
+	ColorFormat[ColorFormat["RGBX_RGBA"] = 2] = "RGBX_RGBA";
+	ColorFormat[ColorFormat["UYVY_RGBA"] = 3] = "UYVY_RGBA";
+	ColorFormat[ColorFormat["Fastest"] = 100] = "Fastest";
+	ColorFormat[ColorFormat["Best"] = 101] = "Best";
+	ColorFormat[ColorFormat["BGRX_BGRA_FLIPPED"] = 1e3] = "BGRX_BGRA_FLIPPED";
+	return ColorFormat;
 }({});
-let AudioFormat = /* @__PURE__ */ function(AudioFormat$1) {
-	AudioFormat$1[AudioFormat$1["Float32Separate"] = 0] = "Float32Separate";
-	AudioFormat$1[AudioFormat$1["Float32Interleaved"] = 1] = "Float32Interleaved";
-	AudioFormat$1[AudioFormat$1["Int16Interleaved"] = 2] = "Int16Interleaved";
-	return AudioFormat$1;
+let AudioFormat = /* @__PURE__ */ function(AudioFormat) {
+	AudioFormat[AudioFormat["Float32Separate"] = 0] = "Float32Separate";
+	AudioFormat[AudioFormat["Float32Interleaved"] = 1] = "Float32Interleaved";
+	AudioFormat[AudioFormat["Int16Interleaved"] = 2] = "Int16Interleaved";
+	return AudioFormat;
 }({});
-let Bandwidth = /* @__PURE__ */ function(Bandwidth$1) {
-	Bandwidth$1[Bandwidth$1["MetadataOnly"] = -10] = "MetadataOnly";
-	Bandwidth$1[Bandwidth$1["AudioOnly"] = 10] = "AudioOnly";
-	Bandwidth$1[Bandwidth$1["Lowest"] = 0] = "Lowest";
-	Bandwidth$1[Bandwidth$1["Highest"] = 100] = "Highest";
-	return Bandwidth$1;
+let Bandwidth = /* @__PURE__ */ function(Bandwidth) {
+	Bandwidth[Bandwidth["MetadataOnly"] = -10] = "MetadataOnly";
+	Bandwidth[Bandwidth["AudioOnly"] = 10] = "AudioOnly";
+	Bandwidth[Bandwidth["Lowest"] = 0] = "Lowest";
+	Bandwidth[Bandwidth["Highest"] = 100] = "Highest";
+	return Bandwidth;
 }({});
-let FourCC = /* @__PURE__ */ function(FourCC$1) {
-	FourCC$1[FourCC$1["UYVY"] = 1498831189] = "UYVY";
-	FourCC$1[FourCC$1["UYVA"] = 1096178005] = "UYVA";
-	FourCC$1[FourCC$1["P216"] = 909193808] = "P216";
-	FourCC$1[FourCC$1["PA16"] = 909197648] = "PA16";
-	FourCC$1[FourCC$1["YV12"] = 842094169] = "YV12";
-	FourCC$1[FourCC$1["I420"] = 808596553] = "I420";
-	FourCC$1[FourCC$1["NV12"] = 842094158] = "NV12";
-	FourCC$1[FourCC$1["BGRA"] = 1095911234] = "BGRA";
-	FourCC$1[FourCC$1["BGRX"] = 1481787202] = "BGRX";
-	FourCC$1[FourCC$1["RGBA"] = 1094862674] = "RGBA";
-	FourCC$1[FourCC$1["RGBX"] = 1480738642] = "RGBX";
-	FourCC$1[FourCC$1["FLTp"] = 1884572742] = "FLTp";
-	return FourCC$1;
+let FourCC = /* @__PURE__ */ function(FourCC) {
+	FourCC[FourCC["UYVY"] = 1498831189] = "UYVY";
+	FourCC[FourCC["UYVA"] = 1096178005] = "UYVA";
+	FourCC[FourCC["P216"] = 909193808] = "P216";
+	FourCC[FourCC["PA16"] = 909197648] = "PA16";
+	FourCC[FourCC["YV12"] = 842094169] = "YV12";
+	FourCC[FourCC["I420"] = 808596553] = "I420";
+	FourCC[FourCC["NV12"] = 842094158] = "NV12";
+	FourCC[FourCC["BGRA"] = 1095911234] = "BGRA";
+	FourCC[FourCC["BGRX"] = 1481787202] = "BGRX";
+	FourCC[FourCC["RGBA"] = 1094862674] = "RGBA";
+	FourCC[FourCC["RGBX"] = 1480738642] = "RGBX";
+	FourCC[FourCC["FLTp"] = 1884572742] = "FLTp";
+	return FourCC;
 }({});
-
+/**
+* NDI sentinel that asks the SDK to generate synthesized timecode.
+*
+* @see [Synthesized timecode in the NDI SDK documentation](https://docs.ndi.video/all/getting-started/white-paper/time-timecode-and-sync-for-ndi#synthesized-timecode)
+*/
+const TIMECODE_SYNTHESIZE = 9223372036854775807n;
 //#endregion
 //#region src/index.ts
+function currentPlatformTarget() {
+	return platforms_default.find((target) => target.platform === process.platform && target.arch === process.arch);
+}
 /**
 * Checks if the current platform and architecture are supported by NDI.
-* @returns {boolean} True if the platform is supported (darwin, linux, or win32 with ia32/x64), false otherwise.
+* @returns {boolean} True if the platform and architecture are supported, false otherwise.
 */
 function isSupportedPlatform() {
-	return process.platform === "darwin" || process.platform === "linux" || process.platform === "win32" && ["ia32", "x64"].includes(process.arch);
+	return currentPlatformTarget() !== void 0;
 }
 function tryRequireArchPackage() {
 	const archKey = `${process.platform}-${process.arch}`;
-	const pkg = {
-		"linux-x64": "@grandi/linux-x64",
-		"linux-arm64": "@grandi/linux-arm64",
-		"linux-arm": "@grandi/linux-armv7l",
-		"win32-x64": "@grandi/win32-x64",
-		"win32-ia32": "@grandi/win32-ia32",
-		"darwin-x64": "@grandi/darwin-x64",
-		"darwin-arm64": "@grandi/darwin-arm64"
-	}[archKey];
-	if (!pkg) throw new Error(`Unsupported platform or architecture: ${archKey}`);
+	const target = currentPlatformTarget();
+	if (!target) throw new Error(`Unsupported platform or architecture: ${archKey}`);
+	const pkg = target.packageName;
 	try {
 		return __require(pkg);
-	} catch {
-		throw new Error(`Failed to find prebuilt package for ${archKey}. Please ensure that the package "${pkg}" is installed`);
+	} catch (cause) {
+		const packageError = /* @__PURE__ */ new Error(`Failed to find prebuilt package for ${archKey}. Please ensure that the package "${pkg}" is installed`);
+		Object.defineProperty(packageError, "cause", {
+			configurable: true,
+			value: cause
+		});
+		throw packageError;
 	}
 }
 function loadAddon() {
@@ -102,14 +203,16 @@ function loadAddon() {
 	try {
 		const archAddon = tryRequireArchPackage();
 		if (archAddon) return archAddon;
+		loadErrors.push(/* @__PURE__ */ new Error(`Prebuilt package for ${process.platform}-${process.arch} did not provide an addon`));
 	} catch (err) {
 		loadErrors.push(err);
 	}
 	if (loadErrors.length > 0) {
-		const aggregateError = /* @__PURE__ */ new Error("Failed to load native addon:\n" + loadErrors.map((e, i) => `  [${i + 1}] ${e.message}`).join("\n"));
-		console.error(aggregateError);
+		const message = "Failed to load native addon:\n" + loadErrors.map((e, i) => `  [${i + 1}] ${e.message}`).join("\n");
+		const AggregateErrorConstructor = globalThis.AggregateError;
+		throw AggregateErrorConstructor ? new AggregateErrorConstructor(loadErrors, message) : Object.assign(new Error(message), { errors: loadErrors });
 	}
-	return noopAddon;
+	throw new Error("Failed to load native addon");
 }
 const noopAddon = {
 	version() {
@@ -143,7 +246,7 @@ const noopAddon = {
 const addon = loadAddon();
 /**
 * Creates a finder to discover NDI sources on the network.
-* @param {FindOptions} [params={}] - Options for finding sources.
+* @param {FindOptions} params - Options for finding sources.
 * @param {boolean} [params.showLocalSources] - Whether to show local sources.
 * @param {string} [params.groups] - Multicast groups to search in.
 * @param {string} [params.extraIPs] - Additional IP addresses to search.
@@ -155,13 +258,18 @@ const addon = loadAddon();
 * import { find, initialize } from "grandi";
 * initialize();
 * const finder = await find({ showLocalSources: true });
-* finder.wait(1000);
+* await finder.wait(1000);
 * console.log(finder.sources());
 * finder.destroy();
 * ```
 */
 function find(params = {}) {
-	return addon.find(params);
+	const { extraIPs, extraIps, ...options } = params;
+	const normalizedExtraIps = extraIPs ?? extraIps;
+	return addon.find(normalizedExtraIps === void 0 ? options : {
+		...options,
+		extraIPs: normalizedExtraIps
+	});
 }
 /**
 * Gets the version of the NDI SDK.
@@ -174,8 +282,9 @@ const version = addon.version;
 */
 const isSupportedCPU = addon.isSupportedCPU;
 /**
-* Initializes the NDI library. Must be called before using any other NDI functions.
-* @returns {boolean} True if initialization was successful, false otherwise.
+* Optionally initializes the process-global NDI library. The SDK does not require
+* this call, but eager initialization is recommended for explicit lifecycle management.
+* @returns {boolean} True if initialization was successful and the CPU is supported.
 *
 * @example
 * ```js
@@ -185,9 +294,9 @@ const isSupportedCPU = addon.isSupportedCPU;
 */
 const initialize = addon.initialize;
 /**
-* Destroys the NDI library instance and cleans up resources.
-* Should be called when done using NDI to free resources.
-* @returns {boolean} True if destruction was successful, false otherwise.
+* Optionally shuts down the process-global NDI library.
+* When managing the lifecycle explicitly, destroy all native objects before calling this.
+* @returns {boolean} True after requesting shutdown.
 *
 * @example
 * ```js
@@ -215,7 +324,33 @@ const destroy = addon.destroy;
 * sender.destroy();
 * ```
 */
-const send = addon.send;
+async function send(params) {
+	const native = await addon.send(params);
+	Object.defineProperty(native, "sourceName", {
+		configurable: true,
+		value: native.sourcename
+	});
+	const origTally = native.tally;
+	native.tally = () => {
+		const result = origTally.call(native);
+		Object.defineProperties(result, {
+			onProgram: {
+				configurable: true,
+				get() {
+					return this.on_program;
+				}
+			},
+			onPreview: {
+				configurable: true,
+				get() {
+					return this.on_preview;
+				}
+			}
+		});
+		return result;
+	};
+	return native;
+}
 /**
 * Creates an NDI receiver for receiving video and audio from an NDI source.
 * @param {ReceiveOptions} params - Options for creating the receiver.
@@ -232,7 +367,7 @@ const send = addon.send;
 * import { find, initialize, receive } from "grandi";
 * initialize();
 * const finder = await find({ showLocalSources: true });
-* finder.wait(1000);
+* await finder.wait(1000);
 * const source = finder.sources()[0];
 * finder.destroy();
 * const receiver = await receive({ source });
@@ -241,45 +376,17 @@ const send = addon.send;
 * ```
 */
 const receive = addon.receive;
-/**
-* Creates an NDI frame-synchronizer (time base corrector) backed by an existing receiver.
-* Use this when you want smooth playback clocked to your own render/audio loop.
-*
-* Note: destroy the frame-sync before destroying the receiver.
-* @param {Receiver} receiver - The receiver instance to frame-sync.
-* @returns {Promise<FrameSync>} A promise that resolves to a FrameSync instance.
-* @throws {Error} Promise rejects on unsupported platform/CPU or if framesync creation fails.
-*
-* @example
-* ```js
-* import grandi from "grandi";
-* grandi.initialize();
-* const receiver = await grandi.receive({ source });
-* const fs = await grandi.framesync(receiver);
-* const frame = await fs.video(grandi.FrameType.Progressive);
-* fs.destroy();
-* receiver.destroy();
-* ```
-*/
+const frameSync = addon.framesync;
+/** @deprecated Use `frameSync` instead. */
 const framesync = addon.framesync;
-/**
-* Creates an NDI router for switching between different NDI sources.
-* @param {Object} params - Options for creating the router.
-* @param {string} [params.name] - The name for the router.
-* @param {string} [params.groups] - Multicast groups for the router.
-* @returns {Promise<Routing>} A promise that resolves to a Routing instance for source switching.
-* @throws {Error} Promise rejects on unsupported platform/CPU or if routing creation fails.
-*
-* @example
-* ```js
-* import { initialize, routing } from "grandi";
-* initialize();
-* const router = await routing({ name: "My Router" });
-* // router.change(source)
-* router.destroy();
-* ```
-*/
-const routing = addon.routing;
+async function routing(params) {
+	const native = await addon.routing(params);
+	Object.defineProperty(native, "sourceName", {
+		configurable: true,
+		value: native.sourcename
+	});
+	return native;
+}
 const grandi = {
 	version,
 	isSupportedCPU,
@@ -287,7 +394,7 @@ const grandi = {
 	destroy,
 	send,
 	receive,
-	framesync,
+	frameSync,
 	routing,
 	find,
 	ColorFormat,
@@ -295,39 +402,39 @@ const grandi = {
 	Bandwidth,
 	FrameType,
 	FourCC,
-	COLOR_FORMAT_BGRX_BGRA: ColorFormat.BGRX_BGRA,
-	COLOR_FORMAT_UYVY_BGRA: ColorFormat.UYVY_BGRA,
-	COLOR_FORMAT_RGBX_RGBA: ColorFormat.RGBX_RGBA,
-	COLOR_FORMAT_UYVY_RGBA: ColorFormat.UYVY_RGBA,
-	COLOR_FORMAT_FASTEST: ColorFormat.Fastest,
-	COLOR_FORMAT_BEST: ColorFormat.Best,
-	COLOR_FORMAT_BGRX_BGRA_FLIPPED: ColorFormat.BGRX_BGRA_FLIPPED,
-	BANDWIDTH_METADATA_ONLY: Bandwidth.MetadataOnly,
-	BANDWIDTH_AUDIO_ONLY: Bandwidth.AudioOnly,
-	BANDWIDTH_LOWEST: Bandwidth.Lowest,
-	BANDWIDTH_HIGHEST: Bandwidth.Highest,
-	FORMAT_TYPE_PROGRESSIVE: FrameType.Progressive,
-	FORMAT_TYPE_INTERLACED: FrameType.Interlaced,
-	FORMAT_TYPE_FIELD_0: FrameType.Field0,
-	FORMAT_TYPE_FIELD_1: FrameType.Field1,
-	AUDIO_FORMAT_FLOAT_32_SEPARATE: AudioFormat.Float32Separate,
-	AUDIO_FORMAT_FLOAT_32_INTERLEAVED: AudioFormat.Float32Interleaved,
-	AUDIO_FORMAT_INT_16_INTERLEAVED: AudioFormat.Int16Interleaved,
-	FOURCC_UYVY: FourCC.UYVY,
-	FOURCC_UYVA: FourCC.UYVA,
-	FOURCC_P216: FourCC.P216,
-	FOURCC_PA16: FourCC.PA16,
-	FOURCC_YV12: FourCC.YV12,
-	FOURCC_I420: FourCC.I420,
-	FOURCC_NV12: FourCC.NV12,
-	FOURCC_BGRA: FourCC.BGRA,
-	FOURCC_BGRX: FourCC.BGRX,
-	FOURCC_RGBA: FourCC.RGBA,
-	FOURCC_RGBX: FourCC.RGBX,
-	FOURCC_FLTp: FourCC.FLTp
+	COLOR_FORMAT_BGRX_BGRA: 0,
+	COLOR_FORMAT_UYVY_BGRA: 1,
+	COLOR_FORMAT_RGBX_RGBA: 2,
+	COLOR_FORMAT_UYVY_RGBA: 3,
+	COLOR_FORMAT_FASTEST: 100,
+	COLOR_FORMAT_BEST: 101,
+	COLOR_FORMAT_BGRX_BGRA_FLIPPED: 1e3,
+	AUDIO_FORMAT_FLOAT_32_SEPARATE: 0,
+	AUDIO_FORMAT_FLOAT_32_INTERLEAVED: 1,
+	AUDIO_FORMAT_INT_16_INTERLEAVED: 2,
+	BANDWIDTH_METADATA_ONLY: -10,
+	BANDWIDTH_AUDIO_ONLY: 10,
+	BANDWIDTH_LOWEST: 0,
+	BANDWIDTH_HIGHEST: 100,
+	FORMAT_TYPE_PROGRESSIVE: 1,
+	FORMAT_TYPE_INTERLACED: 0,
+	FORMAT_TYPE_FIELD_0: 2,
+	FORMAT_TYPE_FIELD_1: 3,
+	FOURCC_UYVY: 1498831189,
+	FOURCC_UYVA: 1096178005,
+	FOURCC_P216: 909193808,
+	FOURCC_PA16: 909197648,
+	FOURCC_YV12: 842094169,
+	FOURCC_I420: 808596553,
+	FOURCC_NV12: 842094158,
+	FOURCC_BGRA: 1095911234,
+	FOURCC_BGRX: 1481787202,
+	FOURCC_RGBA: 1094862674,
+	FOURCC_RGBX: 1480738642,
+	FOURCC_FLTp: 1884572742,
+	TIMECODE_SYNTHESIZE
 };
-var src_default = grandi;
-
 //#endregion
-export { AudioFormat, Bandwidth, ColorFormat, FourCC, FrameType, src_default as default, destroy, find, framesync, initialize, isSupportedCPU, receive, routing, send, version };
+export { AudioFormat, Bandwidth, ColorFormat, FourCC, FrameType, TIMECODE_SYNTHESIZE, grandi as default, destroy, find, frameSync, framesync, initialize, isSupportedCPU, receive, routing, send, version };
+
 //# sourceMappingURL=index.mjs.map