IpatchSF2Voice

typedef struct {
  /* Set by SF2VoiceCache converter via ipatch_sf2_voice_set_sample_data() */
  IpatchSampleData *sample_data; /* sample data for voice */
  IpatchSampleStore *sample_store; /* Cached store */
  guint32 sample_size;			/* size of sample in frames */

  /* Set by SF2VoiceCache converter */
  guint32 loop_start;		/* loop start offset (in samples) */
  guint32 loop_end;   /* loop end offset (in samples, 1st sample after loop) */
  guint32 rate;			/* sample rate */
  guint8 root_note;		/* MIDI root note of sample */
  gint8 fine_tune;		/* fine tune (in cents, -99 - 99) */
  guint16 reserved;		/* reserved (should be 0) */

  IpatchSF2GenArray gen_array; /* generator effect values */
  GSList *mod_list;		/* modulator list */

  /* IpatchSF2VoiceCache user defined */
  gpointer user_data;           /* Arbitrary data defined by IpatchSF2VoiceCache user */

  /* Set internally */
  int range_index;  /* index in ranges array (int *) to first selection range */
} IpatchSF2Voice;

IpatchSF2VoiceUpdate

typedef struct {
  guint16 voice; /* index of voice with parameter to update */

  union			/* new value for parameter */
  {
    gint16 ival;
    guint16 uval;
} IpatchSF2VoiceUpdate;

IpatchSF2VoiceSelInfo

typedef struct {
  IpatchSF2VoiceSelType type;
  int param1;
  int param2;				/* currently not used */
} IpatchSF2VoiceSelInfo;

IpatchSF2VoiceCacheItemFunc ()

void                (*IpatchSF2VoiceCacheItemFunc)      (IpatchSF2VoiceCache *cache,
                                                         GObject *item);

A callback function type which is called during voice cache population for each item which the voice cache is dependent on. This can be useful for determining when a voice cache needs to be updated or for real time effects.

IpatchSF2VoiceCache

typedef struct _IpatchSF2VoiceCache IpatchSF2VoiceCache;

IpatchSF2VoiceCacheUpdateHandler ()

int                 (*IpatchSF2VoiceCacheUpdateHandler) (IpatchSF2VoiceCache *cache,
                                                         int *select_values,
                                                         GObject *cache_item,
                                                         GObject *item,
                                                         GParamSpec *pspec,
                                                         const GValue *value,
                                                         IpatchSF2VoiceUpdate *updates,
                                                         guint max_updates);

Function prototype used to re-calculate SoundFont effect generators for a single object property change. Useful for real time effect changes.

enum IpatchSF2VoiceSelType

typedef enum
{
  IPATCH_SF2_VOICE_SEL_NOTE,		/* MIDI note range */
  IPATCH_SF2_VOICE_SEL_VELOCITY, /* MIDI velocity range */
  IPATCH_SF2_VOICE_SEL_AFTER_TOUCH, /* MIDI aftertouch range */
  IPATCH_SF2_VOICE_SEL_MIDI_CC /* MIDI custom controller (param1: ctrlnum) */
} IpatchSF2VoiceSelType;

IPATCH_SF2_VOICE_CACHE_MAX_SEL_VALUES

#define IPATCH_SF2_VOICE_CACHE_MAX_SEL_VALUES   32

IPATCH_SF2_VOICE_SEL_WILDCARD

#define IPATCH_SF2_VOICE_SEL_WILDCARD (G_MININT)

ipatch_sf2_voice_cache_declare_item()

#define             ipatch_sf2_voice_cache_declare_item(cache, item)

IPATCH_SF2_VOICE_CACHE_GET_VOICE()

#define             IPATCH_SF2_VOICE_CACHE_GET_VOICE(cache, index)

ipatch_sf2_voice_cache_new ()

IpatchSF2VoiceCache * ipatch_sf2_voice_cache_new        (IpatchSF2VoiceSelInfo *info,
                                                         int sel_count);

Create a new SoundFont voice cache object. The sel_count parameter defines the number of selection ranges for the cache. Examples of selection ranges include MIDI note and velocity ranges for a voice. The info parameter should be a pointer to an array of selection info structures which describes each selection type.

ipatch_sf2_voice_cache_set_default_mods ()

void                ipatch_sf2_voice_cache_set_default_mods
                                                        (IpatchSF2VoiceCache *cache,
                                                         GSList *mods);

Set the default modulator list for the voice cache. Modulator list is used directly and the allocation of the list is taken over by the voice cache.

ipatch_sf2_voice_cache_add_voice ()

IpatchSF2Voice *    ipatch_sf2_voice_cache_add_voice    (IpatchSF2VoiceCache *cache);

Adds a new initialized voice to a SoundFont voice cache.

ipatch_sf2_voice_cache_set_voice_range ()

void                ipatch_sf2_voice_cache_set_voice_range
                                                        (IpatchSF2VoiceCache *cache,
                                                         IpatchSF2Voice *voice,
                                                         guint sel_index,
                                                         int low,
                                                         int high);

Set a voice selection range. Selection ranges are used for selection criteria such as MIDI velocity and note ranges.

ipatch_sf2_voice_set_sample_data ()

void                ipatch_sf2_voice_set_sample_data    (IpatchSF2Voice *voice,
                                                         IpatchSampleData *sample_data);

Assign sample data to a SoundFont voice.

ipatch_sf2_voice_cache_sample_data ()

gboolean            ipatch_sf2_voice_cache_sample_data  (IpatchSF2Voice *voice,
                                                         GError **err);

Cache an already assigned sample data object of a voice. The sample data is cached as 16 bit mono native endian format, if not already cached, and the new cached sample is assigned to the sample_store field.

ipatch_sf2_voice_copy ()

void                ipatch_sf2_voice_copy               (IpatchSF2Voice *dest,
                                                         IpatchSF2Voice *src);

Copy a source (src) voice's information to a destination voice (dest). Does not copy selection criteria integers in parent IpatchSF2VoiceCache objects.

ipatch_sf2_voice_cache_optimize ()

void                ipatch_sf2_voice_cache_optimize     (IpatchSF2VoiceCache *cache);

Can be called after all voices have been added to a voice cache. Will optimize voice cache for use with ipatch_sf2_voice_cache_select(). NOTE: Currently does nothing, but will in the future..

ipatch_sf2_voice_cache_select ()

int                 ipatch_sf2_voice_cache_select       (IpatchSF2VoiceCache *cache,
                                                         int *select_values,
                                                         guint16 *index_array,
                                                         guint16 max_indexes);

Stores pointers to voices matching select_values criteria.

ipatch_sf2_voice_cache_update ()

int                 ipatch_sf2_voice_cache_update       (IpatchSF2VoiceCache *cache,
                                                         int *select_values,
                                                         GObject *cache_item,
                                                         GObject *item,
                                                         GParamSpec *pspec,
                                                         const GValue *value,
                                                         IpatchSF2VoiceUpdate *updates,
                                                         guint max_updates);