Knobwerk

← Search

E.3 REGION OPCODES

APPENDIX E: SFZ SUPPORT > E.3 REGION OPCODES · PDF p. 125–127 · OS 1.4.1

Headers <global>, <master>, <group>, and <region> all support the same set of opcodes.

Pitch values can be specified as numeric MIDI key values or in IPN, where MIDI note 0 is called “C-1” (and consequently, middle C is C4).

E.3.1 REQUIRED OPCODES

A region (or a group, master, or global header preceding it) must minimally specify a sample (sample=...) and a pitch (via either key=... or pitch_keycenter=...). Regions that fail to meet this criterion will be ignored.

The sample opcode is a file path, relative to the location of the SFZ file. Use UNIX-style paths (with forward slashes) for best results.

Special rules for file names.

  • Space (blank) characters are allowed.
  • Equals (=) and balanced angle brackets (e.g. My<Sample>.wav) are not allowed.
  • Comment-opening tokens (// or /*) are forbidden.
  • Any trailing blank characters are ignored.

The “root note” of the sample can be specified via pitch_keycenter (note that the special value pitch_keycenter=sample is not supported). If it is not provided, then the key opcode is required.

All other opcodes are optional.

E.3.2 ZONES

  • lokey and hikey are processed and checked for overlap, but are not used internally. Instead, incoming notes are played using the key zone with the nearest root note.
  • lovel and hivel define velocity layers. Up to 128 velocity layers are supported in each key zone.
  • lorand and hirand enable random selection of samples within a velocity layer.

Special considerations:

  • All regions within the same velocity layer must either specify lorand and hirand, or not.’
  • All regions within the same velocity layer must specify equal-sized and non-overlapping ranges of the random space. For example, a velocity layer with 4 samples can be specified like this:

<region> lorand=0.00 hirand=0.25 sample=MySample1.wav

<region> lorand=0.25 hirand=0.50 sample=MySample2.wav

<region> lorand=0.50 hirand=0.25 sample=MySample3.wav

<region> lorand=0.75 hirand=1.00 sample=MySample4.wav

  • Random distribution is mutually exclusive with ordered round-robin.
  • seq_length and seq_position enable ordered round-robin within a velocity layer.

Special considerations:

  • All regions within the same velocity layer must either specify seq_length and seq_position, or not.
  • All regions within the same velocity layer must specify the same seq_length.
  • All regions within the same velocity layer must specify unique seq_position values in ascending order.
  • Ordered round-robin is mutually exclusive with random distribution.

E.3.3 PLAYBACK

Sample playback can be modified with the following opcodes:

  • offset and end set the playback start and end points, respectively. They are integers measured in audio samples.
  • loop_start and loop_end define the loop region, if any.

Special considerations:

  • These opcodes can be spelled either with or without an underscore. If both are present, with-underscore overrides without-underscore.
  • Both are integers measured in audio samples.
  • If not present in the SFZ file, loop points can be read from the SMPL chunk of compatible WAV files.
  • The presence of one or both of these opcodes, or a loop region in the WAV file’s metadata, implies loop_mode=loop_sustain (but this can be overridden via loop_mode=no_loop also being present.
  • loop_mode controls both the state and behavior of looping.

Special considerations:

  • This opcode can be spelled with or without an underscore. If both are present, with-underscore overrides without-underscore.
  • loop_mode=one_shot behaves identically to loop_mode=no_loop.
  • loop_crossfade controls the duration of crossfade at the end of each loop period. It is a floating-point number measured in seconds. Note that it cannot exceed the time between offset and loop_start, which both default to 0 if unset.

E.3.4 OTHER OPCODES

All other opcodes (including those relating to sound processing) are unsupported and will be ignored. A

ARPEGGIATOR 36

AUDIO ROUTING 17

AUDIO TRACK PARAMETERS 55

Amp 57

Filter 56, 57

LFO 60

Mod envelope 61

SRC 56

Trig 55, 56

AUTO SAMPLER 73

B

BACKUP 24

BREATH CONTROLLER 52

BUS TRACK PARAMETERS 64

C

CHAINS 38

CHORD/SCALE SETUP 30

CLASS COMPLIANT 24

COMPRESSOR 102

CONDITIONAL LOCKS 45

CONNECTORS 16

COPY, PASTE AND CLEAR 46

CREDITS AND CONTACT INFORMATION 85

D

DATA STRUCTURE 19

Patterns 19

Project 19

Samples 19

Songs 19

E

EFFECTS 100

F

FACTORY RESET 80

FILL EDIT MENU 46

FILL MODE 46

FILTER

Base-width 57

Multimode 56

FX MACHINES 100

Bypass 101

Chrono Pitch 101

Comb +/- Filter 102

Compressor 102

Daisy Delay 104

Degrader 104

Dirtshaper 105

Filterbank 106

Frequency Warper 107

Infinite Flanger 108

Lowpass Filter 108

Multimode Filter 109

Panoramic Chorus 109

Phase 98 110

Saturator Delay 110, 111

Supervoid Reverb 112, 113

Warble 114

G

GRID RECORDING MODE 40

I

INSTRUMENTS 33

K

KEYBOARD 30

KEYBOARD SCALES 119

KEY COMBINATIONS 81

L

LED BACKLIGHT 77, 78

LED INTENSITY 77, 78

LFO 60, 61, 62, 66, 68, 71

Modulation destinations 115

M

MACHINES 20, 86

Assigning to track 86

FX Machines 100

SRC Machines 86

MEMORIZE 47

METRONOME 29

MICRO TIMING 42

MIDI CC & NRPN 120

MIDI CONFIG 75

MIDI TRACKS 20, 21

Parameters 97

MIX TRACK PARAMETERS 69

MUTE MODE 31

N

NAMING SCREEN 23

O

OS UPGRADE 25

OVERBRIDGE

USB config 78

P

PAGE SETUP

Page setup menu 43

PANEL LAYOUT 14

PARAMETER LOCKS 44

PATTERN MODES

INDEX