Home

Usine Hollyhock SDK Wiki

Welcome to the Usine Hollyhock SDK documentation wiki. This SDK allows you to create custom user modules for the Usine Hollyhock modular environment using C++.

Quick Navigation

Getting Started

• Getting Started — Overview of the SDK, prerequisites, and your first module
• Writing User Modules on Windows — Step-by-step Visual Studio setup
• Writing User Modules on macOS — Step-by-step Xcode setup

Architecture & Reference

• SDK Class Diagram — Complete Mermaid class diagram of the SDK
• Module Architecture — How modules work, lifecycle, and data flow
• UserModuleBase Class — The base class every module inherits from
• UsineEventClass — The main data container class
• Data Types & Constants — All SDK types, structs, enums, and constants
• SDK Functions — Global utility functions (audio, threads, files, etc.)
• Utility Functions — Color, geometry, and numeric helpers
• Release Notes — SDK version history

Examples

Templates

• TemplateModuleSimple — Minimal starting template
• TemplateModule — Full template with all callback stubs
• MyModule — Simple frequency-to-period converter

Audio Processing

• AudioVolume — Multi-channel gain control with mute
• RingMod — Ring modulator effect
• RingModMultithread — Ring modulator with parallel threading
• Reverb — Freeverb-based reverb processor
• Granulator — Granular synthesis engine
• ArrayDelay — Per-channel array delay line

Data & MIDI Processing

• DataMultiply — Simple data multiplication
• DataSampler — Data recording and playback
• MidiTranspose — MIDI note transposition

Graphics & Visualization

• DataOscilloscope — Scrolling waveform display
• DrawBox — Interactive rectangle drawing
• DrawTrajectoryBox — Trajectory drawing with bezier curves
• SimplePad — Multi-pad XY controller
• VideoDimmer — Video frame processing

System & Advanced

• BackgroundJob — Asynchronous background tasks
• MultiThreading — Thread creation and synchronization
• GlobalArray — Shared global array manipulation
• UsineChunks — Chunk-based data persistence
• UsineObjects — Remote object access API
• UsinePointers — Raw pointer data passing

---

SDK Version: 702002 (Hollyhock 7)
License: MIT
Copyright: BrainModular / Adamson