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

clarify docs of fluid_synth_get_active_voice_count()

Browse source
This commit is contained in:
derselbst 2018-03-10 16:44:39 +01:00
parent 8ec580f259
commit 1183fbf416
1 changed files with 10 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
src/synth/fluid_synth.c
View file

@ -2791,15 +2791,22 @@ fluid_synth_get_polyphony(fluid_synth_t* synth)
}
/**
* Get current number of active voices.
* @brief Get current number of active voices.
*
* I.e. the no. of voices that have been
* started and have not yet finished. Unless called from synthesis context,
* this number does not necessarily have to be equal to the number of voices
* currently processed by the DSP loop, see below.
* @param synth FluidSynth instance
* @return Number of currently active voices.
* @since 1.1.0
*
* @note To generate accurate continuous statistics of the voice count, caller
* should ensure this function is called synchronously with the audio synthesis
* process. This can be done in the new_fluid_audio_driver2() audio callback
* function for example.
* process. This can be done in the new_fluid_audio_driver2() audio callback
* function for example. Otherwise every call to this function may return different
* voice counts as it may change after any (concurrent) call to fluid_synth_write_*() made by
* e.g. an audio driver or the applications audio rendering thread.
*/
int
fluid_synth_get_active_voice_count(fluid_synth_t* synth)