zdoom/fluidsynth
0
0
Fork 0
mirror of https://github.com/ZDoom/fluidsynth.git synced 2024-12-11 05:11:33 +00:00
Code Issues Projects Releases Packages Wiki Activity

Make users aware of relative sequencer tick error

Browse source
This commit is contained in:
derselbst 2021-05-01 15:16:39 +02:00
parent 0825e815a8
commit 0ea101721a
2 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
include/fluidsynth/seq.h
View file

@ -45,6 +45,14 @@ extern "C" {
* @param event The event being received
* @param seq The sequencer instance
* @param data User defined data registered with the client
*
* @note @p time may not be of the same tick value as the scheduled event! In fact, depending on
* the sequencer's scale and the synth's sample-rate, @p time may a few ticks too late. Although this
* itself is inaudible, it is important to consider,
* when you use this callback for enqueuing additional events over and over again with
* fluid_sequencer_send_at(): If you enqueue new events with a relative tick value you might introduce
* a timing error, which causes your sequence to sound e.g. slower than it's supposed to be. If this is
* your use-case, make sure to enqueue events with an absolute tick value.
*/
typedef void (*fluid_event_callback_t)(unsigned int time, fluid_event_t *event,
fluid_sequencer_t *seq, void *data);

2
src/midi/fluid_seq.c
View file

@ -469,6 +469,8 @@ fluid_sequencer_send_now(fluid_sequencer_t *seq, fluid_event_t *evt)
* - Otherwise the order is undefined.
* \n
* Or mathematically: #FLUID_SEQ_SYSTEMRESET < #FLUID_SEQ_UNREGISTERING < ... < (#FLUID_SEQ_NOTEON && #FLUID_SEQ_NOTE)
*
* @warning Be careful with relative ticks when sending many events! See #fluid_event_callback_t for details.
*/
int
fluid_sequencer_send_at(fluid_sequencer_t *seq, fluid_event_t *evt,