zdoom/fluidsynth
0
0
Fork 0
mirror of https://github.com/ZDoom/fluidsynth.git synced 2024-11-30 16:01:51 +00:00
Code Issues Projects Releases Packages Wiki Activity

doc the DOCMEs

Browse source
This commit is contained in:
derselbst 2017-12-10 17:31:11 +01:00
parent 5806d9e9cc
commit 84124e3230
2 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
include/fluidsynth/event.h
View file

@ -54,7 +54,7 @@ enum fluid_seq_event_type {
FLUID_SEQ_REVERBSEND, /**< Reverb send set event */
FLUID_SEQ_CHORUSSEND, /**< Chorus send set event */
FLUID_SEQ_TIMER, /**< Timer event (useful for giving a callback at a certain time) */
FLUID_SEQ_ANYCONTROLCHANGE, /**< DOCME (used for remove_events only) */
FLUID_SEQ_ANYCONTROLCHANGE, /**< Any control change message (only internally used for remove_events) */
FLUID_SEQ_CHANNELPRESSURE, /**< Channel aftertouch event @since 1.1.0 */
FLUID_SEQ_KEYPRESSURE, /**< Polyphonic aftertouch event @since 2.0.0 */
FLUID_SEQ_SYSTEMRESET, /**< System reset event @since 1.1.0 */

18
src/synth/fluid_event.c
View file

@ -117,7 +117,7 @@ fluid_event_set_dest(fluid_event_t* evt, fluid_seq_id_t dest)
/**
* Set a sequencer event to be a timer event.
* @param evt Sequencer event structure
* @param data DOCME
* @param data User supplied data pointer
*/
void
fluid_event_timer(fluid_event_t* evt, void* data)
@ -162,7 +162,7 @@ fluid_event_noteoff(fluid_event_t* evt, int channel, short key)
* @param channel MIDI channel number
* @param key MIDI note number (0-127)
* @param vel MIDI velocity value (0-127)
* @param duration Duration of note (DOCME units?)
* @param duration Duration of note in the time scale used by the sequencer (by default milliseconds)
*/
void
fluid_event_note(fluid_event_t* evt, int channel, short key, short vel, unsigned int duration)
@ -246,10 +246,9 @@ fluid_event_program_select(fluid_event_t* evt, int channel,
}
/**
* Set a sequencer event to be an any control change event.
* Set a sequencer event to be an any control change event (for internal use).
* @param evt Sequencer event structure
* @param channel MIDI channel number
* DOCME
*/
void
fluid_event_any_control_change(fluid_event_t* evt, int channel)
@ -278,7 +277,7 @@ fluid_event_pitch_bend(fluid_event_t* evt, int channel, int pitch)
* Set a sequencer event to be a pitch wheel sensitivity event.
* @param evt Sequencer event structure
* @param channel MIDI channel number
* @param value MIDI pitch wheel sensitivity value (DOCME units?)
* @param value MIDI pitch wheel sensitivity value in semitones
*/
void
fluid_event_pitch_wheelsens(fluid_event_t* evt, int channel, short value)
@ -325,7 +324,7 @@ fluid_event_sustain(fluid_event_t* evt, int channel, short val)
* @param evt Sequencer event structure
* @param channel MIDI channel number
* @param control MIDI control number (0-127)
* @param val MIDI control value (0-16383 DOCME is that true?)
* @param val MIDI control value (0-127)
*/
void
fluid_event_control_change(fluid_event_t* evt, int channel, short control, short val)
@ -478,9 +477,10 @@ int fluid_event_get_type(fluid_event_t* evt)
}
/**
* @internal
* Get the time field from a sequencer event structure.
* @param evt Sequencer event structure
* @return Time value (DOCME units?)
* @return Time value
*/
unsigned int fluid_event_get_time(fluid_event_t* evt)
{
@ -510,7 +510,7 @@ fluid_seq_id_t fluid_event_get_dest(fluid_event_t* evt)
/**
* Get the MIDI channel field from a sequencer event structure.
* @param evt Sequencer event structure
* @return MIDI channel number (DOCME 0-15 or more?)
* @return MIDI zero-based channel number
*/
int fluid_event_get_channel(fluid_event_t* evt)
{
@ -579,7 +579,7 @@ void* fluid_event_get_data(fluid_event_t* evt)
/**
* Get the duration field from a sequencer event structure.
* @param evt Sequencer event structure
* @return Note duration value (DOCME units?)
* @return Note duration value in the time scale used by the sequencer (by default milliseconds)
*
* Used by the #FLUID_SEQ_NOTE event type.
*/