Config

Config for jird.

class Config

Overall config controlling jird.

t

Basic time in seconds. Real note durations are the jird duration multiplied by this basic time. For example the note 1:1 will have duration t when played back.

Type:

float

f

Basic frequency in Hz. Real note frequencies are the jird note frequency multiplied by this basic frequency. For example the note 1:1 will have frequency f when played back.

Type:

float

tuning_method

Method to use for tuning midi notes to the desired frequency. Choices are PITCH_BEND, which sends a pitch bend before each midi note to adjust its frequency, and SCALA, which uses Scala scl and kbm files to map each midi note onto its frequency.

Type:

TuningMethod

synth

Synth to use for playback. Choices are FLUIDSYNTH, ZYNADDSUBFX, and SURGE_XT.

Type:

Synth

volume

Overall volume for playback. Interpretation varies by synth; typical values are given in the example configs for each synth.

Type:

float

pitch_bend_range

Midi pitch bend range, in semitones, to assume when calculating bends. Defaults to two.

Type:

int

edo

If specified, music is tempered using edo equal divisions of the octave.

Type:

int, optional

sample_rate

Sample rate to use when rendering audio. Defaults to 44100

Type:

int

soundfont

Path of soundfont to use when using fluidsynth.

Type:

Path, optional

verbose

Whether to show logs and subprocess output. Defaults to False.

Type:

bool

parts

Part-specific config for each jird part. See PartConfig for details.

Type:

list of PartConfig

class PartConfig

Config for each jird part.

volume

Volume for this part.

Type:

float

panning

Pan (position left/right in stereo image) for this part.

Type:

int

instrument

Path to instrument patch to use for this part. For ZynAddSubFX this is an xiz file. For Surge XT this is an fxp file. Not used by fluidsynth.

Type:

Path, optional

program

Midi program to use for this part. Used with fluidsynth to specify which instrument in the soundfont to use.

Type:

int, optional