soundfont2/typings/types/generator.d.ts

A SoundFont2 parser for Node.js and web browsers

/**
 * Generator (or modulator) types. These are defined in a specific order, following the spec. The
 * enum ID corresponds with the ID in the spec, so the unused and reserved fields should not be
 * removed.
 */
export declare enum GeneratorType {
    /**
     * The offset in sample data points beyond the `start` sample header.
     */
    StartAddrsOffset = 0,
    /**
     * The offset in sample data points beyond the `end` sample header.
     */
    EndAddrsOffset = 1,
    /**
     * The offset in sample data points beyond the `startLoop` sample header to the first sample data
     * point to be repeated in the loop for the instrument.
     */
    StartLoopAddrsOffset = 2,
    /**
     * The offset in sample data points beyond the `endLoop` sample header to the sample data point
     * considered equivalent to the `startLoop` sample data point for the loop for this instrument.
     */
    EndLoopAddrsOffset = 3,
    /**
     * The offset in 32768 sample data point increments beyond the `start` sample header and the
     * first sample data point to be played in the instrument.
     */
    StartAddrsCoarseOffset = 4,
    /**
     * The degree (in cents) to which a full scale excursion of the modulation LFO will influence the
     * pitch.
     */
    ModLFOToPitch = 5,
    /**
     * The degree (in cents) to which a full scale excursion of the vibrato LFO will influence the
     * pitch.
     */
    VibLFOToPitch = 6,
    /**
     * The degree (in cents) to which a full scale excursion of the modulation envelope will
     * influence pitch.
     */
    ModEnvToPitch = 7,
    /**
     * The cutoff and resonant frequency of the lowpass filter in absolute cent units.
     */
    InitialFilterFc = 8,
    /**
     * The height above DC gain in centibels which the filter resonance exhibits at the cutoff
     * latency.
     */
    InitialFilterQ = 9,
    /**
     * The degree (in cents) to which a full scale excursion of the modulation LFO will influence the
     * filter cutoff frequency.
     */
    ModLFOToFilterFc = 10,
    /**
     * The degree (in cents) to which a full scale excursion of the modulation envelope will
     * influence the filter cutoff frequency.
     */
    ModEnvToFilterFc = 11,
    /**
     * The offset in 32768 sample data point increments beyond the `end` sample header and the last
     * sample data point to be played in this instrument.
     */
    EndAddrsCoarseOffset = 12,
    /**
     * The degree (in centibels) to which a full scale excursion of the modulation LFO will influence
     * volume.
     */
    ModLFOToVolume = 13,
    /**
     * Unused generator. If this generator is encountered, it should be ignored.
     */
    Unused1 = 14,
    /**
     * The degree (in 0.1% units) to which the audio output of the note is sent to the chorus effects
     * processor.
     */
    ChorusEffectsSend = 15,
    /**
     * The degree (in 0.1% units) to which the audio output of the note is sent to the reverb effects
     * processor.
     */
    ReverbEffectsSend = 16,
    /**
     * The degree (in 0.1% units) to which the dry audio output of the note is positioned to the left
     * or right output.
     */
    Pan = 17,
    /**
     * Unused generator. If this generator is encountered, it should be ignored.
     */
    Unused2 = 18,
    /**
     * Unused generator. If this generator is encountered, it should be ignored.
     */
    Unused3 = 19,
    /**
     * Unused generator. If this generator is encountered, it should be ignored.
     */
    Unused4 = 20,
    /**
     * The delay time (in absolute timecents) from key on until the modulation LFO begins its upward
     * ramp from zero value. A value of zero indicates a one second delay.
     */
    DelayModLFO = 21,
    /**
     * The frequency (in absolute cents) of the modulation LFO's triangular period. A value of 0
     * indicates a frequency of 8.176 Hz.
     */
    FreqModLFO = 22,
    /**
     * The delay time (in absolute timecents) from key on until the vibrato LFO begins its upwards
     * ramp from zero value. A value of zero indicates a one second delay.
     */
    DelayVibLFO = 23,
    /**
     * The frequency (in absolute cents) of the vibrato LFO's triangular period. A value of zero
     * indicates a frequency of 8.176 Hz.
     */
    FreqVibLFO = 24,
    /**
     * The delay time (in absolute timecents) between key on and the start of the attack phase on the
     * modulation envelope. A value of zero indicates a one second delay.
     */
    DelayModEnv = 25,
    /**
     * The time (in absolute timecents) from the end of the modulation envelope delay time until the
     * point at which the modulation envelope value reaches its peak.
     */
    AttackModEnv = 26,
    /**
     * The time (in absolute timecents) from the end of the attack phase to the entry into decay
     * phase, during which the envelope value is held at its peak. A value of zero indicates a one
     * second hold time.
     */
    HoldModEnv = 27,
    /**
     * The time (in absolute timecents) for a 100% change in the modulation envelope value during
     * decay phase.
     */
    DecayModEnv = 28,
    /**
     * The decrease in level (expressed in 0.1% units) to which the modulation envelope ramps during
     * the decay phase.
     */
    SustainModEnv = 29,
    /**
     * The time (in absolute timecents) for a 100% change in the modulation envelope value during
     * release phase.
     */
    ReleaseModEnv = 30,
    /**
     * The degree (in timecents per key number units) to which the hold time of the modulation
     * envelope is decreased by increasing the MIDI key number.
     */
    KeyNumToModEnvHold = 31,
    /**
     * The degree (in timecents per key number units) to which the hold time of the modulation
     * envelope is decreased by increasing the MIDI key number.
     */
    KeyNumToModEnvDecay = 32,
    /**
     * The delay time (in absolute timecents) between key on and the start of the attack phase of the
     * volume envelope. A value of zero indicates a one second delay.
     */
    DelayVolEnv = 33,
    /**
     * The delay time (in absolute timecents) from the end of the volume envelope delay time until
     * the point at which the volume envelope value reaches its peak.
     */
    AttackVolEnv = 34,
    /**
     * The time (in absolute timecents) from the end of the attack phase to the entry into decay
     * phase during which the volume envelope value is held at its peak. A value of zero indicates a
     * one second hold time.
     */
    HoldVolEnv = 35,
    /**
     * The time (in absolute timecents) for a 100% change in the volume envelope value during decay
     * phase.
     */
    DecayVolEnv = 36,
    /**
     * The decrease in level (expressed in centibels) to which the volume envelope value ramps during
     * the decay phase.
     */
    SustainVolEnv = 37,
    /**
     * The time (in absolute centibels) for a 100% change in the volume envelope during release
     * phase. A value of zero indicates a one second decay time.
     */
    ReleaseVolEnv = 38,
    /**
     * The degree (in timecents per key number units) to which the hold time of the volume envelope
     * is increased by increasing the MIDI key number.
     */
    KeyNumToVolEnvHold = 39,
    /**
     * The degree (in timecents per key number units) to which the hold time of the volume envelope
     * is decreased by increasing the MIDI key number.
     */
    KeyNumToVolEnvDecay = 40,
    /**
     * Index of an instrument in the `INST` sub-chunk. This generator and `SampleId` are the only
     * Index generators.
     */
    Instrument = 41,
    /**
     * Unused generator, reserved for future implementation. If this generator is encountered, it
     * should be ignored.
     */
    Reserved1 = 42,
    /**
     * The key range that the preset or instrument zone applies to. This generator and `VelRange` are
     * the only Range generators.
     */
    KeyRange = 43,
    /**
     * The velocity range that the preset or instrument zone applies to. This generator and
     * `KeyRange` are the only Range generators.
     */
    VelRange = 44,
    /**
     * The offset in 32768 sample data point increments beyond the `startLoop` sample header and the
     * first sample data point to be repeated in this instrument's loop.
     */
    StartLoopAddrsCoarseOffset = 45,
    /**
     * Forces the MIDI key number to be interpreted as the value given. This can only appear at
     * instrument level and must be between 0 and 127.
     */
    KeyNum = 46,
    /**
     * Forces the MIDI velocity to be interpreted as the value given. This can only appear at
     * instrument level and must be between 0 and 127.
     */
    Velocity = 47,
    /**
     * The attenuation (in centibels) by which a note is attenuated below full scale.
     */
    InitialAttenuation = 48,
    /**
     * Unused generator, reserved for future implementation. If this generator is encountered, it
     * should be ignored.
     */
    Reserved2 = 49,
    /**
     * The offset in 32768 sample data point increments beyond the `endLoop` sample header to the
     * sample data point considered equivalent to the `startLoop`.
     */
    EndLoopAddrsCoarseOffset = 50,
    /**
     * The pitch offset (in semitones) which should be applied to the note. It is additive with
     * `FineTune`.
     */
    CoarseTune = 51,
    /**
     * The pitch offset (in cents) which should be applied to the note. It is additive with
     * `CoarseTune`.
     */
    FineTune = 52,
    /**
     * Index of a sample in the `SHDR` sub-chunk. This generator and `Instrument` are the only Index
     * generators.
     */
    SampleId = 53,
    /**
     * The value which gives a variety of boolean flags describing the sample for the current
     * instrument zone. A zero indicates a sound reproduced with no loop, one indicates a sound which
     * loops continuously and three indicates a sound which loops for the duration of key depression,
     * then proceeds to play the remainder of the sample.
     */
    SampleModes = 54,
    /**
     * Unused generator, reserved for future implementation. If this generator is encountered, it
     * should be ignored.
     */
    Reserved3 = 55,
    /**
     * The degree to which the MIDI key number influences pitch.
     */
    ScaleTuning = 56,
    /**
     * The capability for key depression in a given instrument to terminate the playback of other
     * instruments.
     */
    ExclusiveClass = 57,
    /**
     * The MIDI key number at which the sample is to be played back at its original sample rate. If
     * not present, or if present with a value of -1, the sample header parameter original key is
     * used in its place.
     */
    OverridingRootKey = 58,
    /**
     * Unused generator. If this generator is encountered, it should be ignored.
     */
    Unused5 = 59,
    /**
     * Unused generator. If this generator is encountered, it should be ignored.
     */
    EndOper = 60
}
/**
 * All unused generators.
 */
export declare type UnusedGenerator = GeneratorType.Unused1 | GeneratorType.Unused2 | GeneratorType.Unused3 | GeneratorType.Unused4 | GeneratorType.Unused5 | GeneratorType.Reserved1 | GeneratorType.Reserved2 | GeneratorType.Reserved3 | GeneratorType.EndOper;
/**
 * All range generators.
 */
export declare type RangeGenerator = GeneratorType.KeyRange | GeneratorType.VelRange;
/**
 * All index generators.
 */
export declare type IndexGenerator = GeneratorType.Instrument | GeneratorType.SampleId;
/**
 * All value generators.
 */
export declare type ValueGenerator = Exclude<GeneratorType, UnusedGenerator | RangeGenerator | IndexGenerator>;
/**
 * The default value for all generator types (where applicable).
 */
export declare const DEFAULT_GENERATOR_VALUES: {
    [key in ValueGenerator]: number;
};
/**
 * Describes a range of MIDI key numbers (for the `keyRange` generator) or MIDI velocities (for the
 * `velRange` generator) with a minimum (lo) and maximum (hi) value.
 */
export interface Range {
    /**
     * Low value for the range.
     */
    lo: number;
    /**
     * High value for the range.
     */
    hi: number;
}
export interface Generator {
    /**
     * The ID of the generator.
     */
    id: GeneratorType;
    /**
     * Generator value. If the range is not specified, this should be set.
     */
    value?: number;
    /**
     * The range of the generator. If the value is not specified, this should be set.
     */
    range?: Range;
}