update docs about file callback struct

This commit is contained in:
derselbst 2017-11-26 09:29:35 +01:00
parent 8fb1f500e0
commit 332c221cfb
2 changed files with 7 additions and 6 deletions

View file

@ -85,12 +85,12 @@ Changes in FluidSynth 2.0.0 concerning developers:
- remove fluid_synth_set_gen2(), fluid_synth_set_gen() now behaves as fluid_synth_set_gen2()
- remove struct fluid_mod_t from public API, use the getters and setters of mod.h instead
- remove struct _fluid_gen_t, fluid_gen_set_default_values() and enum fluid_gen_flags from public API
<br /><br />
- all public \c fluid_settings_* functions that return an integer which is not meant to be interpreted as bool consistently return either FLUID_OK or FLUID_FAILED
- all public delete_* functions return void and are safe when called with NULL
- the shell command handler was decoupled internally, as a consequence the param list of new_fluid_server() and new_fluid_cmd_handler() was adapted
- reverb: roomsize is now limited to an upper threshold of 1.0
<br /><br />
- add "synth.volenv" a setting for volume envelope processing
- add "midi.autoconnect" a setting for automatically connecting fluidsynth to available MIDI input ports
- add support for polyonic key pressure events, see fluid_event_key_pressure()
@ -98,6 +98,7 @@ Changes in FluidSynth 2.0.0 concerning developers:
- add individual reverb setters: fluid_synth_set_reverb_roomsize(), fluid_synth_set_reverb_damp(), fluid_synth_set_reverb_width(), fluid_synth_set_reverb_level()
- add individual chorus setters: fluid_synth_set_chorus_nr(), fluid_synth_set_chorus_level(), fluid_synth_set_chorus_speed(), fluid_synth_set_chorus_depth(), fluid_synth_set_chorus_type()
- introduce a separate data type for sequencer client IDs: #fluid_seq_id_t
- add file callback struct to _fluid_sfloader_t and expose new_fluid_defsfloader() to enable soundfont loading from memory
\section NewIn1_1_9 Whats new in 1.1.9?

View file

@ -77,7 +77,7 @@ enum {
struct _fluid_sfloader_t {
void* data; /**< User defined data pointer */
/** File operation callbacks 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;
/**
@ -102,12 +102,12 @@ struct _fluid_sfloader_t {
*/
struct _fluid_file_callbacks_t {
/**
* Opens the file indicated by \c path in binary read mode.
* Accepts UTF-8 encoding.
* Opens the file or memory indicated by \c filename in binary read mode.
* \c filename matches the one provided during the fluid_synth_sfload() call.
*
* @return returns a file handle on success, NULL otherwise
*/
void * (* fopen )(const char * path);
void * (* fopen )(const char * filename);
/**
* Reads \c count bytes to the specified buffer \c buf.