diff --git a/.env.example b/.env.example index b220868..05b20c3 100644 --- a/.env.example +++ b/.env.example @@ -22,9 +22,21 @@ SESSION_SECRET=changeme # MAM API Configuration MAM_API_URL=http://mam-api:3000 +# Node Agent Authentication +# Bearer token for node-agent to authenticate with mam-api /driver/* endpoints. +# Generate with: openssl rand -hex 32 +NODE_AGENT_TOKEN=changeme + # Auth — default to ON in production. Setting to 'false' is a dev-only escape # hatch that disables all auth checks and attaches a synthetic 'dev' user to # every request. Never run with AUTH_ENABLED=false on a network you don't control. +# +# RBAC v2 note: with AUTH_ENABLED=true, per-project access is enforced. Service +# API tokens (capture sidecar, Premiere panel, integrations) must belong to a +# user with the access they need — an 'admin' user (full access), or a user with +# the right project grants. A non-admin service token with no grants will get +# 403 on asset registration (ingest) and streaming. In dev mode the synthetic +# user is admin, so this only matters once auth is on. AUTH_ENABLED=true # CORS allowlist — comma-separated origins that may carry credentials to the API. @@ -36,3 +48,30 @@ ALLOWED_ORIGINS= # so secure-cookie + X-Forwarded-Proto behave correctly. ALSO required for accurate # per-IP login rate-limiting (otherwise req.ip is always the nginx IP). TRUST_PROXY=false + +# Google OAuth (OIDC) sign-in — OPTIONAL. Leave the client id/secret blank to +# disable; the "Sign in with Google" button and the /auth/google routes only +# activate when all three of CLIENT_ID, CLIENT_SECRET, and REDIRECT_URL are set. +# Create an OAuth 2.0 Client (type: Web application) in Google Cloud Console and +# add OAUTH_REDIRECT_URL to its authorized redirect URIs. +GOOGLE_CLIENT_ID= +GOOGLE_CLIENT_SECRET= +# Must exactly match a redirect URI on the OAuth client, e.g. +# https://dragonflight.live/api/v1/auth/google/callback +OAUTH_REDIRECT_URL= +# Restrict sign-in to one Google Workspace domain (recommended). First login from +# an allowed-domain account auto-provisions a NEW 'viewer' account (matched only +# by Google's stable subject id, never by email — so a Google login can never +# seize a pre-existing local account). An admin then grants project access. +# Leave blank to allow any verified Google account to self-provision (NOT advised). +GOOGLE_ALLOWED_DOMAIN= +# Note: if a Google-linked account also has TOTP enabled, sign-in still requires +# the authenticator code (Google is treated as the first factor). Accounts without +# TOTP complete sign-in in one Google step. + +# Playout / Master Control (MCR) +# Image tag the mam-api spawns when a channel starts. Build with: +# docker compose --profile build-only build playout +PLAYOUT_IMAGE=wild-dragon-playout:latest +# Base AMCP port — each channel binds to BASE + channel_id (in CasparCG terms). +PLAYOUT_AMCP_BASE_PORT=5250 diff --git a/.gitignore b/.gitignore index ee1cfd5..34dce83 100644 --- a/.gitignore +++ b/.gitignore @@ -27,8 +27,8 @@ services/editor/**/node_modules services/editor/**/dist services/editor/.pnpm-store -# Blackmagic DeckLink SDK + runtime libs (operator-supplied; see services/capture/build-with-decklink.sh) -services/capture/sdk/ +# Blackmagic DeckLink SDK headers are now committed (private/internal repo) under services/capture/sdk/. +# Runtime .so libs (libDeckLinkAPI.so) come from the DesktopVideo driver install and are not committed. services/capture/lib/ # Editor backups diff --git a/WORK_LOG_PLAYOUT.md b/WORK_LOG_PLAYOUT.md new file mode 100644 index 0000000..7da9aa3 --- /dev/null +++ b/WORK_LOG_PLAYOUT.md @@ -0,0 +1,101 @@ +# Playout / Master Control — Implementation Work Log + +**Branch:** `feat/playout-mcr` (off `main`) +**Started:** 2026-05-30 +**Status:** Code complete, awaiting runtime validation + +Tracks the build of the playout (MCR) subsystem against the design at +`docs/superpowers/specs/2026-05-30-playout-mcr-design.md`. + +--- + +## Commit sequence + +| # | Commit | Scope | +|---|--------|-------| +| 1 | `docs(playout)` | Design spec, §7 questions answered | +| 2 | `feat(mam-api): migration 029` | Six tables, failover columns, audio_normalized flag | +| 3 | `feat(worker): playout-stage` | S3 → /media + EBU R128 loudnorm + index.js wiring | +| 4 | `feat(playout): sidecar` | CasparCG image + AMCP shim, HLS preview consumer, fps-aware frame math | +| 5 | `feat(mam-api): /playout control plane + auto-failover` | Routes + scheduler health tick + restartChannel helper | +| 6 | `feat(web-ui): MCR page` | screens-playout, styles, app/shell/index.html wiring | +| 7 | `build(playout): compose wiring + .env knobs` | /media volume, queue addition, build-only service | +| 8 | `docs(playout): work log` | This file | + +## Resolved §7 decisions (2026-05-30) + +- **Audio loudness:** pre-normalize at stage time. ffmpeg `loudnorm` two-pass + (I=-23 LUFS, TP=-1 dBTP, LRA=11), linear mode preserves dynamics. Output + AAC 192k @ 48 kHz, video stream copied. Per-item `audio_normalized` flag + so re-stages of the same asset skip the pass. +- **Frame rate:** `1080p5994` default (was `1080i5994`). Per-channel + override allowed via `video_format`. `fpsFor(videoFormat)` helper in + the sidecar drives SEEK / LENGTH / transition-frames math. +- **Preview latency:** HLS v1. CasparCG runs a second FFMPEG consumer + alongside the primary output, writing `/media/live//index.m3u8` + (~600 kbps, 2s segments, 6-window list). Web UI plays via the existing + HLS plumbing. +- **Failover:** auto-restart on healthy node for NDI/SRT/RTMP. Alert-only + for DeckLink (device-index pinning makes blind re-placement risky). + Scheduler tick (PG advisory lock, same lock as recorder schedules) polls + sidecar `/status`; ~3 missed checks → `restartChannel(id)` picks the most + recently-seen-online other node, bumps `restart_count`, calls `/start`. + +## Architecture notes + +**Sidecar model.** One CasparCG container per channel. Spawned by mam-api +via local Docker socket (primary node) or remote node-agent +`/sidecar/start`. Tracked in `playout_sidecars` plus `playout_channels.container_id`. +Killed on `/stop` or by `restartChannel` during failover. + +**Media flow.** +``` +S3 master/proxy → playout-stage worker → /media/playout/. + (loudnormed, AAC@-23 LUFS) + ↓ + CasparCG channel #1 + ↓ + primary consumer HLS consumer + (DeckLink/NDI/ ↓ + SRT/RTMP) /media/live//*.m3u8 +``` + +**Port contention.** `assertDeckLinkFree()` blocks starting a SDI channel +when a recorder or another channel on the same node+device_index is active. + +**Failover scope.** NDI/SRT/RTMP have no hardware tie, so any healthy +cluster_node is eligible. DeckLink channels surface an alert in the UI +(`status='error'` + `error_message`) and require operator intervention. + +## Testing checklist + +- [ ] Apply migration 029 on dev DB +- [ ] Build playout image: `docker compose --profile build-only build playout` +- [ ] Build web-ui (`screens-playout` joins the esbuild list automatically) +- [ ] Create channel via POST /api/v1/playout/channels (SRT first, no HW) +- [ ] Stage 2-3 assets to a playlist, verify loudnorm metadata in stderr +- [ ] Start channel → sidecar container appears in `docker ps` +- [ ] AMCP smoke: `telnet 5250`, `VERSION`, `INFO` +- [ ] Play playlist; verify HLS at /media/live//index.m3u8 +- [ ] Skip / pause / resume / stop +- [ ] As-run log: GET /api/v1/playout/channels/:id/asrun +- [ ] Kill sidecar container → scheduler should restart on another node + within ~3 ticks (~45s), restart_count increments +- [ ] DeckLink channel kill: status flips to 'error', NO restart attempt +- [ ] Try starting a decklink channel on a device_index already held by a + recorder → 409 +- [ ] MCR UI smoke: nav entry visible, page renders, drag-drop adds items, + transport buttons hit the API + +## Known gaps (deferred) + +- No WebRTC preview (HLS-only v1 — 4-6s lag, fine for confidence monitor). +- No graphics/CG overlay layer in Phase A (templates land in Phase B). +- No Phase B scheduler / 24/7 wall-clock channel (schema is in place, + scheduler tick is not). +- No multi-channel grid view (one channel at a time per page). +- No timecode / remaining-duration overlay (would need CasparCG INFO poll). +- No audio level meters on the UI. +- `restartChannel` updates DB state and triggers `/start`; if the new node + also fails repeatedly, there's no exponential backoff yet — bounded only + by the manual stop button. diff --git a/deploy/install-driver.sh b/deploy/install-driver.sh new file mode 100644 index 0000000..090c24f --- /dev/null +++ b/deploy/install-driver.sh @@ -0,0 +1,297 @@ +#!/usr/bin/env bash +# ============================================================================ +# install-driver.sh +# ---------------------------------------------------------------------------- +# Idempotent HOST installer for capture-card runtime drivers / SDKs. +# +# Runs ON the cluster node's HOST kernel. The node-agent invokes it inside a +# one-shot PRIVILEGED ubuntu container that bind-mounts this repo plus the host +# paths needed to affect the host kernel (/lib/modules, /usr/src, /boot, /dev, +# and the host apt/dpkg via the mounted root). dkms / modprobe / ldconfig +# therefore operate against the running host kernel. +# +# Reads the proprietary vendor file(s) from sdk// (in this repo). +# NO binaries are committed — if the expected file is missing the script exits +# non-zero with a clear message telling the operator what to drop in. +# +# Vendors (ALLOWLIST — nothing else is accepted): +# blackmagic Desktop Video .deb (DKMS kernel module) +# aja NTV2 driver source/SDK (built kernel module) +# deltacast VideoMaster installer (kernel module) +# ndi redistributable runtime libs (user-space only, no module) +# +# Exit codes: +# 0 installed (or already present / up to date) +# 2 bad usage / unknown vendor +# 3 expected vendor file missing in sdk// +# 4 missing kernel headers (cannot build DKMS / module) +# 5 build / install / module-load failure +# +# `bash -n` must pass. set -euo pipefail with `|| true` guarding every probe. +# ============================================================================ +set -euo pipefail + +# --------------------------------------------------------------------------- +# Resolve our own repo dir (deploy/ -> repo root), regardless of CWD. +# --------------------------------------------------------------------------- +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" >/dev/null 2>&1 && pwd)" +REPO_DIR="$(cd "$SCRIPT_DIR/.." >/dev/null 2>&1 && pwd)" +SDK_ROOT="$REPO_DIR/sdk" + +VENDOR="${1:-}" +KVER="$(uname -r 2>/dev/null || echo unknown)" +REBOOT_REQUIRED=0 + +log() { echo "[install-driver] $*"; } +warn() { echo "[install-driver] WARN: $*" >&2; } +die() { echo "[install-driver] ERROR: $*" >&2; exit "${2:-5}"; } + +usage() { + echo "Usage: install-driver.sh " >&2 + exit 2 +} + +[ -n "$VENDOR" ] || usage +case "$VENDOR" in + blackmagic|aja|deltacast|ndi) : ;; + *) echo "[install-driver] ERROR: unknown vendor '$VENDOR' (allowed: blackmagic aja deltacast ndi)" >&2; exit 2 ;; +esac + +VENDOR_DIR="$SDK_ROOT/$VENDOR" +log "vendor=$VENDOR kernel=$KVER repo=$REPO_DIR" +log "reading vendor files from $VENDOR_DIR" +[ -d "$VENDOR_DIR" ] || die "vendor dir $VENDOR_DIR does not exist (repo not mounted?)" 3 + +# Pick the newest file matching a glob; echo its path or empty. +newest_match() { + # shellcheck disable=SC2012 + ls -1t $1 2>/dev/null | head -n1 || true +} + +ensure_headers() { + if [ -d "/lib/modules/$KVER/build" ] || dpkg -s "linux-headers-$KVER" >/dev/null 2>&1; then + log "kernel headers for $KVER present" + return 0 + fi + log "installing linux-headers-$KVER ..." + apt-get update -y >/dev/null 2>&1 || true + if ! apt-get install -y "linux-headers-$KVER" >/dev/null 2>&1; then + # Fall back to the generic meta-package; still may not match a custom kernel. + apt-get install -y linux-headers-generic >/dev/null 2>&1 || true + fi + if [ -d "/lib/modules/$KVER/build" ] || dpkg -s "linux-headers-$KVER" >/dev/null 2>&1; then + log "kernel headers ready" + return 0 + fi + die "kernel headers for $KVER unavailable — cannot build module. Install linux-headers-$KVER on the host." 4 +} + +# =========================================================================== +# blackmagic — Desktop Video .deb (DKMS) + modprobe + restart desktopvideo +# =========================================================================== +install_blackmagic() { + # Detect existing state first (idempotent skip). + if lsmod 2>/dev/null | grep -q '^blackmagic' && [ -e /dev/blackmagic ]; then + log "blackmagic module loaded and /dev/blackmagic present — already installed" + if command -v dkms >/dev/null 2>&1; then dkms status 2>/dev/null | grep -i blackmagic || true; fi + return 0 + fi + + local deb + deb="$(newest_match "$VENDOR_DIR/desktopvideo_*_amd64.deb")" + [ -n "$deb" ] && [ -f "$deb" ] || die \ + "no desktopvideo_*_amd64.deb in $VENDOR_DIR — download Desktop Video for Ubuntu 22.04 and drop the .deb there (see sdk/blackmagic/README.md)." 3 + log "using package: $(basename "$deb")" + + ensure_headers + + log "apt-get install (DKMS build) ..." + apt-get update -y >/dev/null 2>&1 || true + apt-get install -y "$deb" || die "apt-get install of $(basename "$deb") failed (DKMS build?)" 5 + + log "depmod + modprobe blackmagic ..." + depmod -a "$KVER" 2>/dev/null || true + if ! modprobe blackmagic 2>/dev/null; then + warn "modprobe blackmagic failed — a reboot may be required for the DKMS module to bind" + REBOOT_REQUIRED=1 + fi + + # Restart the DesktopVideoHelper daemon if present. + if command -v systemctl >/dev/null 2>&1; then + systemctl restart desktopvideo 2>/dev/null \ + || systemctl restart DesktopVideoHelper 2>/dev/null || true + fi + + if lsmod 2>/dev/null | grep -q '^blackmagic' || [ -e /dev/blackmagic ]; then + log "blackmagic installed (module loaded / device present)" + else + warn "blackmagic installed but module not yet loaded — reboot required" + REBOOT_REQUIRED=1 + fi +} + +# =========================================================================== +# aja — build ntv2 kernel module from source archive + modprobe +# =========================================================================== +install_aja() { + if lsmod 2>/dev/null | grep -q 'ajantv2'; then + log "ajantv2 module already loaded — already installed" + return 0 + fi + + local src + src="$(newest_match "$VENDOR_DIR/ntv2sdk*.zip")" + [ -n "$src" ] || src="$(newest_match "$VENDOR_DIR/libajantv2*.tar.gz")" + [ -n "$src" ] && [ -f "$src" ] || die \ + "no ntv2sdk*.zip / libajantv2*.tar.gz in $VENDOR_DIR — download the AJA NTV2 Linux SDK and drop it there (see sdk/aja/README.md)." 3 + log "using source: $(basename "$src")" + + ensure_headers + apt-get install -y build-essential unzip >/dev/null 2>&1 || true + + local work; work="$(mktemp -d)" + log "extracting into $work ..." + case "$src" in + *.zip) unzip -q -o "$src" -d "$work" || die "failed to unzip $(basename "$src")" 5 ;; + *.tar.gz) tar -xzf "$src" -C "$work" || die "failed to untar $(basename "$src")" 5 ;; + esac + + # Find the linux driver dir (contains a Makefile producing ajantv2.ko). + local drvdir + drvdir="$(dirname "$(find "$work" -type d -path '*driver/linux' -print -quit 2>/dev/null || true)/." 2>/dev/null)" + [ -d "$drvdir" ] || drvdir="$(dirname "$(find "$work" -name 'ajantv2.c' -print -quit 2>/dev/null || true)" 2>/dev/null)" + [ -n "$drvdir" ] && [ -d "$drvdir" ] || die "could not locate AJA driver/linux source inside the archive" 5 + log "building module in $drvdir ..." + make -C "$drvdir" >/dev/null 2>&1 || die "AJA module build failed" 5 + + local ko + ko="$(find "$drvdir" -name 'ajantv2.ko' -print -quit 2>/dev/null || true)" + if [ -n "$ko" ]; then + install -D -m 0644 "$ko" "/lib/modules/$KVER/extra/ajantv2.ko" 2>/dev/null || true + depmod -a "$KVER" 2>/dev/null || true + fi + if ! modprobe ajantv2 2>/dev/null; then + # Fall back to the SDK's own load script if shipped. + local loader; loader="$(find "$work" -name 'load_ajantv2' -print -quit 2>/dev/null || true)" + if [ -n "$loader" ]; then bash "$loader" 2>/dev/null || true; fi + fi + + rm -rf "$work" 2>/dev/null || true + + if lsmod 2>/dev/null | grep -q 'ajantv2'; then + log "ajantv2 installed and loaded" + else + warn "ajantv2 built but not loaded — a reboot may be required (old in-tree module wedged?)" + REBOOT_REQUIRED=1 + fi +} + +# =========================================================================== +# deltacast — VideoMaster installer + module load +# =========================================================================== +install_deltacast() { + if lsmod 2>/dev/null | grep -q 'videomaster' || ls /dev/deltacast* >/dev/null 2>&1; then + log "Deltacast module loaded / device present — already installed" + return 0 + fi + + local pkg + pkg="$(newest_match "$VENDOR_DIR/VideoMaster*.run")" + [ -n "$pkg" ] || pkg="$(newest_match "$VENDOR_DIR/VideoMaster*.tar.gz")" + [ -n "$pkg" ] && [ -f "$pkg" ] || die \ + "no VideoMaster*.run / VideoMaster*.tar.gz in $VENDOR_DIR — obtain the Deltacast VideoMaster Linux installer and drop it there (see sdk/deltacast/README.md)." 3 + log "using installer: $(basename "$pkg")" + + ensure_headers + apt-get install -y build-essential dkms >/dev/null 2>&1 || true + + local work; work="$(mktemp -d)" + case "$pkg" in + *.run) + log "extracting self-extractor ..." + chmod +x "$pkg" 2>/dev/null || true + "$pkg" --noexec --target "$work" >/dev/null 2>&1 \ + || cp "$pkg" "$work/installer.run" + ;; + *.tar.gz) + tar -xzf "$pkg" -C "$work" || die "failed to untar $(basename "$pkg")" 5 + ;; + esac + + local installer + installer="$(find "$work" -name 'install.sh' -print -quit 2>/dev/null || true)" + [ -n "$installer" ] || installer="$(find "$work" -name 'installer.run' -print -quit 2>/dev/null || true)" + [ -n "$installer" ] && [ -f "$installer" ] || die "Deltacast installer (install.sh) not found inside the package" 5 + log "running vendor installer: $(basename "$installer") ..." + chmod +x "$installer" 2>/dev/null || true + ( cd "$(dirname "$installer")" && bash "$installer" ) || die "Deltacast VideoMaster installer failed" 5 + + depmod -a "$KVER" 2>/dev/null || true + modprobe videomasterhd 2>/dev/null || modprobe videomaster 2>/dev/null || true + + rm -rf "$work" 2>/dev/null || true + + if lsmod 2>/dev/null | grep -q 'videomaster' || ls /dev/deltacast* >/dev/null 2>&1; then + log "Deltacast VideoMaster installed" + fi + # First-time VideoMaster installs lay down udev rules + firmware that need a reboot. + warn "Deltacast: a REBOOT is recommended after a first-time VideoMaster install (udev + firmware)" + REBOOT_REQUIRED=1 +} + +# =========================================================================== +# ndi — copy redistributable runtime libs to /usr/local/lib + ldconfig +# =========================================================================== +install_ndi() { + local target="/opt/ndi-lib" + local found=0 + # shellcheck disable=SC2231 + for f in "$VENDOR_DIR"/libndi*.so*; do + [ -e "$f" ] || continue + found=1 + break + done + [ "$found" = 1 ] || die \ + "no libndi*.so* in $VENDOR_DIR — drop the NDI runtime redistributable libs there (see sdk/ndi/README.md)." 3 + + log "copying NDI runtime libs to $target ..." + mkdir -p "$target" + cp -av "$VENDOR_DIR"/libndi*.so* "$target"/ 2>/dev/null || die "failed copying NDI libs" 5 + + # Recreate the libndi.so dev symlink if only versioned libs were shipped. + if [ ! -e "$target/libndi.so" ]; then + local versioned + versioned="$(newest_match "$target/libndi.so.*")" + if [ -n "$versioned" ]; then + ln -sf "$(basename "$versioned")" "$target/libndi.so" 2>/dev/null || true + fi + fi + + echo "$target" > /etc/ld.so.conf.d/ndi.conf + ldconfig 2>/dev/null || true + + if ldconfig -p 2>/dev/null | grep -q 'libndi'; then + log "NDI runtime registered with the dynamic linker" + else + die "NDI libs copied but ldconfig did not resolve libndi" 5 + fi + log "NDI: no kernel module and no reboot required." + log "NDI: restart any process that already loaded an older libndi to pick up the new version." +} + +# --------------------------------------------------------------------------- +case "$VENDOR" in + blackmagic) install_blackmagic ;; + aja) install_aja ;; + deltacast) install_deltacast ;; + ndi) install_ndi ;; +esac + +if [ "$REBOOT_REQUIRED" = 1 ]; then + log "RESULT: $VENDOR install completed — REBOOT REQUIRED" + echo "[install-driver] REBOOT_REQUIRED=1" +else + log "RESULT: $VENDOR install completed — no reboot required" + echo "[install-driver] REBOOT_REQUIRED=0" +fi +exit 0 diff --git a/deploy/onboard-node.sh b/deploy/onboard-node.sh index 5208c4d..c374c2b 100644 --- a/deploy/onboard-node.sh +++ b/deploy/onboard-node.sh @@ -16,11 +16,12 @@ # Environment variables: # MAM_API_URL REQUIRED Primary MAM API base URL # NODE_TOKEN API bearer token (required if AUTH_ENABLED=true) -# NODE_ROLE Role tag reported to the cluster (default: worker) +# NODE_ROLE Role tag reported to the cluster (default: auto-detect) # NODE_IP Override the LAN IP reported back (default: auto-detect) # AGENT_PORT Host port for the node agent (default: 7436) # INSTALL_DIR Where to clone/find the repo (default: /opt/wild-dragon) -# PROFILES Extra compose profiles, space-sep e.g. "worker capture" +# PROFILES Compose profiles, space-sep (default: auto-detect from hardware) +# Override only to force, e.g. "worker capture" # BMD_MODEL DeckLink card model name (e.g. "DeckLink Duo 2") # REPO_URL Override the Forgejo clone URL # ============================================================================= @@ -32,6 +33,9 @@ REPO_URL="${REPO_URL:-https://forge.wilddragon.net/zgaetano/wild-dragon.git}" INSTALL_DIR="${INSTALL_DIR:-/opt/wild-dragon}" MAM_API_URL="${MAM_API_URL:-}" NODE_TOKEN="${NODE_TOKEN:-}" +# Track whether the caller pinned NODE_ROLE explicitly (manual override) vs. +# us defaulting it — so auto-detection only fills in an *unset* role. +[[ -n "${NODE_ROLE:-}" ]] && NODE_ROLE_EXPLICIT=1 || NODE_ROLE_EXPLICIT="" NODE_ROLE="${NODE_ROLE:-worker}" NODE_IP="${NODE_IP:-}" AGENT_PORT="${AGENT_PORT:-7436}" @@ -65,6 +69,37 @@ detect_lan_ip() { echo "$ip" } +# ── Auto-detect hardware ───────────────────────────────────────────────────── +# Mirror detect_lan_ip's style: best-effort, guard every probe with `|| true` +# so a missing nvidia-smi/lspci never aborts under `set -euo pipefail`. The +# node self-describes its hardware here so the operator never has to pick a +# role — the right compose profiles are enabled automatically. + +# GPU present? nvidia-smi is the strong signal; fall back to an lspci scan for +# NVIDIA or AMD VGA controllers (covers nodes where the driver isn't installed +# yet but the card is physically present). +detect_gpu() { + if command -v nvidia-smi &>/dev/null && nvidia-smi -L &>/dev/null; then + return 0 + fi + if command -v lspci &>/dev/null; then + if lspci 2>/dev/null | grep -iE 'nvidia|vga.*amd' &>/dev/null; then + return 0 + fi + fi + return 1 +} + +# SDI capture card present? Blackmagic DeckLink or Deltacast, via lspci. +detect_sdi() { + if command -v lspci &>/dev/null; then + if lspci 2>/dev/null | grep -iE 'blackmagic|deltacast' &>/dev/null; then + return 0 + fi + fi + return 1 +} + # ── Preflight ──────────────────────────────────────────────────────────────── echo -e "\n${BLD}${CYN}Wild Dragon MAM — Cluster Node Onboarding${NC}\n" @@ -79,6 +114,36 @@ if [[ -z "$NODE_IP" ]]; then fi fi +# ── Auto-assign compose profiles from detected hardware ────────────────────── +# Operator never picks a role: the worker profile always runs, and we add the +# gpu / capture profiles only when the matching hardware is present. Explicit +# PROFILES / NODE_ROLE env vars are honoured as a manual override escape hatch. +HAS_GPU=false; HAS_SDI=false +detect_gpu && HAS_GPU=true || true +detect_sdi && HAS_SDI=true || true + +DETECTED_DESC="CPU" +[[ "$HAS_GPU" == true ]] && DETECTED_DESC="$DETECTED_DESC, GPU" +[[ "$HAS_SDI" == true ]] && DETECTED_DESC="$DETECTED_DESC, SDI capture card" + +if [[ -z "$PROFILES" ]]; then + AUTO_PROFILES="worker" + [[ "$HAS_GPU" == true ]] && AUTO_PROFILES="$AUTO_PROFILES gpu" + [[ "$HAS_SDI" == true ]] && AUTO_PROFILES="$AUTO_PROFILES capture" + PROFILES="$AUTO_PROFILES" + info "Detected: $DETECTED_DESC → profiles: $PROFILES" +else + info "Detected: $DETECTED_DESC (profiles overridden by env: $PROFILES)" +fi + +# Derive a human-friendly role tag from detected hardware when not pinned. +# Capture cards win over GPU (an SDI ingest node is the more specific role). +if [[ -z "$NODE_ROLE_EXPLICIT" ]]; then + if [[ "$HAS_SDI" == true ]]; then NODE_ROLE="capture" + elif [[ "$HAS_GPU" == true ]]; then NODE_ROLE="gpu" + else NODE_ROLE="worker"; fi +fi + info "Primary API : $MAM_API_URL" info "Role : $NODE_ROLE" info "Agent port : $AGENT_PORT" diff --git a/docker-compose.worker.yml b/docker-compose.worker.yml index 629516e..895c906 100644 --- a/docker-compose.worker.yml +++ b/docker-compose.worker.yml @@ -55,10 +55,25 @@ services: BMD_MODEL: ${BMD_MODEL:-} BMD_DEVICE_PREFIX: ${BMD_DEVICE_PREFIX:-dv} LIVE_DIR: ${LIVE_DIR:-/mnt/NVME/MAM/wild-dragon-live} + # REPO_DIR: host path to the checked-out repo. The agent passes this to the + # one-shot driver-install container so install-driver.sh can read + # sdk// and run deploy/install-driver.sh. Must match the host path + # bind-mounted below (onboard-node.sh clones to /opt/wild-dragon). + REPO_DIR: ${REPO_DIR:-/opt/wild-dragon} volumes: - /var/run/docker.sock:/var/run/docker.sock - /dev:/dev:ro - /mnt/NVME/MAM/wild-dragon-live:/mnt/NVME/MAM/wild-dragon-live:ro + # Capture-driver deployment ("Capture Drivers / SDKs" in the Cluster admin + # screen): the agent itself does NOT run dkms/modprobe — it spawns a + # separate privileged ubuntu container that bind-mounts these host paths. + # The agent only needs to *see* the repo path so it can pass it through as + # a bind to that container; no extra privileges are granted to the agent. + # /opt/wild-dragon → repo (sdk// + deploy/install-driver.sh) + # The install container additionally mounts /lib/modules,/usr/src,/boot, + # /dev and /opt from the host (handled in the agent, not here) so DKMS / + # modprobe / ldconfig affect the host kernel. + - ${REPO_DIR:-/opt/wild-dragon}:${REPO_DIR:-/opt/wild-dragon}:ro devices: - /dev/blackmagic:/dev/blackmagic @@ -103,6 +118,7 @@ services: # worker-l4: HEAVY tier (proxy/conform/trim) on the L4 (NVENC). Talks to # zampp1's Redis/Postgres/S3 over the LAN (.200). No promotion scanner here. worker-l4: + profiles: [gpu] build: context: ./services/worker dockerfile: Dockerfile.gpu diff --git a/docker-compose.yml b/docker-compose.yml index fce5ffb..c92e57c 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -40,6 +40,7 @@ services: - /var/run/docker.sock:/var/run/docker.sock - /mnt/NVME/MAM/wild-dragon-live:/live - /mnt/NVME/MAM/wild-dragon-growing:/growing + - /mnt/NVME/MAM/wild-dragon-media:/media - /mnt/NVME/MAM/sdk:/sdk - /dev/shm:/dev/shm - /run/dbus:/run/dbus @@ -60,7 +61,14 @@ services: DOCKER_NETWORK: wild-dragon_wild-dragon NODE_IP: ${NODE_IP} NODE_HOSTNAME: ${NODE_HOSTNAME:-} + # Bearer mam-api forwards to a node-agent when installing capture drivers + # ("Capture Drivers / SDKs" panel). Set to the same value as the agents' + # NODE_TOKEN. If empty, agents with an empty NODE_TOKEN accept the call + # (dev); agents with a token will reject it (401). + NODE_AGENT_TOKEN: ${NODE_AGENT_TOKEN:-} CAPTURE_TOKEN: ${CAPTURE_TOKEN} + PLAYOUT_IMAGE: ${PLAYOUT_IMAGE:-wild-dragon-playout:latest} + PLAYOUT_AMCP_BASE_PORT: ${PLAYOUT_AMCP_BASE_PORT:-5250} deploy: resources: reservations: @@ -104,6 +112,11 @@ services: dockerfile: Dockerfile.gpu image: wild-dragon-worker-gpu:latest runtime: nvidia + # Privileged so the promotion scanner can mount the growing-files CIFS share + # at /growing (same Approach A as the capture sidecar). Without the share + # mounted the scanner watches an empty local dir and never promotes growing + # captures to S3. + privileged: true depends_on: - queue - db @@ -120,14 +133,18 @@ services: # after the capability-routing split, so import jobs sat unprocessed and # assets stayed `ingesting` forever. import is concurrency-1 + network- # bound, so one consumer (this heavy/primary worker) is sufficient. - WORKER_QUEUES: proxy,conform,trim,import + WORKER_QUEUES: proxy,conform,trim,import,playout-stage RUN_PROMOTION: "true" PROXY_CONCURRENCY: "2" + PLAYOUT_MEDIA_DIR: /media NVIDIA_VISIBLE_DEVICES: GPU-79afca3e-2ab2-a6ea-1c44-706c1f0a26d6 WORKER_LABEL: "zampp1 / Tesla P4" NVIDIA_DRIVER_CAPABILITIES: video,compute,utility volumes: - - /mnt/NVME/MAM/wild-dragon-growing:/growing + # NOTE: /growing is NOT a host bind anymore — the promotion scanner mounts + # the CIFS landing-zone share there itself (a bind would shadow it). The + # mount needs rshared propagation so the in-container CIFS mount is visible. + - /mnt/NVME/MAM/wild-dragon-media:/media networks: - wild-dragon @@ -176,12 +193,22 @@ services: - "${PORT_WEB_UI:-7434}:80" volumes: - /mnt/NVME/MAM/wild-dragon-live:/live + - /mnt/NVME/MAM/wild-dragon-media:/media:ro - /dev/shm:/dev/shm - /run/dbus:/run/dbus - /run/systemd:/run/systemd networks: - wild-dragon + # Build-only: the CasparCG sidecar image. mam-api spawns these on-demand per + # channel (one container per playout channel), so this service is never up'd — + # it exists so `docker compose build playout` produces the image the API tags + # via PLAYOUT_IMAGE. Profile excludes it from default `up`. + playout: + profiles: ["build-only"] + build: ./services/playout + image: wild-dragon-playout:latest + volumes: postgres_data: redis_data: diff --git a/docs/superpowers/specs/2026-05-30-playout-mcr-design.md b/docs/superpowers/specs/2026-05-30-playout-mcr-design.md new file mode 100644 index 0000000..c1bd8a3 --- /dev/null +++ b/docs/superpowers/specs/2026-05-30-playout-mcr-design.md @@ -0,0 +1,235 @@ +# Wild Dragon MAM — Playout / Master Control (MCR) + +**Date:** 2026-05-30 (revised 2026-05-30 — §7 closed) +**Status:** APPROVED — implementation in progress (code drafted but uncommitted; see WORK_LOG_PLAYOUT.md) +**Author:** Zac + Claude + +--- + +## Resolved Decisions + +| Question | Decision | +|----------|----------| +| Playout engine | **CasparCG Server** (orchestrated via AMCP), not ffmpeg-native | +| Channel count | **Multi-channel from start** — N independent channels, placed across cluster nodes by capability (mirrors recorders) | +| Scheduling model | **Phased** — Phase A: on-demand playlist player; Phase B: 24/7 continuous channel | +| Output targets | SDI (DeckLink), NDI, SRT, RTMP — all via CasparCG consumers | +| Media source | Assets live in **S3**; must be staged to a CasparCG-local media volume before play (see §4) | +| CasparCG packaging | **Build our own image** (like `capture/build-with-decklink.sh`) — GL context via GPU passthrough or Xvfb; NDI + DeckLink SDKs fetched at build time (not redistributable) | +| Master codec playability | Zac confirms current masters **play fine in CasparCG** — no transcode-for-playout step; staging is a plain S3→/media copy. Validate on hardware but do not gate on it | +| Management UI | **Single Dragonflight `playout.html` GUI** drives everything via AMCP; operator never touches CasparCG directly | + +--- + +## Overview + +Playout adds **master-control-room** capability to Dragonflight: take library assets, arrange them on a timeline / playlist, and play them out continuously to a broadcast output — SDI via DeckLink, or stream via SRT / RTMP / NDI. Drag-and-drop scheduling, a program/preview monitor, and as-run logging. + +This is the **mirror image** of the existing capture path. Capture is `input → ffmpeg encode → S3`. Playout is `S3 asset → engine → output`. We reuse three things wholesale: + +1. **Cluster node + capability model** — nodes already advertise DeckLink/Deltacast/GPU in `cluster_nodes.capabilities`; channels are placed on nodes that have a free output port, exactly as recorders claim input ports. +2. **Sidecar orchestration** — mam-api spawns containers via the local Docker socket or the remote `node-agent /sidecar/start`. A CasparCG channel is just a different sidecar image. +3. **Scheduler tick + PG advisory lock** — `src/scheduler.js` already runs a single-leader tick over a schedule table. Phase B's wall-clock channel reuses this pattern. + +### Why CasparCG over ffmpeg-native + +The capture stack proves we can drive ffmpeg + DeckLink. But playout's hard part is **gapless, frame-accurate, clean transitions between clips** — every clip boundary in an ffmpeg-per-clip model is a black flash unless we engineer a concat-feeder. CasparCG solves this natively: a channel is a persistent output with a playlist, hard/mix/wipe transitions, layered graphics/logo (CG), and DeckLink/NDI/SRT/RTMP consumers built in. We orchestrate it over **AMCP** (its TCP control protocol) instead of reinventing a feeder. Trade: a new dependency + container image, and media must be on a CasparCG-visible disk (§4). + +--- + +## 1. Data Model + +New migration `029-playout.sql`. Five tables. + +### 1.1 `playout_channels` +A logical output. One channel → one engine instance → one output target. + +``` +id uuid pk +name text -- "Channel 1", "Pop-up SDI" +node_id uuid -> cluster_nodes(id) -- where the engine runs (null = primary) +output_type text -- 'decklink' | 'ndi' | 'srt' | 'rtmp' +output_config jsonb -- { device_index } | { ndi_name } | { url, latency } | { url, key } +video_format text -- '1080i5994' | '1080p5994' | '720p5994' ... +status text -- 'stopped' | 'starting' | 'running' | 'error' +container_id text -- running CasparCG sidecar +project_id uuid -> projects(id) -- RBAC scoping (nullable = admin-only) +created_at / updated_at +``` + +`output_type` + `output_config` map straight to a CasparCG consumer: +- `decklink` → `ADD DECKLINK ...` +- `ndi` → `ADD NDI ...` +- `srt`/`rtmp` → `ADD FFMPEG -f mpegts ...` (CasparCG 2.3+ ffmpeg consumer) + +### 1.2 `playout_playlists` +An ordered list of items bound to a channel. Phase A's primary object. + +``` +id, channel_id -> playout_channels(id) +name, loop boolean, created_at / updated_at +``` + +### 1.3 `playout_items` +One entry on a playlist OR one entry on the 24/7 timeline. + +``` +id +playlist_id uuid -> playout_playlists(id) -- Phase A +asset_id uuid -> assets(id) +sort_order int -- position in playlist (Phase A) +scheduled_at timestamptz -- wall-clock start (Phase B, null in A) +in_point numeric -- seconds, trim head (reuse subclip in/out from editor) +out_point numeric -- seconds, trim tail +transition text -- 'cut' | 'mix' | 'wipe' +transition_ms int +graphics jsonb -- optional CG/template overlay (Phase B+) +media_status text -- 'pending' | 'staging' | 'ready' | 'error' (see §4) +media_path text -- resolved path inside the CasparCG media volume +``` + +### 1.4 `playout_schedule` (Phase B) +Day-ahead, wall-clock-bound timeline rows. Same shape as `playout_items` but `scheduled_at` is authoritative and the scheduler tick (§5) drives transitions. Phase A can ignore this table. + +### 1.5 `playout_as_run` +Append-only log: what actually played, when, for how long. Compliance / billing. + +``` +id, channel_id, asset_id, item_id +started_at, ended_at, duration_s, result -- 'played' | 'skipped' | 'error' +``` + +--- + +## 2. Services & Components + +### 2.1 New sidecar: `services/playout/` (CasparCG wrapper) +A thin container: **CasparCG Server** + a small Node control shim exposing HTTP, the same way `capture` wraps ffmpeg. + +- Base image: official/community `casparcg/server` (Linux build with DeckLink + NDI + FFmpeg producers/consumers). +- Node shim (`src/index.js`): opens an AMCP TCP socket to local CasparCG, exposes: + - `POST /channel/start` → `ADD ` for the channel's output target + - `POST /play` → `PLAY - [transition]` + - `POST /loadbg` + `/play` → preview/cue then take (preview monitor) + - `POST /stop`, `GET /status` → `INFO ` (current clip, position, fps) + - playlist load → translate `playout_items` rows into a sequence of AMCP `LOADBG`/`PLAY` calls, advancing on `OnTransition` / end-of-clip events. +- Mirrors capture's status-polling contract so the UI monitor reuses existing plumbing. + +### 2.2 mam-api: `src/routes/playout.js` +CRUD + control, RBAC-scoped via the existing `assertProjectAccess` helper (channels carry `project_id`). + +``` +GET /playout/channels list (project-filtered) +POST /playout/channels create (edit on project) +POST /playout/channels/:id/start|stop spawn/kill CasparCG sidecar +GET /playout/channels/:id/status proxy engine INFO +POST /playout/channels/:id/play|pause|skip transport control +GET/POST/PUT/DELETE /playout/playlists... playlist + item CRUD, reorder +POST /playout/items/:id/stage kick S3→media-volume staging (§4) +GET /playout/channels/:id/asrun as-run log +``` + +Channel start/stop reuses `resolveNodeTarget()` + the Docker-socket / `node-agent /sidecar/start` split already in `recorders.js`. **Refactor opportunity:** lift that sidecar-spawn logic out of `recorders.js` into `src/orchestration/sidecar.js` so both recorders and playout share it (keep this small — only what both need). + +### 2.3 web-ui: `playout.html` + `public/playout.jsx` +New MCR page. Layout: + +``` +┌─ PREVIEW ───────────┬─ PROGRAM (on air) ──────┐ +│ [cued clip] │ [live output] ● ON AIR │ +│ TC / duration │ TC / remaining │ +│ [CUE] [TAKE] │ [PLAY][PAUSE][SKIP][STOP]│ +├─ MEDIA BIN ─────────┴──────────────────────────┤ +│ (draggable asset list, reuse asset browser) │ +├─ PLAYLIST / TIMELINE ──────────────────────────┤ +│ ▸ clip A ──▸ clip B ──▸ clip C (drag-drop) │ Phase A: ordered list +│ └ 24h time grid w/ now-bar │ Phase B: time-of-day grid +└────────────────────────────────────────────────┘ +``` + +- Drag-drop: reuse whatever the NLE editor timeline uses (check `editor.jsx`); assets drag from the bin into the playlist/grid. +- API via existing `ZAMPP_API.fetch` wrapper. +- Program monitor: HLS preview of the output — CasparCG can emit a second low-bitrate FFmpeg consumer to HLS, reusing the `/live/` HLS plumbing capture already uses. + +--- + +## 3. Channel placement & ports + +A DeckLink port is exclusive — same constraint capture already handles. A node's DeckLink port can be an **input (recorder)** or an **output (playout channel)**, never both at once. So: + +- Extend the capability/port-claim check: when starting a channel on `output_type=decklink`, verify the target node has that device index free (no active recorder, no active channel). +- NDI / SRT / RTMP outputs have no hardware contention → can stack many per node (GPU/CPU-bound only). +- Surface a unified "device map" (extend the existing cluster DeckLink-status endpoint) showing each port's role: idle / recording / playing-out. + +--- + +## 4. Media staging (the S3 ⇄ CasparCG gap) + +**The crux.** Assets live in S3 (`original_s3_key` / `proxy_s3_key`). CasparCG plays from a **local media folder**. Options: + +- **A — Pre-stage to a shared media volume (recommended).** Before a clip can go on air, download/symlink it from S3 to a CasparCG-visible volume (`/media`), set `playout_items.media_status='ready'` + `media_path`. A new BullMQ `playout-stage` job (reuses the worker pattern) does the pull. UI shows per-item readiness; TAKE is blocked until `ready`. Mirrors the growing-file SMB share already mounted for capture. +- **B — Stream from S3 via presigned URL.** CasparCG FFmpeg producer plays an HTTPS presigned URL directly. Zero staging, but seeking/trim and gapless transitions over network are fragile for broadcast. Acceptable as a fallback for SRT/RTMP, risky for SDI. + +**Decision:** Phase A uses **A** (stage proxies for preview, masters for air) with **B** available as a per-channel "low-latency / no-stage" toggle. Zac confirms the current masters play fine in CasparCG, so staging is a **plain S3→/media copy — no transcode-for-playout step**. (Validate on hardware during implementation, but the model does not assume a transcode stage.) + +--- + +## 5. Scheduling + +### Phase A — playlist player +No wall clock. Operator builds a `playout_playlists` row, drags items in, hits PLAY. The playout sidecar walks `playout_items` by `sort_order`, cueing the next clip during the current one (`LOADBG`) and taking it at end-of-clip with the configured transition. `loop` repeats. As-run logged per item. + +### Phase B — 24/7 continuous channel +Wall-clock timeline in `playout_schedule`. Reuse `src/scheduler.js`: +- Add a second tick (or extend the existing one) under the **same PG advisory lock pattern** — exactly-one-leader, so a multi-replica deploy doesn't double-fire. +- Tick responsibilities: stage upcoming items (look-ahead window), verify the on-air item matches the schedule, **fill gaps** (loop a filler/slate asset when the timeline has a hole — a channel must never go black), roll the day forward. +- As-run becomes the compliance record. + +--- + +## 6. Phasing / Milestones + +**Phase A — Playlist playout MVP** +1. Migration `029-playout.sql` (channels, playlists, items, as-run). +2. `services/playout/` sidecar: CasparCG image + AMCP control shim, single output target (start with **SRT or NDI** — no hardware needed for dev; DeckLink behind hardware check). +3. mam-api `routes/playout.js` — channel + playlist CRUD, start/stop, transport, RBAC. +4. `playout-stage` BullMQ job (S3 → /media). +5. web-ui `playout.html` — bin + drag-drop ordered playlist + program/preview monitors + transport. +6. DeckLink output on real hardware; port-contention check vs recorders. + +**Phase B — 24/7 continuous channel** +7. `playout_schedule` + time-of-day grid UI. +8. Scheduler tick (advisory-locked) — look-ahead staging, gap-fill/slate, day-roll. +9. As-run reporting view. +10. Graphics/CG overlay (logo bug, lower-thirds) via CasparCG templates. + +--- + +## 7. Open Questions (for review) + +**Resolved (2026-05-30):** +- ~~CasparCG packaging~~ → **build our own image.** Fetch DeckLink + NDI SDKs at build time (not redistributable — same as capture's DeckLink build). GL context for the mixer comes from GPU passthrough on a real node, or **Xvfb** (virtual framebuffer) where there's no display — community images run `--privileged` + X11 socket. Pin the NDI SDK version to what the server expects (`.so` version mismatch is the common docker failure). +- ~~Master codec playability~~ → Zac confirms masters **play fine**; no transcode-for-playout. Staging = plain S3→/media copy. +- ~~Management GUI~~ → **single Dragonflight `playout.html`** drives everything via AMCP; operator never touches CasparCG. +- ~~Audio loudness~~ → **pre-normalize at stage time** (Zac, 2026-05-30). `playout-stage` job runs ffmpeg `loudnorm` (EBU R128, target −23 LUFS, true-peak −1 dBTP) once, on the S3→/media copy. Output is the cached version CasparCG plays. Staging is no longer a pure copy — staging cost ≈ realtime CPU per clip on first stage; results are reusable across channels. Override (`media_status='ready'` + raw copy) available for clips already mastered to spec. +- ~~Frame rate~~ → **`1080p5994`** default for new channels (Zac, 2026-05-30). Progressive 1080 @ 59.94 fps. Per-channel override allowed (`video_format` column). Streaming-friendly (SRT/RTMP/NDI) and current SDI gear accepts it; matches capture's 59.94 cadence. +- ~~Preview latency~~ → **HLS v1** (Zac, 2026-05-30). Reuse capture's `/live/` HLS plumbing. CasparCG emits a second low-bitrate FFmpeg consumer to HLS. ~4–6s lag, fine for confidence monitor. Operator desk gets a real downstream monitor off the SDI/NDI output anyway. Revisit WebRTC if MCR operators complain. +- ~~Failover~~ → **auto-restart on healthy node** (Zac, 2026-05-30). Scheduler tick (§5) monitors `playout_sidecars` health (AMCP ping + container alive); on N missed checks marks the channel `error`, re-places it on another capability-matching node with a free output port, resumes the playlist from the next item after the as-run-logged on-air item. Gap = black/slate for ~5–30 s during respawn (operator sees a flag in the UI). **DeckLink channels are not auto-failed-over in v1** — device-index pinning makes the destination port non-trivial; v1 alerts and lets the operator move the channel. NDI/SRT/RTMP channels (no hardware contention) failover automatically. Tracked via `restart_count` + `last_restart_at` on `playout_channels`. + +**Still open:** +- (none — all §7 questions resolved 2026-05-30) + +--- + +## 8. Reused building blocks (already in the repo) + +| Need | Existing piece | +|------|----------------| +| Spawn engine container local/remote | `recorders.js` Docker-socket + `node-agent /sidecar/start` | +| Node capability / port model | `cluster_nodes.capabilities`, cluster DeckLink-status endpoint | +| Single-leader scheduled transitions | `src/scheduler.js` + PG advisory lock | +| Background media jobs | BullMQ worker (`services/worker`) | +| RBAC scoping | `src/auth/authz.js` `assertProjectAccess` (channel/project_id) | +| HLS preview plumbing | capture's `/live/` HLS output | +| Subclip in/out points | NLE editor in/out marking | +| API wrapper / SPA shell | `ZAMPP_API.fetch`, esbuild JSX pages | diff --git a/docs/superpowers/specs/2026-05-31-storage-settings-growing-smb-design.md b/docs/superpowers/specs/2026-05-31-storage-settings-growing-smb-design.md new file mode 100644 index 0000000..863aa9c --- /dev/null +++ b/docs/superpowers/specs/2026-05-31-storage-settings-growing-smb-design.md @@ -0,0 +1,148 @@ +# Storage Settings Warning + Growing-Files SMB Auth + Per-Recorder Growing Mode +**Date:** 2026-05-31 +**Branch:** `feat/playout-mcr` (Forgejo: WildDragonLLC/dragonflight) +**Status:** Approved, ready for implementation plan + +--- + +## Scope + +Three related refinements to the Settings page and growing-files capture pipeline: + +1. **Storage warning header** — a prominent set-once warning at the top of the Storage settings section. +2. **Growing-files SMB credentials + system CIFS mount** — store an SMB username/password and have the capture stack mount the growing share itself (Approach A). +3. **Per-recorder growing mode** — remove the global "capture writes to local SMB share first" toggle; make growing-files mode a per-recorder setting. + +All changes live on the `growing-files` / storage-settings path. No playout changes (handled separately). + +--- + +## Background (current state) + +- **Settings storage:** single key/value `settings(key TEXT PRIMARY KEY, value TEXT, updated_at)` table (migration 006). Secrets like `s3_secret_key` are stored but `GET /settings/s3` returns only `s3_secret_key_exists` (never the value). +- **Growing settings UI:** `GrowingSettingsCard` in `services/web-ui/public/screens-admin.jsx` (rendered by `StorageSection` alongside `MountHealthStrip` and `S3SettingsCard`). Current keys: `growing_enabled`, `growing_path`, `growing_smb_url`, `growing_promote_after_seconds`. +- **Settings API:** `services/mam-api/src/routes/settings.js` — `GET/PUT /settings/growing` over `GROWING_KEYS`. +- **Global enable today:** the `growing_enabled` setting (checkbox labelled "Capture writes to the local SMB share first; Premier can edit while it's still growing"). `recorders.js` reads this global key at recorder-start and passes `GROWING_ENABLED=true/false` to the capture container. +- **Capture write path:** `services/capture/src/capture-manager.js` reads `process.env.GROWING_ENABLED` and `GROWING_PATH` (default `/growing`). When on, it writes the master to `/growing/{projectId}/{clipName}.{ext}` instead of streaming to S3; the promotion worker uploads to S3 after stop. +- **Current mount model:** `/growing` is a pre-mounted host bind-mount; the app never authenticates to SMB. +- **Per-recorder column already exists:** migration 014 added `recorders.growing_enabled BOOLEAN DEFAULT NULL` ("NULL = use global"), but recorder-start logic ignores it and the new-recorder modal does not expose it. + +--- + +## Part 1 — Storage warning header + +Add a danger-styled banner at the **top of `StorageSection()`**, above `MountHealthStrip`. + +- Visual: full-width banner, danger token styling (`--danger` border + subtle danger background), alert icon, bold uppercase text. +- Exact copy: + > **⚠ WARNING — THESE SETTINGS ARE MEANT TO BE SET ONCE AT INITIAL DEPLOYMENT. CHANGING STORAGE PATHS MID-CYCLE CAN CAUSE DATABASE CORRUPTION AND FILE LOSS. PLEASE USE WITH CAUTION.** +- Pure presentational; no backend, no dismiss state (always visible). + +**Files:** `services/web-ui/public/screens-admin.jsx` (and a small style rule in the appropriate CSS file if needed). + +--- + +## Part 2 — Growing-files SMB credentials + system CIFS mount (Approach A) + +The growing share is **shared infrastructure**, so the SMB connection config is global. + +### New settings keys +| Key | Purpose | Notes | +|-----|---------|-------| +| `growing_smb_mount` | CIFS source for the system mount, e.g. `//10.0.0.25/mam-growing` | Distinct from `growing_smb_url` | +| `growing_smb_username` | SMB user | Returned in GET (not secret) | +| `growing_smb_password` | SMB password | **Write-only** — never returned | +| `growing_smb_vers` *(optional)* | CIFS protocol version, default `3.0` | Avoids mount negotiation failures | + +`growing_smb_url` (the `smb://…` string) is retained unchanged as the **editor-facing** display value (Premiere connect string). + +### Settings API (`settings.js`) +- Extend `GROWING_KEYS` with the new keys (except the password is handled specially). +- `GET /settings/growing`: return `growing_smb_mount`, `growing_smb_username`, `growing_smb_vers`, and `growing_smb_password_exists: boolean` — **never** the password value. (Mirror the existing `s3_secret_key_exists` pattern.) +- `PUT /settings/growing`: upsert each provided key. For `growing_smb_password`, only write it when a non-empty value is provided (an empty/omitted field leaves the stored password unchanged). Provide a way to clear it (explicit empty sentinel or a "clear" affordance) — see Resolved decisions below. + +### Settings UI (`GrowingSettingsCard`) +Add three fields to the card: +- **SMB mount (CIFS):** text input bound to `growing_smb_mount`, placeholder `//10.0.0.25/mam-growing`. +- **SMB username:** text input bound to `growing_smb_username`. +- **SMB password:** masked password input. Shows a "saved" indicator when `growing_smb_password_exists` is true; typing a new value replaces it; leaving it blank keeps the existing one. `autoComplete="new-password"`. + +### Capture image (`services/capture/Dockerfile`) +Add `cifs-utils` to the installed packages so `mount -t cifs` is available inside the capture container. + +### Capture-manager (`capture-manager.js`) +On capture start, when growing mode is active **and** `GROWING_SMB_MOUNT` is set: +1. Write a root-only credentials file (e.g. `/run/smb-creds`, mode `0600`) containing: + ``` + username= + password= + ``` + (Credentials go in the file, **not** the mount command line, to avoid `ps`/log exposure.) +2. `mkdir -p $GROWING_PATH` then `mount -t cifs $GROWING_SMB_MOUNT $GROWING_PATH -o credentials=/run/smb-creds,uid=0,gid=0,file_mode=0664,dir_mode=0775,vers=$GROWING_SMB_VERS`. +3. If the mount succeeds → proceed writing the master to `$GROWING_PATH/...` (existing behaviour). +4. If the mount **fails** → log the error and fall back to S3 streaming (`growingPath = null`), so a recording is never lost. +5. On capture stop/cleanup, unmount `$GROWING_PATH` (best-effort; ignore "not mounted"). + +Mount isolation: each recorder runs in its **own** capture container, so each container mounts CIFS at its own private `/growing` — no cross-recorder mount conflicts, no ref-counting needed. + +### Recorder start (`recorders.js`) +- Pass new env to the spawned capture container: `GROWING_SMB_MOUNT`, `GROWING_SMB_USERNAME`, `GROWING_SMB_PASSWORD`, `GROWING_SMB_VERS` (read from the `settings` table at start). +- The dynamically-spawned capture container must get `/growing` as an **empty mountpoint** (not a host bind-mount) so the in-container CIFS mount lands cleanly. Confirm/adjust the container spec accordingly. The container is already privileged (required for `mount`). + +### Security notes +- The password is stored plaintext in the `settings` table, identical to the existing `s3_secret_key` handling — acceptable within this app's current secret model. +- The password reaches the capture container as an env var (visible via `docker inspect`), same as S3 keys already are. The credentials **file** (not the command line) is used for the actual mount. + +--- + +## Part 3 — Per-recorder growing mode (remove the global toggle) + +### Remove global enable +- Delete the global "Capture writes to the local SMB share first…" checkbox (`growing_enabled` key) from `GrowingSettingsCard`. The card no longer carries a global on/off — it is **infrastructure-only**: container mount path, SMB URL (editor), SMB mount + credentials, promote threshold. +- The `growing_enabled` settings *key* is retired from the UI. (It may remain in the table harmlessly; recorder-start no longer reads it.) + +### Per-recorder semantics +- Reuse the existing `recorders.growing_enabled BOOLEAN` column. New semantics (no global to defer to): `TRUE` = this recorder uses growing-files mode; `NULL`/`FALSE` = off. +- `recorders.js` recorder-start: read the **recorder's own** `growing_enabled` (defaulting `NULL`→off) and set `GROWING_ENABLED` for the capture container from that, instead of the global setting. +- Add `growing_enabled` to `RECORDER_FIELDS` so create/update accept it. + +### UI +- **New-recorder modal** (`modal-new-recorder.jsx`): add a "Growing-files mode" toggle that sets `growing_enabled` on the created recorder (default off). +- **Recorder edit** (wherever recorders are edited): same toggle. +- Helper text on the toggle notes that growing-files requires the SMB share to be configured in Settings → Storage. + +### Fallback +If a recorder has `growing_enabled = true` but `growing_smb_mount` is not configured globally, capture logs a warning and falls back to S3 streaming (same fallback path as a failed mount). Recording is never blocked. + +--- + +## Files changed + +| File | Change | +|------|--------| +| `services/web-ui/public/screens-admin.jsx` | Storage warning banner; SMB mount/username/password fields in `GrowingSettingsCard`; remove global growing-enable checkbox | +| `services/web-ui/public/modal-new-recorder.jsx` | Per-recorder "Growing-files mode" toggle | +| `services/mam-api/src/routes/settings.js` | New growing SMB keys; write-only password (`growing_smb_password_exists`) | +| `services/mam-api/src/routes/recorders.js` | Read per-recorder `growing_enabled`; pass SMB env to capture; `RECORDER_FIELDS` += `growing_enabled`; empty `/growing` mountpoint | +| `services/capture/Dockerfile` | Add `cifs-utils` | +| `services/capture/src/capture-manager.js` | CIFS mount-on-start (creds file), unmount-on-stop, fallback to S3 on failure | +| CSS (storage warning / fields) | Minor styles if needed | + +No DB migration required (the `recorders.growing_enabled` column already exists; new settings are key/value rows). + +--- + +## Resolved decisions + +- **Clearing the SMB password:** `PUT /settings/growing` treats a field value of the literal sentinel `""` with an explicit `growing_smb_password_clear: true` flag as "remove the stored password"; a blank field with no clear flag leaves it unchanged. (Keeps the common "don't retype the password on every save" UX while still allowing removal.) +- **CIFS version:** default `growing_smb_vers = 3.0`; overridable via settings to support older NAS targets. +- **Recorders already recording when the toggle changes:** the per-recorder `growing_enabled` is read at **start** only; changing it mid-recording has no effect on the active session (consistent with how all recorder encode settings already behave). + +--- + +## Out of scope (deferred) + +- Encrypting secrets at rest (the app's existing model stores `s3_secret_key` in plaintext; SMB password follows the same model). +- A global "growing-files master kill switch" (removed by design — control is now per-recorder). +- Exposing `growing_retention_days` in the UI (seeded in DB, still unsurfaced; unrelated to this work). +- Playout HLS preview fix (handled by a separate parallel effort). diff --git a/sdk/README.md b/sdk/README.md new file mode 100644 index 0000000..af70c59 --- /dev/null +++ b/sdk/README.md @@ -0,0 +1,42 @@ +# Capture-card SDK / driver file store + +This directory holds the **proprietary, non-redistributable** vendor SDKs and +drivers used to enable SDI / NDI capture cards on cluster nodes. + +> **INTERNAL ONLY.** These files are licensed by their respective vendors and +> must **not** be published, redistributed, or committed to any public mirror. +> This repository is private. Do not change that. + +## Why these live in the repo + +The cluster admin screen lets an operator install/update capture-card drivers on +a node from the web UI (no SSH). The node-agent spawns a one-shot privileged +container that bind-mounts this repository and runs +[`deploy/install-driver.sh `](../deploy/install-driver.sh), which reads +the vendor files from `sdk//`. Because the install must work offline on +an isolated broadcast LAN, the binaries ship in-repo rather than being fetched at +install time. + +## Layout + +``` +sdk/ + README.md ← this file + blackmagic/ ← Blackmagic Desktop Video (DeckLink) .deb + aja/ ← AJA ntv2 driver source / installer + deltacast/ ← Deltacast VideoMaster installer + ndi/ ← NDI redistributable runtime libs +``` + +Each vendor directory has its own `README.md` listing **exactly** which files an +admin must drop in. A `.gitkeep` keeps the empty directory committed. + +## Important + +- **No binaries are committed by default.** The directory structure + READMEs + are the deliverable. An admin downloads the proprietary files from the vendor + (per their licence) and drops them in the matching `sdk//` directory. +- The install script **fails gracefully** with a clear message if the expected + file is absent — it never fabricates or downloads binaries. +- Target host OS for all install paths is **Ubuntu 22.04 LTS (jammy), x86_64**, + matching the cluster worker nodes. diff --git a/sdk/aja/.gitkeep b/sdk/aja/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/sdk/aja/README.md b/sdk/aja/README.md new file mode 100644 index 0000000..dac93d1 --- /dev/null +++ b/sdk/aja/README.md @@ -0,0 +1,31 @@ +# AJA NTV2 driver + +Drop the **AJA NTV2** driver source/SDK archive for Linux into this directory. + +## Required file + +| File | Notes | +|------|-------| +| `ntv2sdk*linux*.zip` **or** `libajantv2*.tar.gz` | The NTV2 SDK / open-source `libajantv2` source tree containing `driver/linux/` with the kernel-module `Makefile` and `load_ajantv2` / `unload_ajantv2` scripts. | + +Example names: `ntv2sdklinux_17.0.1.zip`, `libajantv2-17.0.1.tar.gz` + +The installer reads the **newest** matching archive. + +## Where to get it + +AJA → Support → Software & firmware → *NTV2 SDK* (Linux), or the public +`aja-video/libajantv2` source release. Download the Linux SDK zip / source +tarball and copy it here unmodified. + +## What the install script does + +1. Ensures `linux-headers-$(uname -r)`, `build-essential` are present. +2. Extracts the archive into a scratch build dir. +3. Builds the `ajantv2` kernel module from `driver/linux` (`make`). +4. Installs the module under `/lib/modules/$(uname -r)/extra`, runs `depmod`, + `modprobe ajantv2` (falls back to the SDK's `load_ajantv2` script). +5. Verifies the `ajantv2` module is loaded. + +A **reboot is not normally required**; the module loads immediately after build. +The script reports if a reboot is needed (e.g. an old in-tree module is wedged). diff --git a/sdk/blackmagic/.gitkeep b/sdk/blackmagic/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/sdk/blackmagic/README.md b/sdk/blackmagic/README.md new file mode 100644 index 0000000..eafc5aa --- /dev/null +++ b/sdk/blackmagic/README.md @@ -0,0 +1,35 @@ +# Blackmagic Desktop Video (DeckLink) driver + +Drop the **Blackmagic Desktop Video** Debian package for **Ubuntu 22.04 (x86_64)** +into this directory. + +## Required file + +| File | Notes | +|------|-------| +| `desktopvideo_*_amd64.deb` | The `desktopvideo` package from the Desktop Video installer archive. Provides the `blackmagic` kernel module (built via DKMS) and the `DesktopVideoHelper` daemon. | + +Example name: `desktopvideo_14.4.1a4_amd64.deb` + +The installer reads the **newest** matching `desktopvideo_*_amd64.deb` if more +than one is present. + +## Where to get it + +Blackmagic Design → Support → *Desktop Video* (Linux). Download the +"Desktop Video x.y.z Linux" tarball, extract it, and copy the +`deb//desktopvideo_*_amd64.deb` file here. + +> Optional: `desktopvideo-gui_*_amd64.deb` is **not** required for headless +> capture and is not installed. + +## What the install script does + +1. Ensures `linux-headers-$(uname -r)` is present (needed for the DKMS build). +2. `apt-get install -y ./desktopvideo_*_amd64.deb` (pulls DKMS deps). +3. Triggers the DKMS build, `depmod`, `modprobe blackmagic`. +4. Restarts the `DesktopVideoHelper` daemon. +5. Verifies `/dev/blackmagic` appears. + +A **reboot is usually not required** but a DKMS rebuild against a freshly +installed kernel may need one — the script reports this. diff --git a/sdk/deltacast/.gitkeep b/sdk/deltacast/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/sdk/deltacast/README.md b/sdk/deltacast/README.md new file mode 100644 index 0000000..ec81c6a --- /dev/null +++ b/sdk/deltacast/README.md @@ -0,0 +1,31 @@ +# Deltacast VideoMaster driver / SDK + +Drop the **Deltacast VideoMaster** Linux installer into this directory. + +## Required file + +| File | Notes | +|------|-------| +| `VideoMaster*.run` **or** `VideoMaster*linux*.tar.gz` | The VideoMaster SDK + driver installer for Linux. Contains the `videomasterhd` kernel module sources and the `install.sh` driver installer. | + +Example names: `VideoMaster-6.25.0.run`, `VideoMaster_6_25_Linux.tar.gz` + +The installer reads the **newest** matching file. + +## Where to get it + +Deltacast → Products → *SDK* (). Request +the VideoMaster Linux package (licence-gated) and copy the `.run` self-extractor +or the `.tar.gz` here unmodified. + +## What the install script does + +1. Ensures `linux-headers-$(uname -r)`, `build-essential`, `dkms` are present. +2. Runs the vendor installer: + - `.run` → executed with `--noexec --target ` then its `install.sh`, + - `.tar.gz` → extracted, then its bundled `install.sh` is run. +3. Loads the Deltacast module (`modprobe videomasterhd` / vendor load script). +4. Verifies a `/dev/deltacast*` device node appears. + +A **reboot may be required** after a first-time VideoMaster install (udev rules ++ firmware). The script reports this explicitly. diff --git a/sdk/ndi/.gitkeep b/sdk/ndi/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/sdk/ndi/README.md b/sdk/ndi/README.md new file mode 100644 index 0000000..4907199 --- /dev/null +++ b/sdk/ndi/README.md @@ -0,0 +1,35 @@ +# NDI redistributable runtime + +Drop the **NDI runtime redistributable** shared libraries into this directory. +NDI has **no kernel module** — it is purely user-space shared libraries, so this +is the lowest-risk install (no DKMS, no reboot). + +## Required files + +| File | Notes | +|------|-------| +| `libndi.so.*` | The versioned NDI runtime shared object, e.g. `libndi.so.6`. **Required.** | +| `libndi.so` *(optional)* | Dev symlink. The installer recreates it if absent. | + +You may instead drop the whole **NDI SDK / Advanced SDK** `lib/x86_64-linux-gnu/` +directory contents here; the installer copies every `libndi*.so*` it finds. + +Example name: `libndi.so.6.1.1` + +## Where to get it + +NDI → Tools / SDK download (NDI 6 SDK or NDI Advanced SDK for Linux). The +runtime libs live under `lib/x86_64-linux-gnu/` in the SDK. Per the NDI licence +the runtime is redistributable **within your own product** only — keep it in this +private repo, do not publish it. + +## What the install script does + +1. Copies every `libndi*.so*` from here into `/opt/ndi-lib`. +2. Writes `/etc/ld.so.conf.d/ndi.conf` pointing at `/opt/ndi-lib` and runs + `ldconfig`. +3. Recreates the `libndi.so` → `libndi.so.` dev symlink if missing. +4. Verifies `ldconfig -p | grep libndi` resolves. + +**No reboot required.** Running processes that already loaded an old `libndi` +must be restarted to pick up the new version — the script notes this. diff --git a/services/capture/Dockerfile b/services/capture/Dockerfile index 399ff14..1730c6c 100644 --- a/services/capture/Dockerfile +++ b/services/capture/Dockerfile @@ -81,13 +81,46 @@ RUN ./configure \ RUN /usr/local/bin/ffmpeg -hide_banner -encoders 2>&1 | grep -E 'nvenc' \ || (echo 'FATAL: nvenc encoders missing from ffmpeg build' && exit 1) +# ── Stage 1b: Build bmx (raw2bmx / bmxtranswrap) from source ───────────────── +# bmx (bmxlib + libMXF + libMXF++) is the reference GROWING OP1a MXF writer. It +# writes a fresh IndexTableSegment (with an updated IndexDuration) into a new +# body partition at a periodic interval, so the recorded duration is readable — +# and INCREASES — from the header+index alone while the file is still being +# written (no footer needed). This is what makes the master a TRUE Premiere +# growing file. ffmpeg's MXF muxer cannot do this (its real duration/index lands +# only in the footer at av_write_trailer, so duration probes N/A until close). +# +# Debian/Ubuntu have no `bmxlib-tools` package (verified absent in bookworm), so +# we build from the BBC source. liburiparser/uuid/lzma/zlib/expat are the build +# deps; the runtime needs only libexpat1 + liburiparser1 + libuuid1 (added in +# the runtime stage below). Pinned to the bbc/bmx default branch (v1.6.x). +FROM debian:bookworm AS bmx-builder +RUN apt-get update && apt-get install -y --no-install-recommends \ + build-essential cmake git ca-certificates pkg-config \ + liburiparser-dev uuid-dev liblzma-dev zlib1g-dev libexpat1-dev \ + && rm -rf /var/lib/apt/lists/* +# Pin to a release tag so the produced soname (libMXF.so.1.6 etc.) stays stable +# for the COPY in the runtime stage. v1.6 is the BBC bmx series verified here. +RUN git clone --recursive --branch v1.6 https://github.com/bbc/bmx.git /bmx \ + || git clone --recursive https://github.com/bbc/bmx.git /bmx +WORKDIR /bmx/build +RUN cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr/local .. \ + && make -j"$(nproc)" && make install && ldconfig +# Sanity-check: raw2bmx must run, otherwise the growing-MXF pipeline is broken. +RUN /usr/local/bin/raw2bmx -h >/dev/null 2>&1 && echo 'raw2bmx OK' + # ── Stage 2: Runtime image ─────────────────────────────────────────────────── FROM node:20-bookworm -# Runtime deps for compiled ffmpeg libs +# Runtime deps for compiled ffmpeg libs. +# cifs-utils provides mount.cifs so growing-files capture can mount the SMB +# landing-zone share inside the (privileged) container at start (Approach A). +# util-linux supplies mount/umount/mountpoint. RUN apt-get update && apt-get install -y --no-install-recommends \ libx264-164 libx265-199 libvpx7 libopus0 libmp3lame0 \ libsrt1.5-openssl libzmq5 libstdc++6 libc++1 libc++abi1 \ + cifs-utils util-linux \ + libexpat1 liburiparser1 libuuid1 \ && rm -rf /var/lib/apt/lists/* # Copy compiled ffmpeg/ffprobe @@ -98,7 +131,23 @@ COPY --from=ffmpeg-builder /usr/local/lib/ /usr/local/lib/ # DeckLink runtime .so COPY lib/libDeckLinkAPI.so /usr/lib/libDeckLinkAPI.so COPY lib/libDeckLinkPreviewAPI.so /usr/lib/libDeckLinkPreviewAPI.so -RUN ldconfig + +# bmx (raw2bmx / bmxtranswrap / mxf2raw) — the growing OP1a MXF writer used for +# the edit-while-record master. Copy the built binaries + shared libs; runtime +# deps (libexpat1/liburiparser1/libuuid1) were installed above. +COPY --from=bmx-builder /usr/local/bin/raw2bmx /usr/local/bin/raw2bmx +COPY --from=bmx-builder /usr/local/bin/bmxtranswrap /usr/local/bin/bmxtranswrap +COPY --from=bmx-builder /usr/local/bin/mxf2raw /usr/local/bin/mxf2raw +COPY --from=bmx-builder /usr/local/lib/libMXF.so.1.6 /usr/local/lib/ +COPY --from=bmx-builder /usr/local/lib/libMXF++.so.1.6 /usr/local/lib/ +COPY --from=bmx-builder /usr/local/lib/libbmx.so.1.6 /usr/local/lib/ +RUN cd /usr/local/lib \ + && ln -sf libMXF.so.1.6 libMXF.so.1 && ln -sf libMXF.so.1 libMXF.so \ + && ln -sf libMXF++.so.1.6 libMXF++.so.1 && ln -sf libMXF++.so.1 libMXF++.so \ + && ln -sf libbmx.so.1.6 libbmx.so.1 && ln -sf libbmx.so.1 libbmx.so \ + && ldconfig +# Verify raw2bmx resolves its libs and runs in the final image. +RUN raw2bmx -h >/dev/null 2>&1 && echo 'raw2bmx runtime OK' # Deltacast bridge binary + SDK runtime libs COPY --from=bridge-builder /bridge/build/deltacast-capture /usr/local/bin/deltacast-capture diff --git a/services/capture/sdk/DeckLinkAPI.h b/services/capture/sdk/DeckLinkAPI.h new file mode 100644 index 0000000..39068ad --- /dev/null +++ b/services/capture/sdk/DeckLinkAPI.h @@ -0,0 +1,1692 @@ +/* -LICENSE-START- + ** Copyright (c) 2026 Blackmagic Design + ** + ** Permission is hereby granted, free of charge, to any person or organization + ** obtaining a copy of the software and accompanying documentation (the + ** "Software") to use, reproduce, display, distribute, sub-license, execute, + ** and transmit the Software, and to prepare derivative works of the Software, + ** and to permit third-parties to whom the Software is furnished to do so, in + ** accordance with: + ** + ** (1) if the Software is obtained from Blackmagic Design, the End User License + ** Agreement for the Software Development Kit ("EULA") available at + ** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or + ** + ** (2) if the Software is obtained from any third party, such licensing terms + ** as notified by that third party, + ** + ** and all subject to the following: + ** + ** (3) the copyright notices in the Software and this entire statement, + ** including the above license grant, this restriction and the following + ** disclaimer, must be included in all copies of the Software, in whole or in + ** part, and all derivative works of the Software, unless such copies or + ** derivative works are solely in the form of machine-executable object code + ** generated by a source language processor. + ** + ** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS + ** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + ** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT + ** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE + ** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, + ** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + ** DEALINGS IN THE SOFTWARE. + ** + ** A copy of the Software is available free of charge at + ** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. + ** + ** -LICENSE-END- + */ + + +/* + * -- AUTOMATICALLY GENERATED - DO NOT EDIT --- + */ + +#ifndef BMD_DECKLINKAPI_H +#define BMD_DECKLINKAPI_H + + +#ifndef BMD_CONST + #if defined(_MSC_VER) + #define BMD_CONST __declspec(selectany) static const + #else + #define BMD_CONST static const + #endif +#endif + +#ifndef BMD_PUBLIC + #define BMD_PUBLIC +#endif + +/* DeckLink API */ + +#include +#include "LinuxCOM.h" + +#include "DeckLinkAPITypes.h" +#include "DeckLinkAPIModes.h" +#include "DeckLinkAPIDiscovery.h" +#include "DeckLinkAPIConfiguration.h" +#include "DeckLinkAPIDeckControl.h" + +#define BLACKMAGIC_DECKLINK_API_MAGIC 1 + +// Type Declarations + + +// Interface ID Declarations + +BMD_CONST REFIID IID_IDeckLinkVideoOutputCallback = /* 5BE6DF26-02CE-433E-99D9-9A87C3AC171F */ { 0x5B,0xE6,0xDF,0x26,0x02,0xCE,0x43,0x3E,0x99,0xD9,0x9A,0x87,0xC3,0xAC,0x17,0x1F }; +BMD_CONST REFIID IID_IDeckLinkInputCallback = /* 3A94F075-C37D-4BA8-BCC0-1D778C8F881B */ { 0x3A,0x94,0xF0,0x75,0xC3,0x7D,0x4B,0xA8,0xBC,0xC0,0x1D,0x77,0x8C,0x8F,0x88,0x1B }; +BMD_CONST REFIID IID_IDeckLinkEncoderInputCallback = /* ACF13E61-F4A0-4974-A6A7-59AFF6268B31 */ { 0xAC,0xF1,0x3E,0x61,0xF4,0xA0,0x49,0x74,0xA6,0xA7,0x59,0xAF,0xF6,0x26,0x8B,0x31 }; +BMD_CONST REFIID IID_IDeckLinkVideoBufferAllocator = /* F35DFA8D-9078-4622-95BB-56894054EB0F */ { 0xF3,0x5D,0xFA,0x8D,0x90,0x78,0x46,0x22,0x95,0xBB,0x56,0x89,0x40,0x54,0xEB,0x0F }; +BMD_CONST REFIID IID_IDeckLinkVideoBufferAllocatorProvider = /* 6DF6F20A-D8DF-45D2-8914-383CE7E6243F */ { 0x6D,0xF6,0xF2,0x0A,0xD8,0xDF,0x45,0xD2,0x89,0x14,0x38,0x3C,0xE7,0xE6,0x24,0x3F }; +BMD_CONST REFIID IID_IDeckLinkAudioOutputCallback = /* 403C681B-7F46-4A12-B993-2BB127084EE6 */ { 0x40,0x3C,0x68,0x1B,0x7F,0x46,0x4A,0x12,0xB9,0x93,0x2B,0xB1,0x27,0x08,0x4E,0xE6 }; +BMD_CONST REFIID IID_IDeckLinkIterator = /* 50FB36CD-3063-4B73-BDBB-958087F2D8BA */ { 0x50,0xFB,0x36,0xCD,0x30,0x63,0x4B,0x73,0xBD,0xBB,0x95,0x80,0x87,0xF2,0xD8,0xBA }; +BMD_CONST REFIID IID_IDeckLinkAPIInformation = /* 7BEA3C68-730D-4322-AF34-8A7152B532A4 */ { 0x7B,0xEA,0x3C,0x68,0x73,0x0D,0x43,0x22,0xAF,0x34,0x8A,0x71,0x52,0xB5,0x32,0xA4 }; +BMD_CONST REFIID IID_IDeckLinkIPFlowAttributes = /* CDA938DA-6479-40C6-B2EC-A3579B3AEECD */ { 0xCD,0xA9,0x38,0xDA,0x64,0x79,0x40,0xC6,0xB2,0xEC,0xA3,0x57,0x9B,0x3A,0xEE,0xCD }; +BMD_CONST REFIID IID_IDeckLinkIPFlowStatus = /* 31C41656-4992-4396-BBE9-5F8406AAB5AF */ { 0x31,0xC4,0x16,0x56,0x49,0x92,0x43,0x96,0xBB,0xE9,0x5F,0x84,0x06,0xAA,0xB5,0xAF }; +BMD_CONST REFIID IID_IDeckLinkIPFlowSetting = /* 86DD9174-27D3-4032-B2AD-6067C3BB2424 */ { 0x86,0xDD,0x91,0x74,0x27,0xD3,0x40,0x32,0xB2,0xAD,0x60,0x67,0xC3,0xBB,0x24,0x24 }; +BMD_CONST REFIID IID_IDeckLinkIPFlow = /* C5FC83C7-5B8E-42A7-9A40-7C065955D4E1 */ { 0xC5,0xFC,0x83,0xC7,0x5B,0x8E,0x42,0xA7,0x9A,0x40,0x7C,0x06,0x59,0x55,0xD4,0xE1 }; +BMD_CONST REFIID IID_IDeckLinkIPFlowIterator = /* BD296AB2-A5C5-4153-888F-AAB1FDBD8A5C */ { 0xBD,0x29,0x6A,0xB2,0xA5,0xC5,0x41,0x53,0x88,0x8F,0xAA,0xB1,0xFD,0xBD,0x8A,0x5C }; +BMD_CONST REFIID IID_IDeckLinkOutput = /* 5F227C95-39D7-46C7-8B7D-9C81795FBBE4 */ { 0x5F,0x22,0x7C,0x95,0x39,0xD7,0x46,0xC7,0x8B,0x7D,0x9C,0x81,0x79,0x5F,0xBB,0xE4 }; +BMD_CONST REFIID IID_IDeckLinkInput = /* 6A515F8A-FBCE-4853-B0F7-2A09DB1ECA0B */ { 0x6A,0x51,0x5F,0x8A,0xFB,0xCE,0x48,0x53,0xB0,0xF7,0x2A,0x09,0xDB,0x1E,0xCA,0x0B }; +BMD_CONST REFIID IID_IDeckLinkIPExtensions = /* 46CF7903-A9FD-4D0B-8FFC-0103722AB442 */ { 0x46,0xCF,0x79,0x03,0xA9,0xFD,0x4D,0x0B,0x8F,0xFC,0x01,0x03,0x72,0x2A,0xB4,0x42 }; +BMD_CONST REFIID IID_IDeckLinkHDMIInputEDID = /* ABBBACBC-45BC-4665-9D92-ACE6E5A97902 */ { 0xAB,0xBB,0xAC,0xBC,0x45,0xBC,0x46,0x65,0x9D,0x92,0xAC,0xE6,0xE5,0xA9,0x79,0x02 }; +BMD_CONST REFIID IID_IDeckLinkEncoderInput = /* 46C1332E-6FD9-472A-8591-FE59C22192E1 */ { 0x46,0xC1,0x33,0x2E,0x6F,0xD9,0x47,0x2A,0x85,0x91,0xFE,0x59,0xC2,0x21,0x92,0xE1 }; +BMD_CONST REFIID IID_IDeckLinkVideoBuffer = /* 81F03D70-DE13-4B17-873A-C8AC9689C682 */ { 0x81,0xF0,0x3D,0x70,0xDE,0x13,0x4B,0x17,0x87,0x3A,0xC8,0xAC,0x96,0x89,0xC6,0x82 }; +BMD_CONST REFIID IID_IDeckLinkVideoFrame = /* 6502091C-615F-4F51-BAF6-45C4256DD5B0 */ { 0x65,0x02,0x09,0x1C,0x61,0x5F,0x4F,0x51,0xBA,0xF6,0x45,0xC4,0x25,0x6D,0xD5,0xB0 }; +BMD_CONST REFIID IID_IDeckLinkMutableVideoFrame = /* CF9EB134-0374-4C5B-95FA-1EC14819FF62 */ { 0xCF,0x9E,0xB1,0x34,0x03,0x74,0x4C,0x5B,0x95,0xFA,0x1E,0xC1,0x48,0x19,0xFF,0x62 }; +BMD_CONST REFIID IID_IDeckLinkVideoFrame3DExtensions = /* D4DBE9C6-B4D2-49D3-ABF2-B4E86C7391B0 */ { 0xD4,0xDB,0xE9,0xC6,0xB4,0xD2,0x49,0xD3,0xAB,0xF2,0xB4,0xE8,0x6C,0x73,0x91,0xB0 }; +BMD_CONST REFIID IID_IDeckLinkVideoFrameMetadataExtensions = /* E232A5B7-4DB4-44C9-9152-F47C12E5F051 */ { 0xE2,0x32,0xA5,0xB7,0x4D,0xB4,0x44,0xC9,0x91,0x52,0xF4,0x7C,0x12,0xE5,0xF0,0x51 }; +BMD_CONST REFIID IID_IDeckLinkVideoFrameMutableMetadataExtensions = /* CC198FC6-8298-4419-942D-8357EC355E58 */ { 0xCC,0x19,0x8F,0xC6,0x82,0x98,0x44,0x19,0x94,0x2D,0x83,0x57,0xEC,0x35,0x5E,0x58 }; +BMD_CONST REFIID IID_IDeckLinkVideoInputFrame = /* C9ADD3D2-BE52-488D-AB2D-7FDEF7AF0C95 */ { 0xC9,0xAD,0xD3,0xD2,0xBE,0x52,0x48,0x8D,0xAB,0x2D,0x7F,0xDE,0xF7,0xAF,0x0C,0x95 }; +BMD_CONST REFIID IID_IDeckLinkAncillaryPacket = /* F5C0D498-5CD3-4C77-9773-8EFA20BB334B */ { 0xF5,0xC0,0xD4,0x98,0x5C,0xD3,0x4C,0x77,0x97,0x73,0x8E,0xFA,0x20,0xBB,0x33,0x4B }; +BMD_CONST REFIID IID_IDeckLinkAncillaryPacketIterator = /* 10F1AA88-54BE-42F7-B9F8-EC2F5F099551 */ { 0x10,0xF1,0xAA,0x88,0x54,0xBE,0x42,0xF7,0xB9,0xF8,0xEC,0x2F,0x5F,0x09,0x95,0x51 }; +BMD_CONST REFIID IID_IDeckLinkVideoFrameAncillaryPackets = /* 8A72D630-8070-4D05-8A93-E60C40EE088A */ { 0x8A,0x72,0xD6,0x30,0x80,0x70,0x4D,0x05,0x8A,0x93,0xE6,0x0C,0x40,0xEE,0x08,0x8A }; +BMD_CONST REFIID IID_IDeckLinkVideoFrameAncillary = /* 732E723C-D1A4-4E29-9E8E-4A88797A0004 */ { 0x73,0x2E,0x72,0x3C,0xD1,0xA4,0x4E,0x29,0x9E,0x8E,0x4A,0x88,0x79,0x7A,0x00,0x04 }; +BMD_CONST REFIID IID_IDeckLinkEncoderPacket = /* B693F36C-316E-4AF1-B6C2-F389A4BCA620 */ { 0xB6,0x93,0xF3,0x6C,0x31,0x6E,0x4A,0xF1,0xB6,0xC2,0xF3,0x89,0xA4,0xBC,0xA6,0x20 }; +BMD_CONST REFIID IID_IDeckLinkEncoderVideoPacket = /* 4E7FD944-E8C7-4EAC-B8C0-7B77F80F5AE0 */ { 0x4E,0x7F,0xD9,0x44,0xE8,0xC7,0x4E,0xAC,0xB8,0xC0,0x7B,0x77,0xF8,0x0F,0x5A,0xE0 }; +BMD_CONST REFIID IID_IDeckLinkEncoderAudioPacket = /* 49E8EDC8-693B-4E14-8EF6-12C658F5A07A */ { 0x49,0xE8,0xED,0xC8,0x69,0x3B,0x4E,0x14,0x8E,0xF6,0x12,0xC6,0x58,0xF5,0xA0,0x7A }; +BMD_CONST REFIID IID_IDeckLinkH265NALPacket = /* 639C8E0B-68D5-4BDE-A6D4-95F3AEAFF2E7 */ { 0x63,0x9C,0x8E,0x0B,0x68,0xD5,0x4B,0xDE,0xA6,0xD4,0x95,0xF3,0xAE,0xAF,0xF2,0xE7 }; +BMD_CONST REFIID IID_IDeckLinkAudioInputPacket = /* E43D5870-2894-11DE-8C30-0800200C9A66 */ { 0xE4,0x3D,0x58,0x70,0x28,0x94,0x11,0xDE,0x8C,0x30,0x08,0x00,0x20,0x0C,0x9A,0x66 }; +BMD_CONST REFIID IID_IDeckLinkScreenPreviewCallback = /* D4FA2345-9FBA-4497-95C3-C0C3CED3CDA8 */ { 0xD4,0xFA,0x23,0x45,0x9F,0xBA,0x44,0x97,0x95,0xC3,0xC0,0xC3,0xCE,0xD3,0xCD,0xA8 }; +BMD_CONST REFIID IID_IDeckLinkGLScreenPreviewHelper = /* CEB778E2-C202-4EC8-9085-0CD285CC5522 */ { 0xCE,0xB7,0x78,0xE2,0xC2,0x02,0x4E,0xC8,0x90,0x85,0x0C,0xD2,0x85,0xCC,0x55,0x22 }; +BMD_CONST REFIID IID_IDeckLinkNotificationCallback = /* B002A1EC-070D-4288-8289-BD5D36E5FF0D */ { 0xB0,0x02,0xA1,0xEC,0x07,0x0D,0x42,0x88,0x82,0x89,0xBD,0x5D,0x36,0xE5,0xFF,0x0D }; +BMD_CONST REFIID IID_IDeckLinkNotification = /* 1D70FAAC-FD27-4866-9DE6-0939D1E4C7F1 */ { 0x1D,0x70,0xFA,0xAC,0xFD,0x27,0x48,0x66,0x9D,0xE6,0x09,0x39,0xD1,0xE4,0xC7,0xF1 }; +BMD_CONST REFIID IID_IDeckLinkProfileAttributes = /* F47551D7-AD22-47AF-BCFD-6BE88AA879D9 */ { 0xF4,0x75,0x51,0xD7,0xAD,0x22,0x47,0xAF,0xBC,0xFD,0x6B,0xE8,0x8A,0xA8,0x79,0xD9 }; +BMD_CONST REFIID IID_IDeckLinkProfileIterator = /* 29E5A8C0-8BE4-46EB-93AC-31DAAB5B7BF2 */ { 0x29,0xE5,0xA8,0xC0,0x8B,0xE4,0x46,0xEB,0x93,0xAC,0x31,0xDA,0xAB,0x5B,0x7B,0xF2 }; +BMD_CONST REFIID IID_IDeckLinkProfile = /* 16093466-674A-432B-9DA0-1AC2C5A8241C */ { 0x16,0x09,0x34,0x66,0x67,0x4A,0x43,0x2B,0x9D,0xA0,0x1A,0xC2,0xC5,0xA8,0x24,0x1C }; +BMD_CONST REFIID IID_IDeckLinkProfileCallback = /* A4F9341E-97AA-4E04-8935-15F809898CEA */ { 0xA4,0xF9,0x34,0x1E,0x97,0xAA,0x4E,0x04,0x89,0x35,0x15,0xF8,0x09,0x89,0x8C,0xEA }; +BMD_CONST REFIID IID_IDeckLinkProfileManager = /* 30D41429-3998-4B6D-84F8-78C94A797C6E */ { 0x30,0xD4,0x14,0x29,0x39,0x98,0x4B,0x6D,0x84,0xF8,0x78,0xC9,0x4A,0x79,0x7C,0x6E }; +BMD_CONST REFIID IID_IDeckLinkStatistics = /* 21CB2ED1-4429-42BE-AAF3-22A3B1DD3AE0 */ { 0x21,0xCB,0x2E,0xD1,0x44,0x29,0x42,0xBE,0xAA,0xF3,0x22,0xA3,0xB1,0xDD,0x3A,0xE0 }; +BMD_CONST REFIID IID_IDeckLinkStatus = /* 2A04A635-ED42-41EF-9342-0E11F8CF6B5E */ { 0x2A,0x04,0xA6,0x35,0xED,0x42,0x41,0xEF,0x93,0x42,0x0E,0x11,0xF8,0xCF,0x6B,0x5E }; +BMD_CONST REFIID IID_IDeckLinkKeyer = /* 89AFCAF5-65F8-421E-98F7-96FE5F5BFBA3 */ { 0x89,0xAF,0xCA,0xF5,0x65,0xF8,0x42,0x1E,0x98,0xF7,0x96,0xFE,0x5F,0x5B,0xFB,0xA3 }; +BMD_CONST REFIID IID_IDeckLinkVideoConversion = /* 94C536D6-C821-42F5-A600-C66629955101 */ { 0x94,0xC5,0x36,0xD6,0xC8,0x21,0x42,0xF5,0xA6,0x00,0xC6,0x66,0x29,0x95,0x51,0x01 }; +BMD_CONST REFIID IID_IDeckLinkDeviceNotificationCallback = /* 4997053B-0ADF-4CC8-AC70-7A50C4BE728F */ { 0x49,0x97,0x05,0x3B,0x0A,0xDF,0x4C,0xC8,0xAC,0x70,0x7A,0x50,0xC4,0xBE,0x72,0x8F }; +BMD_CONST REFIID IID_IDeckLinkDiscovery = /* CDBF631C-BC76-45FA-B44D-C55059BC6101 */ { 0xCD,0xBF,0x63,0x1C,0xBC,0x76,0x45,0xFA,0xB4,0x4D,0xC5,0x50,0x59,0xBC,0x61,0x01 }; + +/* Enum BMDBufferAccessFlags - Flags to describe access requirements to a video frame buffer */ + +typedef uint32_t BMDBufferAccessFlags; +enum _BMDBufferAccessFlags { + bmdBufferAccessReadAndWrite = 1 << 0 | 1 << 1, + bmdBufferAccessRead = 1 << 0, + bmdBufferAccessWrite = 1 << 1 +}; + +/* Enum BMDVideoOutputFlags - Flags to control the output of ancillary data along with video. */ + +typedef uint32_t BMDVideoOutputFlags; +enum _BMDVideoOutputFlags { + bmdVideoOutputFlagDefault = 0, + bmdVideoOutputVANC = 1 << 0, + bmdVideoOutputVITC = 1 << 1, + bmdVideoOutputRP188 = 1 << 2, + bmdVideoOutputDualStream3D = 1 << 4, + bmdVideoOutputSynchronizeToPlaybackGroup = 1 << 6, + bmdVideoOutputDolbyVision = 1 << 7 +}; + +/* Enum BMDSupportedVideoModeFlags - Flags to describe supported video modes */ + +typedef uint32_t BMDSupportedVideoModeFlags; +enum _BMDSupportedVideoModeFlags { + bmdSupportedVideoModeDefault = 0, + bmdSupportedVideoModeKeying = 1 << 0, + bmdSupportedVideoModeDualStream3D = 1 << 1, + bmdSupportedVideoModeSDISingleLink = 1 << 2, + bmdSupportedVideoModeSDIDualLink = 1 << 3, + bmdSupportedVideoModeSDIQuadLink = 1 << 4, + bmdSupportedVideoModeInAnyProfile = 1 << 5, + bmdSupportedVideoModePsF = 1 << 6, + bmdSupportedVideoModeDolbyVision = 1 << 7, + bmdSupportedVideoModeEthernetIP10 = 1 << 8 +}; + +/* Enum BMDPacketType - Type of packet */ + +typedef uint32_t BMDPacketType; +enum _BMDPacketType { + bmdPacketTypeStreamInterruptedMarker = /* 'sint' */ 0x73696E74, // A packet of this type marks the time when a video stream was interrupted, for example by a disconnected cable + bmdPacketTypeStreamData = /* 'sdat' */ 0x73646174 // Regular stream data +}; + +/* Enum BMDFrameFlags - Frame flags */ + +typedef uint32_t BMDFrameFlags; +enum _BMDFrameFlags { + bmdFrameFlagDefault = 0, + bmdFrameFlagFlipVertical = 1 << 0, + bmdFrameFlagMonitorOutOnly = 1 << 3, + bmdFrameContainsHDRMetadata = 1 << 1, + bmdFrameContainsDolbyVisionMetadata = 1 << 4, + + /* Flags that are applicable only to instances of IDeckLinkVideoInputFrame */ + + bmdFrameCapturedAsPsF = 1 << 30, + bmdFrameHasNoInputSource = 1 << 31 +}; + +/* Enum BMDVideoInputFlags - Flags applicable to video input */ + +typedef uint32_t BMDVideoInputFlags; +enum _BMDVideoInputFlags { + bmdVideoInputFlagDefault = 0, + bmdVideoInputEnableFormatDetection = 1 << 0, + bmdVideoInputDualStream3D = 1 << 1, + bmdVideoInputSynchronizeToCaptureGroup = 1 << 2 +}; + +/* Enum BMDVideoInputFormatChangedEvents - Bitmask passed to the VideoInputFormatChanged notification to identify the properties of the input signal that have changed */ + +typedef uint32_t BMDVideoInputFormatChangedEvents; +enum _BMDVideoInputFormatChangedEvents { + bmdVideoInputDisplayModeChanged = 1 << 0, + bmdVideoInputFieldDominanceChanged = 1 << 1, + bmdVideoInputColorspaceChanged = 1 << 2 +}; + +/* Enum BMDDetectedVideoInputFormatFlags - Flags passed to the VideoInputFormatChanged notification to describe the detected video input signal */ + +typedef uint32_t BMDDetectedVideoInputFormatFlags; +enum _BMDDetectedVideoInputFormatFlags { + bmdDetectedVideoInputYCbCr422 = 1 << 0, + bmdDetectedVideoInputRGB444 = 1 << 1, + bmdDetectedVideoInputDualStream3D = 1 << 2, + bmdDetectedVideoInput12BitDepth = 1 << 3, + bmdDetectedVideoInput10BitDepth = 1 << 4, + bmdDetectedVideoInput8BitDepth = 1 << 5 +}; + +/* Enum BMDDeckLinkCapturePassthroughMode - Enumerates whether the video output is electrically connected to the video input or if the clean switching mode is enabled */ + +typedef uint32_t BMDDeckLinkCapturePassthroughMode; +enum _BMDDeckLinkCapturePassthroughMode { + bmdDeckLinkCapturePassthroughModeDisabled = /* 'pdis' */ 0x70646973, + bmdDeckLinkCapturePassthroughModeDirect = /* 'pdir' */ 0x70646972, + bmdDeckLinkCapturePassthroughModeCleanSwitch = /* 'pcln' */ 0x70636C6E +}; + +/* Enum BMDOutputFrameCompletionResult - Frame Completion Callback */ + +typedef uint32_t BMDOutputFrameCompletionResult; +enum _BMDOutputFrameCompletionResult { + bmdOutputFrameCompleted, + bmdOutputFrameDisplayedLate, + bmdOutputFrameDropped, + bmdOutputFrameFlushed +}; + +/* Enum BMDReferenceStatus - GenLock input status */ + +typedef uint32_t BMDReferenceStatus; +enum _BMDReferenceStatus { + bmdReferenceUnlocked = 0, + bmdReferenceNotSupportedByHardware = 1 << 0, + bmdReferenceLocked = 1 << 1 +}; + +/* Enum BMDEthernetNMOSRegistryState - */ + +typedef uint32_t BMDEthernetNMOSRegistryState; +enum _BMDEthernetNMOSRegistryState { + bmdEthernetNMOSRegistryConnecting = /* 'conn' */ 0x636F6E6E, + bmdEthernetNMOSRegistryActive = /* 'good' */ 0x676F6F64, + bmdEthernetNMOSRegistryError = /* 'erro' */ 0x6572726F +}; + +/* Enum BMDAudioFormat - Audio Format */ + +typedef uint32_t BMDAudioFormat; +enum _BMDAudioFormat { + bmdAudioFormatPCM = /* 'lpcm' */ 0x6C70636D // Linear signed PCM samples +}; + +/* Enum BMDAudioSampleRate - Audio sample rates supported for output/input */ + +typedef uint32_t BMDAudioSampleRate; +enum _BMDAudioSampleRate { + bmdAudioSampleRate48kHz = 48000 +}; + +/* Enum BMDAudioSampleType - Audio sample sizes supported for output/input */ + +typedef uint32_t BMDAudioSampleType; +enum _BMDAudioSampleType { + bmdAudioSampleType16bitInteger = 16, + bmdAudioSampleType32bitInteger = 32 +}; + +/* Enum BMDAudioOutputStreamType - Audio output stream type */ + +typedef uint32_t BMDAudioOutputStreamType; +enum _BMDAudioOutputStreamType { + bmdAudioOutputStreamContinuous, + bmdAudioOutputStreamContinuousDontResample, + bmdAudioOutputStreamTimestamped +}; + +/* Enum BMDAncillaryPacketFormat - Ancillary packet format */ + +typedef uint32_t BMDAncillaryPacketFormat; +enum _BMDAncillaryPacketFormat { + bmdAncillaryPacketFormatUInt8 = /* 'ui08' */ 0x75693038, + bmdAncillaryPacketFormatUInt16 = /* 'ui16' */ 0x75693136, + bmdAncillaryPacketFormatYCbCr10 = /* 'v210' */ 0x76323130 +}; + +/* Enum BMDTimecodeFormat - Timecode formats for frame metadata */ + +typedef uint32_t BMDTimecodeFormat; +enum _BMDTimecodeFormat { + bmdTimecodeRP188VITC1 = /* 'rpv1' */ 0x72707631, // RP188 timecode where DBB1 equals VITC1 (line 9) + bmdTimecodeRP188VITC2 = /* 'rp12' */ 0x72703132, // RP188 timecode where DBB1 equals VITC2 (line 9 for progressive or line 571 for interlaced/PsF) + bmdTimecodeRP188LTC = /* 'rplt' */ 0x72706C74, // RP188 timecode where DBB1 equals LTC (line 10) + bmdTimecodeRP188HighFrameRate = /* 'rphr' */ 0x72706872, // RP188 timecode where DBB1 is an HFRTC (SMPTE ST 12-3), the only timecode allowing the frame value to go above 30 + bmdTimecodeRP188Any = /* 'rp18' */ 0x72703138, // Convenience for capture, returning the first valid timecode in {HFRTC (if supported), VITC1, VITC2, LTC } + bmdTimecodeVITC = /* 'vitc' */ 0x76697463, + bmdTimecodeVITCField2 = /* 'vit2' */ 0x76697432, + bmdTimecodeSerial = /* 'seri' */ 0x73657269 +}; + +/* Enum BMDAnalogVideoFlags - Analog video display flags */ + +typedef uint32_t BMDAnalogVideoFlags; +enum _BMDAnalogVideoFlags { + bmdAnalogVideoFlagCompositeSetup75 = 1 << 0, + bmdAnalogVideoFlagComponentBetacamLevels = 1 << 1 +}; + +/* Enum BMDAudioOutputAnalogAESSwitch - Audio output Analog/AESEBU switch */ + +typedef uint32_t BMDAudioOutputAnalogAESSwitch; +enum _BMDAudioOutputAnalogAESSwitch { + bmdAudioOutputSwitchAESEBU = /* 'aes ' */ 0x61657320, + bmdAudioOutputSwitchAnalog = /* 'anlg' */ 0x616E6C67 +}; + +/* Enum BMDVideoOutputConversionMode - Video/audio conversion mode */ + +typedef uint32_t BMDVideoOutputConversionMode; +enum _BMDVideoOutputConversionMode { + bmdNoVideoOutputConversion = /* 'none' */ 0x6E6F6E65, + bmdVideoOutputLetterboxDownconversion = /* 'ltbx' */ 0x6C746278, + bmdVideoOutputAnamorphicDownconversion = /* 'amph' */ 0x616D7068, + bmdVideoOutputHD720toHD1080Conversion = /* '720c' */ 0x37323063, + bmdVideoOutputHardwareLetterboxDownconversion = /* 'HWlb' */ 0x48576C62, + bmdVideoOutputHardwareAnamorphicDownconversion = /* 'HWam' */ 0x4857616D, + bmdVideoOutputHardwareCenterCutDownconversion = /* 'HWcc' */ 0x48576363, + bmdVideoOutputHardware720p1080pCrossconversion = /* 'xcap' */ 0x78636170, + bmdVideoOutputHardwareAnamorphic720pUpconversion = /* 'ua7p' */ 0x75613770, + bmdVideoOutputHardwareAnamorphic1080iUpconversion = /* 'ua1i' */ 0x75613169, + bmdVideoOutputHardwareAnamorphic149To720pUpconversion = /* 'u47p' */ 0x75343770, + bmdVideoOutputHardwareAnamorphic149To1080iUpconversion = /* 'u41i' */ 0x75343169, + bmdVideoOutputHardwarePillarbox720pUpconversion = /* 'up7p' */ 0x75703770, + bmdVideoOutputHardwarePillarbox1080iUpconversion = /* 'up1i' */ 0x75703169 +}; + +/* Enum BMDVideoInputConversionMode - Video input conversion mode */ + +typedef uint32_t BMDVideoInputConversionMode; +enum _BMDVideoInputConversionMode { + bmdNoVideoInputConversion = /* 'none' */ 0x6E6F6E65, + bmdVideoInputLetterboxDownconversionFromHD1080 = /* '10lb' */ 0x31306C62, + bmdVideoInputAnamorphicDownconversionFromHD1080 = /* '10am' */ 0x3130616D, + bmdVideoInputLetterboxDownconversionFromHD720 = /* '72lb' */ 0x37326C62, + bmdVideoInputAnamorphicDownconversionFromHD720 = /* '72am' */ 0x3732616D, + bmdVideoInputLetterboxUpconversion = /* 'lbup' */ 0x6C627570, + bmdVideoInputAnamorphicUpconversion = /* 'amup' */ 0x616D7570 +}; + +/* Enum BMDVideo3DPackingFormat - Video 3D packing format */ + +typedef uint32_t BMDVideo3DPackingFormat; +enum _BMDVideo3DPackingFormat { + bmdVideo3DPackingSidebySideHalf = /* 'sbsh' */ 0x73627368, + bmdVideo3DPackingLinebyLine = /* 'lbyl' */ 0x6C62796C, + bmdVideo3DPackingTopAndBottom = /* 'tabo' */ 0x7461626F, + bmdVideo3DPackingFramePacking = /* 'frpk' */ 0x6672706B, + bmdVideo3DPackingLeftOnly = /* 'left' */ 0x6C656674, + bmdVideo3DPackingRightOnly = /* 'righ' */ 0x72696768 +}; + +/* Enum BMDIdleVideoOutputOperation - Video output operation when not playing video */ + +typedef uint32_t BMDIdleVideoOutputOperation; +enum _BMDIdleVideoOutputOperation { + bmdIdleVideoOutputBlack = /* 'blac' */ 0x626C6163, + bmdIdleVideoOutputLastFrame = /* 'lafa' */ 0x6C616661 +}; + +/* Enum BMDVideoEncoderFrameCodingMode - Video frame coding mode */ + +typedef uint32_t BMDVideoEncoderFrameCodingMode; +enum _BMDVideoEncoderFrameCodingMode { + bmdVideoEncoderFrameCodingModeInter = /* 'inte' */ 0x696E7465, + bmdVideoEncoderFrameCodingModeIntra = /* 'intr' */ 0x696E7472 +}; + +/* Enum BMDDNxHRLevel - DNxHR Levels */ + +typedef uint32_t BMDDNxHRLevel; +enum _BMDDNxHRLevel { + bmdDNxHRLevelSQ = /* 'dnsq' */ 0x646E7371, + bmdDNxHRLevelLB = /* 'dnlb' */ 0x646E6C62, + bmdDNxHRLevelHQ = /* 'dnhq' */ 0x646E6871, + bmdDNxHRLevelHQX = /* 'dhqx' */ 0x64687178, + bmdDNxHRLevel444 = /* 'd444' */ 0x64343434 +}; + +/* Enum BMDLinkConfiguration - Video link configuration */ + +typedef uint32_t BMDLinkConfiguration; +enum _BMDLinkConfiguration { + bmdLinkConfigurationSingleLink = /* 'lcsl' */ 0x6C63736C, + bmdLinkConfigurationDualLink = /* 'lcdl' */ 0x6C63646C, + bmdLinkConfigurationQuadLink = /* 'lcql' */ 0x6C63716C +}; + +/* Enum BMDDeviceInterface - Device interface type */ + +typedef uint32_t BMDDeviceInterface; +enum _BMDDeviceInterface { + bmdDeviceInterfacePCI = /* 'pci ' */ 0x70636920, + bmdDeviceInterfaceUSB = /* 'usb ' */ 0x75736220, + bmdDeviceInterfaceThunderbolt = /* 'thun' */ 0x7468756E +}; + +/* Enum BMDColorspace - Colorspace */ + +typedef uint32_t BMDColorspace; +enum _BMDColorspace { + bmdColorspaceRec601 = /* 'r601' */ 0x72363031, + bmdColorspaceRec709 = /* 'r709' */ 0x72373039, + bmdColorspaceRec2020 = /* '2020' */ 0x32303230, + bmdColorspaceDolbyVisionNative = /* 'DoVi' */ 0x446F5669, // For bmdDeckLinkConfigVideoOutputConversionColorspaceDestination with 12-bit RGB + bmdColorspaceP3D65 = /* 'P3D6' */ 0x50334436, // For bmdDeckLinkConfigVideoOutputConversionColorspaceSource only + bmdColorspaceUnknown = /* 'Ncol' */ 0x4E636F6C // For disabling bmdDeckLinkConfigVideoOutputConversionColorspaceDestination +}; + +/* Enum BMDDynamicRange - SDR or HDR */ + +typedef uint32_t BMDDynamicRange; +enum _BMDDynamicRange { + bmdDynamicRangeSDR = 0, // Standard Dynamic Range in accordance with SMPTE ST 2036-1 + bmdDynamicRangeHDRStaticPQ = 1 << 29, // High Dynamic Range PQ in accordance with SMPTE ST 2084 + bmdDynamicRangeHDRStaticHLG = 1 << 30 // High Dynamic Range HLG in accordance with ITU-R BT.2100-0 +}; + +/* Enum BMDMezzanineType - */ + +typedef uint32_t BMDMezzanineType; +enum _BMDMezzanineType { + bmdMezzanineTypeNone = 0, // No mezzanine board + bmdMezzanineTypeHDMI14OpticalSDI = /* 'mza1' */ 0x6D7A6131, // Mezzanine board with HDMI 1.4 and Optical SDI + bmdMezzanineTypeQuadSDI = /* 'mz4s' */ 0x6D7A3473, // Mezzanine board with four SDI connectors + bmdMezzanineTypeHDMI20OpticalSDI = /* 'mza2' */ 0x6D7A6132, // Mezzanine board with HDMI 2.0 and Optical SDI + bmdMezzanineTypeHDMI21RS422 = /* 'mzhr' */ 0x6D7A6872 // Mezzanine boards with HDMI 2.1 and RS422 +}; + +/* Enum BMDDeckLinkHDMIInputEDIDID - DeckLink HDMI Input EDID ID */ + +typedef uint32_t BMDDeckLinkHDMIInputEDIDID; +enum _BMDDeckLinkHDMIInputEDIDID { + + /* Integers */ + + bmdDeckLinkHDMIInputEDIDDynamicRange = /* 'HIDy' */ 0x48494479 // Parameter is of type BMDDynamicRange. Default is (bmdDynamicRangeSDR|bmdDynamicRangeHDRStaticPQ) +}; + +/* Enum BMDDeckLinkFrameMetadataID - DeckLink Frame Metadata ID */ + +typedef uint32_t BMDDeckLinkFrameMetadataID; +enum _BMDDeckLinkFrameMetadataID { + + /* Integers */ + + bmdDeckLinkFrameMetadataColorspace = /* 'cspc' */ 0x63737063, // Colorspace of video frame (see BMDColorspace) + bmdDeckLinkFrameMetadataHDRElectroOpticalTransferFunc = /* 'eotf' */ 0x656F7466, // EOTF in range 0-7 as per CEA 861.3 + bmdDeckLinkFrameMetadataRTPTimestamp = /* 'rtpt' */ 0x72747074, // RTP timestamp + + /* Dolby Vision only - Bytes */ + + bmdDeckLinkFrameMetadataDolbyVision = /* 'dovi' */ 0x646F7669, // Dolby Vision Metadata + + /* CEA/SMPTE only - HDR Metadata Floats */ + + bmdDeckLinkFrameMetadataHDRDisplayPrimariesRedX = /* 'hdrx' */ 0x68647278, // Red display primaries in range 0.0 - 1.0 + bmdDeckLinkFrameMetadataHDRDisplayPrimariesRedY = /* 'hdry' */ 0x68647279, // Red display primaries in range 0.0 - 1.0 + bmdDeckLinkFrameMetadataHDRDisplayPrimariesGreenX = /* 'hdgx' */ 0x68646778, // Green display primaries in range 0.0 - 1.0 + bmdDeckLinkFrameMetadataHDRDisplayPrimariesGreenY = /* 'hdgy' */ 0x68646779, // Green display primaries in range 0.0 - 1.0 + bmdDeckLinkFrameMetadataHDRDisplayPrimariesBlueX = /* 'hdbx' */ 0x68646278, // Blue display primaries in range 0.0 - 1.0 + bmdDeckLinkFrameMetadataHDRDisplayPrimariesBlueY = /* 'hdby' */ 0x68646279, // Blue display primaries in range 0.0 - 1.0 + bmdDeckLinkFrameMetadataHDRWhitePointX = /* 'hdwx' */ 0x68647778, // White point in range 0.0 - 1.0 + bmdDeckLinkFrameMetadataHDRWhitePointY = /* 'hdwy' */ 0x68647779, // White point in range 0.0 - 1.0 + bmdDeckLinkFrameMetadataHDRMaxDisplayMasteringLuminance = /* 'hdml' */ 0x68646D6C, // Max display mastering luminance in range 1 cd/m2 - 65535 cd/m2 + bmdDeckLinkFrameMetadataHDRMinDisplayMasteringLuminance = /* 'hmil' */ 0x686D696C, // Min display mastering luminance in range 0.0001 cd/m2 - 6.5535 cd/m2 + bmdDeckLinkFrameMetadataHDRMaximumContentLightLevel = /* 'mcll' */ 0x6D636C6C, // Maximum Content Light Level in range 1 cd/m2 - 65535 cd/m2 + bmdDeckLinkFrameMetadataHDRMaximumFrameAverageLightLevel = /* 'fall' */ 0x66616C6C // Maximum Frame Average Light Level in range 1 cd/m2 - 65535 cd/m2 +}; + +/* Enum BMDEthernetLinkState - The state of the Ethernet link */ + +typedef uint32_t BMDEthernetLinkState; +enum _BMDEthernetLinkState { + bmdEthernetLinkStateDisconnected = /* 'elds' */ 0x656C6473, + bmdEthernetLinkStateConnectedUnbound = /* 'elcu' */ 0x656C6375, + bmdEthernetLinkStateConnectedBound = /* 'elcb' */ 0x656C6362 +}; + +/* Enum BMDProfileID - Identifies a profile */ + +typedef uint32_t BMDProfileID; +enum _BMDProfileID { + bmdProfileOneSubDeviceFullDuplex = /* '1dfd' */ 0x31646664, + bmdProfileOneSubDeviceHalfDuplex = /* '1dhd' */ 0x31646864, + bmdProfileTwoSubDevicesFullDuplex = /* '2dfd' */ 0x32646664, + bmdProfileTwoSubDevicesHalfDuplex = /* '2dhd' */ 0x32646864, + bmdProfileFourSubDevicesHalfDuplex = /* '4dhd' */ 0x34646864 +}; + +/* Enum BMDHDMITimecodePacking - Packing form of timecode on HDMI */ + +typedef uint32_t BMDHDMITimecodePacking; +enum _BMDHDMITimecodePacking { + bmdHDMITimecodePackingIEEEOUI000085 = 0x00008500, + bmdHDMITimecodePackingIEEEOUI080046 = 0x08004601, + bmdHDMITimecodePackingIEEEOUI5CF9F0 = 0x5CF9F003 +}; + +/* Enum BMDInternalKeyingAncillaryDataSource - Source for VANC and timecode data when performing internal keying */ + +typedef uint32_t BMDInternalKeyingAncillaryDataSource; +enum _BMDInternalKeyingAncillaryDataSource { + bmdInternalKeyingUsesAncillaryDataFromInputSignal = /* 'ikai' */ 0x696B6169, + bmdInternalKeyingUsesAncillaryDataFromKeyFrame = /* 'ikak' */ 0x696B616B +}; + +/* Enum BMDAudioOutputXLRDelayType - Audio output XLR delay types */ + +typedef uint32_t BMDAudioOutputXLRDelayType; +enum _BMDAudioOutputXLRDelayType { + bmdAudioOutputXLRDelayTypeTime = /* 'dtms' */ 0x64746D73, + bmdAudioOutputXLRDelayTypeFrames = /* 'dtfr' */ 0x64746672 +}; + +/* Enum BMDLanguage - Languages */ + +typedef uint32_t BMDLanguage; +enum _BMDLanguage { + bmdLanguageEnglish = /* 'enUS' */ 0x656E5553, + bmdLanguageSimplifiedChinese = /* 'zhCN' */ 0x7A68434E, + bmdLanguageJapanese = /* 'jaJP' */ 0x6A614A50, + bmdLanguageKorean = /* 'koKR' */ 0x6B6F4B52, + bmdLanguageSpanish = /* 'esES' */ 0x65734553, + bmdLanguageGerman = /* 'deDE' */ 0x64654445, + bmdLanguageFrench = /* 'frFR' */ 0x66724652, + bmdLanguageRussian = /* 'ruRU' */ 0x72755255, + bmdLanguageItalian = /* 'itIT' */ 0x69744954, + bmdLanguagePortuguese = /* 'ptBR' */ 0x70744252, + bmdLanguageTurkish = /* 'trTR' */ 0x74725452, + bmdLanguagePolish = /* 'plPL' */ 0x706C504C, + bmdLanguageUkrainian = /* 'ukUA' */ 0x756B5541 +}; + +/* Enum BMDAudioMeterType - Audio meter type */ + +typedef uint32_t BMDAudioMeterType; +enum _BMDAudioMeterType { + bmdAudioMeterTypeVUMinus18db = /* 'vu18' */ 0x76753138, + bmdAudioMeterTypeVUMinus20db = /* 'vu20' */ 0x76753230, + bmdAudioMeterTypePPMMinus18db = /* 'pm18' */ 0x706D3138, + bmdAudioMeterTypePPMMinus20db = /* 'pm20' */ 0x706D3230 +}; + +/* Enum BMDDeckLinkAttributeID - DeckLink Attribute ID */ + +typedef uint32_t BMDDeckLinkAttributeID; +enum _BMDDeckLinkAttributeID { + + /* Flags */ + + BMDDeckLinkSupportsInternalKeying = /* 'keyi' */ 0x6B657969, + BMDDeckLinkSupportsExternalKeying = /* 'keye' */ 0x6B657965, + BMDDeckLinkSupportsInputFormatDetection = /* 'infd' */ 0x696E6664, + BMDDeckLinkHasReferenceInput = /* 'hrin' */ 0x6872696E, + BMDDeckLinkHasSerialPort = /* 'hspt' */ 0x68737074, + BMDDeckLinkHasAnalogVideoOutputGain = /* 'avog' */ 0x61766F67, + BMDDeckLinkCanOnlyAdjustOverallVideoOutputGain = /* 'ovog' */ 0x6F766F67, + BMDDeckLinkHasVideoInputAntiAliasingFilter = /* 'aafl' */ 0x6161666C, + BMDDeckLinkHasBypass = /* 'byps' */ 0x62797073, + BMDDeckLinkSupportsClockTimingAdjustment = /* 'ctad' */ 0x63746164, + BMDDeckLinkSupportsFullFrameReferenceInputTimingOffset = /* 'frin' */ 0x6672696E, + BMDDeckLinkSupportsSMPTELevelAOutput = /* 'lvla' */ 0x6C766C61, + BMDDeckLinkSupportsAutoSwitchingPPsFOnInput = /* 'apsf' */ 0x61707366, + BMDDeckLinkSupportsDualLinkSDI = /* 'sdls' */ 0x73646C73, + BMDDeckLinkSupportsQuadLinkSDI = /* 'sqls' */ 0x73716C73, + BMDDeckLinkSupportsIdleOutput = /* 'idou' */ 0x69646F75, + BMDDeckLinkVANCRequires10BitYUVVideoFrames = /* 'vioY' */ 0x76696F59, // Legacy product requires v210 active picture for IDeckLinkVideoFrameAncillaryPackets or 10-bit VANC + BMDDeckLinkHasLTCTimecodeInput = /* 'hltc' */ 0x686C7463, + BMDDeckLinkSupportsHDRMetadata = /* 'hdrm' */ 0x6864726D, + BMDDeckLinkSupportsColorspaceMetadata = /* 'cmet' */ 0x636D6574, + BMDDeckLinkSupportsHDMITimecode = /* 'htim' */ 0x6874696D, + BMDDeckLinkSupportsHighFrameRateTimecode = /* 'HFRT' */ 0x48465254, + BMDDeckLinkSupportsSynchronizeToCaptureGroup = /* 'stcg' */ 0x73746367, + BMDDeckLinkSupportsSynchronizeToPlaybackGroup = /* 'stpg' */ 0x73747067, + BMDDeckLinkHasMonitorOut = /* 'fmoo' */ 0x666D6F6F, + BMDDeckLinkSupportsExtendedDesktop = /* 'dtop' */ 0x64746F70, + BMDDeckLinkHANCRequiresInputFilterConfiguration = /* 'hrif' */ 0x68726966, + BMDDeckLinkSupportsHANCOutput = /* 'dsho' */ 0x6473686F, + BMDDeckLinkSupportsHANCInput = /* 'dshi' */ 0x64736869, + + /* Integers */ + + BMDDeckLinkMaximumAudioChannels = /* 'mach' */ 0x6D616368, + BMDDeckLinkMaximumHDMIAudioChannels = /* 'mhch' */ 0x6D686368, + BMDDeckLinkMaximumAnalogAudioInputChannels = /* 'iach' */ 0x69616368, + BMDDeckLinkMaximumAnalogAudioOutputChannels = /* 'aach' */ 0x61616368, + BMDDeckLinkNumberOfSubDevices = /* 'nsbd' */ 0x6E736264, + BMDDeckLinkNumberOfEthernetConnectors = /* 'neth' */ 0x6E657468, + BMDDeckLinkSubDeviceIndex = /* 'subi' */ 0x73756269, + BMDDeckLinkPersistentID = /* 'peid' */ 0x70656964, + BMDDeckLinkDeviceGroupID = /* 'dgid' */ 0x64676964, + BMDDeckLinkTopologicalID = /* 'toid' */ 0x746F6964, + BMDDeckLinkVideoOutputConnections = /* 'vocn' */ 0x766F636E, // Returns a BMDVideoConnection bit field + BMDDeckLinkVideoInputConnections = /* 'vicn' */ 0x7669636E, // Returns a BMDVideoConnection bit field + BMDDeckLinkAudioOutputConnections = /* 'aocn' */ 0x616F636E, // Returns a BMDAudioConnection bit field + BMDDeckLinkAudioInputConnections = /* 'aicn' */ 0x6169636E, // Returns a BMDAudioConnection bit field + BMDDeckLinkVideoIOSupport = /* 'vios' */ 0x76696F73, // Returns a BMDVideoIOSupport bit field + BMDDeckLinkDeckControlConnections = /* 'dccn' */ 0x6463636E, // Returns a BMDDeckControlConnection bit field + BMDDeckLinkDeviceInterface = /* 'dbus' */ 0x64627573, // Returns a BMDDeviceInterface + BMDDeckLinkAudioInputRCAChannelCount = /* 'airc' */ 0x61697263, + BMDDeckLinkAudioInputXLRChannelCount = /* 'aixc' */ 0x61697863, + BMDDeckLinkAudioOutputRCAChannelCount = /* 'aorc' */ 0x616F7263, + BMDDeckLinkAudioOutputXLRChannelCount = /* 'aoxc' */ 0x616F7863, + BMDDeckLinkProfileID = /* 'prid' */ 0x70726964, // Returns a BMDProfileID + BMDDeckLinkDuplex = /* 'dupx' */ 0x64757078, + BMDDeckLinkMinimumPrerollFrames = /* 'mprf' */ 0x6D707266, + BMDDeckLinkSupportedDynamicRange = /* 'sudr' */ 0x73756472, + BMDDeckLinkMezzanineType = /* 'mezt' */ 0x6D657A74, + BMDDeckLinkXLRDelayMsMaximum = /* 'xdtx' */ 0x78647478, + BMDDeckLinkXLRDelayFramesMaximum = /* 'xdfx' */ 0x78646678, + BMDDeckLinkOutputHANCUserDataWordsLimit = /* 'mhow' */ 0x6D686F77, + BMDDeckLinkInputHANCUserDataWordsLimit = /* 'mhiw' */ 0x6D686977, + + /* Floats */ + + BMDDeckLinkVideoInputGainMinimum = /* 'vigm' */ 0x7669676D, + BMDDeckLinkVideoInputGainMaximum = /* 'vigx' */ 0x76696778, + BMDDeckLinkVideoOutputGainMinimum = /* 'vogm' */ 0x766F676D, + BMDDeckLinkVideoOutputGainMaximum = /* 'vogx' */ 0x766F6778, + BMDDeckLinkMicrophoneInputGainMinimum = /* 'migm' */ 0x6D69676D, + BMDDeckLinkMicrophoneInputGainMaximum = /* 'migx' */ 0x6D696778, + + /* Strings */ + + BMDDeckLinkSerialPortDeviceName = /* 'slpn' */ 0x736C706E, + BMDDeckLinkVendorName = /* 'vndr' */ 0x766E6472, + BMDDeckLinkDisplayName = /* 'dspn' */ 0x6473706E, + BMDDeckLinkModelName = /* 'mdln' */ 0x6D646C6E, + BMDDeckLinkDeviceHandle = /* 'devh' */ 0x64657668, + + /* Parameterized Strings */ + + BMDDeckLinkParamEthernetMACAddress = /* 'pMAC' */ 0x704D4143 +}; + +/* Enum BMDDeckLinkAPIInformationID - DeckLinkAPI information ID */ + +typedef uint32_t BMDDeckLinkAPIInformationID; +enum _BMDDeckLinkAPIInformationID { + + /* Integer or String */ + + BMDDeckLinkAPIVersion = /* 'vers' */ 0x76657273 +}; + +/* Enum BMDDeckLinkStatisticID - DeckLink Statistic ID */ + +typedef uint32_t BMDDeckLinkStatisticID; +enum _BMDDeckLinkStatisticID { + + /* Integers */ + + bmdDeckLinkStatisticPTPLossOfLock = /* 'nlol' */ 0x6E6C6F6C, + bmdDeckLinkStatisticPTPDPLLMarginOfError = /* 'ptpe' */ 0x70747065, + bmdDeckLinkStatisticDeviceTemperature = /* 'Stmp' */ 0x53746D70, + + /* Parameterized Integers */ + + bmdDeckLinkStatisticParamEthernetRxPackets = /* 'ntrx' */ 0x6E747278, + bmdDeckLinkStatisticParamEthernetRxDroppedPackets = /* 'ndrx' */ 0x6E647278, + + /* Parameterized Strings */ + + bmdDeckLinkStatisticParamEthernetSFPDynamicInfo = /* 'sfps' */ 0x73667073 +}; + +/* Enum BMDDeckLinkStatusID - DeckLink Status ID */ + +typedef uint32_t BMDDeckLinkStatusID; +enum _BMDDeckLinkStatusID { + + /* Integers / Interfaces */ + + bmdDeckLinkStatusDetectedVideoInputMode = /* 'dvim' */ 0x6476696D, + bmdDeckLinkStatusCurrentVideoInputMode = /* 'cvim' */ 0x6376696D, + bmdDeckLinkStatusCurrentVideoOutputMode = /* 'cvom' */ 0x63766F6D, + bmdDeckLinkStatusHDMIOutputActualMode = /* 'hiam' */ 0x6869616D, + + /* Integers */ + + bmdDeckLinkStatusDetectedVideoInputFormatFlags = /* 'dvff' */ 0x64766666, + bmdDeckLinkStatusDetectedVideoInputFieldDominance = /* 'dvfd' */ 0x64766664, + bmdDeckLinkStatusDetectedVideoInputColorspace = /* 'dscl' */ 0x6473636C, + bmdDeckLinkStatusDetectedVideoInputDynamicRange = /* 'dsdr' */ 0x64736472, + bmdDeckLinkStatusDetectedSDILinkConfiguration = /* 'dslc' */ 0x64736C63, + bmdDeckLinkStatusCurrentVideoInputPixelFormat = /* 'cvip' */ 0x63766970, + bmdDeckLinkStatusCurrentVideoInputFlags = /* 'cvif' */ 0x63766966, + bmdDeckLinkStatusCurrentVideoOutputFlags = /* 'cvof' */ 0x63766F66, + bmdDeckLinkStatusPCIExpressLinkWidth = /* 'pwid' */ 0x70776964, + bmdDeckLinkStatusPCIExpressLinkSpeed = /* 'plnk' */ 0x706C6E6B, + bmdDeckLinkStatusLastVideoOutputPixelFormat = /* 'opix' */ 0x6F706978, + bmdDeckLinkStatusReferenceSignalMode = /* 'refm' */ 0x7265666D, + bmdDeckLinkStatusReferenceSignalFlags = /* 'reff' */ 0x72656666, + bmdDeckLinkStatusBusy = /* 'busy' */ 0x62757379, + bmdDeckLinkStatusInterchangeablePanelType = /* 'icpt' */ 0x69637074, + bmdDeckLinkStatusHDMIOutputActualFormatFlags = /* 'hiaf' */ 0x68696166, + bmdDeckLinkStatusHDMIOutputFRLRate = /* 'hiof' */ 0x68696F66, + bmdDeckLinkStatusHDMIInputFRLRate = /* 'hiif' */ 0x68696966, + bmdDeckLinkStatusEthernetManualNMOSRegistry = /* 'nmme' */ 0x6E6D6D65, + bmdDeckLinkStatusHDMIOutputTMDSLineRate = /* 'hilr' */ 0x68696C72, + + /* Floats */ + + bmdDeckLinkStatusSinkSupportsDolbyVision = /* 'dvvr' */ 0x64767672, + + /* Flags */ + + bmdDeckLinkStatusVideoInputSignalLocked = /* 'visl' */ 0x7669736C, + bmdDeckLinkStatusAncillaryInputSignalLocked = /* 'aisl' */ 0x6169736C, + bmdDeckLinkStatusReferenceSignalLocked = /* 'refl' */ 0x7265666C, + + /* Strings */ + + bmdDeckLinkStatusEthernetPTPGrandmasterIdentity = /* 'spid' */ 0x73706964, + bmdDeckLinkStatusEthernetAudioInputChannelOrder = /* 'saco' */ 0x7361636F, + bmdDeckLinkStatusEthernetCurrentNMOSRegistry = /* 'nmre' */ 0x6E6D7265, + + /* Bytes */ + + bmdDeckLinkStatusReceivedEDID = /* 'edid' */ 0x65646964, + + /* Parameterized Integers */ + + bmdDeckLinkStatusParamEthernetLink = /* 'sels' */ 0x73656C73, + bmdDeckLinkStatusParamEthernetLinkMbps = /* 'sesp' */ 0x73657370, + + /* Parameterized Strings */ + + bmdDeckLinkStatusParamEthernetLocalIPAddress = /* 'seip' */ 0x73656970, + bmdDeckLinkStatusParamEthernetSubnetMask = /* 'sesm' */ 0x7365736D, + bmdDeckLinkStatusParamEthernetGatewayIPAddress = /* 'segw' */ 0x73656777, + bmdDeckLinkStatusParamEthernetPrimaryDNS = /* 'sepd' */ 0x73657064, + bmdDeckLinkStatusParamEthernetSecondaryDNS = /* 'sesd' */ 0x73657364, + bmdDeckLinkStatusParamEthernetSFPStaticInfo = /* 'sfpi' */ 0x73667069, + bmdDeckLinkStatusParamEthernetVideoOutputAddress = /* 'soav' */ 0x736F6176, + bmdDeckLinkStatusParamEthernetAudioOutputAddress = /* 'soaa' */ 0x736F6161, + bmdDeckLinkStatusParamEthernetAncillaryOutputAddress = /* 'soaA' */ 0x736F6141 +}; + +/* Enum BMDDeckLinkVideoStatusFlags - */ + +typedef uint32_t BMDDeckLinkVideoStatusFlags; +enum _BMDDeckLinkVideoStatusFlags { + bmdDeckLinkVideoStatusPsF = 1 << 0, + bmdDeckLinkVideoStatusDualStream3D = 1 << 1 +}; + +/* Enum BMDDuplexMode - Duplex of the device */ + +typedef uint32_t BMDDuplexMode; +enum _BMDDuplexMode { + bmdDuplexFull = /* 'dxfu' */ 0x64786675, + bmdDuplexHalf = /* 'dxha' */ 0x64786861, + bmdDuplexSimplex = /* 'dxsp' */ 0x64787370, + bmdDuplexInactive = /* 'dxin' */ 0x6478696E +}; + +/* Enum BMDPanelType - The type of interchangeable panel */ + +typedef uint32_t BMDPanelType; +enum _BMDPanelType { + bmdPanelNotDetected = /* 'npnl' */ 0x6E706E6C, + bmdPanelTeranexMiniSmartPanel = /* 'tmsm' */ 0x746D736D +}; + +/* Enum BMDFormatFlags - Flags to describe the video signal */ + +typedef uint32_t BMDFormatFlags; +enum _BMDFormatFlags { + bmdFormatRGB444 = 1 << 0, + bmdFormatYUV444 = 1 << 1, + bmdFormatYUV422 = 1 << 2, + bmdFormatYUV420 = 1 << 3, + bmdFormat8BitDepth = 1 << 4, + bmdFormat10BitDepth = 1 << 5, + bmdFormat12BitDepth = 1 << 6 +}; + +/* Enum BMDDeviceBusyState - Current device busy state */ + +typedef uint32_t BMDDeviceBusyState; +enum _BMDDeviceBusyState { + bmdDeviceCaptureBusy = 1 << 0, + bmdDevicePlaybackBusy = 1 << 1, + bmdDeviceSerialPortBusy = 1 << 2 +}; + +/* Enum BMDVideoIOSupport - Device video input/output support */ + +typedef uint32_t BMDVideoIOSupport; +enum _BMDVideoIOSupport { + bmdDeviceSupportsCapture = 1 << 0, + bmdDeviceSupportsPlayback = 1 << 1 +}; + +/* Enum BMD3DPreviewFormat - Linked Frame preview format */ + +typedef uint32_t BMD3DPreviewFormat; +enum _BMD3DPreviewFormat { + bmd3DPreviewFormatDefault = /* 'defa' */ 0x64656661, + bmd3DPreviewFormatLeftOnly = /* 'left' */ 0x6C656674, + bmd3DPreviewFormatRightOnly = /* 'righ' */ 0x72696768, + bmd3DPreviewFormatSideBySide = /* 'side' */ 0x73696465, + bmd3DPreviewFormatTopBottom = /* 'topb' */ 0x746F7062 +}; + +/* Enum BMDAncillaryDataSpace - BMDAncillaryDataSpace enumerates the location of an ancillary packet. */ + +typedef uint32_t BMDAncillaryDataSpace; +enum _BMDAncillaryDataSpace { + bmdAncillaryDataSpaceVANC = 0, + bmdAncillaryDataSpaceHANC = 1 +}; + +/* Enum BMDIPFlowDirection - BMDIPFlowDirection enumerates the direction of the IP flow. */ + +enum BMDIPFlowDirection { + bmdDeckLinkIPFlowDirectionOutput = 0, + bmdDeckLinkIPFlowDirectionInput = 1 +}; + +/* Enum BMDIPFlowType - BMDIPFlowType enumerates the IP flow type. */ + +enum BMDIPFlowType { + bmdDeckLinkIPFlowTypeVideo = 0, + bmdDeckLinkIPFlowTypeAudio = 1, + bmdDeckLinkIPFlowTypeAncillary = 2 +}; + +/* Enum BMDDeckLinkIPFlowAttributeID - DeckLink IP Flow Attribute ID */ + +enum BMDDeckLinkIPFlowAttributeID { + + /* DeckLink IP Flow Attribute Integers */ + + bmdDeckLinkIPFlowID = /* '2fai' */ 0x32666169, + bmdDeckLinkIPFlowDirection = /* '2fad' */ 0x32666164, + bmdDeckLinkIPFlowType = /* '2fat' */ 0x32666174 +}; + +/* Enum BMDDeckLinkIPFlowStatusID - DeckLink IP Flow Attribute ID */ + +enum BMDDeckLinkIPFlowStatusID { + + /* DeckLink IP Flow Status Strings */ + + bmdDeckLinkIPFlowSDP = /* '2fas' */ 0x32666173 +}; + +/* Enum BMDDeckLinkIPFlowSettingID - DeckLink IP Flow Setting ID */ + +enum BMDDeckLinkIPFlowSettingID { + + /* DeckLink IP Flow Setting Strings */ + + bmdDeckLinkIPFlowPeerSDP = /* '2fps' */ 0x32667073 // The peer's SDP. Must not be over 1000 bytes large. +}; + +/* Enum BMDNotifications - Events that can be subscribed through IDeckLinkNotification */ + +typedef uint32_t BMDNotifications; +enum _BMDNotifications { + bmdPreferencesChanged = /* 'pref' */ 0x70726566, + bmdStatusChanged = /* 'stat' */ 0x73746174, + bmdIPFlowStatusChanged = /* 'bfsc' */ 0x62667363, + bmdIPFlowSettingChanged = /* 'bfcc' */ 0x62666363 +}; + +#if defined(__cplusplus) + +// Forward Declarations + +class IDeckLinkVideoOutputCallback; +class IDeckLinkInputCallback; +class IDeckLinkEncoderInputCallback; +class IDeckLinkVideoBufferAllocator; +class IDeckLinkVideoBufferAllocatorProvider; +class IDeckLinkAudioOutputCallback; +class IDeckLinkIterator; +class IDeckLinkAPIInformation; +class IDeckLinkIPFlowAttributes; +class IDeckLinkIPFlowStatus; +class IDeckLinkIPFlowSetting; +class IDeckLinkIPFlow; +class IDeckLinkIPFlowIterator; +class IDeckLinkOutput; +class IDeckLinkInput; +class IDeckLinkIPExtensions; +class IDeckLinkHDMIInputEDID; +class IDeckLinkEncoderInput; +class IDeckLinkVideoBuffer; +class IDeckLinkVideoFrame; +class IDeckLinkMutableVideoFrame; +class IDeckLinkVideoFrame3DExtensions; +class IDeckLinkVideoFrameMetadataExtensions; +class IDeckLinkVideoFrameMutableMetadataExtensions; +class IDeckLinkVideoInputFrame; +class IDeckLinkAncillaryPacket; +class IDeckLinkAncillaryPacketIterator; +class IDeckLinkVideoFrameAncillaryPackets; +class IDeckLinkVideoFrameAncillary; +class IDeckLinkEncoderPacket; +class IDeckLinkEncoderVideoPacket; +class IDeckLinkEncoderAudioPacket; +class IDeckLinkH265NALPacket; +class IDeckLinkAudioInputPacket; +class IDeckLinkScreenPreviewCallback; +class IDeckLinkGLScreenPreviewHelper; +class IDeckLinkNotificationCallback; +class IDeckLinkNotification; +class IDeckLinkProfileAttributes; +class IDeckLinkProfileIterator; +class IDeckLinkProfile; +class IDeckLinkProfileCallback; +class IDeckLinkProfileManager; +class IDeckLinkStatistics; +class IDeckLinkStatus; +class IDeckLinkKeyer; +class IDeckLinkVideoConversion; +class IDeckLinkDeviceNotificationCallback; +class IDeckLinkDiscovery; + +/* Interface IDeckLinkVideoOutputCallback - Frame completion callback. */ + +class BMD_PUBLIC IDeckLinkVideoOutputCallback : public IUnknown +{ +public: + virtual HRESULT ScheduledFrameCompleted (/* in */ IDeckLinkVideoFrame* completedFrame, /* in */ BMDOutputFrameCompletionResult result) = 0; + virtual HRESULT ScheduledPlaybackHasStopped (void) = 0; + +protected: + virtual ~IDeckLinkVideoOutputCallback () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkInputCallback - Frame arrival callback. */ + +class BMD_PUBLIC IDeckLinkInputCallback : public IUnknown +{ +public: + virtual HRESULT VideoInputFormatChanged (/* in */ BMDVideoInputFormatChangedEvents notificationEvents, /* in */ IDeckLinkDisplayMode* newDisplayMode, /* in */ BMDDetectedVideoInputFormatFlags detectedSignalFlags) = 0; + virtual HRESULT VideoInputFrameArrived (/* in */ IDeckLinkVideoInputFrame* videoFrame, /* in */ IDeckLinkAudioInputPacket* audioPacket) = 0; + +protected: + virtual ~IDeckLinkInputCallback () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkEncoderInputCallback - Frame arrival callback. */ + +class BMD_PUBLIC IDeckLinkEncoderInputCallback : public IUnknown +{ +public: + virtual HRESULT VideoInputSignalChanged (/* in */ BMDVideoInputFormatChangedEvents notificationEvents, /* in */ IDeckLinkDisplayMode* newDisplayMode, /* in */ BMDDetectedVideoInputFormatFlags detectedSignalFlags) = 0; + virtual HRESULT VideoPacketArrived (/* in */ IDeckLinkEncoderVideoPacket* videoPacket) = 0; + virtual HRESULT AudioPacketArrived (/* in */ IDeckLinkEncoderAudioPacket* audioPacket) = 0; + +protected: + virtual ~IDeckLinkEncoderInputCallback () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkVideoBufferAllocator - Buffer allocator for video. */ + +class BMD_PUBLIC IDeckLinkVideoBufferAllocator : public IUnknown +{ +public: + virtual HRESULT AllocateVideoBuffer (/* out */ IDeckLinkVideoBuffer** allocatedBuffer) = 0; + +protected: + virtual ~IDeckLinkVideoBufferAllocator () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkVideoBufferAllocatorProvider - Allows EnableVideoInputWithAllocatorProvider to obtain allocators */ + +class BMD_PUBLIC IDeckLinkVideoBufferAllocatorProvider : public IUnknown +{ +public: + virtual HRESULT GetVideoBufferAllocator (/* in */ uint32_t bufferSize, /* in */ uint32_t width, /* in */ uint32_t height, /* in */ uint32_t rowBytes, /* in */ BMDPixelFormat pixelFormat, /* out */ IDeckLinkVideoBufferAllocator** allocator) = 0; + +protected: + virtual ~IDeckLinkVideoBufferAllocatorProvider () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkAudioOutputCallback - Optional callback to allow audio samples to be pulled as required. */ + +class BMD_PUBLIC IDeckLinkAudioOutputCallback : public IUnknown +{ +public: + virtual HRESULT RenderAudioSamples (/* in */ bool preroll) = 0; +}; + +/* Interface IDeckLinkIterator - Enumerates installed DeckLink hardware */ + +class BMD_PUBLIC IDeckLinkIterator : public IUnknown +{ +public: + virtual HRESULT Next (/* out */ IDeckLink** deckLinkInstance) = 0; +}; + +/* Interface IDeckLinkAPIInformation - DeckLinkAPI attribute interface */ + +class BMD_PUBLIC IDeckLinkAPIInformation : public IUnknown +{ +public: + virtual HRESULT GetFlag (/* in */ BMDDeckLinkAPIInformationID cfgID, /* out */ bool* value) = 0; + virtual HRESULT GetInt (/* in */ BMDDeckLinkAPIInformationID cfgID, /* out */ int64_t* value) = 0; + virtual HRESULT GetFloat (/* in */ BMDDeckLinkAPIInformationID cfgID, /* out */ double* value) = 0; + virtual HRESULT GetString (/* in */ BMDDeckLinkAPIInformationID cfgID, /* out */ const char** value) = 0; + +protected: + virtual ~IDeckLinkAPIInformation () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkIPFlowAttributes - */ + +class BMD_PUBLIC IDeckLinkIPFlowAttributes : public IUnknown +{ +public: + virtual HRESULT GetInt (/* in */ BMDDeckLinkIPFlowAttributeID attrID, /* out */ int64_t* value) = 0; + virtual HRESULT GetFlag (/* in */ BMDDeckLinkIPFlowAttributeID attrID, /* out */ bool* value) = 0; + virtual HRESULT GetFloat (/* in */ BMDDeckLinkIPFlowAttributeID attrID, /* out */ double* value) = 0; + virtual HRESULT GetString (/* in */ BMDDeckLinkIPFlowAttributeID attrID, /* out */ const char** value) = 0; + +protected: + virtual ~IDeckLinkIPFlowAttributes () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkIPFlowStatus - */ + +class BMD_PUBLIC IDeckLinkIPFlowStatus : public IUnknown +{ +public: + virtual HRESULT GetInt (/* in */ BMDDeckLinkIPFlowStatusID statusID, /* out */ int64_t* value) = 0; + virtual HRESULT GetFlag (/* in */ BMDDeckLinkIPFlowStatusID statusID, /* out */ bool* value) = 0; + virtual HRESULT GetFloat (/* in */ BMDDeckLinkIPFlowStatusID statusID, /* out */ double* value) = 0; + virtual HRESULT GetString (/* in */ BMDDeckLinkIPFlowStatusID statusID, /* out */ const char** value) = 0; + +protected: + virtual ~IDeckLinkIPFlowStatus () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkIPFlowSetting - */ + +class BMD_PUBLIC IDeckLinkIPFlowSetting : public IUnknown +{ +public: + virtual HRESULT GetInt (/* in */ BMDDeckLinkIPFlowSettingID settingID, /* out */ int64_t* value) = 0; + virtual HRESULT GetFlag (/* in */ BMDDeckLinkIPFlowSettingID settingID, /* out */ bool* value) = 0; + virtual HRESULT GetFloat (/* in */ BMDDeckLinkIPFlowSettingID settingID, /* out */ double* value) = 0; + virtual HRESULT GetString (/* in */ BMDDeckLinkIPFlowSettingID settingID, /* out */ const char** value) = 0; + virtual HRESULT SetInt (/* in */ BMDDeckLinkIPFlowSettingID settingID, /* in */ int64_t value) = 0; + virtual HRESULT SetFlag (/* in */ BMDDeckLinkIPFlowSettingID settingID, /* in */ bool value) = 0; + virtual HRESULT SetFloat (/* in */ BMDDeckLinkIPFlowSettingID settingID, /* in */ double value) = 0; + virtual HRESULT SetString (/* in */ BMDDeckLinkIPFlowSettingID settingID, /* in */ const char* value) = 0; + +protected: + virtual ~IDeckLinkIPFlowSetting () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkIPFlow - */ + +class BMD_PUBLIC IDeckLinkIPFlow : public IUnknown +{ +public: + virtual HRESULT Enable (void) = 0; // Enables an IP flow to start sending or receiving. + virtual HRESULT Disable (void) = 0; // Disables an IP flow to stop sending or receiving. + +protected: + virtual ~IDeckLinkIPFlow () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkIPFlowIterator - Enumerates DeckLink IP Flows */ + +class BMD_PUBLIC IDeckLinkIPFlowIterator : public IUnknown +{ +public: + virtual HRESULT Next (/* out */ IDeckLinkIPFlow** deckLinkIPFlowInstance) = 0; + +protected: + virtual ~IDeckLinkIPFlowIterator () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkOutput - Created by QueryInterface from IDeckLink. */ + +class BMD_PUBLIC IDeckLinkOutput : public IUnknown +{ +public: + virtual HRESULT DoesSupportVideoMode (/* in */ BMDVideoConnection connection /* If a value of bmdVideoConnectionUnspecified is specified, the caller does not care about the connection */, /* in */ BMDDisplayMode requestedMode, /* in */ BMDPixelFormat requestedPixelFormat, /* in */ BMDVideoOutputConversionMode conversionMode, /* in */ BMDSupportedVideoModeFlags flags, /* out */ BMDDisplayMode* actualMode, /* out */ bool* supported) = 0; + virtual HRESULT GetDisplayMode (/* in */ BMDDisplayMode displayMode, /* out */ IDeckLinkDisplayMode** resultDisplayMode) = 0; + virtual HRESULT GetDisplayModeIterator (/* out */ IDeckLinkDisplayModeIterator** iterator) = 0; + virtual HRESULT SetScreenPreviewCallback (/* in */ IDeckLinkScreenPreviewCallback* previewCallback) = 0; + + /* Video Output */ + + virtual HRESULT EnableVideoOutput (/* in */ BMDDisplayMode displayMode, /* in */ BMDVideoOutputFlags flags) = 0; + virtual HRESULT DisableVideoOutput (void) = 0; + virtual HRESULT CreateVideoFrame (/* in */ int32_t width, /* in */ int32_t height, /* in */ int32_t rowBytes, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDFrameFlags flags, /* out */ IDeckLinkMutableVideoFrame** outFrame) = 0; + virtual HRESULT CreateVideoFrameWithBuffer (/* in */ int32_t width, /* in */ int32_t height, /* in */ int32_t rowBytes, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDFrameFlags flags, /* in */ IDeckLinkVideoBuffer* buffer, /* out */ IDeckLinkMutableVideoFrame** outFrame) = 0; + virtual HRESULT RowBytesForPixelFormat (/* in */ BMDPixelFormat pixelFormat, /* in */ int32_t width, /* out */ int32_t* rowBytes) = 0; + virtual HRESULT CreateAncillaryData (/* in */ BMDPixelFormat pixelFormat, /* out */ IDeckLinkVideoFrameAncillary** outBuffer) = 0; // Deprecated. Use of IDeckLinkVideoFrameAncillaryPackets is preferred + virtual HRESULT DisplayVideoFrameSync (/* in */ IDeckLinkVideoFrame* theFrame) = 0; + virtual HRESULT ScheduleVideoFrame (/* in */ IDeckLinkVideoFrame* theFrame, /* in */ BMDTimeValue displayTime, /* in */ BMDTimeValue displayDuration, /* in */ BMDTimeScale timeScale) = 0; + virtual HRESULT SetScheduledFrameCompletionCallback (/* in */ IDeckLinkVideoOutputCallback* theCallback) = 0; + virtual HRESULT GetBufferedVideoFrameCount (/* out */ uint32_t* bufferedFrameCount) = 0; + + /* Audio Output */ + + virtual HRESULT EnableAudioOutput (/* in */ BMDAudioSampleRate sampleRate, /* in */ BMDAudioSampleType sampleType, /* in */ uint32_t channelCount, /* in */ BMDAudioOutputStreamType streamType) = 0; + virtual HRESULT DisableAudioOutput (void) = 0; + virtual HRESULT WriteAudioSamplesSync (/* in */ void* buffer, /* in */ uint32_t sampleFrameCount, /* out */ uint32_t* sampleFramesWritten) = 0; + virtual HRESULT BeginAudioPreroll (void) = 0; + virtual HRESULT EndAudioPreroll (void) = 0; + virtual HRESULT ScheduleAudioSamples (/* in */ void* buffer, /* in */ uint32_t sampleFrameCount, /* in */ BMDTimeValue streamTime, /* in */ BMDTimeScale timeScale, /* out */ uint32_t* sampleFramesWritten) = 0; + virtual HRESULT GetBufferedAudioSampleFrameCount (/* out */ uint32_t* bufferedSampleFrameCount) = 0; + virtual HRESULT FlushBufferedAudioSamples (void) = 0; + virtual HRESULT SetAudioCallback (/* in */ IDeckLinkAudioOutputCallback* theCallback) = 0; + + /* Output Control */ + + virtual HRESULT StartScheduledPlayback (/* in */ BMDTimeValue playbackStartTime, /* in */ BMDTimeScale timeScale, /* in */ double playbackSpeed) = 0; + virtual HRESULT StopScheduledPlayback (/* in */ BMDTimeValue stopPlaybackAtTime, /* out */ BMDTimeValue* actualStopTime, /* in */ BMDTimeScale timeScale) = 0; + virtual HRESULT IsScheduledPlaybackRunning (/* out */ bool* active) = 0; + virtual HRESULT GetScheduledStreamTime (/* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue* streamTime, /* out */ double* playbackSpeed) = 0; + virtual HRESULT GetReferenceStatus (/* out */ BMDReferenceStatus* referenceStatus) = 0; + + /* Hardware Timing */ + + virtual HRESULT GetHardwareReferenceClock (/* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue* hardwareTime, /* out */ BMDTimeValue* timeInFrame, /* out */ BMDTimeValue* ticksPerFrame) = 0; + virtual HRESULT GetFrameCompletionReferenceTimestamp (/* in */ IDeckLinkVideoFrame* theFrame, /* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue* frameCompletionTimestamp) = 0; + +protected: + virtual ~IDeckLinkOutput () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkInput - Created by QueryInterface from IDeckLink. */ + +class BMD_PUBLIC IDeckLinkInput : public IUnknown +{ +public: + virtual HRESULT DoesSupportVideoMode (/* in */ BMDVideoConnection connection /* If a value of bmdVideoConnectionUnspecified is specified, the caller does not care about the connection */, /* in */ BMDDisplayMode requestedMode, /* in */ BMDPixelFormat requestedPixelFormat, /* in */ BMDVideoInputConversionMode conversionMode, /* in */ BMDSupportedVideoModeFlags flags, /* out */ BMDDisplayMode* actualMode, /* out */ bool* supported) = 0; + virtual HRESULT GetDisplayMode (/* in */ BMDDisplayMode displayMode, /* out */ IDeckLinkDisplayMode** resultDisplayMode) = 0; + virtual HRESULT GetDisplayModeIterator (/* out */ IDeckLinkDisplayModeIterator** iterator) = 0; + virtual HRESULT SetScreenPreviewCallback (/* in */ IDeckLinkScreenPreviewCallback* previewCallback) = 0; + + /* Video Input */ + + virtual HRESULT EnableVideoInput (/* in */ BMDDisplayMode displayMode, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDVideoInputFlags flags) = 0; + virtual HRESULT EnableVideoInputWithAllocatorProvider (/* in */ BMDDisplayMode displayMode, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDVideoInputFlags flags, /* in */ IDeckLinkVideoBufferAllocatorProvider* allocatorProvider) = 0; + virtual HRESULT DisableVideoInput (void) = 0; + virtual HRESULT GetAvailableVideoFrameCount (/* out */ uint32_t* availableFrameCount) = 0; + + /* Audio Input */ + + virtual HRESULT EnableAudioInput (/* in */ BMDAudioSampleRate sampleRate, /* in */ BMDAudioSampleType sampleType, /* in */ uint32_t channelCount) = 0; + virtual HRESULT DisableAudioInput (void) = 0; + virtual HRESULT GetAvailableAudioSampleFrameCount (/* out */ uint32_t* availableSampleFrameCount) = 0; + + /* Input Control */ + + virtual HRESULT StartStreams (void) = 0; + virtual HRESULT StopStreams (void) = 0; + virtual HRESULT PauseStreams (void) = 0; + virtual HRESULT FlushStreams (void) = 0; + virtual HRESULT SetCallback (/* in */ IDeckLinkInputCallback* theCallback) = 0; + + /* Hardware Timing */ + + virtual HRESULT GetHardwareReferenceClock (/* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue* hardwareTime, /* out */ BMDTimeValue* timeInFrame, /* out */ BMDTimeValue* ticksPerFrame) = 0; + +protected: + virtual ~IDeckLinkInput () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkIPExtensions - */ + +class BMD_PUBLIC IDeckLinkIPExtensions : public IUnknown +{ +public: + virtual HRESULT GetDeckLinkIPFlowIterator (/* out */ IDeckLinkIPFlowIterator** iterator) = 0; + virtual HRESULT GetIPFlowByID (/* in */ BMDIPFlowID id, /* out */ IDeckLinkIPFlow** flow) = 0; + +protected: + virtual ~IDeckLinkIPExtensions () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkHDMIInputEDID - Created by QueryInterface from IDeckLink. Releasing all references will restore EDID to default */ + +class BMD_PUBLIC IDeckLinkHDMIInputEDID : public IUnknown +{ +public: + virtual HRESULT SetInt (/* in */ BMDDeckLinkHDMIInputEDIDID cfgID, /* in */ int64_t value) = 0; + virtual HRESULT GetInt (/* in */ BMDDeckLinkHDMIInputEDIDID cfgID, /* out */ int64_t* value) = 0; + virtual HRESULT WriteToEDID (void) = 0; + +protected: + virtual ~IDeckLinkHDMIInputEDID () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkEncoderInput - Created by QueryInterface from IDeckLink. */ + +class BMD_PUBLIC IDeckLinkEncoderInput : public IUnknown +{ +public: + virtual HRESULT DoesSupportVideoMode (/* in */ BMDVideoConnection connection /* If a value of bmdVideoConnectionUnspecified is specified, the caller does not care about the connection */, /* in */ BMDDisplayMode requestedMode, /* in */ BMDPixelFormat requestedCodec, /* in */ uint32_t requestedCodecProfile, /* in */ BMDSupportedVideoModeFlags flags, /* out */ bool* supported) = 0; + virtual HRESULT GetDisplayMode (/* in */ BMDDisplayMode displayMode, /* out */ IDeckLinkDisplayMode** resultDisplayMode) = 0; + virtual HRESULT GetDisplayModeIterator (/* out */ IDeckLinkDisplayModeIterator** iterator) = 0; + + /* Video Input */ + + virtual HRESULT EnableVideoInput (/* in */ BMDDisplayMode displayMode, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDVideoInputFlags flags) = 0; + virtual HRESULT DisableVideoInput (void) = 0; + virtual HRESULT GetAvailablePacketsCount (/* out */ uint32_t* availablePacketsCount) = 0; + + /* Audio Input */ + + virtual HRESULT EnableAudioInput (/* in */ BMDAudioFormat audioFormat, /* in */ BMDAudioSampleRate sampleRate, /* in */ BMDAudioSampleType sampleType, /* in */ uint32_t channelCount) = 0; + virtual HRESULT DisableAudioInput (void) = 0; + virtual HRESULT GetAvailableAudioSampleFrameCount (/* out */ uint32_t* availableSampleFrameCount) = 0; + + /* Input Control */ + + virtual HRESULT StartStreams (void) = 0; + virtual HRESULT StopStreams (void) = 0; + virtual HRESULT PauseStreams (void) = 0; + virtual HRESULT FlushStreams (void) = 0; + virtual HRESULT SetCallback (/* in */ IDeckLinkEncoderInputCallback* theCallback) = 0; + + /* Hardware Timing */ + + virtual HRESULT GetHardwareReferenceClock (/* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue* hardwareTime, /* out */ BMDTimeValue* timeInFrame, /* out */ BMDTimeValue* ticksPerFrame) = 0; + +protected: + virtual ~IDeckLinkEncoderInput () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkVideoBuffer - Interface to encapsulate a video frame buffer; can be caller-implemented. */ + +class BMD_PUBLIC IDeckLinkVideoBuffer : public IUnknown +{ +public: + virtual HRESULT GetBytes (/* out */ void** buffer) = 0; + virtual HRESULT GetSize (/* out */ uint64_t* size) = 0; + virtual HRESULT StartAccess (/* in */ BMDBufferAccessFlags flags) = 0; + virtual HRESULT EndAccess (/* in */ BMDBufferAccessFlags flags) = 0; + +protected: + virtual ~IDeckLinkVideoBuffer () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkVideoFrame - Interface to encapsulate a video frame; can be caller-implemented. */ + +class BMD_PUBLIC IDeckLinkVideoFrame : public IUnknown +{ +public: + virtual long GetWidth (void) = 0; + virtual long GetHeight (void) = 0; + virtual long GetRowBytes (void) = 0; + virtual BMDPixelFormat GetPixelFormat (void) = 0; + virtual BMDFrameFlags GetFlags (void) = 0; + virtual HRESULT GetTimecode (/* in */ BMDTimecodeFormat format, /* out */ IDeckLinkTimecode** timecode) = 0; + virtual HRESULT GetAncillaryData (/* out */ IDeckLinkVideoFrameAncillary** ancillary) = 0; // Deprecated. Use of IDeckLinkVideoFrameAncillaryPackets is preferred + +protected: + virtual ~IDeckLinkVideoFrame () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkMutableVideoFrame - Created by IDeckLinkOutput::CreateVideoFrame. */ + +class BMD_PUBLIC IDeckLinkMutableVideoFrame : public IDeckLinkVideoFrame +{ +public: + virtual HRESULT SetFlags (/* in */ BMDFrameFlags newFlags) = 0; + virtual HRESULT SetTimecode (/* in */ BMDTimecodeFormat format, /* in */ IDeckLinkTimecode* timecode) = 0; + virtual HRESULT SetTimecodeFromComponents (/* in */ BMDTimecodeFormat format, /* in */ uint8_t hours, /* in */ uint8_t minutes, /* in */ uint8_t seconds, /* in */ uint8_t frames, /* in */ BMDTimecodeFlags flags) = 0; + virtual HRESULT SetAncillaryData (/* in */ IDeckLinkVideoFrameAncillary* ancillary) = 0; // Deprecated. Use of IDeckLinkVideoFrameAncillaryPackets is preferred + virtual HRESULT SetTimecodeUserBits (/* in */ BMDTimecodeFormat format, /* in */ BMDTimecodeUserBits userBits) = 0; + virtual HRESULT SetInterfaceProvider (/* in */ REFIID iid, /* in */ IUnknown* iface) = 0; + +protected: + virtual ~IDeckLinkMutableVideoFrame () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkVideoFrame3DExtensions - Optional interface to support 3D frames. */ + +class BMD_PUBLIC IDeckLinkVideoFrame3DExtensions : public IUnknown +{ +public: + virtual BMDVideo3DPackingFormat Get3DPackingFormat (void) = 0; + virtual HRESULT GetFrameForRightEye (/* out */ IDeckLinkVideoFrame** rightEyeFrame) = 0; + +protected: + virtual ~IDeckLinkVideoFrame3DExtensions () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkVideoFrameMetadataExtensions - Get frame metadata */ + +class BMD_PUBLIC IDeckLinkVideoFrameMetadataExtensions : public IUnknown +{ +public: + virtual HRESULT GetInt (/* in */ BMDDeckLinkFrameMetadataID metadataID, /* out */ int64_t* value) = 0; + virtual HRESULT GetFloat (/* in */ BMDDeckLinkFrameMetadataID metadataID, /* out */ double* value) = 0; + virtual HRESULT GetFlag (/* in */ BMDDeckLinkFrameMetadataID metadataID, /* out */ bool* value) = 0; + virtual HRESULT GetString (/* in */ BMDDeckLinkFrameMetadataID metadataID, /* out */ const char** value) = 0; + virtual HRESULT GetBytes (/* in */ BMDDeckLinkFrameMetadataID metadataID, /* out */ void* buffer /* optional */, /* in, out */ uint32_t* bufferSize) = 0; + +protected: + virtual ~IDeckLinkVideoFrameMetadataExtensions () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkVideoFrameMutableMetadataExtensions - Set frame metadata */ + +class BMD_PUBLIC IDeckLinkVideoFrameMutableMetadataExtensions : public IDeckLinkVideoFrameMetadataExtensions +{ +public: + virtual HRESULT SetInt (/* in */ BMDDeckLinkFrameMetadataID metadataID, /* in */ int64_t value) = 0; + virtual HRESULT SetFloat (/* in */ BMDDeckLinkFrameMetadataID metadataID, /* in */ double value) = 0; + virtual HRESULT SetFlag (/* in */ BMDDeckLinkFrameMetadataID metadataID, /* in */ bool value) = 0; + virtual HRESULT SetString (/* in */ BMDDeckLinkFrameMetadataID metadataID, /* in */ const char* value) = 0; + virtual HRESULT SetBytes (/* in */ BMDDeckLinkFrameMetadataID metadataID, /* in */ void* buffer, /* in */ uint32_t bufferSize) = 0; + +protected: + virtual ~IDeckLinkVideoFrameMutableMetadataExtensions () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkVideoInputFrame - Provided by the IDeckLinkVideoInput frame arrival callback. */ + +class BMD_PUBLIC IDeckLinkVideoInputFrame : public IDeckLinkVideoFrame +{ +public: + virtual HRESULT GetStreamTime (/* out */ BMDTimeValue* frameTime, /* out */ BMDTimeValue* frameDuration, /* in */ BMDTimeScale timeScale) = 0; + virtual HRESULT GetHardwareReferenceTimestamp (/* in */ BMDTimeScale timeScale, /* out */ BMDTimeValue* frameTime, /* out */ BMDTimeValue* frameDuration) = 0; + +protected: + virtual ~IDeckLinkVideoInputFrame () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkAncillaryPacket - On output, user needs to implement this interface */ + +class BMD_PUBLIC IDeckLinkAncillaryPacket : public IUnknown +{ +public: + virtual HRESULT GetBytes (/* in */ BMDAncillaryPacketFormat format /* For output, only one format need be offered */, /* out */ const void** data /* Optional */, /* out */ uint32_t* size /* Optional */) = 0; + virtual uint8_t GetDID (void) = 0; + virtual uint8_t GetSDID (void) = 0; + virtual uint32_t GetLineNumber (void) = 0; // On output, zero is auto + virtual uint8_t GetDataStreamIndex (void) = 0; // Usually zero. Can only be 1 if non-SD and the first data stream is completely full + virtual BMDAncillaryDataSpace GetDataSpace (void) = 0; + +protected: + virtual ~IDeckLinkAncillaryPacket () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkAncillaryPacketIterator - Enumerates ancillary packets */ + +class BMD_PUBLIC IDeckLinkAncillaryPacketIterator : public IUnknown +{ +public: + virtual HRESULT Next (/* out */ IDeckLinkAncillaryPacket** packet) = 0; + +protected: + virtual ~IDeckLinkAncillaryPacketIterator () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkVideoFrameAncillaryPackets - Obtained through QueryInterface on an IDeckLinkVideoFrame object. */ + +class BMD_PUBLIC IDeckLinkVideoFrameAncillaryPackets : public IUnknown +{ +public: + virtual HRESULT GetPacketIterator (/* out */ IDeckLinkAncillaryPacketIterator** iterator) = 0; + virtual HRESULT GetFirstPacketByID (/* in */ uint8_t DID, /* in */ uint8_t SDID, /* out */ IDeckLinkAncillaryPacket** packet) = 0; + virtual HRESULT AttachPacket (/* in */ IDeckLinkAncillaryPacket* packet) = 0; // Implement IDeckLinkAncillaryPacket to output your own + virtual HRESULT DetachPacket (/* in */ IDeckLinkAncillaryPacket* packet) = 0; + virtual HRESULT DetachAllPackets (void) = 0; + +protected: + virtual ~IDeckLinkVideoFrameAncillaryPackets () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkVideoFrameAncillary - Use of IDeckLinkVideoFrameAncillaryPackets is preferred. Obtained through QueryInterface on an IDeckLinkVideoFrame object. */ + +class BMD_PUBLIC IDeckLinkVideoFrameAncillary : public IUnknown +{ +public: + virtual HRESULT GetBufferForVerticalBlankingLine (/* in */ uint32_t lineNumber, /* out */ void** buffer) = 0; // Pixels/rowbytes is same as display mode, except for above HD where it's 1920 pixels for UHD modes and 2048 pixels for DCI modes + virtual BMDPixelFormat GetPixelFormat (void) = 0; + virtual BMDDisplayMode GetDisplayMode (void) = 0; + +protected: + virtual ~IDeckLinkVideoFrameAncillary () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkEncoderPacket - Interface to encapsulate an encoded packet. */ + +class BMD_PUBLIC IDeckLinkEncoderPacket : public IUnknown +{ +public: + virtual HRESULT GetBytes (/* out */ void** buffer) = 0; + virtual long GetSize (void) = 0; + virtual HRESULT GetStreamTime (/* out */ BMDTimeValue* frameTime, /* in */ BMDTimeScale timeScale) = 0; + virtual BMDPacketType GetPacketType (void) = 0; + +protected: + virtual ~IDeckLinkEncoderPacket () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkEncoderVideoPacket - Provided by the IDeckLinkEncoderInput video packet arrival callback. */ + +class BMD_PUBLIC IDeckLinkEncoderVideoPacket : public IDeckLinkEncoderPacket +{ +public: + virtual BMDPixelFormat GetPixelFormat (void) = 0; + virtual HRESULT GetHardwareReferenceTimestamp (/* in */ BMDTimeScale timeScale, /* out */ BMDTimeValue* frameTime, /* out */ BMDTimeValue* frameDuration) = 0; + virtual HRESULT GetTimecode (/* in */ BMDTimecodeFormat format, /* out */ IDeckLinkTimecode** timecode) = 0; + +protected: + virtual ~IDeckLinkEncoderVideoPacket () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkEncoderAudioPacket - Provided by the IDeckLinkEncoderInput audio packet arrival callback. */ + +class BMD_PUBLIC IDeckLinkEncoderAudioPacket : public IDeckLinkEncoderPacket +{ +public: + virtual BMDAudioFormat GetAudioFormat (void) = 0; + +protected: + virtual ~IDeckLinkEncoderAudioPacket () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkH265NALPacket - Obtained through QueryInterface on an IDeckLinkEncoderVideoPacket object */ + +class BMD_PUBLIC IDeckLinkH265NALPacket : public IDeckLinkEncoderVideoPacket +{ +public: + virtual HRESULT GetUnitType (/* out */ uint8_t* unitType) = 0; + virtual HRESULT GetBytesNoPrefix (/* out */ void** buffer) = 0; + virtual long GetSizeNoPrefix (void) = 0; + +protected: + virtual ~IDeckLinkH265NALPacket () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkAudioInputPacket - Provided by the IDeckLinkInput callback. */ + +class BMD_PUBLIC IDeckLinkAudioInputPacket : public IUnknown +{ +public: + virtual long GetSampleFrameCount (void) = 0; + virtual HRESULT GetBytes (/* out */ void** buffer) = 0; + virtual HRESULT GetPacketTime (/* out */ BMDTimeValue* packetTime, /* in */ BMDTimeScale timeScale) = 0; + +protected: + virtual ~IDeckLinkAudioInputPacket () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkScreenPreviewCallback - Screen preview callback */ + +class BMD_PUBLIC IDeckLinkScreenPreviewCallback : public IUnknown +{ +public: + virtual HRESULT DrawFrame (/* in */ IDeckLinkVideoFrame* theFrame) = 0; + +protected: + virtual ~IDeckLinkScreenPreviewCallback () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkGLScreenPreviewHelper - Created with CoCreateInstance on platforms with native COM support or from CreateOpenGLScreenPreviewHelper/CreateOpenGL3ScreenPreviewHelper on other platforms. */ + +class BMD_PUBLIC IDeckLinkGLScreenPreviewHelper : public IUnknown +{ +public: + + /* Methods must be called with OpenGL context set */ + + virtual HRESULT InitializeGL (void) = 0; + virtual HRESULT PaintGL (void) = 0; + virtual HRESULT SetFrame (/* in */ IDeckLinkVideoFrame* theFrame) = 0; + virtual HRESULT Set3DPreviewFormat (/* in */ BMD3DPreviewFormat previewFormat) = 0; + +protected: + virtual ~IDeckLinkGLScreenPreviewHelper () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkNotificationCallback - DeckLink Notification Callback Interface */ + +class BMD_PUBLIC IDeckLinkNotificationCallback : public IUnknown +{ +public: + virtual HRESULT Notify (/* in */ BMDNotifications topic, /* in */ uint64_t param1, /* in */ uint64_t param2) = 0; +}; + +/* Interface IDeckLinkNotification - DeckLink Notification interface */ + +class BMD_PUBLIC IDeckLinkNotification : public IUnknown +{ +public: + virtual HRESULT Subscribe (/* in */ BMDNotifications topic, /* in */ IDeckLinkNotificationCallback* theCallback) = 0; + virtual HRESULT Unsubscribe (/* in */ BMDNotifications topic, /* in */ IDeckLinkNotificationCallback* theCallback) = 0; + +protected: + virtual ~IDeckLinkNotification () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkProfileAttributes - Created by QueryInterface from an IDeckLinkProfile, or from IDeckLink. When queried from IDeckLink, interrogates the active profile */ + +class BMD_PUBLIC IDeckLinkProfileAttributes : public IUnknown +{ +public: + virtual HRESULT GetFlag (/* in */ BMDDeckLinkAttributeID cfgID, /* out */ bool* value) = 0; + virtual HRESULT GetInt (/* in */ BMDDeckLinkAttributeID cfgID, /* out */ int64_t* value) = 0; + virtual HRESULT GetFloat (/* in */ BMDDeckLinkAttributeID cfgID, /* out */ double* value) = 0; + virtual HRESULT GetString (/* in */ BMDDeckLinkAttributeID cfgID, /* out */ const char** value) = 0; + virtual HRESULT GetStringWithParam (/* in */ BMDDeckLinkAttributeID cfgID, /* in */ uint64_t param, /* out */ const char** value) = 0; + +protected: + virtual ~IDeckLinkProfileAttributes () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkProfileIterator - Enumerates IDeckLinkProfile interfaces */ + +class BMD_PUBLIC IDeckLinkProfileIterator : public IUnknown +{ +public: + virtual HRESULT Next (/* out */ IDeckLinkProfile** profile) = 0; + +protected: + virtual ~IDeckLinkProfileIterator () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkProfile - Represents the active profile when queried from IDeckLink */ + +class BMD_PUBLIC IDeckLinkProfile : public IUnknown +{ +public: + virtual HRESULT GetDevice (/* out */ IDeckLink** device) = 0; // Device affected when this profile becomes active + virtual HRESULT IsActive (/* out */ bool* isActive) = 0; + virtual HRESULT SetActive (void) = 0; // Activating a profile will also change the profile on all devices enumerated by GetPeers. Activation is not complete until IDeckLinkProfileCallback::ProfileActivated is called + virtual HRESULT GetPeers (/* out */ IDeckLinkProfileIterator** profileIterator) = 0; // Profiles of other devices activated with this profile + +protected: + virtual ~IDeckLinkProfile () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkProfileCallback - Receive notifications about profiles related to this device */ + +class BMD_PUBLIC IDeckLinkProfileCallback : public IUnknown +{ +public: + virtual HRESULT ProfileChanging (/* in */ IDeckLinkProfile* profileToBeActivated, /* in */ bool streamsWillBeForcedToStop) = 0; // Called before this device changes profile. User has an opportunity for teardown if streamsWillBeForcedToStop + virtual HRESULT ProfileActivated (/* in */ IDeckLinkProfile* activatedProfile) = 0; // Called after this device has been activated with a new profile + +protected: + virtual ~IDeckLinkProfileCallback () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkProfileManager - Created by QueryInterface from IDeckLink when a device has multiple optional profiles */ + +class BMD_PUBLIC IDeckLinkProfileManager : public IUnknown +{ +public: + virtual HRESULT GetProfiles (/* out */ IDeckLinkProfileIterator** profileIterator) = 0; // All available profiles for this device + virtual HRESULT GetProfile (/* in */ BMDProfileID profileID, /* out */ IDeckLinkProfile** profile) = 0; + virtual HRESULT SetCallback (/* in */ IDeckLinkProfileCallback* callback) = 0; + +protected: + virtual ~IDeckLinkProfileManager () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkStatistics - DeckLink Statistics interface */ + +class BMD_PUBLIC IDeckLinkStatistics : public IUnknown +{ +public: + virtual HRESULT GetInt (/* in */ BMDDeckLinkStatisticID statID, /* out */ int64_t* value) = 0; + virtual HRESULT GetIntWithParam (/* in */ BMDDeckLinkStatisticID statID, /* in */ uint64_t param, /* out */ int64_t* value) = 0; + virtual HRESULT GetStringWithParam (/* in */ BMDDeckLinkStatisticID statID, /* in */ uint64_t param, /* out */ const char** value) = 0; + +protected: + virtual ~IDeckLinkStatistics () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkStatus - DeckLink Status interface */ + +class BMD_PUBLIC IDeckLinkStatus : public IUnknown +{ +public: + virtual HRESULT GetFlag (/* in */ BMDDeckLinkStatusID statusID, /* out */ bool* value) = 0; + virtual HRESULT GetInt (/* in */ BMDDeckLinkStatusID statusID, /* out */ int64_t* value) = 0; + virtual HRESULT GetFloat (/* in */ BMDDeckLinkStatusID statusID, /* out */ double* value) = 0; + virtual HRESULT GetString (/* in */ BMDDeckLinkStatusID statusID, /* out */ const char** value) = 0; + virtual HRESULT GetBytes (/* in */ BMDDeckLinkStatusID statusID, /* out */ void* buffer, /* in, out */ uint32_t* bufferSize) = 0; + virtual HRESULT GetInterface (/* in */ BMDDeckLinkStatusID statusID, /* out */ void** iface) = 0; + virtual HRESULT GetFlagWithParam (/* in */ BMDDeckLinkStatusID statusID, /* in */ uint64_t param, /* out */ bool* value) = 0; + virtual HRESULT GetIntWithParam (/* in */ BMDDeckLinkStatusID statusID, /* in */ uint64_t param, /* out */ int64_t* value) = 0; + virtual HRESULT GetFloatWithParam (/* in */ BMDDeckLinkStatusID statusID, /* in */ uint64_t param, /* out */ double* value) = 0; + virtual HRESULT GetStringWithParam (/* in */ BMDDeckLinkStatusID statusID, /* in */ uint64_t param, /* out */ const char** value) = 0; + virtual HRESULT GetBytesWithParam (/* in */ BMDDeckLinkStatusID statusID, /* in */ uint64_t param, /* out */ void* buffer, /* in, out */ uint32_t* bufferSize) = 0; + +protected: + virtual ~IDeckLinkStatus () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkKeyer - DeckLink Keyer interface */ + +class BMD_PUBLIC IDeckLinkKeyer : public IUnknown +{ +public: + virtual HRESULT Enable (/* in */ bool isExternal) = 0; + virtual HRESULT SetLevel (/* in */ uint8_t level) = 0; + virtual HRESULT RampUp (/* in */ uint32_t numberOfFrames) = 0; + virtual HRESULT RampDown (/* in */ uint32_t numberOfFrames) = 0; + virtual HRESULT Disable (void) = 0; + +protected: + virtual ~IDeckLinkKeyer () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkVideoConversion - Created with CoCreateInstance. */ + +class BMD_PUBLIC IDeckLinkVideoConversion : public IUnknown +{ +public: + virtual HRESULT ConvertFrame (/* in */ IDeckLinkVideoFrame* srcFrame, /* in */ IDeckLinkVideoFrame* dstFrame) = 0; + virtual HRESULT ConvertNewFrame (/* in */ IDeckLinkVideoFrame* srcFrame, /* in */ BMDPixelFormat dstPixelFormat, /* in */ BMDColorspace dstColorspace, /* in */ IDeckLinkVideoBuffer* dstBuffer, /* out */ IDeckLinkVideoFrame** dstFrame) = 0; + +protected: + virtual ~IDeckLinkVideoConversion () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkDeviceNotificationCallback - DeckLink device arrival/removal notification callbacks */ + +class BMD_PUBLIC IDeckLinkDeviceNotificationCallback : public IUnknown +{ +public: + virtual HRESULT DeckLinkDeviceArrived (/* in */ IDeckLink* deckLinkDevice) = 0; + virtual HRESULT DeckLinkDeviceRemoved (/* in */ IDeckLink* deckLinkDevice) = 0; + +protected: + virtual ~IDeckLinkDeviceNotificationCallback () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkDiscovery - DeckLink device discovery */ + +class BMD_PUBLIC IDeckLinkDiscovery : public IUnknown +{ +public: + virtual HRESULT InstallDeviceNotifications (/* in */ IDeckLinkDeviceNotificationCallback* deviceNotificationCallback) = 0; + virtual HRESULT UninstallDeviceNotifications (void) = 0; + +protected: + virtual ~IDeckLinkDiscovery () {} // call Release method to drop reference count +}; + +/* Functions */ + +extern "C" { + + BMD_PUBLIC IDeckLinkIterator* CreateDeckLinkIteratorInstance(void); + BMD_PUBLIC IDeckLinkDiscovery* CreateDeckLinkDiscoveryInstance(void); + BMD_PUBLIC IDeckLinkAPIInformation* CreateDeckLinkAPIInformationInstance(void); + BMD_PUBLIC IDeckLinkGLScreenPreviewHelper* CreateOpenGLScreenPreviewHelper(void); + BMD_PUBLIC IDeckLinkGLScreenPreviewHelper* CreateOpenGL3ScreenPreviewHelper(void); // Requires OpenGL 3.2 support and provides improved performance and color handling + BMD_PUBLIC IDeckLinkVideoConversion* CreateVideoConversionInstance(void); + BMD_PUBLIC IDeckLinkVideoFrameAncillaryPackets* CreateVideoFrameAncillaryPacketsInstance(void); // For use when creating a custom IDeckLinkVideoFrame without wrapping IDeckLinkOutput::CreateVideoFrame + +} + + + +#endif /* defined(__cplusplus) */ +#endif /* defined(BMD_DECKLINKAPI_H) */ diff --git a/services/capture/sdk/DeckLinkAPIConfiguration.h b/services/capture/sdk/DeckLinkAPIConfiguration.h new file mode 100644 index 0000000..955b4a8 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIConfiguration.h @@ -0,0 +1,338 @@ +/* -LICENSE-START- +** Copyright (c) 2026 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation covered by +** this license (the "Software") to use, reproduce, display, distribute, +** execute, and transmit the Software, and to prepare derivative works of the +** Software, and to permit third-parties to whom the Software is furnished to +** do so, all subject to the following: +** +** The copyright notices in the Software and this entire statement, including +** the above license grant, this restriction and the following disclaimer, +** must be included in all copies of the Software, in whole or in part, and +** all derivative works of the Software, unless such copies or derivative +** works are solely in the form of machine-executable object code generated by +** a source language processor. +** +** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +** IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** -LICENSE-END- +*/ + +/* + * -- AUTOMATICALLY GENERATED - DO NOT EDIT --- + */ + +#ifndef BMD_DECKLINKAPICONFIGURATION_H +#define BMD_DECKLINKAPICONFIGURATION_H + + +#ifndef BMD_CONST + #if defined(_MSC_VER) + #define BMD_CONST __declspec(selectany) static const + #else + #define BMD_CONST static const + #endif +#endif + +#ifndef BMD_PUBLIC + #define BMD_PUBLIC +#endif + +// Type Declarations + + +// Interface ID Declarations + +BMD_CONST REFIID IID_IDeckLinkConfiguration = /* 5A68FFD4-1C12-4EDE-A6D2-45451D385FC1 */ { 0x5A,0x68,0xFF,0xD4,0x1C,0x12,0x4E,0xDE,0xA6,0xD2,0x45,0x45,0x1D,0x38,0x5F,0xC1 }; +BMD_CONST REFIID IID_IDeckLinkEncoderConfiguration = /* 138050E5-C60A-4552-BF3F-0F358049327E */ { 0x13,0x80,0x50,0xE5,0xC6,0x0A,0x45,0x52,0xBF,0x3F,0x0F,0x35,0x80,0x49,0x32,0x7E }; + +/* Enum BMDDeckLinkConfigurationID - DeckLink Configuration ID */ + +typedef uint32_t BMDDeckLinkConfigurationID; +enum _BMDDeckLinkConfigurationID { + + /* Serial port Flags */ + + bmdDeckLinkConfigSwapSerialRxTx = /* 'ssrt' */ 0x73737274, + + /* Video Input/Output Integers */ + + bmdDeckLinkConfigHDMI3DPackingFormat = /* '3dpf' */ 0x33647066, + bmdDeckLinkConfigBypass = /* 'byps' */ 0x62797073, + bmdDeckLinkConfigClockTimingAdjustment = /* 'ctad' */ 0x63746164, + bmdDeckLinkConfigAudioMeterType = /* 'aumt' */ 0x61756D74, + + /* Audio Input/Output Flags */ + + bmdDeckLinkConfigAnalogAudioConsumerLevels = /* 'aacl' */ 0x6161636C, + bmdDeckLinkConfigSwapHDMICh3AndCh4OnInput = /* 'hi34' */ 0x68693334, + bmdDeckLinkConfigSwapHDMICh3AndCh4OnOutput = /* 'ho34' */ 0x686F3334, + bmdDeckLinkConfigAnalogAudioOutputChannelsMutedByHeadphone = /* 'amhp' */ 0x616D6870, + bmdDeckLinkConfigAnalogAudioOutputChannelsMutedBySpeaker = /* 'amsp' */ 0x616D7370, + + /* Video Output Flags */ + + bmdDeckLinkConfigFieldFlickerRemoval = /* 'fdfr' */ 0x66646672, + bmdDeckLinkConfigHD1080p24ToHD1080i5994Conversion = /* 'to59' */ 0x746F3539, + bmdDeckLinkConfig444SDIVideoOutput = /* '444o' */ 0x3434346F, + bmdDeckLinkConfigBlackVideoOutputDuringCapture = /* 'bvoc' */ 0x62766F63, + bmdDeckLinkConfigLowLatencyVideoOutput = /* 'llvo' */ 0x6C6C766F, + bmdDeckLinkConfigDownConversionOnAllAnalogOutput = /* 'caao' */ 0x6361616F, + bmdDeckLinkConfigSMPTELevelAOutput = /* 'smta' */ 0x736D7461, + bmdDeckLinkConfigRec2020Output = /* 'rec2' */ 0x72656332, // Ensure output is Rec.2020 colorspace + bmdDeckLinkConfigQuadLinkSDIVideoOutputSquareDivisionSplit = /* 'SDQS' */ 0x53445153, + bmdDeckLinkConfigOutput1080pAsPsF = /* 'pfpr' */ 0x70667072, + bmdDeckLinkConfigOutputValidateEDIDForDolbyVision = /* 'pred' */ 0x70726564, + bmdDeckLinkConfigExtendedDesktop = /* 'exdt' */ 0x65786474, + bmdDeckLinkConfigEthernetVideoOutputIP10 = /* 'IP10' */ 0x49503130, + + /* Video Output Integers */ + + bmdDeckLinkConfigVideoOutputConnection = /* 'vocn' */ 0x766F636E, + bmdDeckLinkConfigVideoOutputConversionMode = /* 'vocm' */ 0x766F636D, + bmdDeckLinkConfigVideoOutputConversionColorspaceDestination = /* 'vccd' */ 0x76636364, // Parameter is of type BMDColorspace + bmdDeckLinkConfigVideoOutputConversionColorspaceSource = /* 'vccs' */ 0x76636373, // Parameter is of type BMDColorspace + bmdDeckLinkConfigAnalogVideoOutputFlags = /* 'avof' */ 0x61766F66, + bmdDeckLinkConfigReferenceInputTimingOffset = /* 'glot' */ 0x676C6F74, + bmdDeckLinkConfigReferenceOutputMode = /* 'glOm' */ 0x676C4F6D, + bmdDeckLinkConfigVideoOutputIdleOperation = /* 'voio' */ 0x766F696F, + bmdDeckLinkConfigDefaultVideoOutputMode = /* 'dvom' */ 0x64766F6D, + bmdDeckLinkConfigDefaultVideoOutputModeFlags = /* 'dvof' */ 0x64766F66, + bmdDeckLinkConfigSDIOutputLinkConfiguration = /* 'solc' */ 0x736F6C63, + bmdDeckLinkConfigHDMITimecodePacking = /* 'htpk' */ 0x6874706B, + bmdDeckLinkConfigPlaybackGroup = /* 'plgr' */ 0x706C6772, + + /* Video Output Floats */ + + bmdDeckLinkConfigVideoOutputComponentLumaGain = /* 'oclg' */ 0x6F636C67, + bmdDeckLinkConfigVideoOutputComponentChromaBlueGain = /* 'occb' */ 0x6F636362, + bmdDeckLinkConfigVideoOutputComponentChromaRedGain = /* 'occr' */ 0x6F636372, + bmdDeckLinkConfigVideoOutputCompositeLumaGain = /* 'oilg' */ 0x6F696C67, + bmdDeckLinkConfigVideoOutputCompositeChromaGain = /* 'oicg' */ 0x6F696367, + bmdDeckLinkConfigVideoOutputSVideoLumaGain = /* 'oslg' */ 0x6F736C67, + bmdDeckLinkConfigVideoOutputSVideoChromaGain = /* 'oscg' */ 0x6F736367, + bmdDeckLinkConfigDolbyVisionCMVersion = /* 'dvvr' */ 0x64767672, + bmdDeckLinkConfigDolbyVisionMasterMinimumNits = /* 'mnnt' */ 0x6D6E6E74, + bmdDeckLinkConfigDolbyVisionMasterMaximumNits = /* 'mxnt' */ 0x6D786E74, + + /* Video Input Flags */ + + bmdDeckLinkConfigVideoInputScanning = /* 'visc' */ 0x76697363, // Applicable to H264 Pro Recorder only + bmdDeckLinkConfigUseDedicatedLTCInput = /* 'dltc' */ 0x646C7463, // Use timecode from LTC input instead of SDI stream + bmdDeckLinkConfigSDIInput3DPayloadOverride = /* '3dds' */ 0x33646473, + bmdDeckLinkConfigCapture1080pAsPsF = /* 'cfpr' */ 0x63667072, + + /* Video Input Integers */ + + bmdDeckLinkConfigVideoInputConnection = /* 'vicn' */ 0x7669636E, + bmdDeckLinkConfigAnalogVideoInputFlags = /* 'avif' */ 0x61766966, + bmdDeckLinkConfigVideoInputConversionMode = /* 'vicm' */ 0x7669636D, + bmdDeckLinkConfig32PulldownSequenceInitialTimecodeFrame = /* 'pdif' */ 0x70646966, + bmdDeckLinkConfigVANCSourceLine1Mapping = /* 'vsl1' */ 0x76736C31, + bmdDeckLinkConfigVANCSourceLine2Mapping = /* 'vsl2' */ 0x76736C32, + bmdDeckLinkConfigVANCSourceLine3Mapping = /* 'vsl3' */ 0x76736C33, + bmdDeckLinkConfigCapturePassThroughMode = /* 'cptm' */ 0x6370746D, + bmdDeckLinkConfigCaptureGroup = /* 'cpgr' */ 0x63706772, + bmdDeckLinkConfigHANCInputFilter1 = /* 'hif1' */ 0x68696631, + bmdDeckLinkConfigHANCInputFilter2 = /* 'hif2' */ 0x68696632, + bmdDeckLinkConfigHANCInputFilter3 = /* 'hif3' */ 0x68696633, + bmdDeckLinkConfigHANCInputFilter4 = /* 'hif4' */ 0x68696634, + + /* Video Input Floats */ + + bmdDeckLinkConfigVideoInputComponentLumaGain = /* 'iclg' */ 0x69636C67, + bmdDeckLinkConfigVideoInputComponentChromaBlueGain = /* 'iccb' */ 0x69636362, + bmdDeckLinkConfigVideoInputComponentChromaRedGain = /* 'iccr' */ 0x69636372, + bmdDeckLinkConfigVideoInputCompositeLumaGain = /* 'iilg' */ 0x69696C67, + bmdDeckLinkConfigVideoInputCompositeChromaGain = /* 'iicg' */ 0x69696367, + bmdDeckLinkConfigVideoInputSVideoLumaGain = /* 'islg' */ 0x69736C67, + bmdDeckLinkConfigVideoInputSVideoChromaGain = /* 'iscg' */ 0x69736367, + + /* Keying Integers */ + + bmdDeckLinkConfigInternalKeyingAncillaryDataSource = /* 'ikas' */ 0x696B6173, + + /* Audio Input Flags */ + + bmdDeckLinkConfigMicrophonePhantomPower = /* 'mphp' */ 0x6D706870, + + /* Audio Input Integers */ + + bmdDeckLinkConfigAudioInputConnection = /* 'aicn' */ 0x6169636E, + + /* Audio Input Floats */ + + bmdDeckLinkConfigAnalogAudioInputScaleChannel1 = /* 'ais1' */ 0x61697331, + bmdDeckLinkConfigAnalogAudioInputScaleChannel2 = /* 'ais2' */ 0x61697332, + bmdDeckLinkConfigAnalogAudioInputScaleChannel3 = /* 'ais3' */ 0x61697333, + bmdDeckLinkConfigAnalogAudioInputScaleChannel4 = /* 'ais4' */ 0x61697334, + bmdDeckLinkConfigDigitalAudioInputScale = /* 'dais' */ 0x64616973, + bmdDeckLinkConfigMicrophoneInputGain = /* 'micg' */ 0x6D696367, + bmdDeckLinkConfigAudioOutputXLRDelayFrames = /* 'xdfr' */ 0x78646672, + + /* Audio Output Integers */ + + bmdDeckLinkConfigAudioOutputAESAnalogSwitch = /* 'aoaa' */ 0x616F6161, + bmdDeckLinkConfigAudioOutputXLRDelayTime = /* 'xdms' */ 0x78646D73, + bmdDeckLinkConfigAudioOutputXLRDelayType = /* 'xdty' */ 0x78647479, + + /* Audio Output Floats */ + + bmdDeckLinkConfigAnalogAudioOutputScaleChannel1 = /* 'aos1' */ 0x616F7331, + bmdDeckLinkConfigAnalogAudioOutputScaleChannel2 = /* 'aos2' */ 0x616F7332, + bmdDeckLinkConfigAnalogAudioOutputScaleChannel3 = /* 'aos3' */ 0x616F7333, + bmdDeckLinkConfigAnalogAudioOutputScaleChannel4 = /* 'aos4' */ 0x616F7334, + bmdDeckLinkConfigDigitalAudioOutputScale = /* 'daos' */ 0x64616F73, + bmdDeckLinkConfigHeadphoneVolume = /* 'hvol' */ 0x68766F6C, + bmdDeckLinkConfigSpeakerVolume = /* 'svol' */ 0x73766F6C, + + /* Ethernet Flags */ + + bmdDeckLinkConfigEthernetPTPFollowerOnly = /* 'PTPf' */ 0x50545066, + bmdDeckLinkConfigEthernetPTPUseUDPEncapsulation = /* 'PTPU' */ 0x50545055, + bmdDeckLinkConfigEthernetUseManualNMOSRegistry = /* 'nmrp' */ 0x6E6D7270, + + /* Ethernet Integers */ + + bmdDeckLinkConfigEthernetPTPPriority1 = /* 'PTP1' */ 0x50545031, + bmdDeckLinkConfigEthernetPTPPriority2 = /* 'PTP2' */ 0x50545032, + bmdDeckLinkConfigEthernetPTPDomain = /* 'PTPD' */ 0x50545044, + bmdDeckLinkConfigEthernetPTPLogAnnounceInterval = /* 'PTPA' */ 0x50545041, + + /* Ethernet Strings */ + + bmdDeckLinkConfigEthernetAudioOutputChannelOrder = /* 'caco' */ 0x6361636F, + bmdDeckLinkConfigEthernetNMOSRegistryAddress = /* 'nmre' */ 0x6E6D7265, + + /* Parameterized Ethernet Flags */ + + bmdDeckLinkConfigParamEthernetUseDHCP = /* 'DHCP' */ 0x44484350, + + /* Parameterized Ethernet Strings */ + + bmdDeckLinkConfigParamEthernetStaticLocalIPAddress = /* 'nsip' */ 0x6E736970, + bmdDeckLinkConfigParamEthernetStaticSubnetMask = /* 'nssm' */ 0x6E73736D, + bmdDeckLinkConfigParamEthernetStaticGatewayIPAddress = /* 'nsgw' */ 0x6E736777, + bmdDeckLinkConfigParamEthernetStaticPrimaryDNS = /* 'nspd' */ 0x6E737064, + bmdDeckLinkConfigParamEthernetStaticSecondaryDNS = /* 'nssd' */ 0x6E737364, + bmdDeckLinkConfigParamEthernetVideoOutputAddress = /* 'noav' */ 0x6E6F6176, + bmdDeckLinkConfigParamEthernetAudioOutputAddress = /* 'noaa' */ 0x6E6F6161, + bmdDeckLinkConfigParamEthernetAncillaryOutputAddress = /* 'noaA' */ 0x6E6F6141, + + /* Device Information Strings */ + + bmdDeckLinkConfigDeviceInformationLabel = /* 'dila' */ 0x64696C61, + bmdDeckLinkConfigDeviceInformationSerialNumber = /* 'disn' */ 0x6469736E, + bmdDeckLinkConfigDeviceInformationCompany = /* 'dico' */ 0x6469636F, + bmdDeckLinkConfigDeviceInformationPhone = /* 'diph' */ 0x64697068, + bmdDeckLinkConfigDeviceInformationEmail = /* 'diem' */ 0x6469656D, + bmdDeckLinkConfigDeviceInformationDate = /* 'dida' */ 0x64696461, + + /* Deck Control Integers */ + + bmdDeckLinkConfigDeckControlConnection = /* 'dcco' */ 0x6463636F, + + /* UI/UX Integers */ + + bmdDeckLinkConfigDisplayLanguage = /* 'lang' */ 0x6C616E67 +}; + +/* Enum BMDDeckLinkEncoderConfigurationID - DeckLink Encoder Configuration ID */ + +typedef uint32_t BMDDeckLinkEncoderConfigurationID; +enum _BMDDeckLinkEncoderConfigurationID { + + /* Video Encoder Integers */ + + bmdDeckLinkEncoderConfigPreferredBitDepth = /* 'epbr' */ 0x65706272, + bmdDeckLinkEncoderConfigFrameCodingMode = /* 'efcm' */ 0x6566636D, + + /* HEVC/H.265 Encoder Integers */ + + bmdDeckLinkEncoderConfigH265TargetBitrate = /* 'htbr' */ 0x68746272, + + /* DNxHR/DNxHD Compression ID */ + + bmdDeckLinkEncoderConfigDNxHRCompressionID = /* 'dcid' */ 0x64636964, + + /* DNxHR/DNxHD Level */ + + bmdDeckLinkEncoderConfigDNxHRLevel = /* 'dlev' */ 0x646C6576, + + /* Encoded Sample Decriptions */ + + bmdDeckLinkEncoderConfigMPEG4SampleDescription = /* 'stsE' */ 0x73747345, // Full MPEG4 sample description (aka SampleEntry of an 'stsd' atom-box). Useful for MediaFoundation, QuickTime, MKV and more + bmdDeckLinkEncoderConfigMPEG4CodecSpecificDesc = /* 'esds' */ 0x65736473 // Sample description extensions only (atom stream, each with size and fourCC header). Useful for AVFoundation, VideoToolbox, MKV and more +}; + +#if defined(__cplusplus) + +// Forward Declarations + +class IDeckLinkConfiguration; +class IDeckLinkEncoderConfiguration; + +/* Interface IDeckLinkConfiguration - DeckLink Configuration interface */ + +class BMD_PUBLIC IDeckLinkConfiguration : public IUnknown +{ +public: + virtual HRESULT SetFlag (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ bool value) = 0; + virtual HRESULT GetFlag (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ bool* value) = 0; + virtual HRESULT SetInt (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ int64_t value) = 0; + virtual HRESULT GetInt (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ int64_t* value) = 0; + virtual HRESULT SetFloat (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ double value) = 0; + virtual HRESULT GetFloat (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ double* value) = 0; + virtual HRESULT SetString (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ const char* value) = 0; + virtual HRESULT GetString (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ const char** value) = 0; + virtual HRESULT SetFlagWithParam (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ uint64_t param, /* in */ bool value) = 0; + virtual HRESULT GetFlagWithParam (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ uint64_t param, /* out */ bool* value) = 0; + virtual HRESULT SetIntWithParam (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ uint64_t param, /* in */ int64_t value) = 0; + virtual HRESULT GetIntWithParam (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ uint64_t param, /* out */ int64_t* value) = 0; + virtual HRESULT SetFloatWithParam (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ uint64_t param, /* in */ double value) = 0; + virtual HRESULT GetFloatWithParam (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ uint64_t param, /* out */ double* value) = 0; + virtual HRESULT SetStringWithParam (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ uint64_t param, /* in */ const char* value) = 0; + virtual HRESULT GetStringWithParam (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ uint64_t param, /* out */ const char** value) = 0; + virtual HRESULT WriteConfigurationToPreferences (void) = 0; + +protected: + virtual ~IDeckLinkConfiguration () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkEncoderConfiguration - DeckLink Encoder Configuration interface. Obtained from IDeckLinkEncoderInput */ + +class BMD_PUBLIC IDeckLinkEncoderConfiguration : public IUnknown +{ +public: + virtual HRESULT SetFlag (/* in */ BMDDeckLinkEncoderConfigurationID cfgID, /* in */ bool value) = 0; + virtual HRESULT GetFlag (/* in */ BMDDeckLinkEncoderConfigurationID cfgID, /* out */ bool* value) = 0; + virtual HRESULT SetInt (/* in */ BMDDeckLinkEncoderConfigurationID cfgID, /* in */ int64_t value) = 0; + virtual HRESULT GetInt (/* in */ BMDDeckLinkEncoderConfigurationID cfgID, /* out */ int64_t* value) = 0; + virtual HRESULT SetFloat (/* in */ BMDDeckLinkEncoderConfigurationID cfgID, /* in */ double value) = 0; + virtual HRESULT GetFloat (/* in */ BMDDeckLinkEncoderConfigurationID cfgID, /* out */ double* value) = 0; + virtual HRESULT SetString (/* in */ BMDDeckLinkEncoderConfigurationID cfgID, /* in */ const char* value) = 0; + virtual HRESULT GetString (/* in */ BMDDeckLinkEncoderConfigurationID cfgID, /* out */ const char** value) = 0; + virtual HRESULT GetBytes (/* in */ BMDDeckLinkEncoderConfigurationID cfgID, /* out */ void* buffer /* optional */, /* in, out */ uint32_t* bufferSize) = 0; + +protected: + virtual ~IDeckLinkEncoderConfiguration () {} // call Release method to drop reference count +}; + +/* Functions */ + +extern "C" { + + +} + + + +#endif /* defined(__cplusplus) */ +#endif /* defined(BMD_DECKLINKAPICONFIGURATION_H) */ diff --git a/services/capture/sdk/DeckLinkAPIConfiguration_v10_11.h b/services/capture/sdk/DeckLinkAPIConfiguration_v10_11.h new file mode 100644 index 0000000..3c6c59b --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIConfiguration_v10_11.h @@ -0,0 +1,84 @@ +/* -LICENSE-START- +** Copyright (c) 2017 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPICONFIGURATION_v10_11_H +#define BMD_DECKLINKAPICONFIGURATION_v10_11_H + +#include "DeckLinkAPIConfiguration.h" + +// Interface ID Declarations + +BMD_CONST REFIID IID_IDeckLinkConfiguration_v10_11 = /* EF90380B-4AE5-4346-9077-E288E149F129 */ {0xEF,0x90,0x38,0x0B,0x4A,0xE5,0x43,0x46,0x90,0x77,0xE2,0x88,0xE1,0x49,0xF1,0x29}; + +/* Enum BMDDeckLinkConfigurationID_v10_11 - DeckLink Configuration ID */ + +typedef uint32_t BMDDeckLinkConfigurationID_v10_11; +enum _BMDDeckLinkConfigurationID_v10_11 { + + /* Video Input/Output Integers */ + + bmdDeckLinkConfigDuplexMode_v10_11 = /* 'dupx' */ 0x64757078, +}; + +// Forward Declarations + +class IDeckLinkConfiguration_v10_11; + +/* Interface IDeckLinkConfiguration_v10_11 - DeckLink Configuration interface */ + +class BMD_PUBLIC IDeckLinkConfiguration_v10_11 : public IUnknown +{ +public: + virtual HRESULT SetFlag (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ bool value) = 0; + virtual HRESULT GetFlag (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ bool *value) = 0; + virtual HRESULT SetInt (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ int64_t value) = 0; + virtual HRESULT GetInt (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ int64_t *value) = 0; + virtual HRESULT SetFloat (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ double value) = 0; + virtual HRESULT GetFloat (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ double *value) = 0; + virtual HRESULT SetString (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ const char *value) = 0; + virtual HRESULT GetString (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ const char **value) = 0; + virtual HRESULT WriteConfigurationToPreferences (void) = 0; + +protected: + virtual ~IDeckLinkConfiguration_v10_11 () {} // call Release method to drop reference count +}; + + +#endif /* defined(BMD_DECKLINKAPICONFIGURATION_v10_11_H) */ diff --git a/services/capture/sdk/DeckLinkAPIConfiguration_v10_2.h b/services/capture/sdk/DeckLinkAPIConfiguration_v10_2.h new file mode 100644 index 0000000..326ba63 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIConfiguration_v10_2.h @@ -0,0 +1,73 @@ +/* -LICENSE-START- +** Copyright (c) 2014 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPICONFIGURATION_v10_2_H +#define BMD_DECKLINKAPICONFIGURATION_v10_2_H + +#include "DeckLinkAPIConfiguration.h" + +// Interface ID Declarations + +BMD_CONST REFIID IID_IDeckLinkConfiguration_v10_2 = /* C679A35B-610C-4D09-B748-1D0478100FC0 */ {0xC6,0x79,0xA3,0x5B,0x61,0x0C,0x4D,0x09,0xB7,0x48,0x1D,0x04,0x78,0x10,0x0F,0xC0}; + +// Forward Declarations + +class IDeckLinkConfiguration_v10_2; + +/* Interface IDeckLinkConfiguration_v10_2 - DeckLink Configuration interface */ + +class BMD_PUBLIC IDeckLinkConfiguration_v10_2 : public IUnknown +{ +public: + virtual HRESULT SetFlag (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ bool value) = 0; + virtual HRESULT GetFlag (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ bool *value) = 0; + virtual HRESULT SetInt (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ int64_t value) = 0; + virtual HRESULT GetInt (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ int64_t *value) = 0; + virtual HRESULT SetFloat (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ double value) = 0; + virtual HRESULT GetFloat (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ double *value) = 0; + virtual HRESULT SetString (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ const char *value) = 0; + virtual HRESULT GetString (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ const char **value) = 0; + virtual HRESULT WriteConfigurationToPreferences (void) = 0; + +protected: + virtual ~IDeckLinkConfiguration_v10_2 () {} // call Release method to drop reference count +}; + +#endif /* defined(BMD_DECKLINKAPICONFIGURATION_v10_2_H) */ diff --git a/services/capture/sdk/DeckLinkAPIConfiguration_v10_4.h b/services/capture/sdk/DeckLinkAPIConfiguration_v10_4.h new file mode 100644 index 0000000..9ce1adc --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIConfiguration_v10_4.h @@ -0,0 +1,76 @@ +/* -LICENSE-START- +** Copyright (c) 2015 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPICONFIGURATION_v10_4_H +#define BMD_DECKLINKAPICONFIGURATION_v10_4_H + +#include "DeckLinkAPIConfiguration.h" + +// Interface ID Declarations + +BMD_CONST REFIID IID_IDeckLinkConfiguration_v10_4 = /* 1E69FCF6-4203-4936-8076-2A9F4CFD50CB */ {0x1E,0x69,0xFC,0xF6,0x42,0x03,0x49,0x36,0x80,0x76,0x2A,0x9F,0x4C,0xFD,0x50,0xCB}; + + +// +// Forward Declarations + +class IDeckLinkConfiguration_v10_4; + +/* Interface IDeckLinkConfiguration_v10_4 - DeckLink Configuration interface */ + +class BMD_PUBLIC IDeckLinkConfiguration_v10_4 : public IUnknown +{ +public: + virtual HRESULT SetFlag (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ bool value) = 0; + virtual HRESULT GetFlag (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ bool *value) = 0; + virtual HRESULT SetInt (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ int64_t value) = 0; + virtual HRESULT GetInt (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ int64_t *value) = 0; + virtual HRESULT SetFloat (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ double value) = 0; + virtual HRESULT GetFloat (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ double *value) = 0; + virtual HRESULT SetString (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ const char *value) = 0; + virtual HRESULT GetString (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ const char **value) = 0; + virtual HRESULT WriteConfigurationToPreferences (void) = 0; + +protected: + virtual ~IDeckLinkConfiguration_v10_4 () {} // call Release method to drop reference count +}; + + +#endif /* defined(BMD_DECKLINKAPICONFIGURATION_v10_4_H) */ diff --git a/services/capture/sdk/DeckLinkAPIConfiguration_v10_5.h b/services/capture/sdk/DeckLinkAPIConfiguration_v10_5.h new file mode 100644 index 0000000..71feda5 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIConfiguration_v10_5.h @@ -0,0 +1,73 @@ +/* -LICENSE-START- +** Copyright (c) 2015 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPICONFIGURATION_v10_5_H +#define BMD_DECKLINKAPICONFIGURATION_v10_5_H + +#include "DeckLinkAPIConfiguration.h" + +// Interface ID Declarations + +BMD_CONST REFIID IID_IDeckLinkEncoderConfiguration_v10_5 = /* 67455668-0848-45DF-8D8E-350A77C9A028 */ {0x67,0x45,0x56,0x68,0x08,0x48,0x45,0xDF,0x8D,0x8E,0x35,0x0A,0x77,0xC9,0xA0,0x28}; + +// Forward Declarations + +class IDeckLinkEncoderConfiguration_v10_5; + +/* Interface IDeckLinkEncoderConfiguration_v10_5 - DeckLink Encoder Configuration interface. Obtained from IDeckLinkEncoderInput */ + +class BMD_PUBLIC IDeckLinkEncoderConfiguration_v10_5 : public IUnknown +{ +public: + virtual HRESULT SetFlag (/* in */ BMDDeckLinkEncoderConfigurationID cfgID, /* in */ bool value) = 0; + virtual HRESULT GetFlag (/* in */ BMDDeckLinkEncoderConfigurationID cfgID, /* out */ bool *value) = 0; + virtual HRESULT SetInt (/* in */ BMDDeckLinkEncoderConfigurationID cfgID, /* in */ int64_t value) = 0; + virtual HRESULT GetInt (/* in */ BMDDeckLinkEncoderConfigurationID cfgID, /* out */ int64_t *value) = 0; + virtual HRESULT SetFloat (/* in */ BMDDeckLinkEncoderConfigurationID cfgID, /* in */ double value) = 0; + virtual HRESULT GetFloat (/* in */ BMDDeckLinkEncoderConfigurationID cfgID, /* out */ double *value) = 0; + virtual HRESULT SetString (/* in */ BMDDeckLinkEncoderConfigurationID cfgID, /* in */ const char *value) = 0; + virtual HRESULT GetString (/* in */ BMDDeckLinkEncoderConfigurationID cfgID, /* out */ const char **value) = 0; + virtual HRESULT GetDecoderConfigurationInfo (/* out */ void *buffer, /* in */ long bufferSize, /* out */ long *returnedSize) = 0; + +protected: + virtual ~IDeckLinkEncoderConfiguration_v10_5 () {} // call Release method to drop reference count +}; + +#endif /* defined(BMD_DECKLINKAPICONFIGURATION_v10_5_H) */ diff --git a/services/capture/sdk/DeckLinkAPIConfiguration_v10_9.h b/services/capture/sdk/DeckLinkAPIConfiguration_v10_9.h new file mode 100644 index 0000000..79ccfe8 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIConfiguration_v10_9.h @@ -0,0 +1,75 @@ +/* -LICENSE-START- +** Copyright (c) 2017 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPICONFIGURATION_v10_9_H +#define BMD_DECKLINKAPICONFIGURATION_v10_9_H + +#include "DeckLinkAPIConfiguration.h" + +// Interface ID Declarations + +BMD_CONST REFIID IID_IDeckLinkConfiguration_v10_9 = /* CB71734A-FE37-4E8D-8E13-802133A1C3F2 */ {0xCB,0x71,0x73,0x4A,0xFE,0x37,0x4E,0x8D,0x8E,0x13,0x80,0x21,0x33,0xA1,0xC3,0xF2}; + +// +// Forward Declarations + +class IDeckLinkConfiguration_v10_9; + +/* Interface IDeckLinkConfiguration_v10_9 - DeckLink Configuration interface */ + +class BMD_PUBLIC IDeckLinkConfiguration_v10_9 : public IUnknown +{ +public: + virtual HRESULT SetFlag (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ bool value) = 0; + virtual HRESULT GetFlag (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ bool *value) = 0; + virtual HRESULT SetInt (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ int64_t value) = 0; + virtual HRESULT GetInt (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ int64_t *value) = 0; + virtual HRESULT SetFloat (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ double value) = 0; + virtual HRESULT GetFloat (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ double *value) = 0; + virtual HRESULT SetString (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ const char *value) = 0; + virtual HRESULT GetString (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ const char **value) = 0; + virtual HRESULT WriteConfigurationToPreferences (void) = 0; + +protected: + virtual ~IDeckLinkConfiguration_v10_9 () {} // call Release method to drop reference count +}; + + +#endif /* defined(BMD_DECKLINKAPICONFIGURATION_v10_9_H) */ diff --git a/services/capture/sdk/DeckLinkAPIConfiguration_v15_3_1.h b/services/capture/sdk/DeckLinkAPIConfiguration_v15_3_1.h new file mode 100644 index 0000000..f1546da --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIConfiguration_v15_3_1.h @@ -0,0 +1,84 @@ +/* -LICENSE-START- +** Copyright (c) 2026 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#pragma once + +#include "DeckLinkAPIConfiguration.h" + +/* Enum BMDDeckLinkConfigurationID_v15_3_1 - DeckLink Configuration ID */ +typedef uint32_t BMDDeckLinkConfigurationID_v15_3_1; +enum _BMDDeckLinkConfigurationID_v15_3_1 +{ + /* Network Flags */ + bmdDeckLinkConfigEthernetUseDHCP_v15_3_1 = /* 'DHCP' */ 0x44484350, + + /* Network Strings */ + bmdDeckLinkConfigEthernetStaticLocalIPAddress_v15_3_1 = /* 'nsip' */ 0x6E736970, + bmdDeckLinkConfigEthernetStaticSubnetMask_v15_3_1 = /* 'nssm' */ 0x6E73736D, + bmdDeckLinkConfigEthernetStaticGatewayIPAddress_v15_3_1 = /* 'nsgw' */ 0x6E736777, + bmdDeckLinkConfigEthernetStaticPrimaryDNS_v15_3_1 = /* 'nspd' */ 0x6E737064, + bmdDeckLinkConfigEthernetStaticSecondaryDNS_v15_3_1 = /* 'nssd' */ 0x6E737364, + bmdDeckLinkConfigEthernetVideoOutputAddress_v15_3_1 = /* 'noav' */ 0x6E6F6176, + bmdDeckLinkConfigEthernetAudioOutputAddress_v15_3_1 = /* 'noaa' */ 0x6E6F6161, + bmdDeckLinkConfigEthernetAncillaryOutputAddress_v15_3_1 = /* 'noaA' */ 0x6E6F6141, +}; + +// Interface ID Declarations + +BMD_CONST REFIID IID_IDeckLinkConfiguration_v15_3_1 = /* 912F634B-2D4E-40A4-8AAB-8D80B73F1289 */ {0x91,0x2F,0x63,0x4B,0x2D,0x4E,0x40,0xA4,0x8A,0xAB,0x8D,0x80,0xB7,0x3F,0x12,0x89}; + +/* Interface IDeckLinkConfiguration_v15_3_1 - DeckLink Configuration interface */ + +class IDeckLinkConfiguration_v15_3_1 : public IUnknown +{ +public: + virtual HRESULT SetFlag (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ bool value) = 0; + virtual HRESULT GetFlag (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ bool *value) = 0; + virtual HRESULT SetInt (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ int64_t value) = 0; + virtual HRESULT GetInt (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ int64_t *value) = 0; + virtual HRESULT SetFloat (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ double value) = 0; + virtual HRESULT GetFloat (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ double *value) = 0; + virtual HRESULT SetString (/* in */ BMDDeckLinkConfigurationID cfgID, /* in */ const char* value) = 0; + virtual HRESULT GetString (/* in */ BMDDeckLinkConfigurationID cfgID, /* out */ const char* *value) = 0; + virtual HRESULT WriteConfigurationToPreferences (void) = 0; + +protected: + virtual ~IDeckLinkConfiguration_v15_3_1 () {} // call Release method to drop reference count +}; diff --git a/services/capture/sdk/DeckLinkAPIDeckControl.h b/services/capture/sdk/DeckLinkAPIDeckControl.h new file mode 100644 index 0000000..1a3f413 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIDeckControl.h @@ -0,0 +1,227 @@ +/* -LICENSE-START- +** Copyright (c) 2026 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation covered by +** this license (the "Software") to use, reproduce, display, distribute, +** execute, and transmit the Software, and to prepare derivative works of the +** Software, and to permit third-parties to whom the Software is furnished to +** do so, all subject to the following: +** +** The copyright notices in the Software and this entire statement, including +** the above license grant, this restriction and the following disclaimer, +** must be included in all copies of the Software, in whole or in part, and +** all derivative works of the Software, unless such copies or derivative +** works are solely in the form of machine-executable object code generated by +** a source language processor. +** +** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +** IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** -LICENSE-END- +*/ + +/* + * -- AUTOMATICALLY GENERATED - DO NOT EDIT --- + */ + +#ifndef BMD_DECKLINKAPIDECKCONTROL_H +#define BMD_DECKLINKAPIDECKCONTROL_H + + +#ifndef BMD_CONST + #if defined(_MSC_VER) + #define BMD_CONST __declspec(selectany) static const + #else + #define BMD_CONST static const + #endif +#endif + +#ifndef BMD_PUBLIC + #define BMD_PUBLIC +#endif + +// Type Declarations + + +// Interface ID Declarations + +BMD_CONST REFIID IID_IDeckLinkDeckControlStatusCallback = /* 53436FFB-B434-4906-BADC-AE3060FFE8EF */ { 0x53,0x43,0x6F,0xFB,0xB4,0x34,0x49,0x06,0xBA,0xDC,0xAE,0x30,0x60,0xFF,0xE8,0xEF }; +BMD_CONST REFIID IID_IDeckLinkDeckControl = /* 8E1C3ACE-19C7-4E00-8B92-D80431D958BE */ { 0x8E,0x1C,0x3A,0xCE,0x19,0xC7,0x4E,0x00,0x8B,0x92,0xD8,0x04,0x31,0xD9,0x58,0xBE }; + +/* Enum BMDDeckControlMode - DeckControl mode */ + +typedef uint32_t BMDDeckControlMode; +enum _BMDDeckControlMode { + bmdDeckControlNotOpened = /* 'ntop' */ 0x6E746F70, + bmdDeckControlVTRControlMode = /* 'vtrc' */ 0x76747263, + bmdDeckControlExportMode = /* 'expm' */ 0x6578706D, + bmdDeckControlCaptureMode = /* 'capm' */ 0x6361706D +}; + +/* Enum BMDDeckControlEvent - DeckControl event */ + +typedef uint32_t BMDDeckControlEvent; +enum _BMDDeckControlEvent { + bmdDeckControlAbortedEvent = /* 'abte' */ 0x61627465, // This event is triggered when a capture or edit-to-tape operation is aborted. + + /* Export-To-Tape events */ + + bmdDeckControlPrepareForExportEvent = /* 'pfee' */ 0x70666565, // This event is triggered a few frames before reaching the in-point. IDeckLinkInput::StartScheduledPlayback should be called at this point. + bmdDeckControlExportCompleteEvent = /* 'exce' */ 0x65786365, // This event is triggered a few frames after reaching the out-point. At this point, it is safe to stop playback. Upon reception of this event the deck's control mode is set back to bmdDeckControlVTRControlMode. + + /* Capture events */ + + bmdDeckControlPrepareForCaptureEvent = /* 'pfce' */ 0x70666365, // This event is triggered a few frames before reaching the in-point. The serial timecode attached to IDeckLinkVideoInputFrames is now valid. + bmdDeckControlCaptureCompleteEvent = /* 'ccev' */ 0x63636576 // This event is triggered a few frames after reaching the out-point. Upon reception of this event the deck's control mode is set back to bmdDeckControlVTRControlMode. +}; + +/* Enum BMDDeckControlVTRControlState - VTR Control state */ + +typedef uint32_t BMDDeckControlVTRControlState; +enum _BMDDeckControlVTRControlState { + bmdDeckControlNotInVTRControlMode = /* 'nvcm' */ 0x6E76636D, + bmdDeckControlVTRControlPlaying = /* 'vtrp' */ 0x76747270, + bmdDeckControlVTRControlRecording = /* 'vtrr' */ 0x76747272, + bmdDeckControlVTRControlStill = /* 'vtra' */ 0x76747261, + bmdDeckControlVTRControlShuttleForward = /* 'vtsf' */ 0x76747366, + bmdDeckControlVTRControlShuttleReverse = /* 'vtsr' */ 0x76747372, + bmdDeckControlVTRControlJogForward = /* 'vtjf' */ 0x76746A66, + bmdDeckControlVTRControlJogReverse = /* 'vtjr' */ 0x76746A72, + bmdDeckControlVTRControlStopped = /* 'vtro' */ 0x7674726F +}; + +/* Enum BMDDeckControlStatusFlags - Deck Control status flags */ + +typedef uint32_t BMDDeckControlStatusFlags; +enum _BMDDeckControlStatusFlags { + bmdDeckControlStatusDeckConnected = 1 << 0, + bmdDeckControlStatusRemoteMode = 1 << 1, + bmdDeckControlStatusRecordInhibited = 1 << 2, + bmdDeckControlStatusCassetteOut = 1 << 3 +}; + +/* Enum BMDDeckControlExportModeOpsFlags - Export mode flags */ + +typedef uint32_t BMDDeckControlExportModeOpsFlags; +enum _BMDDeckControlExportModeOpsFlags { + bmdDeckControlExportModeInsertVideo = 1 << 0, + bmdDeckControlExportModeInsertAudio1 = 1 << 1, + bmdDeckControlExportModeInsertAudio2 = 1 << 2, + bmdDeckControlExportModeInsertAudio3 = 1 << 3, + bmdDeckControlExportModeInsertAudio4 = 1 << 4, + bmdDeckControlExportModeInsertAudio5 = 1 << 5, + bmdDeckControlExportModeInsertAudio6 = 1 << 6, + bmdDeckControlExportModeInsertAudio7 = 1 << 7, + bmdDeckControlExportModeInsertAudio8 = 1 << 8, + bmdDeckControlExportModeInsertAudio9 = 1 << 9, + bmdDeckControlExportModeInsertAudio10 = 1 << 10, + bmdDeckControlExportModeInsertAudio11 = 1 << 11, + bmdDeckControlExportModeInsertAudio12 = 1 << 12, + bmdDeckControlExportModeInsertTimeCode = 1 << 13, + bmdDeckControlExportModeInsertAssemble = 1 << 14, + bmdDeckControlExportModeInsertPreview = 1 << 15, + bmdDeckControlUseManualExport = 1 << 16 +}; + +/* Enum BMDDeckControlError - Deck Control error */ + +typedef uint32_t BMDDeckControlError; +enum _BMDDeckControlError { + bmdDeckControlNoError = /* 'noer' */ 0x6E6F6572, + bmdDeckControlModeError = /* 'moer' */ 0x6D6F6572, + bmdDeckControlMissedInPointError = /* 'mier' */ 0x6D696572, + bmdDeckControlDeckTimeoutError = /* 'dter' */ 0x64746572, + bmdDeckControlCommandFailedError = /* 'cfer' */ 0x63666572, + bmdDeckControlDeviceAlreadyOpenedError = /* 'dalo' */ 0x64616C6F, + bmdDeckControlFailedToOpenDeviceError = /* 'fder' */ 0x66646572, + bmdDeckControlInLocalModeError = /* 'lmer' */ 0x6C6D6572, + bmdDeckControlEndOfTapeError = /* 'eter' */ 0x65746572, + bmdDeckControlUserAbortError = /* 'uaer' */ 0x75616572, + bmdDeckControlNoTapeInDeckError = /* 'nter' */ 0x6E746572, + bmdDeckControlNoVideoFromCardError = /* 'nvfc' */ 0x6E766663, + bmdDeckControlNoCommunicationError = /* 'ncom' */ 0x6E636F6D, + bmdDeckControlBufferTooSmallError = /* 'btsm' */ 0x6274736D, + bmdDeckControlBadChecksumError = /* 'chks' */ 0x63686B73, + bmdDeckControlUnknownError = /* 'uner' */ 0x756E6572 +}; + +#if defined(__cplusplus) + +// Forward Declarations + +class IDeckLinkDeckControlStatusCallback; +class IDeckLinkDeckControl; + +/* Interface IDeckLinkDeckControlStatusCallback - Deck control state change callback. */ + +class BMD_PUBLIC IDeckLinkDeckControlStatusCallback : public IUnknown +{ +public: + virtual HRESULT TimecodeUpdate (/* in */ BMDTimecodeBCD currentTimecode) = 0; + virtual HRESULT VTRControlStateChanged (/* in */ BMDDeckControlVTRControlState newState, /* in */ BMDDeckControlError error) = 0; + virtual HRESULT DeckControlEventReceived (/* in */ BMDDeckControlEvent event, /* in */ BMDDeckControlError error) = 0; + virtual HRESULT DeckControlStatusChanged (/* in */ BMDDeckControlStatusFlags flags, /* in */ uint32_t mask) = 0; + +protected: + virtual ~IDeckLinkDeckControlStatusCallback () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkDeckControl - Deck Control main interface */ + +class BMD_PUBLIC IDeckLinkDeckControl : public IUnknown +{ +public: + virtual HRESULT Open (/* in */ BMDTimeScale timeScale, /* in */ BMDTimeValue timeValue, /* in */ bool timecodeIsDropFrame, /* out */ BMDDeckControlError* error) = 0; + virtual HRESULT Close (/* in */ bool standbyOn) = 0; + virtual HRESULT GetCurrentState (/* out */ BMDDeckControlMode* mode, /* out */ BMDDeckControlVTRControlState* vtrControlState, /* out */ BMDDeckControlStatusFlags* flags) = 0; + virtual HRESULT SetStandby (/* in */ bool standbyOn) = 0; + virtual HRESULT SendCommand (/* in */ uint8_t* inBuffer, /* in */ uint32_t inBufferSize, /* out */ uint8_t* outBuffer, /* out */ uint32_t* outDataSize, /* in */ uint32_t outBufferSize, /* out */ BMDDeckControlError* error) = 0; + virtual HRESULT Play (/* out */ BMDDeckControlError* error) = 0; + virtual HRESULT Stop (/* out */ BMDDeckControlError* error) = 0; + virtual HRESULT TogglePlayStop (/* out */ BMDDeckControlError* error) = 0; + virtual HRESULT Eject (/* out */ BMDDeckControlError* error) = 0; + virtual HRESULT GoToTimecode (/* in */ BMDTimecodeBCD timecode, /* out */ BMDDeckControlError* error) = 0; + virtual HRESULT FastForward (/* in */ bool viewTape, /* out */ BMDDeckControlError* error) = 0; + virtual HRESULT Rewind (/* in */ bool viewTape, /* out */ BMDDeckControlError* error) = 0; + virtual HRESULT StepForward (/* out */ BMDDeckControlError* error) = 0; + virtual HRESULT StepBack (/* out */ BMDDeckControlError* error) = 0; + virtual HRESULT Jog (/* in */ double rate, /* out */ BMDDeckControlError* error) = 0; + virtual HRESULT Shuttle (/* in */ double rate, /* out */ BMDDeckControlError* error) = 0; + virtual HRESULT GetTimecodeString (/* out */ const char** currentTimeCode, /* out */ BMDDeckControlError* error) = 0; + virtual HRESULT GetTimecode (/* out */ IDeckLinkTimecode** currentTimecode, /* out */ BMDDeckControlError* error) = 0; + virtual HRESULT GetTimecodeBCD (/* out */ BMDTimecodeBCD* currentTimecode, /* out */ BMDDeckControlError* error) = 0; + virtual HRESULT SetPreroll (/* in */ uint32_t prerollSeconds) = 0; + virtual HRESULT GetPreroll (/* out */ uint32_t* prerollSeconds) = 0; + virtual HRESULT SetExportOffset (/* in */ int32_t exportOffsetFields) = 0; + virtual HRESULT GetExportOffset (/* out */ int32_t* exportOffsetFields) = 0; + virtual HRESULT GetManualExportOffset (/* out */ int32_t* deckManualExportOffsetFields) = 0; + virtual HRESULT SetCaptureOffset (/* in */ int32_t captureOffsetFields) = 0; + virtual HRESULT GetCaptureOffset (/* out */ int32_t* captureOffsetFields) = 0; + virtual HRESULT StartExport (/* in */ BMDTimecodeBCD inTimecode, /* in */ BMDTimecodeBCD outTimecode, /* in */ BMDDeckControlExportModeOpsFlags exportModeOps, /* out */ BMDDeckControlError* error) = 0; + virtual HRESULT StartCapture (/* in */ bool useVITC, /* in */ BMDTimecodeBCD inTimecode, /* in */ BMDTimecodeBCD outTimecode, /* out */ BMDDeckControlError* error) = 0; + virtual HRESULT GetDeviceID (/* out */ uint16_t* deviceId, /* out */ BMDDeckControlError* error) = 0; + virtual HRESULT Abort (void) = 0; + virtual HRESULT CrashRecordStart (/* out */ BMDDeckControlError* error) = 0; + virtual HRESULT CrashRecordStop (/* out */ BMDDeckControlError* error) = 0; + virtual HRESULT SetCallback (/* in */ IDeckLinkDeckControlStatusCallback* callback) = 0; + +protected: + virtual ~IDeckLinkDeckControl () {} // call Release method to drop reference count +}; + +/* Functions */ + +extern "C" { + + +} + + + +#endif /* defined(__cplusplus) */ +#endif /* defined(BMD_DECKLINKAPIDECKCONTROL_H) */ diff --git a/services/capture/sdk/DeckLinkAPIDiscovery.h b/services/capture/sdk/DeckLinkAPIDiscovery.h new file mode 100644 index 0000000..b519db8 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIDiscovery.h @@ -0,0 +1,83 @@ +/* -LICENSE-START- +** Copyright (c) 2026 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation covered by +** this license (the "Software") to use, reproduce, display, distribute, +** execute, and transmit the Software, and to prepare derivative works of the +** Software, and to permit third-parties to whom the Software is furnished to +** do so, all subject to the following: +** +** The copyright notices in the Software and this entire statement, including +** the above license grant, this restriction and the following disclaimer, +** must be included in all copies of the Software, in whole or in part, and +** all derivative works of the Software, unless such copies or derivative +** works are solely in the form of machine-executable object code generated by +** a source language processor. +** +** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +** IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** -LICENSE-END- +*/ + +/* + * -- AUTOMATICALLY GENERATED - DO NOT EDIT --- + */ + +#ifndef BMD_DECKLINKAPIDISCOVERY_H +#define BMD_DECKLINKAPIDISCOVERY_H + + +#ifndef BMD_CONST + #if defined(_MSC_VER) + #define BMD_CONST __declspec(selectany) static const + #else + #define BMD_CONST static const + #endif +#endif + +#ifndef BMD_PUBLIC + #define BMD_PUBLIC +#endif + +// Type Declarations + + +// Interface ID Declarations + +BMD_CONST REFIID IID_IDeckLink = /* C418FBDD-0587-48ED-8FE5-640F0A14AF91 */ { 0xC4,0x18,0xFB,0xDD,0x05,0x87,0x48,0xED,0x8F,0xE5,0x64,0x0F,0x0A,0x14,0xAF,0x91 }; + +#if defined(__cplusplus) + +// Forward Declarations + +class IDeckLink; + +/* Interface IDeckLink - Represents a DeckLink device */ + +class BMD_PUBLIC IDeckLink : public IUnknown +{ +public: + virtual HRESULT GetModelName (/* out */ const char** modelName) = 0; + virtual HRESULT GetDisplayName (/* out */ const char** displayName) = 0; + +protected: + virtual ~IDeckLink () {} // call Release method to drop reference count +}; + +/* Functions */ + +extern "C" { + + +} + + + +#endif /* defined(__cplusplus) */ +#endif /* defined(BMD_DECKLINKAPIDISCOVERY_H) */ diff --git a/services/capture/sdk/DeckLinkAPIDispatch.cpp b/services/capture/sdk/DeckLinkAPIDispatch.cpp new file mode 100644 index 0000000..ed54632 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIDispatch.cpp @@ -0,0 +1,188 @@ +/* -LICENSE-START- +** Copyright (c) 2009 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +**/ + +#include +#include +#include + +#include "DeckLinkAPI.h" + +#define kDeckLinkAPI_Name "libDeckLinkAPI.so" +#define KDeckLinkPreviewAPI_Name "libDeckLinkPreviewAPI.so" + +typedef IDeckLinkIterator* (*CreateIteratorFunc)(void); +typedef IDeckLinkAPIInformation* (*CreateAPIInformationFunc)(void); +typedef IDeckLinkGLScreenPreviewHelper* (*CreateOpenGLScreenPreviewHelperFunc)(void); +typedef IDeckLinkGLScreenPreviewHelper* (*CreateOpenGL3ScreenPreviewHelperFunc)(void); +typedef IDeckLinkVideoConversion* (*CreateVideoConversionInstanceFunc)(void); +typedef IDeckLinkDiscovery* (*CreateDeckLinkDiscoveryInstanceFunc)(void); +typedef IDeckLinkVideoFrameAncillaryPackets* (*CreateVideoFrameAncillaryPacketsInstanceFunc)(void); + +static pthread_once_t gDeckLinkOnceControl = PTHREAD_ONCE_INIT; +static pthread_once_t gPreviewOnceControl = PTHREAD_ONCE_INIT; + +static bool gLoadedDeckLinkAPI = false; + +static CreateIteratorFunc gCreateIteratorFunc = NULL; +static CreateAPIInformationFunc gCreateAPIInformationFunc = NULL; +static CreateOpenGLScreenPreviewHelperFunc gCreateOpenGLPreviewFunc = NULL; +static CreateOpenGL3ScreenPreviewHelperFunc gCreateOpenGL3PreviewFunc = NULL; +static CreateVideoConversionInstanceFunc gCreateVideoConversionFunc = NULL; +static CreateDeckLinkDiscoveryInstanceFunc gCreateDeckLinkDiscoveryFunc = NULL; +static CreateVideoFrameAncillaryPacketsInstanceFunc gCreateVideoFrameAncillaryPacketsFunc = NULL; + +static void InitDeckLinkAPI (void) +{ + void *libraryHandle; + + libraryHandle = dlopen(kDeckLinkAPI_Name, RTLD_NOW|RTLD_GLOBAL); + if (!libraryHandle) + { + fprintf(stderr, "%s\n", dlerror()); + return; + } + + gLoadedDeckLinkAPI = true; + + gCreateIteratorFunc = (CreateIteratorFunc)dlsym(libraryHandle, "CreateDeckLinkIteratorInstance_0004"); + if (!gCreateIteratorFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateAPIInformationFunc = (CreateAPIInformationFunc)dlsym(libraryHandle, "CreateDeckLinkAPIInformationInstance_0001"); + if (!gCreateAPIInformationFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateVideoConversionFunc = (CreateVideoConversionInstanceFunc)dlsym(libraryHandle, "CreateVideoConversionInstance_0003"); + if (!gCreateVideoConversionFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateDeckLinkDiscoveryFunc = (CreateDeckLinkDiscoveryInstanceFunc)dlsym(libraryHandle, "CreateDeckLinkDiscoveryInstance_0003"); + if (!gCreateDeckLinkDiscoveryFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateVideoFrameAncillaryPacketsFunc = (CreateVideoFrameAncillaryPacketsInstanceFunc)dlsym(libraryHandle, "CreateVideoFrameAncillaryPacketsInstance_0002"); + if (!gCreateVideoFrameAncillaryPacketsFunc) + fprintf(stderr, "%s\n", dlerror()); +} + +static void InitDeckLinkPreviewAPI (void) +{ + void *libraryHandle; + + libraryHandle = dlopen(KDeckLinkPreviewAPI_Name, RTLD_NOW|RTLD_GLOBAL); + if (!libraryHandle) + { + fprintf(stderr, "%s\n", dlerror()); + return; + } + gCreateOpenGLPreviewFunc = (CreateOpenGLScreenPreviewHelperFunc)dlsym(libraryHandle, "CreateOpenGLScreenPreviewHelper_0002"); + if (!gCreateOpenGLPreviewFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateOpenGL3PreviewFunc = (CreateOpenGL3ScreenPreviewHelperFunc)dlsym(libraryHandle, "CreateOpenGL3ScreenPreviewHelper_0002"); + if (!gCreateOpenGL3PreviewFunc) + fprintf(stderr, "%s\n", dlerror()); +} + +bool IsDeckLinkAPIPresent (void) +{ + // If the DeckLink API dynamic library was successfully loaded, return this knowledge to the caller + return gLoadedDeckLinkAPI; +} + +IDeckLinkIterator* CreateDeckLinkIteratorInstance (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateIteratorFunc == NULL) + return NULL; + return gCreateIteratorFunc(); +} + +IDeckLinkAPIInformation* CreateDeckLinkAPIInformationInstance (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateAPIInformationFunc == NULL) + return NULL; + return gCreateAPIInformationFunc(); +} + +IDeckLinkGLScreenPreviewHelper* CreateOpenGLScreenPreviewHelper (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + pthread_once(&gPreviewOnceControl, InitDeckLinkPreviewAPI); + + if (gCreateOpenGLPreviewFunc == NULL) + return NULL; + return gCreateOpenGLPreviewFunc(); +} + +IDeckLinkGLScreenPreviewHelper* CreateOpenGL3ScreenPreviewHelper (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + pthread_once(&gPreviewOnceControl, InitDeckLinkPreviewAPI); + + if (gCreateOpenGL3PreviewFunc == NULL) + return NULL; + return gCreateOpenGL3PreviewFunc(); +} + +IDeckLinkVideoConversion* CreateVideoConversionInstance (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateVideoConversionFunc == NULL) + return NULL; + return gCreateVideoConversionFunc(); +} + +IDeckLinkDiscovery* CreateDeckLinkDiscoveryInstance (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateDeckLinkDiscoveryFunc == NULL) + return NULL; + return gCreateDeckLinkDiscoveryFunc(); +} + +IDeckLinkVideoFrameAncillaryPackets* CreateVideoFrameAncillaryPacketsInstance (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateVideoFrameAncillaryPacketsFunc == NULL) + return NULL; + return gCreateVideoFrameAncillaryPacketsFunc(); +} diff --git a/services/capture/sdk/DeckLinkAPIDispatch_v10_11.cpp b/services/capture/sdk/DeckLinkAPIDispatch_v10_11.cpp new file mode 100644 index 0000000..7ef0f7e --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIDispatch_v10_11.cpp @@ -0,0 +1,173 @@ +/* -LICENSE-START- +** Copyright (c) 2019 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +**/ + +#include +#include +#include + +#include "DeckLinkAPI_v10_11.h" + +#define kDeckLinkAPI_Name "libDeckLinkAPI.so" +#define KDeckLinkPreviewAPI_Name "libDeckLinkPreviewAPI.so" + +typedef IDeckLinkIterator* (*CreateIteratorFunc)(void); +typedef IDeckLinkAPIInformation* (*CreateAPIInformationFunc)(void); +typedef IDeckLinkGLScreenPreviewHelper* (*CreateOpenGLScreenPreviewHelperFunc)(void); +typedef IDeckLinkVideoConversion* (*CreateVideoConversionInstanceFunc)(void); +typedef IDeckLinkDiscovery* (*CreateDeckLinkDiscoveryInstanceFunc)(void); +typedef IDeckLinkVideoFrameAncillaryPackets* (*CreateVideoFrameAncillaryPacketsInstanceFunc)(void); + +static pthread_once_t gDeckLinkOnceControl = PTHREAD_ONCE_INIT; +static pthread_once_t gPreviewOnceControl = PTHREAD_ONCE_INIT; + +static bool gLoadedDeckLinkAPI = false; + +static CreateIteratorFunc gCreateIteratorFunc = NULL; +static CreateAPIInformationFunc gCreateAPIInformationFunc = NULL; +static CreateOpenGLScreenPreviewHelperFunc gCreateOpenGLPreviewFunc = NULL; +static CreateVideoConversionInstanceFunc gCreateVideoConversionFunc = NULL; +static CreateDeckLinkDiscoveryInstanceFunc gCreateDeckLinkDiscoveryFunc = NULL; +static CreateVideoFrameAncillaryPacketsInstanceFunc gCreateVideoFrameAncillaryPacketsFunc = NULL; + +static void InitDeckLinkAPI (void) +{ + void *libraryHandle; + + libraryHandle = dlopen(kDeckLinkAPI_Name, RTLD_NOW|RTLD_GLOBAL); + if (!libraryHandle) + { + fprintf(stderr, "%s\n", dlerror()); + return; + } + + gLoadedDeckLinkAPI = true; + + gCreateIteratorFunc = (CreateIteratorFunc)dlsym(libraryHandle, "CreateDeckLinkIteratorInstance_0003"); + if (!gCreateIteratorFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateAPIInformationFunc = (CreateAPIInformationFunc)dlsym(libraryHandle, "CreateDeckLinkAPIInformationInstance_0001"); + if (!gCreateAPIInformationFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateVideoConversionFunc = (CreateVideoConversionInstanceFunc)dlsym(libraryHandle, "CreateVideoConversionInstance_0001"); + if (!gCreateVideoConversionFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateDeckLinkDiscoveryFunc = (CreateDeckLinkDiscoveryInstanceFunc)dlsym(libraryHandle, "CreateDeckLinkDiscoveryInstance_0002"); + if (!gCreateDeckLinkDiscoveryFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateVideoFrameAncillaryPacketsFunc = (CreateVideoFrameAncillaryPacketsInstanceFunc)dlsym(libraryHandle, "CreateVideoFrameAncillaryPacketsInstance_0001"); + if (!gCreateVideoFrameAncillaryPacketsFunc) + fprintf(stderr, "%s\n", dlerror()); +} + +static void InitDeckLinkPreviewAPI (void) +{ + void *libraryHandle; + + libraryHandle = dlopen(KDeckLinkPreviewAPI_Name, RTLD_NOW|RTLD_GLOBAL); + if (!libraryHandle) + { + fprintf(stderr, "%s\n", dlerror()); + return; + } + gCreateOpenGLPreviewFunc = (CreateOpenGLScreenPreviewHelperFunc)dlsym(libraryHandle, "CreateOpenGLScreenPreviewHelper_0001"); + if (!gCreateOpenGLPreviewFunc) + fprintf(stderr, "%s\n", dlerror()); +} + +bool IsDeckLinkAPIPresent_v10_11 (void) +{ + // If the DeckLink API dynamic library was successfully loaded, return this knowledge to the caller + return gLoadedDeckLinkAPI; +} + +IDeckLinkIterator* CreateDeckLinkIteratorInstance_v10_11 (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateIteratorFunc == NULL) + return NULL; + return gCreateIteratorFunc(); +} + +IDeckLinkAPIInformation* CreateDeckLinkAPIInformationInstance_v10_11 (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateAPIInformationFunc == NULL) + return NULL; + return gCreateAPIInformationFunc(); +} + +IDeckLinkGLScreenPreviewHelper* CreateOpenGLScreenPreviewHelper_v10_11 (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + pthread_once(&gPreviewOnceControl, InitDeckLinkPreviewAPI); + + if (gCreateOpenGLPreviewFunc == NULL) + return NULL; + return gCreateOpenGLPreviewFunc(); +} + +IDeckLinkVideoConversion* CreateVideoConversionInstance_v10_11 (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateVideoConversionFunc == NULL) + return NULL; + return gCreateVideoConversionFunc(); +} + +IDeckLinkDiscovery* CreateDeckLinkDiscoveryInstance_v10_11 (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateDeckLinkDiscoveryFunc == NULL) + return NULL; + return gCreateDeckLinkDiscoveryFunc(); +} + +IDeckLinkVideoFrameAncillaryPackets* CreateVideoFrameAncillaryPacketsInstance_v10_11 (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateVideoFrameAncillaryPacketsFunc == NULL) + return NULL; + return gCreateVideoFrameAncillaryPacketsFunc(); +} diff --git a/services/capture/sdk/DeckLinkAPIDispatch_v10_8.cpp b/services/capture/sdk/DeckLinkAPIDispatch_v10_8.cpp new file mode 100644 index 0000000..08286ad --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIDispatch_v10_8.cpp @@ -0,0 +1,159 @@ +/* -LICENSE-START- +** Copyright (c) 2009 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +**/ + +#include +#include +#include + +#include "DeckLinkAPI.h" + +#define kDeckLinkAPI_Name "libDeckLinkAPI.so" +#define KDeckLinkPreviewAPI_Name "libDeckLinkPreviewAPI.so" + +typedef IDeckLinkIterator* (*CreateIteratorFunc)(void); +typedef IDeckLinkAPIInformation* (*CreateAPIInformationFunc)(void); +typedef IDeckLinkGLScreenPreviewHelper* (*CreateOpenGLScreenPreviewHelperFunc)(void); +typedef IDeckLinkVideoConversion* (*CreateVideoConversionInstanceFunc)(void); +typedef IDeckLinkDiscovery* (*CreateDeckLinkDiscoveryInstanceFunc)(void); + +static pthread_once_t gDeckLinkOnceControl = PTHREAD_ONCE_INIT; +static pthread_once_t gPreviewOnceControl = PTHREAD_ONCE_INIT; + +static bool gLoadedDeckLinkAPI = false; + +static CreateIteratorFunc gCreateIteratorFunc = NULL; +static CreateAPIInformationFunc gCreateAPIInformationFunc = NULL; +static CreateOpenGLScreenPreviewHelperFunc gCreateOpenGLPreviewFunc = NULL; +static CreateVideoConversionInstanceFunc gCreateVideoConversionFunc = NULL; +static CreateDeckLinkDiscoveryInstanceFunc gCreateDeckLinkDiscoveryFunc = NULL; + +static void InitDeckLinkAPI(void) +{ + void *libraryHandle; + + libraryHandle = dlopen(kDeckLinkAPI_Name, RTLD_NOW | RTLD_GLOBAL); + if (!libraryHandle) + { + fprintf(stderr, "%s\n", dlerror()); + return; + } + + gLoadedDeckLinkAPI = true; + + gCreateIteratorFunc = (CreateIteratorFunc)dlsym(libraryHandle, "CreateDeckLinkIteratorInstance_0002"); + if (!gCreateIteratorFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateAPIInformationFunc = (CreateAPIInformationFunc)dlsym(libraryHandle, "CreateDeckLinkAPIInformationInstance_0001"); + if (!gCreateAPIInformationFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateVideoConversionFunc = (CreateVideoConversionInstanceFunc)dlsym(libraryHandle, "CreateVideoConversionInstance_0001"); + if (!gCreateVideoConversionFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateDeckLinkDiscoveryFunc = (CreateDeckLinkDiscoveryInstanceFunc)dlsym(libraryHandle, "CreateDeckLinkDiscoveryInstance_0001"); + if (!gCreateDeckLinkDiscoveryFunc) + fprintf(stderr, "%s\n", dlerror()); +} + +static void InitDeckLinkPreviewAPI(void) +{ + void *libraryHandle; + + libraryHandle = dlopen(KDeckLinkPreviewAPI_Name, RTLD_NOW | RTLD_GLOBAL); + if (!libraryHandle) + { + fprintf(stderr, "%s\n", dlerror()); + return; + } + gCreateOpenGLPreviewFunc = (CreateOpenGLScreenPreviewHelperFunc)dlsym(libraryHandle, "CreateOpenGLScreenPreviewHelper_0001"); + if (!gCreateOpenGLPreviewFunc) + fprintf(stderr, "%s\n", dlerror()); +} + +bool IsDeckLinkAPIPresent(void) +{ + // If the DeckLink API dynamic library was successfully loaded, return this knowledge to the caller + return gLoadedDeckLinkAPI; +} + +IDeckLinkIterator* CreateDeckLinkIteratorInstance(void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateIteratorFunc == NULL) + return NULL; + return gCreateIteratorFunc(); +} + +IDeckLinkAPIInformation* CreateDeckLinkAPIInformationInstance(void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateAPIInformationFunc == NULL) + return NULL; + return gCreateAPIInformationFunc(); +} + +IDeckLinkGLScreenPreviewHelper* CreateOpenGLScreenPreviewHelper(void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + pthread_once(&gPreviewOnceControl, InitDeckLinkPreviewAPI); + + if (gCreateOpenGLPreviewFunc == NULL) + return NULL; + return gCreateOpenGLPreviewFunc(); +} + +IDeckLinkVideoConversion* CreateVideoConversionInstance(void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateVideoConversionFunc == NULL) + return NULL; + return gCreateVideoConversionFunc(); +} + +IDeckLinkDiscovery* CreateDeckLinkDiscoveryInstance(void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateDeckLinkDiscoveryFunc == NULL) + return NULL; + return gCreateDeckLinkDiscoveryFunc(); +} diff --git a/services/capture/sdk/DeckLinkAPIDispatch_v14_2_1.cpp b/services/capture/sdk/DeckLinkAPIDispatch_v14_2_1.cpp new file mode 100644 index 0000000..7a65443 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIDispatch_v14_2_1.cpp @@ -0,0 +1,188 @@ +/* -LICENSE-START- +** Copyright (c) 2009 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit (“EULA”) available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +**/ + +#include +#include +#include + +#include "DeckLinkAPI_v14_2_1.h" + +#define kDeckLinkAPI_Name "libDeckLinkAPI.so" +#define KDeckLinkPreviewAPI_Name "libDeckLinkPreviewAPI.so" + +typedef IDeckLinkIterator* (*CreateIteratorFunc)(void); +typedef IDeckLinkAPIInformation* (*CreateAPIInformationFunc)(void); +typedef IDeckLinkGLScreenPreviewHelper_v14_2_1* (*CreateOpenGLScreenPreviewHelperFunc)(void); +typedef IDeckLinkGLScreenPreviewHelper_v14_2_1* (*CreateOpenGL3ScreenPreviewHelperFunc)(void); +typedef IDeckLinkVideoConversion_v14_2_1* (*CreateVideoConversionInstanceFunc)(void); +typedef IDeckLinkDiscovery* (*CreateDeckLinkDiscoveryInstanceFunc)(void); +typedef IDeckLinkVideoFrameAncillaryPackets* (*CreateVideoFrameAncillaryPacketsInstanceFunc)(void); + +static pthread_once_t gDeckLinkOnceControl = PTHREAD_ONCE_INIT; +static pthread_once_t gPreviewOnceControl = PTHREAD_ONCE_INIT; + +static bool gLoadedDeckLinkAPI = false; + +static CreateIteratorFunc gCreateIteratorFunc = NULL; +static CreateAPIInformationFunc gCreateAPIInformationFunc = NULL; +static CreateOpenGLScreenPreviewHelperFunc gCreateOpenGLPreviewFunc = NULL; +static CreateOpenGL3ScreenPreviewHelperFunc gCreateOpenGL3PreviewFunc = NULL; +static CreateVideoConversionInstanceFunc gCreateVideoConversionFunc = NULL; +static CreateDeckLinkDiscoveryInstanceFunc gCreateDeckLinkDiscoveryFunc = NULL; +static CreateVideoFrameAncillaryPacketsInstanceFunc gCreateVideoFrameAncillaryPacketsFunc = NULL; + +static void InitDeckLinkAPI (void) +{ + void *libraryHandle; + + libraryHandle = dlopen(kDeckLinkAPI_Name, RTLD_NOW|RTLD_GLOBAL); + if (!libraryHandle) + { + fprintf(stderr, "%s\n", dlerror()); + return; + } + + gLoadedDeckLinkAPI = true; + + gCreateIteratorFunc = (CreateIteratorFunc)dlsym(libraryHandle, "CreateDeckLinkIteratorInstance_0004"); + if (!gCreateIteratorFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateAPIInformationFunc = (CreateAPIInformationFunc)dlsym(libraryHandle, "CreateDeckLinkAPIInformationInstance_0001"); + if (!gCreateAPIInformationFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateVideoConversionFunc = (CreateVideoConversionInstanceFunc)dlsym(libraryHandle, "CreateVideoConversionInstance_0001"); + if (!gCreateVideoConversionFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateDeckLinkDiscoveryFunc = (CreateDeckLinkDiscoveryInstanceFunc)dlsym(libraryHandle, "CreateDeckLinkDiscoveryInstance_0003"); + if (!gCreateDeckLinkDiscoveryFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateVideoFrameAncillaryPacketsFunc = (CreateVideoFrameAncillaryPacketsInstanceFunc)dlsym(libraryHandle, "CreateVideoFrameAncillaryPacketsInstance_0001"); + if (!gCreateVideoFrameAncillaryPacketsFunc) + fprintf(stderr, "%s\n", dlerror()); +} + +static void InitDeckLinkPreviewAPI (void) +{ + void *libraryHandle; + + libraryHandle = dlopen(KDeckLinkPreviewAPI_Name, RTLD_NOW|RTLD_GLOBAL); + if (!libraryHandle) + { + fprintf(stderr, "%s\n", dlerror()); + return; + } + gCreateOpenGLPreviewFunc = (CreateOpenGLScreenPreviewHelperFunc)dlsym(libraryHandle, "CreateOpenGLScreenPreviewHelper_0001"); + if (!gCreateOpenGLPreviewFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateOpenGL3PreviewFunc = (CreateOpenGL3ScreenPreviewHelperFunc)dlsym(libraryHandle, "CreateOpenGL3ScreenPreviewHelper_0001"); + if (!gCreateOpenGL3PreviewFunc) + fprintf(stderr, "%s\n", dlerror()); +} + +bool IsDeckLinkAPIPresent_v14_2_1 (void) +{ + // If the DeckLink API dynamic library was successfully loaded, return this knowledge to the caller + return gLoadedDeckLinkAPI; +} + +IDeckLinkIterator* CreateDeckLinkIteratorInstance_v14_2_1 (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateIteratorFunc == NULL) + return NULL; + return gCreateIteratorFunc(); +} + +IDeckLinkAPIInformation* CreateDeckLinkAPIInformationInstance_v14_2_1 (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateAPIInformationFunc == NULL) + return NULL; + return gCreateAPIInformationFunc(); +} + +IDeckLinkGLScreenPreviewHelper_v14_2_1* CreateOpenGLScreenPreviewHelper_v14_2_1 (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + pthread_once(&gPreviewOnceControl, InitDeckLinkPreviewAPI); + + if (gCreateOpenGLPreviewFunc == NULL) + return NULL; + return gCreateOpenGLPreviewFunc(); +} + +IDeckLinkGLScreenPreviewHelper_v14_2_1* CreateOpenGL3ScreenPreviewHelper_v14_2_1 (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + pthread_once(&gPreviewOnceControl, InitDeckLinkPreviewAPI); + + if (gCreateOpenGL3PreviewFunc == NULL) + return NULL; + return gCreateOpenGL3PreviewFunc(); +} + +IDeckLinkVideoConversion_v14_2_1* CreateVideoConversionInstance_v14_2_1 (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateVideoConversionFunc == NULL) + return NULL; + return gCreateVideoConversionFunc(); +} + +IDeckLinkDiscovery* CreateDeckLinkDiscoveryInstance_v14_2_1 (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateDeckLinkDiscoveryFunc == NULL) + return NULL; + return gCreateDeckLinkDiscoveryFunc(); +} + +IDeckLinkVideoFrameAncillaryPackets* CreateVideoFrameAncillaryPacketsInstance_v14_2_1 (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateVideoFrameAncillaryPacketsFunc == NULL) + return NULL; + return gCreateVideoFrameAncillaryPacketsFunc(); +} diff --git a/services/capture/sdk/DeckLinkAPIDispatch_v15_2.cpp b/services/capture/sdk/DeckLinkAPIDispatch_v15_2.cpp new file mode 100644 index 0000000..a87a150 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIDispatch_v15_2.cpp @@ -0,0 +1,188 @@ +/* -LICENSE-START- +** Copyright (c) 2009 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +**/ + +#include +#include +#include + +#include "DeckLinkAPI_v15_2.h" + +#define kDeckLinkAPI_Name "libDeckLinkAPI.so" +#define KDeckLinkPreviewAPI_Name "libDeckLinkPreviewAPI.so" + +typedef IDeckLinkIterator* (*CreateIteratorFunc)(void); +typedef IDeckLinkAPIInformation* (*CreateAPIInformationFunc)(void); +typedef IDeckLinkGLScreenPreviewHelper* (*CreateOpenGLScreenPreviewHelperFunc)(void); +typedef IDeckLinkGLScreenPreviewHelper* (*CreateOpenGL3ScreenPreviewHelperFunc)(void); +typedef IDeckLinkVideoConversion* (*CreateVideoConversionInstanceFunc)(void); +typedef IDeckLinkDiscovery* (*CreateDeckLinkDiscoveryInstanceFunc)(void); +typedef IDeckLinkVideoFrameAncillaryPackets_v15_2* (*CreateVideoFrameAncillaryPacketsInstanceFunc)(void); + +static pthread_once_t gDeckLinkOnceControl = PTHREAD_ONCE_INIT; +static pthread_once_t gPreviewOnceControl = PTHREAD_ONCE_INIT; + +static bool gLoadedDeckLinkAPI = false; + +static CreateIteratorFunc gCreateIteratorFunc = NULL; +static CreateAPIInformationFunc gCreateAPIInformationFunc = NULL; +static CreateOpenGLScreenPreviewHelperFunc gCreateOpenGLPreviewFunc = NULL; +static CreateOpenGL3ScreenPreviewHelperFunc gCreateOpenGL3PreviewFunc = NULL; +static CreateVideoConversionInstanceFunc gCreateVideoConversionFunc = NULL; +static CreateDeckLinkDiscoveryInstanceFunc gCreateDeckLinkDiscoveryFunc = NULL; +static CreateVideoFrameAncillaryPacketsInstanceFunc gCreateVideoFrameAncillaryPacketsFunc = NULL; + +static void InitDeckLinkAPI (void) +{ + void *libraryHandle; + + libraryHandle = dlopen(kDeckLinkAPI_Name, RTLD_NOW|RTLD_GLOBAL); + if (!libraryHandle) + { + fprintf(stderr, "%s\n", dlerror()); + return; + } + + gLoadedDeckLinkAPI = true; + + gCreateIteratorFunc = (CreateIteratorFunc)dlsym(libraryHandle, "CreateDeckLinkIteratorInstance_0004"); + if (!gCreateIteratorFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateAPIInformationFunc = (CreateAPIInformationFunc)dlsym(libraryHandle, "CreateDeckLinkAPIInformationInstance_0001"); + if (!gCreateAPIInformationFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateVideoConversionFunc = (CreateVideoConversionInstanceFunc)dlsym(libraryHandle, "CreateVideoConversionInstance_0002"); + if (!gCreateVideoConversionFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateDeckLinkDiscoveryFunc = (CreateDeckLinkDiscoveryInstanceFunc)dlsym(libraryHandle, "CreateDeckLinkDiscoveryInstance_0003"); + if (!gCreateDeckLinkDiscoveryFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateVideoFrameAncillaryPacketsFunc = (CreateVideoFrameAncillaryPacketsInstanceFunc)dlsym(libraryHandle, "CreateVideoFrameAncillaryPacketsInstance_0001"); + if (!gCreateVideoFrameAncillaryPacketsFunc) + fprintf(stderr, "%s\n", dlerror()); +} + +static void InitDeckLinkPreviewAPI (void) +{ + void *libraryHandle; + + libraryHandle = dlopen(KDeckLinkPreviewAPI_Name, RTLD_NOW|RTLD_GLOBAL); + if (!libraryHandle) + { + fprintf(stderr, "%s\n", dlerror()); + return; + } + gCreateOpenGLPreviewFunc = (CreateOpenGLScreenPreviewHelperFunc)dlsym(libraryHandle, "CreateOpenGLScreenPreviewHelper_0002"); + if (!gCreateOpenGLPreviewFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateOpenGL3PreviewFunc = (CreateOpenGL3ScreenPreviewHelperFunc)dlsym(libraryHandle, "CreateOpenGL3ScreenPreviewHelper_0002"); + if (!gCreateOpenGL3PreviewFunc) + fprintf(stderr, "%s\n", dlerror()); +} + +bool IsDeckLinkAPIPresent_v15_2 (void) +{ + // If the DeckLink API dynamic library was successfully loaded, return this knowledge to the caller + return gLoadedDeckLinkAPI; +} + +IDeckLinkIterator* CreateDeckLinkIteratorInstance (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateIteratorFunc == NULL) + return NULL; + return gCreateIteratorFunc(); +} + +IDeckLinkAPIInformation* CreateDeckLinkAPIInformationInstance (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateAPIInformationFunc == NULL) + return NULL; + return gCreateAPIInformationFunc(); +} + +IDeckLinkGLScreenPreviewHelper* CreateOpenGLScreenPreviewHelper (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + pthread_once(&gPreviewOnceControl, InitDeckLinkPreviewAPI); + + if (gCreateOpenGLPreviewFunc == NULL) + return NULL; + return gCreateOpenGLPreviewFunc(); +} + +IDeckLinkGLScreenPreviewHelper* CreateOpenGL3ScreenPreviewHelper (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + pthread_once(&gPreviewOnceControl, InitDeckLinkPreviewAPI); + + if (gCreateOpenGL3PreviewFunc == NULL) + return NULL; + return gCreateOpenGL3PreviewFunc(); +} + +IDeckLinkVideoConversion* CreateVideoConversionInstance (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateVideoConversionFunc == NULL) + return NULL; + return gCreateVideoConversionFunc(); +} + +IDeckLinkDiscovery* CreateDeckLinkDiscoveryInstance (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateDeckLinkDiscoveryFunc == NULL) + return NULL; + return gCreateDeckLinkDiscoveryFunc(); +} + +IDeckLinkVideoFrameAncillaryPackets_v15_2* CreateVideoFrameAncillaryPacketsInstance_v15_2 (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateVideoFrameAncillaryPacketsFunc == NULL) + return NULL; + return gCreateVideoFrameAncillaryPacketsFunc(); +} diff --git a/services/capture/sdk/DeckLinkAPIDispatch_v15_3_1.cpp b/services/capture/sdk/DeckLinkAPIDispatch_v15_3_1.cpp new file mode 100644 index 0000000..f780f5b --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIDispatch_v15_3_1.cpp @@ -0,0 +1,188 @@ +/* -LICENSE-START- +** Copyright (c) 2009 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +**/ + +#include +#include +#include + +#include "DeckLinkAPI_v15_3_1.h" + +#define kDeckLinkAPI_Name "libDeckLinkAPI.so" +#define KDeckLinkPreviewAPI_Name "libDeckLinkPreviewAPI.so" + +typedef IDeckLinkIterator* (*CreateIteratorFunc)(void); +typedef IDeckLinkAPIInformation* (*CreateAPIInformationFunc)(void); +typedef IDeckLinkGLScreenPreviewHelper* (*CreateOpenGLScreenPreviewHelperFunc)(void); +typedef IDeckLinkGLScreenPreviewHelper* (*CreateOpenGL3ScreenPreviewHelperFunc)(void); +typedef IDeckLinkVideoConversion_v15_3_1* (*CreateVideoConversionInstanceFunc)(void); +typedef IDeckLinkDiscovery* (*CreateDeckLinkDiscoveryInstanceFunc)(void); +typedef IDeckLinkVideoFrameAncillaryPackets* (*CreateVideoFrameAncillaryPacketsInstanceFunc)(void); + +static pthread_once_t gDeckLinkOnceControl = PTHREAD_ONCE_INIT; +static pthread_once_t gPreviewOnceControl = PTHREAD_ONCE_INIT; + +static bool gLoadedDeckLinkAPI = false; + +static CreateIteratorFunc gCreateIteratorFunc = NULL; +static CreateAPIInformationFunc gCreateAPIInformationFunc = NULL; +static CreateOpenGLScreenPreviewHelperFunc gCreateOpenGLPreviewFunc = NULL; +static CreateOpenGL3ScreenPreviewHelperFunc gCreateOpenGL3PreviewFunc = NULL; +static CreateVideoConversionInstanceFunc gCreateVideoConversionFunc = NULL; +static CreateDeckLinkDiscoveryInstanceFunc gCreateDeckLinkDiscoveryFunc = NULL; +static CreateVideoFrameAncillaryPacketsInstanceFunc gCreateVideoFrameAncillaryPacketsFunc = NULL; + +static void InitDeckLinkAPI (void) +{ + void *libraryHandle; + + libraryHandle = dlopen(kDeckLinkAPI_Name, RTLD_NOW|RTLD_GLOBAL); + if (!libraryHandle) + { + fprintf(stderr, "%s\n", dlerror()); + return; + } + + gLoadedDeckLinkAPI = true; + + gCreateIteratorFunc = (CreateIteratorFunc)dlsym(libraryHandle, "CreateDeckLinkIteratorInstance_0004"); + if (!gCreateIteratorFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateAPIInformationFunc = (CreateAPIInformationFunc)dlsym(libraryHandle, "CreateDeckLinkAPIInformationInstance_0001"); + if (!gCreateAPIInformationFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateVideoConversionFunc = (CreateVideoConversionInstanceFunc)dlsym(libraryHandle, "CreateVideoConversionInstance_0002"); + if (!gCreateVideoConversionFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateDeckLinkDiscoveryFunc = (CreateDeckLinkDiscoveryInstanceFunc)dlsym(libraryHandle, "CreateDeckLinkDiscoveryInstance_0003"); + if (!gCreateDeckLinkDiscoveryFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateVideoFrameAncillaryPacketsFunc = (CreateVideoFrameAncillaryPacketsInstanceFunc)dlsym(libraryHandle, "CreateVideoFrameAncillaryPacketsInstance_0001"); + if (!gCreateVideoFrameAncillaryPacketsFunc) + fprintf(stderr, "%s\n", dlerror()); +} + +static void InitDeckLinkPreviewAPI (void) +{ + void *libraryHandle; + + libraryHandle = dlopen(KDeckLinkPreviewAPI_Name, RTLD_NOW|RTLD_GLOBAL); + if (!libraryHandle) + { + fprintf(stderr, "%s\n", dlerror()); + return; + } + gCreateOpenGLPreviewFunc = (CreateOpenGLScreenPreviewHelperFunc)dlsym(libraryHandle, "CreateOpenGLScreenPreviewHelper_0002"); + if (!gCreateOpenGLPreviewFunc) + fprintf(stderr, "%s\n", dlerror()); + gCreateOpenGL3PreviewFunc = (CreateOpenGL3ScreenPreviewHelperFunc)dlsym(libraryHandle, "CreateOpenGL3ScreenPreviewHelper_0002"); + if (!gCreateOpenGL3PreviewFunc) + fprintf(stderr, "%s\n", dlerror()); +} + +bool IsDeckLinkAPIPresent (void) +{ + // If the DeckLink API dynamic library was successfully loaded, return this knowledge to the caller + return gLoadedDeckLinkAPI; +} + +IDeckLinkIterator* CreateDeckLinkIteratorInstance_v15_3_1 (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateIteratorFunc == NULL) + return NULL; + return gCreateIteratorFunc(); +} + +IDeckLinkAPIInformation* CreateDeckLinkAPIInformationInstance_v15_3_1 (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateAPIInformationFunc == NULL) + return NULL; + return gCreateAPIInformationFunc(); +} + +IDeckLinkGLScreenPreviewHelper* CreateOpenGLScreenPreviewHelper_v15_3_1 (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + pthread_once(&gPreviewOnceControl, InitDeckLinkPreviewAPI); + + if (gCreateOpenGLPreviewFunc == NULL) + return NULL; + return gCreateOpenGLPreviewFunc(); +} + +IDeckLinkGLScreenPreviewHelper* CreateOpenGL3ScreenPreviewHelper_v15_3_1 (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + pthread_once(&gPreviewOnceControl, InitDeckLinkPreviewAPI); + + if (gCreateOpenGL3PreviewFunc == NULL) + return NULL; + return gCreateOpenGL3PreviewFunc(); +} + +IDeckLinkVideoConversion_v15_3_1* CreateVideoConversionInstance_v15_3_1 (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateVideoConversionFunc == NULL) + return NULL; + return gCreateVideoConversionFunc(); +} + +IDeckLinkDiscovery* CreateDeckLinkDiscoveryInstance_v15_3_1 (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateDeckLinkDiscoveryFunc == NULL) + return NULL; + return gCreateDeckLinkDiscoveryFunc(); +} + +IDeckLinkVideoFrameAncillaryPackets* CreateVideoFrameAncillaryPacketsInstance_v15_3_1 (void) +{ + pthread_once(&gDeckLinkOnceControl, InitDeckLinkAPI); + + if (gCreateVideoFrameAncillaryPacketsFunc == NULL) + return NULL; + return gCreateVideoFrameAncillaryPacketsFunc(); +} diff --git a/services/capture/sdk/DeckLinkAPIGLScreenPreview_v14_2_1.h b/services/capture/sdk/DeckLinkAPIGLScreenPreview_v14_2_1.h new file mode 100644 index 0000000..98f9e23 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIGLScreenPreview_v14_2_1.h @@ -0,0 +1,68 @@ +/* -LICENSE-START- +** Copyright (c) 2022 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit (“EULA”) available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPIGLSCREENPREVIEW_v14_2_1_H +#define BMD_DECKLINKAPIGLSCREENPREVIEW_v14_2_1_H + +#include "DeckLinkAPI.h" +#include "DeckLinkAPIVideoFrame_v14_2_1.h" + +// Type Declarations + +BMD_CONST REFIID IID_IDeckLinkGLScreenPreviewHelper_v14_2_1 = /* 504E2209-CAC7-4C1A-9FB4-C5BB6274D22F */ { 0x50, 0x4E, 0x22, 0x09, 0xCA, 0xC7, 0x4C, 0x1A, 0x9F, 0xB4, 0xC5, 0xBB, 0x62, 0x74, 0xD2, 0x2F }; + +/* Interface IDeckLinkGLScreenPreviewHelper - Created with CoCreateInstance on platforms with native COM support or from CreateOpenGLScreenPreviewHelper/CreateOpenGL3ScreenPreviewHelper on other platforms. */ + +class BMD_PUBLIC IDeckLinkGLScreenPreviewHelper_v14_2_1 : public IUnknown +{ +public: + + /* Methods must be called with OpenGL context set */ + + virtual HRESULT InitializeGL (void) = 0; + virtual HRESULT PaintGL (void) = 0; + virtual HRESULT SetFrame (/* in */ IDeckLinkVideoFrame_v14_2_1* theFrame) = 0; + virtual HRESULT Set3DPreviewFormat (/* in */ BMD3DPreviewFormat previewFormat) = 0; + +protected: + virtual ~IDeckLinkGLScreenPreviewHelper_v14_2_1 () {} // call Release method to drop reference count +}; + +#endif diff --git a/services/capture/sdk/DeckLinkAPIMemoryAllocator_v14_2_1.h b/services/capture/sdk/DeckLinkAPIMemoryAllocator_v14_2_1.h new file mode 100644 index 0000000..dc6fded --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIMemoryAllocator_v14_2_1.h @@ -0,0 +1,61 @@ +/* -LICENSE-START- +** Copyright (c) 2022 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit (“EULA”) available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPIMEMORYALLOCATOR_v14_2_1_H +#define BMD_DECKLINKAPIMEMORYALLOCATOR_v14_2_1_H + +#include "DeckLinkAPI.h" + +// Type Declarations + +BMD_CONST REFIID IID_IDeckLinkMemoryAllocator_v14_2_1 = /* B36EB6E7-9D29-4AA8-92EF-843B87A289E8 */ { 0xB3, 0x6E, 0xB6, 0xE7, 0x9D, 0x29, 0x4A, 0xA8, 0x92, 0xEF, 0x84, 0x3B, 0x87, 0xA2, 0x89, 0xE8 }; + +/* Interface IDeckLinkMemoryAllocator_v14_2_1 - Created with CoCreateInstance. */ + +class BMD_PUBLIC IDeckLinkMemoryAllocator_v14_2_1 : public IUnknown +{ +public: + virtual HRESULT AllocateBuffer (/* in */ uint32_t bufferSize, /* out */ void** allocatedBuffer) = 0; + virtual HRESULT ReleaseBuffer (/* in */ void* buffer) = 0; + virtual HRESULT Commit (void) = 0; + virtual HRESULT Decommit (void) = 0; +}; + +#endif diff --git a/services/capture/sdk/DeckLinkAPIMetalScreenPreview_v14_2_1.h b/services/capture/sdk/DeckLinkAPIMetalScreenPreview_v14_2_1.h new file mode 100644 index 0000000..928564d --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIMetalScreenPreview_v14_2_1.h @@ -0,0 +1,65 @@ +/* -LICENSE-START- +** Copyright (c) 2022 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit (“EULA”) available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPIMETALSCREENPREVIEW_v14_2_1_H +#define BMD_DECKLINKAPIMETALSCREENPREVIEW_v14_2_1_H + +#include "DeckLinkAPI.h" +#include "DeckLinkAPIVideoFrame_v14_2_1.h" + +// Type Declarations + +BMD_CONST REFIID IID_IDeckLinkMetalScreenPreviewHelper_v14_2_1 = /* 1AB252C5-DACB-4AE8-A58B-5320DE9CE373 */ { 0x1A, 0xB2, 0x52, 0xC5, 0xDA, 0xCB, 0x4A, 0xE8, 0xA5, 0x8B, 0x53, 0x20, 0xDE, 0x9C, 0xE3, 0x73 }; + +/* Interface IDeckLinkMetalScreenPreviewHelper - Created with CreateMetalScreenPreviewHelper(). */ + +class BMD_PUBLIC IDeckLinkMetalScreenPreviewHelper_v14_2_1 : public IUnknown +{ +public: + virtual HRESULT Initialize (/* in */ void* device) = 0; + virtual HRESULT Draw (/* in */ void* cmdBuffer, /* in */ void* renderPassDescriptor, /* in */ void* viewport) = 0; + virtual HRESULT SetFrame (/* in */ IDeckLinkVideoFrame_v14_2_1* theFrame) = 0; + virtual HRESULT Set3DPreviewFormat (/* in */ BMD3DPreviewFormat previewFormat) = 0; + +protected: + virtual ~IDeckLinkMetalScreenPreviewHelper_v14_2_1 () {} // call Release method to drop reference count +}; + +#endif diff --git a/services/capture/sdk/DeckLinkAPIModes.h b/services/capture/sdk/DeckLinkAPIModes.h new file mode 100644 index 0000000..2dec531 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIModes.h @@ -0,0 +1,291 @@ +/* -LICENSE-START- +** Copyright (c) 2026 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation covered by +** this license (the "Software") to use, reproduce, display, distribute, +** execute, and transmit the Software, and to prepare derivative works of the +** Software, and to permit third-parties to whom the Software is furnished to +** do so, all subject to the following: +** +** The copyright notices in the Software and this entire statement, including +** the above license grant, this restriction and the following disclaimer, +** must be included in all copies of the Software, in whole or in part, and +** all derivative works of the Software, unless such copies or derivative +** works are solely in the form of machine-executable object code generated by +** a source language processor. +** +** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +** IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** -LICENSE-END- +*/ + +/* + * -- AUTOMATICALLY GENERATED - DO NOT EDIT --- + */ + +#ifndef BMD_DECKLINKAPIMODES_H +#define BMD_DECKLINKAPIMODES_H + + +#ifndef BMD_CONST + #if defined(_MSC_VER) + #define BMD_CONST __declspec(selectany) static const + #else + #define BMD_CONST static const + #endif +#endif + +#ifndef BMD_PUBLIC + #define BMD_PUBLIC +#endif + +// Type Declarations + + +// Interface ID Declarations + +BMD_CONST REFIID IID_IDeckLinkDisplayModeIterator = /* 9C88499F-F601-4021-B80B-032E4EB41C35 */ { 0x9C,0x88,0x49,0x9F,0xF6,0x01,0x40,0x21,0xB8,0x0B,0x03,0x2E,0x4E,0xB4,0x1C,0x35 }; +BMD_CONST REFIID IID_IDeckLinkDisplayMode = /* 3EB2C1AB-0A3D-4523-A3AD-F40D7FB14E78 */ { 0x3E,0xB2,0xC1,0xAB,0x0A,0x3D,0x45,0x23,0xA3,0xAD,0xF4,0x0D,0x7F,0xB1,0x4E,0x78 }; + +/* Enum BMDDisplayMode - BMDDisplayMode enumerates the video modes supported. */ + +typedef uint32_t BMDDisplayMode; +enum _BMDDisplayMode { + + /* SD Modes */ + + bmdModeNTSC = /* 'ntsc' */ 0x6E747363, + bmdModeNTSC2398 = /* 'nt23' */ 0x6E743233, // 3:2 pulldown + bmdModePAL = /* 'pal ' */ 0x70616C20, + bmdModeNTSCp = /* 'ntsp' */ 0x6E747370, + bmdModePALp = /* 'palp' */ 0x70616C70, + + /* HD 1080 Modes */ + + bmdModeHD1080p2398 = /* '23ps' */ 0x32337073, + bmdModeHD1080p24 = /* '24ps' */ 0x32347073, + bmdModeHD1080p25 = /* 'Hp25' */ 0x48703235, + bmdModeHD1080p2997 = /* 'Hp29' */ 0x48703239, + bmdModeHD1080p30 = /* 'Hp30' */ 0x48703330, + bmdModeHD1080p4795 = /* 'Hp47' */ 0x48703437, + bmdModeHD1080p48 = /* 'Hp48' */ 0x48703438, + bmdModeHD1080p50 = /* 'Hp50' */ 0x48703530, + bmdModeHD1080p5994 = /* 'Hp59' */ 0x48703539, + bmdModeHD1080p6000 = /* 'Hp60' */ 0x48703630, // N.B. This _really_ is 60.00 Hz. + bmdModeHD1080p9590 = /* 'Hp95' */ 0x48703935, + bmdModeHD1080p96 = /* 'Hp96' */ 0x48703936, + bmdModeHD1080p100 = /* 'Hp10' */ 0x48703130, + bmdModeHD1080p11988 = /* 'Hp11' */ 0x48703131, + bmdModeHD1080p120 = /* 'Hp12' */ 0x48703132, + bmdModeHD1080i50 = /* 'Hi50' */ 0x48693530, + bmdModeHD1080i5994 = /* 'Hi59' */ 0x48693539, + bmdModeHD1080i6000 = /* 'Hi60' */ 0x48693630, // N.B. This _really_ is 60.00 Hz. + + /* HD 720 Modes */ + + bmdModeHD720p50 = /* 'hp50' */ 0x68703530, + bmdModeHD720p5994 = /* 'hp59' */ 0x68703539, + bmdModeHD720p60 = /* 'hp60' */ 0x68703630, + + /* 2K Modes */ + + bmdMode2k2398 = /* '2k23' */ 0x326B3233, + bmdMode2k24 = /* '2k24' */ 0x326B3234, + bmdMode2k25 = /* '2k25' */ 0x326B3235, + + /* 2K DCI Modes */ + + bmdMode2kDCI2398 = /* '2d23' */ 0x32643233, + bmdMode2kDCI24 = /* '2d24' */ 0x32643234, + bmdMode2kDCI25 = /* '2d25' */ 0x32643235, + bmdMode2kDCI2997 = /* '2d29' */ 0x32643239, + bmdMode2kDCI30 = /* '2d30' */ 0x32643330, + bmdMode2kDCI4795 = /* '2d47' */ 0x32643437, + bmdMode2kDCI48 = /* '2d48' */ 0x32643438, + bmdMode2kDCI50 = /* '2d50' */ 0x32643530, + bmdMode2kDCI5994 = /* '2d59' */ 0x32643539, + bmdMode2kDCI60 = /* '2d60' */ 0x32643630, + bmdMode2kDCI9590 = /* '2d95' */ 0x32643935, + bmdMode2kDCI96 = /* '2d96' */ 0x32643936, + bmdMode2kDCI100 = /* '2d10' */ 0x32643130, + bmdMode2kDCI11988 = /* '2d11' */ 0x32643131, + bmdMode2kDCI120 = /* '2d12' */ 0x32643132, + + /* 4K UHD Modes */ + + bmdMode4K2160p2398 = /* '4k23' */ 0x346B3233, + bmdMode4K2160p24 = /* '4k24' */ 0x346B3234, + bmdMode4K2160p25 = /* '4k25' */ 0x346B3235, + bmdMode4K2160p2997 = /* '4k29' */ 0x346B3239, + bmdMode4K2160p30 = /* '4k30' */ 0x346B3330, + bmdMode4K2160p4795 = /* '4k47' */ 0x346B3437, + bmdMode4K2160p48 = /* '4k48' */ 0x346B3438, + bmdMode4K2160p50 = /* '4k50' */ 0x346B3530, + bmdMode4K2160p5994 = /* '4k59' */ 0x346B3539, + bmdMode4K2160p60 = /* '4k60' */ 0x346B3630, + bmdMode4K2160p9590 = /* '4k95' */ 0x346B3935, + bmdMode4K2160p96 = /* '4k96' */ 0x346B3936, + bmdMode4K2160p100 = /* '4k10' */ 0x346B3130, + bmdMode4K2160p11988 = /* '4k11' */ 0x346B3131, + bmdMode4K2160p120 = /* '4k12' */ 0x346B3132, + + /* 4K DCI Modes */ + + bmdMode4kDCI2398 = /* '4d23' */ 0x34643233, + bmdMode4kDCI24 = /* '4d24' */ 0x34643234, + bmdMode4kDCI25 = /* '4d25' */ 0x34643235, + bmdMode4kDCI2997 = /* '4d29' */ 0x34643239, + bmdMode4kDCI30 = /* '4d30' */ 0x34643330, + bmdMode4kDCI4795 = /* '4d47' */ 0x34643437, + bmdMode4kDCI48 = /* '4d48' */ 0x34643438, + bmdMode4kDCI50 = /* '4d50' */ 0x34643530, + bmdMode4kDCI5994 = /* '4d59' */ 0x34643539, + bmdMode4kDCI60 = /* '4d60' */ 0x34643630, + bmdMode4kDCI9590 = /* '4d95' */ 0x34643935, + bmdMode4kDCI96 = /* '4d96' */ 0x34643936, + bmdMode4kDCI100 = /* '4d10' */ 0x34643130, + bmdMode4kDCI11988 = /* '4d11' */ 0x34643131, + bmdMode4kDCI120 = /* '4d12' */ 0x34643132, + + /* 8K UHD Modes */ + + bmdMode8K4320p2398 = /* '8k23' */ 0x386B3233, + bmdMode8K4320p24 = /* '8k24' */ 0x386B3234, + bmdMode8K4320p25 = /* '8k25' */ 0x386B3235, + bmdMode8K4320p2997 = /* '8k29' */ 0x386B3239, + bmdMode8K4320p30 = /* '8k30' */ 0x386B3330, + bmdMode8K4320p4795 = /* '8k47' */ 0x386B3437, + bmdMode8K4320p48 = /* '8k48' */ 0x386B3438, + bmdMode8K4320p50 = /* '8k50' */ 0x386B3530, + bmdMode8K4320p5994 = /* '8k59' */ 0x386B3539, + bmdMode8K4320p60 = /* '8k60' */ 0x386B3630, + + /* 8K DCI Modes */ + + bmdMode8kDCI2398 = /* '8d23' */ 0x38643233, + bmdMode8kDCI24 = /* '8d24' */ 0x38643234, + bmdMode8kDCI25 = /* '8d25' */ 0x38643235, + bmdMode8kDCI2997 = /* '8d29' */ 0x38643239, + bmdMode8kDCI30 = /* '8d30' */ 0x38643330, + bmdMode8kDCI4795 = /* '8d47' */ 0x38643437, + bmdMode8kDCI48 = /* '8d48' */ 0x38643438, + bmdMode8kDCI50 = /* '8d50' */ 0x38643530, + bmdMode8kDCI5994 = /* '8d59' */ 0x38643539, + bmdMode8kDCI60 = /* '8d60' */ 0x38643630, + + /* PC Modes */ + + bmdMode640x480p60 = /* 'vga6' */ 0x76676136, + bmdMode800x600p60 = /* 'svg6' */ 0x73766736, + bmdMode1440x900p50 = /* 'wxg5' */ 0x77786735, + bmdMode1440x900p60 = /* 'wxg6' */ 0x77786736, + bmdMode1440x1080p50 = /* 'sxg5' */ 0x73786735, + bmdMode1440x1080p60 = /* 'sxg6' */ 0x73786736, + bmdMode1600x1200p50 = /* 'uxg5' */ 0x75786735, + bmdMode1600x1200p60 = /* 'uxg6' */ 0x75786736, + bmdMode1920x1200p50 = /* 'wux5' */ 0x77757835, + bmdMode1920x1200p60 = /* 'wux6' */ 0x77757836, + bmdMode1920x1440p50 = /* '1945' */ 0x31393435, + bmdMode1920x1440p60 = /* '1946' */ 0x31393436, + bmdMode2560x1440p50 = /* 'wqh5' */ 0x77716835, + bmdMode2560x1440p60 = /* 'wqh6' */ 0x77716836, + bmdMode2560x1600p50 = /* 'wqx5' */ 0x77717835, + bmdMode2560x1600p60 = /* 'wqx6' */ 0x77717836, + bmdModeUnknown = /* 'iunk' */ 0x69756E6B +}; + +/* Enum BMDFieldDominance - BMDFieldDominance enumerates settings applicable to video fields. */ + +typedef uint32_t BMDFieldDominance; +enum _BMDFieldDominance { + bmdUnknownFieldDominance = 0, + bmdLowerFieldFirst = /* 'lowr' */ 0x6C6F7772, + bmdUpperFieldFirst = /* 'uppr' */ 0x75707072, + bmdProgressiveFrame = /* 'prog' */ 0x70726F67, + bmdProgressiveSegmentedFrame = /* 'psf ' */ 0x70736620 +}; + +/* Enum BMDPixelFormat - Video pixel formats supported for output/input */ + +typedef uint32_t BMDPixelFormat; +enum _BMDPixelFormat { + bmdFormatUnspecified = 0, + bmdFormat8BitYUV = /* '2vuy' */ 0x32767579, + bmdFormat10BitYUV = /* 'v210' */ 0x76323130, + bmdFormat10BitYUVA = /* 'Ay10' */ 0x41793130, // Big-endian YUVA 10 bit per component with SMPTE video levels (64-940) for YUV but full range alpha + bmdFormat8BitARGB = 32, + bmdFormat8BitBGRA = /* 'BGRA' */ 0x42475241, + bmdFormat10BitRGB = /* 'r210' */ 0x72323130, // Big-endian RGB 10-bit per component with SMPTE video levels (64-940). Packed as 2:10:10:10 + bmdFormat12BitRGB = /* 'R12B' */ 0x52313242, // Big-endian RGB 12-bit per component with full range (0-4095). Packed as 12-bit per component + bmdFormat12BitRGBLE = /* 'R12L' */ 0x5231324C, // Little-endian RGB 12-bit per component with full range (0-4095). Packed as 12-bit per component + bmdFormat10BitRGBXLE = /* 'R10l' */ 0x5231306C, // Little-endian 10-bit RGB with SMPTE video levels (64-940) + bmdFormat10BitRGBX = /* 'R10b' */ 0x52313062, // Big-endian 10-bit RGB with SMPTE video levels (64-940) + + /* Formats supported only by devices that can be queried for an IDeckLinkEncoderInput */ + + bmdFormatH265 = /* 'hev1' */ 0x68657631, + bmdFormatDNxHR = /* 'AVdh' */ 0x41566468 +}; + +/* Enum BMDDisplayModeFlags - Flags to describe the characteristics of an IDeckLinkDisplayMode. */ + +typedef uint32_t BMDDisplayModeFlags; +enum _BMDDisplayModeFlags { + bmdDisplayModeSupports3D = 1 << 0, + bmdDisplayModeColorspaceRec601 = 1 << 1, + bmdDisplayModeColorspaceRec709 = 1 << 2, + bmdDisplayModeColorspaceRec2020 = 1 << 3 +}; + +#if defined(__cplusplus) + +// Forward Declarations + +class IDeckLinkDisplayModeIterator; +class IDeckLinkDisplayMode; + +/* Interface IDeckLinkDisplayModeIterator - Enumerates over supported input/output display modes. */ + +class BMD_PUBLIC IDeckLinkDisplayModeIterator : public IUnknown +{ +public: + virtual HRESULT Next (/* out */ IDeckLinkDisplayMode** deckLinkDisplayMode) = 0; + +protected: + virtual ~IDeckLinkDisplayModeIterator () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkDisplayMode - Represents a display mode */ + +class BMD_PUBLIC IDeckLinkDisplayMode : public IUnknown +{ +public: + virtual HRESULT GetName (/* out */ const char** name) = 0; + virtual BMDDisplayMode GetDisplayMode (void) = 0; + virtual long GetWidth (void) = 0; + virtual long GetHeight (void) = 0; + virtual HRESULT GetFrameRate (/* out */ BMDTimeValue* frameDuration, /* out */ BMDTimeScale* timeScale) = 0; + virtual BMDFieldDominance GetFieldDominance (void) = 0; + virtual BMDDisplayModeFlags GetFlags (void) = 0; + +protected: + virtual ~IDeckLinkDisplayMode () {} // call Release method to drop reference count +}; + +/* Functions */ + +extern "C" { + + +} + + + +#endif /* defined(__cplusplus) */ +#endif /* defined(BMD_DECKLINKAPIMODES_H) */ diff --git a/services/capture/sdk/DeckLinkAPIScreenPreviewCallback_v14_2_1.h b/services/capture/sdk/DeckLinkAPIScreenPreviewCallback_v14_2_1.h new file mode 100644 index 0000000..9ab8f7d --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIScreenPreviewCallback_v14_2_1.h @@ -0,0 +1,62 @@ +/* -LICENSE-START- +** Copyright (c) 2022 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit (“EULA”) available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPISCREENPREVIEWCALLBACK_v14_2_1_H +#define BMD_DECKLINKAPISCREENPREVIEWCALLBACK_v14_2_1_H + +#include "DeckLinkAPI.h" +#include "DeckLinkAPIVideoFrame_v14_2_1.h" + +// Type Declarations + +BMD_CONST REFIID IID_IDeckLinkScreenPreviewCallback_v14_2_1 = /* B1D3F49A-85FE-4C5D-95C8-0B5D5DCCD438 */ { 0xB1, 0xD3, 0xF4, 0x9A, 0x85, 0xFE, 0x4C, 0x5D, 0x95, 0xC8, 0x0B, 0x5D, 0x5D, 0xCC, 0xD4, 0x38 }; + +/* Interface IDeckLinkScreenPreviewCallback_v14_2_1 - Screen preview callback */ + +class BMD_PUBLIC IDeckLinkScreenPreviewCallback_v14_2_1 : public IUnknown +{ +public: + virtual HRESULT DrawFrame (/* in */ IDeckLinkVideoFrame_v14_2_1* theFrame) = 0; + +protected: + virtual ~IDeckLinkScreenPreviewCallback_v14_2_1 () {} // call Release method to drop reference count +}; + +#endif /* defined(BMD_DECKLINKAPISCREENPREVIEWCALLBACK_v14_2_1_H) */ diff --git a/services/capture/sdk/DeckLinkAPITypes.h b/services/capture/sdk/DeckLinkAPITypes.h new file mode 100644 index 0000000..57a8d91 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPITypes.h @@ -0,0 +1,140 @@ +/* -LICENSE-START- +** Copyright (c) 2026 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation covered by +** this license (the "Software") to use, reproduce, display, distribute, +** execute, and transmit the Software, and to prepare derivative works of the +** Software, and to permit third-parties to whom the Software is furnished to +** do so, all subject to the following: +** +** The copyright notices in the Software and this entire statement, including +** the above license grant, this restriction and the following disclaimer, +** must be included in all copies of the Software, in whole or in part, and +** all derivative works of the Software, unless such copies or derivative +** works are solely in the form of machine-executable object code generated by +** a source language processor. +** +** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +** IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** -LICENSE-END- +*/ + +/* + * -- AUTOMATICALLY GENERATED - DO NOT EDIT --- + */ + +#ifndef BMD_DECKLINKAPITYPES_H +#define BMD_DECKLINKAPITYPES_H + + +#ifndef BMD_CONST + #if defined(_MSC_VER) + #define BMD_CONST __declspec(selectany) static const + #else + #define BMD_CONST static const + #endif +#endif + +#ifndef BMD_PUBLIC + #define BMD_PUBLIC +#endif + +// Type Declarations + +typedef int64_t BMDTimeValue; +typedef int64_t BMDTimeScale; +typedef uint32_t BMDTimecodeBCD; +typedef uint32_t BMDTimecodeUserBits; +typedef int64_t BMDIPFlowID; + +// Interface ID Declarations + +BMD_CONST REFIID IID_IDeckLinkTimecode = /* BC6CFBD3-8317-4325-AC1C-1216391E9340 */ { 0xBC,0x6C,0xFB,0xD3,0x83,0x17,0x43,0x25,0xAC,0x1C,0x12,0x16,0x39,0x1E,0x93,0x40 }; + +/* Enum BMDTimecodeFlags - Timecode flags */ + +typedef uint32_t BMDTimecodeFlags; +enum _BMDTimecodeFlags { + bmdTimecodeFlagDefault = 0, + bmdTimecodeIsDropFrame = 1 << 0, + bmdTimecodeFieldMark = 1 << 1, + bmdTimecodeColorFrame = 1 << 2, + bmdTimecodeEmbedRecordingTrigger = 1 << 3, // On SDI recording trigger utilises a user-bit. + bmdTimecodeRecordingTriggered = 1 << 4 +}; + +/* Enum BMDVideoConnection - Video connection types */ + +typedef uint32_t BMDVideoConnection; +enum _BMDVideoConnection { + bmdVideoConnectionUnspecified = 0, + bmdVideoConnectionSDI = 1 << 0, + bmdVideoConnectionHDMI = 1 << 1, + bmdVideoConnectionOpticalSDI = 1 << 2, + bmdVideoConnectionComponent = 1 << 3, + bmdVideoConnectionComposite = 1 << 4, + bmdVideoConnectionSVideo = 1 << 5, + bmdVideoConnectionEthernet = 1 << 6, + bmdVideoConnectionOpticalEthernet = 1 << 7, + bmdVideoConnectionInternal = 1 << 8 +}; + +/* Enum BMDAudioConnection - Audio connection types */ + +typedef uint32_t BMDAudioConnection; +enum _BMDAudioConnection { + bmdAudioConnectionEmbedded = 1 << 0, + bmdAudioConnectionAESEBU = 1 << 1, + bmdAudioConnectionAnalog = 1 << 2, + bmdAudioConnectionAnalogXLR = 1 << 3, + bmdAudioConnectionAnalogRCA = 1 << 4, + bmdAudioConnectionMicrophone = 1 << 5, + bmdAudioConnectionHeadphones = 1 << 6 +}; + +/* Enum BMDDeckControlConnection - Deck control connections */ + +typedef uint32_t BMDDeckControlConnection; +enum _BMDDeckControlConnection { + bmdDeckControlConnectionRS422Remote1 = 1 << 0, + bmdDeckControlConnectionRS422Remote2 = 1 << 1 +}; + +#if defined(__cplusplus) + +// Forward Declarations + +class IDeckLinkTimecode; + +/* Interface IDeckLinkTimecode - Used for video frame timecode representation. */ + +class BMD_PUBLIC IDeckLinkTimecode : public IUnknown +{ +public: + virtual BMDTimecodeBCD GetBCD (void) = 0; + virtual HRESULT GetComponents (/* out */ uint8_t* hours, /* out */ uint8_t* minutes, /* out */ uint8_t* seconds, /* out */ uint8_t* frames) = 0; + virtual HRESULT GetString (/* out */ const char** timecode) = 0; + virtual BMDTimecodeFlags GetFlags (void) = 0; + virtual HRESULT GetTimecodeUserBits (/* out */ BMDTimecodeUserBits* userBits) = 0; + +protected: + virtual ~IDeckLinkTimecode () {} // call Release method to drop reference count +}; + +/* Functions */ + +extern "C" { + + +} + + + +#endif /* defined(__cplusplus) */ +#endif /* defined(BMD_DECKLINKAPITYPES_H) */ diff --git a/services/capture/sdk/DeckLinkAPIVersion.h b/services/capture/sdk/DeckLinkAPIVersion.h new file mode 100644 index 0000000..49e2ff1 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIVersion.h @@ -0,0 +1,50 @@ +/* -LICENSE-START- + * ** Copyright (c) 2014 Blackmagic Design + * ** + * ** Permission is hereby granted, free of charge, to any person or organization + * ** obtaining a copy of the software and accompanying documentation (the + * ** "Software") to use, reproduce, display, distribute, sub-license, execute, + * ** and transmit the Software, and to prepare derivative works of the Software, + * ** and to permit third-parties to whom the Software is furnished to do so, in + * ** accordance with: + * ** + * ** (1) if the Software is obtained from Blackmagic Design, the End User License + * ** Agreement for the Software Development Kit ("EULA") available at + * ** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or + * ** + * ** (2) if the Software is obtained from any third party, such licensing terms + * ** as notified by that third party, + * ** + * ** and all subject to the following: + * ** + * ** (3) the copyright notices in the Software and this entire statement, + * ** including the above license grant, this restriction and the following + * ** disclaimer, must be included in all copies of the Software, in whole or in + * ** part, and all derivative works of the Software, unless such copies or + * ** derivative works are solely in the form of machine-executable object code + * ** generated by a source language processor. + * ** + * ** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS + * ** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * ** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT + * ** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE + * ** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, + * ** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + * ** DEALINGS IN THE SOFTWARE. + * ** + * ** A copy of the Software is available free of charge at + * ** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. + * ** + * ** -LICENSE-END- + * */ + +/* DeckLinkAPIVersion.h */ + +#ifndef __DeckLink_API_Version_h__ +#define __DeckLink_API_Version_h__ + +#define BLACKMAGIC_DECKLINK_API_VERSION 0x10000000 +#define BLACKMAGIC_DECKLINK_API_VERSION_STRING "16.0" + +#endif // __DeckLink_API_Version_h__ + diff --git a/services/capture/sdk/DeckLinkAPIVideoConversion_v14_2_1.h b/services/capture/sdk/DeckLinkAPIVideoConversion_v14_2_1.h new file mode 100644 index 0000000..7c1f057 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIVideoConversion_v14_2_1.h @@ -0,0 +1,62 @@ +/* -LICENSE-START- +** Copyright (c) 2022 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit (“EULA”) available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPIVIDEOCONVERSION_v14_2_1_H +#define BMD_DECKLINKAPIVIDEOCONVERSION_v14_2_1_H + +#include "DeckLinkAPI.h" +#include "DeckLinkAPIVideoFrame_v14_2_1.h" + +// Type Declarations + +BMD_CONST REFIID IID_IDeckLinkVideoConversion_v14_2_1 = /* 3BBCB8A2-DA2C-42D9-B5D8-88083644E99A */ { 0x3B, 0xBC, 0xB8, 0xA2, 0xDA, 0x2C, 0x42, 0xD9, 0xB5, 0xD8, 0x88, 0x08, 0x36, 0x44, 0xE9, 0x9A }; + +/* Interface IDeckLinkVideoConversion - Created with CoCreateInstance. */ + +class BMD_PUBLIC IDeckLinkVideoConversion_v14_2_1 : public IUnknown +{ +public: + virtual HRESULT ConvertFrame (/* in */ IDeckLinkVideoFrame_v14_2_1* srcFrame, /* in */ IDeckLinkVideoFrame_v14_2_1* dstFrame) = 0; + +protected: + virtual ~IDeckLinkVideoConversion_v14_2_1 () {} // call Release method to drop reference count +}; + +#endif diff --git a/services/capture/sdk/DeckLinkAPIVideoEncoderInput_v10_11.h b/services/capture/sdk/DeckLinkAPIVideoEncoderInput_v10_11.h new file mode 100644 index 0000000..64312d0 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIVideoEncoderInput_v10_11.h @@ -0,0 +1,88 @@ +/* -LICENSE-START- +** Copyright (c) 2017 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPIVIDEOENCODERINPUT_v10_11_H +#define BMD_DECKLINKAPIVIDEOENCODERINPUT_v10_11_H + +#include "DeckLinkAPI.h" +#include "DeckLinkAPI_v10_11.h" +#include "DeckLinkAPIMemoryAllocator_v14_2_1.h" + +// Type Declarations +BMD_CONST REFIID IID_IDeckLinkEncoderInput_v10_11 = /* 270587DA-6B7D-42E7-A1F0-6D853F581185 */ {0x27,0x05,0x87,0xDA,0x6B,0x7D,0x42,0xE7,0xA1,0xF0,0x6D,0x85,0x3F,0x58,0x11,0x85}; + +/* Interface IDeckLinkEncoderInput_v10_11 - Created by QueryInterface from IDeckLink. */ + +class IDeckLinkEncoderInput_v10_11 : public IUnknown +{ +public: + virtual HRESULT DoesSupportVideoMode (/* in */ BMDDisplayMode displayMode, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDVideoInputFlags flags, /* out */ BMDDisplayModeSupport_v10_11 *result, /* out */ IDeckLinkDisplayMode **resultDisplayMode) = 0; + virtual HRESULT GetDisplayModeIterator (/* out */ IDeckLinkDisplayModeIterator **iterator) = 0; + + /* Video Input */ + + virtual HRESULT EnableVideoInput (/* in */ BMDDisplayMode displayMode, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDVideoInputFlags flags) = 0; + virtual HRESULT DisableVideoInput (void) = 0; + virtual HRESULT GetAvailablePacketsCount (/* out */ uint32_t *availablePacketsCount) = 0; + virtual HRESULT SetMemoryAllocator (/* in */ IDeckLinkMemoryAllocator_v14_2_1 *theAllocator) = 0; + + /* Audio Input */ + + virtual HRESULT EnableAudioInput (/* in */ BMDAudioFormat audioFormat, /* in */ BMDAudioSampleRate sampleRate, /* in */ BMDAudioSampleType sampleType, /* in */ uint32_t channelCount) = 0; + virtual HRESULT DisableAudioInput (void) = 0; + virtual HRESULT GetAvailableAudioSampleFrameCount (/* out */ uint32_t *availableSampleFrameCount) = 0; + + /* Input Control */ + + virtual HRESULT StartStreams (void) = 0; + virtual HRESULT StopStreams (void) = 0; + virtual HRESULT PauseStreams (void) = 0; + virtual HRESULT FlushStreams (void) = 0; + virtual HRESULT SetCallback (/* in */ IDeckLinkEncoderInputCallback *theCallback) = 0; + + /* Hardware Timing */ + + virtual HRESULT GetHardwareReferenceClock (/* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue *hardwareTime, /* out */ BMDTimeValue *timeInFrame, /* out */ BMDTimeValue *ticksPerFrame) = 0; + +protected: + virtual ~IDeckLinkEncoderInput_v10_11 () {} // call Release method to drop reference count +}; + +#endif /* defined(BMD_DECKLINKAPIVIDEOENCODERINPUT_v10_11_H) */ diff --git a/services/capture/sdk/DeckLinkAPIVideoFrame3DExtensions_v14_2_1.h b/services/capture/sdk/DeckLinkAPIVideoFrame3DExtensions_v14_2_1.h new file mode 100644 index 0000000..7407a6b --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIVideoFrame3DExtensions_v14_2_1.h @@ -0,0 +1,63 @@ +/* -LICENSE-START- +** Copyright (c) 2022 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit (“EULA”) available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPIVIDEOFRAME3DEXTENSIONS_v14_2_1_H +#define BMD_DECKLINKAPIVIDEOFRAME3DEXTENSIONS_v14_2_1_H + +#include "DeckLinkAPI.h" +#include "DeckLinkAPIVideoFrame_v14_2_1.h" + +// Type Declarations + +BMD_CONST REFIID IID_IDeckLinkVideoFrame3DExtensions_v14_2_1 = /* DA0F7E4A-EDC7-48A8-9CDD-2DB51C729CD7 */ { 0xDA, 0x0F, 0x7E, 0x4A, 0xED, 0xC7, 0x48, 0xA8, 0x9C, 0xDD, 0x2D, 0xB5, 0x1C, 0x72, 0x9C, 0xD7 }; + +/* Interface IDeckLinkVideoFrame3DExtensions - Optional interface implemented on IDeckLinkVideoFrame to support 3D frames */ + +class BMD_PUBLIC IDeckLinkVideoFrame3DExtensions_v14_2_1 : public IUnknown +{ +public: + virtual BMDVideo3DPackingFormat Get3DPackingFormat (void) = 0; + virtual HRESULT GetFrameForRightEye (/* out */ IDeckLinkVideoFrame_v14_2_1** rightEyeFrame) = 0; + +protected: + virtual ~IDeckLinkVideoFrame3DExtensions_v14_2_1 () {} // call Release method to drop reference count +}; + +#endif /* defined(BMD_DECKLINKAPIVIDEOFRAME3DEXTENSIONS_v14_2_1_H) */ diff --git a/services/capture/sdk/DeckLinkAPIVideoFrame_v14_2_1.h b/services/capture/sdk/DeckLinkAPIVideoFrame_v14_2_1.h new file mode 100644 index 0000000..902be76 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIVideoFrame_v14_2_1.h @@ -0,0 +1,68 @@ +/* -LICENSE-START- +** Copyright (c) 2022 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit (“EULA”) available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPIVIDEOFRAME_v14_2_1_H +#define BMD_DECKLINKAPIVIDEOFRAME_v14_2_1_H + +#include "DeckLinkAPI.h" + +// Type Declarations + +BMD_CONST REFIID IID_IDeckLinkVideoFrame_v14_2_1 = /* 3F716FE0-F023-4111-BE5D-EF4414C05B17 */ { 0x3F, 0x71, 0x6F, 0xE0, 0xF0, 0x23, 0x41, 0x11, 0xBE, 0x5D, 0xEF, 0x44, 0x14, 0xC0, 0x5B, 0x17 }; + +/* Interface IDeckLinkVideoFrame - Interface to encapsulate a video frame; can be caller-implemented. */ + +class BMD_PUBLIC IDeckLinkVideoFrame_v14_2_1 : public IUnknown +{ +public: + virtual long GetWidth (void) = 0; + virtual long GetHeight (void) = 0; + virtual long GetRowBytes (void) = 0; + virtual BMDPixelFormat GetPixelFormat (void) = 0; + virtual BMDFrameFlags GetFlags (void) = 0; + virtual HRESULT GetBytes (/* out */ void** buffer) = 0; + virtual HRESULT GetTimecode (/* in */ BMDTimecodeFormat format, /* out */ IDeckLinkTimecode** timecode) = 0; + virtual HRESULT GetAncillaryData (/* out */ IDeckLinkVideoFrameAncillary** ancillary) = 0; // Use of IDeckLinkVideoFrameAncillaryPackets is preferred + +protected: + virtual ~IDeckLinkVideoFrame_v14_2_1 () {} // call Release method to drop reference count +}; + +#endif /* defined(BMD_DECKLINKAPIVIDEOFRAME_v14_2_1_H) */ diff --git a/services/capture/sdk/DeckLinkAPIVideoInput_v10_11.h b/services/capture/sdk/DeckLinkAPIVideoInput_v10_11.h new file mode 100644 index 0000000..91c0aea --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIVideoInput_v10_11.h @@ -0,0 +1,91 @@ +/* -LICENSE-START- +** Copyright (c) 2017 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPIVIDEOINPUT_v10_11_H +#define BMD_DECKLINKAPIVIDEOINPUT_v10_11_H + +#include "DeckLinkAPI.h" +#include "DeckLinkAPI_v10_11.h" +#include "DeckLinkAPIMemoryAllocator_v14_2_1.h" +#include "DeckLinkAPIVideoInput_v11_5_1.h" + +// Type Declarations +BMD_CONST REFIID IID_IDeckLinkInput_v10_11 = /* AF22762B-DFAC-4846-AA79-FA8883560995 */ {0xAF,0x22,0x76,0x2B,0xDF,0xAC,0x48,0x46,0xAA,0x79,0xFA,0x88,0x83,0x56,0x09,0x95}; + +/* Interface IDeckLinkInput_v10_11 - DeckLink input interface. */ + +class IDeckLinkInput_v10_11 : public IUnknown +{ +public: + virtual HRESULT DoesSupportVideoMode (/* in */ BMDDisplayMode displayMode, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDVideoInputFlags flags, /* out */ BMDDisplayModeSupport_v10_11 *result, /* out */ IDeckLinkDisplayMode **resultDisplayMode) = 0; + virtual HRESULT GetDisplayModeIterator (/* out */ IDeckLinkDisplayModeIterator **iterator) = 0; + + virtual HRESULT SetScreenPreviewCallback (/* in */ IDeckLinkScreenPreviewCallback_v14_2_1 *previewCallback) = 0; + + /* Video Input */ + + virtual HRESULT EnableVideoInput (/* in */ BMDDisplayMode displayMode, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDVideoInputFlags flags) = 0; + virtual HRESULT DisableVideoInput (void) = 0; + virtual HRESULT GetAvailableVideoFrameCount (/* out */ uint32_t *availableFrameCount) = 0; + virtual HRESULT SetVideoInputFrameMemoryAllocator (/* in */ IDeckLinkMemoryAllocator_v14_2_1 *theAllocator) = 0; + + /* Audio Input */ + + virtual HRESULT EnableAudioInput (/* in */ BMDAudioSampleRate sampleRate, /* in */ BMDAudioSampleType sampleType, /* in */ uint32_t channelCount) = 0; + virtual HRESULT DisableAudioInput (void) = 0; + virtual HRESULT GetAvailableAudioSampleFrameCount (/* out */ uint32_t *availableSampleFrameCount) = 0; + + /* Input Control */ + + virtual HRESULT StartStreams (void) = 0; + virtual HRESULT StopStreams (void) = 0; + virtual HRESULT PauseStreams (void) = 0; + virtual HRESULT FlushStreams (void) = 0; + virtual HRESULT SetCallback (/* in */ IDeckLinkInputCallback_v11_5_1 *theCallback) = 0; + + /* Hardware Timing */ + + virtual HRESULT GetHardwareReferenceClock (/* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue *hardwareTime, /* out */ BMDTimeValue *timeInFrame, /* out */ BMDTimeValue *ticksPerFrame) = 0; + +protected: + virtual ~IDeckLinkInput_v10_11 () {} // call Release method to drop reference count +}; + +#endif /* defined(BMD_DECKLINKAPIVIDEOINPUT_v10_11_H) */ diff --git a/services/capture/sdk/DeckLinkAPIVideoInput_v11_4.h b/services/capture/sdk/DeckLinkAPIVideoInput_v11_4.h new file mode 100644 index 0000000..2fc8191 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIVideoInput_v11_4.h @@ -0,0 +1,90 @@ +/* -LICENSE-START- +** Copyright (c) 2019 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPIVIDEOINPUT_v11_4_H +#define BMD_DECKLINKAPIVIDEOINPUT_v11_4_H + +#include "DeckLinkAPI.h" +#include "DeckLinkAPIMemoryAllocator_v14_2_1.h" +#include "DeckLinkAPIVideoInput_v11_5_1.h" + +// Type Declarations +BMD_CONST REFIID IID_IDeckLinkInput_v11_4 = /* 2A88CF76-F494-4216-A7EF-DC74EEB83882 */ { 0x2A,0x88,0xCF,0x76,0xF4,0x94,0x42,0x16,0xA7,0xEF,0xDC,0x74,0xEE,0xB8,0x38,0x82 }; + +/* Interface IDeckLinkInput_v11_4 - Created by QueryInterface from IDeckLink. */ + +class BMD_PUBLIC IDeckLinkInput_v11_4 : public IUnknown +{ +public: + virtual HRESULT DoesSupportVideoMode (/* in */ BMDVideoConnection connection /* If a value of 0 is specified, the caller does not care about the connection */, /* in */ BMDDisplayMode requestedMode, /* in */ BMDPixelFormat requestedPixelFormat, /* in */ BMDSupportedVideoModeFlags flags, /* out */ bool* supported) = 0; + virtual HRESULT GetDisplayMode (/* in */ BMDDisplayMode displayMode, /* out */ IDeckLinkDisplayMode** resultDisplayMode) = 0; + virtual HRESULT GetDisplayModeIterator (/* out */ IDeckLinkDisplayModeIterator** iterator) = 0; + virtual HRESULT SetScreenPreviewCallback (/* in */ IDeckLinkScreenPreviewCallback_v14_2_1* previewCallback) = 0; + + /* Video Input */ + + virtual HRESULT EnableVideoInput (/* in */ BMDDisplayMode displayMode, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDVideoInputFlags flags) = 0; + virtual HRESULT DisableVideoInput (void) = 0; + virtual HRESULT GetAvailableVideoFrameCount (/* out */ uint32_t* availableFrameCount) = 0; + virtual HRESULT SetVideoInputFrameMemoryAllocator (/* in */ IDeckLinkMemoryAllocator_v14_2_1* theAllocator) = 0; + + /* Audio Input */ + + virtual HRESULT EnableAudioInput (/* in */ BMDAudioSampleRate sampleRate, /* in */ BMDAudioSampleType sampleType, /* in */ uint32_t channelCount) = 0; + virtual HRESULT DisableAudioInput (void) = 0; + virtual HRESULT GetAvailableAudioSampleFrameCount (/* out */ uint32_t* availableSampleFrameCount) = 0; + + /* Input Control */ + + virtual HRESULT StartStreams (void) = 0; + virtual HRESULT StopStreams (void) = 0; + virtual HRESULT PauseStreams (void) = 0; + virtual HRESULT FlushStreams (void) = 0; + virtual HRESULT SetCallback (/* in */ IDeckLinkInputCallback_v11_5_1* theCallback) = 0; + + /* Hardware Timing */ + + virtual HRESULT GetHardwareReferenceClock (/* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue* hardwareTime, /* out */ BMDTimeValue* timeInFrame, /* out */ BMDTimeValue* ticksPerFrame) = 0; + +protected: + virtual ~IDeckLinkInput_v11_4 () {} // call Release method to drop reference count +}; + +#endif /* defined(BMD_DECKLINKAPIVIDEOINPUT_v11_4_H) */ diff --git a/services/capture/sdk/DeckLinkAPIVideoInput_v11_5_1.h b/services/capture/sdk/DeckLinkAPIVideoInput_v11_5_1.h new file mode 100644 index 0000000..d0f8944 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIVideoInput_v11_5_1.h @@ -0,0 +1,103 @@ +/* -LICENSE-START- +** Copyright (c) 2020 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPIVIDEOINPUT_v11_5_1_H +#define BMD_DECKLINKAPIVIDEOINPUT_v11_5_1_H + +#include "DeckLinkAPI.h" +#include "DeckLinkAPIVideoInput_v14_2_1.h" + +// Type Declarations + +BMD_CONST REFIID IID_IDeckLinkInputCallback_v11_5_1 = /* DD04E5EC-7415-42AB-AE4A-E80C4DFC044A */ { 0xDD, 0x04, 0xE5, 0xEC, 0x74, 0x15, 0x42, 0xAB, 0xAE, 0x4A, 0xE8, 0x0C, 0x4D, 0xFC, 0x04, 0x4A }; +BMD_CONST REFIID IID_IDeckLinkInput_v11_5_1 = /* 9434C6E4-B15D-4B1C-979E-661E3DDCB4B9 */ { 0x94, 0x34, 0xC6, 0xE4, 0xB1, 0x5D, 0x4B, 0x1C, 0x97, 0x9E, 0x66, 0x1E, 0x3D, 0xDC, 0xB4, 0xB9 }; + +/* Interface IDeckLinkInputCallback_v11_5_1 - Frame arrival callback. */ + +class BMD_PUBLIC IDeckLinkInputCallback_v11_5_1 : public IUnknown +{ +public: + virtual HRESULT VideoInputFormatChanged (/* in */ BMDVideoInputFormatChangedEvents notificationEvents, /* in */ IDeckLinkDisplayMode* newDisplayMode, /* in */ BMDDetectedVideoInputFormatFlags detectedSignalFlags) = 0; + virtual HRESULT VideoInputFrameArrived (/* in */ IDeckLinkVideoInputFrame_v14_2_1* videoFrame, /* in */ IDeckLinkAudioInputPacket* audioPacket) = 0; + +protected: + virtual ~IDeckLinkInputCallback_v11_5_1 () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkInput_v11_5_1 - Created by QueryInterface from IDeckLink. */ + +class BMD_PUBLIC IDeckLinkInput_v11_5_1 : public IUnknown +{ +public: + virtual HRESULT DoesSupportVideoMode (/* in */ BMDVideoConnection connection /* If a value of bmdVideoConnectionUnspecified is specified, the caller does not care about the connection */, /* in */ BMDDisplayMode requestedMode, /* in */ BMDPixelFormat requestedPixelFormat, /* in */ BMDVideoInputConversionMode conversionMode, /* in */ BMDSupportedVideoModeFlags flags, /* out */ BMDDisplayMode* actualMode, /* out */ bool* supported) = 0; + virtual HRESULT GetDisplayMode (/* in */ BMDDisplayMode displayMode, /* out */ IDeckLinkDisplayMode** resultDisplayMode) = 0; + virtual HRESULT GetDisplayModeIterator (/* out */ IDeckLinkDisplayModeIterator** iterator) = 0; + virtual HRESULT SetScreenPreviewCallback (/* in */ IDeckLinkScreenPreviewCallback_v14_2_1* previewCallback) = 0; + + /* Video Input */ + + virtual HRESULT EnableVideoInput (/* in */ BMDDisplayMode displayMode, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDVideoInputFlags flags) = 0; + virtual HRESULT DisableVideoInput (void) = 0; + virtual HRESULT GetAvailableVideoFrameCount (/* out */ uint32_t* availableFrameCount) = 0; + virtual HRESULT SetVideoInputFrameMemoryAllocator (/* in */ IDeckLinkMemoryAllocator_v14_2_1* theAllocator) = 0; + + /* Audio Input */ + + virtual HRESULT EnableAudioInput (/* in */ BMDAudioSampleRate sampleRate, /* in */ BMDAudioSampleType sampleType, /* in */ uint32_t channelCount) = 0; + virtual HRESULT DisableAudioInput (void) = 0; + virtual HRESULT GetAvailableAudioSampleFrameCount (/* out */ uint32_t* availableSampleFrameCount) = 0; + + /* Input Control */ + + virtual HRESULT StartStreams (void) = 0; + virtual HRESULT StopStreams (void) = 0; + virtual HRESULT PauseStreams (void) = 0; + virtual HRESULT FlushStreams (void) = 0; + virtual HRESULT SetCallback (/* in */ IDeckLinkInputCallback_v11_5_1* theCallback) = 0; + + /* Hardware Timing */ + + virtual HRESULT GetHardwareReferenceClock (/* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue* hardwareTime, /* out */ BMDTimeValue* timeInFrame, /* out */ BMDTimeValue* ticksPerFrame) = 0; + +protected: + virtual ~IDeckLinkInput_v11_5_1 () {} // call Release method to drop reference count +}; + +#endif /* defined(BMD_DECKLINKAPIVIDEOINPUT_v11_5_1_H) */ diff --git a/services/capture/sdk/DeckLinkAPIVideoInput_v14_2_1.h b/services/capture/sdk/DeckLinkAPIVideoInput_v14_2_1.h new file mode 100644 index 0000000..0653759 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIVideoInput_v14_2_1.h @@ -0,0 +1,118 @@ +/* -LICENSE-START- +** Copyright (c) 2022 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit (“EULA”) available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPIVIDEOINPUT_v14_2_1_H +#define BMD_DECKLINKAPIVIDEOINPUT_v14_2_1_H + +#include "DeckLinkAPI.h" +#include "DeckLinkAPIMemoryAllocator_v14_2_1.h" +#include "DeckLinkAPIVideoFrame_v14_2_1.h" +#include "DeckLinkAPIScreenPreviewCallback_v14_2_1.h" + +// Type Declarations + +BMD_CONST REFIID IID_IDeckLinkVideoInputFrame_v14_2_1 = /* 05CFE374-537C-4094-9A57-680525118F44 */ { 0x05, 0xCF, 0xE3, 0x74, 0x53, 0x7C, 0x40, 0x94, 0x9A, 0x57, 0x68, 0x05, 0x25, 0x11, 0x8F, 0x44 }; +BMD_CONST REFIID IID_IDeckLinkInputCallback_v14_2_1 = /* C6FCE4C9-C4E4-4047-82FB-5D238232A902 */ { 0xC6, 0xFC, 0xE4, 0xC9, 0xC4, 0xE4, 0x40, 0x47, 0x82, 0xFB, 0x5D, 0x23, 0x82, 0x32, 0xA9, 0x02 }; +BMD_CONST REFIID IID_IDeckLinkInput_v14_2_1 = /* C21CDB6E-F414-46E4-A636-80A566E0ED37 */ { 0xC2, 0x1C, 0xDB, 0x6E, 0xF4, 0x14, 0x46, 0xE4, 0xA6, 0x36, 0x80, 0xA5, 0x66, 0xE0, 0xED, 0x37 }; + +/* Interface IDeckLinkVideoInputFrame - Provided by the IDeckLinkVideoInput frame arrival callback. */ + +class BMD_PUBLIC IDeckLinkVideoInputFrame_v14_2_1 : public IDeckLinkVideoFrame_v14_2_1 +{ +public: + virtual HRESULT GetStreamTime (/* out */ BMDTimeValue* frameTime, /* out */ BMDTimeValue* frameDuration, /* in */ BMDTimeScale timeScale) = 0; + virtual HRESULT GetHardwareReferenceTimestamp (/* in */ BMDTimeScale timeScale, /* out */ BMDTimeValue* frameTime, /* out */ BMDTimeValue* frameDuration) = 0; + +protected: + virtual ~IDeckLinkVideoInputFrame_v14_2_1 () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkInputCallback_v14_2_1 - Frame arrival callback. */ + +class BMD_PUBLIC IDeckLinkInputCallback_v14_2_1 : public IUnknown +{ +public: + virtual HRESULT VideoInputFormatChanged (/* in */ BMDVideoInputFormatChangedEvents notificationEvents, /* in */ IDeckLinkDisplayMode* newDisplayMode, /* in */ BMDDetectedVideoInputFormatFlags detectedSignalFlags) = 0; + virtual HRESULT VideoInputFrameArrived (/* in */ IDeckLinkVideoInputFrame_v14_2_1* videoFrame, /* in */ IDeckLinkAudioInputPacket* audioPacket) = 0; + +protected: + virtual ~IDeckLinkInputCallback_v14_2_1 () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkInput - Created by QueryInterface from IDeckLink. */ + +class BMD_PUBLIC IDeckLinkInput_v14_2_1 : public IUnknown +{ +public: + virtual HRESULT DoesSupportVideoMode (/* in */ BMDVideoConnection connection /* If a value of bmdVideoConnectionUnspecified is specified, the caller does not care about the connection */, /* in */ BMDDisplayMode requestedMode, /* in */ BMDPixelFormat requestedPixelFormat, /* in */ BMDVideoInputConversionMode conversionMode, /* in */ BMDSupportedVideoModeFlags flags, /* out */ BMDDisplayMode* actualMode, /* out */ bool* supported) = 0; + virtual HRESULT GetDisplayMode (/* in */ BMDDisplayMode displayMode, /* out */ IDeckLinkDisplayMode** resultDisplayMode) = 0; + virtual HRESULT GetDisplayModeIterator (/* out */ IDeckLinkDisplayModeIterator** iterator) = 0; + virtual HRESULT SetScreenPreviewCallback (/* in */ IDeckLinkScreenPreviewCallback_v14_2_1* previewCallback) = 0; + + /* Video Input */ + + virtual HRESULT EnableVideoInput (/* in */ BMDDisplayMode displayMode, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDVideoInputFlags flags) = 0; + virtual HRESULT DisableVideoInput (void) = 0; + virtual HRESULT GetAvailableVideoFrameCount (/* out */ uint32_t* availableFrameCount) = 0; + virtual HRESULT SetVideoInputFrameMemoryAllocator (/* in */ IDeckLinkMemoryAllocator_v14_2_1* theAllocator) = 0; + + /* Audio Input */ + + virtual HRESULT EnableAudioInput (/* in */ BMDAudioSampleRate sampleRate, /* in */ BMDAudioSampleType sampleType, /* in */ uint32_t channelCount) = 0; + virtual HRESULT DisableAudioInput (void) = 0; + virtual HRESULT GetAvailableAudioSampleFrameCount (/* out */ uint32_t* availableSampleFrameCount) = 0; + + /* Input Control */ + + virtual HRESULT StartStreams (void) = 0; + virtual HRESULT StopStreams (void) = 0; + virtual HRESULT PauseStreams (void) = 0; + virtual HRESULT FlushStreams (void) = 0; + virtual HRESULT SetCallback (/* in */ IDeckLinkInputCallback_v14_2_1* theCallback) = 0; + + /* Hardware Timing */ + + virtual HRESULT GetHardwareReferenceClock (/* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue* hardwareTime, /* out */ BMDTimeValue* timeInFrame, /* out */ BMDTimeValue* ticksPerFrame) = 0; + +protected: + virtual ~IDeckLinkInput_v14_2_1 () {} // call Release method to drop reference count +}; + +#endif /* defined(BMD_DECKLINKAPIVIDEOINPUT_v14_2_1_H) */ diff --git a/services/capture/sdk/DeckLinkAPIVideoInput_v15_3_1.h b/services/capture/sdk/DeckLinkAPIVideoInput_v15_3_1.h new file mode 100644 index 0000000..6c570d9 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIVideoInput_v15_3_1.h @@ -0,0 +1,86 @@ +/* -LICENSE-START- +** Copyright (c) 2025 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit (“EULA”) available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#pragma once + +#include "DeckLinkAPI_v15_3_1.h" + +// Type Declarations + +BMD_CONST REFIID IID_IDeckLinkInput_v15_3_1 = /* 4095DB82-E294-4B8C-AAA8-3B9E80C49336 */ { 0x40,0x95,0xDB,0x82,0xE2,0x94,0x4B,0x8C,0xAA,0xA8,0x3B,0x9E,0x80,0xC4,0x93,0x36 }; + +/* Interface IDeckLinkInput_v15_3_1 - Created by QueryInterface from IDeckLink. */ + +class BMD_PUBLIC IDeckLinkInput_v15_3_1 : public IUnknown +{ +public: + virtual HRESULT DoesSupportVideoMode (/* in */ BMDVideoConnection connection /* If a value of bmdVideoConnectionUnspecified is specified, the caller does not care about the connection */, /* in */ BMDDisplayMode requestedMode, /* in */ BMDPixelFormat requestedPixelFormat, /* in */ BMDVideoInputConversionMode conversionMode, /* in */ BMDSupportedVideoModeFlags flags, /* out */ BMDDisplayMode* actualMode, /* out */ bool* supported) = 0; + virtual HRESULT GetDisplayMode (/* in */ BMDDisplayMode displayMode, /* out */ IDeckLinkDisplayMode** resultDisplayMode) = 0; + virtual HRESULT GetDisplayModeIterator (/* out */ IDeckLinkDisplayModeIterator** iterator) = 0; + virtual HRESULT SetScreenPreviewCallback (/* in */ IDeckLinkScreenPreviewCallback* previewCallback) = 0; + + /* Video Input */ + + virtual HRESULT EnableVideoInput (/* in */ BMDDisplayMode displayMode, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDVideoInputFlags flags) = 0; + virtual HRESULT EnableVideoInputWithAllocatorProvider (/* in */ BMDDisplayMode displayMode, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDVideoInputFlags flags, /* in */ IDeckLinkVideoBufferAllocatorProvider_v15_3_1* allocatorProvider) = 0; + virtual HRESULT DisableVideoInput (void) = 0; + virtual HRESULT GetAvailableVideoFrameCount (/* out */ uint32_t* availableFrameCount) = 0; + + /* Audio Input */ + + virtual HRESULT EnableAudioInput (/* in */ BMDAudioSampleRate sampleRate, /* in */ BMDAudioSampleType sampleType, /* in */ uint32_t channelCount) = 0; + virtual HRESULT DisableAudioInput (void) = 0; + virtual HRESULT GetAvailableAudioSampleFrameCount (/* out */ uint32_t* availableSampleFrameCount) = 0; + + /* Input Control */ + + virtual HRESULT StartStreams (void) = 0; + virtual HRESULT StopStreams (void) = 0; + virtual HRESULT PauseStreams (void) = 0; + virtual HRESULT FlushStreams (void) = 0; + virtual HRESULT SetCallback (/* in */ IDeckLinkInputCallback* theCallback) = 0; + + /* Hardware Timing */ + + virtual HRESULT GetHardwareReferenceClock (/* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue* hardwareTime, /* out */ BMDTimeValue* timeInFrame, /* out */ BMDTimeValue* ticksPerFrame) = 0; + +protected: + virtual ~IDeckLinkInput_v15_3_1 () {} // call Release method to drop reference count +}; diff --git a/services/capture/sdk/DeckLinkAPIVideoOutput_v10_11.h b/services/capture/sdk/DeckLinkAPIVideoOutput_v10_11.h new file mode 100644 index 0000000..8a4d1ec --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIVideoOutput_v10_11.h @@ -0,0 +1,109 @@ +/* -LICENSE-START- +** Copyright (c) 2017 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPIVIDEOOUTPUT_v10_11_H +#define BMD_DECKLINKAPIVIDEOOUTPUT_v10_11_H + +#include "DeckLinkAPI.h" +#include "DeckLinkAPI_v10_11.h" +#include "DeckLinkAPIVideoInput_v14_2_1.h" +#include "DeckLinkAPIVideoOutput_v14_2_1.h" + +// Type Declarations +BMD_CONST REFIID IID_IDeckLinkOutput_v10_11 = /* CC5C8A6E-3F2F-4B3A-87EA-FD78AF300564 */ {0xCC,0x5C,0x8A,0x6E,0x3F,0x2F,0x4B,0x3A,0x87,0xEA,0xFD,0x78,0xAF,0x30,0x05,0x64}; + +/* Interface IDeckLinkOutput_v10_11 - DeckLink output interface. */ + +class IDeckLinkOutput_v10_11 : public IUnknown +{ +public: + virtual HRESULT DoesSupportVideoMode (/* in */ BMDDisplayMode displayMode, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDVideoOutputFlags flags, /* out */ BMDDisplayModeSupport_v10_11 *result, /* out */ IDeckLinkDisplayMode **resultDisplayMode) = 0; + virtual HRESULT GetDisplayModeIterator (/* out */ IDeckLinkDisplayModeIterator **iterator) = 0; + + virtual HRESULT SetScreenPreviewCallback (/* in */ IDeckLinkScreenPreviewCallback_v14_2_1 *previewCallback) = 0; + + /* Video Output */ + + virtual HRESULT EnableVideoOutput (/* in */ BMDDisplayMode displayMode, /* in */ BMDVideoOutputFlags flags) = 0; + virtual HRESULT DisableVideoOutput (void) = 0; + + virtual HRESULT SetVideoOutputFrameMemoryAllocator (/* in */ IDeckLinkMemoryAllocator_v14_2_1 *theAllocator) = 0; + virtual HRESULT CreateVideoFrame (/* in */ int32_t width, /* in */ int32_t height, /* in */ int32_t rowBytes, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDFrameFlags flags, /* out */ IDeckLinkMutableVideoFrame_v14_2_1 **outFrame) = 0; + virtual HRESULT CreateAncillaryData (/* in */ BMDPixelFormat pixelFormat, /* out */ IDeckLinkVideoFrameAncillary **outBuffer) = 0; + + virtual HRESULT DisplayVideoFrameSync (/* in */ IDeckLinkVideoFrame_v14_2_1 *theFrame) = 0; + virtual HRESULT ScheduleVideoFrame (/* in */ IDeckLinkVideoFrame_v14_2_1 *theFrame, /* in */ BMDTimeValue displayTime, /* in */ BMDTimeValue displayDuration, /* in */ BMDTimeScale timeScale) = 0; + virtual HRESULT SetScheduledFrameCompletionCallback (/* in */ IDeckLinkVideoOutputCallback_v14_2_1 *theCallback) = 0; + virtual HRESULT GetBufferedVideoFrameCount (/* out */ uint32_t *bufferedFrameCount) = 0; + + /* Audio Output */ + + virtual HRESULT EnableAudioOutput (/* in */ BMDAudioSampleRate sampleRate, /* in */ BMDAudioSampleType sampleType, /* in */ uint32_t channelCount, /* in */ BMDAudioOutputStreamType streamType) = 0; + virtual HRESULT DisableAudioOutput (void) = 0; + + virtual HRESULT WriteAudioSamplesSync (/* in */ void *buffer, /* in */ uint32_t sampleFrameCount, /* out */ uint32_t *sampleFramesWritten) = 0; + + virtual HRESULT BeginAudioPreroll (void) = 0; + virtual HRESULT EndAudioPreroll (void) = 0; + virtual HRESULT ScheduleAudioSamples (/* in */ void *buffer, /* in */ uint32_t sampleFrameCount, /* in */ BMDTimeValue streamTime, /* in */ BMDTimeScale timeScale, /* out */ uint32_t *sampleFramesWritten) = 0; + + virtual HRESULT GetBufferedAudioSampleFrameCount (/* out */ uint32_t *bufferedSampleFrameCount) = 0; + virtual HRESULT FlushBufferedAudioSamples (void) = 0; + + virtual HRESULT SetAudioCallback (/* in */ IDeckLinkAudioOutputCallback *theCallback) = 0; + + /* Output Control */ + + virtual HRESULT StartScheduledPlayback (/* in */ BMDTimeValue playbackStartTime, /* in */ BMDTimeScale timeScale, /* in */ double playbackSpeed) = 0; + virtual HRESULT StopScheduledPlayback (/* in */ BMDTimeValue stopPlaybackAtTime, /* out */ BMDTimeValue *actualStopTime, /* in */ BMDTimeScale timeScale) = 0; + virtual HRESULT IsScheduledPlaybackRunning (/* out */ bool *active) = 0; + virtual HRESULT GetScheduledStreamTime (/* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue *streamTime, /* out */ double *playbackSpeed) = 0; + virtual HRESULT GetReferenceStatus (/* out */ BMDReferenceStatus *referenceStatus) = 0; + + /* Hardware Timing */ + + virtual HRESULT GetHardwareReferenceClock (/* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue *hardwareTime, /* out */ BMDTimeValue *timeInFrame, /* out */ BMDTimeValue *ticksPerFrame) = 0; + virtual HRESULT GetFrameCompletionReferenceTimestamp (/* in */ IDeckLinkVideoFrame_v14_2_1 *theFrame, /* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue *frameCompletionTimestamp) = 0; + +protected: + virtual ~IDeckLinkOutput_v10_11 () {} // call Release method to drop reference count +}; + +#endif /* defined(BMD_DECKLINKAPIVIDEOOUTPUT_v10_11_H) */ diff --git a/services/capture/sdk/DeckLinkAPIVideoOutput_v11_4.h b/services/capture/sdk/DeckLinkAPIVideoOutput_v11_4.h new file mode 100644 index 0000000..be3230d --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIVideoOutput_v11_4.h @@ -0,0 +1,101 @@ +/* -LICENSE-START- +** Copyright (c) 2019 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPIVIDEOOUTPUT_v11_4_H +#define BMD_DECKLINKAPIVIDEOOUTPUT_v11_4_H + +#include "DeckLinkAPI.h" +#include "DeckLinkAPIVideoOutput_v14_2_1.h" + +// Type Declarations +BMD_CONST REFIID IID_IDeckLinkOutput_v11_4 = /* 065A0F6C-C508-4D0D-B919-F5EB0EBFC96B */ { 0x06,0x5A,0x0F,0x6C,0xC5,0x08,0x4D,0x0D,0xB9,0x19,0xF5,0xEB,0x0E,0xBF,0xC9,0x6B }; + +/* Interface IDeckLinkOutput_v11_4 - Created by QueryInterface from IDeckLink. */ + +class BMD_PUBLIC IDeckLinkOutput_v11_4 : public IUnknown +{ +public: + virtual HRESULT DoesSupportVideoMode (/* in */ BMDVideoConnection connection /* If a value of 0 is specified, the caller does not care about the connection */, /* in */ BMDDisplayMode requestedMode, /* in */ BMDPixelFormat requestedPixelFormat, /* in */ BMDSupportedVideoModeFlags flags, /* out */ BMDDisplayMode* actualMode, /* out */ bool* supported) = 0; + virtual HRESULT GetDisplayMode (/* in */ BMDDisplayMode displayMode, /* out */ IDeckLinkDisplayMode** resultDisplayMode) = 0; + virtual HRESULT GetDisplayModeIterator (/* out */ IDeckLinkDisplayModeIterator** iterator) = 0; + virtual HRESULT SetScreenPreviewCallback (/* in */ IDeckLinkScreenPreviewCallback_v14_2_1* previewCallback) = 0; + + /* Video Output */ + + virtual HRESULT EnableVideoOutput (/* in */ BMDDisplayMode displayMode, /* in */ BMDVideoOutputFlags flags) = 0; + virtual HRESULT DisableVideoOutput (void) = 0; + virtual HRESULT SetVideoOutputFrameMemoryAllocator (/* in */ IDeckLinkMemoryAllocator_v14_2_1* theAllocator) = 0; + virtual HRESULT CreateVideoFrame (/* in */ int32_t width, /* in */ int32_t height, /* in */ int32_t rowBytes, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDFrameFlags flags, /* out */ IDeckLinkMutableVideoFrame_v14_2_1** outFrame) = 0; + virtual HRESULT CreateAncillaryData (/* in */ BMDPixelFormat pixelFormat, /* out */ IDeckLinkVideoFrameAncillary** outBuffer) = 0; // Use of IDeckLinkVideoFrameAncillaryPackets is preferred + virtual HRESULT DisplayVideoFrameSync (/* in */ IDeckLinkVideoFrame_v14_2_1* theFrame) = 0; + virtual HRESULT ScheduleVideoFrame (/* in */ IDeckLinkVideoFrame_v14_2_1* theFrame, /* in */ BMDTimeValue displayTime, /* in */ BMDTimeValue displayDuration, /* in */ BMDTimeScale timeScale) = 0; + virtual HRESULT SetScheduledFrameCompletionCallback (/* in */ IDeckLinkVideoOutputCallback_v14_2_1* theCallback) = 0; + virtual HRESULT GetBufferedVideoFrameCount (/* out */ uint32_t* bufferedFrameCount) = 0; + + /* Audio Output */ + + virtual HRESULT EnableAudioOutput (/* in */ BMDAudioSampleRate sampleRate, /* in */ BMDAudioSampleType sampleType, /* in */ uint32_t channelCount, /* in */ BMDAudioOutputStreamType streamType) = 0; + virtual HRESULT DisableAudioOutput (void) = 0; + virtual HRESULT WriteAudioSamplesSync (/* in */ void* buffer, /* in */ uint32_t sampleFrameCount, /* out */ uint32_t* sampleFramesWritten) = 0; + virtual HRESULT BeginAudioPreroll (void) = 0; + virtual HRESULT EndAudioPreroll (void) = 0; + virtual HRESULT ScheduleAudioSamples (/* in */ void* buffer, /* in */ uint32_t sampleFrameCount, /* in */ BMDTimeValue streamTime, /* in */ BMDTimeScale timeScale, /* out */ uint32_t* sampleFramesWritten) = 0; + virtual HRESULT GetBufferedAudioSampleFrameCount (/* out */ uint32_t* bufferedSampleFrameCount) = 0; + virtual HRESULT FlushBufferedAudioSamples (void) = 0; + virtual HRESULT SetAudioCallback (/* in */ IDeckLinkAudioOutputCallback* theCallback) = 0; + + /* Output Control */ + + virtual HRESULT StartScheduledPlayback (/* in */ BMDTimeValue playbackStartTime, /* in */ BMDTimeScale timeScale, /* in */ double playbackSpeed) = 0; + virtual HRESULT StopScheduledPlayback (/* in */ BMDTimeValue stopPlaybackAtTime, /* out */ BMDTimeValue* actualStopTime, /* in */ BMDTimeScale timeScale) = 0; + virtual HRESULT IsScheduledPlaybackRunning (/* out */ bool* active) = 0; + virtual HRESULT GetScheduledStreamTime (/* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue* streamTime, /* out */ double* playbackSpeed) = 0; + virtual HRESULT GetReferenceStatus (/* out */ BMDReferenceStatus* referenceStatus) = 0; + + /* Hardware Timing */ + + virtual HRESULT GetHardwareReferenceClock (/* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue* hardwareTime, /* out */ BMDTimeValue* timeInFrame, /* out */ BMDTimeValue* ticksPerFrame) = 0; + virtual HRESULT GetFrameCompletionReferenceTimestamp (/* in */ IDeckLinkVideoFrame_v14_2_1* theFrame, /* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue* frameCompletionTimestamp) = 0; + +protected: + virtual ~IDeckLinkOutput_v11_4 () {} // call Release method to drop reference count +}; + +#endif /* defined(BMD_DECKLINKAPIVIDEOOUTPUT_v11_4_H) */ diff --git a/services/capture/sdk/DeckLinkAPIVideoOutput_v14_2_1.h b/services/capture/sdk/DeckLinkAPIVideoOutput_v14_2_1.h new file mode 100644 index 0000000..981a057 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIVideoOutput_v14_2_1.h @@ -0,0 +1,133 @@ +/* -LICENSE-START- +** Copyright (c) 2022 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit (“EULA”) available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPIVIDEOOUTPUT_v14_2_1_H +#define BMD_DECKLINKAPIVIDEOOUTPUT_v14_2_1_H + +#include "DeckLinkAPI.h" +#include "DeckLinkAPIMemoryAllocator_v14_2_1.h" +#include "DeckLinkAPIVideoFrame_v14_2_1.h" +#include "DeckLinkAPIScreenPreviewCallback_v14_2_1.h" + +// Type Declarations + +BMD_CONST REFIID IID_IDeckLinkMutableVideoFrame_v14_2_1 = /* 69E2639F-40DA-4E19-B6F2-20ACE815C390 */ { 0x69, 0xE2, 0x63, 0x9F, 0x40, 0xDA, 0x4E, 0x19, 0xB6, 0xF2, 0x20, 0xAC, 0xE8, 0x15, 0xC3, 0x90 }; +BMD_CONST REFIID IID_IDeckLinkVideoOutputCallback_v14_2_1 = /* 20AA5225-1958-47CB-820B-80A8D521A6EE */ { 0x20, 0xAA, 0x52, 0x25, 0x19, 0x58, 0x47, 0xCB, 0x82, 0x0B, 0x80, 0xA8, 0xD5, 0x21, 0xA6, 0xEE }; +BMD_CONST REFIID IID_IDeckLinkOutput_v14_2_1 = /* BE2D9020-461E-442F-84B7-E949CB953B9D */ { 0xBE, 0x2D, 0x90, 0x20, 0x46, 0x1E, 0x44, 0x2F, 0x84, 0xB7, 0xE9, 0x49, 0xCB, 0x95, 0x3B, 0x9D }; + +/* Interface IDeckLinkMutableVideoFrame - Created by IDeckLinkOutput::CreateVideoFrame. */ + +class BMD_PUBLIC IDeckLinkMutableVideoFrame_v14_2_1 : public IDeckLinkVideoFrame_v14_2_1 +{ +public: + virtual HRESULT SetFlags (/* in */ BMDFrameFlags newFlags) = 0; + virtual HRESULT SetTimecode (/* in */ BMDTimecodeFormat format, /* in */ IDeckLinkTimecode* timecode) = 0; + virtual HRESULT SetTimecodeFromComponents (/* in */ BMDTimecodeFormat format, /* in */ uint8_t hours, /* in */ uint8_t minutes, /* in */ uint8_t seconds, /* in */ uint8_t frames, /* in */ BMDTimecodeFlags flags) = 0; + virtual HRESULT SetAncillaryData (/* in */ IDeckLinkVideoFrameAncillary* ancillary) = 0; + virtual HRESULT SetTimecodeUserBits (/* in */ BMDTimecodeFormat format, /* in */ BMDTimecodeUserBits userBits) = 0; + +protected: + virtual ~IDeckLinkMutableVideoFrame_v14_2_1 () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkVideoOutputCallback - Frame completion callback. */ + +class BMD_PUBLIC IDeckLinkVideoOutputCallback_v14_2_1 : public IUnknown +{ +public: + virtual HRESULT ScheduledFrameCompleted (/* in */ IDeckLinkVideoFrame_v14_2_1* completedFrame, /* in */ BMDOutputFrameCompletionResult result) = 0; + virtual HRESULT ScheduledPlaybackHasStopped (void) = 0; + +protected: + virtual ~IDeckLinkVideoOutputCallback_v14_2_1 () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkOutput - Created by QueryInterface from IDeckLink. */ + +class BMD_PUBLIC IDeckLinkOutput_v14_2_1 : public IUnknown +{ +public: + virtual HRESULT DoesSupportVideoMode (/* in */ BMDVideoConnection connection /* If a value of bmdVideoConnectionUnspecified is specified, the caller does not care about the connection */, /* in */ BMDDisplayMode requestedMode, /* in */ BMDPixelFormat requestedPixelFormat, /* in */ BMDVideoOutputConversionMode conversionMode, /* in */ BMDSupportedVideoModeFlags flags, /* out */ BMDDisplayMode* actualMode, /* out */ bool* supported) = 0; + virtual HRESULT GetDisplayMode (/* in */ BMDDisplayMode displayMode, /* out */ IDeckLinkDisplayMode** resultDisplayMode) = 0; + virtual HRESULT GetDisplayModeIterator (/* out */ IDeckLinkDisplayModeIterator** iterator) = 0; + virtual HRESULT SetScreenPreviewCallback (/* in */ IDeckLinkScreenPreviewCallback_v14_2_1* previewCallback) = 0; + + /* Video Output */ + + virtual HRESULT EnableVideoOutput (/* in */ BMDDisplayMode displayMode, /* in */ BMDVideoOutputFlags flags) = 0; + virtual HRESULT DisableVideoOutput (void) = 0; + virtual HRESULT SetVideoOutputFrameMemoryAllocator (/* in */ IDeckLinkMemoryAllocator_v14_2_1* theAllocator) = 0; + virtual HRESULT CreateVideoFrame (/* in */ int32_t width, /* in */ int32_t height, /* in */ int32_t rowBytes, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDFrameFlags flags, /* out */ IDeckLinkMutableVideoFrame_v14_2_1** outFrame) = 0; + virtual HRESULT CreateAncillaryData (/* in */ BMDPixelFormat pixelFormat, /* out */ IDeckLinkVideoFrameAncillary** outBuffer) = 0; // Use of IDeckLinkVideoFrameAncillaryPackets is preferred + virtual HRESULT DisplayVideoFrameSync (/* in */ IDeckLinkVideoFrame_v14_2_1* theFrame) = 0; + virtual HRESULT ScheduleVideoFrame (/* in */ IDeckLinkVideoFrame_v14_2_1* theFrame, /* in */ BMDTimeValue displayTime, /* in */ BMDTimeValue displayDuration, /* in */ BMDTimeScale timeScale) = 0; + virtual HRESULT SetScheduledFrameCompletionCallback (/* in */ IDeckLinkVideoOutputCallback_v14_2_1* theCallback) = 0; + virtual HRESULT GetBufferedVideoFrameCount (/* out */ uint32_t* bufferedFrameCount) = 0; + + /* Audio Output */ + + virtual HRESULT EnableAudioOutput (/* in */ BMDAudioSampleRate sampleRate, /* in */ BMDAudioSampleType sampleType, /* in */ uint32_t channelCount, /* in */ BMDAudioOutputStreamType streamType) = 0; + virtual HRESULT DisableAudioOutput (void) = 0; + virtual HRESULT WriteAudioSamplesSync (/* in */ void* buffer, /* in */ uint32_t sampleFrameCount, /* out */ uint32_t* sampleFramesWritten) = 0; + virtual HRESULT BeginAudioPreroll (void) = 0; + virtual HRESULT EndAudioPreroll (void) = 0; + virtual HRESULT ScheduleAudioSamples (/* in */ void* buffer, /* in */ uint32_t sampleFrameCount, /* in */ BMDTimeValue streamTime, /* in */ BMDTimeScale timeScale, /* out */ uint32_t* sampleFramesWritten) = 0; + virtual HRESULT GetBufferedAudioSampleFrameCount (/* out */ uint32_t* bufferedSampleFrameCount) = 0; + virtual HRESULT FlushBufferedAudioSamples (void) = 0; + virtual HRESULT SetAudioCallback (/* in */ IDeckLinkAudioOutputCallback* theCallback) = 0; + + /* Output Control */ + + virtual HRESULT StartScheduledPlayback (/* in */ BMDTimeValue playbackStartTime, /* in */ BMDTimeScale timeScale, /* in */ double playbackSpeed) = 0; + virtual HRESULT StopScheduledPlayback (/* in */ BMDTimeValue stopPlaybackAtTime, /* out */ BMDTimeValue* actualStopTime, /* in */ BMDTimeScale timeScale) = 0; + virtual HRESULT IsScheduledPlaybackRunning (/* out */ bool* active) = 0; + virtual HRESULT GetScheduledStreamTime (/* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue* streamTime, /* out */ double* playbackSpeed) = 0; + virtual HRESULT GetReferenceStatus (/* out */ BMDReferenceStatus* referenceStatus) = 0; + + /* Hardware Timing */ + + virtual HRESULT GetHardwareReferenceClock (/* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue* hardwareTime, /* out */ BMDTimeValue* timeInFrame, /* out */ BMDTimeValue* ticksPerFrame) = 0; + virtual HRESULT GetFrameCompletionReferenceTimestamp (/* in */ IDeckLinkVideoFrame_v14_2_1* theFrame, /* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue* frameCompletionTimestamp) = 0; + +protected: + virtual ~IDeckLinkOutput_v14_2_1 () {} // call Release method to drop reference count +}; + +#endif diff --git a/services/capture/sdk/DeckLinkAPIVideoOutput_v15_3_1.h b/services/capture/sdk/DeckLinkAPIVideoOutput_v15_3_1.h new file mode 100644 index 0000000..cd9bff6 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPIVideoOutput_v15_3_1.h @@ -0,0 +1,103 @@ +/* -LICENSE-START- +** Copyright (c) 2025 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit (“EULA”) available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#pragma once + +#include "DeckLinkAPI_v15_3_1.h" + +// Type Declarations + +BMD_CONST REFIID IID_IDeckLinkOutput_v15_3_1 = /* 1A8077F1-9FE2-4533-8147-2294305E253F */ { 0x1A,0x80,0x77,0xF1,0x9F,0xE2,0x45,0x33,0x81,0x47,0x22,0x94,0x30,0x5E,0x25,0x3F }; + +#if defined(__cplusplus) + +/* Interface IDeckLinkOutput - Created by QueryInterface from IDeckLink. */ + +class BMD_PUBLIC IDeckLinkOutput_v15_3_1 : public IUnknown +{ +public: + virtual HRESULT DoesSupportVideoMode (/* in */ BMDVideoConnection connection /* If a value of bmdVideoConnectionUnspecified is specified, the caller does not care about the connection */, /* in */ BMDDisplayMode requestedMode, /* in */ BMDPixelFormat requestedPixelFormat, /* in */ BMDVideoOutputConversionMode conversionMode, /* in */ BMDSupportedVideoModeFlags flags, /* out */ BMDDisplayMode* actualMode, /* out */ bool* supported) = 0; + virtual HRESULT GetDisplayMode (/* in */ BMDDisplayMode displayMode, /* out */ IDeckLinkDisplayMode** resultDisplayMode) = 0; + virtual HRESULT GetDisplayModeIterator (/* out */ IDeckLinkDisplayModeIterator** iterator) = 0; + virtual HRESULT SetScreenPreviewCallback (/* in */ IDeckLinkScreenPreviewCallback* previewCallback) = 0; + + /* Video Output */ + + virtual HRESULT EnableVideoOutput (/* in */ BMDDisplayMode displayMode, /* in */ BMDVideoOutputFlags flags) = 0; + virtual HRESULT DisableVideoOutput (void) = 0; + virtual HRESULT CreateVideoFrame (/* in */ int32_t width, /* in */ int32_t height, /* in */ int32_t rowBytes, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDFrameFlags flags, /* out */ IDeckLinkMutableVideoFrame** outFrame) = 0; + virtual HRESULT CreateVideoFrameWithBuffer (/* in */ int32_t width, /* in */ int32_t height, /* in */ int32_t rowBytes, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDFrameFlags flags, /* in */ IDeckLinkVideoBuffer_v15_3_1* buffer, /* out */ IDeckLinkMutableVideoFrame** outFrame) = 0; + virtual HRESULT RowBytesForPixelFormat (/* in */ BMDPixelFormat pixelFormat, /* in */ int32_t width, /* out */ int32_t* rowBytes) = 0; + virtual HRESULT CreateAncillaryData (/* in */ BMDPixelFormat pixelFormat, /* out */ IDeckLinkVideoFrameAncillary** outBuffer) = 0; // Use of IDeckLinkVideoFrameAncillaryPackets is preferred + virtual HRESULT DisplayVideoFrameSync (/* in */ IDeckLinkVideoFrame* theFrame) = 0; + virtual HRESULT ScheduleVideoFrame (/* in */ IDeckLinkVideoFrame* theFrame, /* in */ BMDTimeValue displayTime, /* in */ BMDTimeValue displayDuration, /* in */ BMDTimeScale timeScale) = 0; + virtual HRESULT SetScheduledFrameCompletionCallback (/* in */ IDeckLinkVideoOutputCallback* theCallback) = 0; + virtual HRESULT GetBufferedVideoFrameCount (/* out */ uint32_t* bufferedFrameCount) = 0; + + /* Audio Output */ + + virtual HRESULT EnableAudioOutput (/* in */ BMDAudioSampleRate sampleRate, /* in */ BMDAudioSampleType sampleType, /* in */ uint32_t channelCount, /* in */ BMDAudioOutputStreamType streamType) = 0; + virtual HRESULT DisableAudioOutput (void) = 0; + virtual HRESULT WriteAudioSamplesSync (/* in */ void* buffer, /* in */ uint32_t sampleFrameCount, /* out */ uint32_t* sampleFramesWritten) = 0; + virtual HRESULT BeginAudioPreroll (void) = 0; + virtual HRESULT EndAudioPreroll (void) = 0; + virtual HRESULT ScheduleAudioSamples (/* in */ void* buffer, /* in */ uint32_t sampleFrameCount, /* in */ BMDTimeValue streamTime, /* in */ BMDTimeScale timeScale, /* out */ uint32_t* sampleFramesWritten) = 0; + virtual HRESULT GetBufferedAudioSampleFrameCount (/* out */ uint32_t* bufferedSampleFrameCount) = 0; + virtual HRESULT FlushBufferedAudioSamples (void) = 0; + virtual HRESULT SetAudioCallback (/* in */ IDeckLinkAudioOutputCallback* theCallback) = 0; + + /* Output Control */ + + virtual HRESULT StartScheduledPlayback (/* in */ BMDTimeValue playbackStartTime, /* in */ BMDTimeScale timeScale, /* in */ double playbackSpeed) = 0; + virtual HRESULT StopScheduledPlayback (/* in */ BMDTimeValue stopPlaybackAtTime, /* out */ BMDTimeValue* actualStopTime, /* in */ BMDTimeScale timeScale) = 0; + virtual HRESULT IsScheduledPlaybackRunning (/* out */ bool* active) = 0; + virtual HRESULT GetScheduledStreamTime (/* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue* streamTime, /* out */ double* playbackSpeed) = 0; + virtual HRESULT GetReferenceStatus (/* out */ BMDReferenceStatus* referenceStatus) = 0; + + /* Hardware Timing */ + + virtual HRESULT GetHardwareReferenceClock (/* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue* hardwareTime, /* out */ BMDTimeValue* timeInFrame, /* out */ BMDTimeValue* ticksPerFrame) = 0; + virtual HRESULT GetFrameCompletionReferenceTimestamp (/* in */ IDeckLinkVideoFrame* theFrame, /* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue* frameCompletionTimestamp) = 0; + +protected: + virtual ~IDeckLinkOutput_v15_3_1 () {} // call Release method to drop reference count +}; + +#endif // defined(__cplusplus) diff --git a/services/capture/sdk/DeckLinkAPI_v10_11.h b/services/capture/sdk/DeckLinkAPI_v10_11.h new file mode 100644 index 0000000..cf7ce8f --- /dev/null +++ b/services/capture/sdk/DeckLinkAPI_v10_11.h @@ -0,0 +1,134 @@ +/* -LICENSE-START- +** Copyright (c) 2018 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPI_v10_11_H +#define BMD_DECKLINKAPI_v10_11_H + +#include "DeckLinkAPI.h" + +// Interface ID Declarations + +BMD_CONST REFIID IID_IDeckLinkAttributes_v10_11 = /* ABC11843-D966-44CB-96E2-A1CB5D3135C4 */ {0xAB,0xC1,0x18,0x43,0xD9,0x66,0x44,0xCB,0x96,0xE2,0xA1,0xCB,0x5D,0x31,0x35,0xC4}; +BMD_CONST REFIID IID_IDeckLinkNotification_v10_11 = /* 0A1FB207-E215-441B-9B19-6FA1575946C5 */ {0x0A,0x1F,0xB2,0x07,0xE2,0x15,0x44,0x1B,0x9B,0x19,0x6F,0xA1,0x57,0x59,0x46,0xC5}; + +/* Enum BMDDisplayModeSupport_v10_11 - Output mode supported flags */ + +typedef uint32_t BMDDisplayModeSupport_v10_11; +enum _BMDDisplayModeSupport_v10_11 { + bmdDisplayModeNotSupported_v10_11 = 0, + bmdDisplayModeSupported_v10_11, + bmdDisplayModeSupportedWithConversion_v10_11 +}; + +/* Enum BMDDuplexMode_v10_11 - Duplex for configurable ports */ + +typedef uint32_t BMDDuplexMode_v10_11; +enum _BMDDuplexMode_v10_11 { + bmdDuplexModeFull_v10_11 = /* 'fdup' */ 0x66647570, + bmdDuplexModeHalf_v10_11 = /* 'hdup' */ 0x68647570 +}; + +/* Enum BMDDeckLinkAttributeID_v10_11 - DeckLink Attribute ID */ + +enum _BMDDeckLinkAttributeID_v10_11 { + + /* Flags */ + + BMDDeckLinkSupportsDuplexModeConfiguration_v10_11 = 'dupx', + BMDDeckLinkSupportsHDKeying_v10_11 = 'keyh', + + /* Integers */ + + BMDDeckLinkPairedDevicePersistentID_v10_11 = 'ppid', + BMDDeckLinkSupportsFullDuplex_v10_11 = 'fdup', +}; + +enum _BMDDeckLinkStatusID_v10_11 { + bmdDeckLinkStatusDuplexMode_v10_11 = 'dupx', +}; + +typedef uint32_t BMDDuplexStatus_v10_11; +enum _BMDDuplexStatus_v10_11 { + bmdDuplexFullDuplex_v10_11 = 'fdup', + bmdDuplexHalfDuplex_v10_11 = 'hdup', + bmdDuplexSimplex_v10_11 = 'splx', + bmdDuplexInactive_v10_11 = 'inac', +}; + +#if defined(__cplusplus) + +/* Interface IDeckLinkAttributes_v10_11 - DeckLink Attribute interface */ + +class BMD_PUBLIC IDeckLinkAttributes_v10_11 : public IUnknown +{ +public: + virtual HRESULT GetFlag (/* in */ BMDDeckLinkAttributeID cfgID, /* out */ bool *value) = 0; + virtual HRESULT GetInt (/* in */ BMDDeckLinkAttributeID cfgID, /* out */ int64_t *value) = 0; + virtual HRESULT GetFloat (/* in */ BMDDeckLinkAttributeID cfgID, /* out */ double *value) = 0; + virtual HRESULT GetString (/* in */ BMDDeckLinkAttributeID cfgID, /* out */ const char **value) = 0; + +protected: + virtual ~IDeckLinkAttributes_v10_11 () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkNotification_v10_11 - DeckLink Notification interface */ + +class BMD_PUBLIC IDeckLinkNotification_v10_11 : public IUnknown +{ +public: + virtual HRESULT Subscribe (/* in */ BMDNotifications topic, /* in */ IDeckLinkNotificationCallback *theCallback) = 0; + virtual HRESULT Unsubscribe (/* in */ BMDNotifications topic, /* in */ IDeckLinkNotificationCallback *theCallback) = 0; +}; + +/* Functions */ + +extern "C" { + + BMD_PUBLIC IDeckLinkIterator* CreateDeckLinkIteratorInstance_v10_11 (void); + BMD_PUBLIC IDeckLinkDiscovery* CreateDeckLinkDiscoveryInstance_v10_11 (void); + BMD_PUBLIC IDeckLinkAPIInformation* CreateDeckLinkAPIInformationInstance_v10_11 (void); + BMD_PUBLIC IDeckLinkGLScreenPreviewHelper* CreateOpenGLScreenPreviewHelper_v10_11 (void); + BMD_PUBLIC IDeckLinkVideoConversion* CreateVideoConversionInstance_v10_11 (void); + BMD_PUBLIC IDeckLinkVideoFrameAncillaryPackets* CreateVideoFrameAncillaryPacketsInstance_v10_11 (void); // For use when creating a custom IDeckLinkVideoFrame without wrapping IDeckLinkOutput::CreateVideoFrame + +} + +#endif // defined(__cplusplus) +#endif /* defined(BMD_DECKLINKAPI_v10_11_H) */ diff --git a/services/capture/sdk/DeckLinkAPI_v10_2.h b/services/capture/sdk/DeckLinkAPI_v10_2.h new file mode 100644 index 0000000..126e461 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPI_v10_2.h @@ -0,0 +1,68 @@ +/* -LICENSE-START- +** Copyright (c) 2014 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPI_v10_2_H +#define BMD_DECKLINKAPI_v10_2_H + +#include "DeckLinkAPI.h" + +// Type Declarations + +/* Enum BMDDeckLinkConfigurationID - DeckLink Configuration ID */ + +typedef uint32_t BMDDeckLinkConfigurationID_v10_2; +enum _BMDDeckLinkConfigurationID_v10_2 { + /* Video output flags */ + + bmdDeckLinkConfig3GBpsVideoOutput_v10_2 = '3gbs', +}; + +/* Enum BMDAudioConnection_v10_2 - Audio connection types */ + +typedef uint32_t BMDAudioConnection_v10_2; +enum _BMDAudioConnection_v10_2 { + bmdAudioConnectionEmbedded_v10_2 = /* 'embd' */ 0x656D6264, + bmdAudioConnectionAESEBU_v10_2 = /* 'aes ' */ 0x61657320, + bmdAudioConnectionAnalog_v10_2 = /* 'anlg' */ 0x616E6C67, + bmdAudioConnectionAnalogXLR_v10_2 = /* 'axlr' */ 0x61786C72, + bmdAudioConnectionAnalogRCA_v10_2 = /* 'arca' */ 0x61726361 +}; + +#endif /* defined(BMD_DECKLINKAPI_v10_2_H) */ diff --git a/services/capture/sdk/DeckLinkAPI_v10_4.h b/services/capture/sdk/DeckLinkAPI_v10_4.h new file mode 100644 index 0000000..59be138 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPI_v10_4.h @@ -0,0 +1,58 @@ +/* -LICENSE-START- +** Copyright (c) 2015 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPI_v10_4_H +#define BMD_DECKLINKAPI_v10_4_H + +#include "DeckLinkAPI.h" + +// Type Declarations + +/* Enum BMDDeckLinkConfigurationID - DeckLink Configuration ID */ + +typedef uint32_t BMDDeckLinkConfigurationID_v10_4; +enum _BMDDeckLinkConfigurationID_v10_4 { + + /* Video output flags */ + + bmdDeckLinkConfigSingleLinkVideoOutput_v10_4 = /* 'sglo' */ 0x73676C6F, +}; + +#endif /* defined(BMD_DECKLINKAPI_v10_4_H) */ diff --git a/services/capture/sdk/DeckLinkAPI_v10_5.h b/services/capture/sdk/DeckLinkAPI_v10_5.h new file mode 100644 index 0000000..35dee6a --- /dev/null +++ b/services/capture/sdk/DeckLinkAPI_v10_5.h @@ -0,0 +1,59 @@ +/* -LICENSE-START- +** Copyright (c) 2015 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPI_v10_5_H +#define BMD_DECKLINKAPI_v10_5_H + +#include "DeckLinkAPI.h" + +// Type Declarations + +/* Enum BMDDeckLinkAttributeID - DeckLink Attribute ID */ + +typedef uint32_t BMDDeckLinkAttributeID_v10_5; +enum _BMDDeckLinkAttributeID_v10_5 { + + /* Integers */ + + BMDDeckLinkDeviceBusyState_v10_5 = /* 'dbst' */ 0x64627374, +}; + +#endif /* defined(BMD_DECKLINKAPI_v10_5_H) */ + diff --git a/services/capture/sdk/DeckLinkAPI_v10_6.h b/services/capture/sdk/DeckLinkAPI_v10_6.h new file mode 100644 index 0000000..58aae5d --- /dev/null +++ b/services/capture/sdk/DeckLinkAPI_v10_6.h @@ -0,0 +1,63 @@ +/* -LICENSE-START- +** Copyright (c) 2016 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPI_v10_6_H +#define BMD_DECKLINKAPI_v10_6_H + +#include "DeckLinkAPI.h" + +// Type Declarations + +/* Enum BMDDeckLinkAttributeID - DeckLink Attribute ID */ + +typedef uint32_t BMDDeckLinkAttributeID_c10_6; +enum _BMDDeckLinkAttributeID_v10_6 { + + /* Flags */ + + BMDDeckLinkSupportsDesktopDisplay_v10_6 = /* 'extd' */ 0x65787464, +}; + +typedef uint32_t BMDIdleVideoOutputOperation_v10_6; +enum _BMDIdleVideoOutputOperation_v10_6 { + bmdIdleVideoOutputDesktop_v10_6 = /* 'desk' */ 0x6465736B +}; + +#endif /* defined(BMD_DECKLINKAPI_v10_6_H) */ diff --git a/services/capture/sdk/DeckLinkAPI_v10_9.h b/services/capture/sdk/DeckLinkAPI_v10_9.h new file mode 100644 index 0000000..347b908 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPI_v10_9.h @@ -0,0 +1,58 @@ +/* -LICENSE-START- +** Copyright (c) 2017 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPI_v10_9_H +#define BMD_DECKLINKAPI_v10_9_H + +#include "DeckLinkAPI.h" + +// Type Declarations + +/* Enum BMDDeckLinkAttributeID - DeckLink Attribute ID */ + +typedef uint32_t BMDDeckLinkConfigurationID_v10_9; +enum _BMDDeckLinkConfigurationID_v10_9 { + + /* Flags */ + + bmdDeckLinkConfig1080pNotPsF_v10_9 = 'fpro', +}; + +#endif /* defined(BMD_DECKLINKAPI_v10_9_H) */ diff --git a/services/capture/sdk/DeckLinkAPI_v11_5.h b/services/capture/sdk/DeckLinkAPI_v11_5.h new file mode 100644 index 0000000..521cf65 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPI_v11_5.h @@ -0,0 +1,113 @@ +/* -LICENSE-START- +** Copyright (c) 2020 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPI_v11_5_H +#define BMD_DECKLINKAPI_v11_5_H + +#include "DeckLinkAPI.h" + +BMD_CONST REFIID IID_IDeckLinkVideoFrameMetadataExtensions_v11_5 = /* D5973DC9-6432-46D0-8F0B-2496F8A1238F */ {0xD5,0x97,0x3D,0xC9,0x64,0x32,0x46,0xD0,0x8F,0x0B,0x24,0x96,0xF8,0xA1,0x23,0x8F}; + +/* Enum BMDDeckLinkFrameMetadataID - DeckLink Frame Metadata ID */ + +typedef uint32_t BMDDeckLinkFrameMetadataID_v11_5; +enum _BMDDeckLinkFrameMetadataID_v11_5 { + bmdDeckLinkFrameMetadataCintelFilmType_v11_5 = /* 'cfty' */ 0x63667479, // Current film type + bmdDeckLinkFrameMetadataCintelFilmGauge_v11_5 = /* 'cfga' */ 0x63666761, // Current film gauge + bmdDeckLinkFrameMetadataCintelKeykodeLow_v11_5 = /* 'ckkl' */ 0x636B6B6C, // Raw keykode value - low 64 bits + bmdDeckLinkFrameMetadataCintelKeykodeHigh_v11_5 = /* 'ckkh' */ 0x636B6B68, // Raw keykode value - high 64 bits + bmdDeckLinkFrameMetadataCintelTile1Size_v11_5 = /* 'ct1s' */ 0x63743173, // Size in bytes of compressed raw tile 1 + bmdDeckLinkFrameMetadataCintelTile2Size_v11_5 = /* 'ct2s' */ 0x63743273, // Size in bytes of compressed raw tile 2 + bmdDeckLinkFrameMetadataCintelTile3Size_v11_5 = /* 'ct3s' */ 0x63743373, // Size in bytes of compressed raw tile 3 + bmdDeckLinkFrameMetadataCintelTile4Size_v11_5 = /* 'ct4s' */ 0x63743473, // Size in bytes of compressed raw tile 4 + bmdDeckLinkFrameMetadataCintelImageWidth_v11_5 = /* 'IWPx' */ 0x49575078, // Width in pixels of image + bmdDeckLinkFrameMetadataCintelImageHeight_v11_5 = /* 'IHPx' */ 0x49485078, // Height in pixels of image + bmdDeckLinkFrameMetadataCintelLinearMaskingRedInRed_v11_5 = /* 'mrir' */ 0x6D726972, // Red in red linear masking parameter + bmdDeckLinkFrameMetadataCintelLinearMaskingGreenInRed_v11_5 = /* 'mgir' */ 0x6D676972, // Green in red linear masking parameter + bmdDeckLinkFrameMetadataCintelLinearMaskingBlueInRed_v11_5 = /* 'mbir' */ 0x6D626972, // Blue in red linear masking parameter + bmdDeckLinkFrameMetadataCintelLinearMaskingRedInGreen_v11_5 = /* 'mrig' */ 0x6D726967, // Red in green linear masking parameter + bmdDeckLinkFrameMetadataCintelLinearMaskingGreenInGreen_v11_5 = /* 'mgig' */ 0x6D676967, // Green in green linear masking parameter + bmdDeckLinkFrameMetadataCintelLinearMaskingBlueInGreen_v11_5 = /* 'mbig' */ 0x6D626967, // Blue in green linear masking parameter + bmdDeckLinkFrameMetadataCintelLinearMaskingRedInBlue_v11_5 = /* 'mrib' */ 0x6D726962, // Red in blue linear masking parameter + bmdDeckLinkFrameMetadataCintelLinearMaskingGreenInBlue_v11_5 = /* 'mgib' */ 0x6D676962, // Green in blue linear masking parameter + bmdDeckLinkFrameMetadataCintelLinearMaskingBlueInBlue_v11_5 = /* 'mbib' */ 0x6D626962, // Blue in blue linear masking parameter + bmdDeckLinkFrameMetadataCintelLogMaskingRedInRed_v11_5 = /* 'mlrr' */ 0x6D6C7272, // Red in red log masking parameter + bmdDeckLinkFrameMetadataCintelLogMaskingGreenInRed_v11_5 = /* 'mlgr' */ 0x6D6C6772, // Green in red log masking parameter + bmdDeckLinkFrameMetadataCintelLogMaskingBlueInRed_v11_5 = /* 'mlbr' */ 0x6D6C6272, // Blue in red log masking parameter + bmdDeckLinkFrameMetadataCintelLogMaskingRedInGreen_v11_5 = /* 'mlrg' */ 0x6D6C7267, // Red in green log masking parameter + bmdDeckLinkFrameMetadataCintelLogMaskingGreenInGreen_v11_5 = /* 'mlgg' */ 0x6D6C6767, // Green in green log masking parameter + bmdDeckLinkFrameMetadataCintelLogMaskingBlueInGreen_v11_5 = /* 'mlbg' */ 0x6D6C6267, // Blue in green log masking parameter + bmdDeckLinkFrameMetadataCintelLogMaskingRedInBlue_v11_5 = /* 'mlrb' */ 0x6D6C7262, // Red in blue log masking parameter + bmdDeckLinkFrameMetadataCintelLogMaskingGreenInBlue_v11_5 = /* 'mlgb' */ 0x6D6C6762, // Green in blue log masking parameter + bmdDeckLinkFrameMetadataCintelLogMaskingBlueInBlue_v11_5 = /* 'mlbb' */ 0x6D6C6262, // Blue in blue log masking parameter + bmdDeckLinkFrameMetadataCintelFilmFrameRate_v11_5 = /* 'cffr' */ 0x63666672, // Film frame rate + bmdDeckLinkFrameMetadataCintelOffsetToApplyHorizontal_v11_5 = /* 'otah' */ 0x6F746168, // Horizontal offset (pixels) to be applied to image + bmdDeckLinkFrameMetadataCintelOffsetToApplyVertical_v11_5 = /* 'otav' */ 0x6F746176, // Vertical offset (pixels) to be applied to image + bmdDeckLinkFrameMetadataCintelGainRed_v11_5 = /* 'LfRd' */ 0x4C665264, // Red gain parameter to apply after log + bmdDeckLinkFrameMetadataCintelGainGreen_v11_5 = /* 'LfGr' */ 0x4C664772, // Green gain parameter to apply after log + bmdDeckLinkFrameMetadataCintelGainBlue_v11_5 = /* 'LfBl' */ 0x4C66426C, // Blue gain parameter to apply after log + bmdDeckLinkFrameMetadataCintelLiftRed_v11_5 = /* 'GnRd' */ 0x476E5264, // Red lift parameter to apply after log and gain + bmdDeckLinkFrameMetadataCintelLiftGreen_v11_5 = /* 'GnGr' */ 0x476E4772, // Green lift parameter to apply after log and gain + bmdDeckLinkFrameMetadataCintelLiftBlue_v11_5 = /* 'GnBl' */ 0x476E426C, // Blue lift parameter to apply after log and gain + bmdDeckLinkFrameMetadataCintelHDRGainRed_v11_5 = /* 'HGRd' */ 0x48475264, // Red gain parameter to apply to linear data for HDR Combination + bmdDeckLinkFrameMetadataCintelHDRGainGreen_v11_5 = /* 'HGGr' */ 0x48474772, // Green gain parameter to apply to linear data for HDR Combination + bmdDeckLinkFrameMetadataCintelHDRGainBlue_v11_5 = /* 'HGBl' */ 0x4847426C, // Blue gain parameter to apply to linear data for HDR Combination + bmdDeckLinkFrameMetadataCintel16mmCropRequired_v11_5 = /* 'c16c' */ 0x63313663, // The image should be cropped to 16mm size + bmdDeckLinkFrameMetadataCintelInversionRequired_v11_5 = /* 'cinv' */ 0x63696E76, // The image should be colour inverted + bmdDeckLinkFrameMetadataCintelFlipRequired_v11_5 = /* 'cflr' */ 0x63666C72, // The image should be flipped horizontally + bmdDeckLinkFrameMetadataCintelFocusAssistEnabled_v11_5 = /* 'cfae' */ 0x63666165, // Focus Assist is currently enabled + bmdDeckLinkFrameMetadataCintelKeykodeIsInterpolated_v11_5 = /* 'kkii' */ 0x6B6B6969 // The keykode for this frame is interpolated from nearby keykodes +}; + +/* Interface IDeckLinkVideoFrameMetadataExtensions - Optional interface implemented on IDeckLinkVideoFrame to support frame metadata such as HDMI HDR information */ + +class BMD_PUBLIC IDeckLinkVideoFrameMetadataExtensions_v11_5 : public IUnknown +{ +public: + virtual HRESULT GetInt (/* in */ BMDDeckLinkFrameMetadataID_v11_5 metadataID, /* out */ int64_t *value) = 0; + virtual HRESULT GetFloat (/* in */ BMDDeckLinkFrameMetadataID_v11_5 metadataID, /* out */ double *value) = 0; + virtual HRESULT GetFlag (/* in */ BMDDeckLinkFrameMetadataID_v11_5 metadataID, /* out */ bool* value) = 0; + virtual HRESULT GetString (/* in */ BMDDeckLinkFrameMetadataID_v11_5 metadataID, /* out */ const char **value) = 0; + +protected: + virtual ~IDeckLinkVideoFrameMetadataExtensions_v11_5 () {} // call Release method to drop reference count +}; + +#endif /* defined(BMD_DECKLINKAPI_v11_5_H) */ diff --git a/services/capture/sdk/DeckLinkAPI_v11_5_1.h b/services/capture/sdk/DeckLinkAPI_v11_5_1.h new file mode 100644 index 0000000..2e91033 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPI_v11_5_1.h @@ -0,0 +1,57 @@ +/* -LICENSE-START- +** Copyright (c) 2020 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPI_v11_5_1_H +#define BMD_DECKLINKAPI_v11_5_1_H + +#include "DeckLinkAPI.h" + +/* Enum BMDDeckLinkStatusID - DeckLink Status ID */ + +typedef uint32_t BMDDeckLinkStatusID_v11_5_1; +enum _BMDDeckLinkStatusID_v11_5_1 { + + /* Video output flags */ + + bmdDeckLinkStatusDetectedVideoInputFlags_v11_5_1 = /* 'dvif' */ 0x64766966, + +}; + +#endif /* defined(BMD_DECKLINKAPI_v11_5_1_H) */ diff --git a/services/capture/sdk/DeckLinkAPI_v14_2_1.h b/services/capture/sdk/DeckLinkAPI_v14_2_1.h new file mode 100644 index 0000000..ec2ceb9 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPI_v14_2_1.h @@ -0,0 +1,110 @@ +/* -LICENSE-START- +** Copyright (c) 2018 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit (“EULA”) available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef BMD_DECKLINKAPI_v14_2_1_H +#define BMD_DECKLINKAPI_v14_2_1_H + +#include "DeckLinkAPI.h" +#include "DeckLinkAPIVideoConversion_v14_2_1.h" +#include "DeckLinkAPIGLScreenPreview_v14_2_1.h" +#include "DeckLinkAPIMetalScreenPreview_v14_2_1.h" +#include "DeckLinkAPIScreenPreviewCallback_v14_2_1.h" +#include "DeckLinkAPIVideoOutput_v14_2_1.h" +#include "DeckLinkAPIVideoInput_v14_2_1.h" +#include "DeckLinkAPIVideoFrame3DExtensions_v14_2_1.h" + +// Interface ID Declarations + +BMD_CONST REFIID IID_IDeckLinkEncoderInput_v14_2_1 = /* F222551D-13DF-4FD8-B587-9D4F19EC12C9 */ { 0xF2,0x22,0x55,0x1D,0x13,0xDF,0x4F,0xD8,0xB5,0x87,0x9D,0x4F,0x19,0xEC,0x12,0xC9 }; + +#if defined(__cplusplus) + +/* Interface IDeckLinkEncoderInput - Created by QueryInterface from IDeckLink. */ + +class BMD_PUBLIC IDeckLinkEncoderInput_v14_2_1 : public IUnknown +{ +public: + virtual HRESULT DoesSupportVideoMode (/* in */ BMDVideoConnection connection /* If a value of bmdVideoConnectionUnspecified is specified, the caller does not care about the connection */, /* in */ BMDDisplayMode requestedMode, /* in */ BMDPixelFormat requestedCodec, /* in */ uint32_t requestedCodecProfile, /* in */ BMDSupportedVideoModeFlags flags, /* out */ bool* supported) = 0; + virtual HRESULT GetDisplayMode (/* in */ BMDDisplayMode displayMode, /* out */ IDeckLinkDisplayMode** resultDisplayMode) = 0; + virtual HRESULT GetDisplayModeIterator (/* out */ IDeckLinkDisplayModeIterator** iterator) = 0; + + /* Video Input */ + + virtual HRESULT EnableVideoInput (/* in */ BMDDisplayMode displayMode, /* in */ BMDPixelFormat pixelFormat, /* in */ BMDVideoInputFlags flags) = 0; + virtual HRESULT DisableVideoInput (void) = 0; + virtual HRESULT GetAvailablePacketsCount (/* out */ uint32_t* availablePacketsCount) = 0; + virtual HRESULT SetMemoryAllocator (/* in */ IDeckLinkMemoryAllocator_v14_2_1* theAllocator) = 0; + + /* Audio Input */ + + virtual HRESULT EnableAudioInput (/* in */ BMDAudioFormat audioFormat, /* in */ BMDAudioSampleRate sampleRate, /* in */ BMDAudioSampleType sampleType, /* in */ uint32_t channelCount) = 0; + virtual HRESULT DisableAudioInput (void) = 0; + virtual HRESULT GetAvailableAudioSampleFrameCount (/* out */ uint32_t* availableSampleFrameCount) = 0; + + /* Input Control */ + + virtual HRESULT StartStreams (void) = 0; + virtual HRESULT StopStreams (void) = 0; + virtual HRESULT PauseStreams (void) = 0; + virtual HRESULT FlushStreams (void) = 0; + virtual HRESULT SetCallback (/* in */ IDeckLinkEncoderInputCallback* theCallback) = 0; + + /* Hardware Timing */ + + virtual HRESULT GetHardwareReferenceClock (/* in */ BMDTimeScale desiredTimeScale, /* out */ BMDTimeValue* hardwareTime, /* out */ BMDTimeValue* timeInFrame, /* out */ BMDTimeValue* ticksPerFrame) = 0; + +protected: + virtual ~IDeckLinkEncoderInput_v14_2_1 () {} // call Release method to drop reference count +}; + +/* Functions */ + +extern "C" { + BMD_PUBLIC IDeckLinkIterator* CreateDeckLinkIteratorInstance_v14_2_1(void); + BMD_PUBLIC IDeckLinkDiscovery* CreateDeckLinkDiscoveryInstance_v14_2_1(void); + BMD_PUBLIC IDeckLinkAPIInformation* CreateDeckLinkAPIInformationInstance_v14_2_1(void); + BMD_PUBLIC IDeckLinkGLScreenPreviewHelper_v14_2_1* CreateOpenGLScreenPreviewHelper_v14_2_1(void); + BMD_PUBLIC IDeckLinkGLScreenPreviewHelper_v14_2_1* CreateOpenGL3ScreenPreviewHelper_v14_2_1(void); // Requires OpenGL 3.2 support and provides improved performance and color handling + BMD_PUBLIC IDeckLinkVideoConversion_v14_2_1* CreateVideoConversionInstance_v14_2_1(void); + BMD_PUBLIC IDeckLinkVideoFrameAncillaryPackets* CreateVideoFrameAncillaryPacketsInstance_v14_2_1(void); // For use when creating a custom IDeckLinkVideoFrame without wrapping IDeckLinkOutput::CreateVideoFrame +} + +#endif // defined(__cplusplus) +#endif /* defined(BMD_DECKLINKAPI_v14_2_1_H) */ diff --git a/services/capture/sdk/DeckLinkAPI_v15_2.h b/services/capture/sdk/DeckLinkAPI_v15_2.h new file mode 100644 index 0000000..c7bfdd4 --- /dev/null +++ b/services/capture/sdk/DeckLinkAPI_v15_2.h @@ -0,0 +1,96 @@ +/* -LICENSE-START- + ** Copyright (c) 2025 Blackmagic Design + ** + ** Permission is hereby granted, free of charge, to any person or organization + ** obtaining a copy of the software and accompanying documentation (the + ** "Software") to use, reproduce, display, distribute, sub-license, execute, + ** and transmit the Software, and to prepare derivative works of the Software, + ** and to permit third-parties to whom the Software is furnished to do so, in + ** accordance with: + ** + ** (1) if the Software is obtained from Blackmagic Design, the End User License + ** Agreement for the Software Development Kit ("EULA") available at + ** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or + ** + ** (2) if the Software is obtained from any third party, such licensing terms + ** as notified by that third party, + ** + ** and all subject to the following: + ** + ** (3) the copyright notices in the Software and this entire statement, + ** including the above license grant, this restriction and the following + ** disclaimer, must be included in all copies of the Software, in whole or in + ** part, and all derivative works of the Software, unless such copies or + ** derivative works are solely in the form of machine-executable object code + ** generated by a source language processor. + ** + ** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS + ** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + ** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT + ** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE + ** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, + ** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + ** DEALINGS IN THE SOFTWARE. + ** + ** A copy of the Software is available free of charge at + ** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. + ** + ** -LICENSE-END- + */ + +#ifndef BMD_DECKLINKAPI_v15_2_H +#define BMD_DECKLINKAPI_v15_2_H + +#include "DeckLinkAPI.h" + +// Interface ID Declarations + +BMD_CONST REFIID IID_IDeckLinkAncillaryPacket_v15_2 = /* CC5BBF7E-029C-4D3B-9158-6000EF5E3670 */ { 0xCC,0x5B,0xBF,0x7E,0x02,0x9C,0x4D,0x3B,0x91,0x58,0x60,0x00,0xEF,0x5E,0x36,0x70 }; +BMD_CONST REFIID IID_IDeckLinkAncillaryPacketIterator_v15_2 = /* 3FC8994B-88FB-4C17-968F-9AAB69D964A7 */ { 0x3F,0xC8,0x99,0x4B,0x88,0xFB,0x4C,0x17,0x96,0x8F,0x9A,0xAB,0x69,0xD9,0x64,0xA7 }; +BMD_CONST REFIID IID_IDeckLinkVideoFrameAncillaryPackets_v15_2 = /* 6C186C0F-459E-41D8-AEE2-4812D81AEE68 */ { 0x6C,0x18,0x6C,0x0F,0x45,0x9E,0x41,0xD8,0xAE,0xE2,0x48,0x12,0xD8,0x1A,0xEE,0x68 }; + +/* Interface IDeckLinkAncillaryPacket - On output, user needs to implement this interface */ + +#if defined(__cplusplus) + +class BMD_PUBLIC IDeckLinkAncillaryPacket_v15_2 : public IUnknown +{ +public: + virtual HRESULT GetBytes (/* in */ BMDAncillaryPacketFormat format /* For output, only one format need be offered */, /* out */ const void** data /* Optional */, /* out */ uint32_t* size /* Optional */) = 0; + virtual uint8_t GetDID (void) = 0; + virtual uint8_t GetSDID (void) = 0; + virtual uint32_t GetLineNumber (void) = 0; // On output, zero is auto + virtual uint8_t GetDataStreamIndex (void) = 0; // Usually zero. Can only be 1 if non-SD and the first data stream is completely full + +protected: + virtual ~IDeckLinkAncillaryPacket_v15_2 () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkAncillaryPacketIterator - Enumerates ancillary packets */ + +class BMD_PUBLIC IDeckLinkAncillaryPacketIterator_v15_2 : public IUnknown +{ +public: + virtual HRESULT Next (/* out */ IDeckLinkAncillaryPacket_v15_2** packet) = 0; + +protected: + virtual ~IDeckLinkAncillaryPacketIterator_v15_2 () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkVideoFrameAncillaryPackets - Obtained through QueryInterface on an IDeckLinkVideoFrame object. */ + +class BMD_PUBLIC IDeckLinkVideoFrameAncillaryPackets_v15_2 : public IUnknown +{ +public: + virtual HRESULT GetPacketIterator (/* out */ IDeckLinkAncillaryPacketIterator_v15_2** iterator) = 0; + virtual HRESULT GetFirstPacketByID (/* in */ uint8_t DID, /* in */ uint8_t SDID, /* out */ IDeckLinkAncillaryPacket_v15_2** packet) = 0; + virtual HRESULT AttachPacket (/* in */ IDeckLinkAncillaryPacket_v15_2* packet) = 0; // Implement IDeckLinkAncillaryPacket to output your own + virtual HRESULT DetachPacket (/* in */ IDeckLinkAncillaryPacket_v15_2* packet) = 0; + virtual HRESULT DetachAllPackets (void) = 0; + +protected: + virtual ~IDeckLinkVideoFrameAncillaryPackets_v15_2 () {} // call Release method to drop reference count +}; + +#endif /* defined(__cplusplus) */ +#endif /* defined(BMD_DECKLINKAPI_H) */ diff --git a/services/capture/sdk/DeckLinkAPI_v15_3_1.h b/services/capture/sdk/DeckLinkAPI_v15_3_1.h new file mode 100644 index 0000000..b91dead --- /dev/null +++ b/services/capture/sdk/DeckLinkAPI_v15_3_1.h @@ -0,0 +1,189 @@ +/* -LICENSE-START- +** Copyright (c) 2025 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit (“EULA”) available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#pragma once + +#include "DeckLinkAPI.h" + +// Interface ID Declarations + +BMD_CONST REFIID IID_IDeckLinkStatus_v15_3_1 = /* 5F558200-4028-49BC-BEAC-DB3FA4A96E46 */ { 0x5F,0x55,0x82,0x00,0x40,0x28,0x49,0xBC,0xBE,0xAC,0xDB,0x3F,0xA4,0xA9,0x6E,0x46 }; +BMD_CONST REFIID IID_IDeckLinkVideoBuffer_v15_3_1 = /* CCB4B64A-5C86-4E02-B778-885D352709FE */ { 0xCC,0xB4,0xB6,0x4A,0x5C,0x86,0x4E,0x02,0xB7,0x78,0x88,0x5D,0x35,0x27,0x09,0xFE }; +BMD_CONST REFIID IID_IDeckLinkVideoBufferAllocator_v15_3_1 = /* 3481A4DF-2B11-4E55-AC61-836B87985E9A */ { 0x34,0x81,0xA4,0xDF,0x2B,0x11,0x4E,0x55,0xAC,0x61,0x83,0x6B,0x87,0x98,0x5E,0x9A }; +BMD_CONST REFIID IID_IDeckLinkVideoBufferAllocatorProvider_v15_3_1 = /* 08B80403-BFF2-49D0-B448-8C908B9E9FC9 */ { 0x08,0xB8,0x04,0x03,0xBF,0xF2,0x49,0xD0,0xB4,0x48,0x8C,0x90,0x8B,0x9E,0x9F,0xC9 }; +BMD_CONST REFIID IID_IDeckLinkVideoConversion_v15_3_1 = /* A48755D9-8BD5-4727-A1E9-069FDEDBA6E9 */ { 0xA4,0x87,0x55,0xD9,0x8B,0xD5,0x47,0x27,0xA1,0xE9,0x06,0x9F,0xDE,0xDB,0xA6,0xE9 }; +BMD_CONST REFIID IID_IDeckLinkProfileAttributes_v15_3_1 = /* 17D4BF8E-4911-473A-80A0-731CF6FF345B */ { 0x17,0xD4,0xBF,0x8E,0x49,0x11,0x47,0x3A,0x80,0xA0,0x73,0x1C,0xF6,0xFF,0x34,0x5B }; +BMD_CONST REFIID IID_IDeckLinkNotification_v15_3_1 = /* B85DF4C8-BDF5-47C1-8064-28162EBDD4EB */ { 0xB8,0x5D,0xF4,0xC8,0xBD,0xF5,0x47,0xC1,0x80,0x64,0x28,0x16,0x2E,0xBD,0xD4,0xEB }; + +#if defined(__cplusplus) + +/* Enum BMDDeckLinkStatusID_v15_3_1 - DeckLink Status ID */ + +typedef uint32_t BMDDeckLinkStatusID_v15_3_1; +enum _BMDDeckLinkStatusID_v15_3_1 +{ + /* Integers */ + bmdDeckLinkStatusDeviceTemperature_v15_3_1 = /* 'dtmp' */ 0x64746D70, + + bmdDeckLinkStatusEthernetLink_v15_3_1 = /* 'sels' */ 0x73656C73, + bmdDeckLinkStatusEthernetLinkMbps_v15_3_1 = /* 'sesp' */ 0x73657370, + + /* Strings */ + bmdDeckLinkStatusEthernetLocalIPAddress_v15_3_1 = /* 'seip' */ 0x73656970, + bmdDeckLinkStatusEthernetSubnetMask_v15_3_1 = /* 'sesm' */ 0x7365736D, + bmdDeckLinkStatusEthernetGatewayIPAddress_v15_3_1 = /* 'segw' */ 0x73656777, + bmdDeckLinkStatusEthernetPrimaryDNS_v15_3_1 = /* 'sepd' */ 0x73657064, + bmdDeckLinkStatusEthernetSecondaryDNS_v15_3_1 = /* 'sesd' */ 0x73657364, + bmdDeckLinkStatusEthernetVideoOutputAddress_v15_3_1 = /* 'soav' */ 0x736F6176, + bmdDeckLinkStatusEthernetAudioOutputAddress_v15_3_1 = /* 'soaa' */ 0x736F6161, + bmdDeckLinkStatusEthernetAncillaryOutputAddress_v15_3_1 = /* 'soaA' */ 0x736F6141, +}; + +/* Enum BMDDeckLinkAttributeID - DeckLink Attribute ID */ + +typedef uint32_t BMDDeckLinkAttributeID_v15_3_1; +enum _BMDDeckLinkAttributeID_v15_3_1 +{ + /* Strings */ + BMDDeckLinkEthernetMACAddress_v15_3_1 = /* 'eMAC' */ 0x654D4143, +}; + +/* Interface IDeckLinkStatus_v15_3_1 - DeckLink Status interface */ + +class BMD_PUBLIC IDeckLinkStatus_v15_3_1 : public IUnknown +{ +public: + virtual HRESULT GetFlag (/* in */ BMDDeckLinkStatusID statusID, /* out */ bool* value) = 0; + virtual HRESULT GetInt (/* in */ BMDDeckLinkStatusID statusID, /* out */ int64_t* value) = 0; + virtual HRESULT GetFloat (/* in */ BMDDeckLinkStatusID statusID, /* out */ double* value) = 0; + virtual HRESULT GetString (/* in */ BMDDeckLinkStatusID statusID, /* out */ const char** value) = 0; + virtual HRESULT GetBytes (/* in */ BMDDeckLinkStatusID statusID, /* out */ void* buffer, /* in, out */ uint32_t* bufferSize) = 0; + +protected: + virtual ~IDeckLinkStatus_v15_3_1 () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkVideoBuffer_v15_3_1 - Interface to encapsulate a video frame buffer; can be caller-implemented. */ + +class BMD_PUBLIC IDeckLinkVideoBuffer_v15_3_1 : public IUnknown +{ +public: + virtual HRESULT GetBytes (/* out */ void** buffer) = 0; + virtual HRESULT StartAccess (/* in */ BMDBufferAccessFlags flags) = 0; + virtual HRESULT EndAccess (/* in */ BMDBufferAccessFlags flags) = 0; + +protected: + virtual ~IDeckLinkVideoBuffer_v15_3_1 () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkVideoBufferAllocator_v15_3_1 - Buffer allocator for video. */ + +class BMD_PUBLIC IDeckLinkVideoBufferAllocator_v15_3_1 : public IUnknown +{ +public: + virtual HRESULT AllocateVideoBuffer (/* out */ IDeckLinkVideoBuffer_v15_3_1** allocatedBuffer) = 0; + +protected: + virtual ~IDeckLinkVideoBufferAllocator_v15_3_1 () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkVideoBufferAllocatorProvider_v15_3_1 - Allows EnableVideoInputWithAllocatorProvider to obtain allocators */ + +class BMD_PUBLIC IDeckLinkVideoBufferAllocatorProvider_v15_3_1 : public IUnknown +{ +public: + virtual HRESULT GetVideoBufferAllocator (/* in */ uint32_t bufferSize, /* in */ uint32_t width, /* in */ uint32_t height, /* in */ uint32_t rowBytes, /* in */ BMDPixelFormat pixelFormat, /* out */ IDeckLinkVideoBufferAllocator_v15_3_1** allocator) = 0; + +protected: + virtual ~IDeckLinkVideoBufferAllocatorProvider_v15_3_1 () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkVideoConversion_v15_3_1 */ + +class BMD_PUBLIC IDeckLinkVideoConversion_v15_3_1 : public IUnknown +{ +public: + virtual HRESULT ConvertFrame (/* in */ IDeckLinkVideoFrame* srcFrame, /* in */ IDeckLinkVideoFrame* dstFrame) = 0; + virtual HRESULT ConvertNewFrame (/* in */ IDeckLinkVideoFrame* srcFrame, /* in */ BMDPixelFormat dstPixelFormat, /* in */ BMDColorspace dstColorspace, /* in */ IDeckLinkVideoBuffer_v15_3_1* dstBuffer, /* out */ IDeckLinkVideoFrame** dstFrame) = 0; + +protected: + virtual ~IDeckLinkVideoConversion_v15_3_1 () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkProfileAttributes_v15_3_1 - Created by QueryInterface from an IDeckLinkProfile, or from IDeckLink. When queried from IDeckLink, interrogates the active profile */ + +class BMD_PUBLIC IDeckLinkProfileAttributes_v15_3_1 : public IUnknown +{ +public: + virtual HRESULT GetFlag (/* in */ BMDDeckLinkAttributeID cfgID, /* out */ bool* value) = 0; + virtual HRESULT GetInt (/* in */ BMDDeckLinkAttributeID cfgID, /* out */ int64_t* value) = 0; + virtual HRESULT GetFloat (/* in */ BMDDeckLinkAttributeID cfgID, /* out */ double* value) = 0; + virtual HRESULT GetString (/* in */ BMDDeckLinkAttributeID cfgID, /* out */ const char** value) = 0; + +protected: + virtual ~IDeckLinkProfileAttributes_v15_3_1 () {} // call Release method to drop reference count +}; + +/* Interface IDeckLinkNotification_v15_3_1 - DeckLink Notification interface */ + +class BMD_PUBLIC IDeckLinkNotification_v15_3_1 : public IUnknown +{ +public: + virtual HRESULT Subscribe (/* in */ BMDNotifications topic, /* in */ IDeckLinkNotificationCallback *theCallback) = 0; + virtual HRESULT Unsubscribe (/* in */ BMDNotifications topic, /* in */ IDeckLinkNotificationCallback *theCallback) = 0; + +protected: + virtual ~IDeckLinkNotification_v15_3_1 () {} // call Release method to drop reference count +}; + +/* Functions */ + +extern "C" +{ + BMD_PUBLIC IDeckLinkIterator* CreateDeckLinkIteratorInstance_v15_3_1(void); + BMD_PUBLIC IDeckLinkDiscovery* CreateDeckLinkDiscoveryInstance_v15_3_1(void); + BMD_PUBLIC IDeckLinkAPIInformation* CreateDeckLinkAPIInformationInstance_v15_3_1(void); + BMD_PUBLIC IDeckLinkGLScreenPreviewHelper* CreateOpenGLScreenPreviewHelper_v15_3_1(void); + BMD_PUBLIC IDeckLinkGLScreenPreviewHelper* CreateOpenGL3ScreenPreviewHelper_v15_3_1(void); // Requires OpenGL 3.2 support and provides improved performance and color handling + BMD_PUBLIC IDeckLinkVideoConversion_v15_3_1* CreateVideoConversionInstance_v15_3_1(void); + BMD_PUBLIC IDeckLinkVideoFrameAncillaryPackets* CreateVideoFrameAncillaryPacketsInstance_v15_3_1(void); // For use when creating a custom IDeckLinkVideoFrame without wrapping IDeckLinkOutput::CreateVideoFrame +} + +#endif // defined(__cplusplus) diff --git a/services/capture/sdk/LinuxCOM.h b/services/capture/sdk/LinuxCOM.h new file mode 100644 index 0000000..1bdaf7f --- /dev/null +++ b/services/capture/sdk/LinuxCOM.h @@ -0,0 +1,116 @@ +/* -LICENSE-START- +** Copyright (c) 2009 Blackmagic Design +** +** Permission is hereby granted, free of charge, to any person or organization +** obtaining a copy of the software and accompanying documentation (the +** "Software") to use, reproduce, display, distribute, sub-license, execute, +** and transmit the Software, and to prepare derivative works of the Software, +** and to permit third-parties to whom the Software is furnished to do so, in +** accordance with: +** +** (1) if the Software is obtained from Blackmagic Design, the End User License +** Agreement for the Software Development Kit ("EULA") available at +** https://www.blackmagicdesign.com/EULA/DeckLinkSDK; or +** +** (2) if the Software is obtained from any third party, such licensing terms +** as notified by that third party, +** +** and all subject to the following: +** +** (3) the copyright notices in the Software and this entire statement, +** including the above license grant, this restriction and the following +** disclaimer, must be included in all copies of the Software, in whole or in +** part, and all derivative works of the Software, unless such copies or +** derivative works are solely in the form of machine-executable object code +** generated by a source language processor. +** +** (4) THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +** OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +** FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +** SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +** FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +** ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +** DEALINGS IN THE SOFTWARE. +** +** A copy of the Software is available free of charge at +** https://www.blackmagicdesign.com/desktopvideo_sdk under the EULA. +** +** -LICENSE-END- +*/ + +#ifndef __LINUX_COM_H_ +#define __LINUX_COM_H_ + +struct REFIID +{ + unsigned char byte0; + unsigned char byte1; + unsigned char byte2; + unsigned char byte3; + unsigned char byte4; + unsigned char byte5; + unsigned char byte6; + unsigned char byte7; + unsigned char byte8; + unsigned char byte9; + unsigned char byte10; + unsigned char byte11; + unsigned char byte12; + unsigned char byte13; + unsigned char byte14; + unsigned char byte15; +}; + +typedef REFIID CFUUIDBytes; +#define CFUUIDGetUUIDBytes(x) x + +typedef int HRESULT; +typedef unsigned long ULONG; +typedef void *LPVOID; + +#define SUCCEEDED(Status) ((HRESULT)(Status) >= 0) +#define FAILED(Status) ((HRESULT)(Status)<0) + +#define IS_ERROR(Status) ((unsigned long)(Status) >> 31 == SEVERITY_ERROR) +#define HRESULT_CODE(hr) ((hr) & 0xFFFF) +#define HRESULT_FACILITY(hr) (((hr) >> 16) & 0x1fff) +#define HRESULT_SEVERITY(hr) (((hr) >> 31) & 0x1) +#define SEVERITY_SUCCESS 0 +#define SEVERITY_ERROR 1 + +#define MAKE_HRESULT(sev,fac,code) ((HRESULT) (((unsigned long)(sev)<<31) | ((unsigned long)(fac)<<16) | ((unsigned long)(code))) ) + +#define S_OK ((HRESULT)0x00000000L) +#define S_FALSE ((HRESULT)0x00000001L) +#define E_UNEXPECTED ((HRESULT)0x8000FFFFL) +#define E_NOTIMPL ((HRESULT)0x80000001L) +#define E_OUTOFMEMORY ((HRESULT)0x80000002L) +#define E_INVALIDARG ((HRESULT)0x80000003L) +#define E_NOINTERFACE ((HRESULT)0x80000004L) +#define E_POINTER ((HRESULT)0x80000005L) +#define E_HANDLE ((HRESULT)0x80000006L) +#define E_ABORT ((HRESULT)0x80000007L) +#define E_FAIL ((HRESULT)0x80000008L) +#define E_ACCESSDENIED ((HRESULT)0x80000009L) + +#define STDMETHODCALLTYPE + +#define IID_IUnknown (REFIID){0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0xC0,0x00,0x00,0x00,0x00,0x00,0x00,0x46} +#define IUnknownUUID IID_IUnknown + +#ifndef BMD_PUBLIC + #define BMD_PUBLIC +#endif + +#ifdef __cplusplus +class BMD_PUBLIC IUnknown +{ + public: + virtual HRESULT STDMETHODCALLTYPE QueryInterface(REFIID iid, LPVOID *ppv) = 0; + virtual ULONG STDMETHODCALLTYPE AddRef(void) = 0; + virtual ULONG STDMETHODCALLTYPE Release(void) = 0; +}; +#endif + +#endif + diff --git a/services/capture/src/capture-manager.js b/services/capture/src/capture-manager.js index bab7902..77190ec 100644 --- a/services/capture/src/capture-manager.js +++ b/services/capture/src/capture-manager.js @@ -1,5 +1,5 @@ -import { spawn } from 'child_process'; -import { mkdirSync } from 'node:fs'; +import { spawn, execFileSync } from 'child_process'; +import { mkdirSync, writeFileSync, createReadStream, statSync, unlinkSync } from 'node:fs'; import { dirname } from 'node:path'; import { v4 as uuidv4 } from 'uuid'; import { createUploadStream } from './s3/client.js'; @@ -51,11 +51,88 @@ const S3_BUCKET = process.env.S3_BUCKET || 'wild-dragon'; // Growing-files mode: writes the master to a local SMB-backed share that the // editor can mount, instead of streaming to S3 in real time. The promotion // worker uploads the finalized file to S3 after the recording stops. -// Toggled per-process by `GROWING_ENABLED=true` on the capture container +// Toggled per-recorder via `GROWING_ENABLED=true` on the capture container // (see routes/recorders.js where the env is composed). const GROWING_ENABLED = process.env.GROWING_ENABLED === 'true'; const GROWING_PATH = process.env.GROWING_PATH || '/growing'; +// Approach A: when a CIFS source is supplied, this (privileged) container mounts +// the SMB landing-zone share at GROWING_PATH itself, using credentials supplied +// by the API from global Settings. Empty GROWING_SMB_MOUNT → no system mount +// (the host-bound /growing volume is used instead, or S3 streaming if growing +// is off). +// mount.cifs needs a UNC source (//host/share). Operators (and Settings) often +// store the share as an `smb://host/share` URL or a Windows `\\host\share` +// path; the kernel rejects those outright ("Mounting cifs URL not implemented +// yet"), which silently drops us back to S3. Normalize any of these forms to +// the `//host/share` UNC the mount helper accepts. +function toUncShare(raw) { + if (!raw) return ''; + let s = String(raw).trim().replace(/\\/g, '/'); // \\host\share -> //host/share + s = s.replace(/^smb:\/\//i, '//'); // smb://host/share -> //host/share + if (!s.startsWith('//')) s = '//' + s.replace(/^\/+/, ''); // host/share -> //host/share + return s; +} +const GROWING_SMB_MOUNT = toUncShare(process.env.GROWING_SMB_MOUNT || ''); +const GROWING_SMB_USERNAME = process.env.GROWING_SMB_USERNAME || ''; +const GROWING_SMB_PASSWORD = process.env.GROWING_SMB_PASSWORD || ''; +const GROWING_SMB_VERS = process.env.GROWING_SMB_VERS || '3.0'; +const SMB_CREDS_FILE = '/run/smb-creds'; + +// True when GROWING_PATH is already a mountpoint (e.g. a prior session left it +// mounted, or a host bind-mount is present). +function isMounted(path) { + try { execFileSync('mountpoint', ['-q', path]); return true; } + catch { return false; } +} + +// Mount the CIFS growing share at GROWING_PATH. Credentials go in a root-only +// file (NOT the command line) so they never appear in `ps`/process listings. +// Returns true on success (or if already mounted), false on failure — callers +// fall back to S3 streaming so a recording is never lost. +function mountGrowingShare() { + if (!GROWING_SMB_MOUNT) return false; + try { + if (isMounted(GROWING_PATH)) { + console.log('[capture] growing share already mounted at', GROWING_PATH); + return true; + } + try { mkdirSync(GROWING_PATH, { recursive: true }); } catch (_) {} + writeFileSync( + SMB_CREDS_FILE, + `username=${GROWING_SMB_USERNAME}\npassword=${GROWING_SMB_PASSWORD}\n`, + { mode: 0o600 } + ); + const opts = [ + `credentials=${SMB_CREDS_FILE}`, + 'uid=0', 'gid=0', 'file_mode=0664', 'dir_mode=0775', + `vers=${GROWING_SMB_VERS}`, + ].join(','); + execFileSync('mount', ['-t', 'cifs', GROWING_SMB_MOUNT, GROWING_PATH, '-o', opts], + { stdio: ['ignore', 'ignore', 'pipe'] }); + console.log('[capture] mounted CIFS growing share', GROWING_SMB_MOUNT, '->', GROWING_PATH); + return true; + } catch (err) { + const stderr = err.stderr ? err.stderr.toString().trim() : err.message; + console.error('[capture] CIFS mount failed (falling back to S3 streaming):', stderr); + return false; + } +} + +// Best-effort unmount on session stop. Ignores "not mounted". +function unmountGrowingShare() { + if (!GROWING_SMB_MOUNT) return; + try { + if (isMounted(GROWING_PATH)) { + execFileSync('umount', [GROWING_PATH], { stdio: ['ignore', 'ignore', 'pipe'] }); + console.log('[capture] unmounted growing share at', GROWING_PATH); + } + } catch (err) { + const stderr = err.stderr ? err.stderr.toString().trim() : err.message; + console.warn('[capture] growing share unmount failed (ignored):', stderr); + } +} + // ── Codec catalogue ────────────────────────────────────────────────────── // Each entry maps the UI value to a base ffmpeg flag set. Bitrate / framerate // / pix_fmt are layered on top from the per-recorder configuration. @@ -98,6 +175,59 @@ const VIDEO_CODECS = { }, }; +// nvenc codecs available in the capture image. Used both to validate the master +// codec and (issue #164) as the GPU-availability signal for the HLS preview. +const NVENC_CODECS = new Set(['h264_nvenc', 'hevc_nvenc']); + +// ── GPU availability for this sidecar (issue #164) ─────────────────────── +// The HLS monitor preview should be GPU-encoded (h264_nvenc) when — and only +// when — the GPU is actually attached to this capture container. A non-GPU +// recorder must keep using libx264, otherwise ffmpeg would fail to open the +// nvenc encoder and break the preview. +// +// Two signals, OR'd for robustness: +// 1) The master video codec is an nvenc codec. recorders.js derives `useGpu` +// from exactly this (GPU_CODECS = [hevc_nvenc, h264_nvenc]) and node-agent +// only attaches the NVIDIA runtime when useGpu is set — so an nvenc master +// codec is a reliable proxy for "this sidecar has the GPU". +// 2) node-agent injects NVIDIA_VISIBLE_DEVICES into the sidecar env whenever +// useGpu is set. This is the most direct in-process evidence the runtime +// attached a GPU, and covers the (currently unused) case where the GPU is +// present but the master codec is a CPU codec. +function gpuAvailableForPreview(masterCodec) { + if (NVENC_CODECS.has(masterCodec)) return true; + const vis = process.env.NVIDIA_VISIBLE_DEVICES; + if (vis && vis !== 'void' && vis !== 'none') return true; + return false; +} + +// Build the HLS preview video-encode args. `segTime` is the HLS segment length +// (seconds); we pin the GOP/keyframe interval to one IDR per segment so every +// segment starts on a keyframe (misaligned keyframes were the root cause of the +// playout preview black/flashing bug — keep the preview robust). +function buildHlsVideoArgs(masterCodec, framerate) { + // Frames-per-segment for keyframe alignment. The SDI preview runs at the + // capture framerate; default to 30 (matches the test-card rate) when unknown. + const fps = Number.parseFloat(framerate) || 30; + const segTime = 2; // matches -hls_time below + const gop = Math.max(1, Math.round(fps * segTime)); + if (gpuAvailableForPreview(masterCodec)) { + // Low-latency NVENC preset (p1 + ll tune). forced-idr + a keyframe every GOP + // frames keeps segment boundaries on IDR frames so hls.js can sync cleanly. + return [ + '-c:v', 'h264_nvenc', '-preset', 'p1', '-tune', 'll', + '-pix_fmt', 'yuv420p', '-b:v', '2M', + '-g', String(gop), '-forced-idr', '1', '-sc_threshold', '0', + ]; + } + // No GPU → keep the original CPU encode (must not break a non-GPU recorder). + return [ + '-c:v', 'libx264', '-preset', 'veryfast', '-tune', 'zerolatency', + '-pix_fmt', 'yuv420p', '-b:v', '2M', + '-g', String(gop), '-sc_threshold', '0', + ]; +} + const AUDIO_CODECS = { pcm_s16le: { args: ['-c:a', 'pcm_s16le'], bitrateControl: false }, pcm_s24le: { args: ['-c:a', 'pcm_s24le'], bitrateControl: false }, @@ -120,11 +250,261 @@ const CONTAINER_EXT = { mov: 'mov', mp4: 'mp4', mkv: 'mkv', mxf: 'mxf', ts: 'ts', }; +// Growing-file (edit-while-record) master format — MXF OP1a / XDCAM HD422, +// written by bmx (raw2bmx), NOT by ffmpeg's MXF muxer. +// +// This is the SIXTH iteration. The five prior attempts and WHY they failed +// (root-caused with authoritative sources + live structural analysis on the +// zampp2 capture image): +// +// 1) Fragmented MP4/MOV (+frag_keyframe+empty_moov): Premiere's QuickTime +// importer needs the classic stco/stsz/stts sample tables in one top-level +// moov; a fragmented MOV never has them while growing → "unable to open". +// +// 2) MXF OP1a / DNxHR HQ via ffmpeg: a DNxHR MXF SIGKILLed mid-write has ZERO +// body partitions and probes duration=N/A — DNxHR's large VBR frames don't +// trigger ffmpeg's per-partition flush, so only the header is on disk. +// +// 3) MPEG-TS H.264 High 4:2:2: Premiere's H.264 importer only accepts 8-bit +// 4:2:0. +// +// 4) MPEG-TS H.264 High 4:2:0 all-intra + AAC: STILL "unsupported compression +// type" — Premiere does not treat a raw .ts elementary stream as a clean +// importable growing clip. +// +// 5) MXF OP1a / XDCAM HD422 (MPEG-2 422) via ffmpeg's `-f mxf` muxer: this was +// believed to flush incremental body partitions, but PROVEN unable to +// produce a TRUE growing file — ffmpeg's MXF muxer writes the real +// duration/index only in the FOOTER at av_write_trailer (close). A +// metadata-only probe of the mid-write file reports duration=N/A right up +// until the writer exits, so Premiere's growing-file refresh never sees the +// file extend. (Same muxer that defers the index to EOF.) +// +// FIX — MXF OP1a carrying XDCAM HD422 (MPEG-2 422 @ 50 Mbps-class) + PCM, muxed +// by bmx/raw2bmx (the reference growing-OP1a writer, used by BBC/broadcast): +// +// WHY raw2bmx (the key discovery, PROVEN live on zampp2): +// * raw2bmx with `-t op1a --part ` writes a NEW body partition PLUS +// a NEW IndexTableSegment (carrying an updated IndexDuration) at the +// interval. The recorded duration is therefore readable — and INCREASES — +// from the header+index ALONE while the file is still being written, no +// footer needed. Verified by snapshotting the growing file mid-write and +// parsing the IndexTableSegment IndexDuration (local tag 0x3F0C): +// T= 3s: 7 partitions, max IndexDuration = 43 frames +// T= 8s: 17 partitions, max IndexDuration = 193 frames +// T=15s: 31 partitions, max IndexDuration = 403 frames +// The recorded frame count grows monotonically, lagging the record head by +// ~one partition interval — exactly the editable-head behaviour Premiere's +// growing-MXF reader consumes. A mid-write snapshot also decodes cleanly +// (mpeg2video 1920x1080 + 2×PCM, ffmpeg decode exit 0). Contrast with the +// ffmpeg `-f mxf` path (attempt #5): duration=N/A until close. +// * Adobe OFFICIALLY recommends MXF for growing-file workflows; XDCAM HD422 +// (MPEG-2 422 in MXF OP1a) + PCM is read by Premiere's built-in MXF reader +// with no plugin and is the broadcast-standard growing acquisition format. +// +// Pipeline (single SDI read — DeckLink cannot be opened twice): +// ffmpeg decklink → yadif → split → +// (a) MPEG-2 422 elementary VIDEO → named FIFO ┐ +// (b) PCM s16le AUDIO → named FIFO ├→ raw2bmx -t op1a +// (c) H.264 HLS preview (unchanged, keeps monitor live) +// raw2bmx reads the two essence FIFOs and writes the growing OP1a MXF to the +// CIFS share. On stop, ffmpeg is stopped cleanly so raw2bmx gets EOF and +// finalizes the footer; we await raw2bmx exit before reporting complete. +// +// Audio: PCM s16le — the native, broadcast-standard MXF audio mapping +// Premiere's MXF reader expects (NOT AAC). +// +// HONEST CAVEAT (cannot be verified without real Premiere on the workstation): +// the growing IndexDuration / body-partition structure is PROVEN above and +// matches Adobe's documented growing-MXF requirement — but only the user +// opening the growing .mxf in actual Premiere Pro (with "Automatically refresh +// growing files" enabled in Preferences > Media) can confirm the end-to-end +// edit-while-record. +// +// ── ffmpeg elementary-essence args (input to the FIFOs) ─────────────────── +// (a) MPEG-2 422, 8-bit 4:2:2 (Premiere-native XDCAM HD422). `-dc 10` + the CBR +// bitrate (operator target, default 50 Mbps) match XDCAM HD422 essence. `-g 15` +// keeps a short GOP. Muxed to a raw `mpeg2video` elementary stream (no +// container) so raw2bmx ingests it via --mpeg2lg_*. +const GROWING_VIDEO_ELEMENTARY_ARGS = [ + '-c:v', 'mpeg2video', '-pix_fmt', 'yuv422p', + '-dc', '10', '-g', '15', '-bf', '2', +]; +const GROWING_DEFAULT_BITRATE = '50M'; +const GROWING_EXT = 'mxf'; +// Video essence partition interval (frames). raw2bmx starts a new body partition +// + IndexTableSegment every PART_INTERVAL frames; this is the granularity at +// which the growing file's recorded duration advances. ~1s at 25/29.97 fps. +const GROWING_PART_INTERVAL_FRAMES = 30; + +// Map the recorder's resolution/fps to (1) the raw2bmx MPEG-2 Long GOP essence +// input flag and (2) the ffmpeg edit-rate (`-r`). raw2bmx needs the correct +// raster flag so the essence is wrapped as the right XDCAM HD422 variant; an +// 1080i59.94 default is used when the recorder fields are absent (the most +// common SDI broadcast raster). Returns: +// { rawFlag, frameRate, ffRate } +// where rawFlag is e.g. '--mpeg2lg_422p_hl_1080i', frameRate is the raw2bmx +// `-f` value (e.g. '30000/1001'), and ffRate is the ffmpeg `-r` value. +// +// NOTE: the exact interlaced-vs-progressive raster and the fps for a real +// DeckLink SDI feed can only be confirmed against the live signal. This derives +// a sensible value from the recorder's configured resolution/framerate; if those +// are absent or ambiguous it defaults to 1080i59.94. A live DeckLink confirm of +// the actual SDI raster/fps is advised before production use (see report). +function deriveGrowingRaster(resolution, framerate) { + // Normalise fps. Accept '59.94', '60000/1001', '25', '50', '30', '29.97'… + let fpsNum = null; + const fr = (framerate == null) ? '' : String(framerate).trim(); + if (/^\d+\/\d+$/.test(fr)) { + const [n, d] = fr.split('/').map(Number); + if (d) fpsNum = n / d; + } else if (fr && fr !== 'native') { + const f = Number.parseFloat(fr); + if (Number.isFinite(f)) fpsNum = f; + } + + // Resolution → height + scan. Accept '1920x1080', '1080i', '1080p', '720p', + // '720', '576i', etc. + const res = (resolution == null) ? '' : String(resolution).trim().toLowerCase(); + let height = null; + let scan = null; // 'i' | 'p' | null + const mDim = res.match(/(\d{3,4})x(\d{3,4})/); + if (mDim) height = parseInt(mDim[2], 10); + const mH = res.match(/(\d{3,4})\s*([ip])/); + if (mH) { height = parseInt(mH[1], 10); scan = mH[2]; } + if (height == null) { + const only = res.match(/\b(2160|1080|720|576|480)\b/); + if (only) height = parseInt(only[1], 10); + } + if (height == null) height = 1080; // default raster + + // ffmpeg rate + raw2bmx rate strings for the common broadcast rates. + function rates(fps) { + if (fps == null) return { ff: '30000/1001', raw: '30000/1001' }; // 1080i59.94 default + if (Math.abs(fps - 59.94) < 0.2 || Math.abs(fps - 29.97) < 0.05) + return { ff: '30000/1001', raw: '30000/1001' }; + if (Math.abs(fps - 60) < 0.05) return { ff: '60', raw: '60' }; + if (Math.abs(fps - 50) < 0.05) return { ff: '25', raw: '25' }; // 1080i50 → 25 fps frames + if (Math.abs(fps - 25) < 0.05) return { ff: '25', raw: '25' }; + if (Math.abs(fps - 24) < 0.2) return { ff: '24000/1001', raw: '24000/1001' }; + if (Math.abs(fps - 30) < 0.05) return { ff: '30', raw: '30' }; + return { ff: String(fps), raw: String(fps) }; + } + + // Default scan: 1080 → interlaced (broadcast SDI default), 720/below → p. + if (scan == null) scan = (height >= 1080) ? 'i' : 'p'; + const r = rates(fpsNum); + + let rawFlag; + if (height >= 1080) { + rawFlag = (scan === 'p') ? '--mpeg2lg_422p_hl_1080p' : '--mpeg2lg_422p_hl_1080i'; + } else if (height >= 720) { + rawFlag = '--mpeg2lg_422p_hl_720p'; // 720 is always progressive + if (fpsNum == null) { r.ff = '60000/1001'; r.raw = '60000/1001'; } + } else { + rawFlag = '--mpeg2lg_422p_ml_576i'; // SD 576i (PAL); 25 fps + r.ff = '25'; r.raw = '25'; + } + + return { rawFlag, frameRate: r.raw, ffRate: r.ff }; +} + +// ── Source-backend abstraction (issue #168) ────────────────────────────── +// The capture input was historically hard-wired to a single `-f decklink -i …` +// construction. To allow other SDI capture cards (Deltacast, AJA) to be added +// later without touching the encode/output/HLS pipeline, the per-backend FFmpeg +// INPUT-arg construction now lives behind this map. Each backend exposes: +// +// buildInput(ctx) -> { inputArgs, isNetwork } (may be async) +// +// where `ctx` carries the resolved recorder fields the backend needs (device). +// The rest of capture-manager consumes the returned `inputArgs` unchanged, so +// adding a backend is purely additive. +// +// IMPORTANT: `blackmagic` is a behaviour-preserving extraction of the previous +// default DeckLink path — for an existing DeckLink recorder the produced ffmpeg +// input args are byte-for-byte identical to the pre-refactor code. The +// `deltacast`/`aja` entries are stubs that throw until the hardware/SDK plumbing +// lands. +const sourceBackends = { + // BlackMagic DeckLink over SDI (the only backend implemented today). + // device may be an integer index (0-based) or a full device name string. + // FFmpeg 7.x DeckLink requires the full name (e.g. 'DeckLink Duo 2 (2)'). + // Map integer index -> name using ffmpeg -sources decklink at runtime. + // + // ffmpeg -sources decklink output format: + // Auto-detected sources for decklink: + // DeckLink Duo 2 + // DeckLink Duo 2 (2) + // Lines containing device names start with whitespace; the header line + // starts with a non-space character. Previous code used a v4l2-style + // hex-address regex that never matched DeckLink output → index 1+ always + // fell through to a wrong fallback, producing black output from port 2+. + blackmagic: { + async buildInput({ device }) { + let deckLinkName = String(device); + if (typeof device === 'number' || /^\d+$/.test(String(device))) { + const idx = parseInt(device, 10); + try { + const { execSync } = await import('child_process'); + const out = execSync('ffmpeg -hide_banner -sources decklink 2>&1', { encoding: 'utf-8', timeout: 5000 }); + const names = []; + for (const line of out.split('\n')) { + // DeckLink source lines: " 81:76669a80:00000000 [DeckLink Duo (1)] (none)" + const m = line.match(/^\s+[0-9a-f:]+\s+\[([^\]]+)\]/); + if (m) names.push(m[1]); + } + if (names[idx]) { + deckLinkName = names[idx]; + console.log(`[capture] DeckLink index ${idx} → "${deckLinkName}" (from ${names.length} detected: ${names.join(', ')})`); + } else { + // Fallback: cannot determine model name without enumeration. + // Log a warning — operator should check the detected device list. + console.warn(`[capture] DeckLink index ${idx} out of range (detected ${names.length} devices: ${names.join(', ')}). Falling back to index-only input — capture may fail.`); + deckLinkName = `DeckLink (${idx})`; + } + } catch (err) { + console.warn(`[capture] ffmpeg -sources decklink failed: ${err.message}. Using index ${device} directly.`); + // Pass the numeric index directly; some ffmpeg builds accept it. + deckLinkName = String(device); + } + } + return { + inputArgs: ['-f', 'decklink', '-i', deckLinkName], + isNetwork: false, + }; + }, + }, + + // Stubs — hardware/SDK plumbing not yet implemented. These throw clearly so a + // misconfigured recorder fails fast instead of silently falling back to the + // wrong card. + deltacast: { + buildInput() { + throw new Error('deltacast backend not yet implemented — requires hardware'); + }, + }, + aja: { + buildInput() { + throw new Error('aja backend not yet implemented — requires hardware'); + }, + }, +}; + function buildEncodeArgs({ codec, videoBitrate, framerate, audioCodec, audioBitrate, audioChannels, container, isNetwork, isProxy = false, + growing = false, }) { + // NOTE: the growing master is NOT muxed by ffmpeg any more — raw2bmx writes + // the growing OP1a MXF from elementary essence FIFOs (see start()). The + // growing ffmpeg command (elementary MPEG-2 422 video + PCM audio to FIFOs, + // plus the HLS preview) is constructed directly in start(), so buildEncodeArgs + // is no longer called with growing=true. The `growing` param is retained for + // call-site compatibility; if ever set, fall through to the finalized path so + // we never silently produce a wrong file. + const v = VIDEO_CODECS[codec] || (isProxy ? VIDEO_CODECS.h264 : VIDEO_CODECS.prores_hq); const a = AUDIO_CODECS[audioCodec] || (isProxy ? AUDIO_CODECS.aac : AUDIO_CODECS.pcm_s24le); const fmt = CONTAINER_FMT[container] || (isProxy ? 'mp4' : 'mov'); @@ -141,9 +521,20 @@ function buildEncodeArgs({ if (a.bitrateControl && audioBitrate) args.push('-b:a', audioBitrate); if (audioChannels) args.push('-ac', String(audioChannels)); + // moov-atom placement is the difference between a Premiere-openable master and + // a "file cannot be opened" error. + // + // Finalized masters (the S3-piped recording that stops cleanly) must NOT be + // fragmented. Adobe Premiere's QuickTime/MOV importer reads the classic + // stco/stsz/stts sample tables in a single top-level moov; a fragmented MOV + // (moof/trun, empty sample tables) makes Premiere report "file cannot be + // opened." We write a clean, non-fragmented MOV instead. `+faststart` puts the + // moov before mdat on the second pass so the file is instantly + // seekable/streamable too. if (fmt === 'mov' || fmt === 'mp4') { - args.push('-movflags', '+frag_keyframe+empty_moov'); + args.push('-movflags', '+faststart'); } + // ProRes-in-MOV must carry a QuickTime brand or some importers reject the tag. args.push('-f', fmt); return args; @@ -168,7 +559,7 @@ class CaptureManager { * Returns { inputArgs, isNetwork } * @private */ - async _buildInputArgs({ sourceType, device, sourceUrl, listen, listenPort, streamKey }) { + async _buildInputArgs({ sourceType, sourceBackend = 'blackmagic', device, sourceUrl, listen, listenPort, streamKey }) { if (sourceType === 'srt') { let url; if (listen) { @@ -195,32 +586,28 @@ class CaptureManager { return { inputArgs: ['-probesize','32M','-analyzeduration','10M','-fflags','+genpts','-i', sourceUrl], isNetwork: true }; } + // Deltacast SDI via VideoMaster SDK FFmpeg plugin. if (sourceType === 'deltacast') { const idx = (typeof device === 'number' || /^\d+$/.test(String(device))) ? parseInt(device, 10) : 0; const audioFifo = `/tmp/dc-audio-${this._sessionIdForBridge}`; - // Create the audio FIFO before spawning the bridge. const { execFileSync: _execFile } = await import('child_process'); const { unlinkSync: _unlink, existsSync: _exists } = await import('node:fs'); - // Remove any stale FIFO or file from a prior crashed session if (_exists(audioFifo)) { try { _unlink(audioFifo); } catch (_) {} } try { _execFile('mkfifo', [audioFifo]); } catch (e) { throw new Error(`Failed to create audio FIFO ${audioFifo}: ${e.message}`); } const bridge = spawn('deltacast-capture', [ - '--device', String(idx), - '--port', String(idx), - '--audio-pipe', audioFifo, - '--signal-timeout', '30', + '--device', String(idx), + '--port', String(idx), + '--audio-pipe', audioFifo, + '--signal-timeout', '30', ], { stdio: ['ignore', 'pipe', 'pipe'] }); const fmt = await readFirstStderrLine(bridge, 35_000); - // Log any subsequent bridge stderr (diagnostics, warnings) bridge.stderr.on('data', (d) => console.error(`[deltacast-bridge] ${d.toString().trimEnd()}`)); - // fmt: { width, height, fps_num, fps_den, interlaced, pix_fmt, - // audio_channels, audio_rate, device, port } return { inputArgs: [ @@ -241,50 +628,142 @@ class CaptureManager { }; } - // Default: SDI via DeckLink - // device may be an integer index (0-based) or a full device name string. - // FFmpeg 7.x DeckLink requires the full name (e.g. 'DeckLink Duo 2 (2)'). - // Map integer index -> name using ffmpeg -sources decklink at runtime. - // - // ffmpeg -sources decklink output format: - // Auto-detected sources for decklink: - // DeckLink Duo 2 - // DeckLink Duo 2 (2) - // Lines containing device names start with whitespace; the header line - // starts with a non-space character. Previous code used a v4l2-style - // hex-address regex that never matched DeckLink output → index 1+ always - // fell through to a wrong fallback, producing black output from port 2+. - let deckLinkName = String(device); - if (typeof device === 'number' || /^\d+$/.test(String(device))) { - const idx = parseInt(device, 10); - try { - const { execSync } = await import('child_process'); - const out = execSync('ffmpeg -hide_banner -sources decklink 2>&1', { encoding: 'utf-8', timeout: 5000 }); - const names = []; - for (const line of out.split('\n')) { - // DeckLink source lines: " 81:76669a80:00000000 [DeckLink Duo (1)] (none)" - const m = line.match(/^\s+[0-9a-f:]+\s+\[([^\]]+)\]/); - if (m) names.push(m[1]); - } - if (names[idx]) { - deckLinkName = names[idx]; - console.log(`[capture] DeckLink index ${idx} → "${deckLinkName}" (from ${names.length} detected: ${names.join(', ')})`); - } else { - // Fallback: cannot determine model name without enumeration. - // Log a warning — operator should check the detected device list. - console.warn(`[capture] DeckLink index ${idx} out of range (detected ${names.length} devices: ${names.join(', ')}). Falling back to index-only input — capture may fail.`); - deckLinkName = `DeckLink (${idx})`; - } - } catch (err) { - console.warn(`[capture] ffmpeg -sources decklink failed: ${err.message}. Using index ${device} directly.`); - // Pass the numeric index directly; some ffmpeg builds accept it. - deckLinkName = String(device); - } + // Default: SDI via a pluggable source backend (issue #168). The backend + // selection defaults to `blackmagic` (DeckLink) so existing SDI recorders + // behave exactly as before. Deltacast/AJA backends throw until their + // hardware/SDK plumbing lands. + const backend = sourceBackends[sourceBackend]; + if (!backend) { + throw new Error(`Unknown source backend "${sourceBackend}" — expected one of: ${Object.keys(sourceBackends).join(', ')}`); } - return { - inputArgs: ['-f', 'decklink', '-i', deckLinkName], - isNetwork: false, - }; + return await backend.buildInput({ device }); + } + + /** + * Build the bash orchestrator command for the GROWING master (raw2bmx). + * + * One ffmpeg reads the source once (DeckLink can't be opened twice) and writes + * THREE outputs: + * (a) MPEG-2 422 elementary VIDEO → video FIFO ─┐ raw2bmx -t op1a reads + * (b) PCM s16le AUDIO → audio FIFO ─┘ these and writes the + * growing OP1a MXF. + * (c) H.264 HLS preview (unchanged) — keeps the UI monitor live. + * + * FIFO orchestration (the tricky part — proven on the live capture node): + * raw2bmx opens its inputs lazily (video first, reads the header, THEN opens + * audio), while ffmpeg opens ALL its outputs up-front and blocks on the + * audio FIFO until a reader appears → classic open-order deadlock. We break + * it by having the parent shell PRIME both FIFOs read-write (non-blocking + * open) so neither child blocks on open. CRUCIAL: the children must NOT + * inherit a priming *writer* (it would keep the FIFO open and starve raw2bmx + * of EOF forever), so each child closes the priming FDs before exec. The + * parent holds the priming FDs (as a reader/writer) only until raw2bmx has + * opened BOTH FIFOs, then drops them — leaving ffmpeg as the SOLE writer, so + * when ffmpeg exits raw2bmx gets a clean EOF and finalizes the MXF footer. + * + * Stop/finalize: the orchestrator traps SIGINT/SIGTERM and forwards SIGINT to + * ffmpeg (clean stop → EOF to raw2bmx), then `wait`s for raw2bmx and exits + * with raw2bmx's status. The Node side spawns this with detached:true and, on + * stop(), signals it and AWAITS its exit — so the finalized, valid MXF is on + * the share before the promotion worker uploads it. + * + * Returns the argv for spawn('bash', argv). + */ + _buildGrowingOrchestrator({ inputArgs, videoBitrate, resolution, framerate, audioChannels, outPath, hlsDir, videoCodec }) { + const { rawFlag, frameRate, ffRate } = deriveGrowingRaster(resolution, framerate); + const vb = videoBitrate || GROWING_DEFAULT_BITRATE; + const ach = audioChannels ? Number(audioChannels) : 2; + + // ffmpeg argv (shell-quoted). One decklink read → yadif → split → 3 outputs. + const sh = (a) => "'" + String(a).replace(/'/g, `'\\''`) + "'"; + // `-y`: the FIFOs are pre-created by mkfifo, so ffmpeg must overwrite them + // without the interactive "File already exists. Overwrite? [y/N]" prompt + // (which would otherwise abort the video/audio outputs and produce nothing). + const ff = ['ffmpeg', '-y', '-hide_banner', '-loglevel', 'warning']; + // SDI input is interlaced; yadif then split into the master + preview taps. + const ffArgs = [ + ...inputArgs, + '-filter_complex', '[0:v]yadif=mode=1:deint=1,split=2[vhi][vlo]', + // (a) MPEG-2 422 elementary video → "$VF" + '-map', '[vhi]', + ...GROWING_VIDEO_ELEMENTARY_ARGS, + '-b:v', vb, '-minrate', vb, '-maxrate', vb, '-bufsize', vb, + '-r', ffRate, + '-f', 'mpeg2video', '@VF@', + // (b) PCM s16le audio → "$AF" + '-map', '0:a:0?', + '-c:a', 'pcm_s16le', '-ar', '48000', '-ac', String(ach), + '-f', 's16le', '@AF@', + ]; + let ffHls = []; + if (hlsDir) { + ffHls = [ + // (c) H.264 HLS preview — GPU-gated, unchanged behaviour. + '-map', '[vlo]', '-map', '0:a:0?', + ...buildHlsVideoArgs(videoCodec, framerate), + '-c:a', 'aac', '-b:a', '128k', '-ar', '44100', + '-f', 'hls', '-hls_time', '2', '-hls_list_size', '15', + '-hls_flags', 'delete_segments+append_list+omit_endlist', + '-hls_segment_filename', `${hlsDir}/seg-%05d.ts`, + `${hlsDir}/index.m3u8`, + ]; + } + // @VF@/@AF@ are placeholders for the FIFO path shell variables; emit them as + // unquoted "$VF"/"$AF" so the shell expands them, and shell-quote everything + // else. + const placeholder = (t) => (t === '@VF@' ? '"$VF"' : t === '@AF@' ? '"$AF"' : sh(t)); + const ffLine = [...ff, ...ffArgs, ...ffHls].map(placeholder).join(' '); + + // raw2bmx argv. Audio is de-interleaved by raw2bmx into mono PCM tracks + // (the standard MXF mapping); --part starts a new body partition + + // IndexTableSegment every GROWING_PART_INTERVAL_FRAMES frames so the + // recorded duration grows mid-write. + const bmx = [ + 'raw2bmx', '-t', 'op1a', '-o', '"$OUT"', '-f', frameRate, + '--part', String(GROWING_PART_INTERVAL_FRAMES), + rawFlag, '"$VF"', + '-s', '48000', '-q', '16', '--audio-chan', String(ach), '--pcm', '"$AF"', + ]; + const bmxLine = bmx + .map((t) => (t.startsWith('"$') ? t : sh(t))) + .join(' '); + + // The orchestration script. `set -m` is intentionally NOT used; we manage + // children explicitly. Priming FDs 7/8; children close them before exec. + const script = ` +set -u +VF=$(mktemp -u /tmp/grow_v.XXXXXX); AF=$(mktemp -u /tmp/grow_a.XXXXXX) +OUT=${sh(outPath)} +mkfifo "$VF" "$AF" +cleanup() { rm -f "$VF" "$AF"; } +trap cleanup EXIT +# Prime both FIFOs read-write (non-blocking) to break the open-order deadlock. +exec 7<>"$VF" 8<>"$AF" +# raw2bmx: close priming FDs (no stray writer) before exec so it sees real EOF. +( exec 7>&- 8>&-; exec ${bmxLine} ) & +BMXPID=$! +# ffmpeg: also closes priming FDs; it opens its own write ends. +( exec 7>&- 8>&-; exec ${ffLine} ) & +FFPID=$! +# Forward a clean stop to ffmpeg; raw2bmx then gets EOF and finalizes the footer. +stop() { kill -INT "$FFPID" 2>/dev/null; } +trap stop INT TERM +# Drop the parent priming FDs once raw2bmx has opened BOTH FIFOs, so ffmpeg is +# the sole writer (its EOF reaches raw2bmx). If raw2bmx dies early, bail. +for i in $(seq 1 200); do + kill -0 "$BMXPID" 2>/dev/null || break + n=$(ls -l /proc/$BMXPID/fd 2>/dev/null | grep -c -- "$VF\\|$AF") + [ "\${n:-0}" -ge 2 ] && break + sleep 0.1 +done +exec 7>&- 8>&- +# Wait for ffmpeg (source end), then for raw2bmx to finalize the footer. +wait "$FFPID"; FFRC=$? +wait "$BMXPID"; BMXRC=$? +echo "[grow] ffmpeg rc=$FFRC raw2bmx rc=$BMXRC out=$OUT" >&2 +exit "$BMXRC" +`; + return ['-c', script]; } /** @@ -300,6 +779,9 @@ class CaptureManager { clipName, device, sourceType = 'sdi', + // Source-backend selection for SDI capture (issue #168). Defaults to + // `blackmagic` (DeckLink) so existing recorders are unaffected. + sourceBackend = 'blackmagic', sourceUrl, listen = false, listenPort, @@ -328,15 +810,34 @@ class CaptureManager { } const sessionId = uuidv4(); - const hiresExt = CONTAINER_EXT[container] || 'mov'; const proxyExt = CONTAINER_EXT[proxyContainer] || 'mp4'; - const hiresKey = `projects/${projectId}/masters/${clipName}.${hiresExt}`; - // Growing-files: write master to the local SMB share instead of streaming - // to S3. Path is relative to the container's GROWING_PATH mount. - const growingPath = GROWING_ENABLED - ? `${GROWING_PATH}/${projectId}/${clipName}.${hiresExt}` + // Growing-files: write master to the SMB share instead of streaming to S3. + // Path is relative to the container's GROWING_PATH mount. + // + // Approach A: if a CIFS source is configured, mount it now. A mount failure + // is non-fatal — we fall back to S3 streaming so the recording is never + // lost. + let growingActive = GROWING_ENABLED; + if (growingActive && GROWING_SMB_MOUNT) { + if (!mountGrowingShare()) growingActive = false; // fall back to S3 + } + // Growing master is always MXF OP1a / XDCAM HD422 written by raw2bmx (the + // format Premiere reads while growing — see GROWING_VIDEO_ELEMENTARY_ARGS / + // _buildGrowingOrchestrator), regardless of the recorder's configured + // container — so it gets a .mxf extension, not the container's. + const growingPath = growingActive + ? `${GROWING_PATH}/${projectId}/${clipName}.${GROWING_EXT}` : null; + + // hiresKey MUST match the actual master format/destination: + // - growing active → the master is a growing OP1a MXF on the share; the + // promotion worker uploads it to this key, so it has the .mxf extension. + // (A stale .mov key here would make the proxy job download a nonexistent + // object → "unable to open the file on disk".) + // - growing fell back to S3 → the normal container extension. + const hiresExt = growingPath ? GROWING_EXT : (CONTAINER_EXT[container] || 'mov'); + const hiresKey = `projects/${projectId}/masters/${clipName}.${hiresExt}`; if (growingPath) { try { mkdirSync(dirname(growingPath), { recursive: true }); } catch (err) { console.error('[capture] could not create growing dir:', err.message); } @@ -357,10 +858,13 @@ class CaptureManager { this._sessionIdForBridge = sessionId; const { inputArgs, isNetwork, bridgeProcess = null, audioFifo = null, interlaced = false } = await this._buildInputArgs({ - sourceType, device, sourceUrl, listen, listenPort, streamKey, + sourceType, sourceBackend, device, sourceUrl, listen, listenPort, streamKey, }); - const hiresCodecArgs = buildEncodeArgs({ + // Non-growing master: ffmpeg muxes the finalized MOV directly. Growing + // master: raw2bmx muxes the OP1a from elementary FIFOs (handled below via + // the orchestrator), so we don't build ffmpeg codec args here for it. + const hiresCodecArgs = growingPath ? null : buildEncodeArgs({ codec: videoCodec, videoBitrate, framerate, audioCodec, audioBitrate, audioChannels, container, @@ -368,60 +872,109 @@ class CaptureManager { isProxy: false, }); - console.log('[capture] hires ffmpeg args:', hiresCodecArgs.join(' ')); + if (hiresCodecArgs) console.log('[capture] hires ffmpeg args:', hiresCodecArgs.join(' ')); const isInterlacedSource = sourceType === 'sdi' || (sourceType === 'deltacast' && interlaced); const sdiFilterArgs = isInterlacedSource ? ['-vf', 'yadif=mode=1:deint=1'] : []; - // When growing-files is on, write directly to the SMB share so Premier - // can mount and edit the live file. Promotion worker uploads to S3 on EOF. - // Otherwise, stream the master to S3 via stdout pipe (legacy behavior). - const hiresOutput = growingPath ? growingPath : 'pipe:1'; - const hiresStdio = growingPath ? ['ignore', 'ignore', 'pipe'] : ['ignore', 'pipe', 'pipe']; + // Master output destination (NON-growing path only). + // + // - Growing-files on → the growing OP1a MXF is written directly to the SMB + // share by raw2bmx (see the orchestrator below); ffmpeg only produces the + // elementary essence FIFOs + HLS preview. `localMasterPath`/`hiresOutput` + // are unused in this case (the master path is `growingPath`). + // + // - Growing-files off → ffmpeg writes the MOV master to a LOCAL SEEKABLE + // temp file, then we upload to S3 on stop. We must NOT pipe the MOV muxer + // to S3 directly: the MOV/MP4 muxer cannot write to a non-seekable pipe + // without `empty_moov`, and an empty_moov/fragmented MOV is exactly what + // makes Adobe Premiere report "file cannot be opened" (no classic + // stco/stsz sample tables — samples live in moof/trun). A seekable file + // lets ffmpeg write a single contiguous moov with full sample tables and + // `+faststart` moves it to the front, producing a Premiere-native master. + const localMasterPath = growingPath + ? null + : `/tmp/capture/${sessionId}.${hiresExt}`; + if (localMasterPath) { + try { mkdirSync(dirname(localMasterPath), { recursive: true }); } + catch (err) { console.error('[capture] could not create temp master dir:', err.message); } + } + const hiresOutput = localMasterPath; + const hiresStdio = ['ignore', 'ignore', 'pipe']; // For SDI we cannot open the DeckLink device a second time for a preview // tee, so the live HLS preview is produced as a SECOND OUTPUT of the hires // ffmpeg: one decklink read -> yadif -> split -> [ProRes/S3] + [H.264/HLS]. let sdiHlsDir = null; - let hiresArgs; if ((sourceType === 'sdi' || sourceType === 'deltacast') && this._assetIdForHls) { const fsMod = await import('node:fs'); sdiHlsDir = '/live/' + this._assetIdForHls; try { fsMod.mkdirSync(sdiHlsDir, { recursive: true }); } catch (_) {} - hiresArgs = [ - ...inputArgs, - '-filter_complex', '[0:v]yadif=mode=1:deint=1,split=2[vhi][vlo]', - // Output 0 — ProRes master (S3 pipe or growing file) - '-map', '[vhi]', '-map', '0:a:0?', - ...hiresCodecArgs, - hiresOutput, - // Output 1 — low-latency H.264 HLS preview for the UI monitor - '-map', '[vlo]', '-map', '0:a:0?', - '-c:v', 'libx264', '-preset', 'veryfast', '-tune', 'zerolatency', - '-pix_fmt', 'yuv420p', '-b:v', '2M', '-g', '60', '-sc_threshold', '0', - '-c:a', 'aac', '-b:a', '128k', '-ar', '44100', - '-f', 'hls', '-hls_time', '2', '-hls_list_size', '15', - '-hls_flags', 'delete_segments+append_list+omit_endlist', - '-hls_segment_filename', sdiHlsDir + '/seg-%05d.ts', - sdiHlsDir + '/index.m3u8', - ]; - console.log('[HLS] SDI preview as 2nd output -> ' + sdiHlsDir); + } + + let hiresProcess; + if (growingPath) { + // ── GROWING master: raw2bmx orchestrator ────────────────────────── + // One ffmpeg (single SDI read) → MPEG-2 422 elementary + PCM to FIFOs + + // the H.264 HLS preview; raw2bmx muxes the growing OP1a MXF from the FIFOs. + // Spawned via bash so the FIFO priming / EOF / stop-forwarding logic (see + // _buildGrowingOrchestrator) runs as one supervised unit. detached:true so + // it leads its own process group and we can clean-stop the whole pipeline. + const orchArgs = this._buildGrowingOrchestrator({ + inputArgs, + videoBitrate, + // Recorder raster for the raw2bmx essence flag. recorders.js sets + // RECORDING_RESOLUTION (e.g. '1920x1080' / '1080i' / 'native'); when + // 'native'/absent, deriveGrowingRaster defaults to 1080i59.94. + resolution: process.env.RECORDING_RESOLUTION || null, + framerate, + audioChannels, + outPath: growingPath, + hlsDir: (sourceType === 'sdi') ? sdiHlsDir : null, + videoCodec, + }); + console.log('[capture] growing master via raw2bmx; orchestrator script length=' + orchArgs[1].length); + hiresProcess = spawn('bash', orchArgs, { stdio: ['ignore', 'ignore', 'pipe'], detached: true }); } else { - hiresArgs = [ ...inputArgs, ...sdiFilterArgs, ...hiresCodecArgs, hiresOutput ]; + // ── Finalized (non-growing) master: ffmpeg muxes the MOV directly ── + let hiresArgs; + if ((sourceType === 'sdi' || sourceType === 'deltacast') && this._assetIdForHls) { + hiresArgs = [ + ...inputArgs, + '-filter_complex', '[0:v]yadif=mode=1:deint=1,split=2[vhi][vlo]', + // Output 0 — ProRes/MOV master (local temp, uploaded to S3 on stop) + '-map', '[vhi]', '-map', '0:a:0?', + ...hiresCodecArgs, + hiresOutput, + // Output 1 — low-latency H.264 HLS preview for the UI monitor. + // GPU-encoded (h264_nvenc) when the GPU is attached to this sidecar, + // otherwise libx264 (issue #164). GOP is pinned to one IDR per HLS + // segment so segments start on keyframes (avoids black/flashing). + '-map', '[vlo]', '-map', '0:a:0?', + ...buildHlsVideoArgs(videoCodec, framerate), + '-c:a', 'aac', '-b:a', '128k', '-ar', '44100', + '-f', 'hls', '-hls_time', '2', '-hls_list_size', '15', + '-hls_flags', 'delete_segments+append_list+omit_endlist', + '-hls_segment_filename', sdiHlsDir + '/seg-%05d.ts', + sdiHlsDir + '/index.m3u8', + ]; + console.log('[HLS] SDI preview as 2nd output -> ' + sdiHlsDir); + } else { + hiresArgs = [ ...inputArgs, ...sdiFilterArgs, ...hiresCodecArgs, hiresOutput ]; + } + hiresProcess = spawn('ffmpeg', hiresArgs, { stdio: hiresStdio }); + if (bridgeProcess) { + bridgeProcess.stdout.pipe(hiresProcess.stdin); + } } - const hiresProcess = spawn('ffmpeg', hiresArgs, { stdio: hiresStdio }); - if (bridgeProcess) { - bridgeProcess.stdout.pipe(hiresProcess.stdin); - } - - const hiresUpload = growingPath - ? Promise.resolve({ growingPath }) - : createUploadStream(S3_BUCKET, hiresKey, hiresProcess.stdout); - + // Growing-files: nothing to upload here (promotion worker handles S3). + // Non-growing: the master is uploaded from the finalized local file in + // stop(), once ffmpeg has written the moov and exited cleanly — we can't + // upload while recording because the file isn't a valid MOV until finalize. const processes = { hires: hiresProcess }; - if (bridgeProcess) processes.bridge = bridgeProcess; if (bridgeProcess) { + processes.bridge = bridgeProcess; bridgeProcess.on('exit', (code) => { if (code !== 0 && code !== null) { console.error(`[deltacast-bridge] exited with code ${code}`); @@ -429,7 +982,7 @@ class CaptureManager { } }); } - const uploads = { hires: hiresUpload }; + const uploads = { hires: growingPath ? Promise.resolve({ growingPath }) : null }; // ── HLS tee for network sources (live preview in the UI) ────────── let hlsProcess = null; @@ -442,8 +995,8 @@ class CaptureManager { const hlsArgs = [ ...inputArgs, '-map', '0:v:0?', '-map', '0:a:0?', - '-c:v', 'libx264', '-preset', 'veryfast', '-tune', 'zerolatency', - '-pix_fmt', 'yuv420p', '-b:v', '2M', '-g', '60', '-sc_threshold', '0', + // GPU-gated preview encode, same as the SDI 2nd-output path (#164). + ...buildHlsVideoArgs(videoCodec, framerate), '-c:a', 'aac', '-b:a', '128k', '-ar', '44100', '-f', 'hls', '-hls_time', '2', '-hls_list_size', '15', '-hls_flags', 'delete_segments+append_list+omit_endlist', @@ -492,10 +1045,11 @@ class CaptureManager { device, sourceType, sourceUrl, - audioFifo, hiresKey, proxyKey, growingPath, + localMasterPath, + audioFifo, startedAt, duration: 0, uploads, @@ -517,13 +1071,74 @@ class CaptureManager { const { processes, currentSession } = this.state; + const isGrowing = !!currentSession.growingPath; + + // Send SIGINT and WAIT for the master writer to exit cleanly. + // - Non-growing: SIGINT flushes ffmpeg's MOV trailer (the moov atom with + // full sample tables). Uploading before finalize → "moov atom not found". + // - Growing: `processes.hires` is the bash ORCHESTRATOR (detached group + // leader). SIGINT hits its trap, which forwards SIGINT to ffmpeg; ffmpeg + // stops → raw2bmx gets EOF → raw2bmx writes the OP1a FOOTER and exits; + // only then does the orchestrator exit. Awaiting it guarantees the + // finalized, valid MXF is on the share before the promotion worker + // uploads it. raw2bmx footer finalize of a long recording can take longer + // than a MOV trailer flush, so the growing safety-net is more generous. + const finalizeTimeoutMs = isGrowing ? 60000 : 15000; + const waitExit = (proc) => new Promise((resolve) => { + if (!proc || proc.exitCode !== null || proc.signalCode !== null) return resolve(); + let done = false; + const finish = () => { if (!done) { done = true; resolve(); } }; + proc.once('exit', finish); + // Safety net: don't hang stop() forever if the writer refuses to exit. + setTimeout(() => { + try { + // Detached orchestrator → kill the whole process group (ffmpeg + + // raw2bmx + bash); otherwise just the process. + if (isGrowing && proc.pid) { try { process.kill(-proc.pid, 'SIGKILL'); } catch (_) {} } + proc.kill('SIGKILL'); + } catch (_) {} + finish(); + }, finalizeTimeoutMs); + }); + if (processes.hires) processes.hires.kill('SIGINT'); if (processes.proxy) processes.proxy.kill('SIGINT'); if (processes.hls) { try { processes.hls.kill('SIGINT'); } catch (_) {} } if (processes.bridge) { try { processes.bridge.kill('SIGINT'); } catch (_) {} } + // Wait for the master writer to finalize before we read/upload the file. + await waitExit(processes.hires); + + // Release the CIFS mount (best-effort) once the ffmpeg writers are done with + // it. The promotion worker reads the staged file from the host/S3 side, not + // through this container's mount, so unmounting here is safe. + unmountGrowingShare(); + try { - const uploadPromises = [currentSession.uploads.hires]; + const uploadPromises = []; + + // Non-growing: upload the finalized local master file to S3 now that the + // moov has been written. Growing: the promotion worker handles S3. + if (currentSession.localMasterPath) { + let size = 0; + try { size = statSync(currentSession.localMasterPath).size; } catch (_) {} + if (size > 0) { + uploadPromises.push( + createUploadStream( + S3_BUCKET, + currentSession.hiresKey, + createReadStream(currentSession.localMasterPath), + ).then(() => { + try { unlinkSync(currentSession.localMasterPath); } catch (_) {} + }) + ); + } else { + console.warn('[capture] local master is 0 bytes — skipping upload:', currentSession.localMasterPath); + } + } else if (currentSession.uploads.hires) { + uploadPromises.push(currentSession.uploads.hires); + } + if (currentSession.uploads.proxy) uploadPromises.push(currentSession.uploads.proxy); await Promise.all(uploadPromises); } catch (error) { @@ -531,7 +1146,7 @@ class CaptureManager { } if (currentSession.audioFifo) { - try { (await import('node:fs')).unlinkSync(currentSession.audioFifo); } catch (_) {} + try { unlinkSync(currentSession.audioFifo); } catch (_) {} } const stoppedAt = new Date().toISOString(); @@ -618,4 +1233,4 @@ class CaptureManager { } export default new CaptureManager(); -export { VIDEO_CODECS, AUDIO_CODECS, CONTAINER_FMT, CONTAINER_EXT }; +export { VIDEO_CODECS, AUDIO_CODECS, CONTAINER_FMT, CONTAINER_EXT, sourceBackends }; diff --git a/services/capture/src/index.js b/services/capture/src/index.js index 59d0cbe..678e073 100644 --- a/services/capture/src/index.js +++ b/services/capture/src/index.js @@ -135,6 +135,15 @@ async function gracefulShutdown(signal) { console.error('[shutdown] failed to flag empty asset:', e.message); } } + } else if (completed.growingPath) { + // Growing-files recorder: the master lives on the SMB share as a .ts, + // NOT in S3 yet. The promotion worker (which watches the same share) + // uploads it to S3 and enqueues the proxy from the real, finalized key. + // We must NOT call /finalize here: that sets original_s3_key to a key + // that doesn't exist yet and enqueues a proxy that instantly fails with + // "unable to open the file on disk." Leave the asset 'live' for the + // promotion worker to flip to 'ready'. + console.log(`[shutdown] growing capture finalized on share (${completed.growingPath}); leaving promotion worker to upload + proxy`); } else if (liveAssetId) { // Finalise the pre-created live asset by id (avoids POST / 409 collision). try { diff --git a/services/mam-api/package.json b/services/mam-api/package.json index 04101d1..47a260e 100644 --- a/services/mam-api/package.json +++ b/services/mam-api/package.json @@ -22,7 +22,9 @@ "bullmq": "^5.5.0", "multer": "^1.4.5-lts.1", "uuid": "^9.0.1", - "dotenv": "^16.4.5" + "dotenv": "^16.4.5", + "qrcode": "^1.5.4", + "google-auth-library": "^9.14.0" }, "engines": { "node": ">=22.0.0" diff --git a/services/mam-api/src/auth/authz.js b/services/mam-api/src/auth/authz.js new file mode 100644 index 0000000..22a37a6 --- /dev/null +++ b/services/mam-api/src/auth/authz.js @@ -0,0 +1,90 @@ +// Per-project authorization — the single source of truth for "can this user +// touch this project?". v1 auth answers "are you logged in?"; this answers +// "which projects, and at what level?". +// +// Model (locked with Zac): +// - role 'admin' → global bypass; every project at 'edit'. +// - role 'editor'/'viewer' → scoped to projects granted to them directly +// (project_access subject_type='user') or via a +// group they belong to (subject_type='group'). +// - grant level 'view' → read-only; 'edit' → read-write. +// +// A user's effective level on a project is the MAX of every matching grant +// (direct + each group). 'edit' outranks 'view'. +// +// All functions take an optional `db` (defaults to the shared pool) so tests +// can inject an isolated test pool. + +import defaultPool from '../db/pool.js'; + +const LEVEL_RANK = { view: 1, edit: 2 }; + +export function isAdmin(user) { + return user?.role === 'admin'; +} + +// Returns the higher of two levels (either may be null/undefined). +function maxLevel(a, b) { + const ra = LEVEL_RANK[a] || 0; + const rb = LEVEL_RANK[b] || 0; + if (ra === 0 && rb === 0) return null; + return ra >= rb ? a : b; +} + +// Resolve every project the user can see, with their effective level. +// admin → { all: true, ids: null, levelByProject: null } +// else → { all: false, ids: Set, levelByProject: Map } +export async function accessibleProjectIds(user, db = defaultPool) { + if (isAdmin(user)) return { all: true, ids: null, levelByProject: null }; + + const levelByProject = new Map(); + if (!user?.id) return { all: false, ids: new Set(), levelByProject }; + + const { rows } = await db.query( + `SELECT pa.project_id, pa.level + FROM project_access pa + WHERE (pa.subject_type = 'user' AND pa.subject_id = $1) + OR (pa.subject_type = 'group' AND pa.subject_id IN ( + SELECT group_id FROM user_groups WHERE user_id = $1 + ))`, + [user.id] + ); + + for (const r of rows) { + levelByProject.set(r.project_id, maxLevel(levelByProject.get(r.project_id), r.level)); + } + return { all: false, ids: new Set(levelByProject.keys()), levelByProject }; +} + +// Effective level on a single project: 'edit' | 'view' | null. +export async function projectLevel(user, projectId, db = defaultPool) { + if (isAdmin(user)) return 'edit'; + if (!user?.id || !projectId) return null; + + const { rows } = await db.query( + `SELECT pa.level + FROM project_access pa + WHERE pa.project_id = $1 + AND ( (pa.subject_type = 'user' AND pa.subject_id = $2) + OR (pa.subject_type = 'group' AND pa.subject_id IN ( + SELECT group_id FROM user_groups WHERE user_id = $2 + )) )`, + [projectId, user.id] + ); + + let level = null; + for (const r of rows) level = maxLevel(level, r.level); + return level; +} + +// Throw a 403-shaped error (caught by errorHandler) unless the user has at +// least `need` access on the project. `need` ∈ 'view' | 'edit'. +export async function assertProjectAccess(user, projectId, need = 'view', db = defaultPool) { + if (isAdmin(user)) return; + const have = await projectLevel(user, projectId, db); + if (!have || (LEVEL_RANK[have] || 0) < (LEVEL_RANK[need] || 0)) { + const err = new Error('forbidden'); + err.status = 403; + throw err; + } +} diff --git a/services/mam-api/src/auth/google-oauth.js b/services/mam-api/src/auth/google-oauth.js new file mode 100644 index 0000000..1e53f27 --- /dev/null +++ b/services/mam-api/src/auth/google-oauth.js @@ -0,0 +1,90 @@ +// Google OAuth (OIDC) sign-in helpers. +// +// Entirely config-gated: if GOOGLE_CLIENT_ID / GOOGLE_CLIENT_SECRET / +// OAUTH_REDIRECT_URL aren't set, isConfigured() is false and the routes 404, so +// a deployment without Google SSO behaves exactly as before. google-auth-library +// is imported lazily so the dependency is only required when the feature is on. +// +// Flow: /auth/google redirects to Google's consent screen with a signed `state`; +// /auth/google/callback exchanges the code, verifies the ID token, enforces the +// allowed Workspace domain, and auto-provisions a viewer account on first login. + +const SCOPES = ['openid', 'email', 'profile']; + +export function isConfigured() { + return !!(process.env.GOOGLE_CLIENT_ID + && process.env.GOOGLE_CLIENT_SECRET + && process.env.OAUTH_REDIRECT_URL); +} + +export function allowedDomain() { + return (process.env.GOOGLE_ALLOWED_DOMAIN || '').trim().toLowerCase() || null; +} + +// Lazily build an OAuth2 client (throws a clear error if the dep is missing). +async function makeClient() { + let OAuth2Client; + try { + ({ OAuth2Client } = await import('google-auth-library')); + } catch { + const err = new Error('google-auth-library is not installed'); + err.status = 500; + throw err; + } + return new OAuth2Client({ + clientId: process.env.GOOGLE_CLIENT_ID, + clientSecret: process.env.GOOGLE_CLIENT_SECRET, + redirectUri: process.env.OAUTH_REDIRECT_URL, + }); +} + +// URL of Google's consent screen. `state` is an opaque anti-CSRF token we also +// stash in the session and re-check on callback. +export async function buildAuthUrl(state) { + const client = await makeClient(); + return client.generateAuthUrl({ + access_type: 'online', + scope: SCOPES, + state, + prompt: 'select_account', + // If a Workspace domain is configured, hint Google to scope the picker to it. + ...(allowedDomain() ? { hd: allowedDomain() } : {}), + }); +} + +// Exchange the authorization code and verify the returned ID token. Returns the +// verified { sub, email, name, hd } payload. Throws { status } on any failure. +export async function exchangeAndVerify(code) { + const client = await makeClient(); + const { tokens } = await client.getToken(code); + if (!tokens.id_token) { + const err = new Error('no id_token from Google'); err.status = 401; throw err; + } + const ticket = await client.verifyIdToken({ + idToken: tokens.id_token, + audience: process.env.GOOGLE_CLIENT_ID, + }); + const p = ticket.getPayload(); + if (!p || !p.sub) { + const err = new Error('invalid id_token'); err.status = 401; throw err; + } + // Require an explicitly verified email — a missing/undefined claim is NOT + // treated as verified, since the email drives account linking/provisioning. + if (!p.email || p.email_verified !== true) { + const err = new Error('email not verified'); err.status = 403; throw err; + } + const domain = allowedDomain(); + if (domain) { + // ONLY trust Google's `hd` (hosted-domain) claim — it's present iff the + // account is a member of a Google Workspace domain that Google itself + // has verified. The email-suffix fallback we used to allow let any + // non-Workspace account with a spoof-friendly email through; if a + // GOOGLE_ALLOWED_DOMAIN is set, the operator means "only this Workspace," + // and consumer accounts (no hd) must be rejected. + const hd = (p.hd || '').toLowerCase(); + if (hd !== domain) { + const err = new Error('domain not allowed'); err.status = 403; throw err; + } + } + return { sub: p.sub, email: p.email, name: p.name || p.email, hd: p.hd || null }; +} diff --git a/services/mam-api/src/auth/mfa-tickets.js b/services/mam-api/src/auth/mfa-tickets.js new file mode 100644 index 0000000..9c079e2 --- /dev/null +++ b/services/mam-api/src/auth/mfa-tickets.js @@ -0,0 +1,58 @@ +// Short-lived MFA tickets bridging the two login steps. +// +// When a user with TOTP enabled passes password auth, we don't create a session +// yet — we hand back an opaque ticket. The second request (code or recovery +// code) redeems the ticket to finish login. Tickets are single-use and expire +// fast so a stolen ticket is near-useless. +// +// Tickets are bound to the issuing request's IP and User-Agent (hashed). A +// stolen ticket replayed from a different origin redeems to null. This is +// defense in depth against ticket exfiltration via a logged proxy, browser +// extension, or shoulder-surf; it does not stop an attacker who is on the same +// IP and UA. +// +// In-memory + single-instance, matching the existing login rate-limiter +// (auth/rate-limit.js). Documented limitation: in a multi-instance deployment +// the second step must hit the same node. Acceptable for Dragonflight's +// one-mam-api-per-node shape; revisit if that changes. +import { randomBytes, createHash } from 'node:crypto'; + +const TTL_MS = 5 * 60 * 1000; // 5 minutes to enter a code +const tickets = new Map(); // id -> { userId, ipHash, uaHash, expiresAt } + +function sweep() { + const now = Date.now(); + for (const [id, t] of tickets) if (t.expiresAt <= now) tickets.delete(id); +} + +function hashBinding(value) { + return createHash('sha256').update(String(value || '')).digest('hex'); +} + +export function issueTicket(userId, { ip, userAgent } = {}) { + sweep(); + const id = randomBytes(32).toString('hex'); + tickets.set(id, { + userId, + ipHash: hashBinding(ip), + uaHash: hashBinding(userAgent), + expiresAt: Date.now() + TTL_MS, + }); + return id; +} + +// Redeem (and consume) a ticket. Returns the userId, or null if missing, +// expired, or the binding doesn't match the redeeming request. +export function redeemTicket(id, { ip, userAgent } = {}) { + if (!id) return null; + const t = tickets.get(id); + if (!t) return null; + tickets.delete(id); // single-use — burn even on binding mismatch so a + // wrong-binding probe can't be retried. + if (t.expiresAt <= Date.now()) return null; + // If a caller doesn't supply bindings (e.g. tests), accept — the issue side + // controls whether bindings get recorded. + if (ip !== undefined && t.ipHash !== hashBinding(ip)) return null; + if (userAgent !== undefined && t.uaHash !== hashBinding(userAgent)) return null; + return t.userId; +} diff --git a/services/mam-api/src/auth/totp.js b/services/mam-api/src/auth/totp.js new file mode 100644 index 0000000..1b390b7 --- /dev/null +++ b/services/mam-api/src/auth/totp.js @@ -0,0 +1,118 @@ +// TOTP (RFC 6238) implemented on node:crypto — no runtime dependency. +// +// Why hand-rolled: the algorithm is small and stable, and avoiding a dep keeps +// the auth core auditable. Verified against the RFC 6238 Appendix B test vectors +// in test/auth/totp.test.js. +// +// Defaults match every mainstream authenticator app (Google Authenticator, +// Authy, 1Password): SHA-1, 6 digits, 30-second step. + +import { createHmac, randomBytes, timingSafeEqual } from 'node:crypto'; + +const DIGITS = 6; +const STEP_SECONDS = 30; +const RFC4648_B32 = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567'; + +// ── base32 (RFC 4648, no padding) ────────────────────────────────────────── +export function base32Encode(buf) { + let bits = 0, value = 0, out = ''; + for (const byte of buf) { + value = (value << 8) | byte; + bits += 8; + while (bits >= 5) { + out += RFC4648_B32[(value >>> (bits - 5)) & 31]; + bits -= 5; + } + } + if (bits > 0) out += RFC4648_B32[(value << (5 - bits)) & 31]; + return out; +} + +export function base32Decode(str) { + const clean = str.replace(/=+$/,'').toUpperCase().replace(/\s+/g, ''); + let bits = 0, value = 0; + const out = []; + for (const ch of clean) { + const idx = RFC4648_B32.indexOf(ch); + if (idx === -1) continue; // skip stray chars + value = (value << 5) | idx; + bits += 5; + if (bits >= 8) { + out.push((value >>> (bits - 8)) & 0xff); + bits -= 8; + } + } + return Buffer.from(out); +} + +// Generate a new base32 secret (20 random bytes = 160 bits, the RFC-recommended +// SHA-1 key length). +export function generateSecret() { + return base32Encode(randomBytes(20)); +} + +// HOTP for a specific counter (RFC 4226). +function hotp(secretBuf, counter) { + const buf = Buffer.alloc(8); + // 64-bit big-endian counter. + buf.writeUInt32BE(Math.floor(counter / 0x100000000), 0); + buf.writeUInt32BE(counter >>> 0, 4); + const hmac = createHmac('sha1', secretBuf).update(buf).digest(); + const offset = hmac[hmac.length - 1] & 0x0f; + const code = ((hmac[offset] & 0x7f) << 24) + | ((hmac[offset + 1] & 0xff) << 16) + | ((hmac[offset + 2] & 0xff) << 8) + | (hmac[offset + 3] & 0xff); + return String(code % (10 ** DIGITS)).padStart(DIGITS, '0'); +} + +// The TOTP code for a given time (defaults to now). +export function generateToken(base32Secret, atMs = Date.now()) { + const counter = Math.floor(atMs / 1000 / STEP_SECONDS); + return hotp(base32Decode(base32Secret), counter); +} + +// Verify a user-supplied code, allowing ±`window` steps of clock drift +// (default ±1 = 90s total tolerance). Constant-time compare per candidate. +// +// Returns the matched counter on success (so callers can persist it for +// replay protection — RFC 6238 §5.2), or null on failure. Boolean truthiness +// still works for the common case (`if (verifyToken(...))`). +export function verifyToken(base32Secret, token, atMs = Date.now(), window = 1) { + if (!base32Secret || !token) return null; + const cleaned = String(token).replace(/\s+/g, ''); + if (!/^\d{6}$/.test(cleaned)) return null; + const secretBuf = base32Decode(base32Secret); + const counter = Math.floor(atMs / 1000 / STEP_SECONDS); + const want = Buffer.from(cleaned); + for (let w = -window; w <= window; w++) { + const candidate = Buffer.from(hotp(secretBuf, counter + w)); + if (candidate.length === want.length && timingSafeEqual(candidate, want)) return counter + w; + } + return null; +} + +// The otpauth:// URI an authenticator app scans. label/issuer show in the app. +export function otpauthURI(base32Secret, accountName, issuer = 'Dragonflight') { + const label = encodeURIComponent(`${issuer}:${accountName}`); + const params = new URLSearchParams({ + secret: base32Secret, + issuer, + algorithm: 'SHA1', + digits: String(DIGITS), + period: String(STEP_SECONDS), + }); + return `otpauth://totp/${label}?${params.toString()}`; +} + +// Generate N human-friendly one-time recovery codes (raw form). Caller hashes +// them before storage and shows the raw set to the user exactly once. +export function generateRecoveryCodes(n = 10) { + const codes = []; + for (let i = 0; i < n; i++) { + // 10 hex chars in two dash-separated groups, e.g. "a1b2c-3d4e5". + const hex = randomBytes(5).toString('hex'); + codes.push(hex.slice(0, 5) + '-' + hex.slice(5)); + } + return codes; +} diff --git a/services/mam-api/src/db/migrations/026-project-access.sql b/services/mam-api/src/db/migrations/026-project-access.sql new file mode 100644 index 0000000..3e49d4b --- /dev/null +++ b/services/mam-api/src/db/migrations/026-project-access.sql @@ -0,0 +1,30 @@ +-- Migration 026 — per-project access grants (RBAC v2). +-- +-- v1 auth is flat: any logged-in user can do everything. This adds per-project +-- scoping. A grant targets either a user or a group (polymorphic subject) and +-- carries a level: 'view' (read-only) or 'edit' (read-write). Admins bypass all +-- of this in code (authz.js) and need no rows here. +-- +-- subject_id is intentionally NOT a foreign key — it points at either users.id +-- or groups.id depending on subject_type. Rows are cleaned up when the project +-- is deleted (FK cascade). A deleted user/group leaves an orphan row that +-- resolves to nobody (harmless); a later sweep can prune them if desired. + +DO $$ BEGIN + IF NOT EXISTS (SELECT 1 FROM pg_type WHERE typname = 'access_level') THEN + CREATE TYPE access_level AS ENUM ('view', 'edit'); + END IF; +END $$; + +CREATE TABLE IF NOT EXISTS project_access ( + project_id UUID NOT NULL REFERENCES projects ON DELETE CASCADE, + subject_type TEXT NOT NULL CHECK (subject_type IN ('user', 'group')), + subject_id UUID NOT NULL, + level access_level NOT NULL DEFAULT 'view', + granted_by UUID REFERENCES users ON DELETE SET NULL, + granted_at TIMESTAMPTZ DEFAULT NOW(), + PRIMARY KEY (project_id, subject_type, subject_id) +); + +CREATE INDEX IF NOT EXISTS idx_project_access_subject + ON project_access (subject_type, subject_id); diff --git a/services/mam-api/src/db/migrations/027-totp-2fa.sql b/services/mam-api/src/db/migrations/027-totp-2fa.sql new file mode 100644 index 0000000..a4a2dbf --- /dev/null +++ b/services/mam-api/src/db/migrations/027-totp-2fa.sql @@ -0,0 +1,20 @@ +-- Migration 027 — TOTP two-factor auth. +-- +-- totp_secret holds the base32 shared secret once enrollment is confirmed +-- (NULL while disabled or mid-enrollment). totp_enabled flips true only after +-- the user verifies their first code, so a half-finished enrollment never locks +-- anyone out. Recovery codes are one-time bcrypt-hashed fallbacks; used_at marks +-- a code as spent. + +ALTER TABLE users ADD COLUMN IF NOT EXISTS totp_secret TEXT; +ALTER TABLE users ADD COLUMN IF NOT EXISTS totp_enabled BOOLEAN NOT NULL DEFAULT FALSE; + +CREATE TABLE IF NOT EXISTS user_recovery_codes ( + id UUID PRIMARY KEY DEFAULT uuid_generate_v4(), + user_id UUID NOT NULL REFERENCES users ON DELETE CASCADE, + code_hash TEXT NOT NULL, + used_at TIMESTAMPTZ, + created_at TIMESTAMPTZ DEFAULT NOW() +); + +CREATE INDEX IF NOT EXISTS idx_user_recovery_codes_user ON user_recovery_codes(user_id); diff --git a/services/mam-api/src/db/migrations/028-google-oauth.sql b/services/mam-api/src/db/migrations/028-google-oauth.sql new file mode 100644 index 0000000..a7864df --- /dev/null +++ b/services/mam-api/src/db/migrations/028-google-oauth.sql @@ -0,0 +1,13 @@ +-- Migration 028 — Google OAuth (OIDC) sign-in. +-- +-- google_sub is Google's stable subject identifier — the join key for a linked +-- or auto-provisioned account (unique, but NULL for password-only users). +-- email is captured for display + domain checks. password_hash becomes nullable +-- so an OAuth-only account can exist without a local password; such an account +-- simply can't use the password login path until an admin sets one. + +ALTER TABLE users ADD COLUMN IF NOT EXISTS google_sub TEXT; +ALTER TABLE users ADD COLUMN IF NOT EXISTS email TEXT; +ALTER TABLE users ALTER COLUMN password_hash DROP NOT NULL; + +CREATE UNIQUE INDEX IF NOT EXISTS idx_users_google_sub ON users(google_sub) WHERE google_sub IS NOT NULL; diff --git a/services/mam-api/src/db/migrations/029-playout.sql b/services/mam-api/src/db/migrations/029-playout.sql new file mode 100644 index 0000000..541f455 --- /dev/null +++ b/services/mam-api/src/db/migrations/029-playout.sql @@ -0,0 +1,165 @@ +-- Migration 029 — Playout / Master Control (MCR). +-- +-- Adds a broadcast playout subsystem: take library assets, arrange them on a +-- playlist (Phase A) or a wall-clock timeline (Phase B), and play them out +-- continuously to SDI (DeckLink) / NDI / SRT / RTMP via a CasparCG sidecar. +-- +-- This is the mirror of the capture path (input -> ffmpeg -> S3). A channel is +-- placed on a cluster node by capability the same way recorders claim input +-- ports; the engine container is spawned via the same Docker-socket / +-- node-agent orchestration. See docs/superpowers/specs/2026-05-30-playout-mcr-design.md. +-- +-- Tables: +-- playout_channels — a logical output (one channel -> one CasparCG instance -> one target) +-- playout_playlists — an ordered list of items bound to a channel (Phase A) +-- playout_items — one clip on a playlist OR one row on the timeline +-- playout_sidecars — running CasparCG sidecar registry (one per channel; health-checked) +-- playout_schedule — wall-clock day-ahead rows (Phase B; unused in A) +-- playout_as_run — append-only log of what actually played (compliance) + +-- ── Channels ─────────────────────────────────────────────────────────────── +CREATE TABLE IF NOT EXISTS playout_channels ( + id UUID PRIMARY KEY DEFAULT gen_random_uuid(), + name TEXT NOT NULL, + node_id UUID REFERENCES cluster_nodes(id) ON DELETE SET NULL, + output_type TEXT NOT NULL DEFAULT 'srt', + -- output_config is consumer-shape-specific: + -- decklink: { "device_index": 1 } + -- ndi: { "ndi_name": "DRAGONFLIGHT CH1" } + -- srt: { "url": "srt://host:9000", "latency": 200 } + -- rtmp: { "url": "rtmp://host/live", "key": "streamkey" } + output_config JSONB NOT NULL DEFAULT '{}'::jsonb, + -- 1080p59.94 is the house standard (matches capture cadence, streaming-friendly, + -- accepted by current SDI gear). Per-channel override allowed. + video_format TEXT NOT NULL DEFAULT '1080p5994', + status TEXT NOT NULL DEFAULT 'stopped', + container_id TEXT, + -- For remote channels the node-agent reports the reachable host:port of the + -- sidecar HTTP shim; stored here so the API can proxy transport calls. + container_meta JSONB NOT NULL DEFAULT '{}'::jsonb, + error_message TEXT, + -- Failover bookkeeping. Scheduler tick health-checks the sidecar; on N missed + -- checks the channel is re-placed on a healthy node (auto for ndi/srt/rtmp, + -- alert-only for decklink — device-index pinning makes re-placement non-trivial). + restart_count INTEGER NOT NULL DEFAULT 0, + last_restart_at TIMESTAMPTZ, + last_heartbeat_at TIMESTAMPTZ, + -- RBAC scoping: a NULL project_id resolves to admin-only (authz.js), the same + -- convention recorders use for unassigned resources. + project_id UUID REFERENCES projects(id) ON DELETE SET NULL, + created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(), + updated_at TIMESTAMPTZ NOT NULL DEFAULT NOW(), + CHECK (output_type IN ('decklink','ndi','srt','rtmp')), + CHECK (status IN ('stopped','starting','running','error')) +); + +CREATE INDEX IF NOT EXISTS idx_playout_channels_node ON playout_channels (node_id); +CREATE INDEX IF NOT EXISTS idx_playout_channels_project ON playout_channels (project_id); + +-- ── Playlists ────────────────────────────────────────────────────────────── +CREATE TABLE IF NOT EXISTS playout_playlists ( + id UUID PRIMARY KEY DEFAULT gen_random_uuid(), + channel_id UUID NOT NULL REFERENCES playout_channels(id) ON DELETE CASCADE, + name TEXT NOT NULL, + loop BOOLEAN NOT NULL DEFAULT FALSE, + created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(), + updated_at TIMESTAMPTZ NOT NULL DEFAULT NOW() +); + +CREATE INDEX IF NOT EXISTS idx_playout_playlists_channel ON playout_playlists (channel_id); + +-- ── Items ────────────────────────────────────────────────────────────────── +-- One entry on a playlist (Phase A, ordered by sort_order) OR one entry on the +-- timeline (Phase B, ordered by scheduled_at). in/out points reuse the editor's +-- subclip trim model (seconds). media_status tracks the S3 -> /media staging +-- (see playout-stage worker job); a clip cannot go on air until 'ready'. +CREATE TABLE IF NOT EXISTS playout_items ( + id UUID PRIMARY KEY DEFAULT gen_random_uuid(), + playlist_id UUID REFERENCES playout_playlists(id) ON DELETE CASCADE, + asset_id UUID NOT NULL REFERENCES assets(id) ON DELETE CASCADE, + sort_order INTEGER NOT NULL DEFAULT 0, + scheduled_at TIMESTAMPTZ, + in_point NUMERIC, + out_point NUMERIC, + transition TEXT NOT NULL DEFAULT 'cut', + transition_ms INTEGER NOT NULL DEFAULT 0, + graphics JSONB, + media_status TEXT NOT NULL DEFAULT 'pending', + media_path TEXT, + -- Set when playout-stage has run loudnorm (EBU R128, -23 LUFS / -1 dBTP) on + -- the staged file. Re-stages skip the loudnorm pass when true. + audio_normalized BOOLEAN NOT NULL DEFAULT FALSE, + created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(), + updated_at TIMESTAMPTZ NOT NULL DEFAULT NOW(), + CHECK (transition IN ('cut','mix','wipe')), + CHECK (media_status IN ('pending','staging','ready','error')) +); + +CREATE INDEX IF NOT EXISTS idx_playout_items_playlist ON playout_items (playlist_id, sort_order); +CREATE INDEX IF NOT EXISTS idx_playout_items_asset ON playout_items (asset_id); + +-- ── Sidecars ─────────────────────────────────────────────────────────────── +-- Running CasparCG container registry, one row per running channel. The +-- scheduler tick (src/scheduler.js) pings each sidecar's /status endpoint and +-- updates last_heartbeat_at; missed checks trigger the failover path in +-- routes/playout.js. +CREATE TABLE IF NOT EXISTS playout_sidecars ( + id UUID PRIMARY KEY DEFAULT gen_random_uuid(), + channel_id UUID NOT NULL REFERENCES playout_channels(id) ON DELETE CASCADE, + node_id UUID REFERENCES cluster_nodes(id) ON DELETE SET NULL, + container_id TEXT NOT NULL, + sidecar_url TEXT, -- http://host:port for the shim + amcp_port INTEGER, -- in-container AMCP port (default 5250) + status TEXT NOT NULL DEFAULT 'running', + last_heartbeat_at TIMESTAMPTZ, + created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(), + CHECK (status IN ('starting','running','error','stopped')) +); + +CREATE UNIQUE INDEX IF NOT EXISTS idx_playout_sidecars_channel ON playout_sidecars (channel_id) + WHERE status IN ('starting','running'); +CREATE INDEX IF NOT EXISTS idx_playout_sidecars_status ON playout_sidecars (status); + +-- ── Schedule (Phase B) ───────────────────────────────────────────────────── +-- Wall-clock day-ahead timeline. The scheduler tick (src/scheduler.js, under +-- the existing PG advisory lock) drives transitions and gap-fill. Unused by the +-- Phase A playlist player but created now so the schema is stable. +CREATE TABLE IF NOT EXISTS playout_schedule ( + id UUID PRIMARY KEY DEFAULT gen_random_uuid(), + channel_id UUID NOT NULL REFERENCES playout_channels(id) ON DELETE CASCADE, + asset_id UUID REFERENCES assets(id) ON DELETE SET NULL, + scheduled_at TIMESTAMPTZ NOT NULL, + in_point NUMERIC, + out_point NUMERIC, + transition TEXT NOT NULL DEFAULT 'cut', + transition_ms INTEGER NOT NULL DEFAULT 0, + is_filler BOOLEAN NOT NULL DEFAULT FALSE, + status TEXT NOT NULL DEFAULT 'scheduled', + media_status TEXT NOT NULL DEFAULT 'pending', + media_path TEXT, + created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(), + updated_at TIMESTAMPTZ NOT NULL DEFAULT NOW(), + CHECK (transition IN ('cut','mix','wipe')), + CHECK (status IN ('scheduled','playing','played','skipped','error')), + CHECK (media_status IN ('pending','staging','ready','error')) +); + +CREATE INDEX IF NOT EXISTS idx_playout_schedule_channel_time ON playout_schedule (channel_id, scheduled_at); +CREATE INDEX IF NOT EXISTS idx_playout_schedule_status ON playout_schedule (status, scheduled_at); + +-- ── As-run log ───────────────────────────────────────────────────────────── +-- Append-only record of what actually went to air. Never updated after insert. +CREATE TABLE IF NOT EXISTS playout_as_run ( + id UUID PRIMARY KEY DEFAULT gen_random_uuid(), + channel_id UUID NOT NULL REFERENCES playout_channels(id) ON DELETE CASCADE, + asset_id UUID REFERENCES assets(id) ON DELETE SET NULL, + item_id UUID, + clip_name TEXT, + started_at TIMESTAMPTZ NOT NULL DEFAULT NOW(), + ended_at TIMESTAMPTZ, + duration_s NUMERIC, + result TEXT NOT NULL DEFAULT 'played', + CHECK (result IN ('played','skipped','error')) +); + +CREATE INDEX IF NOT EXISTS idx_playout_as_run_channel ON playout_as_run (channel_id, started_at DESC); diff --git a/services/mam-api/src/db/migrations/030-totp-replay.sql b/services/mam-api/src/db/migrations/030-totp-replay.sql new file mode 100644 index 0000000..352ef96 --- /dev/null +++ b/services/mam-api/src/db/migrations/030-totp-replay.sql @@ -0,0 +1,9 @@ +-- Migration 030 — TOTP replay protection. +-- +-- RFC 6238 §5.2 hardening: track the last counter value we accepted for each +-- user and reject codes at counters ≤ the last one. Without this, the same +-- 6-digit code can be submitted N times within its 30s step. Low impact in +-- practice (the code is only valid for ~90s with ±1 drift) but standard. + +ALTER TABLE users + ADD COLUMN IF NOT EXISTS totp_last_counter BIGINT NOT NULL DEFAULT 0; diff --git a/services/mam-api/src/db/migrations/031-cluster-nodes-last-seen.sql b/services/mam-api/src/db/migrations/031-cluster-nodes-last-seen.sql new file mode 100644 index 0000000..1dd0ab0 --- /dev/null +++ b/services/mam-api/src/db/migrations/031-cluster-nodes-last-seen.sql @@ -0,0 +1,10 @@ +-- Migration 031 — Add last_seen_at to cluster_nodes +-- +-- Playout failover (routes/playout.js restartChannel) queries cluster_nodes.last_seen_at +-- to find healthy nodes for channel re-placement. Column was missing from original +-- cluster schema; heartbeat endpoint updates it via /cluster/heartbeat. + +ALTER TABLE cluster_nodes ADD COLUMN IF NOT EXISTS last_seen_at TIMESTAMPTZ; + +-- Backfill existing nodes to NOW() so they're immediately eligible for failover +UPDATE cluster_nodes SET last_seen_at = NOW() WHERE last_seen_at IS NULL; diff --git a/services/mam-api/src/db/migrations/032-recorder-gpu-affinity.sql b/services/mam-api/src/db/migrations/032-recorder-gpu-affinity.sql new file mode 100644 index 0000000..48173a3 --- /dev/null +++ b/services/mam-api/src/db/migrations/032-recorder-gpu-affinity.sql @@ -0,0 +1,10 @@ +-- Migration 032: Per-recorder GPU affinity (Issue #167) +-- Adds a nullable GPU UUID to the recorders table so each recorder can be +-- pinned to a specific GPU on its node. The value is passed through to the +-- node-agent sidecar-start payload and becomes NVIDIA_VISIBLE_DEVICES for the +-- capture container. NULL = legacy behavior (NVIDIA_VISIBLE_DEVICES=all, i.e. +-- every GPU visible). Accepts an nvidia-smi GPU UUID (e.g. "GPU-xxxx") or a +-- numeric index string. + +ALTER TABLE recorders + ADD COLUMN IF NOT EXISTS gpu_uuid TEXT DEFAULT NULL; diff --git a/services/mam-api/src/db/migrations/033-playout-scte.sql b/services/mam-api/src/db/migrations/033-playout-scte.sql new file mode 100644 index 0000000..9d3e56d --- /dev/null +++ b/services/mam-api/src/db/migrations/033-playout-scte.sql @@ -0,0 +1,52 @@ +-- Migration 033 — SCTE-35 ad-break markers for playout. +-- +-- Adds the missing SCTE-35 splice feature to the playout (MCR) subsystem. An +-- operator can either schedule an ad break on a channel's timeline (relative to +-- the active playlist position, or at a wall-clock time) or fire one immediately +-- ("splice now"). Each break is recorded here and, when fired, also written to +-- the append-only as-run log so it shows in the compliance record alongside the +-- clips that aired. +-- +-- type: +-- splice_insert — a scheduled break (out → return), duration_s seconds long +-- immediate — fire-now splice (operator pressed "Trigger ad break now") +-- splice_out — open-ended avail out (provider break start) +-- splice_in — return-to-network (provider break end) +-- +-- status: pending → fired (when the engine acts on it) → done (when the break +-- window has elapsed). cancelled is set if the operator removes a pending break. +-- +-- The engine (services/playout) acts on a break by logging the cue, marking the +-- as-run row, and — where the output path supports it — injecting a real +-- SCTE-35 cue (see playout-manager.triggerScte for the injection point/TODO). + +CREATE TABLE IF NOT EXISTS playout_scte_breaks ( + id UUID PRIMARY KEY DEFAULT gen_random_uuid(), + channel_id UUID NOT NULL REFERENCES playout_channels(id) ON DELETE CASCADE, + -- Position on the active playlist this break should fire after (0-based item + -- index). NULL for immediate/wall-clock breaks. + playlist_pos INTEGER, + -- Wall-clock fire time for scheduled breaks. NULL for immediate breaks. + scheduled_at TIMESTAMPTZ, + duration_s INTEGER NOT NULL DEFAULT 30, + -- SCTE-35 event id (the splice_event_id carried in the cue). Auto-assigned. + event_id INTEGER NOT NULL DEFAULT 1, + type TEXT NOT NULL DEFAULT 'splice_insert', + status TEXT NOT NULL DEFAULT 'pending', + fired_at TIMESTAMPTZ, + created_by UUID REFERENCES users(id) ON DELETE SET NULL, + created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(), + updated_at TIMESTAMPTZ NOT NULL DEFAULT NOW(), + CHECK (type IN ('splice_insert','immediate','splice_out','splice_in')), + CHECK (status IN ('pending','fired','done','cancelled')) +); + +CREATE INDEX IF NOT EXISTS idx_playout_scte_channel ON playout_scte_breaks (channel_id, created_at DESC); +CREATE INDEX IF NOT EXISTS idx_playout_scte_status ON playout_scte_breaks (status); + +-- As-run gains a 'scte' result so fired breaks land in the compliance log next to +-- the clips. The original migration constrained result to played/skipped/error; +-- widen it. +ALTER TABLE playout_as_run DROP CONSTRAINT IF EXISTS playout_as_run_result_check; +ALTER TABLE playout_as_run ADD CONSTRAINT playout_as_run_result_check + CHECK (result IN ('played','skipped','error','scte')); diff --git a/services/mam-api/src/db/pool.js b/services/mam-api/src/db/pool.js index 9cdafff..380bdd0 100644 --- a/services/mam-api/src/db/pool.js +++ b/services/mam-api/src/db/pool.js @@ -1,4 +1,16 @@ -import { Pool } from 'pg'; +import { Pool, types } from 'pg'; + +// node-postgres returns BIGINT (int8, OID 20) as a *string* by default, because +// a 64-bit integer can exceed JS Number.MAX_SAFE_INTEGER. Our int8 columns +// (duration_ms, file_size, …) are always well within 2^53, so a string here is +// pure footgun: it breaks any consumer that does arithmetic or comparison on the +// value (e.g. `duration_ms + x` silently string-concatenates, sorts go +// lexicographic, `!ms`/`Math.round` edge cases). Parse int8 to a real Number so +// the API always emits numeric duration_ms/file_size in its JSON. +// +// 20 = int8/bigint OID. Values above Number.MAX_SAFE_INTEGER would lose +// precision, but no column in this schema ever reaches that range. +types.setTypeParser(20, (val) => (val === null ? null : parseInt(val, 10))); // Prefer DATABASE_URL (set in docker-compose) over individual DB_* vars const pool = process.env.DATABASE_URL diff --git a/services/mam-api/src/index.js b/services/mam-api/src/index.js index d7cf83f..59ffdb0 100644 --- a/services/mam-api/src/index.js +++ b/services/mam-api/src/index.js @@ -8,7 +8,7 @@ import os from 'node:os'; import { exec } from 'node:child_process'; import pool from './db/pool.js'; import { errorHandler } from './middleware/errors.js'; -import { requireAuth, requireUiHeader } from './middleware/auth.js'; +import { requireAuth, requireUiHeader, requireAdmin } from './middleware/auth.js'; import { loadS3ConfigFromDb } from './s3/client.js'; import authRouter from './routes/auth.js'; @@ -22,6 +22,7 @@ import jobsRouter from './routes/jobs.js'; import captureRouter from './routes/capture.js'; import uploadRouter from './routes/upload.js'; import recordersRouter from './routes/recorders.js'; +import playoutRouter from './routes/playout.js'; import settingsRouter from './routes/settings.js'; import amppRouter from './routes/ampp.js'; import groupsRouter from './routes/groups.js'; @@ -40,18 +41,12 @@ import { startCleanupLoop } from './tasks/cleanupTempSegments.js'; const app = express(); const PORT = process.env.PORT || 3000; -// ── Middleware ──────────────────────────────────────────────────────────────── -// Tightened CORS — once cookies carry authority, `origin: true` would let -// any site forge requests with the cookie. Drive the allowlist from env. const allowedOrigins = (process.env.ALLOWED_ORIGINS || '') .split(',').map(s => s.trim()).filter(Boolean); app.use(cors({ origin: (origin, cb) => { - // No Origin header (same-origin or curl) — allow. if (!origin) return cb(null, true); if (allowedOrigins.length === 0 || allowedOrigins.includes(origin)) return cb(null, true); - // Reject cleanly: omit the Allow-Origin header so the browser surfaces - // a real CORS error instead of a 500 from a thrown Error in the callback. console.warn('[cors] rejected origin:', origin); return cb(null, false); }, @@ -59,14 +54,8 @@ app.use(cors({ })); app.use(express.json({ limit: '50mb' })); -// Trust the reverse proxy only when explicitly told to (production HTTPS). if (process.env.TRUST_PROXY === 'true') app.set('trust proxy', 1); -// HSTS — once a browser has seen this header over HTTPS for dragonflight.live, -// it auto-upgrades every future http:// request to https:// before hitting the -// wire. Cookies are Secure-only (below) and the CORS allowlist rejects HTTP, -// so without HSTS a user who lands on http:// silently can't log in. -// Only emit on actual HTTPS responses; req.secure honors trust proxy + X-Forwarded-Proto. if (process.env.AUTH_ENABLED === 'true') { app.use((req, res, next) => { if (req.secure) res.setHeader('Strict-Transport-Security', 'max-age=31536000; includeSubDomains'); @@ -74,17 +63,13 @@ if (process.env.AUTH_ENABLED === 'true') { }); } -// Hard-fail when production-mode auth has no stable session secret. Without -// this, express-session falls back to an in-memory random secret which -// invalidates every session on restart and breaks multi-node deployments. if (process.env.AUTH_ENABLED === 'true' && !process.env.SESSION_SECRET) { console.error('[fatal] SESSION_SECRET is required when AUTH_ENABLED=true'); process.exit(1); } -// Session — actually wired this time. See specs/2026-05-27-auth-system-design.md. app.use(session({ - store: new PgStore({ pool, tableName: 'sessions', pruneSessionInterval: 60 * 15 /* seconds = 15 min */ }), + store: new PgStore({ pool, tableName: 'sessions', pruneSessionInterval: 60 * 15 }), secret: process.env.SESSION_SECRET, name: 'dragonflight.sid', cookie: { @@ -94,31 +79,26 @@ app.use(session({ path: '/', maxAge: 8 * 3600 * 1000, }, - rolling: false, // sliding renewal handled in requireAuth so idle + absolute can be enforced separately + rolling: false, resave: false, saveUninitialized: false, })); -// ── Health ──────────────────────────────────────────────────────────────────── app.get('/health', (_req, res) => res.json({ status: 'ok' })); -// ── Auth gate ───────────────────────────────────────────────────────────────── -// req.path is relative to the /api/v1 mount, so /auth/login NOT /api/v1/auth/login. -const UNAUTH_PATHS = new Set(['/auth/login', '/auth/setup', '/auth/setup-required']); -// node-agent now authenticates /cluster/heartbeat with a bound api_token -// (migration 019 + bound_hostname on the token). requireAuth handles the -// bearer lookup and sets req.tokenBoundHostname; the heartbeat handler in -// routes/cluster.js verifies body.hostname matches that binding. +const UNAUTH_PATHS = new Set([ + '/auth/login', '/auth/login/totp', '/auth/setup', '/auth/setup-required', + '/auth/google', '/auth/google/callback', '/auth/google/enabled', +]); app.use('/api/v1', requireUiHeader); app.use('/api/v1', (req, res, next) => { if (UNAUTH_PATHS.has(req.path)) return next(); return requireAuth(req, res, next); }); -// ── API Routes ──────────────────────────────────────────────────────────────── app.use('/api/v1/auth', authRouter); -app.use('/api/v1/auth/users', usersRouter); -app.use('/api/v1/users', usersRouter); // alias for the existing SPA Users page that calls /api/v1/users; keeps the same auth gate +app.use('/api/v1/auth/users', requireAdmin, usersRouter); +app.use('/api/v1/users', requireAdmin, usersRouter); app.use('/api/v1/auth/tokens', requireAuth, tokensRouter); app.use('/api/v1/assets', assetsRouter); app.use('/api/v1/projects', projectsRouter); @@ -127,9 +107,10 @@ app.use('/api/v1/jobs', jobsRouter); app.use('/api/v1/capture', captureRouter); app.use('/api/v1/upload', uploadRouter); app.use('/api/v1/recorders', recordersRouter); +app.use('/api/v1/playout', playoutRouter); app.use('/api/v1/settings', settingsRouter); app.use('/api/v1/ampp', amppRouter); -app.use('/api/v1/groups', groupsRouter); +app.use('/api/v1/groups', requireAdmin, groupsRouter); app.use('/api/v1/sequences', sequencesRouter); app.use('/api/v1/system', systemRouter); app.use('/api/v1/cluster', clusterRouter); @@ -140,21 +121,14 @@ app.use('/api/v1/assets/:assetId/comments', commentsRouter); app.use('/api/v1/imports', importsRouter); app.use('/api/v1/storage', storageRouter); -// ── Error handler ───────────────────────────────────────────────────────────── app.use(errorHandler); -// ── Start ──────────────────────────────────────────────────────────────────── import { readdirSync, readFileSync } from 'node:fs'; import { fileURLToPath } from 'node:url'; import { dirname, join } from 'node:path'; const __dirnameMig = dirname(fileURLToPath(import.meta.url)); async function runMigrations() { - // Issue #107 — previously the loop swallowed errors and let the server boot - // on a half-migrated schema. Now: track applied migrations in a table, run - // every pending one inside a transaction, and exit non-zero on failure so - // the orchestrator restarts (and so an operator notices) instead of serving - // 500s for the next month. const dir = join(__dirnameMig, 'db', 'migrations'); let files = []; try { files = readdirSync(dir).filter(f => f.endsWith('.sql')).sort(); } catch { return; } @@ -167,7 +141,6 @@ async function runMigrations() { ) `); - // Allow forcing a re-run via env when iterating locally. const force = process.env.MIGRATIONS_FORCE === '1'; const allowFailures = process.env.MIGRATIONS_ALLOW_FAILURES === '1'; @@ -193,7 +166,6 @@ async function runMigrations() { console.error('[migration] FAILED ' + f + ': ' + err.message); client.release(); if (allowFailures) continue; - // Hard fail — better to crash now than serve traffic on a broken schema. console.error('[migration] aborting startup. Set MIGRATIONS_ALLOW_FAILURES=1 to override.'); process.exit(1); } @@ -202,13 +174,9 @@ async function runMigrations() { } await runMigrations(); -// Load S3 config from DB so any settings saved via the Settings page override env vars await loadS3ConfigFromDb(); -// ── Cluster self-heartbeat ──────────────────────────────────────────────────── function getLocalIp() { - // Prefer an explicit override — useful when running inside Docker where - // os.networkInterfaces() returns container bridge IPs, not the host LAN IP. if (process.env.NODE_IP) return process.env.NODE_IP; const ifaces = os.networkInterfaces(); @@ -220,9 +188,6 @@ function getLocalIp() { return '127.0.0.1'; } -// Detect NVIDIA GPUs available to this container via nvidia-smi. -// Returns an array like [{ index: 0, name: 'Tesla P4', memory_mb: 7680 }, ...] -// or an empty array if nvidia-smi is unavailable or no GPUs found. function detectGpus() { return new Promise(resolve => { exec( @@ -244,6 +209,10 @@ function detectGpus() { }); } +// Primary mam-api node self-registers in cluster_nodes every 30s. Must write +// BOTH last_seen (legacy column) and last_seen_at (added by mig 031, used by +// playout failover) — otherwise the primary appears stale to the failover +// query and channels get re-placed off it incorrectly. async function selfHeartbeat() { const load = os.loadavg()[0]; const total = os.totalmem(); @@ -255,14 +224,15 @@ async function selfHeartbeat() { pool.query( `INSERT INTO cluster_nodes (hostname, ip_address, role, version, api_url, - cpu_usage, mem_used_mb, mem_total_mb, capabilities, last_seen) - VALUES ($1,$2,'primary',$3,$4,$5,$6,$7,$8,NOW()) + cpu_usage, mem_used_mb, mem_total_mb, capabilities, last_seen, last_seen_at) + VALUES ($1,$2,'primary',$3,$4,$5,$6,$7,$8,NOW(),NOW()) ON CONFLICT (hostname) DO UPDATE SET ip_address = EXCLUDED.ip_address, cpu_usage = EXCLUDED.cpu_usage, mem_used_mb = EXCLUDED.mem_used_mb, mem_total_mb = EXCLUDED.mem_total_mb, capabilities = EXCLUDED.capabilities, + last_seen_at = NOW(), last_seen = NOW()`, [ process.env.NODE_HOSTNAME || os.hostname(), @@ -287,39 +257,26 @@ const server = app.listen(PORT, () => { if (process.env.AUTH_ENABLED === 'true' && process.env.TRUST_PROXY !== 'true') { console.warn('[auth] WARNING: AUTH_ENABLED=true but TRUST_PROXY=false — req.ip will be the proxy IP, login rate-limit will throttle all clients together. Set TRUST_PROXY=true when behind nginx/HTTPS.'); } - // Boot the recorder scheduler tick loop after the HTTP server is live so - // the loop's self-calls to /recorders/:id/start|stop reach a ready socket. startSchedulerLoop(); - - // Boot the temp-segment cleanup loop (runs hourly). startCleanupLoop(); }); -// Issue #100 — graceful shutdown. Without this, `docker stop` (SIGTERM) killed -// the process mid-scheduler-tick, leaving Redis connections and Docker -// sockets dangling and producing partial DB writes. Now: stop the scheduler, -// finish in-flight HTTP requests, close PG/Redis pools, and exit cleanly -// (or hard-exit after 25 s if something is stuck). let _shuttingDown = false; async function gracefulShutdown(signal) { if (_shuttingDown) return; _shuttingDown = true; console.log(`[shutdown] received ${signal} — closing gracefully…`); - // Stop accepting new requests + wind down the scheduler tick. try { stopSchedulerLoop(); } catch (_) {} - // Force-exit watchdog so a hung connection can't keep us alive forever. const killSwitch = setTimeout(() => { console.error('[shutdown] forced exit after 25s timeout'); process.exit(1); }, 25_000); killSwitch.unref(); - // Stop the HTTP server (waits for in-flight requests to finish). await new Promise(resolve => server.close(resolve)); - // Close DB pool + S3 client + any other resources. Best-effort. try { await pool.end(); } catch (e) { console.warn('[shutdown] pool.end:', e.message); } console.log('[shutdown] clean exit'); diff --git a/services/mam-api/src/middleware/auth.js b/services/mam-api/src/middleware/auth.js index d835c42..21f1d39 100644 --- a/services/mam-api/src/middleware/auth.js +++ b/services/mam-api/src/middleware/auth.js @@ -1,10 +1,29 @@ +import crypto from 'crypto'; import pool from '../db/pool.js'; import { parseBearer, hashToken } from '../auth/tokens.js'; +// In-process service token for the scheduler's loopback self-calls +// (scheduler.js -> /recorders|/playout). The scheduler runs in THIS process, so +// a per-boot random constant needs no env/compose config and is never exposed: +// it only travels over the loopback fetch inside the same process. Multi-replica +// is safe because each replica's scheduler only ever calls 127.0.0.1 (itself), +// matching that replica's token. Requests bearing it are treated as the seeded +// admin (DEV_USER) so RBAC + FK-bearing routes work. +export const INTERNAL_TOKEN = crypto.randomBytes(32).toString('hex'); +const INTERNAL_HEADER = 'x-internal-token'; + +function isInternalCall(req) { + const got = req.headers[INTERNAL_HEADER]; + if (typeof got !== 'string' || got.length !== INTERNAL_TOKEN.length) return false; + return crypto.timingSafeEqual(Buffer.from(got), Buffer.from(INTERNAL_TOKEN)); +} + // Stable UUID matching migration 023's seeded dev user. /** UUID of the seeded dev-mode placeholder. NOT a sentinel for "any unauthenticated user". */ export const DEV_USER_ID = '00000000-0000-4000-8000-000000000000'; -export const DEV_USER = { id: DEV_USER_ID, username: 'dev', display_name: 'Dev (AUTH_ENABLED=false)' }; +// role 'admin' so dev mode (AUTH_ENABLED=false) keeps full access through the +// RBAC v2 gates — matches migration 023's seeded dev row. +export const DEV_USER = { id: DEV_USER_ID, username: 'dev', display_name: 'Dev (AUTH_ENABLED=false)', role: 'admin' }; const ABSOLUTE_MS = 8 * 3600 * 1000; const IDLE_MS = 1 * 3600 * 1000; @@ -18,11 +37,18 @@ async function destroyAnd401(req, res) { async function loadUser(id) { const { rows } = await pool.query( - `SELECT id, username, display_name, role FROM users WHERE id = $1`, [id]); + `SELECT id, username, display_name, role, totp_enabled FROM users WHERE id = $1`, [id]); return rows[0] || null; } export async function requireAuth(req, res, next) { + // Internal loopback self-call (scheduler). Acts as the seeded admin so RBAC + // and FK-bearing routes work, regardless of AUTH_ENABLED. + if (isInternalCall(req)) { + req.user = DEV_USER; + return next(); + } + // Dev mode — attach the seeded dev user so FK-bearing routes work. if (process.env.AUTH_ENABLED !== 'true') { req.user = DEV_USER; @@ -73,6 +99,14 @@ export async function requireAuth(req, res, next) { return res.status(401).json({ error: 'unauthorized' }); } +// Gate a route to admins only. requireAuth must run first (it sets req.user). +// 401 when unauthenticated, 403 when authenticated but not an admin. +export function requireAdmin(req, res, next) { + if (!req.user) return res.status(401).json({ error: 'unauthorized' }); + if (req.user.role !== 'admin') return res.status(403).json({ error: 'forbidden' }); + return next(); +} + // Belt-and-suspenders CSRF: SameSite=Lax already blocks most cross-site // cookie sends, but a custom header that no
can produce hardens // against the edge cases. Applied to mutating verbs only. @@ -88,6 +122,8 @@ const CSRF_EXEMPT_PATHS = new Set(['/cluster/heartbeat']); export function requireUiHeader(req, res, next) { if (!MUTATING.has(req.method)) return next(); + // Internal loopback self-call (scheduler) — not a browser, can't be drive-by'd. + if (isInternalCall(req)) return next(); // Bearer-authed requests (Premiere panel, scripts) are exempt — they're not // browsers and can't be drive-by'd from another origin. if (req.headers.authorization?.toLowerCase().startsWith('bearer ')) return next(); diff --git a/services/mam-api/src/routes/assets.js b/services/mam-api/src/routes/assets.js index 905ab12..1cd7c93 100644 --- a/services/mam-api/src/routes/assets.js +++ b/services/mam-api/src/routes/assets.js @@ -7,9 +7,36 @@ import pool from '../db/pool.js'; import { getSignedUrlForObject, deleteObject, s3Client, getS3Bucket } from '../s3/client.js'; import { GetObjectCommand, HeadObjectCommand } from '@aws-sdk/client-s3'; import { validateUuid } from '../middleware/errors.js'; +import { assertProjectAccess, accessibleProjectIds } from '../auth/authz.js'; +import { requireAdmin } from '../middleware/auth.js'; const router = express.Router(); -router.param('id', (req, res, next) => validateUuid('id')(req, res, next)); + +// Every /:id asset route is scoped to the asset's project. The param handler +// validates the UUID, resolves the owning project_id, and asserts at least +// 'view' access (the baseline for touching an asset at all). Mutating routes +// additionally assert 'edit' via req.assetProjectId. A missing asset is a clean +// 404 here rather than leaking existence to users without access. +router.param('id', async (req, res, next) => { + validateUuid('id')(req, res, () => {}); + if (res.headersSent) return; + try { + const { rows } = await pool.query('SELECT project_id FROM assets WHERE id = $1', [req.params.id]); + if (rows.length === 0) return res.status(404).json({ error: 'Asset not found' }); + req.assetProjectId = rows[0].project_id; + await assertProjectAccess(req.user, req.assetProjectId, 'view'); + next(); + } catch (err) { next(err); } +}); + +// Route-level guard for mutating /:id endpoints — escalates the param handler's +// 'view' baseline to 'edit'. Reuses req.assetProjectId (already resolved). +async function requireAssetEdit(req, res, next) { + try { + await assertProjectAccess(req.user, req.assetProjectId, 'edit'); + next(); + } catch (err) { next(err); } +} // BullMQ queue connection (mirrors worker/src/index.js) const parseRedisUrl = (url) => { @@ -66,6 +93,15 @@ router.get('/', async (req, res, next) => { const params = []; let paramCount = 1; + // Scope to projects the caller can access (admins are unfiltered). Without + // this, a granted user would see every asset across every project. + const access = await accessibleProjectIds(req.user); + if (!access.all) { + if (access.ids.size === 0) return res.json({ assets: [], total: 0 }); + query += ` AND a.project_id = ANY($${paramCount++}::uuid[])`; + params.push([...access.ids]); + } + // Exclude archived unless explicitly requested — independent of status filter if (include_archived !== 'true') { query += ` AND a.status <> 'archived'`; @@ -132,6 +168,9 @@ router.post('/', async (req, res, next) => { return res.status(400).json({ error: 'projectId and clipName are required' }); } + // Registering an asset writes into a project — require edit access there. + await assertProjectAccess(req.user, projectId, 'edit'); + const durationNum = duration !== undefined && duration !== null ? Number(duration) : null; if (durationNum !== null && !Number.isFinite(durationNum)) { return res.status(400).json({ error: 'duration must be a finite number (seconds)' }); @@ -220,8 +259,8 @@ router.post('/', async (req, res, next) => { } }); -// POST /cleanup-live -router.post('/cleanup-live', async (req, res, next) => { +// POST /cleanup-live — cross-project maintenance, admin only. +router.post('/cleanup-live', requireAdmin, async (req, res, next) => { try { const maxAgeHours = Math.max(1, parseInt(req.query.max_age_hours || '4', 10)); const result = await pool.query( @@ -234,8 +273,8 @@ router.post('/cleanup-live', async (req, res, next) => { } catch (err) { next(err); } }); -// POST /cleanup-live-orphans -router.post('/cleanup-live-orphans', async (_req, res, next) => { +// POST /cleanup-live-orphans — cross-project maintenance, admin only. +router.post('/cleanup-live-orphans', requireAdmin, async (_req, res, next) => { try { const liveRoot = process.env.LIVE_DIR || '/live'; let entries; @@ -277,10 +316,22 @@ router.get('/:id', async (req, res, next) => { }); // PATCH /:id -router.patch('/:id', async (req, res, next) => { +router.patch('/:id', requireAssetEdit, async (req, res, next) => { try { const { id } = req.params; const { display_name, tags, notes, bin_id } = req.body; + + // bin_id must reference a bin in the asset's OWN project — otherwise an + // editor in project A could stuff their asset into project B's bin tree. + // Null/empty clears the bin, which is always allowed. + if (bin_id) { + const bin = await pool.query('SELECT project_id FROM bins WHERE id = $1', [bin_id]); + if (bin.rows.length === 0) return res.status(400).json({ error: 'bin_id not found' }); + if (bin.rows[0].project_id !== req.assetProjectId) { + return res.status(400).json({ error: 'bin_id belongs to a different project' }); + } + } + const updates = [], params = []; let paramCount = 1; if (display_name !== undefined) { updates.push(`display_name = $${paramCount++}`); params.push(display_name); } @@ -299,13 +350,32 @@ router.patch('/:id', async (req, res, next) => { }); // POST /:id/copy -router.post('/:id/copy', async (req, res, next) => { +router.post('/:id/copy', requireAssetEdit, async (req, res, next) => { try { const { id } = req.params; const { binId, projectId } = req.body; const r = await pool.query('SELECT * FROM assets WHERE id = $1', [id]); if (r.rows.length === 0) return res.status(404).json({ error: 'Asset not found' }); const src = r.rows[0]; + + // Destination project defaults to source's. If the caller overrides it, + // assert edit on the target — without this, an editor in project A could + // clone any asset they can see into project B with no grant on B. + const destProjectId = projectId || src.project_id; + if (projectId && projectId !== src.project_id) { + await assertProjectAccess(req.user, destProjectId, 'edit'); + } + // Destination bin (if any) must belong to the destination project — same + // class of bug as the PATCH bin_id hole. + const destBinId = binId === undefined ? src.bin_id : (binId || null); + if (destBinId) { + const bin = await pool.query('SELECT project_id FROM bins WHERE id = $1', [destBinId]); + if (bin.rows.length === 0) return res.status(400).json({ error: 'binId not found' }); + if (bin.rows[0].project_id !== destProjectId) { + return res.status(400).json({ error: 'binId belongs to a different project than the destination' }); + } + } + const newId = uuidv4(); // Bug #60: null out proxy_s3_key and thumbnail_s3_key on the copy to avoid // sharing S3 objects with the source. Set status to 'processing' so the copy @@ -320,8 +390,8 @@ router.post('/:id/copy', async (req, res, next) => { $1,$2,$3,$4,$5,$6,$7,$8,NULL,NULL,$9,$10,$11,$12,$13,$14,$15,$16,NOW(),NOW() ) RETURNING *`, [ - newId, projectId || src.project_id, - binId === undefined ? src.bin_id : (binId || null), + newId, destProjectId, + destBinId, src.filename, src.display_name, 'processing', src.media_type, src.original_s3_key, src.codec, src.resolution, src.fps, src.duration_ms, src.start_tc, @@ -346,7 +416,7 @@ router.post('/:id/copy', async (req, res, next) => { }); // POST /:id/mark-empty -router.post('/:id/mark-empty', async (req, res, next) => { +router.post('/:id/mark-empty', requireAssetEdit, async (req, res, next) => { try { const { id } = req.params; // Bug #66: first check the asset exists and what status it is in @@ -384,7 +454,7 @@ router.post('/:id/mark-empty', async (req, res, next) => { // the existing live row -> 409 -> asset stuck 'live', no jobs. Finalising by id // flips it out of 'live', records duration + S3 keys, and kicks off the // proxy -> thumbnail -> filmstrip job chain. -router.post('/:id/finalize', async (req, res, next) => { +router.post('/:id/finalize', requireAssetEdit, async (req, res, next) => { try { const { id } = req.params; const { hiresKey, proxyKey, duration } = req.body; @@ -436,7 +506,7 @@ router.post('/:id/finalize', async (req, res, next) => { }); // POST /:id/generate-proxy -router.post('/:id/generate-proxy', async (req, res, next) => { +router.post('/:id/generate-proxy', requireAssetEdit, async (req, res, next) => { try { const { id } = req.params; const r = await pool.query('SELECT * FROM assets WHERE id = $1', [id]); @@ -452,8 +522,8 @@ router.post('/:id/generate-proxy', async (req, res, next) => { } catch (err) { next(err); } }); -// POST /backfill-proxies -router.post('/backfill-proxies', async (_req, res, next) => { +// POST /backfill-proxies — cross-project maintenance, admin only. +router.post('/backfill-proxies', requireAdmin, async (_req, res, next) => { try { const targets = await pool.query( `SELECT id, original_s3_key FROM assets @@ -477,7 +547,7 @@ router.post('/backfill-proxies', async (_req, res, next) => { // POST /:id/reprocess?type=proxy|thumbnail|filmstrip // Force-requeue a processing job regardless of current asset status. -router.post('/:id/reprocess', async (req, res, next) => { +router.post('/:id/reprocess', requireAssetEdit, async (req, res, next) => { try { const { id } = req.params; const type = req.query.type || 'proxy'; @@ -528,7 +598,7 @@ router.get('/:id/filmstrip', async (req, res, next) => { }); // POST /:id/retry -router.post('/:id/retry', async (req, res, next) => { +router.post('/:id/retry', requireAssetEdit, async (req, res, next) => { try { const { id } = req.params; const r = await pool.query('SELECT * FROM assets WHERE id = $1', [id]); @@ -547,7 +617,7 @@ router.post('/:id/retry', async (req, res, next) => { }); // DELETE /:id -router.delete('/:id', async (req, res, next) => { +router.delete('/:id', requireAssetEdit, async (req, res, next) => { try { const { id } = req.params; const { hard } = req.query; @@ -664,16 +734,21 @@ router.get('/:id/live-path', async (req, res, next) => { if (a.rows.length === 0) return res.status(404).json({ error: 'Asset not found' }); const asset = a.rows[0]; if (asset.status !== 'live') return res.status(409).json({ error: 'Asset is not currently growing', status: asset.status }); - const s = await pool.query(`SELECT key, value FROM settings WHERE key IN ('growing_enabled','growing_smb_url')`); + // Growing-files mode is now per-recorder (recorders.growing_enabled), so we + // no longer gate on the removed global `growing_enabled` setting. A + // status='live' asset already proves a growing recorder is producing this + // file; we only need the editor-facing SMB URL to build the UNC path. + const s = await pool.query(`SELECT key, value FROM settings WHERE key = 'growing_smb_url'`); const cfg = {}; for (const { key, value } of s.rows) cfg[key] = value; - if (cfg.growing_enabled !== 'true') return res.status(409).json({ error: 'Growing-files mode is disabled' }); - if (!cfg.growing_smb_url) return res.status(409).json({ error: 'No SMB URL configured — set growing_smb_url in Settings' }); - const rec = await pool.query( - `SELECT recording_container FROM recorders WHERE current_session_id = $1 ORDER BY updated_at DESC LIMIT 1`, - [asset.id] - ); - const ext = rec.rows[0]?.recording_container || 'mov'; + if (!cfg.growing_smb_url) return res.status(409).json({ error: 'No SMB URL configured — set the editor SMB URL in Settings → Storage' }); + // The growing master is ALWAYS MXF OP1a (XDCAM HD422) on the share, regardless + // of the recorder's configured finalized container — that is the format + // Premiere supports for edit-while-record growing files (incremental index + // segments written into body partitions, readable with no footer). The file + // on the share is `.mxf`. Keep this in lock-step with GROWING_EXT in + // services/capture/src/capture-manager.js. + const ext = 'mxf'; const smbRoot = cfg.growing_smb_url.replace(/\/+$/, ''); const winPath = smbRoot.replace(/^smb:\/\//, '\\\\').replace(/\//g, '\\') + `\\${asset.project_id}\\${asset.display_name}.${ext}`; const posix = smbRoot.replace(/^smb:\/\//, '//') + `/${asset.project_id}/${asset.display_name}.${ext}`; @@ -908,6 +983,15 @@ router.post('/batch-trim', async (req, res, next) => { return res.status(400).json({ error: 'Each clip must have assetId, filename, sourceInFrames, sourceOutFrames, timelineInFrames, timelineOutFrames, and a non-negative integer trackIndex' }); } } + // Authorize every source asset's project (edit) before queuing any work. + const trimAssetIds = [...new Set(clips.map(c => c.assetId))]; + const owning = await pool.query('SELECT id, project_id FROM assets WHERE id = ANY($1::uuid[])', [trimAssetIds]); + const projById = new Map(owning.rows.map(r => [r.id, r.project_id])); + for (const aid of trimAssetIds) { + const pid = projById.get(aid); + if (!pid) return res.status(404).json({ error: 'Asset not found: ' + aid }); + await assertProjectAccess(req.user, pid, 'edit'); + } const jobId = uuidv4(); const expiresAt = new Date(Date.now() + 24 * 60 * 60 * 1000); await pool.query( diff --git a/services/mam-api/src/routes/auth.js b/services/mam-api/src/routes/auth.js index b2dc7b3..00e0456 100644 --- a/services/mam-api/src/routes/auth.js +++ b/services/mam-api/src/routes/auth.js @@ -3,6 +3,14 @@ import pool from '../db/pool.js'; import { DEV_USER_ID, requireAuth } from '../middleware/auth.js'; import { hashPassword, comparePassword } from '../auth/passwords.js'; import { ipBackoff } from '../auth/rate-limit.js'; +import { + generateSecret, verifyToken, otpauthURI, generateRecoveryCodes, +} from '../auth/totp.js'; +import { issueTicket, redeemTicket } from '../auth/mfa-tickets.js'; +import { + isConfigured as googleConfigured, buildAuthUrl, exchangeAndVerify, +} from '../auth/google-oauth.js'; +import { randomBytes } from 'node:crypto'; const DUMMY_PASSWORD_HASH = '$2b$12$gSeC58PregWedNFK/8Q61OephUo.JJ7EUs0LCTdnJV5AzCS5qQH7K'; @@ -76,7 +84,7 @@ router.post('/login', async (req, res, next) => { } const { rows } = await pool.query( - `SELECT id, username, display_name, password_hash FROM users WHERE username = $1 AND id <> $2`, + `SELECT id, username, display_name, password_hash, totp_enabled FROM users WHERE username = $1 AND id <> $2`, [username.trim(), DEV_USER_ID] ); if (rows.length === 0) { @@ -93,21 +101,123 @@ router.post('/login', async (req, res, next) => { return res.status(401).json({ error: 'invalid credentials' }); } - req.session.user_id = user.id; - req.session.first_seen_at = Date.now(); - req.session.last_seen_at = Date.now(); - // The critical line — wait for the row to land in `sessions` before responding. - // Without this, the SPA's next request races the store write, hits 401, and - // the prior bounce-to-login logic produced an infinite loop. - await new Promise((resolve, reject) => req.session.save(err => err ? reject(err) : resolve())); + // Second factor: if TOTP is enabled, don't create a session yet. Hand back + // a short-lived ticket the client redeems via /login/totp with a code. + // Crucially: do NOT clear the per-IP failure counter here. If we did, each + // /login retry would reset the backoff and let an attacker brute the 6-digit + // TOTP space (10^6) with no per-attempt delay. The counter is cleared + // inside establishSession() once MFA has actually passed. + if (user.totp_enabled) { + return res.json({ + mfa_required: true, + ticket: issueTicket(user.id, { ip, userAgent: req.get('user-agent') }), + }); + } - pool.query(`UPDATE users SET last_login_at = NOW() WHERE id = $1`, [user.id]) - .catch(err => console.error('[auth] last_login_at update failed:', err.message)); - - ipBackoff.recordSuccess(ip); - res.json({ user: { id: user.id, username: user.username, display_name: user.display_name } }); } catch (err) { next(err); } + await establishSession(req, user, ip); + res.json({ user: { id: user.id, username: user.username, display_name: user.display_name } }); + } catch (err) { next(err); } }); +// Write the session and wait for it to persist before responding. Extracted so +// both the password-only and the MFA-completion paths share one implementation. +// Clears the per-IP failure counter only here — after every required factor has +// actually been proven (password [+ TOTP if enabled, or OAuth + TOTP]). +async function establishSession(req, user, ip) { + req.session.user_id = user.id; + req.session.first_seen_at = Date.now(); + req.session.last_seen_at = Date.now(); + // The critical line — wait for the row to land in `sessions` before responding. + // Without this, the SPA's next request races the store write, hits 401, and + // the prior bounce-to-login logic produced an infinite loop. + await new Promise((resolve, reject) => req.session.save(err => err ? reject(err) : resolve())); + if (ip) ipBackoff.recordSuccess(ip); + pool.query(`UPDATE users SET last_login_at = NOW() WHERE id = $1`, [user.id]) + .catch(err => console.error('[auth] last_login_at update failed:', err.message)); +} + +// POST /api/v1/auth/login/totp { ticket?, code } — second login step. `code` is +// either a 6-digit TOTP or a one-time recovery code. The ticket comes from the +// request body (password-login path) or req.session.mfa_ticket (Google path). +router.post('/login/totp', async (req, res, next) => { + try { + const ip = req.ip || req.socket?.remoteAddress || 'unknown'; + // Rate-limit the second factor with the same per-IP backoff as /login so + // the 6-digit code space can't be hammered. + const delay = ipBackoff.delayMs(ip); + if (delay > 0) await new Promise(r => setTimeout(r, delay)); + + const { ticket: bodyTicket, code } = req.body || {}; + const ticket = bodyTicket || req.session?.mfa_ticket; + if (req.session?.mfa_ticket) delete req.session.mfa_ticket; + // Bound to the issuing request's IP + UA — replays from a different origin + // redeem to null. See mfa-tickets.js for the binding model. + const userId = redeemTicket(ticket, { ip, userAgent: req.get('user-agent') }); + if (!userId) { + ipBackoff.recordFailure(ip); + return res.status(401).json({ error: 'invalid or expired ticket' }); + } + if (!code) return res.status(400).json({ error: 'code required' }); + + const { rows } = await pool.query( + `SELECT id, username, display_name, totp_secret, totp_enabled, totp_last_counter + FROM users WHERE id = $1`, [userId]); + const user = rows[0]; + if (!user || !user.totp_enabled || !user.totp_secret) { + return res.status(401).json({ error: 'invalid credentials' }); + } + + // verifyToken returns the matched counter on success. Reject codes at + // counters ≤ totp_last_counter to prevent replay within the same step. + // The CAS-style UPDATE makes this race-free under concurrent submissions. + const matchedCounter = verifyToken(user.totp_secret, code); + let ok = false; + if (matchedCounter !== null) { + const lastCounter = BigInt(user.totp_last_counter || 0); + if (BigInt(matchedCounter) > lastCounter) { + const upd = await pool.query( + `UPDATE users SET totp_last_counter = $1 + WHERE id = $2 AND totp_last_counter < $1`, + [String(matchedCounter), user.id] + ); + ok = upd.rowCount === 1; + } + // matchedCounter ≤ last → silent replay; falls through to recovery-code + // path which also fails → 401. Same UX as a wrong code, no info leak. + } + if (!ok) ok = await consumeRecoveryCode(user.id, code); + if (!ok) { + ipBackoff.recordFailure(ip); + // The ticket was single-use; the client must restart from /login. + return res.status(401).json({ error: 'invalid code' }); + } + + // recordSuccess is called by establishSession once the session lands — + // that's the first moment we know every required factor has passed. + await establishSession(req, user, ip); + res.json({ user: { id: user.id, username: user.username, display_name: user.display_name } }); + } catch (err) { next(err); } +}); + +// Check a recovery code against the user's unused codes; mark it spent on match. +// The marking is atomic (UPDATE ... WHERE used_at IS NULL with a rowCount check) +// so two concurrent redemptions of the same code can't both succeed. +async function consumeRecoveryCode(userId, code) { + const cleaned = String(code).trim().toLowerCase(); + if (!/^[0-9a-f]{5}-[0-9a-f]{5}$/.test(cleaned)) return false; + const { rows } = await pool.query( + `SELECT id, code_hash FROM user_recovery_codes WHERE user_id = $1 AND used_at IS NULL`, [userId]); + for (const row of rows) { + if (await comparePassword(cleaned, row.code_hash)) { + const upd = await pool.query( + `UPDATE user_recovery_codes SET used_at = NOW() WHERE id = $1 AND used_at IS NULL`, [row.id]); + // Lost the race if another request already consumed it. + return upd.rowCount === 1; + } + } + return false; +} + // POST /api/v1/auth/logout — destroys the session and clears the cookie. router.post('/logout', (req, res) => { if (!req.session) return res.status(204).end(); @@ -125,6 +235,7 @@ router.get('/me', requireAuth, (req, res) => { username: req.user.username, display_name: req.user.display_name, role: req.user.role, + totp_enabled: !!req.user.totp_enabled, }); }); @@ -149,5 +260,202 @@ router.post('/password', requireAuth, async (req, res, next) => { } catch (err) { next(err); } }); +// ── TOTP enrollment (all require an active session) ───────────────────────── + +// POST /api/v1/auth/totp/setup — begin enrollment. Generates a fresh secret, +// stores it (but leaves totp_enabled=false), and returns the otpauth URI + the +// base32 secret for manual entry. Enrollment isn't active until /enable +// confirms a code, so a started-but-abandoned setup never locks the user out. +router.post('/totp/setup', requireAuth, async (req, res, next) => { + try { + const { rows } = await pool.query(`SELECT totp_enabled FROM users WHERE id = $1`, [req.user.id]); + if (rows[0]?.totp_enabled) return res.status(409).json({ error: 'TOTP already enabled' }); + + const secret = generateSecret(); + await pool.query(`UPDATE users SET totp_secret = $1 WHERE id = $2`, [secret, req.user.id]); + const uri = otpauthURI(secret, req.user.username || 'user'); + + // QR rendering is optional — the otpauth URI + manual secret are sufficient + // to enroll. Render a data-URL QR only if the optional `qrcode` dep is + // present, so a missing dependency degrades instead of 500-ing. + let qr = null; + try { + const QRCode = (await import('qrcode')).default; + qr = await QRCode.toDataURL(uri); + } catch { /* qrcode not installed — client falls back to manual entry */ } + + res.json({ secret, otpauth_uri: uri, qr }); + } catch (err) { next(err); } +}); + +// POST /api/v1/auth/totp/enable { code } — confirm enrollment with a code from +// the authenticator. On success, flips totp_enabled and returns one-time +// recovery codes (shown exactly once). +router.post('/totp/enable', requireAuth, async (req, res, next) => { + try { + const { code } = req.body || {}; + if (!code) return badRequest(res, 'code required'); + + const { rows } = await pool.query( + `SELECT totp_secret, totp_enabled FROM users WHERE id = $1`, [req.user.id]); + const row = rows[0]; + if (!row?.totp_secret) return badRequest(res, 'start setup first'); + if (row.totp_enabled) return res.status(409).json({ error: 'TOTP already enabled' }); + const enrollCounter = verifyToken(row.totp_secret, code); + if (enrollCounter === null) return badRequest(res, 'incorrect code'); + + const recovery = generateRecoveryCodes(10); + const hashes = await Promise.all(recovery.map(c => hashPassword(c))); + // Enable + seed totp_last_counter to the enrollment code's counter so the + // same code can't be reused on first login. Replace any stale recovery + // codes atomically. + const client = await pool.connect(); + try { + await client.query('BEGIN'); + await client.query( + `UPDATE users SET totp_enabled = TRUE, totp_last_counter = $2 WHERE id = $1`, + [req.user.id, String(enrollCounter)] + ); + await client.query(`DELETE FROM user_recovery_codes WHERE user_id = $1`, [req.user.id]); + for (const h of hashes) { + await client.query( + `INSERT INTO user_recovery_codes (user_id, code_hash) VALUES ($1, $2)`, [req.user.id, h]); + } + await client.query('COMMIT'); + } catch (e) { + await client.query('ROLLBACK').catch(() => {}); + throw e; + } finally { client.release(); } + + res.json({ enabled: true, recovery_codes: recovery }); + } catch (err) { next(err); } +}); + +// POST /api/v1/auth/totp/disable { password } — turn off 2FA. Requires the +// account password as a confirmation so a hijacked live session can't silently +// strip the second factor. +router.post('/totp/disable', requireAuth, async (req, res, next) => { + try { + const { password } = req.body || {}; + if (!password) return badRequest(res, 'password required'); + const { rows } = await pool.query(`SELECT password_hash FROM users WHERE id = $1`, [req.user.id]); + if (!rows.length) return res.status(401).json({ error: 'unauthorized' }); + if (!(await comparePassword(password, rows[0].password_hash))) { + return badRequest(res, 'incorrect password'); + } + await pool.query( + `UPDATE users SET totp_enabled = FALSE, totp_secret = NULL, totp_last_counter = 0 WHERE id = $1`, + [req.user.id] + ); + await pool.query(`DELETE FROM user_recovery_codes WHERE user_id = $1`, [req.user.id]); + res.status(204).end(); + } catch (err) { next(err); } +}); + +// ── Google OAuth (OIDC) sign-in ───────────────────────────────────────────── +// All Google routes are config-gated: without GOOGLE_CLIENT_ID/SECRET and +// OAUTH_REDIRECT_URL they 404, so a deployment without SSO is unaffected. + +// GET /api/v1/auth/google/enabled — cheap, no auth. Lets the login screen decide +// whether to render the "Sign in with Google" button. +router.get('/google/enabled', (_req, res) => { + res.json({ enabled: googleConfigured() }); +}); + +// GET /api/v1/auth/google — kick off the OAuth dance. Stores an anti-CSRF state +// in the session and redirects to Google's consent screen. +router.get('/google', async (req, res, next) => { + try { + if (!googleConfigured()) return res.status(404).json({ error: 'google sign-in not configured' }); + const state = randomBytes(16).toString('hex'); + req.session.oauth_state = state; + await new Promise((resolve, reject) => req.session.save(err => err ? reject(err) : resolve())); + res.redirect(await buildAuthUrl(state)); + } catch (err) { next(err); } +}); + +// GET /api/v1/auth/google/callback — Google redirects back here with ?code&state. +// Verifies the ID token, enforces the allowed domain, auto-provisions a viewer +// on first login, establishes the session, then redirects to the SPA. +router.get('/google/callback', async (req, res, next) => { + try { + if (!googleConfigured()) return res.status(404).json({ error: 'google sign-in not configured' }); + const { code, state } = req.query; + const expected = req.session.oauth_state; + delete req.session.oauth_state; + if (!code || !state || !expected || state !== expected) { + return res.status(400).json({ error: 'invalid oauth state' }); + } + + const profile = await exchangeAndVerify(code); + const user = await resolveGoogleUser(profile); + + // If this account has TOTP enabled, Google is only the FIRST factor — route + // through the same second-factor step as password login. The ticket lives in + // the session (not the URL) and the SPA prompts for the code. + if (user.totp_enabled) { + const ip = req.ip || req.socket?.remoteAddress || 'unknown'; + req.session.mfa_ticket = issueTicket(user.id, { + ip, + userAgent: req.get('user-agent'), + }); + await new Promise((resolve, reject) => req.session.save(err => err ? reject(err) : resolve())); + return res.redirect('/?mfa=1'); + } + + const ip = req.ip || req.socket?.remoteAddress || 'unknown'; + await establishSession(req, user, ip); + + // Redirect to the SPA root; AuthGate will re-check /auth/me and render the app. + res.redirect('/'); + } catch (err) { + // Surface a friendly message on the login screen rather than a raw 500. + if (err.status === 403) return res.redirect('/?auth_error=domain'); + if (err.status === 401) return res.redirect('/?auth_error=google'); + next(err); + } +}); + +// Map a verified Google profile to a Dragonflight user row. +// +// Resolution order: +// 1. Existing link by google_sub → that user. +// 2. Otherwise auto-provision a fresh 'viewer'. +// +// We deliberately do NOT auto-link to an existing account by matching email: +// that would let anyone who controls a Google address with the same email sign +// in as a pre-existing local (possibly admin) account, bypassing its password +// and TOTP. Linking an existing account to Google is an explicit, authenticated +// action (a future "connect Google" under Settings), not something a login does. +async function resolveGoogleUser(profile) { + const found = await pool.query( + `SELECT id, username, display_name, totp_enabled FROM users WHERE google_sub = $1`, [profile.sub]); + if (found.rows.length) return found.rows[0]; + + const base = (profile.email.split('@')[0] || 'user').replace(/[^a-z0-9._-]/gi, '').toLowerCase() || 'user'; + let username = base, n = 1; + while ((await pool.query(`SELECT 1 FROM users WHERE username = $1`, [username])).rows.length) { + username = base + (++n); + } + + try { + const ins = await pool.query( + `INSERT INTO users (username, password_hash, display_name, role, email, google_sub) + VALUES ($1, NULL, $2, 'viewer', $3, $4) + RETURNING id, username, display_name, totp_enabled`, + [username, profile.name, profile.email, profile.sub]); + return ins.rows[0]; + } catch (err) { + // Concurrent first-login race: the unique google_sub index rejected our + // INSERT because a sibling request just created the row. Re-resolve. + if (err.code === '23505') { + const retry = await pool.query( + `SELECT id, username, display_name, totp_enabled FROM users WHERE google_sub = $1`, [profile.sub]); + if (retry.rows.length) return retry.rows[0]; + } + throw err; + } +} + export default router; -export { realUserCount }; +export { realUserCount, resolveGoogleUser, consumeRecoveryCode }; diff --git a/services/mam-api/src/routes/bins.js b/services/mam-api/src/routes/bins.js index 1fc91db..646d1eb 100644 --- a/services/mam-api/src/routes/bins.js +++ b/services/mam-api/src/routes/bins.js @@ -1,25 +1,60 @@ import express from 'express'; import pool from '../db/pool.js'; import { validateUuid } from '../middleware/errors.js'; +import { assertProjectAccess, accessibleProjectIds } from '../auth/authz.js'; import { v4 as uuidv4 } from 'uuid'; const router = express.Router(); -router.param('id', (req, res, next) => validateUuid('id')(req, res, next)); -// GET / - List bins. Filter by project_id when supplied; otherwise return -// every bin across every project so the Library / asset-context-menu can -// present a global "move to bin" picker. +// Resolve the owning project for a /:id bin, assert 'view' baseline, stash the +// project_id for mutating routes to escalate to 'edit'. +router.param('id', async (req, res, next) => { + validateUuid('id')(req, res, () => {}); + if (res.headersSent) return; + try { + const { rows } = await pool.query('SELECT project_id FROM bins WHERE id = $1', [req.params.id]); + if (rows.length === 0) return res.status(404).json({ error: 'Bin not found' }); + req.binProjectId = rows[0].project_id; + await assertProjectAccess(req.user, req.binProjectId, 'view'); + next(); + } catch (err) { next(err); } +}); + +async function requireBinEdit(req, res, next) { + try { + await assertProjectAccess(req.user, req.binProjectId, 'edit'); + next(); + } catch (err) { next(err); } +} + +// GET / - List bins. When project_id is supplied, scope to it (after an access +// check); otherwise return bins across every project the caller can access. router.get('/', async (req, res, next) => { try { const { project_id } = req.query; - const params = []; - let where = ''; if (project_id) { - where = 'WHERE b.project_id = $1'; - params.push(project_id); + await assertProjectAccess(req.user, project_id, 'view'); + const result = await pool.query( + `SELECT b.*, p.name AS project_name, + (SELECT COUNT(*)::int FROM assets a WHERE a.bin_id = b.id) AS asset_count + FROM bins b + LEFT JOIN projects p ON p.id = b.project_id + WHERE b.project_id = $1 + ORDER BY b.created_at DESC`, + [project_id] + ); + return res.json(result.rows); } + const access = await accessibleProjectIds(req.user); + let where = ''; + const params = []; + if (!access.all) { + if (access.ids.size === 0) return res.json([]); + where = 'WHERE b.project_id = ANY($1::uuid[])'; + params.push([...access.ids]); + } const result = await pool.query( `SELECT b.*, p.name AS project_name, (SELECT COUNT(*)::int FROM assets a WHERE a.bin_id = b.id) AS asset_count @@ -29,14 +64,13 @@ router.get('/', async (req, res, next) => { ORDER BY b.created_at DESC`, params ); - res.json(result.rows); } catch (err) { next(err); } }); -// POST / - Create bin +// POST / - Create bin (requires edit on the target project). router.post('/', async (req, res, next) => { try { const { project_id, name, parent_id } = req.body; @@ -44,6 +78,7 @@ router.post('/', async (req, res, next) => { if (!project_id || !name) { return res.status(400).json({ error: 'project_id and name are required' }); } + await assertProjectAccess(req.user, project_id, 'edit'); const id = uuidv4(); @@ -61,7 +96,7 @@ router.post('/', async (req, res, next) => { }); // PATCH /:id - Update bin -router.patch('/:id', async (req, res, next) => { +router.patch('/:id', requireBinEdit, async (req, res, next) => { try { const { id } = req.params; const { name, parent_id } = req.body; @@ -107,7 +142,7 @@ router.patch('/:id', async (req, res, next) => { }); // DELETE /:id - Delete bin -router.delete('/:id', async (req, res, next) => { +router.delete('/:id', requireBinEdit, async (req, res, next) => { try { const { id } = req.params; @@ -126,8 +161,8 @@ router.delete('/:id', async (req, res, next) => { } }); -// POST /:id/assets - Add asset to bin -router.post('/:id/assets', async (req, res, next) => { +// POST /:id/assets - Add asset to bin (requires edit on the bin's project). +router.post('/:id/assets', requireBinEdit, async (req, res, next) => { try { const { id } = req.params; const { asset_id } = req.body; @@ -136,10 +171,13 @@ router.post('/:id/assets', async (req, res, next) => { return res.status(400).json({ error: 'asset_id is required' }); } - // Verify bin exists - const binCheck = await pool.query('SELECT id FROM bins WHERE id = $1', [id]); - if (binCheck.rows.length === 0) { - return res.status(404).json({ error: 'Bin not found' }); + // Asset must live in the bin's own project. Without this, an editor in + // project A (where the bin lives) could pull an asset from project B (no + // grant) into A's bin tree, exposing it in A's views. + const a = await pool.query('SELECT project_id FROM assets WHERE id = $1', [asset_id]); + if (a.rows.length === 0) return res.status(404).json({ error: 'Asset not found' }); + if (a.rows[0].project_id !== req.binProjectId) { + return res.status(400).json({ error: 'asset belongs to a different project than the bin' }); } // Update asset's bin_id @@ -158,8 +196,8 @@ router.post('/:id/assets', async (req, res, next) => { } }); -// DELETE /:id/assets/:assetId - Remove asset from bin -router.delete('/:id/assets/:assetId', async (req, res, next) => { +// DELETE /:id/assets/:assetId - Remove asset from bin (requires edit). +router.delete('/:id/assets/:assetId', requireBinEdit, async (req, res, next) => { try { const { id, assetId } = req.params; diff --git a/services/mam-api/src/routes/capture.js b/services/mam-api/src/routes/capture.js index 2f14630..f699d83 100644 --- a/services/mam-api/src/routes/capture.js +++ b/services/mam-api/src/routes/capture.js @@ -1,3 +1,7 @@ +// authz: intentionally any-logged-in (no per-project scoping). This is a thin +// proxy to shared capture hardware with no project_id of its own; the resulting +// asset is scoped when it's registered via the /assets route. Gated by the +// global requireAuth in index.js, like the rest of /api/v1. import express from 'express'; const router = express.Router(); diff --git a/services/mam-api/src/routes/cluster.js b/services/mam-api/src/routes/cluster.js index 174ca49..e50ee34 100644 --- a/services/mam-api/src/routes/cluster.js +++ b/services/mam-api/src/routes/cluster.js @@ -1,9 +1,40 @@ import express from 'express'; import http from 'http'; +import os from 'os'; import pool from '../db/pool.js'; +import { requireAdmin } from '../middleware/auth.js'; const router = express.Router(); +// Hostname the primary mam-api self-registers as (mirrors selfHeartbeat()). +const SELF_HOSTNAME = process.env.NODE_HOSTNAME || os.hostname(); + +// Format a process uptime (seconds) the way the Cluster UI expects — a short +// human string like "3d 4h" / "12m". Workers don't report uptime today, so the +// primary is the only row that populates this. +function formatUptime(seconds) { + const s = Math.floor(seconds); + const d = Math.floor(s / 86400); + const h = Math.floor((s % 86400) / 3600); + const m = Math.floor((s % 3600) / 60); + if (d > 0) return `${d}d ${h}h`; + if (h > 0) return `${h}h ${m}m`; + return `${m}m`; +} + +// GET /onboard-info – admin-only. Supplies the Add Node wizard with the bits it +// needs to build a `curl … | bash` onboarding command: the primary API URL the +// remote node-agent should heartbeat to, the raw URL of onboard-node.sh, and +// the deploy branch. apiUrl is a best guess the UI lets the operator edit. +router.get('/onboard-info', requireAdmin, (req, res) => { + const branch = process.env.DEPLOY_BRANCH || 'main'; + const apiUrl = process.env.PUBLIC_API_URL + || `${req.protocol}://${req.hostname}:${process.env.API_PORT || 47432}`; + const scriptUrl = + `https://forge.wilddragon.net/zgaetano/wild-dragon/raw/branch/${branch}/deploy/onboard-node.sh`; + res.json({ apiUrl, scriptUrl, branch }); +}); + // If the agent reported Docker's default bridge IP (172.17.x) but the request // itself came from a real LAN address, prefer the request source IP instead. // We only check 172.17.x — the default docker0 bridge — not the full RFC1918 @@ -41,7 +72,6 @@ function dockerRequest(path, method = 'GET', body = null) { }); } -// GET / – list all registered cluster nodes with online status router.get('/', async (req, res, next) => { try { const r = await pool.query( @@ -50,25 +80,45 @@ router.get('/', async (req, res, next) => { FROM cluster_nodes ORDER BY registered_at ASC` ); - res.json(r.rows.map(row => ({ - ...row, - online: Number(row.stale_seconds) < 120, - }))); + res.json(r.rows.map(row => { + const out = { ...row, online: Number(row.stale_seconds) < 120 }; + // The primary (this mam-api host) does not heartbeat via the node-agent, + // so its version/uptime are never populated. Self-populate them here so + // the Cluster screen renders them like worker nodes instead of dashes. + if (row.role === 'primary' && row.hostname === SELF_HOSTNAME) { + out.version = process.env.npm_package_version || row.version || null; + out.uptime = formatUptime(process.uptime()); + } + return out; + })); } catch (err) { next(err); } }); -// GET /containers – list all containers on the local Docker host router.get('/containers', async (req, res, next) => { try { const containers = await dockerRequest('/containers/json?all=true'); if (!Array.isArray(containers)) return res.json([]); - const out = containers.map(c => { + const out = await Promise.all(containers.map(async c => { const rawName = (c.Names[0] || '').replace(/^\//, ''); const name = rawName.replace(/^wild-dragon-/, '').replace(/-\d+$/, ''); const ports = (c.Ports || []) .filter(p => p.PublicPort) .map(p => `${p.PublicPort}→${p.PrivatePort}`) .join(', '); + // Live memory usage requires a per-container stats call (the list endpoint + // doesn't include it). One extra Docker call each, but the list is small. + // memory_stats.usage includes page cache; subtract it to match `docker stats`. + let memBytes = null; + if (c.State === 'running') { + try { + const stats = await dockerRequest(`/containers/${c.Id}/stats?stream=false`); + const ms = stats && stats.memory_stats; + if (ms && typeof ms.usage === 'number') { + const cache = (ms.stats && ms.stats.cache) || 0; + memBytes = ms.usage - cache; + } + } catch (_) { memBytes = null; } + } return { id: c.Id.slice(0, 12), name, @@ -78,9 +128,9 @@ router.get('/containers', async (req, res, next) => { healthy: (c.Status || '').includes('healthy'), ports, cpu: 0, - mem: 0, + memBytes, }; - }); + })); res.json(out); } catch (err) { if (err.code === 'ENOENT' || err.code === 'EACCES') return res.json([]); @@ -88,7 +138,6 @@ router.get('/containers', async (req, res, next) => { } }); -// POST /containers/:nameOrId/restart router.post('/containers/:nameOrId/restart', async (req, res, next) => { try { await dockerRequest(`/containers/${encodeURIComponent(req.params.nameOrId)}/restart`, 'POST'); @@ -96,7 +145,6 @@ router.post('/containers/:nameOrId/restart', async (req, res, next) => { } catch (err) { next(err); } }); -// POST /heartbeat – upsert this node's registration (includes hardware capabilities) router.post('/heartbeat', async (req, res, next) => { try { const { @@ -108,11 +156,6 @@ router.post('/heartbeat', async (req, res, next) => { if (!hostname) return res.status(400).json({ error: 'hostname is required' }); - // Issue #106 — any authenticated user used to be able to POST a heartbeat - // for an arbitrary hostname and overwrite the primary node's `api_url`, - // effectively hijacking job dispatch. Now: if the caller's token is bound - // to a hostname (node-agent tokens are bound at issue time), the body - // hostname must match. Admin users with no binding are allowed for ops. if (process.env.AUTH_ENABLED === 'true') { const bound = req.tokenBoundHostname; if (bound && bound !== hostname) { @@ -132,8 +175,8 @@ router.post('/heartbeat', async (req, res, next) => { const r = await pool.query( `INSERT INTO cluster_nodes (hostname, ip_address, role, version, api_url, - cpu_usage, mem_used_mb, mem_total_mb, last_seen, capabilities, metadata, metrics) - VALUES ($1,$2,$3,$4,$5,$6,$7,$8,NOW(),$9,$10,$11) + cpu_usage, mem_used_mb, mem_total_mb, last_seen, last_seen_at, capabilities, metadata, metrics) + VALUES ($1,$2,$3,$4,$5,$6,$7,$8,NOW(),NOW(),$9,$10,$11) ON CONFLICT (hostname) DO UPDATE SET ip_address = EXCLUDED.ip_address, role = EXCLUDED.role, @@ -143,6 +186,7 @@ router.post('/heartbeat', async (req, res, next) => { mem_used_mb = EXCLUDED.mem_used_mb, mem_total_mb = EXCLUDED.mem_total_mb, last_seen = NOW(), + last_seen_at = NOW(), capabilities = EXCLUDED.capabilities, metadata = EXCLUDED.metadata, metrics = COALESCE(EXCLUDED.metrics, cluster_nodes.metrics) @@ -165,42 +209,25 @@ router.post('/heartbeat', async (req, res, next) => { } catch (err) { next(err); } }); -// GET /devices/blackmagic/signal – live video-presence state for every -// DeckLink port across the cluster. For each port we check whether there is -// an active SDI recorder assigned to it and, if so, query the capture -// container for its real signal state (receiving / lost / connecting / -// error). Ports without a recorder get signal = 'no-recorder'. -// -// Response shape (array): -// { node_id, hostname, index, device, model, -// signal, framesReceived, currentFps, recorder_id, recorder_status } router.get('/devices/blackmagic/signal', async (req, res, next) => { try { - // 1. Fetch all cluster nodes with DeckLink capabilities. const nodesResult = await pool.query( `SELECT id, hostname, ip_address, api_url, capabilities, EXTRACT(EPOCH FROM (NOW() - last_seen)) AS stale_seconds FROM cluster_nodes WHERE capabilities IS NOT NULL` ); - - // 2. Fetch all SDI recorders that are pinned to a node+device_index. const recResult = await pool.query( `SELECT id, name, status, container_id, node_id, device_index, source_config FROM recorders WHERE source_type = 'sdi' AND node_id IS NOT NULL` ); - - // Build a fast lookup: "${node_id}:${device_index}" → recorder row. const recByPort = new Map(); for (const r of recResult.rows) { const devIdx = r.device_index ?? r.source_config?.device ?? 0; recByPort.set(`${r.node_id}:${devIdx}`, r); } - - // 3. For each port, determine signal state. We fire all capture-container - // fetches concurrently so the endpoint stays fast even with many ports. const tasks = []; for (const node of nodesResult.rows) { const nodeOnline = Number(node.stale_seconds) < 120; @@ -208,79 +235,51 @@ router.get('/devices/blackmagic/signal', async (req, res, next) => { const model = (node.capabilities && node.capabilities.blackmagic_model) || null; const localHostname = process.env.NODE_HOSTNAME || ''; const isRemote = node.api_url && node.hostname !== localHostname; - bm.forEach((d, idx) => { const portIndex = d.index !== undefined ? d.index : idx; const rec = recByPort.get(`${node.id}:${portIndex}`); - tasks.push((async () => { const base = { - node_id: node.id, - hostname: node.hostname, - index: portIndex, - device: d.device || null, - model, - node_online: nodeOnline, - recorder_id: rec ? rec.id : null, - recorder_name: rec ? rec.name : null, + node_id: node.id, hostname: node.hostname, index: portIndex, + device: d.device || null, model, node_online: nodeOnline, + recorder_id: rec ? rec.id : null, recorder_name: rec ? rec.name : null, recorder_status: rec ? rec.status : null, - signal: 'no-recorder', - framesReceived: null, - currentFps: null, + signal: 'no-recorder', framesReceived: null, currentFps: null, }; - if (!rec || rec.status !== 'recording' || !rec.container_id) { - // No active capture — if there's a recorder but it's not recording, - // report that; otherwise the port is unassigned. if (rec && rec.status !== 'recording') base.signal = 'idle'; return base; } - - // Active recording — query the capture container for real signal. try { let live = null; if (isRemote) { - const r = await fetch( - `${node.api_url}/sidecar/${rec.container_id}/status`, - { signal: AbortSignal.timeout(2500) } - ); + const r = await fetch(`${node.api_url}/sidecar/${rec.container_id}/status`, { signal: AbortSignal.timeout(2500) }); if (r.ok) live = (await r.json()).live; } else { - const r = await fetch( - `http://recorder-${rec.id}:3001/capture/status`, - { signal: AbortSignal.timeout(2000) } - ); + const r = await fetch(`http://recorder-${rec.id}:3001/capture/status`, { signal: AbortSignal.timeout(2000) }); if (r.ok) live = await r.json(); } if (live && live.signal) { - base.signal = live.signal; + base.signal = live.signal; base.framesReceived = live.framesReceived ?? null; - base.currentFps = live.currentFps ?? null; - } else { - base.signal = 'connecting'; - } - } catch (_) { - base.signal = 'connecting'; - } + base.currentFps = live.currentFps ?? null; + } else { base.signal = 'connecting'; } + } catch (_) { base.signal = 'connecting'; } return base; })()); }); } - const results = await Promise.all(tasks); res.json(results); } catch (err) { next(err); } }); -// GET /devices/blackmagic – flatten every node's DeckLink cards for the -// recorder picker. Returns one entry per device with the host node info. router.get('/devices/blackmagic', async (req, res, next) => { try { const r = await pool.query( `SELECT id, hostname, ip_address, role, capabilities, EXTRACT(EPOCH FROM (NOW() - last_seen)) AS stale_seconds - FROM cluster_nodes - WHERE capabilities IS NOT NULL` + FROM cluster_nodes WHERE capabilities IS NOT NULL` ); const out = []; for (const row of r.rows) { @@ -288,157 +287,98 @@ router.get('/devices/blackmagic', async (req, res, next) => { const bm = (row.capabilities && row.capabilities.blackmagic) || []; const model = (row.capabilities && row.capabilities.blackmagic_model) || null; bm.forEach((d, idx) => { - out.push({ - node_id: row.id, - hostname: row.hostname, - ip_address: row.ip_address, - role: row.role, - online, - model, - index: d.index !== undefined ? d.index : idx, - device: d.device, - }); + out.push({ node_id: row.id, hostname: row.hostname, ip_address: row.ip_address, + role: row.role, online, model, index: d.index !== undefined ? d.index : idx, device: d.device }); }); } res.json(out); } catch (err) { next(err); } }); -// GET /devices/deltacast – flatten every node's Deltacast cards for the -// recorder picker. Mirrors /devices/blackmagic shape so the UI can treat -// both card types uniformly. router.get('/devices/deltacast', async (req, res, next) => { try { const r = await pool.query( `SELECT id, hostname, ip_address, role, capabilities, EXTRACT(EPOCH FROM (NOW() - last_seen)) AS stale_seconds - FROM cluster_nodes - WHERE capabilities IS NOT NULL` + FROM cluster_nodes WHERE capabilities IS NOT NULL` ); const out = []; for (const row of r.rows) { const online = Number(row.stale_seconds) < 120; - const dc = (row.capabilities && row.capabilities.deltacast) || []; + const dc = (row.capabilities && row.capabilities.deltacast) || []; const model = (row.capabilities && row.capabilities.deltacast_model) || null; - // Also synthesise entries from DELTACAST_PORT_COUNT if no entries reported yet — - // useful for nodes that haven't sent a heartbeat since the agent was updated. dc.forEach((d, idx) => { - out.push({ - node_id: row.id, - hostname: row.hostname, - ip_address: row.ip_address, - role: row.role, - online, - model: model || 'Deltacast', - index: d.index !== undefined ? d.index : idx, - device: d.device, - present: d.present !== false, - port_count: dc.length, - }); + out.push({ node_id: row.id, hostname: row.hostname, ip_address: row.ip_address, + role: row.role, online, model: model || 'Deltacast', + index: d.index !== undefined ? d.index : idx, device: d.device, + present: d.present !== false, port_count: dc.length }); }); } res.json(out); } catch (err) { next(err); } }); -// GET /devices/deltacast/signal – live signal state for Deltacast ports. -// Same pattern as /devices/blackmagic/signal. router.get('/devices/deltacast/signal', async (req, res, next) => { try { const [nodesRes, recordersRes] = await Promise.all([ - pool.query( - `SELECT id, hostname, ip_address, api_url, capabilities, + pool.query(`SELECT id, hostname, ip_address, api_url, capabilities, EXTRACT(EPOCH FROM (NOW() - last_seen)) AS stale_seconds - FROM cluster_nodes - WHERE capabilities IS NOT NULL` - ), - pool.query( - `SELECT id, node_id, device_index, status, source_type, container_id - FROM recorders WHERE source_type = 'deltacast'` - ), + FROM cluster_nodes WHERE capabilities IS NOT NULL`), + pool.query(`SELECT id, node_id, device_index, status, source_type, container_id + FROM recorders WHERE source_type = 'deltacast'`), ]); - const recByNodePort = {}; for (const rec of recordersRes.rows) { recByNodePort[`${rec.node_id}:${rec.device_index}`] = rec; } - const results = []; const fetchPromises = []; - for (const node of nodesRes.rows) { const online = Number(node.stale_seconds) < 120; const dc = (node.capabilities && node.capabilities.deltacast) || []; const model = (node.capabilities && node.capabilities.deltacast_model) || 'Deltacast'; - for (const port of dc) { const idx = port.index !== undefined ? port.index : dc.indexOf(port); const rec = recByNodePort[`${node.id}:${idx}`]; - const base = { - node_id: node.id, - hostname: node.hostname, - ip_address: node.ip_address, - online, - model, - index: idx, - device: port.device, - present: port.present !== false, - recorder_id: rec ? rec.id : null, - recorder_status: rec ? rec.status : null, - signal: 'no-recorder', - framesReceived: null, - currentFps: null, - }; - + const base = { node_id: node.id, hostname: node.hostname, ip_address: node.ip_address, + online, model, index: idx, device: port.device, present: port.present !== false, + recorder_id: rec ? rec.id : null, recorder_status: rec ? rec.status : null, + signal: 'no-recorder', framesReceived: null, currentFps: null }; if (!rec) { results.push(base); continue; } if (rec.status !== 'recording') { base.signal = 'idle'; results.push(base); continue; } - - // Active recording — query capture container for real signal. const fetchIdx = results.length; results.push(base); fetchPromises.push((async () => { try { - const url = node.api_url - ? `${node.api_url}/sidecar/${rec.container_id}/status` + const url = node.api_url ? `${node.api_url}/sidecar/${rec.container_id}/status` : `http://recorder-${rec.id}:3001/capture/status`; const r = await fetch(url, { signal: AbortSignal.timeout(2500) }); if (r.ok) { const live = await r.json(); if (live && live.signal) { - results[fetchIdx].signal = live.signal; + results[fetchIdx].signal = live.signal; results[fetchIdx].framesReceived = live.framesReceived ?? null; - results[fetchIdx].currentFps = live.currentFps ?? null; + results[fetchIdx].currentFps = live.currentFps ?? null; } } - } catch (_) { - results[fetchIdx].signal = 'connecting'; - } + } catch (_) { results[fetchIdx].signal = 'connecting'; } })()); } } - await Promise.all(fetchPromises); res.json(results); } catch (err) { next(err); } }); -// GET /:id/ping – probe the node's api_url/health endpoint directly router.get('/:id/ping', async (req, res, next) => { try { - const r = await pool.query( - 'SELECT id, hostname, api_url FROM cluster_nodes WHERE id = $1', - [req.params.id] - ); + const r = await pool.query('SELECT id, hostname, api_url FROM cluster_nodes WHERE id = $1', [req.params.id]); if (r.rowCount === 0) return res.status(404).json({ error: 'Node not found' }); - const node = r.rows[0]; if (!node.api_url) return res.json({ reachable: false, reason: 'no api_url registered' }); - const start = Date.now(); try { - const upstream = await fetch(`${node.api_url}/health`, { - signal: AbortSignal.timeout(4000), - }); + const upstream = await fetch(`${node.api_url}/health`, { signal: AbortSignal.timeout(4000) }); const latency_ms = Date.now() - start; const body = await upstream.json().catch(() => ({})); res.json({ reachable: upstream.ok, latency_ms, status: upstream.status, agent: body }); @@ -448,8 +388,83 @@ router.get('/:id/ping', async (req, res, next) => { } catch (err) { next(err); } }); +// ── Capture-driver / SDK deployment ──────────────────────────────────────── +// Admins install/update vendor capture-card drivers on a node from the UI. +// We resolve the node's api_url (like /:id/ping) and forward to its node-agent, +// which runs deploy/install-driver.sh in a privileged one-shot +// container against the host kernel. Vendor is allowlisted here AND on the +// agent. We never echo the agent token or proprietary paths back to the client. +const DRIVER_VENDORS = ['blackmagic', 'aja', 'deltacast', 'ndi']; + +// Bearer the agent expects (its NODE_TOKEN). Configured server-side; never +// derived from client input and never returned to the browser. +function agentAuthHeaders() { + const tok = process.env.NODE_AGENT_TOKEN || ''; + return tok ? { Authorization: `Bearer ${tok}` } : {}; +} + +async function resolveNode(id) { + const r = await pool.query('SELECT id, hostname, api_url, capabilities FROM cluster_nodes WHERE id = $1', [id]); + return r.rowCount === 0 ? null : r.rows[0]; +} + +router.get('/:id/driver-status', requireAdmin, async (req, res, next) => { + try { + const node = await resolveNode(req.params.id); + if (!node) return res.status(404).json({ error: 'Node not found' }); + if (!node.api_url) return res.status(409).json({ error: 'Node has no api_url registered' }); + try { + const upstream = await fetch(`${node.api_url}/driver/status`, { + headers: agentAuthHeaders(), + signal: AbortSignal.timeout(6000), + }); + const body = await upstream.json().catch(() => ({})); + if (!upstream.ok) { + return res.status(502).json({ error: 'Agent driver-status failed', status: upstream.status }); + } + res.json(body); + } catch (err) { + res.status(502).json({ error: 'Node unreachable', reason: err.message }); + } + } catch (err) { next(err); } +}); + +router.post('/:id/install-driver', requireAdmin, async (req, res, next) => { + try { + const vendor = String(req.body?.vendor || '').toLowerCase(); + if (!DRIVER_VENDORS.includes(vendor)) { + return res.status(400).json({ error: `Invalid vendor (allowed: ${DRIVER_VENDORS.join(', ')})` }); + } + const node = await resolveNode(req.params.id); + if (!node) return res.status(404).json({ error: 'Node not found' }); + if (!node.api_url) return res.status(409).json({ error: 'Node has no api_url registered' }); + + try { + // DKMS builds can take minutes — generous timeout. + const upstream = await fetch(`${node.api_url}/driver/install`, { + method: 'POST', + headers: { 'Content-Type': 'application/json', ...agentAuthHeaders() }, + body: JSON.stringify({ vendor }), + signal: AbortSignal.timeout(600000), + }); + const body = await upstream.json().catch(() => ({})); + // Relay logs/result. install-driver.sh never echoes secrets; the agent + // returns only its structured [install-driver] log lines + status. + res.status(upstream.ok ? 200 : 502).json({ + ok: !!body.ok, + vendor, + exitCode: body.exitCode ?? null, + rebootRequired: !!body.rebootRequired, + status: body.status ?? null, + logs: typeof body.logs === 'string' ? body.logs : '', + error: body.ok ? undefined : (body.error || 'Install failed — see logs'), + }); + } catch (err) { + res.status(502).json({ error: 'Node unreachable or install timed out', reason: err.message }); + } + } catch (err) { next(err); } +}); -// GET /metrics - live per-node utilization (CPU, RAM, GPU) router.get('/metrics', async (req, res, next) => { try { const r = await pool.query( @@ -457,59 +472,37 @@ router.get('/metrics', async (req, res, next) => { cpu_usage, mem_used_mb, mem_total_mb, capabilities, metrics, EXTRACT(EPOCH FROM (NOW() - last_seen)) AS stale_seconds - FROM cluster_nodes - ORDER BY registered_at ASC` + FROM cluster_nodes ORDER BY registered_at ASC` ); - const nodes = r.rows.map(row => { - const capGpus = (row.capabilities && row.capabilities.gpus) || []; + const capGpus = (row.capabilities && row.capabilities.gpus) || []; const liveGpus = (row.metrics && row.metrics.gpus) || []; - const gpus = capGpus.map((g, idx) => { const live = liveGpus.find(l => l.index === g.index) || liveGpus[idx] || {}; - return { - name: g.name || null, - util_pct: live.util_pct != null ? live.util_pct : null, - memory_used_mb: live.memory_used_mb != null ? live.memory_used_mb : null, - memory_total_mb: g.memory_mb != null ? g.memory_mb : (live.memory_total_mb ?? null), - }; + return { name: g.name || null, util_pct: live.util_pct != null ? live.util_pct : null, + memory_used_mb: live.memory_used_mb != null ? live.memory_used_mb : null, + memory_total_mb: g.memory_mb != null ? g.memory_mb : (live.memory_total_mb ?? null) }; }); - // include any live GPUs not in static capabilities for (const lg of liveGpus) { if (!capGpus.some(g => g.index === lg.index)) { - gpus.push({ - name: lg.name || null, - util_pct: lg.util_pct != null ? lg.util_pct : null, - memory_used_mb: lg.memory_used_mb != null ? lg.memory_used_mb : null, - memory_total_mb: lg.memory_total_mb != null ? lg.memory_total_mb : null, - }); + gpus.push({ name: lg.name || null, util_pct: lg.util_pct != null ? lg.util_pct : null, + memory_used_mb: lg.memory_used_mb != null ? lg.memory_used_mb : null, + memory_total_mb: lg.memory_total_mb != null ? lg.memory_total_mb : null }); } } - - return { - id: row.id, - hostname: row.hostname, - role: row.role, - online: Number(row.stale_seconds) < 120, - last_seen: row.last_seen, - cpu_util_pct: row.cpu_usage != null ? Number(row.cpu_usage) : null, - ram_used_mb: row.mem_used_mb != null ? row.mem_used_mb : null, - ram_total_mb: row.mem_total_mb != null ? row.mem_total_mb : null, - gpus, - }; + return { id: row.id, hostname: row.hostname, role: row.role, + online: Number(row.stale_seconds) < 120, last_seen: row.last_seen, + cpu_util_pct: row.cpu_usage != null ? Number(row.cpu_usage) : null, + ram_used_mb: row.mem_used_mb != null ? row.mem_used_mb : null, + ram_total_mb: row.mem_total_mb != null ? row.mem_total_mb : null, gpus }; }); - res.json({ nodes }); } catch (err) { next(err); } }); -// DELETE /:id – deregister a node router.delete('/:id', async (req, res, next) => { try { - const r = await pool.query( - 'DELETE FROM cluster_nodes WHERE id = $1 RETURNING id', - [req.params.id] - ); + const r = await pool.query('DELETE FROM cluster_nodes WHERE id = $1 RETURNING id', [req.params.id]); if (r.rowCount === 0) return res.status(404).json({ error: 'Node not found' }); res.json({ ok: true }); } catch (err) { next(err); } diff --git a/services/mam-api/src/routes/comments.js b/services/mam-api/src/routes/comments.js index 6701155..5a0cae1 100644 --- a/services/mam-api/src/routes/comments.js +++ b/services/mam-api/src/routes/comments.js @@ -5,9 +5,23 @@ import express from 'express'; import pool from '../db/pool.js'; +import { assertProjectAccess } from '../auth/authz.js'; const router = express.Router({ mergeParams: true }); +// Scope every comment route to the parent asset's project: resolve project_id +// via the asset, then require 'view' to read and 'edit' to write. A non-UUID or +// unknown asset is a clean 404 before any access decision leaks its existence. +const MUTATING = new Set(['POST', 'PUT', 'PATCH', 'DELETE']); +router.use(async (req, res, next) => { + try { + const { rows } = await pool.query('SELECT project_id FROM assets WHERE id = $1', [req.params.assetId]); + if (rows.length === 0) return res.status(404).json({ error: 'Asset not found' }); + await assertProjectAccess(req.user, rows[0].project_id, MUTATING.has(req.method) ? 'edit' : 'view'); + next(); + } catch (err) { next(err); } +}); + function rowToJson(r) { return { id: r.id, @@ -49,8 +63,9 @@ router.post('/', async (req, res, next) => { if (!body || !String(body).trim()) { return res.status(400).json({ error: 'body is required' }); } - // Best-effort author lookup — pull from the session if AUTH_ENABLED is on. - const userId = req.session?.userId || null; + // Author is the authenticated user (requireAuth sets req.user for both + // session and bearer auth, and the dev user when AUTH_ENABLED=false). + const userId = req.user?.id || null; const ins = await pool.query( `INSERT INTO asset_comments (asset_id, user_id, body, frame_ms) diff --git a/services/mam-api/src/routes/imports.js b/services/mam-api/src/routes/imports.js index 7540e46..eeab8c3 100644 --- a/services/mam-api/src/routes/imports.js +++ b/services/mam-api/src/routes/imports.js @@ -10,6 +10,7 @@ import express from 'express'; import { Queue } from 'bullmq'; import { v4 as uuidv4 } from 'uuid'; import pool from '../db/pool.js'; +import { assertProjectAccess } from '../auth/authz.js'; const router = express.Router(); @@ -60,6 +61,8 @@ router.post('/youtube', async (req, res, next) => { if (projCheck.rows.length === 0) { return res.status(404).json({ error: 'Project not found' }); } + // Importing writes an asset into the project — require edit access. + await assertProjectAccess(req.user, projectId, 'edit'); const assetId = uuidv4(); diff --git a/services/mam-api/src/routes/jobs.js b/services/mam-api/src/routes/jobs.js index 1079b19..5608cb1 100644 --- a/services/mam-api/src/routes/jobs.js +++ b/services/mam-api/src/routes/jobs.js @@ -1,6 +1,7 @@ import express from 'express'; import pool from '../db/pool.js'; import { Queue } from 'bullmq'; +import { assertProjectAccess } from '../auth/authz.js'; const router = express.Router(); // Note: jobs use BullMQ id format ":" (e.g. "conform:42"), @@ -21,20 +22,22 @@ const parseRedisUrl = (url) => { const redisConn = parseRedisUrl(process.env.REDIS_URL || 'redis://queue:6379'); -const proxyQueue = new Queue('proxy', { connection: redisConn }); -const thumbnailQueue = new Queue('thumbnail', { connection: redisConn }); -const filmstripQueue = new Queue('filmstrip', { connection: redisConn }); -const conformQueue = new Queue('conform', { connection: redisConn }); -const importQueue = new Queue('import', { connection: redisConn }); -const trimQueue = new Queue('trim', { connection: redisConn }); +const proxyQueue = new Queue('proxy', { connection: redisConn }); +const thumbnailQueue = new Queue('thumbnail', { connection: redisConn }); +const filmstripQueue = new Queue('filmstrip', { connection: redisConn }); +const conformQueue = new Queue('conform', { connection: redisConn }); +const importQueue = new Queue('import', { connection: redisConn }); +const trimQueue = new Queue('trim', { connection: redisConn }); +const playoutStageQueue = new Queue('playout-stage', { connection: redisConn }); const QUEUES = [ - { queue: proxyQueue, type: 'proxy' }, - { queue: thumbnailQueue, type: 'thumbnail' }, - { queue: filmstripQueue, type: 'filmstrip' }, - { queue: conformQueue, type: 'conform' }, - { queue: importQueue, type: 'import' }, - { queue: trimQueue, type: 'trim' }, + { queue: proxyQueue, type: 'proxy' }, + { queue: thumbnailQueue, type: 'thumbnail' }, + { queue: filmstripQueue, type: 'filmstrip' }, + { queue: conformQueue, type: 'conform' }, + { queue: importQueue, type: 'import' }, + { queue: trimQueue, type: 'trim' }, + { queue: playoutStageQueue, type: 'playout-stage' }, ]; // BullMQ state → API status mapping @@ -324,6 +327,10 @@ router.post('/conform', async (req, res, next) => { }); } + // Conform writes back into a project — require edit on that project. Without + // this, any logged-in user could enqueue conform jobs targeting any project. + await assertProjectAccess(req.user, project_id, 'edit'); + const bullJob = await conformQueue.add('conform-task', { edl, projectId: project_id, diff --git a/services/mam-api/src/routes/playout.js b/services/mam-api/src/routes/playout.js new file mode 100644 index 0000000..ca66cc2 --- /dev/null +++ b/services/mam-api/src/routes/playout.js @@ -0,0 +1,777 @@ +// Playout / Master Control routes. +// +// Control plane for the CasparCG-backed playout subsystem. Channels are placed +// on cluster nodes and their engine containers spawned via the same Docker-socket +// / node-agent path recorders use; the channel's transport (play / pause / skip) +// is proxied through to the sidecar's HTTP shim, which drives CasparCG over AMCP. +// +// RBAC: every channel carries a project_id (NULL = admin-only, the recorder +// convention). List routes filter by accessible projects; mutating routes assert +// 'edit'. See docs/superpowers/specs/2026-05-30-playout-mcr-design.md. + +import express from 'express'; +import http from 'http'; +import { readFile } from 'fs/promises'; +import { Queue } from 'bullmq'; +import pool from '../db/pool.js'; +import { validateUuid } from '../middleware/errors.js'; +import { + assertProjectAccess, accessibleProjectIds, isAdmin, +} from '../auth/authz.js'; + +const router = express.Router(); + +const parseRedisUrl = (url) => { + const parsed = new URL(url); + return { host: parsed.hostname, port: parseInt(parsed.port, 10) }; +}; +const stageQueue = new Queue('playout-stage', { + connection: parseRedisUrl(process.env.REDIS_URL || 'redis://queue:6379'), +}); + +const PLAYOUT_SIDECAR_IMAGE = process.env.PLAYOUT_IMAGE || 'wild-dragon-playout:latest'; + +function dockerApi(method, path, body = null) { + return new Promise((resolve, reject) => { + const options = { + socketPath: '/var/run/docker.sock', + path: `/v1.43${path}`, + method, + headers: { 'Content-Type': 'application/json' }, + }; + const req = http.request(options, (res) => { + let data = ''; + res.on('data', (chunk) => (data += chunk)); + res.on('end', () => { + try { resolve({ status: res.statusCode, data: data ? JSON.parse(data) : {} }); } + catch { resolve({ status: res.statusCode, data }); } + }); + }); + req.on('error', reject); + req.setTimeout(10000, () => req.destroy(new Error('Docker API timeout after 10s'))); + if (body) req.write(JSON.stringify(body)); + req.end(); + }); +} + +async function resolveNodeTarget(nodeId) { + if (!nodeId) return { remote: false }; + const r = await pool.query( + 'SELECT hostname, ip_address, api_url FROM cluster_nodes WHERE id = $1', [nodeId] + ); + if (r.rows.length === 0) return { remote: false }; + const node = r.rows[0]; + const localHostname = process.env.NODE_HOSTNAME || ''; + if (!node.api_url || node.hostname === localHostname) return { remote: false }; + return { remote: true, apiUrl: node.api_url, ip: node.ip_address }; +} + +const SIDECAR_HTTP_PORT = 3002; + +function channelAlias(id) { return `playout-${id}`; } + +function sidecarBaseUrl(channel) { + if (channel.container_meta && channel.container_meta.sidecar_url) { + return channel.container_meta.sidecar_url; + } + return `http://${channelAlias(channel.id)}:${SIDECAR_HTTP_PORT}`; +} + +async function callSidecar(channel, path, method = 'POST', body = null) { + const url = `${sidecarBaseUrl(channel)}${path}`; + const res = await fetch(url, { + method, + headers: { 'Content-Type': 'application/json' }, + body: body ? JSON.stringify(body) : undefined, + signal: AbortSignal.timeout(20000), + }); + if (!res.ok) { + const text = await res.text().catch(() => ''); + throw new Error(`sidecar ${method} ${path} -> HTTP ${res.status}: ${text.slice(0, 200)}`); + } + return res.json().catch(() => ({})); +} + +function channelToJson(r) { + return { + id: r.id, + name: r.name, + node_id: r.node_id, + output_type: r.output_type, + output_config: r.output_config, + video_format: r.video_format, + status: r.status, + container_id: r.container_id, + error_message: r.error_message, + project_id: r.project_id, + restart_count: r.restart_count ?? 0, + last_restart_at: r.last_restart_at, + last_heartbeat_at: r.last_heartbeat_at, + created_at: r.created_at, + updated_at: r.updated_at, + }; +} + +const OUTPUT_TYPES = new Set(['decklink', 'ndi', 'srt', 'rtmp']); + +router.param('id', async (req, res, next) => { + validateUuid('id')(req, res, () => {}); + if (res.headersSent) return; + try { + const { rows } = await pool.query( + 'SELECT * FROM playout_channels WHERE id = $1', [req.params.id] + ); + if (rows.length === 0) return res.status(404).json({ error: 'Channel not found' }); + req.channel = rows[0]; + await assertProjectAccess(req.user, req.channel.project_id, 'view'); + next(); + } catch (err) { next(err); } +}); + +async function requireChannelEdit(req, res, next) { + try { await assertProjectAccess(req.user, req.channel.project_id, 'edit'); next(); } + catch (err) { next(err); } +} + +router.get('/channels', async (req, res, next) => { + try { + let rows; + if (isAdmin(req.user)) { + ({ rows } = await pool.query('SELECT * FROM playout_channels ORDER BY created_at DESC')); + } else { + const ids = await accessibleProjectIds(req.user); + if (ids.length === 0) return res.json([]); + ({ rows } = await pool.query( + 'SELECT * FROM playout_channels WHERE project_id = ANY($1) ORDER BY created_at DESC', [ids] + )); + } + res.json(rows.map(channelToJson)); + } catch (err) { next(err); } +}); + +router.post('/channels', async (req, res, next) => { + try { + const { name, node_id = null, output_type = 'srt', output_config = {}, + video_format = '1080p5994', project_id = null } = req.body || {}; + if (!name || typeof name !== 'string') { + return res.status(400).json({ error: 'name is required' }); + } + if (!OUTPUT_TYPES.has(output_type)) { + return res.status(400).json({ error: `output_type must be one of: ${[...OUTPUT_TYPES].join(', ')}` }); + } + if (project_id) await assertProjectAccess(req.user, project_id, 'edit'); + else if (!isAdmin(req.user)) return res.status(403).json({ error: 'admin required for unassigned channel' }); + + const { rows } = await pool.query( + `INSERT INTO playout_channels (name, node_id, output_type, output_config, video_format, project_id) + VALUES ($1,$2,$3,$4,$5,$6) RETURNING *`, + [name.trim(), node_id, output_type, JSON.stringify(output_config), video_format, project_id] + ); + res.status(201).json(channelToJson(rows[0])); + } catch (err) { next(err); } +}); + +router.patch('/channels/:id', requireChannelEdit, async (req, res, next) => { + try { + if (req.channel.status === 'running') { + return res.status(409).json({ error: 'Cannot edit a running channel — stop it first' }); + } + const allowed = ['name', 'node_id', 'output_type', 'output_config', 'video_format', 'project_id']; + const sets = []; + const vals = []; + let i = 1; + for (const k of allowed) { + if (req.body[k] === undefined) continue; + if (k === 'output_type' && !OUTPUT_TYPES.has(req.body[k])) { + return res.status(400).json({ error: 'invalid output_type' }); + } + sets.push(`${k} = $${i++}`); + vals.push(k === 'output_config' ? JSON.stringify(req.body[k]) : req.body[k]); + } + if (sets.length === 0) return res.json(channelToJson(req.channel)); + vals.push(req.channel.id); + const { rows } = await pool.query( + `UPDATE playout_channels SET ${sets.join(', ')}, updated_at = NOW() WHERE id = $${i} RETURNING *`, vals + ); + res.json(channelToJson(rows[0])); + } catch (err) { next(err); } +}); + +router.delete('/channels/:id', requireChannelEdit, async (req, res, next) => { + try { + if (req.channel.status === 'running') { + return res.status(409).json({ error: 'Stop the channel before deleting it' }); + } + await pool.query('DELETE FROM playout_channels WHERE id = $1', [req.channel.id]); + res.json({ deleted: true }); + } catch (err) { next(err); } +}); + +async function assertDeckLinkFree(channel) { + if (channel.output_type !== 'decklink') return; + const idx = (channel.output_config && channel.output_config.device_index) || 1; + const chan = await pool.query( + `SELECT id FROM playout_channels + WHERE id <> $1 AND node_id IS NOT DISTINCT FROM $2 AND status = 'running' + AND output_type = 'decklink' AND (output_config->>'device_index')::int = $3`, + [channel.id, channel.node_id, idx] + ); + if (chan.rows.length > 0) { + throw Object.assign(new Error(`DeckLink device ${idx} already in use by another channel on this node`), { httpStatus: 409 }); + } + const rec = await pool.query( + `SELECT id FROM recorders + WHERE node_id IS NOT DISTINCT FROM $1 AND device_index = $2 + AND status = 'recording' AND source_type = 'sdi'`, + [channel.node_id, idx] + ); + if (rec.rows.length > 0) { + throw Object.assign(new Error(`DeckLink device ${idx} is in use by a recorder on this node`), { httpStatus: 409 }); + } +} + +async function spawnChannelSidecar(channel) { + await pool.query('UPDATE playout_channels SET status = $1, error_message = NULL WHERE id = $2', ['starting', channel.id]); + + const env = [ + `OUTPUT_TYPE=${channel.output_type}`, + `OUTPUT_CONFIG=${JSON.stringify(channel.output_config || {})}`, + `VIDEO_FORMAT=${channel.video_format}`, + `PORT=${SIDECAR_HTTP_PORT}`, + `CHANNEL_ID=${channel.id}`, + ]; + + const { remote: isRemote, apiUrl: targetNodeApiUrl } = await resolveNodeTarget(channel.node_id); + const dockerNetwork = process.env.DOCKER_NETWORK || 'wild-dragon_wild-dragon'; + let containerId; + let containerMeta = {}; + + if (isRemote) { + const sidecarRes = await fetch(`${targetNodeApiUrl}/sidecar/start`, { + method: 'POST', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ + image: PLAYOUT_SIDECAR_IMAGE, env, + capturePort: SIDECAR_HTTP_PORT, + sourceType: channel.output_type, + useGpu: false, + publishHttp: true, + }), + signal: AbortSignal.timeout(20000), + }); + if (!sidecarRes.ok) { + const details = await sidecarRes.json().catch(() => ({})); + console.error('[playout] remote sidecar start failed:', JSON.stringify(details)); + await pool.query('UPDATE playout_channels SET status = $1, error_message = $2 WHERE id = $3', + ['error', 'remote node failed to start sidecar', channel.id]); + throw Object.assign(new Error('Remote node failed to start sidecar'), { httpStatus: 502 }); + } + const data = await sidecarRes.json(); + containerId = data.containerId; + if (data.sidecarUrl || data.host) { + containerMeta.sidecar_url = data.sidecarUrl || `http://${data.host}:${SIDECAR_HTTP_PORT}`; + } + } else { + const alias = channelAlias(channel.id); + const hostBinds = ['/mnt/NVME/MAM/wild-dragon-media:/media']; + if (channel.output_type === 'decklink') hostBinds.push('/dev/blackmagic:/dev/blackmagic'); + + const containerConfig = { + Image: PLAYOUT_SIDECAR_IMAGE, + Env: env, + HostConfig: { + // DeckLink SDI needs raw /dev access (privileged). SRT/NDI/RTMP/HLS run + // unprivileged — privileged exposes host GPUs to CasparCG, and the + // missing in-container NVIDIA driver crashes the engine within seconds. + Privileged: channel.output_type === 'decklink', + NetworkMode: dockerNetwork, + Binds: hostBinds, + }, + NetworkingConfig: { EndpointsConfig: { [dockerNetwork]: { Aliases: [alias] } } }, + Hostname: alias, + }; + const createRes = await dockerApi('POST', '/containers/create', containerConfig); + if (createRes.status !== 201) { + console.error('[playout] container create failed:', JSON.stringify(createRes.data)); + await pool.query('UPDATE playout_channels SET status = $1, error_message = $2 WHERE id = $3', + ['error', 'container create failed', channel.id]); + throw Object.assign(new Error('Failed to create container'), { httpStatus: 500 }); + } + containerId = createRes.data.Id; + const startRes = await dockerApi('POST', `/containers/${containerId}/start`); + if (startRes.status !== 204) { + console.error('[playout] container start failed:', JSON.stringify(startRes.data)); + await dockerApi('DELETE', `/containers/${containerId}?force=true`).catch(() => {}); + await pool.query('UPDATE playout_channels SET status = $1, error_message = $2 WHERE id = $3', + ['error', 'container start failed', channel.id]); + throw Object.assign(new Error('Failed to start container'), { httpStatus: 500 }); + } + } + + // Set last_heartbeat_at = NOW() so the scheduler health tick treats this + // channel as freshly alive. Without this, last_heartbeat_at starts as NULL + // (epoch=0), and the very first tick sees ageMs >> TIMEOUT_MS and triggers + // failover immediately — before the sidecar has had a chance to respond. + const { rows } = await pool.query( + `UPDATE playout_channels + SET status = 'running', container_id = $1, container_meta = $2, + last_heartbeat_at = NOW(), updated_at = NOW() + WHERE id = $3 RETURNING *`, + [containerId, JSON.stringify(containerMeta), channel.id] + ); + return rows[0]; +} + +router.post('/channels/:id/start', requireChannelEdit, async (req, res, next) => { + try { + const channel = req.channel; + if (channel.status === 'running' || channel.status === 'starting') { + return res.status(409).json({ error: `Channel already ${channel.status}` }); + } + await assertDeckLinkFree(channel); + const row = await spawnChannelSidecar(channel); + res.json(channelToJson(row)); + } catch (err) { + if (err.httpStatus) return res.status(err.httpStatus).json({ error: err.message }); + next(err); + } +}); + +router.post('/channels/:id/stop', requireChannelEdit, async (req, res, next) => { + try { + const channel = req.channel; + if (channel.container_id) { + const { remote: isRemote, apiUrl } = await resolveNodeTarget(channel.node_id); + if (isRemote) { + await fetch(`${apiUrl}/sidecar/stop`, { + method: 'POST', headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ containerId: channel.container_id }), + signal: AbortSignal.timeout(20000), + }).catch((e) => console.error('[playout] remote stop failed:', e.message)); + } else { + await dockerApi('POST', `/containers/${channel.container_id}/stop?t=10`).catch(() => {}); + await dockerApi('DELETE', `/containers/${channel.container_id}?force=true`).catch(() => {}); + } + } + const { rows } = await pool.query( + `UPDATE playout_channels SET status = 'stopped', container_id = NULL, updated_at = NOW() + WHERE id = $1 RETURNING *`, [channel.id] + ); + res.json(channelToJson(rows[0])); + } catch (err) { next(err); } +}); + +router.get('/channels/:id/status', async (req, res, next) => { + try { + if (req.channel.status !== 'running') { + return res.json({ running: false, status: req.channel.status }); + } + const out = await callSidecar(req.channel, '/status', 'GET'); + res.json({ running: true, status: req.channel.status, engine: out }); + } catch (err) { + res.json({ running: true, status: req.channel.status, engine: null, engine_error: err.message }); + } +}); + +// GET /playout/channels/:id/hls/index.m3u8 — the live preview playlist, served +// through the API (not the static /media/live path) so it bypasses the public +// reverse proxy's static cache. That proxy caches the .m3u8 by path with a +// multi-second TTL and ignores the origin's no-store, so hls.js's ~1s reloads +// always got a STALE playlist ("MISSED" forever → monitor stayed black). The +// /api/ path is not proxy-cached (the status poll updates fine), so this always +// returns the fresh live edge. Segment (.ts) lines are rewritten to absolute +// /media/live// URLs so they still load from the static path (immutable, +// caching them is fine). mam-api shares the same /media volume the sidecars +// write to. +const HLS_MEDIA_DIR = process.env.PLAYOUT_MEDIA_DIR || '/media'; +router.get('/channels/:id/hls/index.m3u8', async (req, res, next) => { + try { + const cid = req.channel.id; + let body; + try { + body = await readFile(`${HLS_MEDIA_DIR}/live/${cid}/index.m3u8`, 'utf8'); + } catch (e) { + return res.status(404).json({ error: 'No live preview for this channel yet' }); + } + // Rewrite bare segment names to absolute static URLs. + const rewritten = body + .split('\n') + .map((line) => (/^[^#].*\.ts\s*$/.test(line) ? `/media/live/${cid}/${line.trim()}` : line)) + .join('\n'); + res.setHeader('Content-Type', 'application/vnd.apple.mpegurl'); + res.setHeader('Cache-Control', 'no-store, no-cache, must-revalidate'); + res.setHeader('Pragma', 'no-cache'); + res.send(rewritten); + } catch (err) { next(err); } +}); + +// ── Transport ──────────────────────────────────────────────────────────────── +async function transport(req, res, action, body = null) { + if (req.channel.status !== 'running') { + return res.status(409).json({ error: 'Channel is not running' }); + } + try { res.json(await callSidecar(req.channel, action, 'POST', body)); } + catch (err) { res.status(502).json({ error: err.message }); } +} + +router.post('/channels/:id/play', requireChannelEdit, async (req, res, next) => { + try { + if (req.channel.status !== 'running') { + return res.status(409).json({ error: 'Start the channel before playing' }); + } + const { playlist_id } = req.body || {}; + if (!playlist_id) return res.status(400).json({ error: 'playlist_id is required' }); + + const pl = await pool.query('SELECT * FROM playout_playlists WHERE id = $1 AND channel_id = $2', + [playlist_id, req.channel.id]); + if (pl.rows.length === 0) return res.status(404).json({ error: 'Playlist not found for this channel' }); + + const items = await pool.query( + `SELECT i.*, a.filename AS clip_name, a.duration_ms AS asset_duration_ms + FROM playout_items i JOIN assets a ON a.id = i.asset_id + WHERE i.playlist_id = $1 ORDER BY i.sort_order ASC`, [playlist_id]); + + const notReady = items.rows.filter((i) => i.media_status !== 'ready' || !i.media_path); + if (notReady.length > 0) { + return res.status(409).json({ + error: 'Some items are not staged yet', + pending: notReady.map((i) => i.id), + }); + } + + const payload = { + loop: pl.rows[0].loop, + items: items.rows.map((i) => ({ + id: i.id, asset_id: i.asset_id, media_path: i.media_path, + in_point: i.in_point ? Number(i.in_point) : null, + out_point: i.out_point ? Number(i.out_point) : null, + transition: i.transition, transition_ms: i.transition_ms, + clip_name: i.clip_name, + asset_duration_ms: i.asset_duration_ms != null ? Number(i.asset_duration_ms) : null, + })), + }; + // callSidecar throws on network/timeout errors. Return 502 (not 409) so + // the UI and operators know it's a gateway problem, not a state conflict. + let out; + try { + out = await callSidecar(req.channel, '/playlist/load', 'POST', payload); + } catch (err) { + return res.status(502).json({ error: 'Sidecar unreachable: ' + err.message }); + } + res.json(out); + } catch (err) { next(err); } +}); + +router.post('/channels/:id/pause', requireChannelEdit, (req, res) => transport(req, res, '/transport/pause')); +router.post('/channels/:id/resume', requireChannelEdit, (req, res) => transport(req, res, '/transport/resume')); +router.post('/channels/:id/skip', requireChannelEdit, (req, res) => transport(req, res, '/transport/skip')); +router.post('/channels/:id/stop-playback', requireChannelEdit, (req, res) => transport(req, res, '/channel/stop')); + +router.get('/channels/:id/asrun', async (req, res, next) => { + try { + const { rows } = await pool.query( + `SELECT * FROM playout_as_run WHERE channel_id = $1 ORDER BY started_at DESC LIMIT 500`, + [req.channel.id]); + res.json(rows); + } catch (err) { next(err); } +}); + +// ── SCTE-35 ad-break splices ─────────────────────────────────────────────── +// Schedule, trigger, and list SCTE-35 ad breaks on a channel. A break can be +// scheduled (after a playlist position, or at a wall-clock time) or fired +// immediately. Firing tells the sidecar to splice the live output, marks the +// break 'fired', and stamps a row in the as-run compliance log. +const SCTE_TYPES = new Set(['splice_insert', 'immediate', 'splice_out', 'splice_in']); + +// Fire a break row on the sidecar + record it. Shared by the immediate-trigger +// route and the scheduler's due-break sweep. Best-effort: a sidecar failure +// marks the break 'error' via error_message but never throws to the caller's +// HTTP path beyond what's handled here. +export async function fireScteBreak(channel, brk) { + const out = await callSidecar(channel, '/scte/trigger', 'POST', { + eventId: brk.event_id, + type: brk.type === 'immediate' ? 'splice_insert' : brk.type, + durationS: brk.duration_s, + }); + await pool.query( + `UPDATE playout_scte_breaks SET status = 'fired', fired_at = NOW(), updated_at = NOW() WHERE id = $1`, + [brk.id] + ); + // Stamp the compliance log. ended_at/duration are known up front for a + // fixed-duration break, so the row is written closed. + await pool.query( + `INSERT INTO playout_as_run + (channel_id, item_id, clip_name, started_at, ended_at, duration_s, result) + VALUES ($1, $2, $3, NOW(), + CASE WHEN $4 > 0 THEN NOW() + ($4 || ' seconds')::interval ELSE NULL END, + $4, 'scte')`, + [channel.id, brk.id, `SCTE-35 ${brk.type} (${brk.duration_s}s)`, brk.duration_s] + ); + return out; +} + +router.get('/channels/:id/scte', async (req, res, next) => { + try { + const { rows } = await pool.query( + `SELECT * FROM playout_scte_breaks WHERE channel_id = $1 ORDER BY created_at DESC LIMIT 200`, + [req.channel.id]); + res.json(rows); + } catch (err) { next(err); } +}); + +// Schedule a break. Body: { type, duration_s, playlist_pos?, scheduled_at? }. +// A pending break with a playlist_pos / scheduled_at is fired later by the +// scheduler; one with neither is fired immediately for convenience. +router.post('/channels/:id/scte', requireChannelEdit, async (req, res, next) => { + try { + const { type = 'splice_insert', duration_s = 30, + playlist_pos = null, scheduled_at = null } = req.body || {}; + if (!SCTE_TYPES.has(type)) { + return res.status(400).json({ error: `type must be one of: ${[...SCTE_TYPES].join(', ')}` }); + } + const dur = Math.max(0, parseInt(duration_s, 10) || 0); + // Auto-assign a monotonically increasing splice_event_id per channel. + const ev = await pool.query( + `SELECT COALESCE(MAX(event_id), 0) + 1 AS next FROM playout_scte_breaks WHERE channel_id = $1`, + [req.channel.id]); + const eventId = ev.rows[0].next; + const { rows } = await pool.query( + `INSERT INTO playout_scte_breaks + (channel_id, playlist_pos, scheduled_at, duration_s, event_id, type, created_by) + VALUES ($1,$2,$3,$4,$5,$6,$7) RETURNING *`, + [req.channel.id, playlist_pos, scheduled_at, dur, eventId, type, req.user?.id || null]); + res.status(201).json(rows[0]); + } catch (err) { next(err); } +}); + +// Fire an ad break immediately ("splice now"). Body: { type?, duration_s? }. +// Creates the break row and triggers the splice on the live output in one shot. +router.post('/channels/:id/scte/trigger', requireChannelEdit, async (req, res, next) => { + try { + if (req.channel.status !== 'running') { + return res.status(409).json({ error: 'Channel is not running' }); + } + const { type = 'immediate', duration_s = 30 } = req.body || {}; + if (!SCTE_TYPES.has(type)) { + return res.status(400).json({ error: `type must be one of: ${[...SCTE_TYPES].join(', ')}` }); + } + const dur = Math.max(0, parseInt(duration_s, 10) || 0); + const ev = await pool.query( + `SELECT COALESCE(MAX(event_id), 0) + 1 AS next FROM playout_scte_breaks WHERE channel_id = $1`, + [req.channel.id]); + const eventId = ev.rows[0].next; + const { rows } = await pool.query( + `INSERT INTO playout_scte_breaks (channel_id, duration_s, event_id, type, status, created_by) + VALUES ($1,$2,$3,$4,'pending',$5) RETURNING *`, + [req.channel.id, dur, eventId, type, req.user?.id || null]); + try { + const out = await fireScteBreak(req.channel, rows[0]); + const updated = await pool.query('SELECT * FROM playout_scte_breaks WHERE id = $1', [rows[0].id]); + res.json({ break: updated.rows[0], engine: out }); + } catch (err) { + await pool.query(`UPDATE playout_scte_breaks SET status = 'cancelled', updated_at = NOW() WHERE id = $1`, + [rows[0].id]).catch(() => {}); + return res.status(502).json({ error: 'Sidecar unreachable: ' + err.message }); + } + } catch (err) { next(err); } +}); + +router.delete('/channels/:id/scte/:scteId', requireChannelEdit, async (req, res, next) => { + try { + const { rows } = await pool.query( + `UPDATE playout_scte_breaks SET status = 'cancelled', updated_at = NOW() + WHERE id = $1 AND channel_id = $2 AND status = 'pending' RETURNING id`, + [req.params.scteId, req.channel.id]); + if (rows.length === 0) return res.status(404).json({ error: 'Pending break not found' }); + res.json({ cancelled: true }); + } catch (err) { next(err); } +}); + +async function loadChannelForBody(req, res, next) { + const channelId = req.body.channel_id || req.query.channel_id; + if (!channelId) return res.status(400).json({ error: 'channel_id is required' }); + try { + const { rows } = await pool.query('SELECT * FROM playout_channels WHERE id = $1', [channelId]); + if (rows.length === 0) return res.status(404).json({ error: 'Channel not found' }); + req.channel = rows[0]; + await assertProjectAccess(req.user, req.channel.project_id, 'edit'); + next(); + } catch (err) { next(err); } +} + +router.get('/playlists', async (req, res, next) => { + try { + const channelId = req.query.channel_id; + if (!channelId) return res.status(400).json({ error: 'channel_id is required' }); + const ch = await pool.query('SELECT project_id FROM playout_channels WHERE id = $1', [channelId]); + if (ch.rows.length === 0) return res.status(404).json({ error: 'Channel not found' }); + await assertProjectAccess(req.user, ch.rows[0].project_id, 'view'); + const { rows } = await pool.query( + 'SELECT * FROM playout_playlists WHERE channel_id = $1 ORDER BY created_at ASC', [channelId]); + res.json(rows); + } catch (err) { next(err); } +}); + +router.post('/playlists', loadChannelForBody, async (req, res, next) => { + try { + const { name, loop = false } = req.body || {}; + if (!name) return res.status(400).json({ error: 'name is required' }); + const { rows } = await pool.query( + 'INSERT INTO playout_playlists (channel_id, name, loop) VALUES ($1,$2,$3) RETURNING *', + [req.channel.id, name.trim(), !!loop]); + res.status(201).json(rows[0]); + } catch (err) { next(err); } +}); + +router.get('/playlists/:plid/items', validateUuid('plid'), async (req, res, next) => { + try { + const pl = await pool.query( + `SELECT p.*, c.project_id FROM playout_playlists p + JOIN playout_channels c ON c.id = p.channel_id WHERE p.id = $1`, [req.params.plid]); + if (pl.rows.length === 0) return res.status(404).json({ error: 'Playlist not found' }); + await assertProjectAccess(req.user, pl.rows[0].project_id, 'view'); + const { rows } = await pool.query( + `SELECT i.*, a.filename AS clip_name, a.duration_ms AS asset_duration_ms + FROM playout_items i JOIN assets a ON a.id = i.asset_id + WHERE i.playlist_id = $1 ORDER BY i.sort_order ASC`, [req.params.plid]); + res.json(rows); + } catch (err) { next(err); } +}); + +async function loadPlaylistEdit(plid, user) { + const pl = await pool.query( + `SELECT p.*, c.project_id FROM playout_playlists p + JOIN playout_channels c ON c.id = p.channel_id WHERE p.id = $1`, [plid]); + if (pl.rows.length === 0) { throw Object.assign(new Error('Playlist not found'), { httpStatus: 404 }); } + await assertProjectAccess(user, pl.rows[0].project_id, 'edit'); + return pl.rows[0]; +} + +router.post('/playlists/:plid/items', validateUuid('plid'), async (req, res, next) => { + try { + await loadPlaylistEdit(req.params.plid, req.user); + const { asset_id, in_point = null, out_point = null, + transition = 'cut', transition_ms = 0 } = req.body || {}; + if (!asset_id) return res.status(400).json({ error: 'asset_id is required' }); + + const ord = await pool.query( + 'SELECT COALESCE(MAX(sort_order), -1) + 1 AS next FROM playout_items WHERE playlist_id = $1', + [req.params.plid]); + const { rows } = await pool.query( + `INSERT INTO playout_items (playlist_id, asset_id, sort_order, in_point, out_point, transition, transition_ms) + VALUES ($1,$2,$3,$4,$5,$6,$7) RETURNING *`, + [req.params.plid, asset_id, ord.rows[0].next, in_point, out_point, transition, transition_ms]); + + await stageQueue.add('stage', { itemId: rows[0].id, assetId: asset_id }).catch((e) => + console.error('[playout] failed to enqueue stage job:', e.message)); + + res.status(201).json(rows[0]); + } catch (err) { + if (err.httpStatus) return res.status(err.httpStatus).json({ error: err.message }); + next(err); + } +}); + +router.put('/playlists/:plid/reorder', validateUuid('plid'), async (req, res, next) => { + const client = await pool.connect(); + try { + await loadPlaylistEdit(req.params.plid, req.user); + const { order } = req.body || {}; + if (!Array.isArray(order)) return res.status(400).json({ error: 'order must be an array of item ids' }); + await client.query('BEGIN'); + for (let i = 0; i < order.length; i++) { + await client.query( + 'UPDATE playout_items SET sort_order = $1, updated_at = NOW() WHERE id = $2 AND playlist_id = $3', + [i, order[i], req.params.plid]); + } + await client.query('COMMIT'); + res.json({ reordered: order.length }); + } catch (err) { + await client.query('ROLLBACK').catch(() => {}); + if (err.httpStatus) return res.status(err.httpStatus).json({ error: err.message }); + next(err); + } finally { client.release(); } +}); + +router.delete('/items/:itemId', validateUuid('itemId'), async (req, res, next) => { + try { + const it = await pool.query( + `SELECT i.id, c.project_id FROM playout_items i + JOIN playout_playlists p ON p.id = i.playlist_id + JOIN playout_channels c ON c.id = p.channel_id WHERE i.id = $1`, [req.params.itemId]); + if (it.rows.length === 0) return res.status(404).json({ error: 'Item not found' }); + await assertProjectAccess(req.user, it.rows[0].project_id, 'edit'); + await pool.query('DELETE FROM playout_items WHERE id = $1', [req.params.itemId]); + res.json({ deleted: true }); + } catch (err) { next(err); } +}); + +router.post('/items/:itemId/stage', validateUuid('itemId'), async (req, res, next) => { + try { + const it = await pool.query( + `SELECT i.id, i.asset_id, c.project_id FROM playout_items i + JOIN playout_playlists p ON p.id = i.playlist_id + JOIN playout_channels c ON c.id = p.channel_id WHERE i.id = $1`, [req.params.itemId]); + if (it.rows.length === 0) return res.status(404).json({ error: 'Item not found' }); + await assertProjectAccess(req.user, it.rows[0].project_id, 'edit'); + await pool.query("UPDATE playout_items SET media_status = 'pending' WHERE id = $1", [req.params.itemId]); + await stageQueue.add('stage', { itemId: it.rows[0].id, assetId: it.rows[0].asset_id }); + res.json({ queued: true }); + } catch (err) { next(err); } +}); + +export async function restartChannel(channelId) { + const { rows } = await pool.query('SELECT * FROM playout_channels WHERE id = $1', [channelId]); + if (rows.length === 0) return { restarted: false, reason: 'channel not found' }; + const channel = rows[0]; + + if (channel.output_type === 'decklink') { + return { restarted: false, reason: 'decklink channels are alert-only' }; + } + + if (channel.container_id) { + const { remote, apiUrl } = await resolveNodeTarget(channel.node_id); + if (remote && apiUrl) { + await fetch(`${apiUrl}/sidecar/stop`, { + method: 'POST', headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ containerId: channel.container_id }), + signal: AbortSignal.timeout(10000), + }).catch(() => {}); + } else { + await dockerApi('DELETE', `/containers/${channel.container_id}?force=true`).catch(() => {}); + } + } + + const nodes = await pool.query( + `SELECT id, hostname, api_url, last_seen_at FROM cluster_nodes + WHERE id <> $1 AND last_seen_at > NOW() - INTERVAL '60 seconds' + ORDER BY last_seen_at DESC LIMIT 1`, + [channel.node_id] + ); + if (nodes.rows.length === 0) { + await pool.query( + "UPDATE playout_channels SET status = 'error', error_message = $1 WHERE id = $2", + ['no healthy node available for failover', channel.id] + ); + return { restarted: false, reason: 'no eligible node' }; + } + const newNodeId = nodes.rows[0].id; + + const { rows: moved } = await pool.query( + `UPDATE playout_channels + SET node_id = $1, status = 'stopped', container_id = NULL, container_meta = '{}'::jsonb, + restart_count = restart_count + 1, last_restart_at = NOW(), + error_message = NULL, updated_at = NOW() + WHERE id = $2 RETURNING *`, + [newNodeId, channel.id] + ); + + try { + await spawnChannelSidecar(moved[0]); + return { restarted: true, new_node_id: newNodeId }; + } catch (err) { + return { restarted: false, reason: `respawn failed: ${err.message}` }; + } +} + +export default router; diff --git a/services/mam-api/src/routes/projects.js b/services/mam-api/src/routes/projects.js index 3524ab0..2e0529e 100644 --- a/services/mam-api/src/routes/projects.js +++ b/services/mam-api/src/routes/projects.js @@ -1,6 +1,8 @@ import express from 'express'; import pool from '../db/pool.js'; import { validateUuid } from '../middleware/errors.js'; +import { requireAdmin } from '../middleware/auth.js'; +import { accessibleProjectIds, assertProjectAccess } from '../auth/authz.js'; import { v4 as uuidv4 } from 'uuid'; const router = express.Router(); @@ -16,18 +18,29 @@ const slugify = (str) => { .replace(/-+/g, '-'); }; -// GET / - List all projects +// GET / - List projects the caller can access (admins see all). router.get('/', async (req, res, next) => { try { - const result = await pool.query('SELECT * FROM projects ORDER BY created_at DESC'); + const access = await accessibleProjectIds(req.user); + if (access.all) { + const result = await pool.query('SELECT * FROM projects ORDER BY created_at DESC'); + return res.json(result.rows); + } + if (access.ids.size === 0) return res.json([]); + const ids = [...access.ids]; + const result = await pool.query( + `SELECT * FROM projects WHERE id = ANY($1::uuid[]) ORDER BY created_at DESC`, + [ids] + ); res.json(result.rows); } catch (err) { next(err); } }); -// POST / - Create project -router.post('/', async (req, res, next) => { +// POST / - Create project (admin only; new projects have no grants, so a +// scoped user could never reach one they just made). +router.post('/', requireAdmin, async (req, res, next) => { try { const { name, description } = req.body; @@ -51,10 +64,11 @@ router.post('/', async (req, res, next) => { } }); -// GET /:id - Single project with asset count +// GET /:id - Single project with asset count (requires view access). router.get('/:id', async (req, res, next) => { try { const { id } = req.params; + await assertProjectAccess(req.user, id, 'view'); const result = await pool.query( `SELECT p.*, @@ -76,10 +90,11 @@ router.get('/:id', async (req, res, next) => { } }); -// PATCH /:id - Update project +// PATCH /:id - Update project (requires edit access). router.patch('/:id', async (req, res, next) => { try { const { id } = req.params; + await assertProjectAccess(req.user, id, 'edit'); const { name, description } = req.body; const updates = []; @@ -122,8 +137,9 @@ router.patch('/:id', async (req, res, next) => { } }); -// DELETE /:id - Delete project and cascade -router.delete('/:id', async (req, res, next) => { +// DELETE /:id - Delete project and cascade (admin only — destructive, wipes +// every asset/bin/recorder under it). +router.delete('/:id', requireAdmin, async (req, res, next) => { try { const { id } = req.params; @@ -143,4 +159,78 @@ router.delete('/:id', async (req, res, next) => { } }); +// ── Per-project access grants (admin only) ────────────────────────────────── +// GET /:id/access — list grants with resolved user/group display names. +router.get('/:id/access', requireAdmin, async (req, res, next) => { + try { + const { rows } = await pool.query( + `SELECT pa.subject_type, pa.subject_id, pa.level, pa.granted_at, + CASE pa.subject_type + WHEN 'user' THEN u.display_name + WHEN 'group' THEN g.name + END AS subject_name, + CASE pa.subject_type + WHEN 'user' THEN u.username + ELSE NULL + END AS username + FROM project_access pa + LEFT JOIN users u ON pa.subject_type = 'user' AND u.id = pa.subject_id + LEFT JOIN groups g ON pa.subject_type = 'group' AND g.id = pa.subject_id + WHERE pa.project_id = $1 + ORDER BY pa.subject_type, subject_name`, + [req.params.id] + ); + res.json(rows); + } catch (err) { next(err); } +}); + +// POST /:id/access { subject_type, subject_id, level } — grant or update. +router.post('/:id/access', requireAdmin, async (req, res, next) => { + try { + const { subject_type, subject_id, level } = req.body || {}; + if (!['user', 'group'].includes(subject_type)) { + return res.status(400).json({ error: "subject_type must be 'user' or 'group'" }); + } + if (!subject_id) return res.status(400).json({ error: 'subject_id required' }); + const lvl = level || 'view'; + if (!['view', 'edit'].includes(lvl)) { + return res.status(400).json({ error: "level must be 'view' or 'edit'" }); + } + + // Validate the subject actually exists so we don't create dead grants. + const tbl = subject_type === 'user' ? 'users' : 'groups'; + const exists = await pool.query(`SELECT 1 FROM ${tbl} WHERE id = $1`, [subject_id]); + if (exists.rows.length === 0) { + return res.status(404).json({ error: subject_type + ' not found' }); + } + + const { rows } = await pool.query( + `INSERT INTO project_access (project_id, subject_type, subject_id, level, granted_by) + VALUES ($1, $2, $3, $4, $5) + ON CONFLICT (project_id, subject_type, subject_id) + DO UPDATE SET level = EXCLUDED.level, granted_by = EXCLUDED.granted_by, granted_at = NOW() + RETURNING project_id, subject_type, subject_id, level, granted_at`, + [req.params.id, subject_type, subject_id, lvl, req.user?.id || null] + ); + res.status(201).json(rows[0]); + } catch (err) { next(err); } +}); + +// DELETE /:id/access/:subjectType/:subjectId — revoke a grant. +router.delete('/:id/access/:subjectType/:subjectId', requireAdmin, async (req, res, next) => { + try { + const { id, subjectType, subjectId } = req.params; + if (!['user', 'group'].includes(subjectType)) { + return res.status(400).json({ error: "subjectType must be 'user' or 'group'" }); + } + const { rowCount } = await pool.query( + `DELETE FROM project_access + WHERE project_id = $1 AND subject_type = $2 AND subject_id = $3`, + [id, subjectType, subjectId] + ); + if (rowCount === 0) return res.status(404).json({ error: 'grant not found' }); + res.status(204).end(); + } catch (err) { next(err); } +}); + export default router; diff --git a/services/mam-api/src/routes/recorders.js b/services/mam-api/src/routes/recorders.js index 316d39e..a6bb778 100644 --- a/services/mam-api/src/routes/recorders.js +++ b/services/mam-api/src/routes/recorders.js @@ -6,10 +6,34 @@ import dgram from 'dgram'; import pool from '../db/pool.js'; import { getS3Bucket } from '../s3/client.js'; import { validateUuid } from '../middleware/errors.js'; +import { assertProjectAccess, accessibleProjectIds } from '../auth/authz.js'; import { v4 as uuidv4 } from 'uuid'; const router = express.Router(); -router.param('id', (req, res, next) => validateUuid('id')(req, res, next)); + +// Every /:id recorder route is scoped to the recorder's project. The param +// handler validates the UUID, resolves the owning project_id, and asserts the +// 'view' baseline; mutating routes escalate to 'edit' via requireRecorderEdit. +// A recorder with a NULL project_id resolves to admin-only (assertProjectAccess +// throws 403 for non-admins on a null project). +router.param('id', async (req, res, next) => { + validateUuid('id')(req, res, () => {}); + if (res.headersSent) return; + try { + const { rows } = await pool.query('SELECT project_id FROM recorders WHERE id = $1', [req.params.id]); + if (rows.length === 0) return res.status(404).json({ error: 'Recorder not found' }); + req.recorderProjectId = rows[0].project_id; + await assertProjectAccess(req.user, req.recorderProjectId, 'view'); + next(); + } catch (err) { next(err); } +}); + +async function requireRecorderEdit(req, res, next) { + try { + await assertProjectAccess(req.user, req.recorderProjectId, 'edit'); + next(); + } catch (err) { next(err); } +} // Base port for on-demand SDI sidecar containers on remote worker nodes. // Device index 0 → 7438, index 1 → 7439, etc. @@ -130,6 +154,7 @@ const RECORDER_FIELDS = [ 'proxy_audio_codec', 'proxy_audio_bitrate', 'proxy_audio_channels', 'proxy_container', 'project_id', 'node_id', 'device_index', + 'growing_enabled', ]; function pickRecorderFields(body) { @@ -140,6 +165,94 @@ function pickRecorderFields(body) { return out; } +// Codecs that require an NVIDIA GPU on the target node. +const GPU_CODECS = ['hevc_nvenc', 'h264_nvenc']; + +// Issue #163 — codec/container/audio compatibility guard. Returns null when the +// config is valid, otherwise a descriptive error string naming the bad combo. +// `nodeHasGpu` is tri-state: true (GPU present), false (no GPU), or null +// (unknown — node not resolvable at this point, so GPU is only a soft check). +// +// Rules: +// - PCM audio is only valid in MOV/MXF containers, never MP4 (an MP4 with a +// PCM track produces a corrupt/unplayable master — also part of #162). +// - HEVC is not valid in MXF in this build. +// - NVENC codecs require the target node to have a GPU. +function validateRecorderConfig(cfg, nodeHasGpu = null) { + if (!cfg) return null; + + const container = String(cfg.recording_container || '').toLowerCase(); + const codec = String(cfg.recording_codec || '').toLowerCase(); + const audio = String(cfg.recording_audio_codec || '').toLowerCase(); + + // PCM audio + MP4 → reject. + if (container === 'mp4' && audio.startsWith('pcm')) { + return `Invalid combo: PCM audio (${cfg.recording_audio_codec}) is not supported in an MP4 container. Use a MOV or MXF container, or switch the audio codec to AAC.`; + } + + // HEVC in MXF → reject. + if (container === 'mxf' && (codec === 'hevc' || codec === 'hevc_nvenc')) { + return `Invalid combo: HEVC (${cfg.recording_codec}) is not supported in an MXF container in this build. Use a MOV/MP4 container, or pick a DNxHR/ProRes codec for MXF.`; + } + + // NVENC requires a GPU on the target node. Only a hard error when we know the + // node lacks one; unknown capability is left as a soft pass. + if (GPU_CODECS.includes(codec) && nodeHasGpu === false) { + return `Invalid combo: codec ${cfg.recording_codec} requires an NVIDIA GPU, but the target node reports no GPU. Choose a software codec (e.g. prores_hq, dnxhr_hq, h264) or assign a GPU node.`; + } + + return null; +} + +// Resolve whether a recorder's target node has a GPU. Returns true/false when +// the node's heartbeat capability is known, or null when it can't be resolved +// (no node assigned / no capability reported) — callers treat null as a soft +// check per validateRecorderConfig. +async function nodeHasGpuCapability(nodeId) { + if (!nodeId) return null; + try { + const r = await pool.query( + 'SELECT capabilities FROM cluster_nodes WHERE id = $1', + [nodeId] + ); + if (r.rows.length === 0) return null; + const caps = r.rows[0].capabilities; + const gpus = caps && caps.gpus; + if (!Array.isArray(gpus)) return null; + return gpus.length > 0; + } catch (_) { + return null; + } +} + +const sleep = (ms) => new Promise(r => setTimeout(r, ms)); + +// Issue #162 — after a local-spawn stop, wait for the capture container to +// finalize its master. The asset row was pre-created at start with +// status='live' (display_name = current_session_id); the ingest/finalize step +// flips it to ready/processing once the MOV/MP4 trailer is written. We poll +// until the asset leaves 'live' (or disappears) or we hit the timeout, so we +// don't DELETE the container — and SIGKILL ffmpeg — before the trailer lands. +async function waitForFinalize(recorder, { timeoutMs = 180000, intervalMs = 3000 } = {}) { + if (!recorder.current_session_id) return; + const deadline = Date.now() + timeoutMs; + while (Date.now() < deadline) { + try { + const r = await pool.query( + `SELECT 1 FROM assets + WHERE project_id = $1 + AND display_name = $2 + AND status = 'live' + LIMIT 1`, + [recorder.project_id, recorder.current_session_id] + ); + // No live asset row left → finalize is done (or there was none to wait on). + if (r.rows.length === 0) return; + } catch (_) { /* transient DB error — keep polling until timeout */ } + await sleep(intervalMs); + } +} + // GET / - List all recorders // // Issue #121 — previous version fired N PG queries + N Docker inspects per @@ -149,6 +262,17 @@ function pickRecorderFields(body) { // parallel with a per-call timeout from `dockerApi`. router.get('/', async (req, res, next) => { try { + // Scope to recorders in projects the caller can access (admins unfiltered). + // Recorders with a NULL project are admin-only and never appear for scoped + // users (accessibleProjectIds never yields a null id). + const access = await accessibleProjectIds(req.user); + let scopeClause = ''; + const params = []; + if (!access.all) { + if (access.ids.size === 0) return res.json([]); + scopeClause = 'WHERE r.project_id = ANY($1::uuid[])'; + params.push([...access.ids]); + } const result = await pool.query(` SELECT r.*, la.live_asset_id FROM recorders r @@ -162,8 +286,9 @@ router.get('/', async (req, res, next) => { ORDER BY a.created_at DESC LIMIT 1 ) la ON TRUE + ${scopeClause} ORDER BY r.created_at DESC - `); + `, params); const rows = result.rows; // Only inspect containers for recorders that actually claim to be recording. @@ -194,6 +319,11 @@ router.post('/', async (req, res, next) => { .json({ error: 'Name and source_type are required' }); } + // Creating a recorder writes into a project — require edit there. A recorder + // with no project_id is admin-only (assertProjectAccess denies non-admins on + // a null project). + await assertProjectAccess(req.user, fields.project_id ?? null, 'edit'); + // Defaults — written on insert so the DB row is always self-contained. const defaults = { source_config: {}, @@ -213,6 +343,13 @@ router.post('/', async (req, res, next) => { }; const row = { id: uuidv4(), status: 'stopped', ...defaults, ...fields }; + // Issue #163 — reject invalid codec/container/audio combos before insert. + const createGpu = await nodeHasGpuCapability(row.node_id); + const createErr = validateRecorderConfig(row, createGpu); + if (createErr) { + return res.status(400).json({ error: createErr }); + } + // Build INSERT dynamically so adding columns later means one place to update. const cols = Object.keys(row); const placeholders = cols.map((_, i) => `$${i + 1}`).join(', '); @@ -256,7 +393,7 @@ router.get('/:id', async (req, res, next) => { // PATCH /:id - Edit recorder settings // Blocked while recorder is actively recording to prevent config drift. -router.patch('/:id', async (req, res, next) => { +router.patch('/:id', requireRecorderEdit, async (req, res, next) => { try { const { id } = req.params; @@ -279,6 +416,15 @@ router.patch('/:id', async (req, res, next) => { return res.status(400).json({ error: 'No fields to update' }); } + // Issue #163 — validate the resulting config (existing row overlaid with the + // incoming changes) so a PATCH can't introduce an invalid combo either. + const merged = { ...recorder, ...fields }; + const patchGpu = await nodeHasGpuCapability(merged.node_id); + const patchErr = validateRecorderConfig(merged, patchGpu); + if (patchErr) { + return res.status(400).json({ error: patchErr }); + } + const setClause = cols.map((k, i) => `${k} = $${i + 1}`).join(', '); const params = cols.map(k => fields[k]); params.push(id); @@ -295,7 +441,7 @@ router.patch('/:id', async (req, res, next) => { }); // POST /:id/start - Start recording -router.post('/:id/start', async (req, res, next) => { +router.post('/:id/start', requireRecorderEdit, async (req, res, next) => { try { const { id } = req.params; @@ -322,14 +468,25 @@ router.post('/:id/start', async (req, res, next) => { const externalMamApiUrl = `http://${process.env.NODE_IP || '172.18.91.200'}:${process.env.PORT_MAM_API || 47432}`; const dockerNetwork = process.env.DOCKER_NETWORK || 'wild-dragon_wild-dragon'; - // Growing-files mode is a global setting (settings table). When on, the - // capture container writes the master to its /growing/ mount instead of - // streaming it to S3 — Premiere can mount the SMB share and edit it live. - const growingRow = await pool.query( - `SELECT value FROM settings WHERE key = 'growing_enabled'` - ); - const growingEnabled = - growingRow.rows[0]?.value === 'true' || growingRow.rows[0]?.value === true; + // Growing-files mode is a PER-RECORDER setting (recorders.growing_enabled). + // When on, the capture container writes the master to its /growing/ mount + // instead of streaming it to S3 — editors can mount the SMB share and cut it + // live. The SMB share itself (mount source + credentials) is shared + // infrastructure configured globally in Settings → Storage. + const growingEnabled = recorder.growing_enabled === true; + + // Shared growing-files SMB infrastructure (global settings). Used to mount + // the CIFS share inside the capture container (services/capture mounts it + // with these credentials when GROWING_SMB_MOUNT is set). + const growingInfra = {}; + { + const r = await pool.query( + `SELECT key, value FROM settings WHERE key = ANY($1)`, + [['growing_smb_mount', 'growing_smb_username', 'growing_smb_password', 'growing_smb_vers']] + ); + for (const { key, value } of r.rows) growingInfra[key] = value; + } + const smbMount = growingEnabled ? (growingInfra.growing_smb_mount || '') : ''; // Operator-supplied clip name wins over the auto-timestamped fallback. // The Recorders UI passes this on the start request when the user types @@ -345,6 +502,14 @@ router.post('/:id/start', async (req, res, next) => { ? req.body.projectId : recorder.project_id; + // requireRecorderEdit only covered the recorder's own project. If this take + // is being routed into a DIFFERENT project, the caller must have edit there + // too — otherwise edit on recorder A's project would let them write live + // assets into any project B. + if (takeProjectId !== recorder.project_id) { + await assertProjectAccess(req.user, takeProjectId, 'edit'); + } + // live-asset: create the asset row right now (status='live') so the // library shows the recording while it is happening. const assetIdLive = uuidv4(); @@ -406,6 +571,13 @@ router.post('/:id/start', async (req, res, next) => { `MAM_API_TOKEN=${process.env.CAPTURE_TOKEN || ''}`, `GROWING_ENABLED=${growingEnabled ? 'true' : 'false'}`, `GROWING_PATH=/growing`, + // SMB mount details for the in-container CIFS mount (Approach A). Empty + // GROWING_SMB_MOUNT → capture falls back to the host-bound /growing volume + // (or to S3 streaming if growing isn't enabled). + `GROWING_SMB_MOUNT=${smbMount}`, + `GROWING_SMB_USERNAME=${growingInfra.growing_smb_username || ''}`, + `GROWING_SMB_PASSWORD=${growingInfra.growing_smb_password || ''}`, + `GROWING_SMB_VERS=${growingInfra.growing_smb_vers || '3.0'}`, ]; // Deltacast: pass port count so the capture container can enumerate @@ -428,11 +600,15 @@ router.post('/:id/start', async (req, res, next) => { } // GPU-accelerated codecs require the NVIDIA container runtime on the node. - // hevc_nvenc / h264_nvenc are the only two we currently support; extend - // this list if av1_nvenc or others are added later. - const GPU_CODECS = ['hevc_nvenc', 'h264_nvenc']; + // hevc_nvenc / h264_nvenc are the only two we currently support (see the + // module-level GPU_CODECS list); extend it if av1_nvenc or others are added. const useGpu = GPU_CODECS.includes(recorder.recording_codec); + // Issue #167 — per-recorder GPU affinity. When recorders.gpu_uuid is set the + // sidecar is pinned to that single device (NVIDIA_VISIBLE_DEVICES=); + // null keeps the legacy "all" behavior. Only meaningful when useGpu is true. + const gpuUuid = recorder.gpu_uuid || null; + // Determine whether to spawn locally or via a remote node-agent. const { remote: isRemote, apiUrl: targetNodeApiUrl } = await resolveNodeTarget(recorder.node_id); // For remote sidecars, the capture container runs on the worker host network and cannot @@ -450,7 +626,7 @@ router.post('/:id/start', async (req, res, next) => { const sidecarRes = await fetch(`${targetNodeApiUrl}/sidecar/start`, { method: 'POST', headers: { 'Content-Type': 'application/json' }, - body: JSON.stringify({ image: 'wild-dragon-capture:latest', env, capturePort, sourceType, useGpu }), + body: JSON.stringify({ image: 'wild-dragon-capture:latest', env, capturePort, sourceType, useGpu, gpuUuid }), signal: AbortSignal.timeout(15000), }); if (!sidecarRes.ok) { @@ -481,11 +657,20 @@ router.post('/:id/start', async (req, res, next) => { for (const d of dcEntries) hostBinds.push(`/dev/${d}:/dev/${d}`); } catch (_) { /* no /dev/deltacast* nodes on this host */ } } - if (growingEnabled) hostBinds.push('/mnt/NVME/MAM/wild-dragon-growing:/growing'); + // /growing handling: + // - SMB mount configured → DON'T host-bind; the capture container mounts + // the CIFS share at /growing itself (Approach A). A bind-mount here + // would shadow the in-container mount. + // - growing on but no SMB mount → legacy host bind-mount fallback. + // - growing off → no /growing mount at all. + if (growingEnabled && !smbMount) { + hostBinds.push('/mnt/NVME/MAM/wild-dragon-growing:/growing'); + } const localEnv = [...env]; if (useGpu) { - localEnv.push('NVIDIA_VISIBLE_DEVICES=all'); + // Issue #167 — same per-recorder GPU affinity as the remote sidecar path. + localEnv.push(`NVIDIA_VISIBLE_DEVICES=${gpuUuid || 'all'}`); localEnv.push('NVIDIA_DRIVER_CAPABILITIES=video,compute,utility'); } @@ -551,7 +736,7 @@ router.post('/:id/start', async (req, res, next) => { }); // POST /:id/stop - Stop recording -router.post('/:id/stop', async (req, res, next) => { +router.post('/:id/stop', requireRecorderEdit, async (req, res, next) => { try { const { id } = req.params; @@ -587,9 +772,13 @@ router.post('/:id/stop', async (req, res, next) => { return res.status(502).json({ error: 'Remote node failed to stop sidecar' }); } } else { + // Issue #162 — stop WITH a grace period (t=180). Docker sends SIGTERM and + // waits up to 180s for ffmpeg to flush and write the MOV/MP4 trailer before + // it SIGKILLs. Without this the master is truncated/corrupt and the + // pre-created asset can get stuck in 'live'. const stopRes = await dockerApi( 'POST', - `/containers/${recorder.container_id}/stop` + `/containers/${recorder.container_id}/stop?t=180` ); // 204 = stopped, 304 = already stopped, 404 = container gone — all acceptable. @@ -602,6 +791,12 @@ router.post('/:id/stop', async (req, res, next) => { // Only attempt remove if the container existed (not 404). if (stopRes.status !== 404) { + // Issue #162 — before removing the container, wait for the master to + // finalize (asset leaves 'live'), mirroring the remote path's reliance on + // the node-agent's clean teardown. This guards against deleting the + // container — and its lingering finalize work — too early. + await waitForFinalize(recorder); + const removeRes = await dockerApi( 'DELETE', `/containers/${recorder.container_id}` @@ -722,7 +917,7 @@ router.get('/:id/status', async (req, res, next) => { }); // DELETE /:id - Delete recorder -router.delete('/:id', async (req, res, next) => { +router.delete('/:id', requireRecorderEdit, async (req, res, next) => { try { const { id } = req.params; diff --git a/services/mam-api/src/routes/sequences.js b/services/mam-api/src/routes/sequences.js index b7dd20c..76041a5 100644 --- a/services/mam-api/src/routes/sequences.js +++ b/services/mam-api/src/routes/sequences.js @@ -3,6 +3,7 @@ import express from 'express'; import pool from '../db/pool.js'; import { getSignedUrlForObject } from '../s3/client.js'; import { validateUuid } from '../middleware/errors.js'; +import { assertProjectAccess } from '../auth/authz.js'; import { Queue } from 'bullmq'; const parseRedisUrl = (url) => { @@ -19,7 +20,27 @@ const conformQueue = new Queue('conform', { }); const router = express.Router(); -router.param('id', (req, res, next) => validateUuid('id')(req, res, next)); + +// Scope every /:id sequence route to its project: validate the UUID, resolve +// project_id, assert the 'view' baseline; mutators escalate via requireSequenceEdit. +router.param('id', async (req, res, next) => { + validateUuid('id')(req, res, () => {}); + if (res.headersSent) return; + try { + const { rows } = await pool.query('SELECT project_id FROM sequences WHERE id = $1', [req.params.id]); + if (rows.length === 0) return res.status(404).json({ error: 'Sequence not found' }); + req.sequenceProjectId = rows[0].project_id; + await assertProjectAccess(req.user, req.sequenceProjectId, 'view'); + next(); + } catch (err) { next(err); } +}); + +async function requireSequenceEdit(req, res, next) { + try { + await assertProjectAccess(req.user, req.sequenceProjectId, 'edit'); + next(); + } catch (err) { next(err); } +} // ── Row mapper ──────────────────────────────────────────────────────────────── // node-postgres returns NUMERIC columns as strings. Coerce frame_rate to a @@ -124,6 +145,7 @@ router.get('/', async (req, res, next) => { try { const { project_id } = req.query; if (!project_id) return res.status(400).json({ error: 'project_id is required' }); + await assertProjectAccess(req.user, project_id, 'view'); const r = await pool.query( `SELECT * FROM sequences WHERE project_id = $1 ORDER BY updated_at DESC`, [project_id] @@ -143,6 +165,7 @@ router.post('/', async (req, res, next) => { height = 1080, } = req.body; if (!project_id) return res.status(400).json({ error: 'project_id is required' }); + await assertProjectAccess(req.user, project_id, 'edit'); const r = await pool.query( `INSERT INTO sequences (project_id, name, frame_rate, width, height) VALUES ($1, $2, $3, $4, $5) RETURNING *`, @@ -188,7 +211,7 @@ router.get('/:id', async (req, res, next) => { }); // ── PUT /:id – update sequence metadata ────────────────────────────────────── -router.put('/:id', async (req, res, next) => { +router.put('/:id', requireSequenceEdit, async (req, res, next) => { try { const { name, frame_rate, width, height } = req.body; const updates = []; @@ -211,7 +234,7 @@ router.put('/:id', async (req, res, next) => { }); // ── DELETE /:id ─────────────────────────────────────────────────────────────── -router.delete('/:id', async (req, res, next) => { +router.delete('/:id', requireSequenceEdit, async (req, res, next) => { try { const r = await pool.query(`DELETE FROM sequences WHERE id = $1`, [req.params.id]); if (!r.rowCount) return res.status(404).json({ error: 'Sequence not found' }); @@ -220,25 +243,41 @@ router.delete('/:id', async (req, res, next) => { }); // ── PUT /:id/clips – full replace of clip array (single transaction) ────────── -router.put('/:id/clips', async (req, res, next) => { - // Verify sequence exists first (before acquiring transaction client) - const seqCheck = await pool.query(`SELECT id FROM sequences WHERE id = $1`, [req.params.id]); - if (!seqCheck.rows.length) return res.status(404).json({ error: 'Sequence not found' }); - +router.put('/:id/clips', requireSequenceEdit, async (req, res, next) => { const clips = Array.isArray(req.body) ? req.body : []; - for (const c of clips) { - if (!c.asset_id) return res.status(400).json({ error: 'Each clip must have asset_id' }); - if (!Number.isFinite(Number(c.timeline_in_frames)) || !Number.isFinite(Number(c.timeline_out_frames)) || - !Number.isFinite(Number(c.source_in_frames)) || !Number.isFinite(Number(c.source_out_frames))) { - return res.status(400).json({ error: 'Clip frame fields must be finite numbers' }); - } - if (!Number.isInteger(Number(c.track)) || Number(c.track) < 0) { - return res.status(400).json({ error: 'Clip track must be a non-negative integer' }); - } - } - - const client = await pool.connect(); + let client; try { + // Verify sequence exists first (before acquiring transaction client). + const seqCheck = await pool.query(`SELECT id FROM sequences WHERE id = $1`, [req.params.id]); + if (!seqCheck.rows.length) return res.status(404).json({ error: 'Sequence not found' }); + + for (const c of clips) { + if (!c.asset_id) return res.status(400).json({ error: 'Each clip must have asset_id' }); + if (!Number.isFinite(Number(c.timeline_in_frames)) || !Number.isFinite(Number(c.timeline_out_frames)) || + !Number.isFinite(Number(c.source_in_frames)) || !Number.isFinite(Number(c.source_out_frames))) { + return res.status(400).json({ error: 'Clip frame fields must be finite numbers' }); + } + if (!Number.isInteger(Number(c.track)) || Number(c.track) < 0) { + return res.status(400).json({ error: 'Clip track must be a non-negative integer' }); + } + } + + // Every referenced asset must belong to THIS sequence's project. Without this, + // a user with edit on the sequence could splice in assets from a project they + // can't access — and GET /:id would then hand back those assets' names and + // signed proxy URLs (cross-project leak). + const assetIds = [...new Set(clips.map(c => c.asset_id))]; + if (assetIds.length) { + const owning = await pool.query( + `SELECT id FROM assets WHERE id = ANY($1::uuid[]) AND project_id = $2`, + [assetIds, req.sequenceProjectId] + ); + if (owning.rows.length !== assetIds.length) { + return res.status(400).json({ error: 'All clip assets must belong to the sequence\'s project' }); + } + } + + client = await pool.connect(); await client.query('BEGIN'); await client.query( `DELETE FROM sequence_clips WHERE sequence_id = $1`, @@ -265,10 +304,12 @@ router.put('/:id/clips', async (req, res, next) => { await client.query('COMMIT'); res.json({ ok: true, count: clips.length }); } catch (e) { - await client.query('ROLLBACK'); + // client is only set once we've connected; a failure in the pre-transaction + // queries (existence/validation/ownership) has no transaction to roll back. + if (client) await client.query('ROLLBACK').catch(() => {}); next(e); } finally { - client.release(); + if (client) client.release(); } }); @@ -300,7 +341,7 @@ router.post('/:id/export/edl', async (req, res, next) => { // ── POST /:id/conform – conform sequence via FCP XML ───────────────────────── // Accepts FCP XML content and encode settings from the Premiere plugin, // queues a conform job in BullMQ, and returns the job ID for polling. -router.post('/:id/conform', async (req, res, next) => { +router.post('/:id/conform', requireSequenceEdit, async (req, res, next) => { try { const seqR = await pool.query(`SELECT * FROM sequences WHERE id = $1`, [req.params.id]); if (!seqR.rows.length) return res.status(404).json({ error: 'Sequence not found' }); diff --git a/services/mam-api/src/routes/settings.js b/services/mam-api/src/routes/settings.js index f7cefdc..82fbe17 100644 --- a/services/mam-api/src/routes/settings.js +++ b/services/mam-api/src/routes/settings.js @@ -258,21 +258,45 @@ router.put('/transcoding', async (req, res, next) => { // while it's still being written; the promotion worker later moves the // finalized file to S3 and flips the asset to status='ready'. -const GROWING_KEYS = ['growing_enabled', 'growing_path', 'growing_smb_url', 'growing_promote_after_seconds']; +// Growing-files mode is now a PER-RECORDER setting (recorders.growing_enabled); +// the legacy global `growing_enabled` key is no longer read at recorder start. +// These global keys describe the shared SMB landing-zone infrastructure only: +// - growing_path container mount point (default /growing) +// - growing_smb_url smb://... display string for editors (Premiere) +// - growing_smb_mount //host/share CIFS source the capture container mounts +// - growing_smb_username SMB user for the system-side CIFS mount +// - growing_smb_password SMB password (WRITE-ONLY; never returned) +// - growing_smb_vers CIFS protocol version (default 3.0) +// - growing_promote_after_seconds idle threshold before S3 promotion +const GROWING_KEYS = [ + 'growing_path', 'growing_smb_url', 'growing_smb_mount', + 'growing_smb_username', 'growing_smb_vers', 'growing_promote_after_seconds', +]; +// growing_smb_password is handled separately: stored on PUT but NEVER returned +// on GET (only a *_exists flag), mirroring s3_secret_key. router.get('/growing', async (req, res, next) => { try { const result = await pool.query( `SELECT key, value FROM settings WHERE key = ANY($1)`, - [GROWING_KEYS] + [[...GROWING_KEYS, 'growing_smb_password']] ); const out = { - growing_enabled: 'false', growing_path: '/growing', growing_smb_url: '', + growing_smb_mount: '', + growing_smb_username: '', + growing_smb_vers: '3.0', growing_promote_after_seconds: '8', + growing_smb_password_exists: false, }; - for (const { key, value } of result.rows) out[key] = value; + for (const { key, value } of result.rows) { + if (key === 'growing_smb_password') { + out.growing_smb_password_exists = !!(value && value.length); + } else { + out[key] = value; + } + } res.json(out); } catch (err) { next(err); @@ -290,6 +314,19 @@ router.put('/growing', async (req, res, next) => { ); } } + // SMB password is write-only. A non-empty value sets/replaces it. To remove + // it, send growing_smb_password_clear:true. A blank/omitted password field + // leaves the stored value untouched (so operators don't retype it on every + // save). + if (req.body.growing_smb_password_clear === true) { + await pool.query(`DELETE FROM settings WHERE key = 'growing_smb_password'`); + } else if (typeof req.body.growing_smb_password === 'string' && req.body.growing_smb_password.length > 0) { + await pool.query( + `INSERT INTO settings (key, value, updated_at) VALUES ('growing_smb_password', $1, NOW()) + ON CONFLICT (key) DO UPDATE SET value = $1, updated_at = NOW()`, + [req.body.growing_smb_password] + ); + } res.json({ message: 'Growing-files settings saved' }); } catch (err) { next(err); diff --git a/services/mam-api/src/routes/storage.js b/services/mam-api/src/routes/storage.js index 9d767a8..493d87b 100644 --- a/services/mam-api/src/routes/storage.js +++ b/services/mam-api/src/routes/storage.js @@ -14,10 +14,12 @@ const exec = promisify(execCb); const router = express.Router(); // Defaults mirrored from settings.js so the overview never returns nulls. +// Growing-file mode is now per-recorder; "enabled" here means the shared SMB +// landing zone is CONFIGURED (a mount source is set), not a global on/off. const GROWING_DEFAULTS = { - growing_enabled: 'false', growing_path: '/growing', growing_smb_url: '', + growing_smb_mount: '', growing_promote_after_seconds: '8', }; @@ -100,7 +102,9 @@ router.get('/overview', async (req, res, next) => { try { // Growing files — merge defaults with whatever's in `settings`. const growingRaw = { ...GROWING_DEFAULTS, ...(await readSettings(Object.keys(GROWING_DEFAULTS))) }; - const growingEnabled = growingRaw.growing_enabled === 'true' || growingRaw.growing_enabled === true; + // "enabled" now means the shared SMB landing zone is configured (a mount + // source is set). Per-recorder toggles decide which recorders actually use it. + const growingEnabled = !!(growingRaw.growing_smb_mount && growingRaw.growing_smb_mount.trim()); const containerPath = growingRaw.growing_path || '/growing'; const mount = await probeGrowingPath(containerPath); @@ -117,6 +121,7 @@ router.get('/overview', async (req, res, next) => { // existing deploy uses this symlink — surface it for operator context. host_path: '/mnt/NVME/MAM/wild-dragon-growing', smb_url: growingRaw.growing_smb_url || '', + smb_mount: growingRaw.growing_smb_mount || '', promote_after_seconds: parseInt(growingRaw.growing_promote_after_seconds, 10) || 8, exists: mount.exists, writable: mount.writable, diff --git a/services/mam-api/src/routes/upload.js b/services/mam-api/src/routes/upload.js index fcb89ef..c1ab9f3 100644 --- a/services/mam-api/src/routes/upload.js +++ b/services/mam-api/src/routes/upload.js @@ -14,6 +14,7 @@ import { AbortMultipartUploadCommand, } from '@aws-sdk/client-s3'; import { getAmppConfig, ensureFolderPath } from '../ampp/client.js'; +import { assertProjectAccess, accessibleProjectIds } from '../auth/authz.js'; const router = express.Router(); @@ -138,16 +139,24 @@ function mediaTypeFromMime(mime = '') { return 'document'; } -// GET /api/v1/upload - List in-progress uploads (#68) +// GET /api/v1/upload - List in-progress uploads (#68). Scoped to projects the +// caller can see — admins are unfiltered; a scoped viewer/editor only sees +// uploads for projects they have access to (no enumeration of other projects' +// in-flight filenames). router.get('/', async (req, res, next) => { try { - const result = await pool.query( - `SELECT id, filename, display_name, project_id, bin_id, status, created_at, updated_at - FROM assets - WHERE status = 'ingesting' - ORDER BY created_at DESC - LIMIT 50` - ); + const access = await accessibleProjectIds(req.user); + let query = `SELECT id, filename, display_name, project_id, bin_id, status, created_at, updated_at + FROM assets + WHERE status = 'ingesting'`; + const params = []; + if (!access.all) { + if (access.ids.size === 0) return res.json([]); + query += ` AND project_id = ANY($1::uuid[])`; + params.push([...access.ids]); + } + query += ` ORDER BY created_at DESC LIMIT 50`; + const result = await pool.query(query, params); res.json(result.rows); } catch (err) { next(err); } }); @@ -163,6 +172,17 @@ router.post('/init', async (req, res, next) => { }); } + // Uploading creates an asset under a project — require edit on that project. + // Without this, any logged-in user could write into any project. + await assertProjectAccess(req.user, projectId, 'edit'); + if (binId) { + const bin = await pool.query('SELECT project_id FROM bins WHERE id = $1', [binId]); + if (bin.rows.length === 0) return res.status(400).json({ error: 'binId not found' }); + if (bin.rows[0].project_id !== projectId) { + return res.status(400).json({ error: 'binId belongs to a different project' }); + } + } + const assetId = uuidv4(); const s3Key = `originals/${assetId}/${filename}`; const tagsArray = tags ? (Array.isArray(tags) ? tags : [tags]) : []; @@ -326,6 +346,20 @@ router.post('/simple', upload.single('file'), async (req, res, next) => { }); } + // Same authz gate as /init. + await assertProjectAccess(req.user, projectId, 'edit'); + if (binId) { + const bin = await pool.query('SELECT project_id FROM bins WHERE id = $1', [binId]); + if (bin.rows.length === 0) { + unlinkPart(tmpPath); + return res.status(400).json({ error: 'binId not found' }); + } + if (bin.rows[0].project_id !== projectId) { + unlinkPart(tmpPath); + return res.status(400).json({ error: 'binId belongs to a different project' }); + } + } + const assetId = uuidv4(); const s3Key = `originals/${assetId}/${filename}`; const mimeType = contentType || req.file.mimetype; diff --git a/services/mam-api/src/routes/users.js b/services/mam-api/src/routes/users.js index b28bcb5..3e93dba 100644 --- a/services/mam-api/src/routes/users.js +++ b/services/mam-api/src/routes/users.js @@ -3,10 +3,12 @@ import express from 'express'; import pool from '../db/pool.js'; import { hashPassword } from '../auth/passwords.js'; -import { DEV_USER_ID } from '../middleware/auth.js'; +import { DEV_USER_ID, requireAdmin } from '../middleware/auth.js'; +import { accessibleProjectIds } from '../auth/authz.js'; const router = express.Router(); const MIN_PASSWORD_LEN = 12; +const ROLES = ['admin', 'editor', 'viewer']; function bad(res, msg) { return res.status(400).json({ error: msg }); } @@ -14,7 +16,7 @@ function bad(res, msg) { return res.status(400).json({ error: msg }); } router.get('/', async (_req, res, next) => { try { const { rows } = await pool.query( - `SELECT id, username, display_name, role, last_login_at, created_at + `SELECT id, username, display_name, role, totp_enabled, last_login_at, created_at FROM users WHERE id <> $1 ORDER BY username`, [DEV_USER_ID]); res.json(rows); } catch (err) { next(err); } @@ -26,6 +28,7 @@ router.post('/', async (req, res, next) => { const { username, password, display_name, role } = req.body || {}; if (!username || typeof username !== 'string') return bad(res, 'username required'); if (!password || password.length < MIN_PASSWORD_LEN) return bad(res, 'password must be at least ' + MIN_PASSWORD_LEN + ' chars'); + if (role !== undefined && !ROLES.includes(role)) return bad(res, "role must be one of: " + ROLES.join(', ')); const hash = await hashPassword(password); const { rows } = await pool.query( `INSERT INTO users (username, password_hash, display_name, role) @@ -76,7 +79,10 @@ router.patch('/:id', async (req, res, next) => { if (req.params.id === DEV_USER_ID) return res.status(400).json({ error: 'cannot edit dev user' }); const sets = []; const vals = []; if (typeof req.body?.display_name === 'string') { sets.push('display_name = $' + (sets.length + 1)); vals.push(req.body.display_name); } - if (typeof req.body?.role === 'string') { sets.push('role = $' + (sets.length + 1)); vals.push(req.body.role); } + if (typeof req.body?.role === 'string') { + if (!ROLES.includes(req.body.role)) return bad(res, "role must be one of: " + ROLES.join(', ')); + sets.push('role = $' + (sets.length + 1)); vals.push(req.body.role); + } if (typeof req.body?.password === 'string') { if (req.body.password.length < MIN_PASSWORD_LEN) return bad(res, 'password must be at least ' + MIN_PASSWORD_LEN + ' chars'); sets.push('password_hash = $' + (sets.length + 1) + ', password_updated_at = NOW()'); @@ -93,4 +99,88 @@ router.patch('/:id', async (req, res, next) => { } catch (err) { next(err); } }); +// GET /:id/access — effective per-project access for one user (admin only). +// Reuses authz.accessibleProjectIds (MAX over direct user grant + every group the +// user belongs to). `via` is 'direct' for a user grant, 'group:' otherwise. +// When the effective level comes from several sources we report the direct grant +// if present, else the first contributing group. +router.get('/:id/access', requireAdmin, async (req, res, next) => { + try { + const { rows: urows } = await pool.query( + `SELECT id, role FROM users WHERE id = $1`, [req.params.id]); + if (urows.length === 0) return res.status(404).json({ error: 'user not found' }); + const target = urows[0]; + + const { rows: groups } = await pool.query( + `SELECT g.id, g.name + FROM user_groups ug JOIN groups g ON g.id = ug.group_id + WHERE ug.user_id = $1 ORDER BY g.name`, [target.id]); + + // Admins bypass scoping — every project at 'edit', via their role. + const access = await accessibleProjectIds(target); + if (access.all) { + const { rows: projects } = await pool.query( + `SELECT id, name FROM projects ORDER BY name`); + return res.json({ + projects: projects.map(p => ({ + project_id: p.id, project_name: p.name, level: 'edit', via: 'direct', + })), + groups, + }); + } + + const ids = [...access.ids]; + if (ids.length === 0) return res.json({ projects: [], groups }); + + // Resolve names + the source of each grant. groupNameById lets us label a + // group-sourced grant; a direct user grant always wins the `via` label. + const groupNameById = new Map(groups.map(g => [g.id, g.name])); + const { rows: grants } = await pool.query( + `SELECT pa.project_id, pa.subject_type, pa.subject_id, pa.level, p.name AS project_name + FROM project_access pa JOIN projects p ON p.id = pa.project_id + WHERE (pa.subject_type = 'user' AND pa.subject_id = $1) + OR (pa.subject_type = 'group' AND pa.subject_id IN ( + SELECT group_id FROM user_groups WHERE user_id = $1 + ))`, + [target.id]); + + const byProject = new Map(); + for (const g of grants) { + const eff = access.levelByProject.get(g.project_id); // already the MAX + const via = g.subject_type === 'user' + ? 'direct' + : 'group:' + (groupNameById.get(g.subject_id) || g.subject_id); + const prev = byProject.get(g.project_id); + // Keep a row only if it carries the effective level; prefer a direct grant + // when both a direct and a group grant hit the same level. + if (g.level === eff && (!prev || (prev.via !== 'direct' && via === 'direct'))) { + byProject.set(g.project_id, { + project_id: g.project_id, project_name: g.project_name, level: eff, via, + }); + } + } + + res.json({ + projects: [...byProject.values()].sort((a, b) => a.project_name.localeCompare(b.project_name)), + groups, + }); + } catch (err) { next(err); } +}); + +// POST /:id/totp/disable — admin clears a locked-out user's 2FA WITHOUT their +// password (the self-service /auth/totp/disable needs the victim's own). Mirrors +// that handler's SQL but targets :id and skips the password check. Dev user blocked. +router.post('/:id/totp/disable', requireAdmin, async (req, res, next) => { + try { + if (req.params.id === DEV_USER_ID) return res.status(400).json({ error: 'cannot edit dev user' }); + const { rowCount } = await pool.query( + `UPDATE users SET totp_enabled = FALSE, totp_secret = NULL, totp_last_counter = 0 + WHERE id = $1 AND id <> $2`, + [req.params.id, DEV_USER_ID]); + if (rowCount === 0) return res.status(404).json({ error: 'user not found' }); + await pool.query(`DELETE FROM user_recovery_codes WHERE user_id = $1`, [req.params.id]); + res.status(204).end(); + } catch (err) { next(err); } +}); + export default router; diff --git a/services/mam-api/src/scheduler.js b/services/mam-api/src/scheduler.js index 8b6b305..a929bc1 100644 --- a/services/mam-api/src/scheduler.js +++ b/services/mam-api/src/scheduler.js @@ -9,6 +9,8 @@ import pool from './db/pool.js'; import { syncToAmpp } from './routes/upload.js'; +import { restartChannel, fireScteBreak } from './routes/playout.js'; +import { INTERNAL_TOKEN } from './middleware/auth.js'; const TICK_INTERVAL_MS = parseInt(process.env.SCHEDULER_TICK_MS || '15000', 10); const SELF_URL = process.env.MAM_API_SELF_URL || `http://127.0.0.1:${process.env.PORT || 3000}`; @@ -19,7 +21,10 @@ let _interval = null; async function callSelf(path, method = 'POST') { const res = await fetch(`${SELF_URL}${path}`, { method, - headers: { 'Content-Type': 'application/json' }, + headers: { + 'Content-Type': 'application/json', + 'x-internal-token': INTERNAL_TOKEN, + }, signal: AbortSignal.timeout(30000), }); if (!res.ok) { @@ -29,11 +34,7 @@ async function callSelf(path, method = 'POST') { return res.json().catch(() => ({})); } -// Issue #103 — every mam-api replica runs the same tick on the same interval, -// so a multi-node deploy would double-fire recorder starts/stops. We guard -// the whole tick with a PG advisory lock (1 = scheduler) so exactly one -// replica processes a given interval. Pure-Postgres, no extra infra. -const SCHEDULER_LOCK_KEY = 8210301; // arbitrary, must be stable across replicas +const SCHEDULER_LOCK_KEY = 8210301; async function tryAcquireSchedulerLock(client) { const r = await client.query('SELECT pg_try_advisory_lock($1) AS got', [SCHEDULER_LOCK_KEY]); @@ -52,14 +53,9 @@ async function tick() { try { haveLock = await tryAcquireSchedulerLock(client); if (!haveLock) { - // Another replica is processing this interval — bail silently. return; } - // 1) Atomically claim pending schedules whose window has opened. The - // UPDATE...RETURNING flips status to 'running' in the same statement - // so even if another replica got past the lock (it can't, but - // belt-and-braces) each row can only be claimed once. const dueStart = await client.query( `UPDATE recorder_schedules SET status = 'starting', updated_at = NOW() @@ -92,7 +88,6 @@ async function tick() { } } - // 2) Atomically claim running schedules whose window has closed. const dueStop = await client.query( `UPDATE recorder_schedules SET status = 'stopping', updated_at = NOW() @@ -115,7 +110,6 @@ async function tick() { console.log(`[scheduler] stopped schedule "${s.name}" on recorder ${s.recorder_id}`); await enqueueNextOccurrence(s, client); } catch (err) { - // Stop failed — flag as failed but don't keep trying forever. await client.query( `UPDATE recorder_schedules SET status = 'failed', error_message = $2, updated_at = NOW() @@ -126,7 +120,6 @@ async function tick() { } } - // 3) If a schedule was cancelled while running, stop the recorder. const cancelledRunning = await client.query( `SELECT s.* FROM recorder_schedules s JOIN recorders r ON r.id = s.recorder_id @@ -142,9 +135,6 @@ async function tick() { } } - // 4) Mark stale live assets as 'error' (#66). - // If a capture container crashes without calling mark-empty/mark-complete, - // the asset row stays status='live' indefinitely. Timeout after 2 hours. const LIVE_TIMEOUT_MINUTES = parseInt(process.env.LIVE_ASSET_TIMEOUT_MINUTES || '120', 10); const staleResult = await client.query( `UPDATE assets @@ -161,9 +151,6 @@ async function tick() { } } - // 5) AMPP sync retry (#77). Pick up any pending/failed rows whose - // next-attempt time has arrived and retry them. Cap per tick so we - // don't burn budget on a single rough interval. const ampps = await client.query( `SELECT id, project_id, bin_id FROM assets WHERE ampp_sync_status IN ('pending', 'failed') @@ -175,6 +162,8 @@ async function tick() { for (const row of ampps.rows) { await syncToAmpp(row.id, row.project_id, row.bin_id); } + + await playoutHealthTick(client); } catch (err) { console.error('[scheduler] tick error:', err); } finally { @@ -201,11 +190,168 @@ async function enqueueNextOccurrence(schedule, client) { console.log(`[scheduler] queued next "${schedule.name}" → ${start.toISOString()}`); } +// ── Playout channel health + failover ──────────────────────────────────────── +// Tick step 6. Reuses the same advisory lock so only one replica probes the +// sidecars; multi-replica pings would just waste cycles. A missed probe is +// counted via last_heartbeat_at age: > 3 * TICK_INTERVAL means 3 consecutive +// misses. +// Persist the as-run compliance log for one channel from a sidecar /status +// payload. The sidecar reports the currently on-air item via currentItemId / +// currentClip / currentItemStartedAt (playout-manager.getStatus). We keep at +// most one "open" row (ended_at IS NULL) per channel: when the on-air item +// changes (or playout stops) we close the open row — stamping ended_at and a +// computed duration_s — and, if a new clip is on air, open a fresh row. +// +// playout_as_run columns (migration 029): id, channel_id, asset_id, item_id, +// clip_name, started_at, ended_at, duration_s, result. +async function writeAsRun(client, channelId, engine) { + const currentItemId = engine && engine.currentItemId ? engine.currentItemId : null; + + // The currently-open as-run row for this channel, if any. + const { rows: openRows } = await client.query( + `SELECT id, item_id, started_at FROM playout_as_run + WHERE channel_id = $1 AND ended_at IS NULL + ORDER BY started_at DESC LIMIT 1`, + [channelId] + ); + const open = openRows[0] || null; + + // Same clip still on air → nothing to do. + if (open && currentItemId && open.item_id === currentItemId) return; + // Nothing on air and nothing open → nothing to do. + if (!open && !currentItemId) return; + + // Close the previous open row (clip changed, or playout stopped). + if (open) { + await client.query( + `UPDATE playout_as_run + SET ended_at = NOW(), + duration_s = EXTRACT(EPOCH FROM (NOW() - started_at)) + WHERE id = $1`, + [open.id] + ); + } + + // Open a new row for the clip now on air. Resolve the item's asset_id so the + // compliance log links back to the source asset even after the playlist item + // is later deleted. + if (currentItemId) { + let assetId = null; + try { + const { rows } = await client.query( + 'SELECT asset_id FROM playout_items WHERE id = $1', [currentItemId] + ); + if (rows.length > 0) assetId = rows[0].asset_id; + } catch (_) { /* item may have been deleted; log without asset link */ } + + await client.query( + `INSERT INTO playout_as_run + (channel_id, asset_id, item_id, clip_name, started_at, result) + VALUES ($1, $2, $3, $4, COALESCE($5::timestamptz, NOW()), 'played')`, + [channelId, assetId, currentItemId, engine.currentClip || null, + engine.currentItemStartedAt || null] + ); + } +} + +async function playoutHealthTick(client) { + let channels; + try { + ({ rows: channels } = await client.query( + `SELECT id, output_type, container_meta, node_id, last_heartbeat_at, updated_at, restart_count + FROM playout_channels WHERE status = 'running'` + )); + } catch (err) { + if (err.code === '42P01') return; + throw err; + } + + const TIMEOUT_MS = TICK_INTERVAL_MS * 3 + 5000; + for (const ch of channels) { + const sidecarUrl = + ch.container_meta && ch.container_meta.sidecar_url + ? ch.container_meta.sidecar_url + : `http://playout-${ch.id}:3002`; + try { + const r = await fetch(`${sidecarUrl}/status`, { signal: AbortSignal.timeout(5000) }); + if (!r.ok) throw new Error(`status HTTP ${r.status}`); + await client.query( + 'UPDATE playout_channels SET last_heartbeat_at = NOW() WHERE id = $1', [ch.id] + ); + // As-run compliance log: the sidecar only tracks the on-air clip locally + // (playout-manager._reportAsRunStart). On every successful status poll we + // detect a clip change here and persist it to playout_as_run — close the + // previous open row and open a new one. Failures are swallowed so a logging + // hiccup never knocks a healthy channel into failover. + try { + const engine = await r.json().catch(() => null); + if (engine) await writeAsRun(client, ch.id, engine); + } catch (e) { + console.warn(`[scheduler] as-run write failed for ${ch.id}: ${e.message}`); + } + + // SCTE-35: fire any pending scheduled breaks now due. Position-based + // breaks (playlist_pos) fire when the engine reaches that item; wall-clock + // breaks fire at scheduled_at. Failures mark the break cancelled so a bad + // break never wedges the sweep. + try { + const { rows: due } = await client.query( + `SELECT * FROM playout_scte_breaks + WHERE channel_id = $1 AND status = 'pending' + AND ( (scheduled_at IS NOT NULL AND scheduled_at <= NOW()) + OR (playlist_pos IS NOT NULL AND playlist_pos <= $2) ) + ORDER BY created_at ASC`, + [ch.id, (engine && engine.currentIndex >= 0) ? engine.currentIndex : -1] + ); + for (const brk of due) { + try { await fireScteBreak(ch, brk); } + catch (e2) { + console.warn(`[scheduler] scte fire failed for break ${brk.id}: ${e2.message}`); + await client.query( + `UPDATE playout_scte_breaks SET status = 'cancelled', updated_at = NOW() WHERE id = $1`, + [brk.id]).catch(() => {}); + } + } + } catch (e) { + console.warn(`[scheduler] scte sweep failed for ${ch.id}: ${e.message}`); + } + } catch (err) { + // When last_heartbeat_at is NULL (channel just spawned), fall back to + // updated_at (set to NOW() by spawnChannelSidecar). This prevents a + // brand-new channel from being failed over on the very first tick because + // epoch-0 age always exceeds TIMEOUT_MS. + const baseline = ch.last_heartbeat_at || ch.updated_at; + const lastSeen = baseline ? new Date(baseline).getTime() : Date.now(); + const ageMs = Date.now() - lastSeen; + if (ageMs < TIMEOUT_MS) continue; + + if (ch.output_type === 'decklink') { + await client.query( + "UPDATE playout_channels SET status = 'error', error_message = $1 WHERE id = $2", + [`sidecar unreachable (${err.message}); decklink channels require manual recovery`, ch.id] + ); + console.error(`[scheduler] decklink channel ${ch.id} unreachable — alert-only, no auto-failover`); + continue; + } + + console.warn(`[scheduler] failover: channel ${ch.id} unreachable (${err.message}), restart #${ch.restart_count + 1}`); + try { + const res = await restartChannel(ch.id); + if (res.restarted) { + console.log(`[scheduler] failover: channel ${ch.id} re-placed on node ${res.new_node_id}`); + } else { + console.error(`[scheduler] failover: channel ${ch.id} restart skipped — ${res.reason}`); + } + } catch (err2) { + console.error(`[scheduler] failover error for ${ch.id}: ${err2.message}`); + } + } + } +} + export function startSchedulerLoop() { if (_interval) return; console.log(`[scheduler] tick loop started (interval=${TICK_INTERVAL_MS}ms)`); - // Fire once on startup so a window that opened while the API was down - // doesn't have to wait a full interval. setTimeout(() => tick().catch(() => {}), 2000); _interval = setInterval(() => tick().catch(() => {}), TICK_INTERVAL_MS); } diff --git a/services/mam-api/test/auth/authz.test.js b/services/mam-api/test/auth/authz.test.js new file mode 100644 index 0000000..4ab34a3 --- /dev/null +++ b/services/mam-api/test/auth/authz.test.js @@ -0,0 +1,125 @@ +import { test } from 'node:test'; +import assert from 'node:assert/strict'; +import { isTestDbConfigured, setupTestDb } from '../helpers/setup-db.js'; +import { + isAdmin, + accessibleProjectIds, + projectLevel, + assertProjectAccess, +} from '../../src/auth/authz.js'; + +const SKIP = !isTestDbConfigured() && 'TEST_DATABASE_URL not set'; + +// ── isAdmin (pure, no DB) ─────────────────────────────────────────────────── +test('isAdmin true only for role admin', () => { + assert.equal(isAdmin({ role: 'admin' }), true); + assert.equal(isAdmin({ role: 'editor' }), false); + assert.equal(isAdmin({ role: 'viewer' }), false); + assert.equal(isAdmin(null), false); + assert.equal(isAdmin(undefined), false); +}); + +// Seed helpers shared across the DB-backed cases. +async function seed(pool) { + const proj = async (name) => + (await pool.query( + `INSERT INTO projects (name, s3_prefix) VALUES ($1, $1) RETURNING id`, [name] + )).rows[0].id; + const user = async (username, role) => + (await pool.query( + `INSERT INTO users (username, password_hash, role) VALUES ($1, 'x', $2) RETURNING id`, + [username, role] + )).rows[0].id; + const group = async (name) => + (await pool.query(`INSERT INTO groups (name) VALUES ($1) RETURNING id`, [name])).rows[0].id; + const grantUser = (pid, uid, level) => + pool.query( + `INSERT INTO project_access (project_id, subject_type, subject_id, level) + VALUES ($1, 'user', $2, $3)`, [pid, uid, level]); + const grantGroup = (pid, gid, level) => + pool.query( + `INSERT INTO project_access (project_id, subject_type, subject_id, level) + VALUES ($1, 'group', $2, $3)`, [pid, gid, level]); + const addToGroup = (uid, gid) => + pool.query(`INSERT INTO user_groups (user_id, group_id) VALUES ($1, $2)`, [uid, gid]); + return { proj, user, group, grantUser, grantGroup, addToGroup }; +} + +test('admin sees all projects, every project at edit', { skip: SKIP }, async () => { + const pool = await setupTestDb(); + try { + const s = await seed(pool); + await s.proj('Alpha'); await s.proj('Beta'); + const admin = { id: await s.user('adm', 'admin'), role: 'admin' }; + + const acc = await accessibleProjectIds(admin, pool); + assert.equal(acc.all, true); + assert.equal(await projectLevel(admin, '00000000-0000-4000-8000-000000000001', pool), 'edit'); + await assertProjectAccess(admin, '00000000-0000-4000-8000-000000000001', 'edit', pool); // no throw + } finally { await pool.end(); } +}); + +test('direct user grant scopes access and respects level', { skip: SKIP }, async () => { + const pool = await setupTestDb(); + try { + const s = await seed(pool); + const alpha = await s.proj('Alpha'); + const beta = await s.proj('Beta'); + const u = { id: await s.user('bob', 'editor'), role: 'editor' }; + await s.grantUser(alpha, u.id, 'view'); + + const acc = await accessibleProjectIds(u, pool); + assert.equal(acc.all, false); + assert.deepEqual([...acc.ids], [alpha]); + assert.equal(await projectLevel(u, alpha, pool), 'view'); + assert.equal(await projectLevel(u, beta, pool), null); + + await assertProjectAccess(u, alpha, 'view', pool); // ok + await assert.rejects(() => assertProjectAccess(u, alpha, 'edit', pool), e => e.status === 403); + await assert.rejects(() => assertProjectAccess(u, beta, 'view', pool), e => e.status === 403); + } finally { await pool.end(); } +}); + +test('group grant flows through membership', { skip: SKIP }, async () => { + const pool = await setupTestDb(); + try { + const s = await seed(pool); + const alpha = await s.proj('Alpha'); + const u = { id: await s.user('carol', 'viewer'), role: 'viewer' }; + const g = await s.group('broadcasters'); + await s.addToGroup(u.id, g); + await s.grantGroup(alpha, g, 'edit'); + + assert.equal(await projectLevel(u, alpha, pool), 'edit'); + const acc = await accessibleProjectIds(u, pool); + assert.deepEqual([...acc.ids], [alpha]); + await assertProjectAccess(u, alpha, 'edit', pool); // ok via group + } finally { await pool.end(); } +}); + +test('effective level is the max of direct + group grants', { skip: SKIP }, async () => { + const pool = await setupTestDb(); + try { + const s = await seed(pool); + const alpha = await s.proj('Alpha'); + const u = { id: await s.user('dan', 'editor'), role: 'editor' }; + const g = await s.group('team'); + await s.addToGroup(u.id, g); + await s.grantUser(alpha, u.id, 'view'); // direct: view + await s.grantGroup(alpha, g, 'edit'); // group: edit → wins + + assert.equal(await projectLevel(u, alpha, pool), 'edit'); + } finally { await pool.end(); } +}); + +test('user with no grants sees nothing', { skip: SKIP }, async () => { + const pool = await setupTestDb(); + try { + const s = await seed(pool); + await s.proj('Alpha'); + const u = { id: await s.user('eve', 'viewer'), role: 'viewer' }; + + const acc = await accessibleProjectIds(u, pool); + assert.equal(acc.ids.size, 0); + } finally { await pool.end(); } +}); diff --git a/services/mam-api/test/auth/google-oauth.test.js b/services/mam-api/test/auth/google-oauth.test.js new file mode 100644 index 0000000..26766be --- /dev/null +++ b/services/mam-api/test/auth/google-oauth.test.js @@ -0,0 +1,40 @@ +// Unit tests for the config-gating + domain helpers in google-oauth.js. The +// token-exchange / ID-token-verify path requires Google's servers and is covered +// by manual verification (see .env.example); here we lock down the pure logic +// that decides whether the feature is on and which domain is allowed. +import { test } from 'node:test'; +import assert from 'node:assert/strict'; +import { isConfigured, allowedDomain } from '../../src/auth/google-oauth.js'; + +function withEnv(vars, fn) { + const saved = {}; + for (const k of Object.keys(vars)) { saved[k] = process.env[k]; + if (vars[k] === undefined) delete process.env[k]; else process.env[k] = vars[k]; } + try { return fn(); } + finally { + for (const k of Object.keys(vars)) { + if (saved[k] === undefined) delete process.env[k]; else process.env[k] = saved[k]; + } + } +} + +test('isConfigured is false unless client id, secret, and redirect are all set', () => { + withEnv({ GOOGLE_CLIENT_ID: undefined, GOOGLE_CLIENT_SECRET: undefined, OAUTH_REDIRECT_URL: undefined }, () => { + assert.equal(isConfigured(), false); + }); + withEnv({ GOOGLE_CLIENT_ID: 'x', GOOGLE_CLIENT_SECRET: undefined, OAUTH_REDIRECT_URL: undefined }, () => { + assert.equal(isConfigured(), false); + }); + withEnv({ GOOGLE_CLIENT_ID: 'x', GOOGLE_CLIENT_SECRET: 'y', OAUTH_REDIRECT_URL: undefined }, () => { + assert.equal(isConfigured(), false); + }); + withEnv({ GOOGLE_CLIENT_ID: 'x', GOOGLE_CLIENT_SECRET: 'y', OAUTH_REDIRECT_URL: 'https://h/cb' }, () => { + assert.equal(isConfigured(), true); + }); +}); + +test('allowedDomain normalizes and defaults to null', () => { + withEnv({ GOOGLE_ALLOWED_DOMAIN: undefined }, () => assert.equal(allowedDomain(), null)); + withEnv({ GOOGLE_ALLOWED_DOMAIN: '' }, () => assert.equal(allowedDomain(), null)); + withEnv({ GOOGLE_ALLOWED_DOMAIN: ' WildDragon.NET ' }, () => assert.equal(allowedDomain(), 'wilddragon.net')); +}); diff --git a/services/mam-api/test/auth/mfa-tickets.test.js b/services/mam-api/test/auth/mfa-tickets.test.js new file mode 100644 index 0000000..546a336 --- /dev/null +++ b/services/mam-api/test/auth/mfa-tickets.test.js @@ -0,0 +1,49 @@ +// MFA ticket binding tests — the second login step's tickets are bound to the +// issuing request's IP + User-Agent (hashed) so a stolen ticket replayed from +// a different origin can't complete the second factor. +import { test } from 'node:test'; +import assert from 'node:assert/strict'; +import { issueTicket, redeemTicket } from '../../src/auth/mfa-tickets.js'; + +test('ticket round-trips when ip + userAgent match', () => { + const id = issueTicket('user-1', { ip: '1.2.3.4', userAgent: 'curl/8' }); + assert.equal(redeemTicket(id, { ip: '1.2.3.4', userAgent: 'curl/8' }), 'user-1'); +}); + +test('ticket rejects redemption from a different IP', () => { + const id = issueTicket('user-1', { ip: '1.2.3.4', userAgent: 'curl/8' }); + assert.equal(redeemTicket(id, { ip: '9.9.9.9', userAgent: 'curl/8' }), null); +}); + +test('ticket rejects redemption with a different User-Agent', () => { + const id = issueTicket('user-1', { ip: '1.2.3.4', userAgent: 'curl/8' }); + assert.equal(redeemTicket(id, { ip: '1.2.3.4', userAgent: 'Mozilla/5.0' }), null); +}); + +test('ticket is single-use even on binding mismatch', () => { + // A wrong-binding probe must still burn the ticket — otherwise an attacker + // could try multiple IPs/UAs against the same ticket. + const id = issueTicket('user-1', { ip: '1.2.3.4', userAgent: 'curl/8' }); + assert.equal(redeemTicket(id, { ip: '9.9.9.9', userAgent: 'curl/8' }), null); + // Same ticket with correct bindings now also fails — it was consumed. + assert.equal(redeemTicket(id, { ip: '1.2.3.4', userAgent: 'curl/8' }), null); +}); + +test('redeemTicket returns null for missing or unknown id', () => { + assert.equal(redeemTicket(null), null); + assert.equal(redeemTicket(undefined), null); + assert.equal(redeemTicket(''), null); + assert.equal(redeemTicket('not-a-real-id', { ip: 'x', userAgent: 'y' }), null); +}); + +test('ticket is single-use on success', () => { + const id = issueTicket('user-1', { ip: '1.2.3.4', userAgent: 'curl/8' }); + assert.equal(redeemTicket(id, { ip: '1.2.3.4', userAgent: 'curl/8' }), 'user-1'); + assert.equal(redeemTicket(id, { ip: '1.2.3.4', userAgent: 'curl/8' }), null); +}); + +test('issueTicket without bindings still works (back-compat / tests)', () => { + const id = issueTicket('user-1'); + // No bindings on redeem either — both sides skip the check. + assert.equal(redeemTicket(id), 'user-1'); +}); diff --git a/services/mam-api/test/auth/totp.test.js b/services/mam-api/test/auth/totp.test.js new file mode 100644 index 0000000..f583213 --- /dev/null +++ b/services/mam-api/test/auth/totp.test.js @@ -0,0 +1,96 @@ +import { test } from 'node:test'; +import assert from 'node:assert/strict'; +import { + base32Encode, base32Decode, generateSecret, generateToken, + verifyToken, otpauthURI, generateRecoveryCodes, +} from '../../src/auth/totp.js'; + +// ── base32 round-trips ────────────────────────────────────────────────────── +test('base32 encode/decode round-trips arbitrary bytes', () => { + for (const s of ['', 'f', 'fo', 'foo', 'foob', 'fooba', 'foobar']) { + const buf = Buffer.from(s); + assert.deepEqual(base32Decode(base32Encode(buf)), buf); + } +}); + +// ── RFC 6238 Appendix B test vectors (SHA-1, 8 digits in the RFC; we use the +// low 6 here, so compare the last 6 digits of each published value). ────────── +// The RFC uses the ASCII secret "12345678901234567890". We base32-encode it and +// check the 6-digit code at each published timestamp. +test('matches RFC 6238 SHA-1 vectors (low 6 digits)', () => { + const secret = base32Encode(Buffer.from('12345678901234567890')); + // [unix seconds, full 8-digit code from the RFC] → expect last 6 digits. + const vectors = [ + [59, '94287082'], + [1111111109, '07081804'], + [1111111111, '14050471'], + [1234567890, '89005924'], + [2000000000, '69279037'], + [20000000000, '65353130'], + ]; + for (const [secs, full8] of vectors) { + const got = generateToken(secret, secs * 1000); + assert.equal(got, full8.slice(-6), `t=${secs}`); + } +}); + +// ── verify with drift window ──────────────────────────────────────────────── +// verifyToken returns the matched counter (truthy) or null (falsy). +test('verifyToken accepts the current code and ±1 step of drift', () => { + const secret = generateSecret(); + const now = 1_700_000_000_000; + const code = generateToken(secret, now); + const baseCounter = Math.floor(now / 1000 / 30); + assert.equal(verifyToken(secret, code, now), baseCounter); + // 30s earlier / later still inside ±1 window — the *issued* code matches the + // baseCounter, but at now+30s we're in step baseCounter+1, so the issued + // code matches as drift = -1 step → returns baseCounter. + assert.equal(verifyToken(secret, code, now + 30_000), baseCounter); + assert.equal(verifyToken(secret, code, now - 30_000), baseCounter); + // 2 steps away → rejected. + assert.equal(verifyToken(secret, code, now + 90_000), null); +}); + +test('verifyToken rejects malformed / empty input without throwing', () => { + const secret = generateSecret(); + assert.equal(verifyToken(secret, ''), null); + assert.equal(verifyToken(secret, 'abcdef'), null); + assert.equal(verifyToken(secret, '12345'), null); // too short + assert.equal(verifyToken(secret, '1234567'), null); // too long + assert.equal(verifyToken('', '123456'), null); +}); + +test('verifyToken tolerates spaces in the user-entered code', () => { + const secret = generateSecret(); + const now = 1_700_000_000_000; + const code = generateToken(secret, now); + const expected = Math.floor(now / 1000 / 30); + assert.equal(verifyToken(secret, code.slice(0, 3) + ' ' + code.slice(3), now), expected); +}); + +test('verifyToken returns the matched counter (for replay protection)', () => { + const secret = generateSecret(); + const now = 1_700_000_000_000; + const code = generateToken(secret, now); + const counter = verifyToken(secret, code, now); + assert.ok(typeof counter === 'number' && counter > 0); + assert.equal(counter, Math.floor(now / 1000 / 30)); +}); + +// ── otpauth URI ───────────────────────────────────────────────────────────── +test('otpauthURI embeds secret, issuer, and account', () => { + const uri = otpauthURI('JBSWY3DPEHPK3PXP', 'alice', 'Dragonflight'); + assert.match(uri, /^otpauth:\/\/totp\/Dragonflight%3Aalice\?/); + assert.match(uri, /secret=JBSWY3DPEHPK3PXP/); + assert.match(uri, /issuer=Dragonflight/); + assert.match(uri, /digits=6/); + assert.match(uri, /period=30/); +}); + +// ── recovery codes ────────────────────────────────────────────────────────── +test('generateRecoveryCodes returns N distinct formatted codes', () => { + const codes = generateRecoveryCodes(10); + assert.equal(codes.length, 10); + assert.equal(new Set(codes).size, 10); + for (const c of codes) assert.match(c, /^[0-9a-f]{5}-[0-9a-f]{5}$/); +}); diff --git a/services/mam-api/test/routes/assets-access.test.js b/services/mam-api/test/routes/assets-access.test.js new file mode 100644 index 0000000..99aa598 --- /dev/null +++ b/services/mam-api/test/routes/assets-access.test.js @@ -0,0 +1,79 @@ +// Regression test: GET /api/v1/assets must be scoped to the caller's accessible +// projects. A pre-fix bug returned every asset across every project to any +// authenticated user, defeating RBAC v2. +// +// Like project-access.test.js, the assets router uses the singleton pool, so we +// point DATABASE_URL at TEST_DATABASE_URL and seed through the same pool. +// Skips when TEST_DATABASE_URL is unset. +import { test } from 'node:test'; +import assert from 'node:assert/strict'; +import express from 'express'; +import { isTestDbConfigured, setupTestDb } from '../helpers/setup-db.js'; + +const SKIP = !isTestDbConfigured() && 'TEST_DATABASE_URL not set'; + +async function appWithAssets(user) { + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + process.env.AUTH_ENABLED = 'true'; + // Importing the assets router constructs BullMQ queues; they connect lazily, + // and the list route only touches Postgres, so no Redis is needed here. + const { default: assetsRouter } = await import('../../src/routes/assets.js?v=' + Date.now()); + const app = express(); + app.use(express.json()); + app.use((req, _res, next) => { req.user = user; next(); }); + app.use('/api/v1/assets', assetsRouter); + return new Promise(r => { + const srv = app.listen(0, '127.0.0.1', () => + r({ baseUrl: 'http://127.0.0.1:' + srv.address().port, close: () => new Promise(rs => srv.close(rs)) })); + }); +} + +async function seed(pool) { + const proj = async (n) => (await pool.query(`INSERT INTO projects (name, s3_prefix) VALUES ($1,$1) RETURNING id`, [n])).rows[0].id; + const alpha = await proj('Alpha'); + const beta = await proj('Beta'); + const asset = (pid, name) => pool.query( + `INSERT INTO assets (project_id, filename, display_name, media_type, status) + VALUES ($1, $2, $2, 'video', 'ready')`, [pid, name]); + await asset(alpha, 'a1'); await asset(alpha, 'a2'); await asset(beta, 'b1'); + const admin = { id: (await pool.query(`INSERT INTO users (username, password_hash, role) VALUES ('adm','x','admin') RETURNING id`)).rows[0].id, role: 'admin' }; + const scoped = { id: (await pool.query(`INSERT INTO users (username, password_hash, role) VALUES ('vu','x','viewer') RETURNING id`)).rows[0].id, role: 'viewer' }; + await pool.query( + `INSERT INTO project_access (project_id, subject_type, subject_id, level) VALUES ($1,'user',$2,'view')`, + [alpha, scoped.id]); + return { alpha, beta, admin, scoped }; +} + +test('GET /assets returns only assets in granted projects for scoped users', { skip: SKIP }, async () => { + const pool = await setupTestDb(); + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + try { + const { admin, scoped } = await seed(pool); + + // Admin sees all three. + let a = await appWithAssets(admin); + let body = await (await fetch(a.baseUrl + '/api/v1/assets')).json(); + assert.equal(body.assets.length, 3, 'admin should see every asset'); + await a.close(); + + // Scoped viewer (granted only Alpha) sees the two Alpha assets, not Beta's. + let s = await appWithAssets(scoped); + body = await (await fetch(s.baseUrl + '/api/v1/assets')).json(); + assert.equal(body.assets.length, 2, 'scoped user should see only granted-project assets'); + assert.ok(body.assets.every(x => x.display_name !== 'b1'), 'must not leak ungranted-project asset'); + await s.close(); + } finally { await pool.end(); } +}); + +test('GET /assets returns nothing for a user with no grants', { skip: SKIP }, async () => { + const pool = await setupTestDb(); + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + try { + await seed(pool); + const nobody = { id: (await pool.query(`INSERT INTO users (username, password_hash, role) VALUES ('no','x','viewer') RETURNING id`)).rows[0].id, role: 'viewer' }; + const s = await appWithAssets(nobody); + const body = await (await fetch(s.baseUrl + '/api/v1/assets')).json(); + assert.deepEqual(body, { assets: [], total: 0 }); + await s.close(); + } finally { await pool.end(); } +}); diff --git a/services/mam-api/test/routes/comments-access.test.js b/services/mam-api/test/routes/comments-access.test.js new file mode 100644 index 0000000..d056760 --- /dev/null +++ b/services/mam-api/test/routes/comments-access.test.js @@ -0,0 +1,76 @@ +// RBAC coverage for asset comments: the guard resolves the project via the +// asset, requiring view to read and edit to write. Also verifies the author id +// is recorded from req.user (regression for the old req.session.userId bug). +// Skips without TEST_DATABASE_URL. +import { test } from 'node:test'; +import assert from 'node:assert/strict'; +import express from 'express'; +import { isTestDbConfigured, setupTestDb } from '../helpers/setup-db.js'; + +const SKIP = !isTestDbConfigured() && 'TEST_DATABASE_URL not set'; + +async function appWithComments(user) { + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + process.env.AUTH_ENABLED = 'true'; + const { default: commentsRouter } = await import('../../src/routes/comments.js?v=' + Date.now()); + const app = express(); + app.use(express.json()); + app.use((req, _res, next) => { req.user = user; next(); }); + // Mirror index.js mount so :assetId flows through (mergeParams in the router). + app.use('/api/v1/assets/:assetId/comments', commentsRouter); + return new Promise(r => { + const srv = app.listen(0, '127.0.0.1', () => + r({ baseUrl: 'http://127.0.0.1:' + srv.address().port, close: () => new Promise(rs => srv.close(rs)) })); + }); +} + +async function seed(pool) { + const proj = async (n) => (await pool.query(`INSERT INTO projects (name, s3_prefix) VALUES ($1,$1) RETURNING id`, [n])).rows[0].id; + const alpha = await proj('Alpha'); + const beta = await proj('Beta'); + const asset = async (pid, name) => (await pool.query( + `INSERT INTO assets (project_id, filename, display_name, media_type, status) VALUES ($1,$2,$2,'video','ready') RETURNING id`, [pid, name])).rows[0].id; + const assetA = await asset(alpha, 'a1'); + const assetB = await asset(beta, 'b1'); + const viewer = { id: (await pool.query(`INSERT INTO users (username, password_hash, role) VALUES ('vu','x','viewer') RETURNING id`)).rows[0].id, role: 'viewer' }; + const editor = { id: (await pool.query(`INSERT INTO users (username, password_hash, role) VALUES ('ed','x','editor') RETURNING id`)).rows[0].id, role: 'editor' }; + await pool.query(`INSERT INTO project_access (project_id, subject_type, subject_id, level) VALUES ($1,'user',$2,'view')`, [alpha, viewer.id]); + await pool.query(`INSERT INTO project_access (project_id, subject_type, subject_id, level) VALUES ($1,'user',$2,'edit')`, [alpha, editor.id]); + return { assetA, assetB, viewer, editor }; +} + +test('comments require view to read and block ungranted assets', { skip: SKIP }, async () => { + const pool = await setupTestDb(); + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + try { + const { assetA, assetB, viewer } = await seed(pool); + const s = await appWithComments(viewer); + assert.equal((await fetch(s.baseUrl + '/api/v1/assets/' + assetA + '/comments')).status, 200); + assert.equal((await fetch(s.baseUrl + '/api/v1/assets/' + assetB + '/comments')).status, 403); + await s.close(); + } finally { await pool.end(); } +}); + +test('posting a comment requires edit and records the author id from req.user', { skip: SKIP }, async () => { + const pool = await setupTestDb(); + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + try { + const { assetA, viewer, editor } = await seed(pool); + + // viewer (view-only) cannot post. + let s = await appWithComments(viewer); + let r = await fetch(s.baseUrl + '/api/v1/assets/' + assetA + '/comments', { + method: 'POST', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify({ body: 'hi' }) }); + assert.equal(r.status, 403); + await s.close(); + + // editor can post, and the author id is the editor (not null). + let e = await appWithComments(editor); + r = await fetch(e.baseUrl + '/api/v1/assets/' + assetA + '/comments', { + method: 'POST', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify({ body: 'looks good' }) }); + assert.equal(r.status, 201); + const created = await r.json(); + assert.equal(created.user_id, editor.id, 'comment author must be req.user.id'); + await e.close(); + } finally { await pool.end(); } +}); diff --git a/services/mam-api/test/routes/google-link.test.js b/services/mam-api/test/routes/google-link.test.js new file mode 100644 index 0000000..9c5e069 --- /dev/null +++ b/services/mam-api/test/routes/google-link.test.js @@ -0,0 +1,63 @@ +// Security regression test for resolveGoogleUser: a Google sign-in must NEVER +// adopt a pre-existing local account by matching email (that would be account +// takeover). It links only by google_sub, otherwise provisions a fresh viewer. +// Skips without TEST_DATABASE_URL. +import { test } from 'node:test'; +import assert from 'node:assert/strict'; +import { isTestDbConfigured, setupTestDb } from '../helpers/setup-db.js'; +import { hashPassword } from '../../src/auth/passwords.js'; + +const SKIP = !isTestDbConfigured() && 'TEST_DATABASE_URL not set'; + +async function loadResolve() { + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + return (await import('../../src/routes/auth.js?v=' + Date.now())).resolveGoogleUser; +} + +test('a Google login with an email matching a local admin does NOT take over that account', { skip: SKIP }, async () => { + const pool = await setupTestDb(); + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + try { + // Pre-existing local admin with a password and the same email the attacker controls. + const adminId = (await pool.query( + `INSERT INTO users (username, password_hash, role, email) + VALUES ('boss', $1, 'admin', 'boss@wilddragon.net') RETURNING id`, + [await hashPassword('a-real-password-12')])).rows[0].id; + + const resolveGoogleUser = await loadResolve(); + const user = await resolveGoogleUser({ sub: 'google-attacker-sub', email: 'boss@wilddragon.net', name: 'Not The Boss' }); + + // Must be a brand-new account, NOT the admin. + assert.notEqual(user.id, adminId, 'Google login must not resolve to the existing admin'); + const row = (await pool.query(`SELECT role, google_sub FROM users WHERE id = $1`, [user.id])).rows[0]; + assert.equal(row.role, 'viewer', 'auto-provisioned account must be a viewer'); + assert.equal(row.google_sub, 'google-attacker-sub'); + // The admin row is untouched (no google_sub linked onto it). + const admin = (await pool.query(`SELECT google_sub FROM users WHERE id = $1`, [adminId])).rows[0]; + assert.equal(admin.google_sub, null, 'the existing admin must not have been linked'); + } finally { await pool.end(); } +}); + +test('a returning Google user resolves to the same account by google_sub', { skip: SKIP }, async () => { + const pool = await setupTestDb(); + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + try { + const resolveGoogleUser = await loadResolve(); + const first = await resolveGoogleUser({ sub: 'sub-123', email: 'alice@wilddragon.net', name: 'Alice' }); + const second = await resolveGoogleUser({ sub: 'sub-123', email: 'alice@wilddragon.net', name: 'Alice' }); + assert.equal(first.id, second.id, 'same google_sub must map to the same user'); + const count = (await pool.query(`SELECT COUNT(*)::int AS n FROM users WHERE google_sub = 'sub-123'`)).rows[0].n; + assert.equal(count, 1, 'must not create a duplicate on second login'); + } finally { await pool.end(); } +}); + +test('username collisions get a numeric suffix', { skip: SKIP }, async () => { + const pool = await setupTestDb(); + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + try { + await pool.query(`INSERT INTO users (username, password_hash, role) VALUES ('sam', 'x', 'viewer')`); + const resolveGoogleUser = await loadResolve(); + const u = await resolveGoogleUser({ sub: 'sub-sam', email: 'sam@wilddragon.net', name: 'Sam' }); + assert.match(u.username, /^sam\d+$/, 'colliding username should get a numeric suffix'); + } finally { await pool.end(); } +}); diff --git a/services/mam-api/test/routes/project-access.test.js b/services/mam-api/test/routes/project-access.test.js new file mode 100644 index 0000000..49d3bf1 --- /dev/null +++ b/services/mam-api/test/routes/project-access.test.js @@ -0,0 +1,125 @@ +// Integration test for per-project RBAC: the grant-management API on the +// projects router + scoped enforcement on GET /projects and GET /projects/:id. +// +// NOTE: the routers use the singleton pool (src/db/pool.js), which reads +// DATABASE_URL. We point DATABASE_URL at the throwaway TEST_DATABASE_URL and +// seed through that same singleton pool so the router and the test share one +// database. Skips cleanly when TEST_DATABASE_URL is unset. +import { test } from 'node:test'; +import assert from 'node:assert/strict'; +import express from 'express'; +import { isTestDbConfigured, setupTestDb } from '../helpers/setup-db.js'; + +const SKIP = !isTestDbConfigured() && 'TEST_DATABASE_URL not set'; + +// Build an app that injects a chosen user as req.user (simulating requireAuth), +// then mounts the real projects router with the same admin gate index.js uses. +async function appWithProjects(user) { + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + process.env.AUTH_ENABLED = 'true'; + const { default: projectsRouter } = await import('../../src/routes/projects.js?v=' + Date.now()); + const app = express(); + app.use(express.json()); + app.use((req, _res, next) => { req.user = user; next(); }); + app.use('/api/v1/projects', projectsRouter); + return new Promise(r => { + const srv = app.listen(0, '127.0.0.1', () => + r({ baseUrl: 'http://127.0.0.1:' + srv.address().port, close: () => new Promise(rs => srv.close(rs)) })); + }); +} + +async function seedBaseline(pool) { + const alpha = (await pool.query(`INSERT INTO projects (name, s3_prefix) VALUES ('Alpha','alpha') RETURNING id`)).rows[0].id; + const beta = (await pool.query(`INSERT INTO projects (name, s3_prefix) VALUES ('Beta','beta') RETURNING id`)).rows[0].id; + const admin = { id: (await pool.query(`INSERT INTO users (username, password_hash, role) VALUES ('adm','x','admin') RETURNING id`)).rows[0].id, role: 'admin' }; + const scoped = { id: (await pool.query(`INSERT INTO users (username, password_hash, role) VALUES ('vu','x','viewer') RETURNING id`)).rows[0].id, role: 'viewer' }; + return { alpha, beta, admin, scoped }; +} + +test('admin grants a project, scoped user then sees only it; revoke removes access', { skip: SKIP }, async () => { + const pool = await setupTestDb(); + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + try { + const { alpha, beta, admin, scoped } = await seedBaseline(pool); + + // Scoped viewer initially sees nothing. + let s = await appWithProjects(scoped); + let list = await (await fetch(s.baseUrl + '/api/v1/projects')).json(); + assert.equal(list.length, 0, 'scoped user should see no projects before any grant'); + // And cannot read Alpha directly. + let direct = await fetch(s.baseUrl + '/api/v1/projects/' + alpha); + assert.equal(direct.status, 403); + await s.close(); + + // Admin grants the scoped user 'view' on Alpha. + const a = await appWithProjects(admin); + const grant = await fetch(a.baseUrl + '/api/v1/projects/' + alpha + '/access', { + method: 'POST', headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ subject_type: 'user', subject_id: scoped.id, level: 'view' }), + }); + assert.equal(grant.status, 201); + const grantList = await (await fetch(a.baseUrl + '/api/v1/projects/' + alpha + '/access')).json(); + assert.equal(grantList.length, 1); + assert.equal(grantList[0].subject_id, scoped.id); + await a.close(); + + // Scoped viewer now sees exactly Alpha (not Beta), can GET it, cannot PATCH (view-only). + s = await appWithProjects(scoped); + list = await (await fetch(s.baseUrl + '/api/v1/projects')).json(); + assert.deepEqual(list.map(p => p.id), [alpha]); + assert.equal((await fetch(s.baseUrl + '/api/v1/projects/' + alpha)).status, 200); + assert.equal((await fetch(s.baseUrl + '/api/v1/projects/' + beta)).status, 403); + const patch = await fetch(s.baseUrl + '/api/v1/projects/' + alpha, { + method: 'PATCH', headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ description: 'hacked' }), + }); + assert.equal(patch.status, 403, 'view-level grant must not allow edit'); + await s.close(); + + // Admin revokes; scoped viewer goes back to seeing nothing. + const a2 = await appWithProjects(admin); + const del = await fetch(a2.baseUrl + '/api/v1/projects/' + alpha + '/access/user/' + scoped.id, { method: 'DELETE' }); + assert.equal(del.status, 204); + await a2.close(); + + s = await appWithProjects(scoped); + list = await (await fetch(s.baseUrl + '/api/v1/projects')).json(); + assert.equal(list.length, 0); + await s.close(); + } finally { await pool.end(); } +}); + +test('non-admin cannot reach the grant-management API', { skip: SKIP }, async () => { + const pool = await setupTestDb(); + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + try { + const { alpha, scoped } = await seedBaseline(pool); + const s = await appWithProjects(scoped); + // requireAdmin sits on the access sub-routes; a viewer is 403. + const r = await fetch(s.baseUrl + '/api/v1/projects/' + alpha + '/access'); + assert.equal(r.status, 403); + await s.close(); + } finally { await pool.end(); } +}); + +test('edit-level grant allows PATCH', { skip: SKIP }, async () => { + const pool = await setupTestDb(); + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + try { + const { alpha, admin, scoped } = await seedBaseline(pool); + const a = await appWithProjects(admin); + await fetch(a.baseUrl + '/api/v1/projects/' + alpha + '/access', { + method: 'POST', headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ subject_type: 'user', subject_id: scoped.id, level: 'edit' }), + }); + await a.close(); + + const s = await appWithProjects(scoped); + const patch = await fetch(s.baseUrl + '/api/v1/projects/' + alpha, { + method: 'PATCH', headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ description: 'updated by editor' }), + }); + assert.equal(patch.status, 200); + await s.close(); + } finally { await pool.end(); } +}); diff --git a/services/mam-api/test/routes/recorders-access.test.js b/services/mam-api/test/routes/recorders-access.test.js new file mode 100644 index 0000000..ee143ba --- /dev/null +++ b/services/mam-api/test/routes/recorders-access.test.js @@ -0,0 +1,107 @@ +// RBAC coverage for recorders: list is scoped to accessible projects, /:id +// asserts view, mutators assert edit, null-project recorders are admin-only. +// Same harness as assets-access.test.js — singleton pool on TEST_DATABASE_URL, +// req.user injected, router dynamic-imported. Skips without TEST_DATABASE_URL. +import { test } from 'node:test'; +import assert from 'node:assert/strict'; +import express from 'express'; +import { isTestDbConfigured, setupTestDb } from '../helpers/setup-db.js'; + +const SKIP = !isTestDbConfigured() && 'TEST_DATABASE_URL not set'; + +async function appWithRecorders(user) { + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + process.env.AUTH_ENABLED = 'true'; + const { default: recordersRouter } = await import('../../src/routes/recorders.js?v=' + Date.now()); + const app = express(); + app.use(express.json()); + app.use((req, _res, next) => { req.user = user; next(); }); + app.use('/api/v1/recorders', recordersRouter); + return new Promise(r => { + const srv = app.listen(0, '127.0.0.1', () => + r({ baseUrl: 'http://127.0.0.1:' + srv.address().port, close: () => new Promise(rs => srv.close(rs)) })); + }); +} + +async function seed(pool) { + const proj = async (n) => (await pool.query(`INSERT INTO projects (name, s3_prefix) VALUES ($1,$1) RETURNING id`, [n])).rows[0].id; + const alpha = await proj('Alpha'); + const beta = await proj('Beta'); + const rec = async (pid, name) => (await pool.query( + `INSERT INTO recorders (name, source_type, project_id) VALUES ($1, 'srt', $2) RETURNING id`, [name, pid])).rows[0].id; + const recA = await rec(alpha, 'Cam A'); + const recB = await rec(beta, 'Cam B'); + const recNull = (await pool.query( + `INSERT INTO recorders (name, source_type, project_id) VALUES ('Unassigned','srt',NULL) RETURNING id`)).rows[0].id; + const admin = { id: (await pool.query(`INSERT INTO users (username, password_hash, role) VALUES ('adm','x','admin') RETURNING id`)).rows[0].id, role: 'admin' }; + const scoped = { id: (await pool.query(`INSERT INTO users (username, password_hash, role) VALUES ('ed','x','editor') RETURNING id`)).rows[0].id, role: 'editor' }; + await pool.query(`INSERT INTO project_access (project_id, subject_type, subject_id, level) VALUES ($1,'user',$2,'view')`, [alpha, scoped.id]); + return { alpha, beta, recA, recB, recNull, admin, scoped }; +} + +test('recorders list is scoped; admin sees all incl. null-project, scoped sees only granted', { skip: SKIP }, async () => { + const pool = await setupTestDb(); + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + try { + const { recA, admin, scoped } = await seed(pool); + + let a = await appWithRecorders(admin); + let list = await (await fetch(a.baseUrl + '/api/v1/recorders')).json(); + assert.equal(list.length, 3, 'admin sees all three recorders'); + await a.close(); + + let s = await appWithRecorders(scoped); + list = await (await fetch(s.baseUrl + '/api/v1/recorders')).json(); + assert.deepEqual(list.map(r => r.id), [recA], 'scoped editor sees only the granted-project recorder'); + await s.close(); + } finally { await pool.end(); } +}); + +test('recorder /:id enforces view; mutators enforce edit', { skip: SKIP }, async () => { + const pool = await setupTestDb(); + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + try { + const { recA, recB, recNull, scoped } = await seed(pool); + const s = await appWithRecorders(scoped); + + // view-granted on Alpha: can GET recA, cannot GET recB (other project) or recNull (admin-only). + assert.equal((await fetch(s.baseUrl + '/api/v1/recorders/' + recA)).status, 200); + assert.equal((await fetch(s.baseUrl + '/api/v1/recorders/' + recB)).status, 403); + assert.equal((await fetch(s.baseUrl + '/api/v1/recorders/' + recNull)).status, 403); + + // view-only grant cannot PATCH (edit) or start. + const patch = await fetch(s.baseUrl + '/api/v1/recorders/' + recA, { + method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify({ name: 'x' }) }); + assert.equal(patch.status, 403, 'view-level grant must not allow edit'); + await s.close(); + } finally { await pool.end(); } +}); + +test('creating a recorder requires edit; null-project create is admin-only', { skip: SKIP }, async () => { + const pool = await setupTestDb(); + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + try { + const { alpha, admin, scoped } = await seed(pool); + + // scoped editor has only 'view' on Alpha → create denied. + let s = await appWithRecorders(scoped); + let r = await fetch(s.baseUrl + '/api/v1/recorders', { + method: 'POST', headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ name: 'New', source_type: 'srt', project_id: alpha }) }); + assert.equal(r.status, 403); + // null project → admin-only, still denied for the editor. + r = await fetch(s.baseUrl + '/api/v1/recorders', { + method: 'POST', headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ name: 'New2', source_type: 'srt' }) }); + assert.equal(r.status, 403); + await s.close(); + + // admin can create in any project and with no project. + let a = await appWithRecorders(admin); + r = await fetch(a.baseUrl + '/api/v1/recorders', { + method: 'POST', headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ name: 'AdminRec', source_type: 'srt' }) }); + assert.equal(r.status, 201); + await a.close(); + } finally { await pool.end(); } +}); diff --git a/services/mam-api/test/routes/sequences-access.test.js b/services/mam-api/test/routes/sequences-access.test.js new file mode 100644 index 0000000..6849977 --- /dev/null +++ b/services/mam-api/test/routes/sequences-access.test.js @@ -0,0 +1,103 @@ +// RBAC coverage for sequences: list/create assert on the query/body project, +// /:id asserts view, mutators assert edit. Skips without TEST_DATABASE_URL. +import { test } from 'node:test'; +import assert from 'node:assert/strict'; +import express from 'express'; +import { isTestDbConfigured, setupTestDb } from '../helpers/setup-db.js'; + +const SKIP = !isTestDbConfigured() && 'TEST_DATABASE_URL not set'; + +async function appWithSequences(user) { + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + process.env.AUTH_ENABLED = 'true'; + const { default: sequencesRouter } = await import('../../src/routes/sequences.js?v=' + Date.now()); + const app = express(); + app.use(express.json()); + app.use((req, _res, next) => { req.user = user; next(); }); + app.use('/api/v1/sequences', sequencesRouter); + return new Promise(r => { + const srv = app.listen(0, '127.0.0.1', () => + r({ baseUrl: 'http://127.0.0.1:' + srv.address().port, close: () => new Promise(rs => srv.close(rs)) })); + }); +} + +async function seed(pool) { + const proj = async (n) => (await pool.query(`INSERT INTO projects (name, s3_prefix) VALUES ($1,$1) RETURNING id`, [n])).rows[0].id; + const alpha = await proj('Alpha'); + const beta = await proj('Beta'); + const seqB = (await pool.query(`INSERT INTO sequences (project_id, name) VALUES ($1,'B seq') RETURNING id`, [beta])).rows[0].id; + const viewer = { id: (await pool.query(`INSERT INTO users (username, password_hash, role) VALUES ('vu','x','viewer') RETURNING id`)).rows[0].id, role: 'viewer' }; + const editor = { id: (await pool.query(`INSERT INTO users (username, password_hash, role) VALUES ('ed','x','editor') RETURNING id`)).rows[0].id, role: 'editor' }; + await pool.query(`INSERT INTO project_access (project_id, subject_type, subject_id, level) VALUES ($1,'user',$2,'view')`, [alpha, viewer.id]); + await pool.query(`INSERT INTO project_access (project_id, subject_type, subject_id, level) VALUES ($1,'user',$2,'edit')`, [alpha, editor.id]); + return { alpha, beta, seqB, viewer, editor }; +} + +const asset = (pool, pid, name) => pool.query( + `INSERT INTO assets (project_id, filename, display_name, media_type, status) VALUES ($1,$2,$2,'video','ready') RETURNING id`, + [pid, name]).then(r => r.rows[0].id); + +test('GET /sequences?project_id 403s on an ungranted project', { skip: SKIP }, async () => { + const pool = await setupTestDb(); + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + try { + const { alpha, beta, viewer } = await seed(pool); + const s = await appWithSequences(viewer); + assert.equal((await fetch(s.baseUrl + '/api/v1/sequences?project_id=' + alpha)).status, 200); + assert.equal((await fetch(s.baseUrl + '/api/v1/sequences?project_id=' + beta)).status, 403); + await s.close(); + } finally { await pool.end(); } +}); + +test('POST /sequences requires edit; viewer denied, editor allowed; /:id view enforced', { skip: SKIP }, async () => { + const pool = await setupTestDb(); + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + try { + const { alpha, seqB, viewer, editor } = await seed(pool); + + // viewer (view-only on Alpha) cannot create. + let s = await appWithSequences(viewer); + let r = await fetch(s.baseUrl + '/api/v1/sequences', { + method: 'POST', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify({ project_id: alpha, name: 'X' }) }); + assert.equal(r.status, 403); + // viewer cannot read a sequence in an ungranted project (Beta). + assert.equal((await fetch(s.baseUrl + '/api/v1/sequences/' + seqB)).status, 403); + await s.close(); + + // editor can create in Alpha and then PUT it. + let e = await appWithSequences(editor); + r = await fetch(e.baseUrl + '/api/v1/sequences', { + method: 'POST', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify({ project_id: alpha, name: 'Mine' }) }); + assert.equal(r.status, 201); + const seqId = (await r.json()).id; + const put = await fetch(e.baseUrl + '/api/v1/sequences/' + seqId, { + method: 'PUT', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify({ name: 'Renamed' }) }); + assert.equal(put.status, 200); + await e.close(); + } finally { await pool.end(); } +}); + +test('PUT /:id/clips rejects assets from outside the sequence project (cross-project leak guard)', { skip: SKIP }, async () => { + const pool = await setupTestDb(); + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + try { + const { alpha, beta, editor } = await seed(pool); + const seqA = (await pool.query(`INSERT INTO sequences (project_id, name) VALUES ($1,'A seq') RETURNING id`, [alpha])).rows[0].id; + const assetA = await asset(pool, alpha, 'a-clip'); + const assetB = await asset(pool, beta, 'b-clip'); // editor has NO access to project Beta + + const e = await appWithSequences(editor); + const clip = (aid) => ({ asset_id: aid, track: 0, timeline_in_frames: 0, timeline_out_frames: 10, source_in_frames: 0, source_out_frames: 10 }); + + // Same-project asset is accepted. + let r = await fetch(e.baseUrl + '/api/v1/sequences/' + seqA + '/clips', { + method: 'PUT', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify([clip(assetA)]) }); + assert.equal(r.status, 200); + + // Splicing in a Beta asset must be rejected — it would leak B's media via GET /:id. + r = await fetch(e.baseUrl + '/api/v1/sequences/' + seqA + '/clips', { + method: 'PUT', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify([clip(assetA), clip(assetB)]) }); + assert.equal(r.status, 400, 'foreign-project asset must be rejected'); + await e.close(); + } finally { await pool.end(); } +}); diff --git a/services/mam-api/test/routes/totp.test.js b/services/mam-api/test/routes/totp.test.js new file mode 100644 index 0000000..84f5c4c --- /dev/null +++ b/services/mam-api/test/routes/totp.test.js @@ -0,0 +1,143 @@ +// Integration test for the TOTP two-step login + recovery codes. +// +// Mounts the real auth router with a session store on the throwaway test DB. +// Drives: enroll (setup → enable) → logout → password login returns mfa_required +// → complete with a generated code → and the recovery-code single-use path. +// Skips when TEST_DATABASE_URL is unset. +import { test } from 'node:test'; +import assert from 'node:assert/strict'; +import express from 'express'; +import session from 'express-session'; +import { isTestDbConfigured, setupTestDb } from '../helpers/setup-db.js'; +import { hashPassword } from '../../src/auth/passwords.js'; +import { generateToken } from '../../src/auth/totp.js'; + +const SKIP = !isTestDbConfigured() && 'TEST_DATABASE_URL not set'; + +async function appWithAuth(pool) { + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + process.env.AUTH_ENABLED = 'true'; + process.env.SESSION_SECRET = 'test'; + const ConnectPg = (await import('connect-pg-simple')).default(session); + const { default: authRouter } = await import('../../src/routes/auth.js?v=' + Date.now()); + const app = express(); + app.use(express.json()); + app.use(session({ + store: new ConnectPg({ pool, tableName: 'sessions' }), + secret: 'test', name: 'dragonflight.sid', + cookie: { httpOnly: true, sameSite: 'lax', secure: false, maxAge: 8 * 3600 * 1000 }, + rolling: false, resave: false, saveUninitialized: false, + })); + app.use('/api/v1/auth', authRouter); + return new Promise(r => { + const srv = app.listen(0, '127.0.0.1', () => + r({ baseUrl: 'http://127.0.0.1:' + srv.address().port, close: () => new Promise(rs => srv.close(rs)) })); + }); +} + +const J = (cookie, body) => ({ + method: 'POST', + headers: { 'Content-Type': 'application/json', ...(cookie ? { cookie } : {}) }, + body: JSON.stringify(body), +}); + +async function loginPassword(baseUrl, username, password) { + const r = await fetch(baseUrl + '/api/v1/auth/login', J(null, { username, password })); + const cookie = (r.headers.get('set-cookie') || '').split(';')[0]; + return { r, body: await r.json().catch(() => ({})), cookie }; +} + +test('enable TOTP, then password login requires a second factor', { skip: SKIP }, async () => { + const pool = await setupTestDb(); + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + try { + await pool.query(`INSERT INTO users (username, password_hash) VALUES ('alice', $1)`, [await hashPassword('correct-horse-battery')]); + const { baseUrl, close } = await appWithAuth(pool); + + // 1. Password login (no TOTP yet) → 200 with a session cookie. + const first = await loginPassword(baseUrl, 'alice', 'correct-horse-battery'); + assert.equal(first.r.status, 200); + assert.ok(!first.body.mfa_required); + const cookie = first.cookie; + + // 2. Enroll: setup returns a secret; enable confirms with a live code. + const setup = await (await fetch(baseUrl + '/api/v1/auth/totp/setup', J(cookie, {}))).json(); + assert.match(setup.secret, /^[A-Z2-7]+$/); + const enableRes = await fetch(baseUrl + '/api/v1/auth/totp/enable', J(cookie, { code: generateToken(setup.secret) })); + assert.equal(enableRes.status, 200); + const enableBody = await enableRes.json(); + assert.equal(enableBody.enabled, true); + assert.equal(enableBody.recovery_codes.length, 10); + + // 3. Fresh password login now returns mfa_required + a ticket, NO session cookie. + const second = await loginPassword(baseUrl, 'alice', 'correct-horse-battery'); + assert.equal(second.r.status, 200); + assert.equal(second.body.mfa_required, true); + assert.ok(second.body.ticket); + assert.ok(!second.cookie, 'no session cookie should be set before the second factor'); + + // 4. Wrong code → 401; the ticket is now spent. + const bad = await fetch(baseUrl + '/api/v1/auth/login/totp', J(null, { ticket: second.body.ticket, code: '000000' })); + assert.equal(bad.status, 401); + + // 5. New login + correct code → 200 with a session cookie. + const third = await loginPassword(baseUrl, 'alice', 'correct-horse-battery'); + const ok = await fetch(baseUrl + '/api/v1/auth/login/totp', J(null, { ticket: third.body.ticket, code: generateToken(setup.secret) })); + assert.equal(ok.status, 200); + assert.match(ok.headers.get('set-cookie') || '', /dragonflight\.sid=/); + + await close(); + } finally { await pool.end(); } +}); + +test('a recovery code logs in once and cannot be reused', { skip: SKIP }, async () => { + const pool = await setupTestDb(); + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + try { + await pool.query(`INSERT INTO users (username, password_hash) VALUES ('bob', $1)`, [await hashPassword('correct-horse-battery')]); + const { baseUrl, close } = await appWithAuth(pool); + + const first = await loginPassword(baseUrl, 'bob', 'correct-horse-battery'); + const setup = await (await fetch(baseUrl + '/api/v1/auth/totp/setup', J(first.cookie, {}))).json(); + const enableBody = await (await fetch(baseUrl + '/api/v1/auth/totp/enable', J(first.cookie, { code: generateToken(setup.secret) }))).json(); + const recovery = enableBody.recovery_codes[0]; + + // Use a recovery code to complete a fresh login. + const login1 = await loginPassword(baseUrl, 'bob', 'correct-horse-battery'); + const use1 = await fetch(baseUrl + '/api/v1/auth/login/totp', J(null, { ticket: login1.body.ticket, code: recovery })); + assert.equal(use1.status, 200, 'recovery code should complete login once'); + + // The same recovery code must NOT work a second time. + const login2 = await loginPassword(baseUrl, 'bob', 'correct-horse-battery'); + const use2 = await fetch(baseUrl + '/api/v1/auth/login/totp', J(null, { ticket: login2.body.ticket, code: recovery })); + assert.equal(use2.status, 401, 'a spent recovery code must be rejected'); + + await close(); + } finally { await pool.end(); } +}); + +test('disable TOTP returns login to single-factor', { skip: SKIP }, async () => { + const pool = await setupTestDb(); + process.env.DATABASE_URL = process.env.TEST_DATABASE_URL; + try { + await pool.query(`INSERT INTO users (username, password_hash) VALUES ('carol', $1)`, [await hashPassword('correct-horse-battery')]); + const { baseUrl, close } = await appWithAuth(pool); + + const first = await loginPassword(baseUrl, 'carol', 'correct-horse-battery'); + const setup = await (await fetch(baseUrl + '/api/v1/auth/totp/setup', J(first.cookie, {}))).json(); + await fetch(baseUrl + '/api/v1/auth/totp/enable', J(first.cookie, { code: generateToken(setup.secret) })); + + // Disabling requires the password. + const wrongPw = await fetch(baseUrl + '/api/v1/auth/totp/disable', J(first.cookie, { password: 'nope' })); + assert.equal(wrongPw.status, 400); + const disabled = await fetch(baseUrl + '/api/v1/auth/totp/disable', J(first.cookie, { password: 'correct-horse-battery' })); + assert.equal(disabled.status, 204); + + // Password login is single-factor again. + const relog = await loginPassword(baseUrl, 'carol', 'correct-horse-battery'); + assert.equal(relog.r.status, 200); + assert.ok(!relog.body.mfa_required); + + await close(); + } finally { await pool.end(); } +}); diff --git a/services/node-agent/index.js b/services/node-agent/index.js index f21c896..18f5660 100644 --- a/services/node-agent/index.js +++ b/services/node-agent/index.js @@ -8,7 +8,16 @@ const NODE_ROLE = process.env.NODE_ROLE || 'worker'; const AGENT_PORT = parseInt(process.env.AGENT_PORT || '7436', 10); const HEARTBEAT_MS = parseInt(process.env.HEARTBEAT_MS || '30000', 10); const LIVE_DIR = process.env.LIVE_DIR || '/mnt/NVME/MAM/wild-dragon-live'; -const VERSION = '1.3.0'; +// Host path to the checked-out repo (onboard-node.sh clones to /opt/wild-dragon). +// The driver-install container bind-mounts this so install-driver.sh can read +// sdk// and run from deploy/. Overridable for non-standard layouts. +const REPO_DIR = process.env.REPO_DIR || '/opt/wild-dragon'; +const VERSION = '1.4.0'; + +// Capture-driver vendor allowlist. NOTHING outside this set is ever passed to +// the host installer — the value is only ever used to pick a script arg, never +// interpolated into a shell string. +const DRIVER_VENDORS = ['blackmagic', 'aja', 'deltacast', 'ndi']; // Pick the host's LAN IP. Inside a bridge-mode container, // os.networkInterfaces() returns the container's docker-bridge IP (172.x), @@ -93,6 +102,11 @@ async function handleSidecarStart(body, res) { // (ProRes, DNxHR, libx264) don't need it and it avoids a hard dep on the // NVIDIA container runtime on nodes that have no GPU. useGpu = false, + // Issue #167 — optional per-recorder GPU affinity. When set to a GPU + // UUID (e.g. "GPU-xxxx") or a numeric index, the sidecar is pinned to + // that single device via NVIDIA_VISIBLE_DEVICES instead of "all". null / + // undefined keeps the legacy "all" behavior (expose every GPU). + gpuUuid = null, } = body; const binds = [`${LIVE_DIR}:/live`]; @@ -109,11 +123,14 @@ async function handleSidecarStart(body, res) { // Build the sidecar environment, injecting NVIDIA vars when GPU is requested. const sidecarEnv = [...env, `PORT=${capturePort}`]; if (useGpu) { - // NVIDIA_VISIBLE_DEVICES=all exposes every GPU on the host. - // For a single-GPU node (zampp2 / L4) this is equivalent to pinning GPU 0. - // When we later store per-recorder GPU affinity in the DB we can pass a - // specific UUID here instead. - sidecarEnv.push('NVIDIA_VISIBLE_DEVICES=all'); + // Issue #167 — per-recorder GPU affinity. A gpuUuid (UUID string or + // numeric index) pins the sidecar to exactly that device; otherwise + // NVIDIA_VISIBLE_DEVICES=all exposes every GPU on the host (legacy + // behavior — for a single-GPU node like zampp2 / L4 this equals GPU 0). + const visibleDevices = (gpuUuid != null && String(gpuUuid).trim() !== '') + ? String(gpuUuid).trim() + : 'all'; + sidecarEnv.push(`NVIDIA_VISIBLE_DEVICES=${visibleDevices}`); sidecarEnv.push('NVIDIA_DRIVER_CAPABILITIES=video,compute,utility'); } @@ -227,6 +244,147 @@ async function handleSidecarStatus(containerId, res) { } } +// ── Agent auth ──────────────────────────────────────────────────────────── +// When NODE_TOKEN is configured, privileged control endpoints (driver install) +// require a matching `Authorization: Bearer `. mam-api forwards the +// node's stored token. If NODE_TOKEN is empty (dev), auth is not enforced. +function checkAgentAuth(req) { + if (!NODE_TOKEN) return true; + const hdr = req.headers['authorization'] || ''; + const m = /^Bearer\s+(.+)$/i.exec(hdr); + return !!m && m[1] === NODE_TOKEN; +} + +// ── Driver/SDK install ──────────────────────────────────────────────────── +// Probe host presence of each capture-driver vendor. Mirrors the detection the +// install script uses, so the UI can show "installed / not installed" without +// running the installer. Best-effort: every probe is guarded. +function probeDriverStatus() { + const out = {}; + + // blackmagic — kernel module + /dev/blackmagic device tree. + let bmLoaded = false; + try { bmLoaded = fs.readFileSync('/proc/modules', 'utf8').split('\n').some(l => /^blackmagic\b/.test(l)); } catch (_) {} + let bmDev = false; + try { bmDev = fs.existsSync('/dev/blackmagic') && fs.readdirSync('/dev/blackmagic').length > 0; } catch (_) {} + out.blackmagic = { installed: bmLoaded || bmDev, module_loaded: bmLoaded, device_present: bmDev }; + + // aja — ajantv2 kernel module. + let ajaLoaded = false; + try { ajaLoaded = fs.readFileSync('/proc/modules', 'utf8').split('\n').some(l => /ajantv2/.test(l)); } catch (_) {} + out.aja = { installed: ajaLoaded, module_loaded: ajaLoaded }; + + // deltacast — videomaster module or /dev/deltacast* node. + let dcLoaded = false; + try { dcLoaded = fs.readFileSync('/proc/modules', 'utf8').split('\n').some(l => /videomaster/.test(l)); } catch (_) {} + let dcDev = false; + try { dcDev = fs.readdirSync('/dev').some(n => /^deltacast\d+$/.test(n)); } catch (_) {} + out.deltacast = { installed: dcLoaded || dcDev, module_loaded: dcLoaded, device_present: dcDev }; + + // ndi — user-space libs only. Look in the install target + common lib dirs. + let ndiPresent = false; + try { + for (const dir of ['/opt/ndi-lib', '/usr/local/lib', '/usr/lib/x86_64-linux-gnu']) { + let entries = []; + try { entries = fs.readdirSync(dir); } catch (_) { continue; } + if (entries.some(n => /^libndi\.so/.test(n))) { ndiPresent = true; break; } + } + } catch (_) {} + out.ndi = { installed: ndiPresent, libs_present: ndiPresent }; + + return out; +} + +async function handleDriverStatus(res) { + try { + jsonResponse(res, 200, { kernel: os.release(), vendors: probeDriverStatus() }); + } catch (err) { + jsonResponse(res, 500, { error: err.message }); + } +} + +// Run install-driver.sh inside a one-shot PRIVILEGED ubuntu container. +// The repo is bind-mounted read-only at /repo; host kernel paths are mounted so +// dkms/modprobe/ldconfig affect the host. Logs are streamed back to the caller. +async function handleDriverInstall(body, res) { + const vendor = String(body?.vendor || '').toLowerCase(); + if (!DRIVER_VENDORS.includes(vendor)) { + return jsonResponse(res, 400, { error: `Invalid vendor (allowed: ${DRIVER_VENDORS.join(', ')})` }); + } + + let containerId; + try { + // Host paths the installer needs to reach the host kernel: + // /lib/modules,/usr/src,/boot → DKMS / module build + install + // /dev → device-node visibility + udev + // The repo (sdk// + deploy/install-driver.sh) is mounted read-only. + const binds = [ + `${REPO_DIR}:/repo:ro`, + '/lib/modules:/lib/modules', + '/usr/src:/usr/src', + '/boot:/boot', + '/dev:/dev', + // NDI install target lives under /opt; expose host /opt so libs land on host. + '/opt:/opt', + ]; + + const spec = { + Image: 'ubuntu:22.04', + // NOTE: vendor is a value from DRIVER_VENDORS only — never arbitrary input. + // Passed as a distinct argv element (Cmd array), not a shell string. + Cmd: ['bash', '/repo/deploy/install-driver.sh', vendor], + Env: [`REPO_DIR=/repo`], + WorkingDir: '/repo', + HostConfig: { + Privileged: true, + NetworkMode: 'host', + Binds: binds, + AutoRemove: false, + }, + }; + + const createRes = await dockerApi('POST', '/containers/create', spec); + if (createRes.status !== 201) { + return jsonResponse(res, 502, { error: 'Failed to create install container', details: createRes.data }); + } + containerId = createRes.data.Id; + console.log(`[driver-install] ${containerId} vendor=${vendor}`); + + const startRes = await dockerApi('POST', `/containers/${containerId}/start`); + if (startRes.status !== 204) { + await dockerApi('DELETE', `/containers/${containerId}?force=true`).catch(() => {}); + return jsonResponse(res, 502, { error: 'Failed to start install container', details: startRes.data }); + } + + // Wait for the install to finish (DKMS builds can take a minute+). + let exitCode = null; + for (let i = 0; i < 600; i++) { + await new Promise(r => setTimeout(r, 1000)); + const inspect = await dockerApi('GET', `/containers/${containerId}/json`); + const state = inspect.data?.State; + if (state && !state.Running) { exitCode = state.ExitCode; break; } + } + + const logs = await fetchContainerLogs(containerId); + const rebootRequired = /REBOOT_REQUIRED=1/.test(logs); + const ok = exitCode === 0; + jsonResponse(res, ok ? 200 : 500, { + ok, + vendor, + exitCode, + rebootRequired, + logs, + status: probeDriverStatus()[vendor] || null, + }); + } catch (err) { + jsonResponse(res, 500, { error: err.message }); + } finally { + if (containerId) { + await dockerApi('DELETE', `/containers/${containerId}?force=true`).catch(() => {}); + } + } +} + // ── CPU sampling (500ms window) ─────────────────────────────────────────── function sampleCpu() { return new Promise(resolve => { @@ -247,21 +405,39 @@ function sampleCpu() { } -// -- Live GPU utilization sampling ----------------------------------------- +// -- Live GPU / NVENC encode telemetry sampling ----------------------------- // Spawns a short-lived nvidia container via Docker API on each heartbeat call. -// Returns array of { index, util_pct, mem_used_mb, mem_total_mb } per GPU, -// or [] if no GPUs / nvidia runtime unavailable. +// Returns array of { index, util_pct, enc_util_pct, mem_used_mb, mem_total_mb, +// nvenc_sessions } per GPU, or [] if no GPUs / nvidia runtime unavailable. +// +// Two nvidia-smi queries are run inside one container via `sh -c`, each guarded +// with `|| true` so a query unsupported on a given driver/GPU (e.g. older cards +// that don't expose utilization.encoder) doesn't abort the whole sample: +// 1. --query-gpu → per-GPU gpu/encoder util + memory +// 2. --query-compute-apps → pid,used_memory,gpu_uuid for live processes; we +// count rows per GPU as an NVENC/compute "session" approximation. Marked +// with a SEP line so the two CSV blocks can be told apart in the log. async function sampleGpuUtil() { if (!_gpuCache || _gpuCache.length === 0) return []; - const QUERY = '--query-gpu=index,utilization.gpu,memory.used,memory.total'; - const FMT = '--format=csv,noheader,nounits'; + const GPU_QUERY = '--query-gpu=index,utilization.gpu,utilization.encoder,memory.used,memory.total'; + const APP_QUERY = '--query-compute-apps=gpu_uuid,pid,used_memory'; + const FMT = '--format=csv,noheader,nounits'; + // Map GPU index → uuid so compute-app rows (keyed by uuid) attach to a GPU. + const UUID_QUERY = '--query-gpu=index,uuid'; + const SCRIPT = [ + `nvidia-smi ${GPU_QUERY} ${FMT} || true`, + `echo '---SEP-APPS---'`, + `nvidia-smi ${APP_QUERY} ${FMT} 2>/dev/null || true`, + `echo '---SEP-UUID---'`, + `nvidia-smi ${UUID_QUERY} ${FMT} 2>/dev/null || true`, + ].join('; '); let containerId; try { const createRes = await dockerApi('POST', '/containers/create', { Image: 'ubuntu:22.04', - Cmd: ['nvidia-smi', QUERY, FMT], + Cmd: ['sh', '-c', SCRIPT], HostConfig: { AutoRemove: false, Runtime: 'nvidia', @@ -295,11 +471,46 @@ async function sampleGpuUtil() { }); const text = logRes.replace(/[\x00-\x07].{7}/g, '').trim(); - const lines = text.split('\n').filter(l => /^\d+,/.test(l.trim())); + const [gpuBlock = '', appBlock = '', uuidBlock = ''] = + text.split(/---SEP-(?:APPS|UUID)---/); + + // uuid → index map (for attributing compute-app rows to a GPU) + const uuidToIndex = {}; + uuidBlock.split('\n').forEach(l => { + const m = l.trim().match(/^(\d+)\s*,\s*(GPU-[0-9a-fA-F-]+)/); + if (m) uuidToIndex[m[2]] = parseInt(m[1], 10); + }); + + // NVENC/compute session count per GPU index (best-effort). + const sessionsByIndex = {}; + appBlock.split('\n').forEach(l => { + const parts = l.split(',').map(s => s.trim()); + const uuid = parts[0]; + if (!uuid || !uuid.startsWith('GPU-')) return; + const idx = uuidToIndex[uuid]; + if (idx == null) return; + sessionsByIndex[idx] = (sessionsByIndex[idx] || 0) + 1; + }); + + const lines = gpuBlock.split('\n').filter(l => /^\s*\d+\s*,/.test(l)); return lines.map(line => { - const [idx, util, memUsed, memTotal] = line.split(',').map(s => parseInt(s.trim(), 10)); - return { index: idx, util_pct: util, mem_used_mb: memUsed, mem_total_mb: memTotal }; + // utilization.encoder may report "[N/A]" on cards/drivers that don't + // expose it — parseInt yields NaN there, which we coerce to null. + const cols = line.split(',').map(s => s.trim()); + const idx = parseInt(cols[0], 10); + const util = parseInt(cols[1], 10); + const encUtil = parseInt(cols[2], 10); + const memUsed = parseInt(cols[3], 10); + const memTotal = parseInt(cols[4], 10); + return { + index: idx, + util_pct: Number.isNaN(util) ? null : util, + enc_util_pct: Number.isNaN(encUtil) ? null : encUtil, + mem_used_mb: Number.isNaN(memUsed) ? null : memUsed, + mem_total_mb: Number.isNaN(memTotal) ? null : memTotal, + nvenc_sessions: sessionsByIndex[idx] || 0, + }; }); } catch (err) { console.warn('[gpu-util] sampling failed:', err.message); @@ -480,6 +691,25 @@ async function heartbeat() { const ip_address = getIp(); const capabilities = detectHardware(); + // Issue #166 — fold live NVENC/GPU encode telemetry into capabilities.gpus so + // the Cluster screen (which reads cluster_nodes.capabilities.gpus) can render + // per-GPU util / encoder util / NVENC sessions alongside the static name+VRAM. + // gpu_util is also sent verbatim below for any consumer reading metrics.gpus. + if (Array.isArray(capabilities.gpus) && gpu_util.length) { + capabilities.gpus = capabilities.gpus.map(g => { + const live = gpu_util.find(u => u.index === g.index); + if (!live) return g; + return { + ...g, + util_pct: live.util_pct, + enc_util_pct: live.enc_util_pct, + mem_used_mb: live.mem_used_mb, + mem_total_mb: live.mem_total_mb ?? g.memory_mb ?? null, + nvenc_sessions: live.nvenc_sessions, + }; + }); + } + const payload = { hostname: os.hostname(), ip_address, @@ -572,6 +802,16 @@ const server = http.createServer((req, res) => { const id = pathname.slice('/sidecar/'.length, -'/status'.length); handleSidecarStatus(id, res); + } else if (req.method === 'GET' && pathname === '/driver/status') { + if (!checkAgentAuth(req)) return jsonResponse(res, 401, { error: 'Unauthorized' }); + handleDriverStatus(res); + + } else if (req.method === 'POST' && pathname === '/driver/install') { + if (!checkAgentAuth(req)) return jsonResponse(res, 401, { error: 'Unauthorized' }); + readBody(req) + .then(body => handleDriverInstall(body, res)) + .catch(() => jsonResponse(res, 400, { error: 'Invalid request body' })); + } else if (req.method === 'GET' && pathname.startsWith('/live/')) { serveLiveFile(pathname, res); diff --git a/services/playout/Dockerfile b/services/playout/Dockerfile new file mode 100644 index 0000000..5b29ac2 --- /dev/null +++ b/services/playout/Dockerfile @@ -0,0 +1,102 @@ +# Wild Dragon Playout sidecar — CasparCG Server + Node AMCP control shim. +# +# CasparCG's mixer needs an OpenGL context. On a node with a real GPU we'd pass +# the device + driver through; for the headless / no-GPU case we run a virtual +# framebuffer (Xvfb) so the GL context initialises. The container is launched +# --privileged by mam-api (same as capture) so DeckLink / NDI hardware is +# reachable when present. +# +# CasparCG 2.4.x no longer ships a self-contained Linux tarball — the GitHub +# release provides either Ubuntu .deb packages or an "ubuntu22" zip that bundles +# the binary + its .so files under bin/ and lib/. We use the zip on an +# ubuntu:22.04 base so the bundled libs match the host glibc/abi, then install +# Node 20 from NodeSource on top. +# +# NDI + DeckLink SDKs are NOT redistributable. They are fetched at build time +# from a URL supplied as a build arg (mirror it into your own artifact store); +# the build still succeeds without it (NDI/DeckLink consumers simply won't be +# available — SRT/RTMP/test output still work). + +FROM ubuntu:22.04 + +ARG CASPAR_VERSION=2.4.0-stable +ARG CASPAR_URL=https://github.com/CasparCG/server/releases/download/v2.4.0-stable/casparcg-server-v2.4.0-stable-ubuntu22.zip +ARG NDI_SDK_URL= + +ENV DEBIAN_FRONTEND=noninteractive + +# CasparCG 2.4 runtime deps + Xvfb for headless GL + CEF (HTML producer) deps + +# Node 20 (NodeSource). +# +# NOTE: we deliberately do NOT `apt-get install ffmpeg`. That package drags in +# ~80 transitive shared libraries (libav*, libx264, libdrm, libva, ...) that +# perturb CasparCG 2.4.0's runtime linking and make its headless startup abort +# with SIGABRT (exit 134) on nearly every launch. A self-contained STATIC +# ffmpeg binary (installed below) gives us the standalone CLI the preview +# re-muxer needs with ZERO new shared libs, keeping CasparCG's environment +# identical to the known-good image. +RUN apt-get update && apt-get install -y --no-install-recommends \ + ca-certificates curl unzip tar xz-utils gnupg \ + xvfb libgl1-mesa-dri libglu1-mesa fonts-dejavu-core \ + libnss3 libnspr4 libatk1.0-0 libatk-bridge2.0-0 libcups2 libdrm2 \ + libxkbcommon0 libxcomposite1 libxdamage1 libxfixes3 libxrandr2 \ + libgbm1 libpango-1.0-0 libcairo2 libasound2 libatspi2.0-0 \ + && mkdir -p /etc/apt/keyrings \ + && curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key \ + | gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg \ + && echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_20.x nodistro main" \ + > /etc/apt/sources.list.d/nodesource.list \ + && apt-get update && apt-get install -y --no-install-recommends nodejs \ + && rm -rf /var/lib/apt/lists/* + +# ── Standalone STATIC ffmpeg CLI (for the HLS preview re-muxer) ─────────────── +# john van sickle's static build is fully self-contained (no shared-lib deps), +# so it can't perturb CasparCG's runtime linking. Override FFMPEG_URL to mirror +# this into your own artifact store if upstream availability is a concern. +ARG FFMPEG_URL=https://johnvansickle.com/ffmpeg/releases/ffmpeg-release-amd64-static.tar.xz +RUN set -eux; \ + curl -fsSL "$FFMPEG_URL" -o /tmp/ffmpeg.tar.xz; \ + mkdir -p /tmp/ffmpeg; \ + tar xJf /tmp/ffmpeg.tar.xz -C /tmp/ffmpeg --strip-components=1; \ + cp /tmp/ffmpeg/ffmpeg /tmp/ffmpeg/ffprobe /usr/local/bin/; \ + chmod +x /usr/local/bin/ffmpeg /usr/local/bin/ffprobe; \ + rm -rf /tmp/ffmpeg /tmp/ffmpeg.tar.xz; \ + /usr/local/bin/ffmpeg -version | head -1 + +# ── CasparCG Server (ubuntu22 zip bundle) ──────────────────────────────────── +# The zip extracts to /opt/casparcg_server with the binary at bin/casparcg and +# its bundled .so files under lib/ (added to LD_LIBRARY_PATH by entrypoint.sh). +# Symlink to /opt/casparcg so the config/entrypoint paths stay stable. +WORKDIR /tmp/caspar +RUN set -eux; \ + curl -fsSL "$CASPAR_URL" -o caspar.zip; \ + unzip -q caspar.zip -d /opt; \ + chmod +x /opt/casparcg_server/bin/casparcg /opt/casparcg_server/scanner 2>/dev/null || true; \ + ls /opt/casparcg_server/; \ + test -x /opt/casparcg_server/bin/casparcg; \ + ln -sfn /opt/casparcg_server /opt/casparcg; \ + echo "caspar binary: /opt/casparcg_server/bin/casparcg"; \ + cd /; rm -rf /tmp/caspar + +RUN if [ -n "$NDI_SDK_URL" ]; then \ + mkdir -p /opt/ndi-lib && \ + curl -fsSL "$NDI_SDK_URL" -o /tmp/ndi.tar.gz && \ + tar xzf /tmp/ndi.tar.gz -C /tmp && \ + find /tmp -name 'libndi*.so*' -exec cp -a {} /opt/ndi-lib/ \; && \ + rm -f /tmp/ndi.tar.gz && ldconfig /opt/ndi-lib || true; \ + fi +ENV NDI_RUNTIME_DIR_V6=/opt/ndi-lib + +RUN mkdir -p /media + +WORKDIR /app +COPY package*.json ./ +RUN npm install --omit=dev +COPY . . + +COPY casparcg.config /opt/casparcg/casparcg.config +COPY entrypoint.sh /entrypoint.sh +RUN chmod +x /entrypoint.sh + +EXPOSE 3002 5250 +ENTRYPOINT ["/entrypoint.sh"] diff --git a/services/playout/casparcg.config b/services/playout/casparcg.config new file mode 100644 index 0000000..5fc806a --- /dev/null +++ b/services/playout/casparcg.config @@ -0,0 +1,22 @@ + + + + /media/ + /media/casparcg/log/ + /media/casparcg/data/ + /media/templates/ + + + + 1080i5994 + + + + + + + 5250 + AMCP + + + diff --git a/services/playout/entrypoint.sh b/services/playout/entrypoint.sh new file mode 100644 index 0000000..7450abb --- /dev/null +++ b/services/playout/entrypoint.sh @@ -0,0 +1,57 @@ +#!/usr/bin/env bash +set -euo pipefail + +if [ -z "${DISPLAY:-}" ]; then + echo "[entrypoint] starting Xvfb on :99" + Xvfb :99 -screen 0 1920x1080x24 -nolisten tcp & + export DISPLAY=:99 + for i in $(seq 1 20); do + [ -e /tmp/.X11-unix/X99 ] && break + sleep 0.25 + done +fi + +# Ensure the HLS preview directory exists before the re-mux ffmpeg writes to it +# (mam-api serves /live//* from the shared media volume). +if [ -n "${CHANNEL_ID:-}" ]; then + mkdir -p "/media/live/${CHANNEL_ID}" +fi + +mkdir -p /media/casparcg/log /media/casparcg/data /media/templates + +# CEF (HTML producer) initialises an NSS database at /root/.pki/nssdb and +# Chrome caches under HOME. Pre-create writable dirs so CEF doesn't SIGABRT +# ~30s into the run when it first lazily inits. +mkdir -p /root/.pki/nssdb /root/.cache /tmp/cef-cache +chmod 700 /root/.pki/nssdb +export HOME=/root + +# 2.4.x zip bundles its own .so files under lib/ — add to LD_LIBRARY_PATH. +export LD_LIBRARY_PATH="/opt/casparcg/lib${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}" + +cd /opt/casparcg +CASPAR_CFG=/opt/casparcg/casparcg.config +# 2.4.x: binary at bin/casparcg. 2.5.x: symlinked to casparcg at root. +if [ -x "./bin/casparcg" ]; then CASPAR_BIN="./bin/casparcg"; +elif [ -x "./casparcg" ]; then CASPAR_BIN="./casparcg"; +elif [ -x "./CasparCG Server" ]; then CASPAR_BIN="./CasparCG Server"; +elif command -v casparcg >/dev/null; then CASPAR_BIN="casparcg"; +else echo "[entrypoint] ERROR: casparcg binary not found"; exit 1; fi +echo "[entrypoint] launching CasparCG: $CASPAR_BIN $CASPAR_CFG" +"$CASPAR_BIN" "$CASPAR_CFG" & +CASPAR_PID=$! + +term() { + echo "[entrypoint] terminating CasparCG ($CASPAR_PID)" + kill -TERM "$CASPAR_PID" 2>/dev/null || true + wait "$CASPAR_PID" 2>/dev/null || true + exit 0 +} +trap term SIGTERM SIGINT + +cd /app +node src/index.js & +NODE_PID=$! + +wait -n "$CASPAR_PID" "$NODE_PID" +term diff --git a/services/playout/package.json b/services/playout/package.json new file mode 100644 index 0000000..fff4480 --- /dev/null +++ b/services/playout/package.json @@ -0,0 +1,18 @@ +{ + "name": "wild-dragon-playout", + "version": "1.0.0", + "description": "Wild Dragon MAM playout sidecar — wraps a CasparCG Server instance and drives it over AMCP for master-control playout (SDI / NDI / SRT / RTMP).", + "type": "module", + "main": "src/index.js", + "scripts": { + "start": "node src/index.js" + }, + "engines": { + "node": ">=18" + }, + "dependencies": { + "express": "^4.18.0", + "cors": "^2.8.0", + "dotenv": "^16.4.0" + } +} diff --git a/services/playout/src/amcp.js b/services/playout/src/amcp.js new file mode 100644 index 0000000..d60754a --- /dev/null +++ b/services/playout/src/amcp.js @@ -0,0 +1,182 @@ +import net from 'node:net'; + +// Minimal AMCP (Advanced Media Control Protocol) client for CasparCG. +// +// AMCP is a line-based TCP protocol: each command is a single CRLF-terminated +// line, and the server replies with a status line ("201 PLAY OK\r\n") optionally +// followed by data lines. We keep one persistent socket per CasparCG instance +// and serialize commands through a FIFO queue — CasparCG processes one command +// at a time per connection, so interleaving replies would otherwise be +// ambiguous. +// +// We only implement the subset the playout sidecar needs (PLAY / LOADBG / STOP / +// CLEAR / INFO / ADD / REMOVE). Responses are returned raw; callers parse the +// status code where they care. + +const CRLF = '\r\n'; + +export class AmcpClient { + constructor({ host = '127.0.0.1', port = 5250 } = {}) { + this.host = host; + this.port = port; + this.socket = null; + this.connected = false; + this._buffer = ''; + this._queue = []; // pending { command, resolve, reject, timer } + this._active = null; // command currently awaiting a reply + this._reconnectTimer = null; + } + + connect() { + if (this.socket) return; + const socket = net.createConnection({ host: this.host, port: this.port }); + socket.setEncoding('utf8'); + socket.setKeepAlive(true, 10000); + + socket.on('connect', () => { + this.connected = true; + console.log(`[amcp] connected to ${this.host}:${this.port}`); + }); + socket.on('data', (chunk) => this._onData(chunk)); + socket.on('error', (err) => { + console.error(`[amcp] socket error: ${err.message}`); + }); + socket.on('close', () => { + this.connected = false; + this.socket = null; + // Fail any in-flight + queued commands so callers don't hang. + const pending = this._active ? [this._active, ...this._queue] : [...this._queue]; + this._active = null; + this._queue = []; + for (const p of pending) { + clearTimeout(p.timer); + p.reject(new Error('AMCP connection closed')); + } + this._scheduleReconnect(); + }); + + this.socket = socket; + } + + _scheduleReconnect() { + if (this._reconnectTimer) return; + this._reconnectTimer = setTimeout(() => { + this._reconnectTimer = null; + console.log('[amcp] reconnecting...'); + this.connect(); + }, 2000); + } + + // Wait until the socket is usable, up to timeoutMs. + async waitReady(timeoutMs = 30000) { + const deadline = Date.now() + timeoutMs; + while (Date.now() < deadline) { + if (this.connected) return true; + if (!this.socket) this.connect(); + await new Promise((r) => setTimeout(r, 250)); + } + throw new Error('AMCP not ready within timeout'); + } + + _onData(chunk) { + this._buffer += chunk; + // A CasparCG reply is a status line, optionally followed by data lines. + // The simplest robust framing: a command's reply is complete when we see a + // status line AND (for 2-line "200" multi-line replies) the terminating + // blank line. For our command subset, single-status-line replies dominate; + // we treat a reply as complete at each newline and let the active command + // decide whether it has enough. To keep this correct for INFO (multi-line), + // we accumulate until the buffer ends with a known terminator. + if (!this._active) { + // Unsolicited data (e.g. connection banner) — discard. + this._buffer = ''; + return; + } + // CasparCG ends multi-line replies with CRLF on an empty line. Single-line + // replies (201/202/4xx/5xx) end with a single CRLF. Resolve when we have at + // least one complete line; for "200 ... OK" (list follows) wait for the + // blank-line terminator. + const firstLineEnd = this._buffer.indexOf(CRLF); + if (firstLineEnd === -1) return; + const statusLine = this._buffer.slice(0, firstLineEnd); + const code = parseInt(statusLine, 10); + + if (code === 200) { + // Multi-line: data lines until an empty line. + const term = this._buffer.indexOf(CRLF + CRLF); + if (term === -1) return; // wait for more + const full = this._buffer.slice(0, term); + this._buffer = this._buffer.slice(term + 4); + this._finishActive(null, full); + return; + } + + if (code === 201 || code === 202) { + // 201: one data line follows the status line. 202: status only. + if (code === 201) { + const secondLineEnd = this._buffer.indexOf(CRLF, firstLineEnd + 2); + if (secondLineEnd === -1) return; + const full = this._buffer.slice(0, secondLineEnd); + this._buffer = this._buffer.slice(secondLineEnd + 2); + this._finishActive(null, full); + } else { + const full = this._buffer.slice(0, firstLineEnd); + this._buffer = this._buffer.slice(firstLineEnd + 2); + this._finishActive(null, full); + } + return; + } + + // 4xx / 5xx error, or any other single-line status. + const full = this._buffer.slice(0, firstLineEnd); + this._buffer = this._buffer.slice(firstLineEnd + 2); + if (code >= 400) this._finishActive(new Error(`AMCP error: ${full}`), full); + else this._finishActive(null, full); + } + + _finishActive(err, data) { + const active = this._active; + this._active = null; + if (active) { + clearTimeout(active.timer); + if (err) active.reject(err); + else active.resolve(data); + } + this._pump(); + } + + _pump() { + if (this._active || this._queue.length === 0) return; + const next = this._queue.shift(); + this._active = next; + try { + this.socket.write(next.command + CRLF); + } catch (err) { + this._active = null; + clearTimeout(next.timer); + next.reject(err); + } + } + + // Send a single AMCP command and resolve with the raw reply string. + send(command, { timeoutMs = 15000 } = {}) { + return new Promise((resolve, reject) => { + const entry = { command, resolve, reject, timer: null }; + entry.timer = setTimeout(() => { + // Drop from queue if still pending; if active, detach so the next + // reply doesn't get misrouted. + if (this._active === entry) this._active = null; + else this._queue = this._queue.filter((e) => e !== entry); + reject(new Error(`AMCP command timed out: ${command}`)); + }, timeoutMs); + this._queue.push(entry); + this._pump(); + }); + } + + close() { + if (this._reconnectTimer) { clearTimeout(this._reconnectTimer); this._reconnectTimer = null; } + if (this.socket) { try { this.socket.destroy(); } catch (_) {} this.socket = null; } + this.connected = false; + } +} diff --git a/services/playout/src/index.js b/services/playout/src/index.js new file mode 100644 index 0000000..646f18e --- /dev/null +++ b/services/playout/src/index.js @@ -0,0 +1,99 @@ +import express from 'express'; +import cors from 'cors'; +import dotenv from 'dotenv'; +import playoutManager from './playout-manager.js'; + +dotenv.config(); + +const app = express(); +const PORT = process.env.PORT || 3002; + +app.use(cors()); +app.use(express.json()); + +app.get('/health', (req, res) => res.json({ status: 'ok' })); + +// Start the channel's output consumer. Body: { outputType, outputConfig, videoFormat } +app.post('/channel/start', async (req, res) => { + try { + const out = await playoutManager.startChannel(req.body || {}); + res.json(out); + } catch (err) { + console.error('[playout] /channel/start error:', err.message); + res.status(500).json({ error: err.message }); + } +}); + +app.post('/channel/stop', async (req, res) => { + try { res.json(await playoutManager.stopChannel()); } + catch (err) { res.status(500).json({ error: err.message }); } +}); + +// Load + start a playlist. Body: { items: [...], loop } +app.post('/playlist/load', async (req, res) => { + try { + const { items = [], loop = false } = req.body || {}; + res.json(await playoutManager.loadPlaylist({ items, loop })); + } catch (err) { + console.error('[playout] /playlist/load error:', err.message); + res.status(500).json({ error: err.message }); + } +}); + +app.post('/transport/skip', async (req, res) => { try { res.json(await playoutManager.skip()); } catch (e) { res.status(500).json({ error: e.message }); } }); +app.post('/transport/pause', async (req, res) => { try { res.json(await playoutManager.pause()); } catch (e) { res.status(500).json({ error: e.message }); } }); +app.post('/transport/resume', async (req, res) => { try { res.json(await playoutManager.resume()); } catch (e) { res.status(500).json({ error: e.message }); } }); + +// Fire an SCTE-35 ad-break splice on the live output. Body: +// { eventId, type: 'splice_insert'|'immediate'|'splice_out'|'splice_in', durationS } +// Returns the active-break descriptor (or the splice_in ack) so the mam-api can +// stamp the as-run log. +app.post('/scte/trigger', (req, res) => { + try { + const { eventId = 1, type = 'splice_insert', durationS = 30 } = req.body || {}; + res.json(playoutManager.triggerScte({ eventId, type, durationS })); + } catch (err) { + console.error('[playout] /scte/trigger error:', err.message); + res.status(500).json({ error: err.message }); + } +}); + +app.get('/status', (req, res) => res.json(playoutManager.getStatus())); + +// Auto-start: when the sidecar is spawned by mam-api with channel env, bring up +// the output consumer immediately so the container is "on air idle" (black/slate) +// the moment it boots, mirroring the capture sidecar's bootstrap pattern. +async function bootstrap() { + const outputType = process.env.OUTPUT_TYPE; + if (!outputType) { + console.log('[bootstrap] no OUTPUT_TYPE — on-demand sidecar, waiting for /channel/start'); + return; + } + let outputConfig = {}; + try { outputConfig = JSON.parse(process.env.OUTPUT_CONFIG || '{}'); } + catch (err) { console.error('[bootstrap] bad OUTPUT_CONFIG json:', err.message); } + const videoFormat = process.env.VIDEO_FORMAT || '1080i5994'; + try { + await playoutManager.startChannel({ outputType, outputConfig, videoFormat }); + } catch (err) { + console.error('[bootstrap] channel start failed:', err.message); + } +} + +const server = app.listen(PORT, () => { + console.log(`Wild Dragon Playout Service listening on port ${PORT}`); + // Give CasparCG a moment to come up (started by the container entrypoint). + playoutManager.amcp.connect(); + bootstrap(); +}); + +function shutdown(sig) { + console.log(`[playout] ${sig} — shutting down`); + playoutManager.stopChannel().catch(() => {}).finally(() => { + playoutManager.amcp.close(); + server.close(() => process.exit(0)); + setTimeout(() => process.exit(0), 5000); + }); +} +process.on('SIGTERM', () => shutdown('SIGTERM')); +process.on('SIGINT', () => shutdown('SIGINT')); diff --git a/services/playout/src/playout-manager.js b/services/playout/src/playout-manager.js new file mode 100644 index 0000000..9c63512 --- /dev/null +++ b/services/playout/src/playout-manager.js @@ -0,0 +1,551 @@ +import { AmcpClient } from './amcp.js'; +import { spawn } from 'node:child_process'; +import { mkdirSync, readdirSync, unlinkSync } from 'node:fs'; + +// Playout manager — owns one CasparCG channel's lifecycle inside this sidecar. +// +// One sidecar container == one CasparCG Server == one logical channel (channel +// index 1 in CasparCG terms). We add the output consumer (DeckLink / NDI / SRT +// / RTMP) at start, then walk a playlist by cueing the next clip on a background +// layer (LOADBG ... AUTO) so CasparCG performs a gapless transition at end of +// the current clip. +// +// Media is referenced by a path relative to CasparCG's configured media folder +// (/media inside the container). The mam-api stages assets from S3 to that +// shared volume and passes the resolved relative path on each item. + +const CHANNEL = 1; // single CasparCG channel per sidecar +const FG_LAYER = 10; // foreground (on-air) layer +const MEDIA_ROOT = process.env.CASPAR_MEDIA_ROOT || '/media'; + +// Channel-id-derived HLS preview path. The mam-api proxies /live// +// to this directory (shared media volume) so the UI's existing HLS player +// (capture's /live/ plumbing) works for playout monitors with zero new +// transport. +const CHANNEL_ID = process.env.CHANNEL_ID || ''; +const HLS_DIR = CHANNEL_ID ? `${MEDIA_ROOT}/live/${CHANNEL_ID}` : ''; + +// Loopback UDP port CasparCG's preview STREAM consumer publishes mpegts to, and +// the standalone ffmpeg re-muxer reads from. One CasparCG per sidecar, so a +// fixed port is fine; allow override for parallel local testing. +const PREVIEW_UDP_PORT = parseInt(process.env.PREVIEW_UDP_PORT || '9710', 10); +const PREVIEW_UDP_URL = `udp://127.0.0.1:${PREVIEW_UDP_PORT}`; + +// CasparCG SEEK / LENGTH are in frames, not seconds. Capture standard is 59.94; +// SD/film modes need their own values. Default 60000/1001 matches both +// '1080p5994' and '1080i5994'. +function fpsFor(videoFormat) { + const f = String(videoFormat || '').toLowerCase(); + if (f.endsWith('5994')) return 60000 / 1001; + if (f.endsWith('p60') || f.endsWith('i60')) return 60; + if (f.endsWith('p50') || f.endsWith('i50')) return 50; + if (f.endsWith('2997')) return 30000 / 1001; + if (f.endsWith('p30')) return 30; + if (f.endsWith('p25')) return 25; + if (f.endsWith('p24') || f.endsWith('2398')) return 24000 / 1001; + return 60000 / 1001; // safe default for the house standard +} + +// CasparCG transition syntax fragments keyed by our item.transition value. +function transitionArgs(transition, ms, fps) { + if (!transition || transition === 'cut' || !ms) return ''; + const frames = Math.max(1, Math.round((ms / 1000) * fps)); + if (transition === 'mix') return ` MIX ${frames}`; + if (transition === 'wipe') return ` WIPE ${frames}`; + return ''; +} + +// Turn an absolute /media path (or a relative one) into the token CasparCG +// expects: a path relative to MEDIA_ROOT, without extension, forward-slashed. +// CasparCG resolves "subdir/clip" against its media folder + probes extensions. +function toCasparToken(mediaPath) { + let p = String(mediaPath || ''); + if (p.startsWith(MEDIA_ROOT)) p = p.slice(MEDIA_ROOT.length); + p = p.replace(/^\/+/, ''); + p = p.replace(/\.[^/.]+$/, ''); // strip extension + return p; +} + +export class PlayoutManager { + constructor() { + this.amcp = new AmcpClient({ + host: process.env.CASPAR_HOST || '127.0.0.1', + port: parseInt(process.env.CASPAR_PORT || '5250', 10), + }); + this.state = { + running: false, + outputType: null, + outputConfig: null, + videoFormat: null, + playlist: [], // resolved items in play order + currentIndex: -1, + loop: false, + currentClip: null, + startedAt: null, + lastError: null, + // SCTE-35: the currently-active ad break, if any. Set by triggerScte and + // cleared by a timer when the break window elapses. Surfaced in getStatus + // so the UI can render an "in break" state + countdown. + scteActive: null, // { eventId, type, durationS, firedAt(iso), endsAt(iso) } + }; + this._advanceTimer = null; + this._scteTimer = null; + this._hlsProc = null; // standalone ffmpeg re-mux child process + this._hlsRestartTimer = null; + } + + async _consumerCommand(outputType, cfg) { + // Returns the AMCP ADD argument string for the requested output target. + if (outputType === 'decklink') { + const dev = cfg.device_index || 1; + return `DECKLINK DEVICE ${dev} EMBEDDED_AUDIO`; + } + if (outputType === 'ndi') { + const name = cfg.ndi_name || 'DRAGONFLIGHT'; + return `NDI NAME "${name}"`; + } + if (outputType === 'srt' || outputType === 'rtmp') { + // CasparCG 2.3 streams via the FFMPEG consumer, invoked with the STREAM + // keyword (FILE/STREAM are interchangeable aliases for it; the bare word + // "FFMPEG" is the PRODUCER and is NOT a valid consumer keyword). Args must + // use ffmpeg's -param:stream form (-codec:v, not -vcodec) or CasparCG + // rejects them. The channel feeds the consumer as RGBA, so a + // format=yuv420p filter is required before libx264. + const url = cfg.url || ''; + if (outputType === 'srt') { + const latency = cfg.latency || 200; + const full = url.includes('latency=') ? url : `${url}${url.includes('?') ? '&' : '?'}latency=${latency}`; + return `STREAM "${full}" -format mpegts -codec:v libx264 -preset:v veryfast -tune:v zerolatency -b:v 6M -codec:a aac -b:a 192k -filter:v format=yuv420p`; + } + const target = cfg.key ? `${url}/${cfg.key}` : url; + return `STREAM "${target}" -format flv -codec:v libx264 -preset:v veryfast -tune:v zerolatency -b:v 6M -codec:a aac -b:a 192k -filter:v format=yuv420p`; + } + throw new Error(`Unknown output_type: ${outputType}`); + } + + // Start the channel: bring up CasparCG's primary output consumer for the + // target, plus a second FFMPEG consumer writing HLS for the UI preview + // monitor (~4-6s lag, reuses capture's /live/ plumbing). + // + // The primary consumer failure is NON-FATAL. CasparCG can decode and route + // media through its pipeline even without an output consumer. This means: + // - NDI channels work (load/play/transport) even if libndi.so is absent. + // - SRT/RTMP channels work even if the destination URL is unreachable. + // - The HLS preview consumer is always attempted independently. + // + // state.consumerError is set when the primary consumer fails so the mam-api + // can surface a warning in the channel status without blocking operation. + async startChannel({ outputType, outputConfig = {}, videoFormat = '1080p5994' }) { + await this.amcp.waitReady(30000); + + // Set the channel video mode first. + try { await this.amcp.send(`SET ${CHANNEL} MODE ${videoFormat}`); } + catch (err) { console.warn(`[playout] SET MODE failed (continuing): ${err.message}`); } + + // Primary output consumer — non-fatal. + let consumerError = null; + try { + const consumer = await this._consumerCommand(outputType, outputConfig); + await this.amcp.send(`ADD ${CHANNEL} ${consumer}`); + } catch (err) { + consumerError = err.message; + console.warn(`[playout] primary consumer ADD failed (continuing without output): ${err.message}`); + } + + // HLS preview consumer — always attempt, independently non-fatal. + if (HLS_DIR) { + try { + await this._addHlsConsumer(); + console.log(`[playout] HLS preview at ${HLS_DIR}/index.m3u8`); + } catch (err) { + console.warn(`[playout] HLS preview consumer failed: ${err.message}`); + } + } + + this.state.running = true; + this.state.outputType = outputType; + this.state.outputConfig = outputConfig; + this.state.videoFormat = videoFormat; + this.state.fps = fpsFor(videoFormat); + this.state.startedAt = new Date().toISOString(); + this.state.lastError = consumerError; + console.log(`[playout] channel started output=${outputType} mode=${videoFormat} fps=${this.state.fps.toFixed(3)}${consumerError ? ' ⚠ consumer: ' + consumerError : ''}`); + return this.getStatus(); + } + + // HLS preview for the web UI confidence monitor. + // + // ── Why not CasparCG's own HLS (FILE/STREAM ".../index.m3u8") ────────────── + // CasparCG's bundled FFMPEG consumer muxes a BROKEN audio track into the HLS: + // ffprobe reports `aac, sample_rate=0` and ffmpeg decoding the playlist fails + // with "Invalid data ... abuffer: Value inf for parameter 'time_base' ... + // time_base 1/0". That corrupt audio prevents BOTH ffmpeg and hls.js from + // decoding, so the browser