logue-sdk

The repository is organized by platform and includes tools for building projects.

Platform Directories

• platform/prologue/: Files, templates, and demo projects for prologue.
• platform/minilogue-xd/: Files, templates, and demo projects for minilogue xd.
• platform/nutekt-digital/: Files, templates, and demo projects for Nu:Tekt NTS-1 digital kit.
• platform/drumlogue/: Files and templates for drumlogue.
• platform/nts-1_mkii/: Files, templates, and demo projects for Nu:Tekt NTS-1 digital kit mkII.
• platform/nts-3_kaoss/: Files, templates, and demo projects for Nu:Tekt NTS-3 kaoss pad kit.
• platform/microkorg2/: Files, templates, and demo projects for microKORG2.
• platform/ext/: External dependencies and submodules.

Build Tools

• docker/: Source for Docker containers used to build projects for any platform without host OS dependencies. Using Docker is recommended for environment consistency.
• tools/: Tools and documentation for building projects or manipulating build artifacts. These are not required if using Docker.

When running as an Oscillator unit, the runtime provides a specific context (unit_runtime_osc_context_t) containing real-time parameters. Other module types (Effects) do not provide this specific real-time information.

Oscillator Context Fields

• shape_lfo: LFO shape.
• pitch: Pitch value (range 0x0000 to 0x9000 suggested).
• cutoff: Cutoff frequency (range 0x0000 to 0x1fff).
• resonance: Resonance (range 0x0000 to 0x1fff).
• amp_eg_phase: Amplitude envelope phase.
• amp_eg_state: Amplitude envelope state.

/** Oscillator specific unit runtime context. */
typedef struct unit_runtime_osc_context {
 int32_t  shape_lfo;
 uint16_t pitch;    // 0x0000 ~ 0x9000?
 uint16_t cutoff;   // 0x0000 ~ 0x1fff
 uint16_t resonance; // 0x0000 ~ 0x1fff    
 uint8_t  amp_eg_phase;
 uint8_t  amp_eg_state:3;
 uint8_t  padding0:5;
 uint8_t  padding1[4];
} unit_runtime_osc_context_t;

When developing an oscillator unit, the runtime provides a unit_runtime_osc_context_t structure containing real-time information necessary for synthesis:

• pitch[kMk2MaxVoices]: An array of 8 floats defining the pitch for each voice.
• trigger: A bit array where a bit is set to 1 (Hi) when a corresponding voice is triggered.
• unitModDataPlus / unitModDataPlusMinus: Optional modulation buffers. unitModDataPlus is normalized (0 to 1), while unitModDataPlusMinus is normalized (-1 to 1). Use these to write per-voice modulation signals.
• modDataSize: The size of the modulation buffers.
• bufferOffset: The offset from the start of the oscillator output buffer.
• voiceOffset: The starting voice index for this unit.
• voiceLimit: The maximum number of voices allowed for this unit.
• outputStride: The number of interleaved output streams.

/** Oscillator specific unit runtime context. */
typedef struct unit_runtime_osc_context 
{
  float pitch[kMk2MaxVoices]; 
  uint8_t trigger; // bit array
  float * unitModDataPlus; 
  float * unitModDataPlusMinus; 
  uint8_t modDataSize;
  uint16_t bufferOffset;
  uint8_t voiceOffset;
  uint8_t voiceLimit;
  uint16_t outputStride;
} unit_runtime_osc_context_t;

The NTS-1 digital kit mkII automatically maps parameters to physical controls based on their order in the .params array:

Oscillator (OSC)

• A & B Knobs: First two parameters.
• Edit Mode: Remaining parameters are accessed by holding OSC and turning the TYPE knob.

Modulation Effect (MOD)

• A & B Knobs: First two parameters.
• Edit Mode: Remaining parameters are accessed by holding MOD and turning the TYPE knob.

Delay Effect (DEL)

• A & B Knobs: First two parameters.
• Dry/Wet: The third parameter is mapped to holding DEL and turning the B knob.
• Edit Mode: Remaining parameters are accessed by holding DEL and turning the TYPE knob.

Reverb Effect (REV)

• A & B Knobs: First two parameters.
• Dry/Wet: The third parameter is mapped to holding REV and turning the B knob.
• Edit Mode: Remaining parameters are accessed by holding REV and turning the TYPE knob.

For effect units, you can control how parameters behave when switching between effects using the reserved bits in the parameter descriptor. This is managed via the kMk2FxParamMode enumeration in FxDefines.h.