IpatchSF2Inst

IpatchSF2Inst — SoundFont instrument object

Stability Level

Stable, unless otherwise indicated

Functions

Properties

int attenuation Read / Write
gboolean attenuation-set Read / Write
int chorus Read / Write
gboolean chorus-set Read / Write
int coarse-tune Read / Write
gboolean coarse-tune-set Read / Write
int exclusive-class Read / Write
gboolean exclusive-class-set Read / Write
int filter-cutoff Read / Write
gboolean filter-cutoff-set Read / Write
int filter-q Read / Write
gboolean filter-q-set Read / Write
int fine-tune-override Read / Write
gboolean fine-tune-override-set Read / Write
int fixed-note Read / Write
gboolean fixed-note-set Read / Write
int fixed-velocity Read / Write
gboolean fixed-velocity-set Read / Write
int mod-env-attack Read / Write
gboolean mod-env-attack-set Read / Write
int mod-env-decay Read / Write
gboolean mod-env-decay-set Read / Write
int mod-env-delay Read / Write
gboolean mod-env-delay-set Read / Write
int mod-env-hold Read / Write
gboolean mod-env-hold-set Read / Write
int mod-env-release Read / Write
gboolean mod-env-release-set Read / Write
int mod-env-sustain Read / Write
gboolean mod-env-sustain-set Read / Write
int mod-env-to-filter-cutoff Read / Write
gboolean mod-env-to-filter-cutoff-set Read / Write
int mod-env-to-pitch Read / Write
gboolean mod-env-to-pitch-set Read / Write
int mod-lfo-delay Read / Write
gboolean mod-lfo-delay-set Read / Write
int mod-lfo-freq Read / Write
gboolean mod-lfo-freq-set Read / Write
int mod-lfo-to-filter-cutoff Read / Write
gboolean mod-lfo-to-filter-cutoff-set Read / Write
int mod-lfo-to-pitch Read / Write
gboolean mod-lfo-to-pitch-set Read / Write
int mod-lfo-to-volume Read / Write
gboolean mod-lfo-to-volume-set Read / Write
char * name Read / Write
IpatchRange * note-range Read / Write
gboolean note-range-set Read / Write
int note-to-mod-env-decay Read / Write
gboolean note-to-mod-env-decay-set Read / Write
int note-to-mod-env-hold Read / Write
gboolean note-to-mod-env-hold-set Read / Write
int note-to-vol-env-decay Read / Write
gboolean note-to-vol-env-decay-set Read / Write
int note-to-vol-env-hold Read / Write
gboolean note-to-vol-env-hold-set Read / Write
int pan Read / Write
gboolean pan-set Read / Write
int reverb Read / Write
gboolean reverb-set Read / Write
int root-note-override Read / Write
gboolean root-note-override-set Read / Write
int sample-coarse-end Read / Write
gboolean sample-coarse-end-set Read / Write
int sample-coarse-loop-end Read / Write
gboolean sample-coarse-loop-end-set Read / Write
int sample-coarse-loop-start Read / Write
gboolean sample-coarse-loop-start-set Read / Write
int sample-coarse-start Read / Write
gboolean sample-coarse-start-set Read / Write
int sample-end Read / Write
gboolean sample-end-set Read / Write
int sample-loop-end Read / Write
gboolean sample-loop-end-set Read / Write
int sample-loop-start Read / Write
gboolean sample-loop-start-set Read / Write
int sample-start Read / Write
gboolean sample-start-set Read / Write
int scale-tune Read / Write
gboolean scale-tune-set Read / Write
IpatchRange * velocity-range Read / Write
gboolean velocity-range-set Read / Write
int vib-lfo-delay Read / Write
gboolean vib-lfo-delay-set Read / Write
int vib-lfo-freq Read / Write
gboolean vib-lfo-freq-set Read / Write
int vib-lfo-to-pitch Read / Write
gboolean vib-lfo-to-pitch-set Read / Write
int vol-env-attack Read / Write
gboolean vol-env-attack-set Read / Write
int vol-env-decay Read / Write
gboolean vol-env-decay-set Read / Write
int vol-env-delay Read / Write
gboolean vol-env-delay-set Read / Write
int vol-env-hold Read / Write
gboolean vol-env-hold-set Read / Write
int vol-env-release Read / Write
gboolean vol-env-release-set Read / Write
int vol-env-sustain Read / Write
gboolean vol-env-sustain-set Read / Write

Object Hierarchy

    GObject
    ╰── IpatchItem
        ╰── IpatchContainer
            ╰── IpatchSF2Inst

Description

SoundFont instruments are children of IpatchSF2 objects and are referenced by IpatchSF2PZone objects.

Functions

ipatch_sf2_inst_new ()

IpatchSF2Inst *
ipatch_sf2_inst_new (void);

Create a new SoundFont instrument object.

Returns

New SoundFont instrument with a reference count of 1. Caller owns the reference and removing it will destroy the item, unless another reference is added (if its parented for example).


ipatch_sf2_inst_get_zones()

#define             ipatch_sf2_inst_get_zones(inst)

ipatch_sf2_inst_first ()

IpatchSF2Inst *
ipatch_sf2_inst_first (IpatchIter *iter);

Gets the first item in an instrument iterator. A convenience wrapper for ipatch_iter_first().

[skip]

Parameters

iter

Patch item iterator containing IpatchSF2Inst items

 

Returns

The first instrument in iter or NULL if empty.


ipatch_sf2_inst_next ()

IpatchSF2Inst *
ipatch_sf2_inst_next (IpatchIter *iter);

Gets the next item in an instrument iterator. A convenience wrapper for ipatch_iter_next().

[skip]

Parameters

iter

Patch item iterator containing IpatchSF2Inst items

 

Returns

The next instrument in iter or NULL if at the end of the list.


ipatch_sf2_inst_new_zone ()

void
ipatch_sf2_inst_new_zone (IpatchSF2Inst *inst,
                          IpatchSF2Sample *sample);

A convenience function for quickly creating a new instrument zone, adding it to inst and setting the zone's referenced sample to sample .

Parameters

inst

SoundFont instrument

 

sample

Referenced sample for new zone

 

ipatch_sf2_inst_set_name ()

void
ipatch_sf2_inst_set_name (IpatchSF2Inst *inst,
                          const char *name);

Sets the name of a SoundFont instrument.

Parameters

inst

Instrument to set name of

 

name

Value to set name to

 

ipatch_sf2_inst_get_name ()

char *
ipatch_sf2_inst_get_name (IpatchSF2Inst *inst);

Gets the name of a SoundFont instrument.

Parameters

inst

Instrument to get name of

 

Returns

Name of instrument or NULL if not set. String value should be freed when finished with it.

Property Details

The “attenuation” property

  “attenuation”              int

Volume attenuation.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [0,1440]

Default value: 0


The “attenuation-set” property

  “attenuation-set”          gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “chorus” property

  “chorus”                   int

Chorus.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [0,1000]

Default value: 0


The “chorus-set” property

  “chorus-set”               gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “coarse-tune” property

  “coarse-tune”              int

Coarse Tune.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-120,120]

Default value: 0


The “coarse-tune-set” property

  “coarse-tune-set”          gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “exclusive-class” property

  “exclusive-class”          int

Exclusive Class.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [0,127]

Default value: 0


The “exclusive-class-set” property

  “exclusive-class-set”      gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “filter-cutoff” property

  “filter-cutoff”            int

Low pass filter cutoff frequency.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [1500,13500]

Default value: 13500


The “filter-cutoff-set” property

  “filter-cutoff-set”        gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “filter-q” property

  “filter-q”                 int

Low pass filter Q factor.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [0,960]

Default value: 0


The “filter-q-set” property

  “filter-q-set”             gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “fine-tune-override” property

  “fine-tune-override”       int

Fine Tune.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-99,99]

Default value: 0


The “fine-tune-override-set” property

  “fine-tune-override-set”   gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “fixed-note” property

  “fixed-note”               int

Fixed Note.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-1,127]

Default value: -1


The “fixed-note-set” property

  “fixed-note-set”           gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “fixed-velocity” property

  “fixed-velocity”           int

Fixed Velocity.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-1,127]

Default value: -1


The “fixed-velocity-set” property

  “fixed-velocity-set”       gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “mod-env-attack” property

  “mod-env-attack”           int

Modulation envelope attack.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-12000,8000]

Default value: -12000


The “mod-env-attack-set” property

  “mod-env-attack-set”       gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “mod-env-decay” property

  “mod-env-decay”            int

Modulation envelope decay.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-12000,8000]

Default value: -12000


The “mod-env-decay-set” property

  “mod-env-decay-set”        gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “mod-env-delay” property

  “mod-env-delay”            int

Modulation envelope delay.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-12000,5000]

Default value: -12000


The “mod-env-delay-set” property

  “mod-env-delay-set”        gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “mod-env-hold” property

  “mod-env-hold”             int

Modulation envelope hold.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-12000,5000]

Default value: -12000


The “mod-env-hold-set” property

  “mod-env-hold-set”         gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “mod-env-release” property

  “mod-env-release”          int

Modulation envelope release.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-12000,8000]

Default value: -12000


The “mod-env-release-set” property

  “mod-env-release-set”      gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “mod-env-sustain” property

  “mod-env-sustain”          int

Modulation envelope sustain.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [0,1000]

Default value: 0


The “mod-env-sustain-set” property

  “mod-env-sustain-set”      gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “mod-env-to-filter-cutoff” property

  “mod-env-to-filter-cutoff” int

Modulation envelope to filter cutoff.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-12000,12000]

Default value: 0


The “mod-env-to-filter-cutoff-set” property

  “mod-env-to-filter-cutoff-set” gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “mod-env-to-pitch” property

  “mod-env-to-pitch”         int

Modulation envelope to pitch.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-12000,12000]

Default value: 0


The “mod-env-to-pitch-set” property

  “mod-env-to-pitch-set”     gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “mod-lfo-delay” property

  “mod-lfo-delay”            int

Modulation oscillator delay.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-12000,5000]

Default value: -12000


The “mod-lfo-delay-set” property

  “mod-lfo-delay-set”        gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “mod-lfo-freq” property

  “mod-lfo-freq”             int

Modulation oscillator frequency.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-16000,4500]

Default value: 0


The “mod-lfo-freq-set” property

  “mod-lfo-freq-set”         gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “mod-lfo-to-filter-cutoff” property

  “mod-lfo-to-filter-cutoff” int

Modulation oscillator to filter cutoff.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-12000,12000]

Default value: 0


The “mod-lfo-to-filter-cutoff-set” property

  “mod-lfo-to-filter-cutoff-set” gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “mod-lfo-to-pitch” property

  “mod-lfo-to-pitch”         int

Modulation oscillator to pitch.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-12000,12000]

Default value: 0


The “mod-lfo-to-pitch-set” property

  “mod-lfo-to-pitch-set”     gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “mod-lfo-to-volume” property

  “mod-lfo-to-volume”        int

Modulation oscillator to volume.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-960,960]

Default value: 0


The “mod-lfo-to-volume-set” property

  “mod-lfo-to-volume-set”    gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “name” property

  “name”                     char *

Name.

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: NULL


The “note-range” property

  “note-range”               IpatchRange *

Note Range.

Owner: IpatchSF2Inst

Flags: Read / Write


The “note-range-set” property

  “note-range-set”           gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “note-to-mod-env-decay” property

  “note-to-mod-env-decay”    int

MIDI note to modulation envelope decay.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-1200,1200]

Default value: 0


The “note-to-mod-env-decay-set” property

  “note-to-mod-env-decay-set” gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “note-to-mod-env-hold” property

  “note-to-mod-env-hold”     int

MIDI note to modulation envelope hold.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-1200,1200]

Default value: 0


The “note-to-mod-env-hold-set” property

  “note-to-mod-env-hold-set” gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “note-to-vol-env-decay” property

  “note-to-vol-env-decay”    int

MIDI note to volume envelope decay.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-1200,1200]

Default value: 0


The “note-to-vol-env-decay-set” property

  “note-to-vol-env-decay-set” gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “note-to-vol-env-hold” property

  “note-to-vol-env-hold”     int

MIDI note to volume envelope hold.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-1200,1200]

Default value: 0


The “note-to-vol-env-hold-set” property

  “note-to-vol-env-hold-set” gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “pan” property

  “pan”                      int

Panning.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-500,500]

Default value: 0


The “pan-set” property

  “pan-set”                  gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “reverb” property

  “reverb”                   int

Reverb.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [0,1000]

Default value: 0


The “reverb-set” property

  “reverb-set”               gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “root-note-override” property

  “root-note-override”       int

Root Note.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-1,127]

Default value: -1


The “root-note-override-set” property

  “root-note-override-set”   gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “sample-coarse-end” property

  “sample-coarse-end”        int

Sample End Coarse Ofs.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-32768,0]

Default value: 0


The “sample-coarse-end-set” property

  “sample-coarse-end-set”    gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “sample-coarse-loop-end” property

  “sample-coarse-loop-end”   int

Sample Loop End Coarse Ofs.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-32768,32767]

Default value: 0


The “sample-coarse-loop-end-set” property

  “sample-coarse-loop-end-set” gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “sample-coarse-loop-start” property

  “sample-coarse-loop-start” int

Sample Loop Start Coarse Ofs.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-32768,32767]

Default value: 0


The “sample-coarse-loop-start-set” property

  “sample-coarse-loop-start-set” gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “sample-coarse-start” property

  “sample-coarse-start”      int

Sample Start Coarse Ofs.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [0,32767]

Default value: 0


The “sample-coarse-start-set” property

  “sample-coarse-start-set”  gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “sample-end” property

  “sample-end”               int

Sample End Ofs.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [0,1073741823]

Default value: 0


The “sample-end-set” property

  “sample-end-set”           gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “sample-loop-end” property

  “sample-loop-end”          int

Sample Loop End Ofs.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [0,1073741823]

Default value: 0


The “sample-loop-end-set” property

  “sample-loop-end-set”      gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “sample-loop-start” property

  “sample-loop-start”        int

Sample Loop Start Ofs.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [0,1073741823]

Default value: 0


The “sample-loop-start-set” property

  “sample-loop-start-set”    gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “sample-start” property

  “sample-start”             int

Sample Start Ofs.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [0,1073741823]

Default value: 0


The “sample-start-set” property

  “sample-start-set”         gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “scale-tune” property

  “scale-tune”               int

Scale Tune.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [0,1200]

Default value: 100


The “scale-tune-set” property

  “scale-tune-set”           gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “velocity-range” property

  “velocity-range”           IpatchRange *

Velocity Range.

Owner: IpatchSF2Inst

Flags: Read / Write


The “velocity-range-set” property

  “velocity-range-set”       gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “vib-lfo-delay” property

  “vib-lfo-delay”            int

Vibrato oscillator delay.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-12000,5000]

Default value: -12000


The “vib-lfo-delay-set” property

  “vib-lfo-delay-set”        gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “vib-lfo-freq” property

  “vib-lfo-freq”             int

Vibrato oscillator frequency.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-16000,4500]

Default value: 0


The “vib-lfo-freq-set” property

  “vib-lfo-freq-set”         gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “vib-lfo-to-pitch” property

  “vib-lfo-to-pitch”         int

Vibrato oscillator to pitch.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-12000,12000]

Default value: 0


The “vib-lfo-to-pitch-set” property

  “vib-lfo-to-pitch-set”     gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “vol-env-attack” property

  “vol-env-attack”           int

Volume envelope attack.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-12000,8000]

Default value: -12000


The “vol-env-attack-set” property

  “vol-env-attack-set”       gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “vol-env-decay” property

  “vol-env-decay”            int

Volume envelope decay.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-12000,8000]

Default value: -12000


The “vol-env-decay-set” property

  “vol-env-decay-set”        gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “vol-env-delay” property

  “vol-env-delay”            int

Volume envelope delay.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-12000,5000]

Default value: -12000


The “vol-env-delay-set” property

  “vol-env-delay-set”        gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “vol-env-hold” property

  “vol-env-hold”             int

Volume envelope hold.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-12000,5000]

Default value: -12000


The “vol-env-hold-set” property

  “vol-env-hold-set”         gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “vol-env-release” property

  “vol-env-release”          int

Volume envelope release.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [-12000,8000]

Default value: -12000


The “vol-env-release-set” property

  “vol-env-release-set”      gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE


The “vol-env-sustain” property

  “vol-env-sustain”          int

Volume envelope sustain.

Owner: IpatchSF2Inst

Flags: Read / Write

Allowed values: [0,1440]

Default value: 0


The “vol-env-sustain-set” property

  “vol-env-sustain-set”      gboolean

Owner: IpatchSF2Inst

Flags: Read / Write

Default value: FALSE

See Also

IpatchSF2, IpatchSF2PZone