92 lines
4.3 KiB
Markdown
92 lines
4.3 KiB
Markdown
# xtc — a lightweight, modular DAW
|
|
|
|
`xtc` is a new, energyXT-inspired digital audio workstation project. It is not a clone and contains no energyXT source code or assets.
|
|
|
|
## Design decisions
|
|
|
|
- **Modular engine first:** sequencer, instruments, effects, mixers and I/O are nodes in one processing graph.
|
|
- **C core:** project model, graph, DSP and audio engine are implemented in C.
|
|
- **FLTK/C++ GUI:** C++ is confined to the graphical interface and calls the core through a C API.
|
|
- **Linux first:** keep backend-specific details behind an interface.
|
|
- **Small increments:** build and test each milestone before adding features.
|
|
|
|
## Current status
|
|
|
|
This repository is a starter scaffold, not a production DAW. It currently provides:
|
|
- a small C library/API;
|
|
- a mono graph model with port validation, cycle rejection and topological ordering;
|
|
- compiled offline plans with preallocated buffers, sine oscillator, audio source, gain, meter and output nodes;
|
|
- C tests for deterministic rendering, routing, validation and lifecycle;
|
|
- an optional JACK-compatible mono backend with start/stop, routing and status;
|
|
- safe control/audio plan handoff and concurrent replacement tests;
|
|
- an optional FLTK shell with engine controls, view switching and backend status;
|
|
- a modular graph editor with transactional edits and live plan adoption status;
|
|
- versioned project save/load and a timeline for tracks and clips;
|
|
- sample-counted transport, selection, move/trim, timeline zoom and scrolling;
|
|
- WAV import/graph playback, bounded recording and missing-asset relinking;
|
|
- architecture, format, GUI, roadmap, and decision documents.
|
|
|
|
The JACK backend has passed software-loopback testing; physical-device playback
|
|
and capture are unverified. MIDI and plugin hosting are not implemented yet.
|
|
|
|
## Build
|
|
|
|
Requirements: a C compiler, a C++ compiler, GNU Make, and `pkg-config`. FLTK is optional for the core and tests.
|
|
|
|
```sh
|
|
make
|
|
make test
|
|
```
|
|
|
|
`make` also builds `build/xtc-check`, a headless core startup/shutdown
|
|
check. Use `make debug` for a separate debug build and test run. See
|
|
[docs/BUILD.md](docs/BUILD.md) for the inspected toolchain and baseline limits.
|
|
|
|
Build the optional FLTK GUI if FLTK is installed:
|
|
|
|
```sh
|
|
make gui
|
|
```
|
|
|
|
Run the GUI:
|
|
|
|
```sh
|
|
./build/xtc
|
|
```
|
|
|
|
The GUI opens JACK and offers Play/Stop/Reconnect, backend status and view
|
|
switching. The initial empty graph is silent. Modular Graph supports adding,
|
|
moving and deleting oscillator/audio/gain/meter/output nodes and connecting ports.
|
|
Import WAV (Ctrl+I) creates playable clips; Add region creates silent placeholders.
|
|
Record captures JACK input to a chosen WAV; Stop finalizes and adds the take.
|
|
Save the project after recording. External asset paths must remain available;
|
|
select a missing clip and use File/Relink selected audio to repair it.
|
|
See [audio workflow and limits](docs/AUDIO_FILES.md). The mixer remains a placeholder.
|
|
Use Add track/Add region, drag regions or their edges, and Zoom +/-; scrollbars pan.
|
|
Ctrl+N/O/S creates, opens or saves a project; Save As chooses another path.
|
|
Arrangement edits stop playback; graph edits remain live.
|
|
The ruler seeks while stopped. Stop pauses; Reconnect and project load reset position. F5 starts, F8 stops, Space toggles, F6 reconnects, and Ctrl+1/2/3
|
|
switches views. Ctrl+Q closes the client and window. No physical ports are
|
|
connected automatically. In Modular Graph, drag output to input to connect;
|
|
select a node or wire and press Delete to remove it. Invalid edits leave the
|
|
active graph intact; queued changes are labeled until the engine adopts them.
|
|
See [GUI documentation](docs/GUI.md).
|
|
With JACK development files and an existing JACK-compatible server, run the
|
|
isolated software-loopback test with `make test-jack` and the record/reopen/play
|
|
acceptance test with `make test-jack-audio`. It connects only test
|
|
clients. See [engine documentation](docs/AUDIO_ENGINE.md) for configuration,
|
|
routing, ownership and recovery.
|
|
|
|
Clean generated files:
|
|
|
|
```sh
|
|
make clean
|
|
```
|
|
|
|
## Suggested first agent task
|
|
|
|
Read `AGENT.md` and `docs/ARCHITECTURE.md`. Inspect the existing implementation, run `make test`, and report gaps before adding the next feature. Do not jump directly to plugin hosting or a full sequencer.
|
|
|
|
## License
|
|
|
|
The project is scaffolded under the MIT License; see `LICENSE`. Review the licenses of any future dependencies before distribution.
|