@luxonis/depthai-viewer-common 2.5.2 → 2.5.3

package/benchmark-download.sh

@@ -3,156 +3,8 @@
 set -euo pipefail
 
 SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
-BENCHMARKS_DIR="${SCRIPT_DIR}/src/utils/benchmarks"
-MAX_DOWNLOAD_ATTEMPTS="${BENCHMARK_DOWNLOAD_RETRIES:-3}"
-
-BENCHMARKS=(
-	"bgr888i-stream"
-	"encoded-stream"
-	"nv12-stream"
-	"pointcloud"
-)
-
-BENCHMARK_ASSETS=(
-	"bgr888i-stream|bgr888i_stream.pkl|https://oak-viewer-releases.luxonis.com/benchmark/bgr888i-stream/bgr888i_stream.pkl"
-	"encoded-stream|encoded_stream.pkl|https://oak-viewer-releases.luxonis.com/benchmark/encoded-stream/encoded_stream.pkl"
-	"nv12-stream|nv12_stream.pkl|https://oak-viewer-releases.luxonis.com/benchmark/nv12-stream/nv12_stream.pkl"
-	"pointcloud|encoded_stream.pkl|https://oak-viewer-releases.luxonis.com/benchmark/pointcloud/encoded_stream.pkl"
-	"pointcloud|depth_stream.pkl|https://oak-viewer-releases.luxonis.com/benchmark/pointcloud/depth_stream.pkl"
-)
 
 trap 'exit 130' INT
 trap 'exit 143' TERM
 
-log() {
-	printf '[benchmark-download] %s\n' "$1"
-}
-
-file_size() {
-	local file_path=$1
-	stat -f%z "${file_path}" 2>/dev/null || stat -c%s "${file_path}"
-}
-
-install_requirements() {
-	local requirements_file="${BENCHMARKS_DIR}/requirements.txt"
-	log "Installing Python dependencies from ${requirements_file}"
-	python3 -m pip install --quiet -r "${requirements_file}"
-}
-
-get_remote_file_size() {
-	local url=$1
-	curl --head --silent --show-error --location --fail "${url}" |
-		awk 'BEGIN { IGNORECASE = 1 } /^content-length:/ { gsub("\r", "", $2); print $2; exit }'
-}
-
-download_asset() {
-	local benchmark_id=$1
-	local file_name=$2
-	local url=$3
-	local benchmark_dir="${BENCHMARKS_DIR}/${benchmark_id}"
-	local output_path="${benchmark_dir}/${file_name}"
-	local partial_path="${output_path}.part"
-	local expected_size=""
-	local final_size=""
-	local partial_size=""
-	local attempt=1
-	local curl_args=(
-		--fail
-		--location
-		--progress-bar
-		--output "${partial_path}"
-		"${url}"
-	)
-
-	expected_size="$(get_remote_file_size "${url}" || true)"
-
-	if [[ -f "${output_path}" ]]; then
-		if [[ -n "${expected_size}" ]]; then
-			final_size="$(file_size "${output_path}")"
-			if [[ "${final_size}" == "${expected_size}" ]]; then
-				log "Using existing asset ${file_name} for ${benchmark_id}"
-				return
-			fi
-
-			log "Existing file size mismatch for ${file_name}: found ${final_size} bytes, expected ${expected_size} bytes. Preparing to resume..."
-		else
-			log "Using existing asset ${file_name} for ${benchmark_id}"
-			return
-		fi
-
-		if [[ -f "${partial_path}" ]]; then
-			partial_size="$(file_size "${partial_path}")"
-			if [[ "${partial_size}" -lt "${final_size}" ]]; then
-				rm -f "${partial_path}"
-				mv "${output_path}" "${partial_path}"
-			else
-				rm -f "${output_path}"
-			fi
-		else
-			mv "${output_path}" "${partial_path}"
-		fi
-	fi
-
-	if [[ -f "${partial_path}" ]]; then
-		if [[ -n "${expected_size}" ]]; then
-			partial_size="$(file_size "${partial_path}")"
-			if [[ "${partial_size}" == "${expected_size}" ]]; then
-				mv "${partial_path}" "${output_path}"
-				log "Recovered completed asset ${file_name} for ${benchmark_id}"
-				return
-			fi
-
-			if [[ "${partial_size}" -gt "${expected_size}" ]]; then
-				log "Partial download for ${file_name} is larger than expected. Restarting download..."
-				rm -f "${partial_path}"
-			else
-				log "Resuming ${file_name} for ${benchmark_id} from ${partial_size} of ${expected_size} bytes"
-			fi
-		else
-			log "Resuming ${file_name} for ${benchmark_id} from existing partial file"
-		fi
-
-		curl_args=(--continue-at - "${curl_args[@]}")
-	else
-		log "Downloading ${file_name} for ${benchmark_id}"
-	fi
-
-	while (( attempt <= MAX_DOWNLOAD_ATTEMPTS )); do
-		if curl "${curl_args[@]}"; then
-			if [[ -n "${expected_size}" ]]; then
-				partial_size="$(file_size "${partial_path}")"
-				if [[ "${partial_size}" != "${expected_size}" ]]; then
-					log "Downloaded size mismatch for ${file_name}: expected ${expected_size} bytes, got ${partial_size} bytes"
-				else
-					mv "${partial_path}" "${output_path}"
-					log "Download completed: ${file_name}"
-					return
-				fi
-			else
-				mv "${partial_path}" "${output_path}"
-				log "Download completed: ${file_name}"
-				return
-			fi
-		fi
-
-		if (( attempt == MAX_DOWNLOAD_ATTEMPTS )); then
-			log "Download failed for ${file_name} after ${MAX_DOWNLOAD_ATTEMPTS} attempts"
-			return 1
-		fi
-
-		log "Retrying ${file_name} (${attempt}/${MAX_DOWNLOAD_ATTEMPTS})..."
-		attempt=$((attempt + 1))
-	done
-}
-
-log 'Upgrading pip'
-python3 -m pip install --quiet --upgrade pip
-
-install_requirements
-
-for benchmark_asset in "${BENCHMARK_ASSETS[@]}"; do
-	IFS='|' read -r benchmark_id file_name url <<<"${benchmark_asset}"
-	download_asset "${benchmark_id}" "${file_name}" "${url}"
-done
-
-log 'Benchmark assets are ready'
+exec "${SCRIPT_DIR}/benchmark.sh" download "$@"

package/benchmark-lib.sh

@@ -0,0 +1,336 @@
+#!/usr/bin/env bash
+
+BENCHMARK_GUM_ENABLED=0
+
+BENCHMARK_DEFINITIONS=(
+	"bgr888i-stream|BGR888i Stream"
+	"encoded-stream|H.264 Stream"
+	"nv12-stream|NV12 Stream"
+	"pointcloud|Point Cloud"
+)
+
+BENCHMARK_ASSET_DEFINITIONS=(
+	"bgr888i-stream|bgr888i_stream.pkl|https://oak-viewer-releases.luxonis.com/benchmark/bgr888i-stream/bgr888i_stream.pkl"
+	"encoded-stream|encoded_stream.pkl|https://oak-viewer-releases.luxonis.com/benchmark/encoded-stream/encoded_stream.pkl"
+	"nv12-stream|nv12_stream.pkl|https://oak-viewer-releases.luxonis.com/benchmark/nv12-stream/nv12_stream.pkl"
+	"pointcloud|encoded_stream.pkl|https://oak-viewer-releases.luxonis.com/benchmark/pointcloud/encoded_stream.pkl"
+	"pointcloud|depth_stream.pkl|https://oak-viewer-releases.luxonis.com/benchmark/pointcloud/depth_stream.pkl"
+)
+
+BENCHMARK_SELECTED_IDS=()
+
+benchmark_init_ui() {
+	local use_gum="${BENCHMARK_USE_GUM:-auto}"
+
+	BENCHMARK_GUM_ENABLED=0
+
+	case "${use_gum}" in
+		0|false|FALSE|False|no|NO|No)
+			return
+			;;
+	esac
+
+	if ! command -v gum >/dev/null 2>&1; then
+		return
+	fi
+
+	if [[ "${use_gum}" == 'auto' ]] && [[ ! -t 1 ]]; then
+		return
+	fi
+
+	BENCHMARK_GUM_ENABLED=1
+}
+
+benchmark_trim() {
+	local value=$1
+	value="${value#"${value%%[![:space:]]*}"}"
+	value="${value%"${value##*[![:space:]]}"}"
+	printf '%s' "${value}"
+}
+
+benchmark_join_by() {
+	local separator=$1
+	shift
+
+	if [[ $# -eq 0 ]]; then
+		return
+	fi
+
+	local result=$1
+	shift
+
+	for item in "$@"; do
+		result+="${separator}${item}"
+	done
+
+	printf '%s' "${result}"
+}
+
+benchmark_selected_ids_display() {
+	if (( ${#BENCHMARK_SELECTED_IDS[@]} == 0 )); then
+		return
+	fi
+
+	benchmark_join_by ', ' "${BENCHMARK_SELECTED_IDS[@]}"
+}
+
+benchmark_log() {
+	local level=$1
+	local message=$2
+	local gum_level='info'
+
+	case "${level}" in
+		info)
+			gum_level='info'
+			;;
+		success)
+			gum_level='info'
+			;;
+		warn)
+			gum_level='warn'
+			;;
+		error)
+			gum_level='error'
+			;;
+	esac
+
+	if (( BENCHMARK_GUM_ENABLED )) && [[ -t 1 ]]; then
+		case "${level}" in
+			success)
+				gum log --level "${gum_level}" "Done: ${message}"
+				;;
+			*)
+				gum log --level "${gum_level}" "${message}"
+				;;
+		esac
+		return
+	fi
+
+	printf '[benchmark] %s\n' "${message}"
+}
+
+benchmark_print_banner() {
+	local title=$1
+	local details=${2:-}
+
+	if (( BENCHMARK_GUM_ENABLED )) && [[ -t 1 ]]; then
+		if [[ -n "${details}" ]]; then
+			gum style \
+				--border rounded \
+				--border-foreground 39 \
+				--padding '0 1' \
+				--margin '1 0' \
+				"$(printf '%s\n%s' "${title}" "${details}")"
+		else
+			gum style \
+				--border rounded \
+				--border-foreground 39 \
+				--padding '0 1' \
+				--margin '1 0' \
+				"${title}"
+		fi
+		return
+	fi
+
+	printf '[benchmark] %s\n' "${title}"
+	if [[ -n "${details}" ]]; then
+		printf '%s\n' "${details}"
+	fi
+}
+
+benchmark_print_selection_summary() {
+	local mode=$1
+	local resolution=${2:-}
+	local selected_display
+	local details
+
+	selected_display="$(benchmark_selected_ids_display)"
+	details="$(printf 'Mode: %s\nBenchmarks: %s' "${mode}" "${selected_display}")"
+
+	if [[ -n "${resolution}" ]]; then
+		details+="
+Resolution: ${resolution}"
+	fi
+
+	benchmark_print_banner 'DepthAI Benchmark CLI' "${details}"
+}
+
+benchmark_run_with_spinner() {
+	local title=$1
+	shift
+
+	if (( BENCHMARK_GUM_ENABLED )) && [[ -t 1 ]]; then
+		gum spin --spinner dot --title "${title}" -- "$@"
+		return
+	fi
+
+	benchmark_log info "${title}"
+	"$@"
+}
+
+benchmark_print_available() {
+	local benchmark_definition benchmark_id topic_name
+
+	if (( BENCHMARK_GUM_ENABLED )) && [[ -t 1 ]]; then
+		gum style --bold --foreground 39 'Available benchmarks'
+		for benchmark_definition in "${BENCHMARK_DEFINITIONS[@]}"; do
+			IFS='|' read -r benchmark_id topic_name <<<"${benchmark_definition}"
+			printf '  %s  %s\n' "${benchmark_id}" "${topic_name}"
+		done
+		return
+	fi
+
+	printf 'Available benchmarks:\n'
+	for benchmark_definition in "${BENCHMARK_DEFINITIONS[@]}"; do
+		IFS='|' read -r benchmark_id topic_name <<<"${benchmark_definition}"
+		printf '  %s (%s)\n' "${benchmark_id}" "${topic_name}"
+	done
+}
+
+benchmark_selection_contains() {
+	local expected_id=$1
+	local benchmark_id
+
+	if (( ${#BENCHMARK_SELECTED_IDS[@]} == 0 )); then
+		return 1
+	fi
+
+	for benchmark_id in "${BENCHMARK_SELECTED_IDS[@]}"; do
+		if [[ "${benchmark_id}" == "${expected_id}" ]]; then
+			return 0
+		fi
+	done
+
+	return 1
+}
+
+benchmark_is_valid_id() {
+	local expected_id=$1
+	local benchmark_definition benchmark_id _
+
+	for benchmark_definition in "${BENCHMARK_DEFINITIONS[@]}"; do
+		IFS='|' read -r benchmark_id _ <<<"${benchmark_definition}"
+		if [[ "${benchmark_id}" == "${expected_id}" ]]; then
+			return 0
+		fi
+	done
+
+	return 1
+}
+
+benchmark_get_topic_name() {
+	local expected_id=$1
+	local benchmark_definition benchmark_id topic_name
+
+	for benchmark_definition in "${BENCHMARK_DEFINITIONS[@]}"; do
+		IFS='|' read -r benchmark_id topic_name <<<"${benchmark_definition}"
+		if [[ "${benchmark_id}" == "${expected_id}" ]]; then
+			printf '%s\n' "${topic_name}"
+			return 0
+		fi
+	done
+
+	return 1
+}
+
+benchmark_print_assets_for_id() {
+	local expected_id=$1
+	local benchmark_asset benchmark_id
+
+	for benchmark_asset in "${BENCHMARK_ASSET_DEFINITIONS[@]}"; do
+		IFS='|' read -r benchmark_id _ <<<"${benchmark_asset}"
+		if [[ "${benchmark_id}" == "${expected_id}" ]]; then
+			printf '%s\n' "${benchmark_asset}"
+		fi
+	done
+}
+
+benchmark_add_selected_id() {
+	local benchmark_id
+
+	benchmark_id="$(benchmark_trim "$1")"
+	if [[ -z "${benchmark_id}" ]]; then
+		printf 'Benchmark id cannot be empty\n' >&2
+		return 1
+	fi
+
+	if ! benchmark_is_valid_id "${benchmark_id}"; then
+		printf 'Unknown benchmark: %s\n' "${benchmark_id}" >&2
+		benchmark_print_available >&2
+		return 1
+	fi
+
+	if benchmark_selection_contains "${benchmark_id}"; then
+		return 0
+	fi
+
+	BENCHMARK_SELECTED_IDS+=("${benchmark_id}")
+}
+
+benchmark_add_selected_csv() {
+	local raw_ids=$1
+	local benchmark_ids benchmark_id
+
+	IFS=',' read -r -a benchmark_ids <<<"${raw_ids}"
+	for benchmark_id in "${benchmark_ids[@]}"; do
+		benchmark_add_selected_id "${benchmark_id}" || return 1
+	done
+}
+
+benchmark_select_all_if_empty() {
+	local benchmark_definition benchmark_id
+
+	if (( ${#BENCHMARK_SELECTED_IDS[@]} > 0 )); then
+		return
+	fi
+
+	for benchmark_definition in "${BENCHMARK_DEFINITIONS[@]}"; do
+		IFS='|' read -r benchmark_id _ <<<"${benchmark_definition}"
+		BENCHMARK_SELECTED_IDS+=("${benchmark_id}")
+	done
+}
+
+benchmark_parse_selection_flags() {
+	BENCHMARK_SELECTED_IDS=()
+
+	while [[ $# -gt 0 ]]; do
+		case "$1" in
+			--benchmark)
+				if [[ $# -lt 2 ]]; then
+					printf 'Missing value for --benchmark\n' >&2
+					return 1
+				fi
+				benchmark_add_selected_id "$2" || return 1
+				shift 2
+				;;
+			--benchmarks)
+				if [[ $# -lt 2 ]]; then
+					printf 'Missing value for --benchmarks\n' >&2
+					return 1
+				fi
+				benchmark_add_selected_csv "$2" || return 1
+				shift 2
+				;;
+			*)
+				shift
+				;;
+		esac
+	done
+
+	benchmark_select_all_if_empty
+}
+
+benchmark_selected_plan_json() {
+	local json='['
+	local separator=''
+	local benchmark_id topic_name
+
+	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}\"}"
+		separator=','
+	done
+
+	json+=']'
+	printf '%s\n' "${json}"
+}

package/benchmark-root.sh

@@ -4,7 +4,11 @@ set -euo pipefail
 
 BENCHMARK_VISUALIZER_LOG="${BENCHMARK_VISUALIZER_LOG:-/tmp/depthai-benchmark-visualizer.log}"
 BENCHMARK_VISUALIZER_PIDFILE="${BENCHMARK_VISUALIZER_PIDFILE:-/tmp/depthai-benchmark-visualizer.pid}"
+BENCHMARK_VISUALIZER_WARMUP_SECONDS="${BENCHMARK_VISUALIZER_WARMUP_SECONDS:-5}"
 SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+source "${SCRIPT_DIR}/benchmark-lib.sh"
+benchmark_init_ui
+
 REPO_ROOT="$(cd "${SCRIPT_DIR}/../.." && pwd)"
 VISUALIZER_DIR="${REPO_ROOT}/packages/visualizer"
 VITE_BIN="${REPO_ROOT}/node_modules/.bin/vite"
@@ -23,6 +27,12 @@ if [[ $# -eq 0 ]]; then
 	exit 1
 fi
 
+if ! benchmark_parse_selection_flags "$@"; then
+	exit 1
+fi
+
+benchmark_plan="$(benchmark_selected_plan_json)"
+
 cleanup() {
 	if [[ -f "${BENCHMARK_VISUALIZER_PIDFILE}" ]]; then
 		local visualizer_pid
@@ -56,15 +66,17 @@ cleanup
 
 (
 	cd "${VISUALIZER_DIR}"
-	BENCHMARK=true npm run build
-	BENCHMARK=true "${VITE_BIN}" preview --host localhost --open '/'
+	benchmark_log info "Visualizer plan: $(benchmark_selected_ids_display)"
+	BENCHMARK=true BENCHMARK_PLAN="${benchmark_plan}" npm run build
+	BENCHMARK=true BENCHMARK_PLAN="${benchmark_plan}" "${VITE_BIN}" preview --host localhost --open '/'
 ) >"${BENCHMARK_VISUALIZER_LOG}" 2>&1 &
 visualizer_pid=$!
 printf '%s' "${visualizer_pid}" >"${BENCHMARK_VISUALIZER_PIDFILE}"
 
+benchmark_log info "Starting visualizer preview. Logs: ${BENCHMARK_VISUALIZER_LOG}"
 for _ in {1..120}; do
 	if ! kill -0 "${visualizer_pid}" 2>/dev/null; then
-		echo "[benchmark] Visualizer preview exited early. See ${BENCHMARK_VISUALIZER_LOG}"
+		benchmark_log error "Visualizer preview exited early. See ${BENCHMARK_VISUALIZER_LOG}"
 		exit 1
 	fi
 
@@ -80,8 +92,13 @@ for _ in {1..120}; do
 done
 
 if ! curl -sf http://localhost:4173/ >/dev/null; then
-	echo "[benchmark] Visualizer preview did not become ready. See ${BENCHMARK_VISUALIZER_LOG}"
+	benchmark_log error "Visualizer preview did not become ready. See ${BENCHMARK_VISUALIZER_LOG}"
 	exit 1
 fi
 
+benchmark_log success 'Visualizer preview is ready'
+if [[ "${BENCHMARK_VISUALIZER_WARMUP_SECONDS}" != '0' ]]; then
+	benchmark_log info "Waiting ${BENCHMARK_VISUALIZER_WARMUP_SECONDS}s for the visualizer to connect before starting benchmarks"
+	sleep "${BENCHMARK_VISUALIZER_WARMUP_SECONDS}"
+fi
 "$@"