diff --git a/src/sfizz.h b/src/sfizz.h index f3aba449..02190061 100644 --- a/src/sfizz.h +++ b/src/sfizz.h @@ -141,7 +141,7 @@ void sfizz_set_sample_rate(sfizz_synth_t* synth, float sample_rate); /** * @brief Send a note on event to the synth. As with all MIDI events, this * needs to happen before the call to sfizz_render_block in each - * block. + * block and should appear in order of the delays, at least within a channel. * * @param synth The synth * @param delay the delay of the event in the block, in samples. @@ -154,8 +154,9 @@ void sfizz_send_note_on(sfizz_synth_t* synth, int delay, int channel, int note_n /** * @brief Send a note off event to the synth. As with all MIDI events, this * needs to happen before the call to sfizz_render_block in each - * block. As per the SFZ spec the velocity of note-off events is - * usually replaced by the note-on velocity. + * block and should appear in order of the delays, at least within a channel. + * As per the SFZ spec the velocity of note-off events is usually replaced by + * the note-on velocity. * * @param synth The synth * @param delay the delay of the event in the block, in samples. @@ -167,7 +168,8 @@ void sfizz_send_note_off(sfizz_synth_t* synth, int delay, int channel, int note_ /** * @brief Send a CC event to the synth. As with all MIDI events, this needs - * to happen before the call to sfizz_render_block in each block. + * to happen before the call to sfizz_render_block in each block and + * should appear in order of the delays, at least within a channel. * * @param synth The synth * @param delay the delay of the event in the block, in samples. @@ -177,7 +179,9 @@ void sfizz_send_note_off(sfizz_synth_t* synth, int delay, int channel, int note_ */ void sfizz_send_cc(sfizz_synth_t* synth, int delay, int channel, int cc_number, char cc_value); /** - * @brief Send a pitch wheel event. (CURRENTLY UNIMPLEMENTED) + * @brief Send a pitch wheel event. As with all MIDI events, this needs + * to happen before the call to sfizz_render_block in each block and + * should appear in order of the delays, at least within a channel. * * @param synth The synth * @param delay The delay diff --git a/src/sfizz/Synth.h b/src/sfizz/Synth.h index 81ca9f53..86159f93 100644 --- a/src/sfizz/Synth.h +++ b/src/sfizz/Synth.h @@ -68,7 +68,8 @@ namespace sfz { * will call to render a block of 256 samples, all the events you send to the * synth should have a delay parameter strictly lower than 256. Events beyond 256 * may be completely ignored by the synth as the incoming event buffer is cleared - * during the renderBlock() call. + * during the renderBlock() call. You SHOULD also feed the midi events in the correct + * order, at least within a channel. * * The jack_client.cpp file contains examples of the most classical usage of the * synth and can be used as a reference.