Skip to content

AGENTS.md

Latest commit

 

History

History
58 lines (45 loc) · 2.42 KB

AGENTS.md

File metadata and controls

58 lines (45 loc) · 2.42 KB
Raw

SegDSP

Go SDR demodulator. Single-module, single-binary project.

Commands

# UI (run from ui/)
cd ui && npm ci && npm run build    # builds to content/
cd ui && npm run dev                 # dev server with proxy to :8080

# Go
go build -o segdsp .
go test -v -race ./...
golangci-lint run
go vet ./...
go fmt ./...

No Makefile or task runner exists.

Architecture

  • Entry point: segdsp.go (package main, all root *.go files)
  • dsp/ — DSP primitives (FIR, FFT, NCO, AGC, resamplers). Contains arch-specific code:
    • dsp/native/amd64/ — AMD64 assembly optimizations
    • dsp/native/c/ — C fallback implementations
  • demodcore/ — Demodulator interface + FM/AM implementations
  • eventmanager/ — Channel-based pub/sub event bus
  • recorders/ — WAV file recording
  • content/ — Built web UI (Vite output), embedded via go:embed
  • ui/ — Preact + Vite source for the web UI
  • control.go — WebSocket control message handler (runtime param changes)
  • helpers.go — Message types (FFT, device, control)
  • websocket.go — WebSocket server with broadcast + incoming control read loop

Gotchas

  • Docker builds use CGO_ENABLED=0 for static binaries despite native C code existing
  • Binary is named segdsp locally but segdsp_worker inside Docker containers
  • The app cannot start without a running radioserver instance (external SDR IQ source, not in this repo)
  • Default branch is master; releases are tag-triggered via GitHub Actions (release.yml)
  • Multi-arch Docker builds (amd64, arm32v6, arm64v8) use QEMU emulation in CI — no host-side cross-compilation needed
  • content/ is auto-generated by npm run build in ui/ — do not edit directly
  • The Dockerfile has a multi-stage build: node → go → alpine runtime

Testing

All tests are pure unit tests (DSP math primitives). No integration tests, no external service dependencies, no test fixtures. Benchmark files exist (benchmark_*.go).

Conventions

  • HTTP routing uses stdlib http.HandleFunc directly, no router library
  • CLI flags parsed with stdlib flag, env vars set in common.go:setEnv()
  • WebSocket endpoint at /ws, UI at /, assets at /assets/*
  • Control messages: clients send {"MessageType":"control", ...} JSON to /ws when WebCanControl=true
  • Runtime changes to demod mode / filter BW / squelch trigger a DSP pipeline rebuild
  • Frequency changes are applied directly to the RadioServer without rebuild