SOF Utilities (sof-utils)

Developer utilities, visual tools, and host applications for the Sound Open Firmware (SOF) ecosystem.

---

Included Tools

Tool	Directory	Description
sof-builder	sof-builder/	GTK4 Topology2 Visual Graph Editor, IPC4 .tplg Compiler & Real-Time sof-testbench4 Simulation / Telemetry Studio
sof-testbench	sof-testbench/	Multi-Core LL/DP sof-testbench4 Simulator, sof-tb-ctl TCP Control CLI, Host Platform Runtime (platform/library), and 70-Test Suite
sof-tplg-parser	sof-tplg-parser/	ALSA Topology (.tplg) IPC3/IPC4 Parser Library (libsof_tplg_parser.a)

---

Quick Start: sof-testbench4 & sof-tb-ctl

sof-testbench/ builds sof-testbench4 and sof-tb-ctl in a local build directory by compiling sof-utils's host platform runtime (sof-testbench/platform/library and sof-testbench/arch/host) together with the firmware audio modules, pipeline engine, and IPC code directly from an SOF checkout (${SOF_SRC_DIR}/src/), leaving the sof checkout completely untouched.

1. Align Versions with west (Optional)

west init -l sof-utils
west update

2. Configure & Build

cmake -B sof-testbench/build -S sof-testbench -DSOF_SRC_DIR=/path/to/sof
cmake --build sof-testbench/build -j$(nproc)

(If -DSOF_SRC_DIR is omitted, CMake auto-detects sof via west list -f "{abspath}" sof, $SOF_SRC_DIR, or ../sof.)

3. Run the 5-Tier (70-Test) Verification Suite

ctest --test-dir sof-testbench/build --output-on-failure

---

Quick Start: sof-builder

1. Install Dependencies

Ubuntu / Debian:

sudo apt update
sudo apt install python3 python3-pip python3-gi python3-gi-cairo gir1.2-gtk-4.0 gir1.2-pango-1.0 alsa-utils

Python Packages (pip):

pip install -r sof-builder/requirements.txt

(Required Python packages: PyGObject>=3.42.0, pycairo>=1.20.0)

2. Run or Install sof-builder

# Run directly:
./sof-builder/sof-builder /path/to/sof/tools/topology/topology2

# Or install as a Python CLI package:
pip install -e ./sof-builder
sof-builder /path/to/sof/tools/topology/topology2

See sof-builder/README.md for full documentation, environment variables (SOF_ROOT, SOF_TOPOLOGY2_DIR, SOF_TESTBENCH_BIN, ALSATPLG), and feature guides.

---

License

Licensed under the BSD 3-Clause License. See LICENSE for details.