@stagetimerio/grandiose 0.1.0

package/dist/index.js

@@ -0,0 +1,101 @@
+/* Copyright 2018 Streampunk Media Ltd.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+const path = require("path")
+
+const addon = require(path.join(__dirname, "grandiose.node"));
+
+const COLOR_FORMAT_BGRX_BGRA = 0; // No alpha channel: BGRX, Alpha channel: BGRA
+const COLOR_FORMAT_UYVY_BGRA = 1; // No alpha channel: UYVY, Alpha channel: BGRA
+const COLOR_FORMAT_RGBX_RGBA = 2; // No alpha channel: RGBX, Alpha channel: RGBA
+const COLOR_FORMAT_UYVY_RGBA = 3; // No alpha channel: UYVY, Alpha channel: RGBA
+
+const NDI_LIB_FOURCC = (ch0, ch1, ch2, ch3) =>
+	(ch0.charCodeAt(0) | (ch1.charCodeAt(0) << 8) | (ch2.charCodeAt(0) << 16) | (ch3.charCodeAt(0) << 24))
+
+const FOURCC_UYVY = NDI_LIB_FOURCC("U", "Y", "V", "Y")
+const FOURCC_UYVA = NDI_LIB_FOURCC("U", "Y", "V", "A")
+const FOURCC_P216 = NDI_LIB_FOURCC("P", "2", "1", "6")
+const FOURCC_PA16 = NDI_LIB_FOURCC("P", "A", "1", "6")
+const FOURCC_YV12 = NDI_LIB_FOURCC("Y", "V", "1", "2")
+const FOURCC_I420 = NDI_LIB_FOURCC("I", "4", "2", "0")
+const FOURCC_NV12 = NDI_LIB_FOURCC("N", "V", "1", "2")
+const FOURCC_BGRA = NDI_LIB_FOURCC("B", "G", "R", "A")
+const FOURCC_BGRX = NDI_LIB_FOURCC("B", "G", "R", "X")
+const FOURCC_RGBA = NDI_LIB_FOURCC("R", "G", "B", "A")
+const FOURCC_RGBX = NDI_LIB_FOURCC("R", "G", "B", "X")
+const FOURCC_FLTp = NDI_LIB_FOURCC("F", "L", "T", "p")
+
+// On Windows there are some APIs that require bottom to top images in RGBA format. Specifying
+// this format will return images in this format. The image data pointer will still point to the
+// "top" of the image, althought he stride will be negative. You can get the "bottom" line of the image
+// using : video_data.p_data + (video_data.yres - 1)*video_data.line_stride_in_bytes
+const COLOR_FORMAT_BGRX_BGRA_FLIPPED = 200;
+
+const COLOR_FORMAT_FASTEST = 100;
+
+const BANDWIDTH_METADATA_ONLY = -10; // Receive metadata.
+const BANDWIDTH_AUDIO_ONLY    =  10; // Receive metadata, audio.
+const BANDWIDTH_LOWEST        =  0; // Receive metadata, audio, video at a lower bandwidth and resolution.
+const BANDWIDTH_HIGHEST       =  100; // Receive metadata, audio, video at full resolution.
+
+const FORMAT_TYPE_PROGRESSIVE = 1;
+const FORMAT_TYPE_INTERLACED = 0;
+const FORMAT_TYPE_FIELD_0 = 2;
+const FORMAT_TYPE_FIELD_1 = 3;
+
+// Default NDI audio format
+// Channels stored one after the other in each block - 32-bit floating point values
+const AUDIO_FORMAT_FLOAT_32_SEPARATE = 0;
+// Alternative NDI audio foramt
+// Channels stored as channel-interleaved 32-bit floating point values
+const AUDIO_FORMAT_FLOAT_32_INTERLEAVED = 1;
+// Alternative NDI audio format
+// Channels stored as channel-interleaved 16-bit integer values
+const AUDIO_FORMAT_INT_16_INTERLEAVED = 2;
+
+let find = function (...args) {
+  if (args.length === 0) return addon.find();
+  if (Array.isArray(args[0].groups)) {
+    args[0].groups = args[0].groups.reduce((x, y) => x + ',' + y);
+  }
+  if (Array.isArray(args[0].extraIPs)) {
+    args[0].extraIPs = args[0].extraIPs.reduce((x, y) => x + ',' + y);
+  }
+  return addon.find.apply(null, args);
+}
+
+module.exports = {
+  version: addon.version,
+  isSupportedCPU: addon.isSupportedCPU,
+  initialize: addon.initialize,
+  destroy: addon.destroy,
+  find: find,
+  receive: addon.receive,
+  send: addon.send,
+  routing: addon.routing,
+  COLOR_FORMAT_BGRX_BGRA, COLOR_FORMAT_UYVY_BGRA,
+  COLOR_FORMAT_RGBX_RGBA, COLOR_FORMAT_UYVY_RGBA,
+  COLOR_FORMAT_BGRX_BGRA_FLIPPED, COLOR_FORMAT_FASTEST,
+  FOURCC_UYVY, FOURCC_UYVA, FOURCC_P216, FOURCC_PA16, FOURCC_YV12,
+  FOURCC_I420, FOURCC_NV12, FOURCC_BGRA, FOURCC_BGRX, FOURCC_RGBA, FOURCC_RGBX,
+  FOURCC_FLTp,
+  BANDWIDTH_METADATA_ONLY, BANDWIDTH_AUDIO_ONLY,
+  BANDWIDTH_LOWEST, BANDWIDTH_HIGHEST,
+  FORMAT_TYPE_PROGRESSIVE, FORMAT_TYPE_INTERLACED,
+  FORMAT_TYPE_FIELD_0, FORMAT_TYPE_FIELD_1,
+  AUDIO_FORMAT_FLOAT_32_SEPARATE, AUDIO_FORMAT_FLOAT_32_INTERLEAVED,
+  AUDIO_FORMAT_INT_16_INTERLEAVED
+};

package/index.d.ts

@@ -0,0 +1,142 @@
+export interface AudioFrame {
+  type: 'audio'
+  audioFormat: AudioFormat
+  referenceLevel: number
+  sampleRate: number // Hz
+  channels: number
+  samples: number
+  channelStrideInBytes: number
+  timestamp: [number, number] // PTP timestamp
+  timecode: [number, number] // timecode as PTP value
+  data: Buffer
+}
+
+export interface VideoFrame {
+  type: 'video'
+  xres: number
+  yres: number
+  frameRateN: number
+  frameRateD: number
+  fourCC: FourCC
+  pictureAspectRatio: number
+  timestamp: [ number, number ] // PTP timestamp
+  frameFormatType: FrameType
+  timecode: [ number, number ] // Measured in nanoseconds
+  lineStrideBytes: number
+  data: Buffer
+}
+
+export interface Receiver {
+  embedded: unknown
+  video: (timeout?: number) => Promise<VideoFrame>
+  audio: (params: {
+    audioFormat: AudioFormat
+    referenceLevel: number
+  }, timeout?: number) => Promise<AudioFrame>
+  metadata: any
+  data: any
+  source: Source
+  colorFormat: ColorFormat
+  bandwidth: Bandwidth
+  allowVideoFields: boolean
+}
+
+export interface Sender {
+  embedded: unknown
+  destroy: () => Promise<void>
+  video: (frame: VideoFrame) => Promise<void>
+  audio: (frame: AudioFrame) => Promise<void>
+  connections: () => number
+  tally: () => { onProgram: boolean, onPreview: boolean }
+  sourcename: () => string
+  name: string
+  groups?: string | string[]
+  clockVideo: boolean
+  clockAudio: boolean
+}
+
+export interface Routing {
+  name: string
+  groups?: string
+  embedded: unknown
+  destroy: () => Promise<void>
+  change: (Source) => number
+  clear: () => boolean
+  connections: () => number
+  sourcename: () => string
+}
+
+export interface Source {
+  name: string
+  urlAddress?: string
+}
+
+export const enum FrameType {
+  Progressive = 1,
+  Interlaced = 0,
+  Field0 = 2,
+  Field1 = 3,
+}
+
+export const enum ColorFormat {
+  BGRX_BGRA = 0,
+  UYVY_BGRA = 1,
+  RGBX_RGBA = 2,
+  UYVY_RGBA = 3,
+  Fastest = 100,
+  Best = 101
+}
+
+export const enum FourCC {
+  UYVY = 1498831189,
+  UYVA = 1096178005,
+  P216 = 909193808,
+  PA16 = 909197648,
+  YV12 = 842094169,
+  I420 = 808596553,
+  NV12 = 842094158,
+  BGRA = 1095911234,
+  BGRX = 1481787202,
+  RGBA = 1094862674,
+  RGBX = 1480738642
+}
+
+export const enum AudioFormat {
+  Float32Separate = 0,
+  Float32Interleaved = 1,
+  Int16Interleaved = 2
+}
+
+export const enum Bandwidth {
+  MetadataOnly = -10,
+  AudioOnly = 10,
+  Lowest = 0,
+  Highest = 100
+}
+
+export function find(params: {
+  showLocalSources?: boolean
+  groups?: string | string[]
+  extraIPs?: string | string[]
+}): Promise<Source[]>
+
+export function receive(params: {
+  source: Source
+  colorFormat?: ColorFormat
+  bandwidth?: Bandwidth
+  allowVideoFields?: boolean
+  name?: string
+}): Receiver
+
+export function send(params: {
+  name: string
+  groups?: string | string[]
+  clockVideo?: boolean
+  clockAudio?: boolean
+}): Promise<Sender>
+
+export function routing(params: {
+  name: string
+  groups?: string | string[]
+}): Routing
+

package/index.js

@@ -0,0 +1,104 @@
+/* Copyright 2018 Streampunk Media Ltd.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+const path = require("path")
+
+const addon = require('bindings')({
+  bindings: "grandiose",
+  module_root: path.resolve(__dirname)
+});
+
+const COLOR_FORMAT_BGRX_BGRA = 0; // No alpha channel: BGRX, Alpha channel: BGRA
+const COLOR_FORMAT_UYVY_BGRA = 1; // No alpha channel: UYVY, Alpha channel: BGRA
+const COLOR_FORMAT_RGBX_RGBA = 2; // No alpha channel: RGBX, Alpha channel: RGBA
+const COLOR_FORMAT_UYVY_RGBA = 3; // No alpha channel: UYVY, Alpha channel: RGBA
+
+const NDI_LIB_FOURCC = (ch0, ch1, ch2, ch3) =>
+	(ch0.charCodeAt(0) | (ch1.charCodeAt(0) << 8) | (ch2.charCodeAt(0) << 16) | (ch3.charCodeAt(0) << 24))
+
+const FOURCC_UYVY = NDI_LIB_FOURCC("U", "Y", "V", "Y")
+const FOURCC_UYVA = NDI_LIB_FOURCC("U", "Y", "V", "A")
+const FOURCC_P216 = NDI_LIB_FOURCC("P", "2", "1", "6")
+const FOURCC_PA16 = NDI_LIB_FOURCC("P", "A", "1", "6")
+const FOURCC_YV12 = NDI_LIB_FOURCC("Y", "V", "1", "2")
+const FOURCC_I420 = NDI_LIB_FOURCC("I", "4", "2", "0")
+const FOURCC_NV12 = NDI_LIB_FOURCC("N", "V", "1", "2")
+const FOURCC_BGRA = NDI_LIB_FOURCC("B", "G", "R", "A")
+const FOURCC_BGRX = NDI_LIB_FOURCC("B", "G", "R", "X")
+const FOURCC_RGBA = NDI_LIB_FOURCC("R", "G", "B", "A")
+const FOURCC_RGBX = NDI_LIB_FOURCC("R", "G", "B", "X")
+const FOURCC_FLTp = NDI_LIB_FOURCC("F", "L", "T", "p")
+
+// On Windows there are some APIs that require bottom to top images in RGBA format. Specifying
+// this format will return images in this format. The image data pointer will still point to the
+// "top" of the image, althought he stride will be negative. You can get the "bottom" line of the image
+// using : video_data.p_data + (video_data.yres - 1)*video_data.line_stride_in_bytes
+const COLOR_FORMAT_BGRX_BGRA_FLIPPED = 200;
+
+const COLOR_FORMAT_FASTEST = 100;
+
+const BANDWIDTH_METADATA_ONLY = -10; // Receive metadata.
+const BANDWIDTH_AUDIO_ONLY    =  10; // Receive metadata, audio.
+const BANDWIDTH_LOWEST        =  0; // Receive metadata, audio, video at a lower bandwidth and resolution.
+const BANDWIDTH_HIGHEST       =  100; // Receive metadata, audio, video at full resolution.
+
+const FORMAT_TYPE_PROGRESSIVE = 1;
+const FORMAT_TYPE_INTERLACED = 0;
+const FORMAT_TYPE_FIELD_0 = 2;
+const FORMAT_TYPE_FIELD_1 = 3;
+
+// Default NDI audio format
+// Channels stored one after the other in each block - 32-bit floating point values
+const AUDIO_FORMAT_FLOAT_32_SEPARATE = 0;
+// Alternative NDI audio foramt
+// Channels stored as channel-interleaved 32-bit floating point values
+const AUDIO_FORMAT_FLOAT_32_INTERLEAVED = 1;
+// Alternative NDI audio format
+// Channels stored as channel-interleaved 16-bit integer values
+const AUDIO_FORMAT_INT_16_INTERLEAVED = 2;
+
+let find = function (...args) {
+  if (args.length === 0) return addon.find();
+  if (Array.isArray(args[0].groups)) {
+    args[0].groups = args[0].groups.reduce((x, y) => x + ',' + y);
+  }
+  if (Array.isArray(args[0].extraIPs)) {
+    args[0].extraIPs = args[0].extraIPs.reduce((x, y) => x + ',' + y);
+  }
+  return addon.find.apply(null, args);
+}
+
+module.exports = {
+  version: addon.version,
+  isSupportedCPU: addon.isSupportedCPU,
+  initialize: addon.initialize,
+  destroy: addon.destroy,
+  find: find,
+  receive: addon.receive,
+  send: addon.send,
+  routing: addon.routing,
+  COLOR_FORMAT_BGRX_BGRA, COLOR_FORMAT_UYVY_BGRA,
+  COLOR_FORMAT_RGBX_RGBA, COLOR_FORMAT_UYVY_RGBA,
+  COLOR_FORMAT_BGRX_BGRA_FLIPPED, COLOR_FORMAT_FASTEST,
+  FOURCC_UYVY, FOURCC_UYVA, FOURCC_P216, FOURCC_PA16, FOURCC_YV12,
+  FOURCC_I420, FOURCC_NV12, FOURCC_BGRA, FOURCC_BGRX, FOURCC_RGBA, FOURCC_RGBX,
+  FOURCC_FLTp,
+  BANDWIDTH_METADATA_ONLY, BANDWIDTH_AUDIO_ONLY,
+  BANDWIDTH_LOWEST, BANDWIDTH_HIGHEST,
+  FORMAT_TYPE_PROGRESSIVE, FORMAT_TYPE_INTERLACED,
+  FORMAT_TYPE_FIELD_0, FORMAT_TYPE_FIELD_1,
+  AUDIO_FORMAT_FLOAT_32_SEPARATE, AUDIO_FORMAT_FLOAT_32_INTERLEAVED,
+  AUDIO_FORMAT_INT_16_INTERLEAVED
+};

package/package.json

@@ -0,0 +1,61 @@
+{
+    "name": "@stagetimerio/grandiose",
+    "version": "0.1.0",
+    "description": "Node.js N-API native addon wrapping the NDI SDK.",
+    "homepage": "https://github.com/stagetimerio/grandiose#readme",
+    "keywords": [
+        "NDI",
+        "video",
+        "streaming",
+        "napi",
+        "native"
+    ],
+    "author": "Lukas Hermann <lukas@stagetimer.io>",
+    "contributors": [
+        "Dr. Ralf S. Engelschall <rse@engelschall.com> (NDI SDK 6, audio send, routing)",
+        "Ian Shade (NDI sender, TypeScript types)",
+        "Dan Jenkins (macOS fixes)",
+        "Streampunk Media (original implementation)"
+    ],
+    "license": "Apache-2.0",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "gypfile": true,
+    "files": [
+        "src/",
+        "scripts/",
+        "index.js",
+        "index.d.ts",
+        "binding.gyp"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/stagetimerio/grandiose.git"
+    },
+    "bugs": {
+        "url": "https://github.com/stagetimerio/grandiose/issues"
+    },
+    "publishConfig": {
+        "registry": "https://registry.npmjs.org"
+    },
+    "dependencies": {
+        "got": "14.6.6",
+        "mkdirp": "3.0.1",
+        "tmp": "0.2.5",
+        "execa": "9.6.1",
+        "cross-zip": "4.0.1",
+        "shelljs": "0.10.0"
+    },
+    "devDependencies": {
+        "bindings": "1.5.0",
+        "shx": "0.4.0",
+        "vitest": "^4.1.0"
+    },
+    "scripts": {
+        "install": "node scripts/ndi.js && node-gyp rebuild && node scripts/dist.js",
+        "build": "node-gyp rebuild && node scripts/dist.js",
+        "dist": "node scripts/dist.js",
+        "test": "vitest run",
+        "clean": "shx rm -rf ndi build dist"
+    }
+}

package/scripts/dist.js

@@ -0,0 +1,45 @@
+const fs = require("fs")
+const path = require("path")
+
+const root = path.resolve(__dirname, "..")
+const buildDir = path.join(root, "build", "Release")
+const distDir = path.join(root, "dist")
+
+/* clean and create dist/ */
+fs.rmSync(distDir, { recursive: true, force: true })
+fs.mkdirSync(distDir)
+
+/* copy grandiose.node */
+const nodePath = path.join(buildDir, "grandiose.node")
+if (!fs.existsSync(nodePath))
+    throw new Error("build/Release/grandiose.node not found — run node-gyp rebuild first")
+fs.copyFileSync(nodePath, path.join(distDir, "grandiose.node"))
+console.log("  copied grandiose.node")
+
+/* copy NDI shared libraries (.dylib, .so, .so.*, .dll) */
+const libPattern = /\.(dylib|so(\.\d+(\.\d+)*)?|dll)$/
+const libs = fs.readdirSync(buildDir).filter(f => libPattern.test(f))
+if (libs.length === 0)
+    throw new Error("No NDI shared library found in build/Release/")
+for (const lib of libs) {
+    fs.copyFileSync(path.join(buildDir, lib), path.join(distDir, lib))
+    console.log(`  copied ${lib}`)
+}
+
+/* generate dist/index.js from root index.js with rewritten require */
+let indexSrc = fs.readFileSync(path.join(root, "index.js"), "utf8")
+const needle = /const addon = require\('bindings'\)\(\{[\s\S]*?\}\);?/
+if (!needle.test(indexSrc))
+    throw new Error("Could not find bindings require in index.js — has the format changed?")
+indexSrc = indexSrc.replace(
+    needle,
+    'const addon = require(path.join(__dirname, "grandiose.node"));'
+)
+fs.writeFileSync(path.join(distDir, "index.js"), indexSrc)
+console.log("  generated index.js")
+
+/* copy index.d.ts */
+fs.copyFileSync(path.join(root, "index.d.ts"), path.join(distDir, "index.d.ts"))
+console.log("  copied index.d.ts")
+
+console.log("dist/ ready")

package/scripts/ndi.js

@@ -0,0 +1,159 @@
+/*
+  Copyright (c) 2021 Dr. Ralf S. Engelschall
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+/*  external requirements  */
+const fs        = require("fs")
+const path      = require("path")
+const os        = require("os")
+const shell     = require("shelljs")
+const { execa } = require("execa")
+const zip       = require("cross-zip")
+const { got }   = require("got")
+const mkdirp    = require("mkdirp")
+const tmp       = require("tmp")
+
+/*  establish asynchronous environment  */
+;(async () => {
+    console.log("++ ad-hoc assembling NDK SDK distribution subset from original sources")
+    if (os.platform() === "win32") {
+        /*  download innoextract utility  */
+        const url1 = "https://constexpr.org/innoextract/files/innoextract-1.9-windows.zip"
+        console.log("-- downloading innoextract utility")
+        const data1 = await got.get(url1, { responseType: "buffer" })
+        const file1 = tmp.tmpNameSync()
+        await fs.promises.writeFile(file1, data1.body, { encoding: null })
+
+        /*  extract innoextract utility  */
+        console.log("-- extracting innoextract utility")
+        const dir1 = tmp.tmpNameSync()
+        zip.unzipSync(file1, dir1)
+
+        /*  download NDI SDK distribution  */
+        const url2 = "https://downloads.ndi.tv/SDK/NDI_SDK/NDI%206%20SDK.exe"
+        console.log("-- dowloading NDI SDK distribution")
+        const data2 = await got.get(url2, { responseType: "buffer" })
+        const file2 = tmp.tmpNameSync()
+        await fs.promises.writeFile(file2, data2.body, { encoding: null })
+
+        /*  extract NDI SDK distribution  */
+        console.log("-- extracting NDI SDK distribution")
+        const dir2 = tmp.tmpNameSync()
+        shell.mkdir("-p", dir2)
+        await execa(path.join(dir1, "innoextract.exe"), [ "-s", "-d", dir2, file2 ],
+            { stdin: "inherit", stdout: "inherit", stderr: "inherit" })
+
+        /*  assemble NDI SDK subset  */
+        console.log("-- assembling NDI SDK subset")
+        shell.rm("-rf", "ndi")
+        shell.mkdir("-p", "ndi")
+        shell.mkdir("-p", "ndi/lib/win-x86")
+        shell.mkdir("-p", "ndi/lib/win-x64")
+        shell.mv(path.join(dir2, "app/Include"), "ndi/include")
+        shell.mv(path.join(dir2, "app/Lib/x86/Processing.NDI.Lib.x86.lib"), "ndi/lib/win-x86/Processing.NDI.Lib.x86.lib")
+        shell.mv(path.join(dir2, "app/Bin/x86/Processing.NDI.Lib.x86.dll"), "ndi/lib/win-x86/Processing.NDI.Lib.x86.dll")
+        shell.mv(path.join(dir2, "app/Lib/x64/Processing.NDI.Lib.x64.lib"), "ndi/lib/win-x64/Processing.NDI.Lib.x64.lib")
+        shell.mv(path.join(dir2, "app/Bin/x64/Processing.NDI.Lib.x64.dll"), "ndi/lib/win-x64/Processing.NDI.Lib.x64.dll")
+
+        /*  remove temporary files  */
+        console.log("-- removing temporary files")
+        shell.rm("-f", file1)
+        shell.rm("-f", file2)
+        shell.rm("-rf", dir1)
+        shell.rm("-rf", dir2)
+    }
+    else if (os.platform() === "darwin") {
+        /*  download NDI SDK distribution  */
+        const url1 = "https://downloads.ndi.tv/SDK/NDI_SDK_Mac/Install_NDI_SDK_v6_Apple.pkg"
+        console.log("-- dowloading NDI SDK distribution")
+        const data1 = await got.get(url1, { responseType: "buffer" })
+        const file1 = tmp.tmpNameSync()
+        await fs.promises.writeFile(file1, data1.body, { encoding: null })
+
+        /*  extract NDI SDK distribution  */
+        console.log("-- extracting NDI SDK distribution")
+        const dir1 = tmp.tmpNameSync()
+        shell.rm("-rf", dir1)
+        await execa("pkgutil", [ "--expand", file1, dir1 ],
+            { stdin: "inherit", stdout: "inherit", stderr: "inherit" })
+        await execa("cpio", [ "-idmu", "-F", path.join(dir1, "NDI_SDK_Component.pkg/Payload") ],
+            { cwd: dir1, stdin: "inherit", stdout: "ignore", stderr: "ignore" })
+
+        /*  assemble NDI SDK subset  */
+        console.log("-- assembling NDI SDK subset")
+        shell.rm("-rf", "ndi")
+        shell.mkdir("-p", "ndi/include")
+        shell.mkdir("-p", "ndi/lib/mac-a64")
+        shell.mkdir("-p", "ndi/lib/mac-x64")
+        shell.mv(path.join(dir1, "NDI SDK for Apple/include/*.h"), "ndi/include/")
+        shell.mv(path.join(dir1, "NDI SDK for Apple/lib/macOS/*.dylib"), "ndi/lib/mac-a64/")
+        shell.mv(path.join(dir1, "NDI SDK for Apple/lib/macOS/*.dylib"), "ndi/lib/mac-x64/")
+
+        /*  remove temporary files  */
+        console.log("-- removing temporary files")
+        shell.rm("-f", file1)
+        shell.rm("-rf", dir1)
+    }
+    else if (os.platform() === "linux") {
+        /*  download NDI SDK distribution  */
+        const url1 = "https://downloads.ndi.tv/SDK/NDI_SDK_Linux/Install_NDI_SDK_v6_Linux.tar.gz"
+        console.log("-- dowloading NDI SDK distribution")
+        const data1 = await got.get(url1, { responseType: "buffer" })
+        const file1 = tmp.tmpNameSync()
+        await fs.promises.writeFile(file1, data1.body, { encoding: null })
+
+        /*  extract NDI SDK distribution  */
+        console.log("-- extracting NDI SDK distribution")
+        const dir1 = tmp.tmpNameSync()
+        shell.mkdir("-p", dir1)
+        await execa("tar", [ "-z", "-x", "-C", dir1, "-f", file1 ],
+            { stdin: "inherit", stdout: "inherit", stderr: "inherit" })
+        await execa("sh", [ "-c", `echo "y" | PAGER=cat sh Install_NDI_SDK_v6_Linux.sh` ],
+            { cwd: dir1, stdin: "inherit", stdout: "ignore", stderr: "inherit" })
+
+        /*  assemble NDI SDK subset  */
+        console.log("-- assembling NDI SDK subset")
+        shell.rm("-rf", "ndi")
+        shell.mkdir("-p", "ndi/include")
+        shell.mkdir("-p", "ndi/lib/lnx-x86")
+        shell.mkdir("-p", "ndi/lib/lnx-x64")
+        shell.mkdir("-p", "ndi/lib/lnx-a64")
+        shell.mv(path.join(dir1, "NDI SDK for Linux/include/*.h"),                      "ndi/include/")
+        shell.mv(path.join(dir1, "NDI SDK for Linux/lib/i686-linux-gnu/*"),             "ndi/lib/lnx-x86/")
+        shell.mv(path.join(dir1, "NDI SDK for Linux/lib/x86_64-linux-gnu/*"),           "ndi/lib/lnx-x64/")
+        shell.mv(path.join(dir1, "NDI SDK for Linux/lib/aarch64-rpi4-linux-gnueabi/*"), "ndi/lib/lnx-a64/")
+
+        /*  dereference symlinks (Linux NDI SDK ships symlink chains)  */
+        for (const sub of ["lnx-x86", "lnx-x64", "lnx-a64"]) {
+            const dir = path.join("ndi", "lib", sub)
+            for (const f of fs.readdirSync(dir)) {
+                const p = path.join(dir, f)
+                if (fs.lstatSync(p).isSymbolicLink()) {
+                    const real = fs.realpathSync(p)
+                    fs.unlinkSync(p)
+                    fs.copyFileSync(real, p)
+                }
+            }
+        }
+
+        /*  remove temporary files  */
+        console.log("-- removing temporary files")
+        shell.rm("-f", file1)
+        shell.rm("-rf", dir1)
+    }
+})().catch((err) => {
+    console.log(`** ERROR: ${err}`)
+})
+