Login
Instruments
Login

Classes and Structures

Structure: INSTRUMENT

Represents a single instrument within a SoundFont. The presets for this instrument are stored separately.

The available accessors are:

  • INST-NAME instrument -> string
  • INST-REGION instrument -> (simple-array instrument-region)

Structure: INSTRUMENT-REGION

Represents a SoundFont instrument region. Regions contain all the parameters necessary in order to synthesize a note.

The available accessors are:

  • INST-REGION-SAMPLE instrument-region -> (or null sample-header)

Additional functions for retrieving various information about the region:

  • INST-REGION-SAMPLE-START instrument-region -> fixnum
  • INST-REGION-SAMPLE-END instrument-region -> fixnum
  • INST-REGION-SAMPLE-START-LOOP instrument-region -> fixnum
  • INST-REGION-SAMPLE-END-LOOP instrument-region -> fixnum
  • INST-REGION-START-ADDRESS-OFFSET instrument-region -> fixnum
  • INST-REGION-END-ADDRESS-OFFSET instrument-region -> fixnum
  • INST-REGION-START-LOOP-ADDRESS-OFFSET instrument-region -> fixnum
  • INST-REGION-END-LOOP-ADDRESS-OFFSET instrument-region -> fixnum
  • INST-REGION-MODULATION-LFO-TO-PITCH instrument-region -> fixnum
  • INST-REGION-VIBRATO-LFO-TO-PITCH instrument-region -> fixnum
  • INST-REGION-MODULATION-ENVELOPE-TO-PITCH instrument-region -> fixnum
  • INST-REGION-INITIAL-FILTER-CUTOFF-FREQUENCY instrument-region -> double-float
  • INST-REGION-INITIAL-FILTER-Q instrument-region -> double-float
  • INST-REGION-MODULATION-LFO-TO-FILTER-CUTOFF-FREQUENCY instrument-region -> fixnum
  • INST-REGION-MODULATION-ENVELOPE-TO-FILTER-CUTOFF-FREQUENCY instrument-region -> fixnum
  • INST-REGION-MODULATION-LFO-TO-VOLUME instrument-region -> double-float
  • INST-REGION-CHORUS-EFFECTS-SEND instrument-region -> double-float
  • INST-REGION-REVERB-EFFECTS-SEND instrument-region -> double-float
  • INST-REGION-PAN instrument-region -> double-float
  • INST-REGION-DELAY-MODULATION-LFO instrument-region -> double-float
  • INST-REGION-FREQUENCY-MODULATION-LFO instrument-region -> double-float
  • INST-REGION-DELAY-VIBRATO-LFO instrument-region -> double-float
  • INST-REGION-FREQUENCY-VIBRATO-LFO instrument-region -> double-float
  • INST-REGION-DELAY-MODULATION-ENVELOPE instrument-region -> double-float
  • INST-REGION-ATTACK-MODULATION-ENVELOPE instrument-region -> double-float
  • INST-REGION-HOLD-MODULATION-ENVELOPE instrument-region -> double-float
  • INST-REGION-DECAY-MODULATION-ENVELOPE instrument-region -> double-float
  • INST-REGION-SUSTAIN-MODULATION-ENVELOPE instrument-region -> double-float
  • INST-REGION-RELEASE-MODULATION-ENVELOPE instrument-region -> double-float
  • INST-REGION-KEY-NUMBER-TO-MODULATION-ENVELOPE-HOLD instrument-region -> fixnum
  • INST-REGION-KEY-NUMBER-TO-MODULATION-ENVELOPE-DECAY instrument-region -> fixnum
  • INST-REGION-DELAY-VOLUME-ENVELOPE instrument-region -> double-float
  • INST-REGION-ATTACK-VOLUME-ENVELOPE instrument-region -> double-float
  • INST-REGION-HOLD-VOLUME-ENVELOPE instrument-region -> double-float
  • INST-REGION-DECAY-VOLUME-ENVELOPE instrument-region -> double-float
  • INST-REGION-SUSTAIN-VOLUME-ENVELOPE instrument-region -> double-float
  • INST-REGION-RELEASE-VOLUME-ENVELOPE instrument-region -> double-float
  • INST-REGION-KEY-NUMBER-TO-VOLUME-ENVELOPE-HOLD instrument-region -> fixnum
  • INST-REGION-KEY-NUMBER-TO-VOLUME-ENVELOPE-DECAY instrument-region -> fixnum
  • INST-REGION-KEY-RANGE-START instrument-region -> fixnum
  • INST-REGION-KEY-RANGE-END instrument-region -> fixnum
  • INST-REGION-VELOCITY-RANGE-START instrument-region -> fixnum
  • INST-REGION-VELOCITY-RANGE-END instrument-region -> fixnum
  • INST-REGION-INITIAL-ATTENUATION instrument-region -> double-float
  • INST-REGION-COARSE-TUNE instrument-region -> fixnum
  • INST-REGION-FINE-TUNE instrument-region -> fixnum
  • INST-REGION-SAMPLE-MODES instrument-region -> t/loop-mode
  • INST-REGION-SCALE-TUNING instrument-region -> fixnum
  • INST-REGION-EXCLUSIVE-CLASS instrument-region -> fixnum
  • INST-REGION-ROOT-KEY instrument-region -> fixnum

Function: INST-REGION-CONTAINS-P instrument-region fixnum fixnum -> boolean

Checks to see if the instrument region covers the given key and velocity. Returns T of it does, or NIL otherwise.