zdoom
/
fluidsynth
mirror of https://github.com/ZDoom/fluidsynth.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update API doc of soundfont loader module

This commit is contained in:
derselbst 2018-06-03 07:04:17 +02:00
parent 77e608e3ce
commit c1a2a7af19
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
include/fluidsynth/sfont.h
View File

@ -31,30 +31,30 @@ extern "C" {
* @brief SoundFont plugins * @brief SoundFont plugins
* *
* It is possible to add new SoundFont loaders to the * It is possible to add new SoundFont loaders to the
* synthesizer. The API uses a couple of "interfaces" (structures * synthesizer. This API allows for virtual SoundFont files to be loaded
* 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 * and synthesized, which may not actually be SoundFont files, as long as they
* can be represented by the SoundFont synthesis model. * can be represented by the SoundFont synthesis model.
* *
* To add a new SoundFont loader to the synthesizer, call * To add a new SoundFont loader to the synthesizer, call
* fluid_synth_add_sfloader() and pass a pointer to an * fluid_synth_add_sfloader() and pass a pointer to an
* fluid_sfloader_t structure. The important callback function in * #fluid_sfloader_t instance created by new_fluid_sfloader().
* this structure is "load", which should try to load a file and * On creation, you must specify a callback function \p load
* returns a #fluid_sfont_t structure, or NULL if it fails. * that will be called for every file attempting to load it and
* if successful returns a #fluid_sfont_t instance, or NULL if it fails.
* *
* The #fluid_sfont_t structure contains a callback to obtain the * The #fluid_sfont_t structure contains a callback to obtain the
* name of the SoundFont. It contains two functions to iterate * name of the SoundFont. It contains two functions to iterate
* though the contained presets, and one function to obtain a * though the contained presets, and one function to obtain a
* preset corresponding to a bank and preset number. This * preset corresponding to a bank and preset number. This
* function should return a #fluid_preset_t structure. * function should return a #fluid_preset_t instance.
* *
* The #fluid_preset_t structure contains some functions to obtain * The #fluid_preset_t instance contains some functions to obtain
* information from the preset (name, bank, number). The most * information from the preset (name, bank, number). The most
* important callback is the noteon function. The noteon function * important callback is the noteon function. The noteon function
* is called by fluidsynth internally and
* should call fluid_synth_alloc_voice() for every sample that has * should call fluid_synth_alloc_voice() for every sample that has
* to be played. fluid_synth_alloc_voice() expects a pointer to a * to be played. fluid_synth_alloc_voice() expects a pointer to a
* #fluid_sample_t structure and returns a pointer to the opaque * #fluid_sample_t instance and returns a pointer to the opaque
* #fluid_voice_t structure. To set or increment the values of a * #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 * generator, use fluid_voice_gen_set() or fluid_voice_gen_incr(). When you are
* finished initializing the voice call fluid_voice_start() to * finished initializing the voice call fluid_voice_start() to