libfluidsynth  1.1.8
Data Structures | Macros | Enumerations
sfont.h File Reference

SoundFont plugins. More...

Data Structures

struct  _fluid_sfloader_t
 SoundFont loader structure. More...
 
struct  _fluid_sfont_t
 Virtual SoundFont instance structure. More...
 
struct  _fluid_preset_t
 Virtual SoundFont preset. More...
 
struct  _fluid_sample_t
 Virtual SoundFont sample. More...
 

Macros

#define fluid_sample_refcount(_sample)   ((_sample)->refcount)
 Get the reference count of a sample. More...
 
#define FLUID_SAMPLETYPE_MONO   1
 Flag for fluid_sample_t sampletype field for mono samples.
 
#define FLUID_SAMPLETYPE_RIGHT   2
 Flag for fluid_sample_t sampletype field for right samples of a stereo pair.
 
#define FLUID_SAMPLETYPE_LEFT   4
 Flag for fluid_sample_t sampletype field for left samples of a stereo pair.
 
#define FLUID_SAMPLETYPE_LINKED   8
 Flag for fluid_sample_t sampletype field, not used currently.
 
#define FLUID_SAMPLETYPE_OGG_VORBIS   0x10
 Flag for fluid_sample_t sampletype field for Ogg Vorbis compressed samples. More...
 
#define FLUID_SAMPLETYPE_ROM   0x8000
 Flag for fluid_sample_t sampletype field, ROM sample, causes sample to be ignored.
 

Enumerations

enum  { FLUID_PRESET_SELECTED, FLUID_PRESET_UNSELECTED, FLUID_SAMPLE_DONE }
 Some notification enums for presets and samples. More...
 

Detailed Description

SoundFont plugins.

It is possible to add new SoundFont loaders to the synthesizer. The API uses a couple of "interfaces" (structures with callback functions): fluid_sfloader_t, fluid_sfont_t, and fluid_preset_t. This API allows for virtual SoundFont files to be loaded and synthesized, which may not actually be SoundFont files, as long as they can be represented by the SoundFont synthesis model.

To add a new SoundFont loader to the synthesizer, call fluid_synth_add_sfloader() and pass a pointer to an fluid_sfloader_t structure. The important callback function in this structure is "load", which should try to load a file and returns a fluid_sfont_t structure, or NULL if it fails.

The fluid_sfont_t structure contains a callback to obtain the name of the SoundFont. It contains two functions to iterate though the contained presets, and one function to obtain a preset corresponding to a bank and preset number. This function should return a fluid_preset_t structure.

The fluid_preset_t structure contains some functions to obtain information from the preset (name, bank, number). The most important callback is the noteon function. The noteon function should call fluid_synth_alloc_voice() for every sample that has to be played. fluid_synth_alloc_voice() expects a pointer to a fluid_sample_t structure and returns a pointer to the opaque fluid_voice_t structure. To set or increment the values of a generator, use fluid_voice_gen_set() or fluid_voice_gen_incr(). When you are finished initializing the voice call fluid_voice_start() to start playing the synthesis voice.

Macro Definition Documentation

◆ fluid_sample_refcount

#define fluid_sample_refcount (   _sample)    ((_sample)->refcount)

Get the reference count of a sample.

Should only be called from within synthesis context (noteon method for example)

Referenced by fluid_ramsfont_create_sfont().

◆ FLUID_SAMPLETYPE_OGG_VORBIS

#define FLUID_SAMPLETYPE_OGG_VORBIS   0x10

Flag for fluid_sample_t sampletype field for Ogg Vorbis compressed samples.

Since
1.1.7

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Some notification enums for presets and samples.

Enumerator
FLUID_PRESET_SELECTED 

Preset selected notify.

FLUID_PRESET_UNSELECTED 

Preset unselected notify.

FLUID_SAMPLE_DONE 

Sample no longer needed notify.