From 16a715ccec59bcdc27d2d0c8fc0e88b6ec328fb5 Mon Sep 17 00:00:00 2001 From: Jeremy Fielder Date: Fri, 17 Jul 2026 13:13:23 -0700 Subject: [PATCH 1/2] docs(build): note optional setup-deepfilter.sh prereq for local DFNR CMake gates DFNR off with "library not found" when the prebuilt libdeepfilter isn't present. CI fetches it automatically (cached) in every build workflow, so this trips up only local dev builds. Document the one-time setup step (and Windows .ps1 variant) in the Build section. Co-Authored-By: Claude Opus 4.8 --- AGENTS.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 8e374bc64..ff1a4eb01 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -169,6 +169,15 @@ cmake --build build -j$(nproc) ./build/AetherSDR ``` +**Optional — DFNR (DeepFilterNet3) noise reduction.** Run +`scripts/setup/setup-deepfilter.sh` (Windows: `setup-deepfilter.ps1`) +*once before* `cmake` to fetch the prebuilt `libdeepfilter` for your +platform; configure will otherwise report `DFNR ... disabled — library +not found` and gate the feature off. CI runs this step automatically +(cached) in every build workflow, so release binaries always ship DFNR; +it is a manual prereq only for local dev builds. NR still works without +it via NR4 (libspecbleach). + Full dependency list is in `README.md` — don't duplicate it here. Current version: **26.7.2** (set in both `CMakeLists.txt` and `README.md`). From 6d71d484763dc26bb8ab62f4eafa6aca5dc26541 Mon Sep 17 00:00:00 2001 From: "Jeremy [KK7GWY]" Date: Sat, 18 Jul 2026 17:49:31 -0700 Subject: [PATCH 2/2] =?UTF-8?q?docs(build):=20tighten=20DFNR=20note=20?= =?UTF-8?q?=E2=80=94=20release-build=20precision,=20RN2=20fallback?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Address review nits on the DFNR setup note: - 'every build workflow' overstated (codeql/sanitizers/build-macos-qt build the app but don't run setup-deepfilter) -> 'the release-build workflows', which is what the 'shipped binaries include DFNR' claim actually rests on. - Name RN2 (RNNoise) as the no-setup NR fallback instead of NR4: RN2 is bundled (third_party/rnnoise, own kiss_fft) and always compiled, whereas NR4/libspecbleach needs FFTW + LLVM (clang-cl) on Windows and can be gated off. Co-Authored-By: Claude Opus 4.8 (1M context) --- AGENTS.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index ff1a4eb01..518be0297 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -174,9 +174,10 @@ cmake --build build -j$(nproc) *once before* `cmake` to fetch the prebuilt `libdeepfilter` for your platform; configure will otherwise report `DFNR ... disabled — library not found` and gate the feature off. CI runs this step automatically -(cached) in every build workflow, so release binaries always ship DFNR; -it is a manual prereq only for local dev builds. NR still works without -it via NR4 (libspecbleach). +(cached) in the release-build workflows, so shipped binaries always +include DFNR; it is a manual prereq only for local dev builds. NR still +works without it — RN2 (RNNoise) is bundled and always built, needing no +setup. Full dependency list is in `README.md` — don't duplicate it here.