Pulp Documentation

Pulp is a cross-platform framework for building audio plugins and applications. MIT-licensed. No royalties. No copyleft.

What is supported today

• Formats: VST3, AU v2, AUv3, CLAP, LV2, WAMv2, WebCLAP, standalone, headless
• Platforms: macOS, Windows (WASAPI, NSIS), Linux (ALSA, JACK, LV2), Browser (WASM)
• Audio: CoreAudio, WASAPI, ALSA, JACK, Web Audio API — device I/O, buffer processing, file read/write
• MIDI: CoreMIDI, Win32 MIDI, ALSA MIDI, Web MIDI, MIDI 2.0 UMP, MPE
• DSP: 30+ signal processors (oscillator, biquad, SVF, ladder, FIR, TPT, compressor, reverb, delay, chorus, phaser, FFT, convolver, and more)
• Parameters: thread-safe, automatable, serializable, with CLAP modulation, presets, undo/redo
• GPU rendering: Dawn (Metal/D3D12/Vulkan) + Skia Graphite on all platforms
• View system: TextEditor, ComboBox, TabPanel, ListBox, TreeView, and more — flex layout, JS scripting, hot-reload
• Plugin hosting: PluginScanner, PluginSlot, SignalGraph for DAW-like apps
• Testing: coverage tracked per-subsystem, per-platform, and per-surface on macOS, Linux, and Windows — see Test Coverage
• Shipping: codesign, notarization, DMG/PKG (macOS), NSIS (Windows), .deb (Linux), appcast

Where to start

• Getting Started — build your first plugin step by step
• Examples — browse example projects by category
• Capabilities — full capability matrix with status
• Overview — what Pulp is and how it is organized

Reference

• Modules — 13 subsystems with status, dependencies, and key headers
• API Reference — Doxygen-generated class and function documentation
• CLI Reference — pulp command reference
• CMake Reference — pulp_add_plugin() and build system functions
• Licensing & Acknowledgements — dependencies, standards, attribution
• Architecture — subsystem dependencies, thread model, GPU stack

Guides

• Building — requirements, options, platform notes
• Testing — running tests, validation, writing tests
• Web Plugins — WAMv2, WebCLAP, browser demos
• Docs Maintenance — how docs stay consistent with code

Policies

• Code Style — coding standards and architectural rules
• Agent Rules — contribution rules for AI agents