Welcome to the DecentSampler Developer Guide

DecentSampler is a free sampling plug-in that allows music composers to use multi-samples in the DecentSampler format. This document is a guide to creating samples in that format.

If you have no familiarity with the DecentSamples format, this video is a great place to start. After that, you’ll want to start at the File Format Overview to learn a bit more about how to create sample libraries.

If you’d rather not map your samples by hand, the built-in Preset Editor can do it for you; see The Preset Editor.

Note

This project is under active development.

Contents

• File Format Overview
  • The top-level <DecentSampler> element (required)
    • How loud your samples come out
• The <ui> element
  • The <tab> element
  • The <button> element
    • The <state> element
  • The <image> element
  • The <multiFrameImage> element
  • The <label> element
  • The <rectangle> element
  • The <line> element
  • The <oscilloscope> element
  • The <drawbars> element
  • The <labeled-knob> and <control> elements
    • Multi-State Controls
  • The <menu> element
    • The <option> element
  • The <xyPad> element
    • The <x> and <y> elements
  • The <keyboard> element
    • The <color> element
• The <groups> element (required)
  • A note about volume and pan
  • The <group> element
    • The <sample> element
    • The <oscillator> element
      • Polyphony and glide
• The <effects> element
  • The <effect> element
    • Low-pass, Band pass, and Hi-pass filter
    • Notch EQ Filter
    • Peak EQ Filter
    • Low Shelf and High Shelf EQ Filters
    • Gain effect
    • Reverb effect
    • Delay effect
    • Chorus effect
    • Phaser effect
    • Convolution effect
    • Pitch Shifter effect
    • Wave Folder effect
    • Wave Shaper effect
    • Stereo Simulator effect
    • Bit Crusher effect
    • Compressor effect
    • Stutter effect
• The <midi> element
  • The <cc> element
  • The <note> element
    • Responding to the first and last held note
  • The <velocity> element
    • Bindings within the <midi> section
• The <noteSequences> element
  • The <sequence> element
    • The <note> element
• The <arpeggiator> element
  • Attributes
  • Order Modes
  • Example
• The <modulators> element
  • The <lfo> element
  • The <envelope> element
  • The <midiCC> element
  • The <midiVelocity> element
  • The <mpeTimbre> element
  • The <mpePressure> element
  • The <random> element
  • How to use <binding>s in conjunction with modulators
    • Controlling Modulator Parameters with Bindings
      • Switching a modulator on and off
      • Bindable parameters by modulator type
      • Example: controlling LFO parameters from UI knobs
      • Choosing between multiply and modulate for amplitude
  • Modulator scope: global or voice-level
• The <tags> element
  • The <tag> element
  • Example
• The <buses> element
  • The <bus> element
  • Effects and buses
  • Using buses in the sample library
• The DSLibraryInfo.xml file
  • The <DecentSamplerLibraryInfo> element
  • The <presetMenu> element
    • The <menu> element
    • The <preset> element
    • How unmapped presets are handled
    • Fallback and error-tolerance rules
• The Preset Editor
  • Opening the editor
  • The window
  • Adding samples
  • Mapping samples to notes
  • Inherited values
  • The Zone tab
  • Group settings
  • Velocity layers
  • Round robins
  • Loops
  • Slicing loops that follow the tempo
  • Processing samples
  • Saving, undo and checking your work
  • Other tools
  • Preferences and themes
• Appendix A: The Color Format
• Appendix B: The <binding> element
  • Binding Parameters for Targeting Note Sequences
  • Controllable Parameters
    • UI Parameters
    • Effects Parameters
    • Bus-related Parameters
  • Translation Modes
    • Mode #1: linear
    • Mode #2: table
    • Mode #3: fixed_value
• Appendix C: Boilerplate .dspreset File
• Useful Tutorials and Resources
  • UI Elements
    • How to Color the Keys of the On-Screen Keyboard
      • How to turn keyboard note coloring on and off using bindings
    • How to add Dropdown Menus
      • Dropdown Menus
        • The new fixed_value translation type
        • Customizing Menu Colors
        • Text Alignment
        • Dynamic Control via Bindings
    • How to add Buttons to your user interfaces
    • Example: How to control two groups with knobs
    • How to Use Animations
      • Controlling Animations
        • Current Frame
      • Frame Rate
      • Playback Mode
      • Conclusion
  • Presets and Snapshots
    • How to ship snapshots with your library
      • Making a snapshot
      • The file format
        • The <DecentSamplerSnapshot> element
        • The <preset> element
        • The <controls> element
        • The <settings> element
        • The <midi> element
      • Where your snapshots appear
      • Copy-protected libraries
  • Sample Mapping and Effects
    • How to Use Buses and Auxiliary Outputs
      • Auxilary Outputs
      • Buses
      • Examples
        • Example 1: Routing audio to an auxiliary output
        • Example 2: Applying effects to audio using buses
      • Conclusion
    • How to Use Note Sequences within your Sample Libraries
      • Creating a sequence by hand
      • The <noteSequences> element
        • The <sequence> element
          • The <note> element
      • Creating a sequence using the sample editor
      • Triggering sequences using MIDI
      • Triggering note sequences using the UI
      • Conclusion
    • How to Use the Arpeggiator within your Sample Libraries
      • The <arpeggiator> element
      • Binding knobs to the arpeggiator
        • An on/off toggle
        • A discrete order selector
        • Numeric knobs
      • Modulating the arpeggiator with an LFO
      • Conclusion
    • How to control parameters using tags (Example: Mic-level Knobs)
      • Targeting individual samples and oscillators
    • How to do voice-muting for drums
    • How to implement true legato
    • How to add Keyswitches
    • How to Use FM Synthesis (fm6op)
      • Quick Start
      • Concepts
        • Operators
        • Carriers and Modulators
        • Algorithms
        • Feedback
        • Detune
        • Fixed Frequency Mode
        • Velocity Sensitivity
        • Per-Operator Envelopes
      • DX7-Compatible 4-Stage Operator Envelope
        • Example: Brass patch with DX7 envelope
      • Per-Operator ADSR Example: DX7 E. Piano Transient
      • Real-Time Modulation with Bindings
        • Example: Knob controls modulation depth (morph timbre)
        • Supported binding parameters
      • Classic Sound Recipes
        • Drawbar Organ (Algorithm 32 — all carriers)
        • Bell / FM Marimba (Algorithm 5 — three 2-op pairs)
        • Choir Pad (Algorithm 19 — shared modulator with detuned carriers)
      • Tips
    • How to make loops that follow the tempo
      • Step 1: Map the loop
      • Step 2: Decide where the slices go
      • Step 3: Fill the gaps
      • Step 4: Add controls
      • Things to know
    • How to add LFOs and Envelopes
    • How to use Legato in Decent Sampler [Video]
    • How to do Voice-Muting (like for hi-hats) and create Legato samples
    • How to use Convolution Reverb in Decent Sampler
    • How to add Tempo-synced Delay
  • Developer Tools
    • How to Validate a Preset File
      • Accessing the Tool
      • What Gets Checked
        • 1. Preset File Availability
        • 2. XML Validity
        • 3. File Path References
      • Reading the Report
      • Common Errors and How to Fix Them
        • Missing file
        • Incorrect capitalization