libfluidsynth  2.3.5
fluidsynth_process.c

Usage examples of how to render audio using fluid_synth_process() (advanced users only)

/*
* This is a C99 program that outlines different usage examples for fluid_synth_process()
*/
#include <stdio.h>
#include <string.h>
#include <fluidsynth.h>
int main()
{
// any arbitrary number of audio samples to render during on call of fluid_synth_process()
enum { SAMPLES = 512 };
// ...creation of synth omitted...
// USECASE1: render all dry audio channels + reverb and chorus to one stereo channel
{
// planar sample buffers that received synthesized (monophonic) audio
float left[SAMPLES], right[SAMPLES];
// array of buffers used to setup channel mapping
float *dry[1 * 2], *fx[1 * 2];
// first make sure to zero out the sample buffers every time before calling fluid_synth_process()
memset(left, 0, sizeof(left));
memset(right, 0, sizeof(right));
// setup channel mapping for a single stereo channel to which to render all dry audio to
dry[0] = left;
dry[1] = right;
// Setup channel mapping for a single stereo channel to which to render effects to.
// Just using the same sample buffers as for dry audio is fine here, as it will cause the effects to be mixed with dry output.
// Note: reverb and chorus together make up two stereo channels. Setting up only one stereo channel is sufficient
// as the channels wraps around (i.e. chorus will be mixed with reverb channel).
fx[0] = left;
fx[1] = right;
int err = fluid_synth_process(synth, SAMPLES, 2, fx, 2, dry);
if(err == FLUID_FAILED)
{
puts("oops");
}
// USECASE2: only render dry audio and discard effects
// same as above, but call fluid_synth_process() like:
int err = fluid_synth_process(synth, SAMPLES, 0, NULL, 2, dry);
if(err == FLUID_FAILED)
{
puts("oops");
}
}
// USECASE3: render audio and discard all samples
{
int err = fluid_synth_process(synth, SAMPLES, 0, NULL, 0, NULL);
if(err == FLUID_FAILED)
{
puts("oops");
}
}
// USECASE4: multi-channel rendering, i.e. render all audio and effects channels to dedicated audio buffers
// ofc it‘s not a good idea to allocate all the arrays on the stack
{
// lookup number of audio and effect (stereo-)channels of the synth
// see "synth.audio-channels", "synth.effects-channels" and "synth.effects-groups" settings respectively
int n_aud_chan = fluid_synth_count_audio_channels(synth);
// by default there are two effects stereo channels (reverb and chorus) ...
int n_fx_chan = fluid_synth_count_effects_channels(synth);
// ... for each effects unit. Each unit takes care of the effects of one MIDI channel.
// If there are less units than channels, it wraps around and one unit may render effects of multiple
// MIDI channels.
// for simplicity, allocate one single sample pool
float samp_buf[SAMPLES * (n_aud_chan + n_fx_chan) * 2];
// array of buffers used to setup channel mapping
float *dry[n_aud_chan * 2], *fx[n_fx_chan * 2];
// setup buffers to mix dry stereo audio to
// buffers are alternating left and right for each n_aud_chan,
// please review documentation of fluid_synth_process()
for(int i = 0; i < n_aud_chan * 2; i++)
{
dry[i] = &samp_buf[i * SAMPLES];
}
// setup buffers to mix effects stereo audio to
// similar channel layout as above, revie fluid_synth_process()
for(int i = 0; i < n_fx_chan * 2; i++)
{
fx[i] = &samp_buf[n_aud_chan * 2 * SAMPLES + i * SAMPLES];
}
// dont forget to zero sample buffer(s) before each rendering
memset(samp_buf, 0, sizeof(samp_buf));
int err = fluid_synth_process(synth, SAMPLES, n_fx_chan * 2, fx, n_aud_chan * 2, dry);
if(err == FLUID_FAILED)
{
puts("oops");
}
}
return 0;
}
int fluid_synth_process(fluid_synth_t *synth, int len, int nfx, float *fx[], int nout, float *out[])
Synthesize floating point audio to stereo audio channels (implements the default interface fluid_audi...
Definition: fluid_synth.c:4125
#define FLUID_FAILED
Value that indicates failure, used by most libfluidsynth functions.
Definition: misc.h:65
int fluid_synth_count_effects_groups(fluid_synth_t *synth)
Get the total number of allocated effects units.
Definition: fluid_synth.c:6988
int fluid_synth_count_effects_channels(fluid_synth_t *synth)
Get the total number of allocated effects channels.
Definition: fluid_synth.c:6970
int fluid_synth_count_audio_channels(fluid_synth_t *synth)
Get the total count of audio channels.
Definition: fluid_synth.c:6936