xtc/examples/README.md
2026-11-06 22:00:35 +01:00

27 lines
1.5 KiB
Markdown

# Examples
`native_gain.c` is a complete trusted native C effect compiled into an offline
graph. Build/run with `cmake --build build --target native-gain && ./build/native-gain`; it needs
no GUI/server/plugin SDK. See ../docs/NATIVE_API.md for lifecycle/event contracts.
`quality_preview.c` uses public C MIDI, recorder and gain-ramp APIs to generate
matched raw/smoothed listening fixtures. Run `cmake --build build --target quality-preview`; generated
WAVs remain in the ignored build directory. See docs/AUDIO_QUALITY.md for the
listening sequence and the distinction between automated checks and human
listening acceptance. It never starts a backend or plays audio.
`projects/playback-test.xtc` is a four-bar playback check requiring no MIDI
hardware, media or plugins. See [example songs](projects/README.md).
`projects/midi-demo.xtc` is an original media/plugin-free MIDI example installed
under `share/xtc/examples`. See projects/README.md for opening and playback.
[Steinberg SDK examples](steinberg/README.md) build an official-SDK VST3 gain
and MIDI synth, qualify them with Steinberg's validator and the xtc C host, and
render a WAV offline. An optional Windows ASIO device diagnostic is also provided;
it is not yet a qualified audio backend.
[JUCE examples](juce/README.md) provide a VST3/standalone Soft Keys instrument
using the C engine, native controls and keyboard, presets, JUCE DSP effects,
MIDI-to-WAV rendering and explicit VST3 hosting checks. The external JUCE SDK is
AGPLv3/commercial and is not required by normal builds.