alh477/demod-vox repository overview

IN (32f, 96 kHz)
  → [Pitch Shift]          0 to −12 semitones  (21 ms latency)
  → [HPF] → [LPF] → [Mid Peak EQ]
  → [Bitcrusher / Downsample]
  → [Ring Modulator]
  → [Helmet Echo]
  → [Bass Boost]           1st-order low shelf
  → [Compressor]
  → [Output Gain]
  → [Hard Clip ±1.0]
  → [TPDF Dither + Word-Length Reduction (16/20/24-bit)]
  → [SR Guard × 1.0 or × 0.0]
  → OUT

DeMoD-Vox/
├── flake.nix                        Nix flake — packages, modules, devShell
├── modules/
│   ├── nixos.nix                    NixOS module  (system-wide)
│   └── home-manager.nix             Home Manager module (per-user)
├── easyeffects/
│   └── DeMoD_Vox_input.json         EasyEffects input preset
├── DeMoD_Vox.dsp                    Faust source → LV2 / LADSPA
├── DeMoD_Vox.csd                    Csound source → standalone / csound-lv2
├── LICENSE                          MIT
└── README.md

{
  inputs = {
    nixpkgs.url     = "github:NixOS/nixpkgs/nixos-unstable";
    home-manager.url = "github:nix-community/home-manager";
    demod-vox.url   = "github:ALH477/DeMoD-Vox";
  };

  outputs = { self, nixpkgs, home-manager, demod-vox, ... }: {
    nixosConfigurations.mymachine = nixpkgs.lib.nixosSystem {
      modules = [
        ./configuration.nix
        demod-vox.nixosModules.default
        home-manager.nixosModules.home-manager
        {
          home-manager.users.youruser = {
            imports = [ demod-vox.homeManagerModules.default ];
          };
        }
      ];
    };
  };
}

# System-wide: PipeWire at 96 kHz + JACK + RT priorities + Carla
programs.demod-vox = {
  enable              = true;
  quantum             = 256;      # 2.67 ms @ 96 kHz
  installCarla        = true;
  installEasyEffects  = true;
};

# Per-user: LV2_PATH, EasyEffects preset, optional Carla session
programs.demod-vox = {
  enable                    = true;
  installEasyEffectsPreset  = true;
  installCarlaSession       = true;   # pre-loads plugin in Carla
  installCarla              = true;
};

sudo nixos-rebuild switch --flake .#mymachine

faust2lv2 -srate 96000 -vec -vs 32 -dfs DeMoD_Vox.dsp
cp -r DeMoD_Vox.lv2 ~/.lv2/

# Verify URI (needed for EasyEffects preset):
cat DeMoD_Vox.lv2/manifest.ttl | grep 'lv2:Plugin'

faust2ladspa -srate 96000 -vec -vs 32 DeMoD_Vox.dsp
cp DeMoD_Vox.so ~/.ladspa/

faust2jack -srate 96000 -vec -vs 32 DeMoD_Vox.dsp && ./DeMoD_Vox

csound -+rtaudio=jack -+rtmidi=null \
       -odac -iadc -b256 -B512 \
       DeMoD_Vox.csd

csound -+rtaudio=alsa -odac0 -iadc0 \
       -b512 -B2048 DeMoD_Vox.csd

# Check LV2_PATH is set
echo $LV2_PATH

# Check EasyEffects can see the plugin
easyeffects --lv2-dump 2>&1 | grep -i demod

# Verify the URI in the preset matches the built plugin
cat ~/.config/easyeffects/input/DeMoD_Vox.json | grep '"lv2#'
cat ~/.lv2/DeMoD_Vox.lv2/manifest.ttl | grep 'a lv2:Plugin'
# Update the URI in DeMoD_Vox.json if they differ.

# /etc/pipewire/pipewire.conf.d/92-demod-vox.conf
context.properties = {
    default.clock.rate        = 96000
    default.clock.quantum     = 256
    default.clock.min-quantum = 256
    default.clock.max-quantum = 1024
    default.clock.allowed-rates = [ 96000 ]
}

systemctl --user restart pipewire pipewire-pulse wireplumber
# Verify:
pw-cli info 0 | grep -E 'rate|quantum'

# /etc/security/limits.d/99-audio.conf
@audio  -  rtprio   99
@audio  -  memlock  unlimited
@audio  -  nice     -20

# Add yourself to the audio group:
sudo usermod -aG audio $USER

nix develop github:ALH477/DeMoD-Vox

# Or from a local clone:
git clone https://github.com/ALH477/DeMoD-Vox
cd DeMoD-Vox
nix develop

# Quick test with jalv (minimal LV2 host):
faust2lv2 -srate 96000 -vec -vs 32 -dfs DeMoD_Vox.dsp
jalv.gtk https://faustlv2.grame.fr/DeMoD_Vox

# Lint the LV2 bundle:
lv2lint -s lv2 https://faustlv2.grame.fr/DeMoD_Vox

# Run Nix build checks:
nix flake check

echo $LV2_PATH
ls $(echo $LV2_PATH | tr ':' '\n' | head -1)
# If empty, re-login or: source ~/.nix-profile/etc/profile.d/hm-session-vars.sh

pw-cli info 0 | grep rate
# Should show: clock.rate = 96000
# If not: systemctl --user restart wireplumber pipewire pipewire-pulse

chrt -p $(pgrep pipewire)    # should show SCHED_FIFO or SCHED_RR
ulimit -r                    # should be > 0 (rtprio limit)

# Get the actual URI from the built plugin:
cat ~/.lv2/DeMoD_Vox.lv2/manifest.ttl | grep 'a lv2:Plugin' -A2
# Update DeMoD_Vox_input.json: replace the URI in "plugins_order" and the key name

pw-jack csound -+rtaudio=jack -odac -iadc -b256 -B512 DeMoD_Vox.csd
# pw-jack wraps Csound in the PipeWire JACK layer explicitly

cd docker-vox
docker build -t demod-vox:latest .

zstd -d < dist/demod-vox-latest.tar.zst | docker load

sudo apt install jackd2 qjackctl
sudo usermod -aG audio $USER
# Log out and back in for group membership

# Using QJackCtl GUI or:
jackd -d alsa -r 48000 -p 512 &

# Interactive CLI
docker compose -f docker-compose.linux.yml run --rm demod-linux --interactive

# Or use Makefile
make run-linux

docker compose -f docker-compose.macos.yml run --rm demod-macos --interactive
make run-macos

# PowerShell
.\launch.ps1

# Or docker compose
docker compose -f docker-compose.windows.yml run --rm lv2-pipeline --interactive
make run-windows

# Start Carla with X11 forwarding
docker run -it --rm \
    -e DISPLAY=$DISPLAY \
    -v /tmp/.X11-unix:/tmp/.X11-unix \
    -v $(pwd)/lv2_plugins:/usr/lib/lv2:ro \
    --device /dev/snd \
    demod-vox:latest \
    carla

# Using the built-in Xvfb support
docker run -it --rm \
    -e CARLA_FULL_GUI=0 \
    demod-vox:latest \
    /opt/audio/scripts/run_carla.sh http://my.plugin.uri

# docker-compose.carla.yml
services:
  carla-gui:
    image: demod-vox:latest
    volumes:
      - ./lv2_plugins:/usr/lib/lv2:ro
      - ./config:/opt/audio/config:ro
      - /tmp/.X11-unix:/tmp/.X11-unix:rw
      - ${XAUTHORITY:-$HOME/.Xauthority}:/root/.Xauthority:ro
    environment:
      - DISPLAY=${DISPLAY}
      - PULSE_SERVER=unix:/run/user/1000/pulse/native
      - LV2_PATH=/usr/lib/lv2
    devices:
      - /dev/snd:/dev/snd
    group_add:
      - audio
    ipc: host
    stdin_open: true
    tty: true

# Linux
PLUGIN_URI="http://example.com/my-plugin" \
docker compose -f docker-compose.linux.yml up

# With parameters
PLUGIN_URI="http://example.com/my-plugin" \
PLUGIN_PARAMS='[{"param": "gain", "value": 0.8}]' \
docker compose -f docker-compose.linux.yml up

make build              # Build Docker image
make build-dist         # Build and compress for distribution
make run-linux          # Interactive on Linux
make run-linux-plugin PLUGIN_URI=<uri>  # Headless on Linux
make run-macos          # Interactive on macOS
make run-windows        # Interactive on Windows/WSLg
make list-plugins       # List available LV2 plugins
make shell             # Interactive bash shell
make clean             # Remove containers and image

# Check JACK status
jack_lsp
jack_lsof

# Verify audio group
groups $USER

# List audio devices
cat /proc/asound/cards

# Check permissions
ls -la /dev/snd

# If X11 forwarding fails
xhost +local:docker

# Or run with Xvfb (headless)
docker run -it --rm \
    -e DISPLAY=:99 \
    demod-vox:latest \
    xvfb-run -a carla

# Host side: start JACK
jackd -d alsa -r 48000 -p 512 &

# Container: connect to JACK
AUDIO_DRIVER=jack JACKD_PARAMS="-d alsa" docker compose up

# Container uses PulseAudio bridge
PULSE_SERVER="unix:/run/user/1000/pulse/native" docker compose up

# For testing without JACK
AUDIO_DRIVER=alsa docker compose up

# The Dockerfile automatically compiles all .dsp files
docker build -t demod-vox:custom .

docker run -v /path/to/my/plugins:/usr/lib/lv2:ro demod-vox:latest \
    jalv.gtk "http://my.plugin.uri"