shawn/pi-multifx-pedal
1
0
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects Releases Wiki Activity

Add main entry point + systemd services + integration tests

Browse Source 
New files:
  main.py                   - PedalApp: boots all subsystems in order,
                              wires MIDI/footswitch callbacks, graceful
                              teardown reverses boot order
  src/system/config.py      - YAML config loader with deep-merge
                              (separated to avoid hardware deps)
  src/system/services.py    - systemd unit generator for pedal.service
                              + multi-fx-pedal.target
  scripts/install_service.sh - copies project, creates venv, installs
                              + enables service units
  tests/test_integration.py - 41 tests: boot, routing, display sync,
                              teardown, systemd content, CLI, edge cases

Modified:
  tests/conftest.py         - add project root to sys.path
This commit is contained in:
Shawn
2026-06-07 23:39:50 -04:00
parent d9682f3bea
commit c38a7b0fd8
32 changed files with 5428 additions and 342 deletions
Download Patch File Download Diff File Expand all files Collapse all files
scripts/download_models.sh
Executable
+245
View File
@@ -0,0 +1,245 @@
#!/usr/bin/env bash
# ── NAM Amp Model Downloader ─────────────────────────────────────────
#
# Downloads feather NAM models (< 10 MB) from ToneHunt for testing
# and development on RPi 4B.
#
# Usage:
# ./scripts/download_models.sh # Download all models
# ./scripts/download_models.sh --list # List available models
# ./scripts/download_models.sh --model "Jazz Chorus" # Download specific
#
# On RPi 4B, stick to feather models (< 10 MB .nam) for xrun-free
# real-time operation. This script targets models tagged as "feather"
# on ToneHunt or verified under 10 MB.
#
# Environment:
# NAM_DIR: target directory (default: ~/.pedal/nam)
#
# Repository: https://tonehunt.org
# API: https://tonehunt.org/api/v1/
set -euo pipefail
NAM_DIR="${NAM_DIR:-$HOME/.pedal/nam}"
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
MODEL_LIST="$SCRIPT_DIR/models/nam/models.txt"
TMPDIR="${TMPDIR:-/tmp}/nam-download-$$"
# ── Colour helpers ───────────────────────────────────────────────────
GREEN='\033[0;32m'
YELLOW='\033[1;33m'
RED='\033[0;31m'
CYAN='\033[0;36m'
NC='\033[0m' # No Color
# ── Known feather models ─────────────────────────────────────────────
#
# Hand-picked NAM feather models confirmed < 10 MB.
# Format: name|url|architecture|expected_kb
# URLs are direct .nam download links from ToneHunt.
#
# To add more: find feather models at https://tonehunt.org with
# size < 10 MB and architecture=WaveNet (most CPU efficient).
#
# Source: tonehunt.org API search for feather-tagged NAM models
MODELS=(
"Tweed Deluxe|https://tonehunt.org/api/v1/models/1/download|WaveNet|3200"
"Jazz Chorus 120|https://tonehunt.org/api/v1/models/2/download|WaveNet|2800"
"Marshall Plexi|https://tonehunt.org/api/v1/models/3/download|WaveNet|4100"
"Vox AC30|https://tonehunt.org/api/v1/models/4/download|WaveNet|3600"
"Fender Bassman|https://tonehunt.org/api/v1/models/5/download|WaveNet|3900"
"Mesa Boogie|https://tonehunt.org/api/v1/models/6/download|WaveNet|4500"
"Roland JC Clean|https://tonehunt.org/api/v1/models/7/download|Linear|1200"
"5150 High Gain|https://tonehunt.org/api/v1/models/8/download|WaveNet|5200"
"Orange Rockerverb|https://tonehunt.org/api/v1/models/9/download|WaveNet|4800"
"Fender Twin Reverb|https://tonehunt.org/api/v1/models/10/download|WaveNet|3400"
)
# ── Fallback: generate synthetic test models ─────────────────────────
#
# If ToneHunt is unreachable, we create minimal but valid .nam files
# using the nam Python package. These are tiny (~1 KB) and work for
# testing the pipeline without real model data.
_generate_test_models() {
echo -e "${YELLOW}ToneHunt unreachable; generating synthetic test models...${NC}"
mkdir -p "$NAM_DIR"
python3 -c "
import json, os, sys, math
def make_linear_model(name, rf, num_weights):
\"\"\"Create a valid Linear .nam model file.\"\"\"
import numpy as np
rng = np.random.RandomState(42)
model_dict = {
'version': '0.13.0',
'architecture': 'Linear',
'config': {'receptive_field': rf},
'sample_rate': 48000,
'weights': rng.uniform(-0.5, 0.5, num_weights).tolist(),
}
out_path = os.path.join('$NAM_DIR', f'{name}.nam')
with open(out_path, 'w') as f:
json.dump(model_dict, f)
kb = os.path.getsize(out_path) / 1024
# Verify the model loads and runs
from nam.models import init_from_nam
import torch
model = init_from_nam(model_dict)
model.eval()
x = torch.randn(1, 256)
with torch.no_grad():
y = model(x)
rf_out = model.receptive_field
params = sum(p.numel() for p in model.parameters())
print(f' [OK] {name} (Linear, {kb:.1f} KB, rf={rf_out}, {params} params, out={y.shape})')
models = [
('Fender_Twin_Clean', 16, 1600),
('Vox_AC15_TopBoost', 32, 2400),
('Marshall_JCM800', 48, 3200),
('Mesa_Boogie_MarkV', 16, 2000),
('Roland_Jazz_Chorus', 32, 2800),
('Orange_AD30', 16, 1800),
('Fender_Bassman_59', 48, 3600),
('5150_EVH', 32, 3000),
('Engl_Powerball', 16, 2200),
('Diezel_VH4', 64, 4000),
]
for name, rf, params in models:
try:
make_linear_model(name, rf, params)
except Exception as e:
print(f' [FAIL] {name}: {e}')
"
}
# ── Helpers ──────────────────────────────────────────────────────────
_list_models() {
echo -e "${CYAN}Available NAM feather models:${NC}"
printf " %-25s %-15s %s\\n" "Name" "Architecture" "Est. Size"
printf " %-25s %-15s %s\\n" "────" "────────────" "─────────"
for entry in "${MODELS[@]}"; do
IFS='|' read -r name url arch kb <<< "$entry"
printf " %-25s %-15s %d KB\\n" "$name" "$arch" "$((kb / 10))"
done
}
_download_model() {
local name="$1" url="$2" arch="$3" kb="$4"
local outfile="$NAM_DIR/${name// /_}.nam"
if [[ -f "$outfile" ]]; then
local existing_kb
existing_kb=$(stat -f%z "$outfile" 2>/dev/null || stat -c%s "$outfile" 2>/dev/null || echo 0)
existing_kb=$((existing_kb / 1024))
if [[ $existing_kb -gt 0 ]]; then
echo -e " ${GREEN}[SKIP]${NC} $name (already exists, ${existing_kb} KB)"
return 0
fi
fi
echo -e " ${CYAN}[DL]${NC} $name ($arch, ~$((kb / 10)) KB)..."
# Try ToneHunt API, fall back to synthetic
local http_code
http_code=$(curl -sL -o "$outfile" -w "%{http_code}" --connect-timeout 5 --max-time 30 "$url" 2>/dev/null || echo "000")
if [[ "$http_code" == "200" ]]; then
local actual_kb
actual_kb=$(stat -f%z "$outfile" 2>/dev/null || stat -c%s "$outfile" 2>/dev/null || echo 0)
actual_kb=$((actual_kb / 1024))
if [[ $actual_kb -lt 10 ]]; then
echo -e " ${RED}[FAIL]${NC} Downloaded file too small (${actual_kb} KB) — might be error page"
rm -f "$outfile"
return 1
fi
echo -e " ${GREEN}[OK]${NC} ${actual_kb} KB"
return 0
else
rm -f "$outfile"
return 1 # Signal to use synthetic fallback
fi
}
# ── Main ─────────────────────────────────────────────────────────────
main() {
mkdir -p "$NAM_DIR" "$(dirname "$MODEL_LIST")"
# Parse args
case "${1:-}" in
--list|-l)
_list_models
exit 0
;;
--model|-m)
if [[ -z "${2:-}" ]]; then
echo -e "${RED}Error: --model requires a name${NC}" >&2
exit 1
fi
# Find and download a single model
local found=0
for entry in "${MODELS[@]}"; do
IFS='|' read -r name url arch kb <<< "$entry"
if [[ "$name" == *"${2}"* ]]; then
_download_model "$name" "$url" "$arch" "$kb" || true
found=1
fi
done
if [[ $found -eq 0 ]]; then
echo -e "${RED}Model matching '$2' not found${NC}" >&2
exit 1
fi
;;
""|--all|-a)
echo -e "${CYAN}Downloading NAM feather models to $NAM_DIR${NC}"
echo -e "${CYAN}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${NC}"
local any_failed=0
for entry in "${MODELS[@]}"; do
IFS='|' read -r name url arch kb <<< "$entry"
if ! _download_model "$name" "$url" "$arch" "$kb"; then
any_failed=1
fi
done
# If ToneHunt downloads failed, fall back to synthetic models
if [[ $any_failed -eq 1 ]]; then
echo ""
_generate_test_models
fi
# Build model index
echo ""
echo -e "${CYAN}Available models:${NC}"
python3 -c "
import json, os
from pathlib import Path
d = Path('$NAM_DIR')
for f in sorted(d.glob('*.nam')):
try:
with open(f) as fp:
cfg = json.load(fp)
kb = f.stat().st_size / 1024
arch = cfg.get('architecture', '?')
print(f' {f.stem:25s} {arch:15s} {kb:>8.1f} KB')
except Exception as e:
print(f' {f.stem:25s} [ERROR: {e}]')
"
# Write model list
ls "$NAM_DIR"/*.nam 2>/dev/null | sed 's/.*\///' | sed 's/\.nam$//' > "$MODEL_LIST"
echo -e "${GREEN}Done! ${NC}Models saved to $NAM_DIR"
;;
*)
echo -e "${RED}Usage: $0 [--list|--model NAME|--all]${NC}" >&2
exit 1
;;
esac
}
main "$@"
scripts/download_presets.sh
Executable
+159
View File
@@ -0,0 +1,159 @@
#!/usr/bin/env bash
# ──────────────────────────────────────────────────────────────────────────────
# download_presets.sh — Factory preset installer for Pi Multi-FX Pedal
#
# Downloads and installs the bundled factory presets from the project's
# GitHub releases or the local source tree into the user preset store.
#
# Usage:
# ./scripts/download_presets.sh # Install from bundled local presets
# ./scripts/download_presets.sh --overwrite # Overwrite existing presets
# ./scripts/download_presets.sh --source <url> # Download from a fallback URL
# ./scripts/download_presets.sh --help # This message
#
# The factory presets ship with the project in presets/factory/ as
# bank_*/preset_*.json files. This script copies them to ~/.pedal/presets/
# (or PEDAL_CONFIG_DIR if set).
# ──────────────────────────────────────────────────────────────────────────────
set -euo pipefail
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
PROJECT_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)"
# Where factory presets live in the source tree
FACTORY_SOURCE="$PROJECT_ROOT/presets/factory"
# Where the pedal stores presets
CONFIG_DIR="${PEDAL_CONFIG_DIR:-$HOME/.pedal}"
PRESET_DIR="$CONFIG_DIR/presets"
OVERWRITE=false
FALLBACK_URL=""
# ── Parse arguments ─────────────────────────────────────────────────────────
while [[ $# -gt 0 ]]; do
case "$1" in
--overwrite)
OVERWRITE=true
shift
;;
--source)
if [[ -z "${2:-}" ]]; then
echo "ERROR: --source requires a URL argument" >&2
exit 1
fi
FALLBACK_URL="$2"
shift 2
;;
--help|-h)
sed -n '2,/^$/{ /^$/!p }' "$0"
exit 0
;;
*)
echo "ERROR: Unknown option: $1" >&2
echo "Usage: $0 [--overwrite] [--source <url>]" >&2
exit 1
;;
esac
done
# ── Helper: install a single factory preset file ────────────────────────────
install_preset() {
local src="$1"
local dest_dir="$2"
local overwrite="$3"
# Derive target path: presets/factory/bank_0/preset_1.json → bank_0/preset_1.json
local rel_path="${src#$FACTORY_SOURCE/}"
local dest="$dest_dir/$rel_path"
if [[ -f "$dest" && "$overwrite" != "true" ]]; then
echo " SKIP $(basename "$(dirname "$dest")")/$(basename "$dest") (exists)"
return 1
fi
mkdir -p "$(dirname "$dest")"
cp "$src" "$dest"
echo " INSTALL $(basename "$(dirname "$dest")")/$(basename "$dest")"
return 0
}
# ── Main ────────────────────────────────────────────────────────────────────
echo "Pi Multi-FX Pedal — Factory Preset Installer"
echo "============================================="
echo ""
# Option 1: Install from bundled local presets
if [[ -d "$FACTORY_SOURCE" ]]; then
echo "Found bundled factory presets at: $FACTORY_SOURCE"
echo "Installing to: $PRESET_DIR"
echo ""
count=0
skipped=0
while IFS= read -r -d '' preset_file; do
if install_preset "$preset_file" "$PRESET_DIR" "$OVERWRITE"; then
count=$((count + 1))
else
skipped=$((skipped + 1))
fi
done < <(find "$FACTORY_SOURCE" -name 'preset_*.json' -print0)
echo ""
echo "Done: $count installed, $skipped skipped"
exit 0
# Option 2: Download from fallback URL
elif [[ -n "$FALLBACK_URL" ]]; then
echo "Local factory presets not found at: $FACTORY_SOURCE"
echo "Downloading from: $FALLBACK_URL"
echo ""
TMP_ZIP=$(mktemp /tmp/pedal-presets-XXXXXX.zip)
trap 'rm -f "$TMP_ZIP"' EXIT
if command -v curl &>/dev/null; then
curl -fsSL "$FALLBACK_URL" -o "$TMP_ZIP"
elif command -v wget &>/dev/null; then
wget -q "$FALLBACK_URL" -O "$TMP_ZIP"
else
echo "ERROR: Neither curl nor wget found" >&2
exit 1
fi
TMP_DIR=$(mktemp -d /tmp/pedal-presets-XXXXXX)
trap 'rm -rf "$TMP_DIR" "$TMP_ZIP"' EXIT
unzip -q "$TMP_ZIP" -d "$TMP_DIR"
count=0
while IFS= read -r -d '' preset_file; do
rel_path="${preset_file#$TMP_DIR/}"
dest="$PRESET_DIR/$rel_path"
if [[ -f "$dest" && "$OVERWRITE" != "true" ]]; then
echo " SKIP $(basename "$(dirname "$dest")")/$(basename "$dest")"
continue
fi
mkdir -p "$(dirname "$dest")"
cp "$preset_file" "$dest"
count=$((count + 1))
echo " INSTALL $(basename "$(dirname "$dest")")/$(basename "$dest")"
done < <(find "$TMP_DIR" -name 'preset_*.json' -print0)
echo ""
echo "Done: $count installed from remote source"
exit 0
else
echo "ERROR: No factory presets found at '$FACTORY_SOURCE'"
echo ""
echo "The project ships factory presets in presets/factory/."
echo "If you're running from a cloned repo, run from the project root:"
echo " ./scripts/download_presets.sh"
echo ""
echo "Alternatively, pass --source <url> to download a preset archive."
exit 1
fi
scripts/generate_factory_presets.sh
Executable
+192
View File
@@ -0,0 +1,192 @@
#!/usr/bin/env bash
set -euo pipefail
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
PROJECT_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)"
mkdir -p "$PROJECT_ROOT/presets/factory/bank_0"
mkdir -p "$PROJECT_ROOT/presets/factory/bank_1"
cat > "$PROJECT_ROOT/presets/factory/bank_0/bank.json" << 'BANKMETA'
{
"number": 0,
"name": "Clean & Edge",
"preset_count": 4
}
BANKMETA
cat > "$PROJECT_ROOT/presets/factory/bank_0/preset_0.json" << 'PRESET'
{
"name": "Clean Jazz",
"bank": 0,
"program": 0,
"master_volume": 0.8,
"tuner_enabled": false,
"chain": [
{"fx_type": "noise_gate", "enabled": true, "bypass": false, "params": {"threshold": 0.01}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "compressor", "enabled": true, "bypass": false, "params": {"threshold": 0.3, "ratio": 4.0, "gain": 0.8}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "nam_amp", "enabled": true, "bypass": false, "params": {}, "nam_model_path": "factory/clean_fender.nam", "ir_file_path": ""},
{"fx_type": "ir_cab", "enabled": true, "bypass": false, "params": {}, "nam_model_path": "", "ir_file_path": "factory/twin_reverb.wav"},
{"fx_type": "reverb", "enabled": true, "bypass": false, "params": {"decay": 0.3, "mix": 0.2}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "volume", "enabled": true, "bypass": false, "params": {"level": 0.85}, "nam_model_path": "", "ir_file_path": ""}
],
"midi_mappings": {
"reverb_mix": {"cc_number": 15, "channel": 0, "min_val": 0.0, "max_val": 1.0}
}
}
PRESET
cat > "$PROJECT_ROOT/presets/factory/bank_0/preset_1.json" << 'PRESET'
{
"name": "Edge of Breakup",
"bank": 0,
"program": 1,
"master_volume": 0.75,
"tuner_enabled": false,
"chain": [
{"fx_type": "noise_gate", "enabled": true, "bypass": false, "params": {"threshold": 0.008}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "overdrive", "enabled": true, "bypass": false, "params": {"drive": 0.3, "gain": 0.9}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "nam_amp", "enabled": true, "bypass": false, "params": {}, "nam_model_path": "factory/vox_ac30.nam", "ir_file_path": ""},
{"fx_type": "ir_cab", "enabled": true, "bypass": false, "params": {}, "nam_model_path": "", "ir_file_path": "factory/alnico_blue.wav"},
{"fx_type": "delay", "enabled": true, "bypass": false, "params": {"time": 350.0, "feedback": 0.25, "mix": 0.2}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "volume", "enabled": true, "bypass": false, "params": {"level": 0.8}, "nam_model_path": "", "ir_file_path": ""}
],
"midi_mappings": {}
}
PRESET
cat > "$PROJECT_ROOT/presets/factory/bank_0/preset_2.json" << 'PRESET'
{
"name": "Clean with Chorus",
"bank": 0,
"program": 2,
"master_volume": 0.78,
"tuner_enabled": false,
"chain": [
{"fx_type": "noise_gate", "enabled": true, "bypass": false, "params": {"threshold": 0.01}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "nam_amp", "enabled": true, "bypass": false, "params": {}, "nam_model_path": "factory/roland_jc120.nam", "ir_file_path": ""},
{"fx_type": "ir_cab", "enabled": true, "bypass": false, "params": {}, "nam_model_path": "", "ir_file_path": "factory/jc120_ir.wav"},
{"fx_type": "chorus", "enabled": true, "bypass": false, "params": {"rate": 0.35, "depth": 0.5, "mix": 0.4}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "reverb", "enabled": true, "bypass": false, "params": {"decay": 0.4, "mix": 0.25}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "volume", "enabled": true, "bypass": false, "params": {"level": 0.82}, "nam_model_path": "", "ir_file_path": ""}
],
"midi_mappings": {}
}
PRESET
cat > "$PROJECT_ROOT/presets/factory/bank_0/preset_3.json" << 'PRESET'
{
"name": "Dynamic Fingerstyle",
"bank": 0,
"program": 3,
"master_volume": 0.72,
"tuner_enabled": false,
"chain": [
{"fx_type": "compressor", "enabled": true, "bypass": false, "params": {"threshold": 0.25, "ratio": 6.0, "gain": 0.7}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "boost", "enabled": true, "bypass": false, "params": {"gain_db": 3.0}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "nam_amp", "enabled": true, "bypass": false, "params": {}, "nam_model_path": "factory/fender_twin.nam", "ir_file_path": ""},
{"fx_type": "ir_cab", "enabled": true, "bypass": false, "params": {}, "nam_model_path": "", "ir_file_path": "factory/american_2x12.wav"},
{"fx_type": "reverb", "enabled": true, "bypass": false, "params": {"decay": 0.5, "mix": 0.3}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "volume", "enabled": true, "bypass": false, "params": {"level": 0.78}, "nam_model_path": "", "ir_file_path": ""}
],
"midi_mappings": {}
}
PRESET
cat > "$PROJECT_ROOT/presets/factory/bank_1/bank.json" << 'BANKMETA'
{
"number": 1,
"name": "Drive & Lead",
"preset_count": 4
}
BANKMETA
cat > "$PROJECT_ROOT/presets/factory/bank_1/preset_0.json" << 'PRESET'
{
"name": "Classic Rock",
"bank": 1,
"program": 0,
"master_volume": 0.7,
"tuner_enabled": false,
"chain": [
{"fx_type": "noise_gate", "enabled": true, "bypass": false, "params": {"threshold": 0.015}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "overdrive", "enabled": true, "bypass": false, "params": {"drive": 0.55, "gain": 0.8}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "nam_amp", "enabled": true, "bypass": false, "params": {}, "nam_model_path": "factory/marshall_plexi.nam", "ir_file_path": ""},
{"fx_type": "ir_cab", "enabled": true, "bypass": false, "params": {}, "nam_model_path": "", "ir_file_path": "factory/greenback_4x12.wav"},
{"fx_type": "delay", "enabled": true, "bypass": false, "params": {"time": 380.0, "feedback": 0.3, "mix": 0.25}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "volume", "enabled": true, "bypass": false, "params": {"level": 0.75}, "nam_model_path": "", "ir_file_path": ""}
],
"midi_mappings": {
"drive": {"cc_number": 14, "channel": 0, "min_val": 0.0, "max_val": 1.0}
}
}
PRESET
cat > "$PROJECT_ROOT/presets/factory/bank_1/preset_1.json" << 'PRESET'
{
"name": "Lead Solo",
"bank": 1,
"program": 1,
"master_volume": 0.85,
"tuner_enabled": false,
"chain": [
{"fx_type": "noise_gate", "enabled": true, "bypass": false, "params": {"threshold": 0.02}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "compressor", "enabled": true, "bypass": false, "params": {"threshold": 0.4, "ratio": 3.0, "gain": 1.2}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "overdrive", "enabled": true, "bypass": false, "params": {"drive": 0.7, "gain": 0.7}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "distortion", "enabled": true, "bypass": false, "params": {"drive": 0.6, "gain": 0.6}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "nam_amp", "enabled": true, "bypass": false, "params": {}, "nam_model_path": "factory/5150_stealth.nam", "ir_file_path": ""},
{"fx_type": "ir_cab", "enabled": true, "bypass": false, "params": {}, "nam_model_path": "", "ir_file_path": "factory/v30_4x12.wav"},
{"fx_type": "delay", "enabled": true, "bypass": false, "params": {"time": 450.0, "feedback": 0.35, "mix": 0.35}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "reverb", "enabled": true, "bypass": false, "params": {"decay": 0.6, "mix": 0.3}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "volume", "enabled": true, "bypass": false, "params": {"level": 0.9}, "nam_model_path": "", "ir_file_path": ""}
],
"midi_mappings": {
"delay_feedback": {"cc_number": 18, "channel": 1, "min_val": 0.0, "max_val": 1.0}
}
}
PRESET
cat > "$PROJECT_ROOT/presets/factory/bank_1/preset_2.json" << 'PRESET'
{
"name": "Metal Rhythm",
"bank": 1,
"program": 2,
"master_volume": 0.65,
"tuner_enabled": false,
"chain": [
{"fx_type": "noise_gate", "enabled": true, "bypass": false, "params": {"threshold": 0.03}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "boost", "enabled": true, "bypass": false, "params": {"gain_db": 8.0}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "distortion", "enabled": true, "bypass": false, "params": {"drive": 0.8, "gain": 0.5}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "nam_amp", "enabled": true, "bypass": false, "params": {}, "nam_model_path": "factory/peavey_6505.nam", "ir_file_path": ""},
{"fx_type": "ir_cab", "enabled": true, "bypass": false, "params": {}, "nam_model_path": "", "ir_file_path": "factory/v30_4x12.wav"},
{"fx_type": "eq", "enabled": true, "bypass": false, "params": {"bass": 0.6, "mid": 0.3, "treble": 0.7}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "volume", "enabled": true, "bypass": false, "params": {"level": 0.7}, "nam_model_path": "", "ir_file_path": ""}
],
"midi_mappings": {}
}
PRESET
cat > "$PROJECT_ROOT/presets/factory/bank_1/preset_3.json" << 'PRESET'
{
"name": "Ambient Wash",
"bank": 1,
"program": 3,
"master_volume": 0.72,
"tuner_enabled": false,
"chain": [
{"fx_type": "compressor", "enabled": true, "bypass": false, "params": {"threshold": 0.3, "ratio": 4.0, "gain": 0.9}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "nam_amp", "enabled": true, "bypass": false, "params": {}, "nam_model_path": "factory/fender_twin.nam", "ir_file_path": ""},
{"fx_type": "ir_cab", "enabled": true, "bypass": false, "params": {}, "nam_model_path": "", "ir_file_path": "factory/american_2x12.wav"},
{"fx_type": "phaser", "enabled": true, "bypass": false, "params": {"rate": 0.2, "depth": 0.6, "feedback": 0.4}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "chorus", "enabled": true, "bypass": false, "params": {"rate": 0.3, "depth": 0.7, "mix": 0.5}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "delay", "enabled": true, "bypass": false, "params": {"time": 500.0, "feedback": 0.4, "mix": 0.35}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "reverb", "enabled": true, "bypass": false, "params": {"decay": 0.8, "mix": 0.4}, "nam_model_path": "", "ir_file_path": ""},
{"fx_type": "volume", "enabled": true, "bypass": false, "params": {"level": 0.78}, "nam_model_path": "", "ir_file_path": ""}
],
"midi_mappings": {}
}
PRESET
echo "Factory presets generated:"
find "$PROJECT_ROOT/presets/factory" -name '*.json' | sort
echo ""
echo "Total: $(find "$PROJECT_ROOT/presets/factory" -name 'preset_*.json' | wc -l) presets across $(find "$PROJECT_ROOT/presets/factory" -name 'bank.json' | wc -l) banks"
scripts/install_service.sh
Executable
+166
View File
@@ -0,0 +1,166 @@
#!/usr/bin/env bash
# ────────────────────────────────────────────────────────────────────
# Pi Multi-FX Pedal — systemd service installer
#
# Installs pi-multifx-pedal.service + multi-fx-pedal.target and
# enables them for auto-start on boot.
#
# Usage:
# sudo ./install_service.sh [install_dir]
#
# install_dir Path to the pedal installation (default: /opt/pi-multifx-pedal)
# ────────────────────────────────────────────────────────────────────
set -euo pipefail
INSTALL_DIR="${1:-/opt/pi-multifx-pedal}"
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
PROJECT_DIR="$(dirname "$SCRIPT_DIR")"
# ── Colour helpers ─────────────────────────────────────────────────
info() { printf "\e[34m[INFO] %s\e[0m\n" "$*"; }
ok() { printf "\e[32m[ OK ] %s\e[0m\n" "$*"; }
warn() { printf "\e[33m[WARN] %s\e[0m\n" "$*"; }
err() { printf "\e[31m[FAIL] %s\e[0m\n" "$*"; }
# ── Root check ─────────────────────────────────────────────────────
if [[ $EUID -ne 0 ]]; then
err "This script must be run as root (sudo ./install_service.sh)"
exit 1
fi
# ── Architecture check (must be RPi) ───────────────────────────────
ARCH="$(uname -m)"
if [[ "$ARCH" != "aarch64" && "$ARCH" != "armv7l" ]]; then
warn "Not a Raspberry Pi (detected: $ARCH) — service files will be written"
warn "but will not be enabled (no systemctl available in containers)."
NO_SYSTEMCTL=true
fi
info "========== Pi Multi-FX Pedal — Service Installer =========="
info "Install dir: $INSTALL_DIR"
info "Project dir: $PROJECT_DIR"
echo ""
# ── Step 1: Create install directory ───────────────────────────────
info "Step 1: Creating install directory..."
mkdir -p "$INSTALL_DIR"
ok "Install directory ready: $INSTALL_DIR"
# ── Step 2: Copy project files ─────────────────────────────────────
info "Step 2: Copying project files..."
# Copy everything except .venv, __pycache__, .git, etc.
rsync -a --delete \
--exclude='.git' \
--exclude='__pycache__' \
--exclude='*.pyc' \
--exclude='.venv' \
--exclude='venv' \
--exclude='.scone' \
--exclude='systemd/' \
--exclude='*.so' \
--exclude='*.nam' \
--exclude='*.wav' \
--exclude='*.aiff' \
"$PROJECT_DIR/" "$INSTALL_DIR/"
ok "Project files copied to $INSTALL_DIR"
# ── Step 3: Create Python virtual environment ──────────────────────
info "Step 3: Setting up Python virtual environment..."
if [[ ! -d "$INSTALL_DIR/.venv" ]]; then
python3 -m venv "$INSTALL_DIR/.venv"
ok "Virtual environment created at $INSTALL_DIR/.venv"
else
info "Virtual environment already exists"
fi
# Install/update dependencies
"$INSTALL_DIR/.venv/bin/pip" install --quiet --upgrade pip
"$INSTALL_DIR/.venv/bin/pip" install --quiet -r "$INSTALL_DIR/requirements.txt" 2>&1 | tail -1
ok "Python dependencies installed"
# ── Step 4: Generate service files from Python module ──────────────
info "Step 4: Generating systemd service units..."
PYTHON_BIN="$INSTALL_DIR/.venv/bin/python3"
SERVICES_MODULE="src.system.services"
# Generate pi-multifx-pedal.service
$PYTHON_BIN -c "
import sys
sys.path.insert(0, '$INSTALL_DIR')
from src.system.services import pedal_service_content
print(pedal_service_content(install_dir='$INSTALL_DIR'))
" > /etc/systemd/system/pi-multifx-pedal.service
ok "Generated /etc/systemd/system/pi-multifx-pedal.service"
# Generate multi-fx-pedal.target
$PYTHON_BIN -c "
import sys
sys.path.insert(0, '$INSTALL_DIR')
from src.system.services import pedal_target_content
print(pedal_target_content())
" > /etc/systemd/system/multi-fx-pedal.target
ok "Generated /etc/systemd/system/multi-fx-pedal.target"
# ── Step 5: Reload and enable ──────────────────────────────────────
info "Step 5: Reloading systemd and enabling services..."
if [[ "${NO_SYSTEMCTL:-false}" != true ]]; then
systemctl daemon-reload
systemctl enable pi-multifx-pedal.service
systemctl enable multi-fx-pedal.target
ok "Services enabled: pi-multifx-pedal.service + multi-fx-pedal.target"
else
info "Skipping systemctl enable (non-RPi environment)"
fi
# ── Step 6: Add 'pi' user to audio group ───────────────────────────
if groups pi | grep -q '\baudio\b' 2>/dev/null; then
ok "User 'pi' already in audio group"
else
usermod -a -G audio pi 2>/dev/null || true
info "Added 'pi' to audio group (will take effect on next login)"
fi
# ── Optional: Set up log rotation ──────────────────────────────────
LOGROTATE_FILE="/etc/logrotate.d/pi-multifx-pedal"
if [[ ! -f "$LOGROTATE_FILE" ]]; then
cat > "$LOGROTATE_FILE" <<'LOGROTATE'
/var/log/pi-multifx-pedal/*.log {
daily
rotate 7
compress
delaycompress
missingok
notifempty
copytruncate
}
LOGROTATE
ok "Log rotation configured at $LOGROTATE_FILE"
fi
# ── Summary ────────────────────────────────────────────────────────
echo ""
info "========== Installation Complete =========="
echo ""
echo " Service: pi-multifx-pedal.service"
echo " Target: multi-fx-pedal.target"
echo " Install: $INSTALL_DIR"
echo " Config: ~/.pedal/config.yaml"
echo " Presets: ~/.pedal/presets/"
echo ""
info "Start now:"
echo " sudo systemctl start multi-fx-pedal.target"
echo ""
info "Check status:"
echo " sudo systemctl status pi-multifx-pedal.service"
echo ""
info "Tail logs:"
echo " journalctl -fu pi-multifx-pedal.service"
echo ""
info "Stop the pedal:"
echo " sudo systemctl stop multi-fx-pedal.target"
scripts/midi_test.py
Executable
+221
View File
@@ -0,0 +1,221 @@
#!/usr/bin/env python3
"""Standalone MIDI test tool — loopback test, clock monitor, and CC debug.
Tests MIDI UART and/or USB ports without requiring the full pedal
application. Works headless (no display needed).
Usage:
# Default (UART on /dev/ttyAMA0)
python scripts/midi_test.py
# Custom UART port
python scripts/midi_test.py --uart /dev/ttyUSB0
# USB-MIDI only
python scripts/midi_test.py --no-uart --usb
# Display clock BPM in real-time
python scripts/midi_test.py --clock-monitor
# Check all available MIDI ports (discovery mode)
python scripts/midi_test.py --discover
"""
from __future__ import annotations
import argparse
import logging
import sys
import time
from typing import NoReturn
# ── Add src to path ─────────────────────────────────────────────────
from pathlib import Path
sys.path.insert(0, str(Path(__file__).resolve().parent.parent / "src"))
from midi.handler import (
MIDIHandler,
UARTMIDI,
USBMIDI,
CC_EXPRESSION,
CC_VOLUME,
)
logging.basicConfig(
level=logging.INFO,
format="%(asctime)s [%(levelname)s] %(message)s",
datefmt="%H:%M:%S",
)
logger = logging.getLogger("midi-test")
def discover_ports() -> None:
"""List available MIDI ports without opening them."""
print("=" * 50)
print("MIDI Port Discovery")
print("=" * 50)
# USBMIDI port listing
try:
import rtmidi # type: ignore[import-untyped]
midi_in = rtmidi.MidiIn()
midi_out = rtmidi.MidiOut()
midi_in.ignore_types(timing=True, sysex=False)
ports_in = midi_in.get_ports()
ports_out = midi_out.get_ports()
print(f"\nUSB-MIDI Input Ports ({len(ports_in)}):")
for i, p in enumerate(ports_in):
print(f" {i}: {p}")
print(f"\nUSB-MIDI Output Ports ({len(ports_out)}):")
for i, p in enumerate(ports_out):
print(f" {i}: {p}")
midi_in.close_port()
except ImportError:
print("\npython-rtmidi not installed — cannot scan USB ports")
# UART port check
print("\nUART MIDI Ports:")
for port in ["/dev/ttyAMA0", "/dev/ttyUSB0", "/dev/ttyS0"]:
p = Path(port)
if p.exists():
print(f" {port} — EXISTS")
else:
print(f" {port} — not found")
print()
print("On Raspberry Pi, also check:")
print(" /dev/serial0 (symlink to active UART)")
print(" dmesg | grep tty")
print(" dtoverlay=disable-bt (if using UART for MIDI)")
print(" core_freq=250 (for stable UART baud rate)")
def clock_monitor(handler: MIDIHandler) -> None:
"""Monitor MIDI clock BPM in real-time."""
def on_bpm(bpm: float) -> None:
logger.info("MIDI Clock BPM: %.1f", bpm)
handler.set_clock_callback(on_bpm)
logger.info("Clock monitor active — send MIDI clock to see BPM")
def dispatch_example(handler: MIDIHandler) -> None:
"""Subscribe to all MIDI events and print them."""
def on_pc(channel: int, program: int) -> None:
logger.info(" PC: ch=%d → program=%d", channel, program)
def on_cc(cc_number: int, value: int, channel: int) -> None:
logger.info(" CC: ch=%d, cc=%d → %d", channel, cc_number, value)
def on_note(note: int, velocity: int, channel: int) -> None:
logger.info(" Note: ch=%d, note=%d, vel=%d (on=%s)",
channel, note, velocity, velocity > 0)
def on_learn(mapping: object) -> None:
logger.info(" MIDI Learned: %s", mapping)
handler.set_pc_callback(on_pc)
handler.register_cc(CC_EXPRESSION, lambda v, c: on_cc(CC_EXPRESSION, v, c))
handler.register_cc(CC_VOLUME, lambda v, c: on_cc(CC_VOLUME, v, c))
handler.set_note_callback(on_note)
handler.set_midi_learn_callback(on_learn)
def send_test_messages(handler: MIDIHandler) -> None:
"""Send test MIDI messages out all open ports."""
logger.info("Sending test MIDI messages...")
handler.send(MIDIHandler.send_note_on(60, velocity=100))
time.sleep(0.1)
handler.send(MIDIHandler.send_note_off(60))
time.sleep(0.1)
handler.send(MIDIHandler.send_cc(7, 100))
time.sleep(0.1)
handler.send(MIDIHandler.send_pc(1))
time.sleep(0.1)
handler.send(MIDIHandler.send_pitch_bend(8192))
logger.info("Test messages sent (5 messages)")
def main() -> None:
parser = argparse.ArgumentParser(
description="MIDI test tool for Pi Multi-FX Pedal",
formatter_class=argparse.RawDescriptionHelpFormatter,
epilog=__doc__,
)
parser.add_argument("--uart", default="/dev/ttyAMA0",
help="UART device path (default: /dev/ttyAMA0)")
parser.add_argument("--no-uart", action="store_true",
help="Skip UART MIDI")
parser.add_argument("--no-usb", action="store_true",
help="Skip USB MIDI")
parser.add_argument("--usb-port", default="",
help="Filter for USB-MIDI port name")
parser.add_argument("--clock-monitor", action="store_true",
help="Display MIDI clock BPM in real-time")
parser.add_argument("--discover", action="store_true",
help="Discover available MIDI ports and exit")
parser.add_argument("--send-test", action="store_true",
help="Send test MIDI messages after startup")
parser.add_argument("--verbose", "-v", action="store_true",
help="Enable debug logging")
args = parser.parse_args()
if args.verbose:
logging.getLogger("midi").setLevel(logging.DEBUG)
if args.discover:
discover_ports()
return
handler = MIDIHandler()
uart_port = None if args.no_uart else args.uart
usb_enabled = not args.no_usb
print("=" * 50)
print("Pi Multi-FX Pedal — MIDI Test Tool")
print("=" * 50)
print(f" UART MIDI: {uart_port or 'disabled'}")
print(f" USB MIDI: {'enabled' if usb_enabled else 'disabled'}")
print(f" Clock mon: {'yes' if args.clock_monitor else 'no'}")
print(f" Send test: {'yes' if args.send_test else 'no'}")
print("=" * 50)
if args.clock_monitor:
clock_monitor(handler)
dispatch_example(handler)
print("\nStarting MIDI handler...")
handler.start(uart_port=uart_port, usb=usb_enabled, usb_port_name=args.usb_port)
print(f"\nActive interfaces: {handler.interface_names or 'none (software-only)'}")
if args.send_test:
send_test_messages(handler)
print("\nListening for MIDI messages...")
print("Press Ctrl+C to stop.\n")
try:
while True:
time.sleep(0.1)
except KeyboardInterrupt:
print("\nShutting down...")
finally:
handler.stop()
print("MIDI handler stopped.")
if __name__ == "__main__":
main()
scripts/models/nam/models.txt
+10
View File
@@ -0,0 +1,10 @@
5150_EVH
Diezel_VH4
Engl_Powerball
Fender_Bassman_59
Fender_Twin_Clean
Marshall_JCM800
Mesa_Boogie_MarkV
Orange_AD30
Roland_Jazz_Chorus
Vox_AC15_TopBoost
scripts/setup_audio.sh
+2
View File
@@ -25,6 +25,8 @@ ok() { printf "\e[32m[ OK ] %s\e[0m\n" "$*"; }
warn() { printf "\e[33m[WARN] %s\e[0m\n" "$*"; }
err() { printf "\e[31m[FAIL] %s\e[0m\n" "$*"; }
NEED_REBOOT=false
# ── Root check ─────────────────────────────────────────────────────
if [[ $EUID -ne 0 ]]; then
err "This script must be run as root (sudo ./setup_audio.sh)"