docs: align docs with codebase

Author: arancormonk

.github/workflows/linux-appimage.yaml

@@ -229,7 +229,7 @@ jobs:
               cmake --install build/appimage --prefix AppDir/usr
 
               docdir="AppDir/usr/share/doc/dsd-neo"
-              required=(LICENSE COPYRIGHT THIRD_PARTY.md lesser.txt)
+              required=(LICENSE COPYRIGHT THIRD_PARTY.md licenses/ezpwd-LGPL-2.1-or-later.txt licenses/pffft-FFTPACK.txt)
               for f in "${required[@]}"; do
                 if [ ! -f "$docdir/$f" ]; then
                   echo "ERROR: missing required license file: $docdir/$f" >&2

.github/workflows/macos-ci.yaml

@@ -238,9 +238,11 @@ jobs:
           chmod +x "$STAGE/dsd-neo.sh" || true
           # Bundle license/notice files
           DOCDIR="$STAGE/share/doc/dsd-neo"
-          mkdir -p "$DOCDIR"
-          cp -f LICENSE COPYRIGHT THIRD_PARTY.md src/third_party/ezpwd/lesser.txt "$DOCDIR/"
-          for f in LICENSE COPYRIGHT THIRD_PARTY.md lesser.txt; do
+          mkdir -p "$DOCDIR/licenses"
+          cp -f LICENSE COPYRIGHT THIRD_PARTY.md "$DOCDIR/"
+          cp -f src/third_party/ezpwd/lesser.txt "$DOCDIR/licenses/ezpwd-LGPL-2.1-or-later.txt"
+          cp -f src/third_party/pffft/COPYING "$DOCDIR/licenses/pffft-FFTPACK.txt"
+          for f in LICENSE COPYRIGHT THIRD_PARTY.md licenses/ezpwd-LGPL-2.1-or-later.txt licenses/pffft-FFTPACK.txt; do
             if [ ! -f "$DOCDIR/$f" ]; then
               echo "ERROR: missing required license file $f in $DOCDIR" >&2
               exit 1

.github/workflows/windows-ci.yaml

@@ -76,7 +76,8 @@ jobs:
           $stage = 'dist/dsd-neo-msvc'
           $binDir = Join-Path $stage 'bin'
           $docDir = Join-Path $stage 'share/doc/dsd-neo'
-          New-Item -ItemType Directory -Force -Path $binDir,$docDir | Out-Null
+          $licenseDir = Join-Path $docDir 'licenses'
+          New-Item -ItemType Directory -Force -Path $binDir,$docDir,$licenseDir | Out-Null
           Copy-Item -Force $exe $binDir
 
           $triplet = $env:VCPKG_TARGET_TRIPLET
@@ -90,8 +91,10 @@ jobs:
             -DestinationDir $binDir `
             -SearchDirs $searchDirs
 
-          Copy-Item -Force LICENSE,COPYRIGHT,THIRD_PARTY.md,'src/third_party/ezpwd/lesser.txt' $docDir -ErrorAction SilentlyContinue
-          $required = @('LICENSE','COPYRIGHT','THIRD_PARTY.md','lesser.txt')
+          Copy-Item -Force LICENSE,COPYRIGHT,THIRD_PARTY.md $docDir -ErrorAction SilentlyContinue
+          Copy-Item -Force 'src/third_party/ezpwd/lesser.txt' (Join-Path $licenseDir 'ezpwd-LGPL-2.1-or-later.txt') -ErrorAction SilentlyContinue
+          Copy-Item -Force 'src/third_party/pffft/COPYING' (Join-Path $licenseDir 'pffft-FFTPACK.txt') -ErrorAction SilentlyContinue
+          $required = @('LICENSE','COPYRIGHT','THIRD_PARTY.md','licenses/ezpwd-LGPL-2.1-or-later.txt','licenses/pffft-FFTPACK.txt')
           foreach ($f in $required) {
             $p = Join-Path $docDir $f
             if (!(Test-Path $p)) { throw "Missing required license file in staged docs: $p" }
@@ -258,7 +261,8 @@ jobs:
           $stage = 'dist/dsd-neo-mingw'
           $binDir = Join-Path $stage 'bin'
           $docDir = Join-Path $stage 'share/doc/dsd-neo'
-          New-Item -ItemType Directory -Force -Path $binDir,$docDir | Out-Null
+          $licenseDir = Join-Path $docDir 'licenses'
+          New-Item -ItemType Directory -Force -Path $binDir,$docDir,$licenseDir | Out-Null
           Copy-Item -Force $exe $binDir
           $triplet = $env:VCPKG_TARGET_TRIPLET
           if (-not $triplet) { $triplet = $env:VCPKG_DEFAULT_TRIPLET }
@@ -283,8 +287,10 @@ jobs:
             -DestinationDir $binDir `
             -SearchDirs $searchDirs
 
-          Copy-Item -Force LICENSE,COPYRIGHT,THIRD_PARTY.md,'src/third_party/ezpwd/lesser.txt' $docDir -ErrorAction SilentlyContinue
-          $required = @('LICENSE','COPYRIGHT','THIRD_PARTY.md','lesser.txt')
+          Copy-Item -Force LICENSE,COPYRIGHT,THIRD_PARTY.md $docDir -ErrorAction SilentlyContinue
+          Copy-Item -Force 'src/third_party/ezpwd/lesser.txt' (Join-Path $licenseDir 'ezpwd-LGPL-2.1-or-later.txt') -ErrorAction SilentlyContinue
+          Copy-Item -Force 'src/third_party/pffft/COPYING' (Join-Path $licenseDir 'pffft-FFTPACK.txt') -ErrorAction SilentlyContinue
+          $required = @('LICENSE','COPYRIGHT','THIRD_PARTY.md','licenses/ezpwd-LGPL-2.1-or-later.txt','licenses/pffft-FFTPACK.txt')
           foreach ($f in $required) {
             $p = Join-Path $docDir $f
             if (!(Test-Path $p)) { throw "Missing required license file in staged docs: $p" }

CMakeLists.txt

@@ -311,8 +311,14 @@ add_custom_target(uninstall
     COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake)
 
 # Install license/notice files with binaries
-install(FILES LICENSE COPYRIGHT THIRD_PARTY.md src/third_party/ezpwd/lesser.txt
+install(FILES LICENSE COPYRIGHT THIRD_PARTY.md
     DESTINATION ${CMAKE_INSTALL_DOCDIR})
+install(FILES src/third_party/ezpwd/lesser.txt
+    DESTINATION ${CMAKE_INSTALL_DOCDIR}/licenses
+    RENAME ezpwd-LGPL-2.1-or-later.txt)
+install(FILES src/third_party/pffft/COPYING
+    DESTINATION ${CMAKE_INSTALL_DOCDIR}/licenses
+    RENAME pffft-FFTPACK.txt)
 
 add_subdirectory(src/platform)
 add_subdirectory(src/core)

COPYRIGHT

@@ -4,4 +4,4 @@ Legacy ISC-licensed portions from the original DSD author remain identified via
 
 The D-STAR radio-header processing path (scrambler, interleaver, Viterbi decode, CRC) was rewritten in 2025 under GPL-3.0-or-later to replace prior GPL-2.0-only contributions.
 
-Third-party code retains its original notices in-place; notably, ezpwd Reed-Solomon contains GPL-3.0-or-later/LGPL components (see src/third_party/ezpwd/ and src/third_party/ezpwd/lesser.txt). A summary of bundled third-party code lives in THIRD_PARTY.md.
+Third-party code retains its original notices in-place; notably, ezpwd Reed-Solomon contains GPL-3.0-or-later/LGPL components (see src/third_party/ezpwd/ and src/third_party/ezpwd/lesser.txt). Installed third-party license texts are shipped under share/doc/dsd-neo/licenses/. A summary of bundled third-party code lives in THIRD_PARTY.md.

README.md

@@ -1,6 +1,6 @@
 # DSD-neo
 
-A modular and performance‑enhanced version of the well-known Digital Speech Decoder (DSD) with a modern CMake build, split into focused libraries (runtime, DSP, IO, FEC, crypto, protocol, core, ui) and a thin CLI.
+A modular and performance‑enhanced version of the well-known Digital Speech Decoder (DSD) with a modern CMake build, split into focused libraries (`runtime`, `platform`, `dsp`, `io`, `engine`, `fec`, `crypto`, `protocol`, `core`, `ui`) and a thin CLI.
 
 Project homepage: https://github.com/arancormonk/dsd-neo
 
@@ -35,7 +35,7 @@ This project is an active work in progress as we decouple from the upstream fork
 ## Overview
 
 - A performance‑enhanced fork of [lwvmobile/dsd-fme](https://github.com/lwvmobile/dsd-fme), which is a fork of [szechyjs/dsd](https://github.com/szechyjs/dsd)
-- Modularized fork with clear boundaries: `runtime`, `dsp`, `io`, `fec`, `crypto`, `protocol`, `core`, plus `ui` and a CLI app.
+- Modularized fork with clear boundaries: `runtime`, `platform`, `dsp`, `io`, `engine`, `fec`, `crypto`, `protocol`, `core`, plus `ui` and a CLI app.
 - Protocol coverage: DMR, dPMR, D‑STAR, NXDN, P25 Phase 1/2, X2‑TDMA, EDACS, ProVoice, M17, YSF.
 - Requires [arancormonk/mbelib-neo](https://github.com/arancormonk/mbelib-neo) for IMBE/AMBE vocoder primitives.
 - Public headers live under `include/dsd-neo/...` and are included as `#include <dsd-neo/<module>/<header>>`.
@@ -72,6 +72,10 @@ This project is an active work in progress as we decouple from the upstream fork
     - Optional auto‑PPM correction from the timing error detector for long unattended runs.
   - Device control from the UI: toggle bias‑tee, switch AGC/manual gain, adjust bandwidth and squelch, and retune quickly.
 
+- M17 encode tooling
+
+  - Generate M17 signals for test/airgap workflows: stream voice (`-fZ`), packet (`-fP`), and BERT (`-fB`) encoders.
+
 - Expanded DSP controls for power users
 
   - Changes apply instantly from the UI and persist across retunes.
@@ -92,7 +96,7 @@ Requirements
 - C compiler with C11 and C++ compiler with C++14 support.
 - CMake ≥ 3.20.
 - Dependencies:
-  - Required: libsndfile, ncurses (wide), PulseAudio.
+  - Required: libsndfile; a curses backend (ncursesw/PDCurses); and an audio backend (PulseAudio by default, PortAudio on Windows).
   - Optional: librtlsdr (RTL‑SDR support), Codec2 (additional vocoder paths), help2man (man page generation).
   - Vocoder: mbelib-neo (`mbe-neo` CMake package) is required.
 
@@ -104,7 +108,7 @@ OS package hints
   - `brew install cmake ninja libsndfile ncurses pulseaudio librtlsdr codec2`
 - Windows:
   - Preferred binary: the native MSVC ZIP. The MinGW ZIP is an alternative native build.
-  - Source builds can use MSVC or MinGW (via MSYS2).
+  - Source builds use CMake presets with vcpkg; set `VCPKG_ROOT` and use `win-msvc-*` or `win-mingw-*` presets in `CMakePresets.json`.
 
 Using CMake presets (recommended)
 
@@ -167,6 +171,8 @@ cmake --build build/dev-release --target uninstall
   - `-DDSD_ENABLE_NATIVE=ON` — Enable `-march=native -mtune=native` (non‑portable binaries).
   - `-DDSD_ENABLE_ASAN=ON` — AddressSanitizer in Debug builds.
   - `-DDSD_ENABLE_UBSAN=ON` — UndefinedBehaviorSanitizer in Debug builds.
+- Audio backend selection:
+  - `-DDSD_USE_PORTAUDIO=ON` — Use PortAudio instead of PulseAudio (default on Windows).
 - UI and behavior toggles:
   - `-DCOLORS=OFF` — Disable ncurses color output.
   - `-DCOLORSLOGS=OFF` — Disable colored terminal/log output.
@@ -208,7 +214,7 @@ Common options:
 ## Tests and Examples
 
 - Run all tests: `ctest --preset dev-debug -V` (or `ctest --test-dir build/dev-debug -V`).
-- Scope: unit tests for protocol helpers (P25 p1/p2, IDEN maps, CRC/RS), crypto, and FEC primitives are included and run via CTest.
+- Scope: unit tests cover runtime config parsing/validation, DSP primitives (filters/resampler/demod helpers), and FEC/crypto helpers.
 - Contributions: prefer small, testable helpers and add focused tests under `tests/<area>`.
 
 ## Documentation
@@ -220,13 +226,15 @@ Common options:
 
 - Apps: `apps/dsd-cli` — CLI entrypoint, target `dsd-neo`.
 - Core: `src/core`, headers `<dsd-neo/core/...>` — glue (audio, vocoder, frame dispatch, GPS, file import).
+- Engine: `src/engine`, headers `<dsd-neo/engine/...>` — top-level decode/encode runner and lifecycle.
+- Platform: `src/platform`, headers `<dsd-neo/platform/...>` — cross-platform primitives (audio backend, sockets, threading, timing, curses).
 - Runtime: `src/runtime`, headers `<dsd-neo/runtime/...>` — config, logging, aligned memory, rings, worker pool, RT scheduling, git version.
 - DSP: `src/dsp`, headers `<dsd-neo/dsp/...>` — demod pipeline, resampler, filters, FLL/TED, SIMD helpers.
-- IO: `src/io`, headers `<dsd-neo/io/...>` — radio (RTL‑SDR), audio (PulseAudio + UDP PCM input/output), control (UDP/rigctl/serial).
+- IO: `src/io`, headers `<dsd-neo/io/...>` — radio (RTL‑SDR), audio (PulseAudio/PortAudio + UDP PCM input/output), control (UDP/rigctl/serial).
 - FEC: `src/fec`, headers `<dsd-neo/fec/...>` — BCH, Golay, Hamming, RS, BPTC, CRC/FCS.
 - Crypto: `src/crypto`, headers `<dsd-neo/crypto/...>` — RC2/RC4/DES/AES and helpers.
 - Protocols: `src/protocol/<name>`, headers `<dsd-neo/protocol/<name>/...>` — DMR, dPMR, D‑STAR, NXDN, P25, X2‑TDMA, EDACS, ProVoice, M17, YSF.
-- Third‑party: `src/third_party/ezpwd` — INTERFACE target `dsd-neo_ezpwd`.
+- Third‑party: `src/third_party/ezpwd` (INTERFACE target `dsd-neo_ezpwd`), `src/third_party/pffft` (FFT helper).
 
 ## Tooling
 
@@ -238,11 +246,11 @@ Common options:
 
 - Languages: C (C11) and C++ (C++14). Indent width 4 spaces; no tabs; brace all control statements; line length ≤ 120.
 - Use project‑prefixed includes only: `#include <dsd-neo/...>`.
-- Before sending changes: build presets you touched, run `tools/format.sh`, address feasible clang‑tidy warnings.
+- Before sending changes: build presets you touched, run `tools/format.sh`, address feasible clang‑tidy and cppcheck warnings.
 
 ## License
 
 - Project license: GPL‑3.0‑or‑later (see `LICENSE`).
 - Portions remain under ISC per the original DSD author (see `COPYRIGHT`).
-- Third-party notices live in `THIRD_PARTY.md` (ezpwd LGPL text: `src/third_party/ezpwd/lesser.txt`).
+- Third-party notices live in `THIRD_PARTY.md` (installed license texts: `share/doc/dsd-neo/licenses/`).
 - Source files carry SPDX identifiers reflecting their license.

THIRD_PARTY.md

@@ -1,7 +1,7 @@
 # Third-Party Notices
 
-- **ezpwd Reed-Solomon** (Hard Consulting Corporation) — GPL-3.0-or-later; `rs_base` is LGPL-2.1-or-later (per upstream notice). License texts: project GPL license and `src/third_party/ezpwd/lesser.txt` (LGPL).
-- **pffft** (Julien Pommier, based on FFTPACKv4 by Dr Paul Swarztrauber/NCAR) — BSD-like FFTPACK license; `src/third_party/pffft/COPYING`.
+- **ezpwd Reed-Solomon** (Hard Consulting Corporation) — GPL-3.0-or-later; `rs_base` is LGPL-2.1-or-later (per upstream notice). License text: `src/third_party/ezpwd/lesser.txt` (installed as `share/doc/dsd-neo/licenses/ezpwd-LGPL-2.1-or-later.txt`).
+- **pffft** (Julien Pommier, based on FFTPACKv4 by Dr Paul Swarztrauber/NCAR) — BSD-like FFTPACK license; `src/third_party/pffft/COPYING` (installed as `share/doc/dsd-neo/licenses/pffft-FFTPACK.txt`).
 - **Tiny AES** (`src/crypto/crypt-aes.c`) — Unlicense/public domain; original upstream https://github.com/kokke/tiny-AES-c.
 
 All third-party files retain their original headers; consult the referenced paths for details.