DawDreamer

User Guide

  • Installation
    • Quick Install
    • System Requirements
    • Building from Source
      • Prerequisites
      • Platform-Specific Build Instructions
        • Linux
        • Docker
        • Windows
        • macOS
      • Building a Wheel
      • Faust Libraries
    • Verification
    • Troubleshooting
      • Common Issues
  • Quick Start Guide
    • Basic Concepts
    • Example 1: Faust Sine Wave
    • Example 2: VST Plugin Chain
    • Example 3: Audio Playback and Effects
    • Key Concepts Explained
      • RenderEngine
      • Processor Graph
      • Parameter Automation
      • BPM and Timing
    • Next Steps
  • User Guide
    • Render Engine and BPM
      • Creating a RenderEngine
      • Setting BPM
        • Static BPM
        • Dynamic BPM Automation
      • Rendering Audio
        • Render by Duration
        • Render by Beats
      • Getting Audio Output
      • Graph Management
        • Loading a Graph
        • Re-rendering
      • Timing and Synchronization
        • Audio-Rate Automation
        • PPQN-Rate Automation
      • Best Practices
      • Performance Considerations
      • Example: Complete Workflow
    • Faust Processor
      • New to Faust?
      • Basic Usage
        • Creating a Faust Processor
        • Loading DSP from File
        • Loading DSP from String
      • Parameters
        • Listing Parameters
        • Setting Parameters
        • Getting Parameter Values
      • Example: Stereo Reverb
      • Multi-Channel Processing
      • Polyphony
        • Enabling Polyphony
        • Example
      • Soundfiles
        • Example
        • Advanced Example: 88-Key Piano
      • Parameter Automation
      • Tips and Best Practices
      • Common Issues
      • Further Reading
    • Plugin Processor
      • Basic Usage
        • Creating a Plugin Processor
      • Plugin State Management
        • Opening the Editor
        • Saving and Loading State
        • Loading Presets
      • Parameters
        • Listing Parameters
        • Setting Parameters
        • Getting Parameter Values
        • Getting Parameter Ranges
      • Parameter Automation
      • MIDI Support
        • Adding Individual Notes
        • Loading MIDI Files
        • Saving MIDI Files
        • Clearing MIDI
      • Graph Integration
        • Basic Chain
        • Re-rendering
      • Multi-Channel Buses
        • Checking Bus Support
        • Sidechain Processing
        • Channel Counts
      • Complete Example
      • Tips and Best Practices
      • Common Issues
      • Further Reading
    • Playback Processor
      • Basic Usage
      • Changing Playback Data
      • Multi-Channel Audio
      • Looping
      • Working with Different Sample Rates
      • Complete Example
      • Tips and Best Practices
      • Common Issues
      • Advanced: Time-Stretching and Pitch-Shifting
      • See Also
    • Playback Warp Processor
      • Basic Usage
        • Time-Stretching and Pitch-Shifting
        • Advanced Options
      • Ableton Live Warp Markers
        • Loading .asd Files
        • Clip Properties
        • Manual Warp Markers
      • Multiple Clip Positions
      • Complete Example
      • Tips and Best Practices
      • Common Issues
      • Further Reading
    • Built-In Effect Processors
      • Add Processor (Mixer)
        • Basic Usage
        • Setting Gain Levels
        • Complete Example
      • Filter Processor
        • Filter Modes
        • Basic Usage
        • Setting Parameters
        • Parameter Automation
      • Compressor Processor
        • Parameters
        • Basic Usage
        • Adjusting Parameters
      • Reverb Processor
        • Parameters
        • Basic Usage
        • Adjusting Parameters
      • Panner Processor
        • Panning Rules
        • Basic Usage
        • Adjusting Parameters
      • Delay Processor
        • Parameters
        • Basic Usage
        • Adjusting Parameters
      • Processor-Specific Tips
    • Overview
    • Processor Types
    • Basic Workflow
    • Common Patterns
      • Multi-Channel Routing
      • Parallel Processing
      • Parameter Automation
    • Recording Intermediate Outputs
    • Complete Example: Multi-Track Mix
    • Best Practices
    • Troubleshooting
    • Next Steps
  • Examples
    • Faust Box API
    • Faust to JAX/Flax Transpilation
    • Faust to QDax
    • Mashup Generator
    • DJ Mixing
    • Multiprocessing with Plugins
    • XML Synth Sound Rendering
    • Running the Examples
      • Prerequisites
      • Jupyter Notebooks
      • Python Scripts
    • Additional Resources
    • Contributing Examples
    • Next Steps

API Reference

  • API Reference
    • Core Classes
      • RenderEngine
        • RenderEngine
      • ProcessorBase
        • ProcessorBase
    • Processors
      • FaustProcessor
        • FaustProcessor
      • PluginProcessor
        • PluginProcessor
      • PlaybackProcessor
        • PlaybackProcessor
      • PlaybackWarpProcessor
        • PlaybackWarpProcessor
      • FilterProcessor
        • FilterProcessor
      • CompressorProcessor
        • CompressorProcessor
      • ReverbProcessor
        • ReverbProcessor
      • PannerProcessor
        • PannerProcessor
      • DelayProcessor
        • DelayProcessor
      • AddProcessor
        • AddProcessor
      • SamplerProcessor
        • SamplerProcessor
      • OscillatorProcessor
        • OscillatorProcessor
    • Faust API
      • Faust Module
        • dawdreamer.faust.FaustContext
        • dawdreamer.faust.createLibContext()
        • dawdreamer.faust.destroyLibContext()
        • dawdreamer.faust.boxToSignals()
      • Faust Box API
        • dawdreamer.faust.box.Box
        • dawdreamer.faust.box.SType
        • Audio Primitives
        • Math Operations
        • Trigonometric Functions
        • Delay and Memory
        • User Interface Elements
      • Faust Signal API
        • dawdreamer.faust.signal.Signal
        • dawdreamer.faust.signal.sigInt()
        • dawdreamer.faust.signal.sigReal()
        • dawdreamer.faust.signal.sigInput()
        • dawdreamer.faust.signal.sigDelay()
        • dawdreamer.faust.signal.sigIntCast()
        • dawdreamer.faust.signal.sigFloatCast()
      • Further Reading
    • Indices and Tables

Additional Resources

  • Plugin Compatibility
    • Legend
    • Effect Plugins
    • Instrument/Synthesizer Plugins
    • General Compatibility Notes
      • Format Compatibility
      • Common Issues
      • Platform-Specific Notes
    • Testing Your Plugins
    • Contributing Compatibility Info
    • Alternative to VST Plugins
    • See Also
  • Release Notes
    • v0.8.4 (2025)
    • v0.8.3 (2024-09-09)
    • v0.8.0 (2023-11-17)
    • v0.7.4 (2023-09-26)
    • v0.7.3 (2023-09-18)
    • v0.7.1 (2023-06-01)
    • v0.7.0 (2023-05-18)
    • v0.6.3 (2022-04-19)
    • v0.6.1 (2022-04-04)
    • v0.6.0 (2022-03-24)
    • v0.5.8.1 (2021-01-13)
    • v0.5.7.8 (2021-10-09)
    • v0.5.7 (2021-08-14)
    • v0.5.6 (2021-05-09)
    • v0.5.0 (2021-04-01)
    • v0.4.0 (2020-12-01)
    • v0.1.0 (2020-08-14)
    • Upgrade Guide
      • v0.8.0 Breaking Changes
      • v0.7.0 Breaking Changes
      • v0.6.0 Breaking Changes
      • v0.5.7 Breaking Changes
    • Versioning Scheme
    • Future Roadmap
    • Contributing
    • See Also
DawDreamer
  • Search

© Copyright 2025, David Braun. Last updated on Nov 18, 2025.

Built with Sphinx using a theme provided by Read the Docs.