From: Jaroslav Kysela Date: Wed, 22 Sep 2021 09:13:57 +0000 (+0200) Subject: rawmidi: doc - fix the framing / read mode section X-Git-Tag: v1.2.6~23 X-Git-Url: https://git.alsa-project.org/?a=commitdiff_plain;h=11f54c2774bd5d85c00f819b71772f70a7036b6f;p=alsa-lib.git rawmidi: doc - fix the framing / read mode section Follow the previous changes and describe the current API. Signed-off-by: Jaroslav Kysela --- diff --git a/src/rawmidi/rawmidi.c b/src/rawmidi/rawmidi.c index 31845e6f..9fab63f1 100644 --- a/src/rawmidi/rawmidi.c +++ b/src/rawmidi/rawmidi.c @@ -118,14 +118,14 @@ hw:soundwave,1,2 hw:DEV=1,CARD=soundwave,SUBDEV=2 \endcode -\section rawmidi_framing Framing of rawmidi data +\section read_mode Read mode -Optionally, incoming rawmidi bytes can be put inside a frame of type snd_rawmidi_framing_tstamp_t. -The main current benefit is that can enable in-kernel timestamping of incoming bytes, and that -timestamp is likely to be more precise than what userspace can offer. +Optionally, incoming rawmidi bytes can be marked with timestamps. The library hides +the kernel implementation (linux kernel 5.14+) and exports +the \link ::snd_rawmidi_tread() \endlink function which returns the +midi bytes marked with the identical timestamp in one iteration. -Tstamp type framing requires a kernel >= 5.14 and a buffer size that is a multiple of -sizeof(snd_rawmidi_framing_tstamp_t). It is only available on input streams. +The timestamping is available only on input streams. \section rawmidi_examples Examples