From 550f853509aac407275b3da9e501ab6338424998 Mon Sep 17 00:00:00 2001 From: derselbst Date: Sat, 23 Jun 2018 14:34:30 +0200 Subject: [PATCH] update example fluidsynth_fx.c --- doc/fluidsynth_fx.c | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/fluidsynth_fx.c b/doc/fluidsynth_fx.c index 6300e3e9..ce2fb405 100644 --- a/doc/fluidsynth_fx.c +++ b/doc/fluidsynth_fx.c @@ -26,16 +26,16 @@ struct fx_data_t { /* This function implements the callback function of the audio driver * (see new_fluid_audio_driver2 below). The data argument is a pointer - * to your private data structure. 'len' is the number of samples in - * the buffers. 'nin' and 'nout' are the number of input and output - * audio buffers. 'in' and 'out' are an array of float buffers with - * the samples. The audio driver fills the 'in' buffers the incoming - * audio. The 'out' buffers should be filled by your function. The - * 'out' buffers will be sent to the audio output of the sound card. + * to your private data structure. 'len' is the number of audio frames + * in the buffers. 'nfx' and 'nout' are the number of input and output + * audio buffers. 'fx' and 'out' are arrays of float buffers containing + * the audio. The audio driver fills zero-initializes those buffers. + * You are responsible for filling up those buffers, as the result will + * be sent to the sound card. This is usually done by asking the synth + * to fill those buffers appropriately using fluid_synth_process() * - * IMPORTANT NOTE: The API was designed to be generic but none of the - * audio drivers currently handles audio input. Either 'nin' will be - * zero, or the buffers will be filled with zero samples. + * NOTE: The API was designed to be generic. Audio driver may fill the + * buffers with audio input from the soundcard, rather than zeros. */ int fx_function(void* data, int len, int nfx, float** fx,