zdoom/fluidsynth
0
0
Fork 0
mirror of https://github.com/ZDoom/fluidsynth.git synced 2025-01-19 16:00:51 +00:00
Code Issues Projects Releases Packages Wiki Activity

clarify API doc of fluid_synth_add_sfloader()

Browse source
This commit is contained in:
derselbst 2017-11-27 14:26:48 +01:00
parent 7a22eb87f6
commit 3b1a4ccad0
2 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
include/fluidsynth/sfont.h
View file

@ -75,7 +75,7 @@ enum {
* SoundFont loader structure. * SoundFont loader structure.
*/ */
struct _fluid_sfloader_t { struct _fluid_sfloader_t {
void* data; /**< User defined data pointer */ void* data; /**< User defined data pointer used by _fluid_sfloader_t::load() */
/** Callback structure specifying file operations used during soundfont loading to allow custom loading, such as from memory */ /** Callback structure specifying file operations used during soundfont loading to allow custom loading, such as from memory */
const fluid_file_callbacks_t* file_callbacks; const fluid_file_callbacks_t* file_callbacks;

12
src/synth/fluid_synth.c
View file

@ -3365,10 +3365,10 @@ fluid_synth_start_voice(fluid_synth_t* synth, fluid_voice_t* voice)
} }
/** /**
* Add a SoundFont loader interface. * Add a SoundFont loader to the synth. This function takes ownership of \c loader
* and frees it automatically upon \c synth destruction.
* @param synth FluidSynth instance * @param synth FluidSynth instance
* @param loader Loader API structure, used directly and should remain allocated * @param loader Loader API structure
* as long as the synth instance is used.
* *
* SoundFont loaders are used to add custom instrument loading to FluidSynth. * SoundFont loaders are used to add custom instrument loading to FluidSynth.
* The caller supplied functions for loading files, allocating presets, * The caller supplied functions for loading files, allocating presets,
@ -3397,7 +3397,7 @@ fluid_synth_add_sfloader(fluid_synth_t* synth, fluid_sfloader_t* loader)
* stack. Presets are searched starting from the SoundFont on the * stack. Presets are searched starting from the SoundFont on the
* top of the stack, working the way down the stack until a preset is found. * top of the stack, working the way down the stack until a preset is found.
* *
* @param synth SoundFont instance * @param synth FluidSynth instance
* @param filename File to load * @param filename File to load
* @param reset_presets TRUE to re-assign presets for all MIDI channels * @param reset_presets TRUE to re-assign presets for all MIDI channels
* @return SoundFont ID on success, FLUID_FAILED on error * @return SoundFont ID on success, FLUID_FAILED on error
@ -3470,7 +3470,7 @@ new_fluid_sfont_info (fluid_synth_t *synth, fluid_sfont_t *sfont)
/** /**
* Unload a SoundFont. * Unload a SoundFont.
* @param synth SoundFont instance * @param synth FluidSynth instance
* @param id ID of SoundFont to unload * @param id ID of SoundFont to unload
* @param reset_presets TRUE to re-assign presets for all MIDI channels * @param reset_presets TRUE to re-assign presets for all MIDI channels
* @return FLUID_OK on success, FLUID_FAILED on error * @return FLUID_OK on success, FLUID_FAILED on error
@ -3559,7 +3559,7 @@ fluid_synth_sfunload_callback(void* data, unsigned int msec)
/** /**
* Reload a SoundFont. The SoundFont retains its ID and index on the SoundFont stack. * Reload a SoundFont. The SoundFont retains its ID and index on the SoundFont stack.
* @param synth SoundFont instance * @param synth FluidSynth instance
* @param id ID of SoundFont to reload * @param id ID of SoundFont to reload
* @return SoundFont ID on success, FLUID_FAILED on error * @return SoundFont ID on success, FLUID_FAILED on error
*/ */