Skip to content

Commit

Permalink
Updating API doc from fluidsynth master
Browse files Browse the repository at this point in the history
  • Loading branch information
API Doc Deploy committed Dec 29, 2023
1 parent 04c709f commit 7e8437c
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion api/MIDIRouter.html
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@
<div class="ttc" id="agroup__Types_html_gaa363402d3c77333b0f070ba531d034ba"><div class="ttname"><a href="group__Types.html#gaa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a></div><div class="ttdeci">struct _fluid_hashtable_t fluid_settings_t</div><div class="ttdoc">Configuration settings instance.</div><div class="ttdef"><b>Definition:</b> types.h:38</div></div>
<div class="ttc" id="agroup__Types_html_gaa57b4746220e24506a169f109875e4ad"><div class="ttname"><a href="group__Types.html#gaa57b4746220e24506a169f109875e4ad">fluid_midi_router_t</a></div><div class="ttdeci">struct _fluid_midi_router_t fluid_midi_router_t</div><div class="ttdoc">MIDI router instance.</div><div class="ttdef"><b>Definition:</b> types.h:51</div></div>
<div class="ttc" id="agroup__Types_html_gae265f10ae174a13afe010de50d87e1a4"><div class="ttname"><a href="group__Types.html#gae265f10ae174a13afe010de50d87e1a4">fluid_synth_t</a></div><div class="ttdeci">struct _fluid_synth_t fluid_synth_t</div><div class="ttdoc">Synthesizer instance.</div><div class="ttdef"><b>Definition:</b> types.h:39</div></div>
<div class="ttc" id="agroup__midi__input_html_ga2327ed7bf1ff702b0ec4095b59d7d660"><div class="ttname"><a href="group__midi__input.html#ga2327ed7bf1ff702b0ec4095b59d7d660">fluid_synth_handle_midi_event</a></div><div class="ttdeci">int fluid_synth_handle_midi_event(void *data, fluid_midi_event_t *event)</div><div class="ttdoc">Handle MIDI event from MIDI router, used as a callback function.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:7596</div></div>
<div class="ttc" id="agroup__midi__input_html_ga2327ed7bf1ff702b0ec4095b59d7d660"><div class="ttname"><a href="group__midi__input.html#ga2327ed7bf1ff702b0ec4095b59d7d660">fluid_synth_handle_midi_event</a></div><div class="ttdeci">int fluid_synth_handle_midi_event(void *data, fluid_midi_event_t *event)</div><div class="ttdoc">Handle MIDI event from MIDI router, used as a callback function.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:7611</div></div>
<div class="ttc" id="agroup__midi__router_html_ga0e9d57b3665c4f4c18e9a03bd8b86f81"><div class="ttname"><a href="group__midi__router.html#ga0e9d57b3665c4f4c18e9a03bd8b86f81">new_fluid_midi_router_rule</a></div><div class="ttdeci">fluid_midi_router_rule_t * new_fluid_midi_router_rule(void)</div><div class="ttdoc">Create a new MIDI router rule.</div><div class="ttdef"><b>Definition:</b> fluid_midi_router.c:378</div></div>
<div class="ttc" id="agroup__midi__router_html_ga11791201fd94c81226b2a7941634f615"><div class="ttname"><a href="group__midi__router.html#ga11791201fd94c81226b2a7941634f615">new_fluid_midi_router</a></div><div class="ttdeci">fluid_midi_router_t * new_fluid_midi_router(fluid_settings_t *settings, handle_midi_event_func_t handler, void *event_handler_data)</div><div class="ttdoc">Create a new midi router.</div><div class="ttdef"><b>Definition:</b> fluid_midi_router.c:86</div></div>
<div class="ttc" id="agroup__midi__router_html_ga21a8b9673c43955d4296a6ec1b3f0632"><div class="ttname"><a href="group__midi__router.html#ga21a8b9673c43955d4296a6ec1b3f0632">fluid_midi_router_clear_rules</a></div><div class="ttdeci">int fluid_midi_router_clear_rules(fluid_midi_router_t *router)</div><div class="ttdoc">Clear all rules in a MIDI router.</div><div class="ttdef"><b>Definition:</b> fluid_midi_router.c:263</div></div>
Expand Down
6 changes: 3 additions & 3 deletions api/fluidsynth_process_8c-example.html
Original file line number Diff line number Diff line change
Expand Up @@ -207,9 +207,9 @@
<div class="line">}</div>
<div class="ttc" id="agroup__audio__rendering_html_gaf41e26b153a095dbc4248e9df4f3ad46"><div class="ttname"><a href="group__audio__rendering.html#gaf41e26b153a095dbc4248e9df4f3ad46">fluid_synth_process</a></div><div class="ttdeci">int fluid_synth_process(fluid_synth_t *synth, int len, int nfx, float *fx[], int nout, float *out[])</div><div class="ttdoc">Synthesize floating point audio to stereo audio channels (implements the default interface fluid_audi...</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:4125</div></div>
<div class="ttc" id="agroup__misc_html_ga90e8bdbc5a507bbfa5c45bac85a63a61"><div class="ttname"><a href="group__misc.html#ga90e8bdbc5a507bbfa5c45bac85a63a61">FLUID_FAILED</a></div><div class="ttdeci">#define FLUID_FAILED</div><div class="ttdoc">Value that indicates failure, used by most libfluidsynth functions.</div><div class="ttdef"><b>Definition:</b> misc.h:65</div></div>
<div class="ttc" id="agroup__synthesis__params_html_ga2b4731bf062b674937f11db9395360be"><div class="ttname"><a href="group__synthesis__params.html#ga2b4731bf062b674937f11db9395360be">fluid_synth_count_effects_groups</a></div><div class="ttdeci">int fluid_synth_count_effects_groups(fluid_synth_t *synth)</div><div class="ttdoc">Get the total number of allocated effects units.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:6973</div></div>
<div class="ttc" id="agroup__synthesis__params_html_gabacb45dc50c05b7a0bb7229df3081b1b"><div class="ttname"><a href="group__synthesis__params.html#gabacb45dc50c05b7a0bb7229df3081b1b">fluid_synth_count_effects_channels</a></div><div class="ttdeci">int fluid_synth_count_effects_channels(fluid_synth_t *synth)</div><div class="ttdoc">Get the total number of allocated effects channels.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:6955</div></div>
<div class="ttc" id="agroup__synthesis__params_html_gafd0280f9f3e9d9aae14a7a9dc02edea7"><div class="ttname"><a href="group__synthesis__params.html#gafd0280f9f3e9d9aae14a7a9dc02edea7">fluid_synth_count_audio_channels</a></div><div class="ttdeci">int fluid_synth_count_audio_channels(fluid_synth_t *synth)</div><div class="ttdoc">Get the total count of audio channels.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:6921</div></div>
<div class="ttc" id="agroup__synthesis__params_html_ga2b4731bf062b674937f11db9395360be"><div class="ttname"><a href="group__synthesis__params.html#ga2b4731bf062b674937f11db9395360be">fluid_synth_count_effects_groups</a></div><div class="ttdeci">int fluid_synth_count_effects_groups(fluid_synth_t *synth)</div><div class="ttdoc">Get the total number of allocated effects units.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:6988</div></div>
<div class="ttc" id="agroup__synthesis__params_html_gabacb45dc50c05b7a0bb7229df3081b1b"><div class="ttname"><a href="group__synthesis__params.html#gabacb45dc50c05b7a0bb7229df3081b1b">fluid_synth_count_effects_channels</a></div><div class="ttdeci">int fluid_synth_count_effects_channels(fluid_synth_t *synth)</div><div class="ttdoc">Get the total number of allocated effects channels.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:6970</div></div>
<div class="ttc" id="agroup__synthesis__params_html_gafd0280f9f3e9d9aae14a7a9dc02edea7"><div class="ttname"><a href="group__synthesis__params.html#gafd0280f9f3e9d9aae14a7a9dc02edea7">fluid_synth_count_audio_channels</a></div><div class="ttdeci">int fluid_synth_count_audio_channels(fluid_synth_t *synth)</div><div class="ttdoc">Get the total count of audio channels.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:6936</div></div>
</div><!-- fragment --> </div><!-- contents -->
</div><!-- doc-content -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion api/group__audio__rendering.html
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf41e26b153a095dbc4248e9
<div class="line">...</div>
<div class="line">fx[ ((k * <a class="code" href="group__synthesis__params.html#gabacb45dc50c05b7a0bb7229df3081b1b">fluid_synth_count_effects_channels</a>() + j) * 2 + 0) % nfx ] = left_buffer_for_effect_channel_j_of_unit_k</div>
<div class="line">fx[ ((k * <a class="code" href="group__synthesis__params.html#gabacb45dc50c05b7a0bb7229df3081b1b">fluid_synth_count_effects_channels</a>() + j) * 2 + 1) % nfx ] = right_buffer_for_effect_channel_j_of_unit_k</div>
<div class="ttc" id="agroup__synthesis__params_html_gabacb45dc50c05b7a0bb7229df3081b1b"><div class="ttname"><a href="group__synthesis__params.html#gabacb45dc50c05b7a0bb7229df3081b1b">fluid_synth_count_effects_channels</a></div><div class="ttdeci">int fluid_synth_count_effects_channels(fluid_synth_t *synth)</div><div class="ttdoc">Get the total number of allocated effects channels.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:6955</div></div>
<div class="ttc" id="agroup__synthesis__params_html_gabacb45dc50c05b7a0bb7229df3081b1b"><div class="ttname"><a href="group__synthesis__params.html#gabacb45dc50c05b7a0bb7229df3081b1b">fluid_synth_count_effects_channels</a></div><div class="ttdeci">int fluid_synth_count_effects_channels(fluid_synth_t *synth)</div><div class="ttdoc">Get the total number of allocated effects channels.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:6970</div></div>
</div><!-- fragment --><p> where <code>0 &lt;= k &lt; <a class="el" href="group__synthesis__params.html#ga2b4731bf062b674937f11db9395360be" title="Get the total number of allocated effects units.">fluid_synth_count_effects_groups()</a></code> is a zero-based index denoting the effects unit and <code>0 &lt;= j &lt; <a class="el" href="group__synthesis__params.html#gabacb45dc50c05b7a0bb7229df3081b1b" title="Get the total number of allocated effects channels.">fluid_synth_count_effects_channels()</a></code> is a zero-based index denoting the effect channel within unit <code>k</code>.</p>
<p>Any playing voice is assigned to audio channels based on the MIDI channel it's playing on: Let <code>chan</code> be the zero-based MIDI channel index an arbitrary voice is playing on. To determine the audio channel and effects unit it is going to be rendered to use:</p>
<p><code>i = chan % <a class="el" href="group__synthesis__params.html#ga06915c22716afc8bab6f1e3b7e250f8d" title="Get the total number of allocated audio channels.">fluid_synth_count_audio_groups()</a></code></p>
Expand Down

0 comments on commit 7e8437c

Please sign in to comment.