@luxonis/depthai-viewer-common 3.9.7 → 4.0.0

package/benchmark-cli.mjs

@@ -1,12 +1,12 @@
 #!/usr/bin/env node
 
 import * as prompts from '@clack/prompts';
-import { spawn } from 'node:child_process';
-import { existsSync, statSync } from 'node:fs';
-import { dirname, join } from 'node:path';
+import {spawn} from 'node:child_process';
+import {existsSync, statSync} from 'node:fs';
+import {dirname, join, resolve} from 'node:path';
 import process from 'node:process';
-import { clearLine, cursorTo } from 'node:readline';
-import { fileURLToPath } from 'node:url';
+import {clearLine, cursorTo} from 'node:readline';
+import {fileURLToPath} from 'node:url';
 
 const __filename = fileURLToPath(import.meta.url);
 const repoRoot = join(dirname(__filename), '..', '..');
@@ -16,11 +16,14 @@ const benchmarkCatalog = [
 	{ id: 'encoded-stream', label: 'H.264 Stream' },
 	{ id: 'nv12-stream', label: 'NV12 Stream' },
 	{ id: 'pointcloud', label: 'Point Cloud' },
+	{ id: 'image-stream', label: 'Image Stream', optional: true },
 ];
 const backValue = '__back__';
 const customResolutionValue = '__custom_resolution__';
 const sourceResolutionValue = '__source_resolution__';
 const defaultResolution = process.env.BENCHMARK_RESOLUTION ?? '1920x1080';
+const defaultFps = process.env.BENCHMARK_FPS ?? '30';
+const defaultStreams = Number(process.env.BENCHMARK_STREAMS ?? 1);
 const progressEventPrefix = '__BENCHMARK_PROGRESS__|';
 const isWindows = process.platform === 'win32';
 
@@ -91,7 +94,11 @@ Commands:
 Options:
   --benchmark ID              Select a single benchmark. Can be repeated.
   --benchmarks ID1,ID2        Select a comma-separated list of benchmarks.
+  --image PATH                Stream one JPG, PNG, or other OpenCV-supported image.
+  --compressed                Transport --image frames as H.264 instead of raw BGR888i.
   --resolution WIDTHxHEIGHT   Resolution used by the run command.
+  --fps FPS|unpaced           Publisher rate, default 30 FPS.
+  --streams N                 Number of concurrent stream topics, default 1.
   --interactive               Force interactive benchmark selection.
   --no-interactive            Disable interactive prompts.
   -h, --help                  Show this help message.
@@ -100,6 +107,8 @@ Examples:
   npm run benchmark
   npm run benchmark -- download
   npm run benchmark -- run --benchmark encoded-stream
+  npm run benchmark -- run --image ./odd-resolution.png
+  npm run benchmark -- run --image ./frame.png --compressed
   npm run benchmark -- list
 `);
 }
@@ -110,9 +119,13 @@ function parseArgs(argv) {
 
 	const options = {
 		benchmarkIds: [],
+		imagePath: null,
+		compressed: false,
 		resolution: defaultResolution,
 		hasResolutionFlag: false,
 		interactive: null,
+		fps: defaultFps,
+		streams: defaultStreams,
 		help: false,
 	};
 
@@ -150,6 +163,33 @@ function parseArgs(argv) {
 				options.hasResolutionFlag = true;
 				break;
 			}
+			case '--image': {
+				const value = args.shift();
+				if (!value) {
+					throw new Error('Missing value for --image');
+				}
+				options.imagePath = resolve(value);
+				break;
+			}
+			case '--compressed':
+				options.compressed = true;
+				break;
+			case '--fps': {
+				const value = args.shift();
+				if (!value) {
+					throw new Error('Missing value for --fps');
+				}
+				options.fps = value;
+				break;
+			}
+			case '--streams': {
+				const value = args.shift();
+				if (!value) {
+					throw new Error('Missing value for --streams');
+				}
+				options.streams = Number(value);
+				break;
+			}
 			case '--interactive':
 				options.interactive = true;
 				break;
@@ -179,6 +219,9 @@ function parseArgs(argv) {
 	}
 
 	options.benchmarkIds = [...new Set(options.benchmarkIds)];
+	if (options.imagePath && options.benchmarkIds.length === 0) {
+		options.benchmarkIds = ['image-stream'];
+	}
 	return { command, options };
 }
 
@@ -208,6 +251,15 @@ function validateResolution(resolution) {
 	}
 }
 
+function validateLoadOptions(fps, streams) {
+	if (fps !== 'unpaced' && (!Number.isFinite(Number(fps)) || Number(fps) <= 0)) {
+		throw new Error('FPS must be a positive number or unpaced');
+	}
+	if (!Number.isInteger(streams) || streams <= 0) {
+		throw new Error('Stream count must be a positive integer');
+	}
+}
+
 function shouldPromptForAction(options, command) {
 	if (options.interactive === false || command !== null) {
 		return false;
@@ -224,6 +276,16 @@ function shouldPromptForBenchmarks(options) {
 	return process.stdin.isTTY && process.stdout.isTTY;
 }
 
+function validateImagePath(imagePath) {
+	if (!existsSync(imagePath)) {
+		throw new Error(`Image does not exist: ${imagePath}`);
+	}
+
+	if (!statSync(imagePath).isFile()) {
+		throw new Error(`Image path is not a file: ${imagePath}`);
+	}
+}
+
 function shouldPromptForResolution(options, command) {
 	if (command !== 'run') {
 		return false;
@@ -236,6 +298,14 @@ function shouldPromptForResolution(options, command) {
 	return process.stdin.isTTY && process.stdout.isTTY;
 }
 
+function usesOnlyNativeImageResolution(options, benchmarkIds) {
+	return (
+		!options.hasResolutionFlag &&
+		benchmarkIds.length === 1 &&
+		benchmarkIds[0] === 'image-stream'
+	);
+}
+
 function toSelectionArgs(benchmarkIds) {
 	const args = [];
 
@@ -286,7 +356,9 @@ async function promptForBenchmarks() {
 	}
 
 	if (selectionMode === 'all') {
-		return benchmarkCatalog.map((benchmark) => benchmark.id);
+		return benchmarkCatalog
+			.filter((benchmark) => !benchmark.optional)
+			.map((benchmark) => benchmark.id);
 	}
 
 	if (selectionMode === 'single') {
@@ -942,6 +1014,10 @@ async function resolveBenchmarkIds(options) {
 }
 
 async function resolveRunResolution(options, command, benchmarkIds) {
+	if (usesOnlyNativeImageResolution(options, benchmarkIds)) {
+		return null;
+	}
+
 	if (!shouldPromptForResolution(options, command)) {
 		return options.resolution;
 	}
@@ -955,8 +1031,57 @@ async function resolveRunResolution(options, command, benchmarkIds) {
 	return selectedResolution;
 }
 
+async function resolveImagePath(options, command, benchmarkIds) {
+	if (!benchmarkIds.includes('image-stream')) {
+		if (options.imagePath) {
+			throw new Error('--image requires the image-stream benchmark');
+		}
+		return null;
+	}
+
+	if (command !== 'run') {
+		return null;
+	}
+
+	let imagePath = options.imagePath;
+	if (!imagePath && options.interactive !== false && process.stdin.isTTY && process.stdout.isTTY) {
+		const selectedImagePath = await prompts.text({
+			message: 'Which image should be streamed?',
+			placeholder: './image.png',
+			validate: (value) => {
+				try {
+					validateImagePath(resolve(value));
+					return;
+				} catch (error) {
+					return error instanceof Error ? error.message : String(error);
+				}
+			},
+		});
+
+		if (prompts.isCancel(selectedImagePath)) {
+			prompts.cancel('Image selection cancelled');
+			process.exit(1);
+		}
+
+		imagePath = resolve(selectedImagePath);
+	}
+
+	if (!imagePath) {
+		throw new Error('The image-stream benchmark requires --image PATH');
+	}
+
+	validateImagePath(imagePath);
+	return imagePath;
+}
+
 function formatResolutionDisplay(resolution, benchmarkIds) {
-	return resolution === null ? 'recorded source resolution' : resolution;
+	if (resolution !== null) {
+		return resolution;
+	}
+
+	return benchmarkIds.length === 1 && benchmarkIds[0] === 'image-stream'
+		? 'native image resolution'
+		: 'recorded source resolution';
 }
 
 function printBenchmarkList() {
@@ -1003,6 +1128,7 @@ async function main() {
 	if (options.hasResolutionFlag) {
 		validateResolution(options.resolution);
 	}
+	validateLoadOptions(options.fps, options.streams);
 
 	for (;;) {
 		if (shouldPromptForAction(options, command)) {
@@ -1027,10 +1153,15 @@ async function main() {
 		}
 
 		let benchmarkIds;
+		let resolvedImagePath = null;
 		let resolvedResolution = options.resolution;
 		for (;;) {
 			benchmarkIds = await resolveBenchmarkIds(options);
 			if (benchmarkIds !== backValue) {
+				resolvedImagePath = await resolveImagePath(options, command, benchmarkIds);
+				if (options.compressed && resolvedImagePath === null) {
+					throw new Error('--compressed requires the image-stream benchmark and --image PATH');
+				}
 				if (command !== 'run') {
 					break;
 				}
@@ -1063,11 +1194,25 @@ async function main() {
 
 		const selectionArgs = toSelectionArgs(benchmarkIds);
 		const resolutionArgs =
-			command === 'run' && resolvedResolution !== null
-				? ['--resolution', resolvedResolution]
+			command !== 'run'
+				? []
+				: resolvedResolution === null
+					? ['--source-resolution']
+					: ['--resolution', resolvedResolution];
+		const imageArgs =
+			command === 'run' && resolvedImagePath !== null
+				? ['--image', resolvedImagePath, ...(options.compressed ? ['--compressed'] : [])]
+				: [];
+		const loadArgs =
+			command === 'run'
+				? ['--fps', String(options.fps), '--streams', String(options.streams)]
 				: [];
 		const selectedDisplay =
-			benchmarkIds.length > 0 ? benchmarkIds.join(', ') : 'all benchmarks';
+			resolvedImagePath !== null
+				? `image-stream (${resolvedImagePath}${options.compressed ? ', H.264' : ', raw BGR888i'})`
+				: benchmarkIds.length > 0
+					? benchmarkIds.join(', ')
+					: 'all benchmarks';
 		const resolutionDisplay =
 			command === 'run' ? ` • ${formatResolutionDisplay(resolvedResolution, benchmarkIds)}` : '';
 
@@ -1093,11 +1238,21 @@ async function main() {
 			prompts.outro('Starting benchmark flow');
 			await runCommand(
 				rootRunCommand[0],
-				[...rootRunCommand.slice(1), ...rootBenchmarkScript, ...selectionArgs, ...resolutionArgs],
+				[
+					...rootRunCommand.slice(1),
+					...rootBenchmarkScript,
+					...selectionArgs,
+					...resolutionArgs,
+					...imageArgs,
+					...loadArgs,
+				],
 				{
 					env: {
 						...process.env,
 						BENCHMARK_SKIP_DOWNLOAD: '1',
+						BENCHMARK_FPS: String(options.fps),
+						BENCHMARK_STREAMS: String(options.streams),
+						BENCHMARK_RESOLUTION: resolvedResolution ?? 'source',
 					},
 				},
 			);

package/benchmark-lib.sh

@@ -7,6 +7,14 @@ BENCHMARK_DEFINITIONS=(
 	"encoded-stream|H.264 Stream"
 	"nv12-stream|NV12 Stream"
 	"pointcloud|Point Cloud"
+	"image-stream|Image Stream"
+)
+
+BENCHMARK_DEFAULT_IDS=(
+	"bgr888i-stream"
+	"encoded-stream"
+	"nv12-stream"
+	"pointcloud"
 )
 
 BENCHMARK_ASSET_DEFINITIONS=(
@@ -278,20 +286,20 @@ benchmark_add_selected_csv() {
 }
 
 benchmark_select_all_if_empty() {
-	local benchmark_definition benchmark_id
+	local benchmark_id
 
 	if (( ${#BENCHMARK_SELECTED_IDS[@]} > 0 )); then
 		return
 	fi
 
-	for benchmark_definition in "${BENCHMARK_DEFINITIONS[@]}"; do
-		IFS='|' read -r benchmark_id _ <<<"${benchmark_definition}"
+	for benchmark_id in "${BENCHMARK_DEFAULT_IDS[@]}"; do
 		BENCHMARK_SELECTED_IDS+=("${benchmark_id}")
 	done
 }
 
 benchmark_parse_selection_flags() {
 	BENCHMARK_SELECTED_IDS=()
+	local has_image=0
 
 	while [[ $# -gt 0 ]]; do
 		case "$1" in
@@ -311,23 +319,50 @@ benchmark_parse_selection_flags() {
 				benchmark_add_selected_csv "$2" || return 1
 				shift 2
 				;;
+			--image)
+				if [[ $# -lt 2 ]]; then
+					printf 'Missing value for --image\n' >&2
+					return 1
+				fi
+				has_image=1
+				shift 2
+				;;
 			*)
 				shift
 				;;
 		esac
 	done
 
+	if (( has_image )) && (( ${#BENCHMARK_SELECTED_IDS[@]} == 0 )); then
+		BENCHMARK_SELECTED_IDS+=("image-stream")
+	elif (( has_image )) && ! benchmark_selection_contains "image-stream"; then
+		printf '%s\n' '--image requires the image-stream benchmark' >&2
+		return 1
+	fi
+
 	benchmark_select_all_if_empty
 }
 
 benchmark_selected_plan_json() {
 	local json='['
 	local separator=''
-	local benchmark_id topic_name
+	local benchmark_id topic_name topic_index required_topics
+	local stream_count="${BENCHMARK_STREAMS:-1}"
+	local target_fps="${BENCHMARK_FPS:-30}"
+	local resolution="${BENCHMARK_RESOLUTION:-source}"
 
 	for benchmark_id in "${BENCHMARK_SELECTED_IDS[@]}"; do
 		topic_name="$(benchmark_get_topic_name "${benchmark_id}")" || return 1
-		json+="${separator}{\"id\":\"${benchmark_id}\",\"topicName\":\"${topic_name}\"}"
+		required_topics="[\"${topic_name}\""
+		for ((topic_index = 2; topic_index <= stream_count; topic_index += 1)); do
+			required_topics+=",\"${topic_name} #${topic_index}\""
+		done
+		required_topics+=']'
+		if [[ "${target_fps}" == 'unpaced' ]]; then
+			json+="${separator}{\"id\":\"${benchmark_id}\",\"topicName\":\"${topic_name}\",\"streamCount\":${stream_count},\"targetFps\":\"unpaced\",\"resolution\":\"${resolution}\",\"requiredTopics\":${required_topics}}"
+		else
+			json+="${separator}{\"id\":\"${benchmark_id}\",\"topicName\":\"${topic_name}\",\"streamCount\":${stream_count},\"targetFps\":${target_fps},\"resolution\":\"${resolution}\",\"requiredTopics\":${required_topics}}"
+		fi
 		separator=','
 	done
 

package/benchmark-root.sh

@@ -14,6 +14,9 @@ benchmark_init_ui
 REPO_ROOT="$(cd "${SCRIPT_DIR}/../.." && pwd)"
 VISUALIZER_DIR="${REPO_ROOT}/packages/visualizer"
 VITE_BIN="${REPO_ROOT}/node_modules/.bin/vite"
+read -r BENCHMARK_VISUALIZER_HOST BENCHMARK_VISUALIZER_PORT < <(
+	node -e 'const url = new URL(process.argv[1]); console.log(url.hostname, url.port || (url.protocol === "https:" ? "443" : "80"))' "${BENCHMARK_VISUALIZER_URL}"
+)
 
 configure_windows_npm_script_shell() {
 	if [[ "${OSTYPE:-}" != msys* && "${OSTYPE:-}" != cygwin* ]]; then
@@ -50,7 +53,33 @@ if ! benchmark_parse_selection_flags "$@"; then
 	exit 1
 fi
 
+benchmark_root_args=("$@")
+for ((benchmark_arg_index = 0; benchmark_arg_index < ${#benchmark_root_args[@]}; benchmark_arg_index += 1)); do
+	case "${benchmark_root_args[benchmark_arg_index]}" in
+		--fps)
+			BENCHMARK_FPS="${benchmark_root_args[benchmark_arg_index + 1]}"
+			;;
+		--streams)
+			BENCHMARK_STREAMS="${benchmark_root_args[benchmark_arg_index + 1]}"
+			;;
+		--resolution)
+			BENCHMARK_RESOLUTION="${benchmark_root_args[benchmark_arg_index + 1]}"
+			;;
+		--source-resolution)
+			BENCHMARK_RESOLUTION='source'
+			;;
+	esac
+done
+export BENCHMARK_FPS="${BENCHMARK_FPS:-30}"
+export BENCHMARK_STREAMS="${BENCHMARK_STREAMS:-1}"
+export BENCHMARK_RESOLUTION="${BENCHMARK_RESOLUTION:-source}"
+
 benchmark_plan="$(benchmark_selected_plan_json)"
+BENCHMARK_HARDWARE="$({
+	cd "${REPO_ROOT}"
+	node --input-type=module -e "import { collectHardwareReport } from './tools/benchmark-weekly/benchmark-report.mjs'; process.stdout.write(JSON.stringify(collectHardwareReport('/tmp')));"
+})"
+export BENCHMARK_HARDWARE
 
 cleanup() {
 	if [[ -f "${BENCHMARK_VISUALIZER_PIDFILE}" ]]; then
@@ -119,16 +148,57 @@ open_visualizer_preview() {
 trap cleanup EXIT HUP INT QUIT TERM
 cleanup
 
+configured_visualizer_port="${BENCHMARK_VISUALIZER_PORT}"
+BENCHMARK_VISUALIZER_PORT="$(
+	node -e '
+		const net = require("node:net");
+		const host = process.argv[1];
+		const firstPort = Number(process.argv[2]);
+		const lastPort = firstPort + 100;
+		const findAvailablePort = (port) => {
+			if (port > lastPort) {
+				console.error(`No free benchmark preview port found between ${firstPort} and ${lastPort}.`);
+				process.exit(1);
+			}
+			const server = net.createServer();
+			server.unref();
+			server.once("error", (error) => {
+				if (error.code === "EADDRINUSE" || error.code === "EACCES") {
+					findAvailablePort(port + 1);
+					return;
+				}
+				throw error;
+			});
+			server.listen({ host, port }, () => server.close(() => console.log(port)));
+		};
+		findAvailablePort(firstPort);
+	' "${BENCHMARK_VISUALIZER_HOST}" "${configured_visualizer_port}"
+)"
+if [[ "${BENCHMARK_VISUALIZER_PORT}" != "${configured_visualizer_port}" ]]; then
+	BENCHMARK_VISUALIZER_URL="$(
+		node -e 'const url = new URL(process.argv[1]); url.port = process.argv[2]; console.log(url.href)' \
+			"${BENCHMARK_VISUALIZER_URL}" "${BENCHMARK_VISUALIZER_PORT}"
+	)"
+	benchmark_log warn "Port ${configured_visualizer_port} is occupied; using ${BENCHMARK_VISUALIZER_URL}"
+fi
+
+benchmark_log info "Visualizer plan: $(benchmark_selected_ids_display)"
 (
 	cd "${VISUALIZER_DIR}"
-	benchmark_log info "Visualizer plan: $(benchmark_selected_ids_display)"
-	BENCHMARK=true BENCHMARK_PLAN="${benchmark_plan}" npm run build
-	# `open_visualizer_preview` owns browser launching so we can avoid duplicate tabs
-	# and still respect `BENCHMARK_OPEN_BROWSER=0`.
-	BENCHMARK=true BENCHMARK_PLAN="${benchmark_plan}" "${VITE_BIN}" preview --host localhost
-) >"${BENCHMARK_VISUALIZER_LOG}" 2>&1 &
+	BENCHMARK=true BENCHMARK_PLAN="${benchmark_plan}" BENCHMARK_HARDWARE="${BENCHMARK_HARDWARE}" npm run build
+) >"${BENCHMARK_VISUALIZER_LOG}" 2>&1
+
+# Replace the background shell with Vite so the PID file tracks the server
+# itself. Otherwise the shell can exit first and leave an orphaned preview.
+(
+	cd "${VISUALIZER_DIR}"
+	exec env BENCHMARK=true BENCHMARK_PLAN="${benchmark_plan}" BENCHMARK_HARDWARE="${BENCHMARK_HARDWARE}" "${VITE_BIN}" preview \
+		--host "${BENCHMARK_VISUALIZER_HOST}" \
+		--port "${BENCHMARK_VISUALIZER_PORT}" \
+		--strictPort
+) >>"${BENCHMARK_VISUALIZER_LOG}" 2>&1 &
 visualizer_pid=$!
-printf '%s' "${visualizer_pid}" >"${BENCHMARK_VISUALIZER_PIDFILE}"
+printf '%s\n' "${visualizer_pid}" >"${BENCHMARK_VISUALIZER_PIDFILE}"
 
 benchmark_log info "Starting visualizer preview. Logs: ${BENCHMARK_VISUALIZER_LOG}"
 for _ in {1..120}; do
@@ -137,18 +207,14 @@ for _ in {1..120}; do
 		exit 1
 	fi
 
-	if curl -sf http://localhost:4173/ >/dev/null; then
-		listener_pid="$(lsof -tiTCP:4173 -sTCP:LISTEN 2>/dev/null | head -n 1 || true)"
-		if [[ -n "${listener_pid}" ]] && ! grep -qx "${listener_pid}" "${BENCHMARK_VISUALIZER_PIDFILE}"; then
-			printf '\n%s' "${listener_pid}" >>"${BENCHMARK_VISUALIZER_PIDFILE}"
-		fi
+	if curl -sf "${BENCHMARK_VISUALIZER_URL}" >/dev/null; then
 		break
 	fi
 
 	sleep 1
 done
 
-if ! curl -sf http://localhost:4173/ >/dev/null; then
+if ! curl -sf "${BENCHMARK_VISUALIZER_URL}" >/dev/null; then
 	benchmark_log error "Visualizer preview did not become ready. See ${BENCHMARK_VISUALIZER_LOG}"
 	exit 1
 fi