add internal note about fluid_midi_parser_parse()

This commit is contained in:
derselbst 2017-12-21 14:57:09 +01:00
parent 5f45c6d97b
commit 51cc2656e1

View file

@ -1924,6 +1924,11 @@ delete_fluid_midi_parser(fluid_midi_parser_t *parser)
* @param c Next character in MIDI stream
* @return A parsed MIDI event or NULL if none. Event is internal and should
* not be modified or freed and is only valid until next call to this function.
* @internal Do not expose this function to the public API. It would allow downstream
* apps to abuse fluidsynth as midi parser, e.g. feeding it with rawmidi and pull out
* the needed midi information using the getter functions of fluid_midi_event_t.
* This parser however is incomplete as it e.g. only provides a limited buffer to
* store and process SYSEX data (i.e. doesnt allow arbitrary lengths)
*/
fluid_midi_event_t *
fluid_midi_parser_parse(fluid_midi_parser_t *parser, unsigned char c)