alsa-lib patches for rawmidi tstamp framing
v2 cover alsa-lib patches for rawmidi tstamp framing
v2: Improved commit messages
David Henningsson (2):
Add rawmidi framing API
Add test for rawmidi framing API
include/rawmidi.h | 26 ++++++++++++ include/sound/uapi/asound.h | 30 +++++++++++++- src/rawmidi/rawmidi.c | 83 +++++++++++++++++++++++++++++++++++++ src/rawmidi/rawmidi_hw.c | 2 + src/rawmidi/rawmidi_local.h | 2 + test/rawmidi.c | 65 ++++++++++++++++++++++++++--- 6 files changed, 200 insertions(+), 8 deletions(-)
Signature · 1 line
2.25.1
PATCH v2 1/2 Add rawmidi framing API
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.
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.
--- include/rawmidi.h | 26 ++++++++++++ include/sound/uapi/asound.h | 30 +++++++++++++- src/rawmidi/rawmidi.c | 83 +++++++++++++++++++++++++++++++++++++ src/rawmidi/rawmidi_hw.c | 2 + src/rawmidi/rawmidi_local.h | 2 + 5 files changed, 141 insertions(+), 2 deletions(-)
include/rawmidi.h +26 -0
@@ -79,6 +79,27 @@ typedef enum _snd_rawmidi_type {SND_RAWMIDI_TYPE_VIRTUAL } snd_rawmidi_type_t; +#define SND_RAWMIDI_CLOCK_NONE (0<<3) +#define SND_RAWMIDI_CLOCK_REALTIME (1<<3) +#define SND_RAWMIDI_CLOCK_MONOTONIC (2<<3) +#define SND_RAWMIDI_CLOCK_MONOTONIC_RAW (3<<3) + +#define SND_RAWMIDI_FRAMING_DATA_LENGTH 16 + +/** Incoming RawMidi bytes is put inside this container if tstamp type framing is enabled. */ +typedef struct _snd_rawmidi_framing_tstamp { +/** +* For now, frame_type is always 0. Midi 2.0 is expected to add new +* types here. Applications are expected to skip unknown frame types. +*/ +__u8 frame_type; +__u8 length;/* number of valid bytes in data field */ +__u8 reserved[2 ]; +__u32 tv_nsec;/* nanoseconds */ +__u64 tv_sec;/* seconds */ +__u8 data[SND_RAWMIDI_FRAMING_DATA_LENGTH ]; +}snd_rawmidi_framing_tstamp_t ; +int snd_rawmidi_open (snd_rawmidi_t **in_rmidi,snd_rawmidi_t **out_rmidi,const char *name,int mode); int snd_rawmidi_open_lconf(snd_rawmidi_t **in_rmidi, snd_rawmidi_t **out_rmidi,
@@ -126,6 +147,11 @@ int snd_rawmidi_params_set_avail_min(snd_rawmidi_t *rmidi, snd_rawmidi_params_tsize_t snd_rawmidi_params_get_avail_min (const snd_rawmidi_params_t *params);int snd_rawmidi_params_set_no_active_sensing (snd_rawmidi_t *rmidi,snd_rawmidi_params_t *params,int val);int snd_rawmidi_params_get_no_active_sensing (const snd_rawmidi_params_t *params); +int snd_rawmidi_params_set_framing_type (const snd_rawmidi_t *rawmidi,snd_rawmidi_params_t *params,unsigned int val); +int snd_rawmidi_params_get_framing_type (const snd_rawmidi_params_t *params); +int snd_rawmidi_params_set_clock_type (const snd_rawmidi_t *rawmidi,snd_rawmidi_params_t *params,unsigned int val); +int snd_rawmidi_params_get_clock_type (const snd_rawmidi_params_t *params); +int snd_rawmidi_params (snd_rawmidi_t *rmidi,snd_rawmidi_params_t * params);int snd_rawmidi_params_current (snd_rawmidi_t *rmidi,snd_rawmidi_params_t *params);size_t snd_rawmidi_status_sizeof (void );
include/sound/uapi/asound.h +28 -2
@@ -702,7 +702,7 @@ enum {* Raw MIDI section - /dev/snd/midi?? */ -#define SNDRV_RAWMIDI_VERSION SNDRV_PROTOCOL_VERSION(2, 0, 1) +#define SNDRV_RAWMIDI_VERSION SNDRV_PROTOCOL_VERSION(2, 0, 2)enum {SNDRV_RAWMIDI_STREAM_OUTPUT =0 ,
@@ -728,12 +728,38 @@ struct snd_rawmidi_info {unsigned char reserved[64 ];/* reserved for future use */ }; +#define SNDRV_RAWMIDI_MODE_FRAMING_MASK (7<<0) +#define SNDRV_RAWMIDI_MODE_FRAMING_SHIFT 0 +#define SNDRV_RAWMIDI_MODE_FRAMING_NONE (0<<0) +#define SNDRV_RAWMIDI_MODE_FRAMING_TSTAMP (1<<0) +#define SNDRV_RAWMIDI_MODE_CLOCK_MASK (7<<3) +#define SNDRV_RAWMIDI_MODE_CLOCK_SHIFT 3 +#define SNDRV_RAWMIDI_MODE_CLOCK_NONE (0<<3) +#define SNDRV_RAWMIDI_MODE_CLOCK_REALTIME (1<<3) +#define SNDRV_RAWMIDI_MODE_CLOCK_MONOTONIC (2<<3) +#define SNDRV_RAWMIDI_MODE_CLOCK_MONOTONIC_RAW (3<<3) + +#define SNDRV_RAWMIDI_FRAMING_DATA_LENGTH 16 + +struct snd_rawmidi_framing_tstamp { +/* For now, frame_type is always 0. Midi 2.0 is expected to add new +* types here. Applications are expected to skip unknown frame types. +*/ +__u8 frame_type; +__u8 length;/* number of valid bytes in data field */ +__u8 reserved[2 ]; +__u32 tv_nsec;/* nanoseconds */ +__u64 tv_sec;/* seconds */ +__u8 data[SNDRV_RAWMIDI_FRAMING_DATA_LENGTH ]; +} __packed; +struct snd_rawmidi_params {int stream;size_t buffer_size;/* queue size in bytes */ size_t avail_min;/* minimum avail bytes for wakeup */ unsigned int no_active_sensing:1 ;/* do not send active sensing byte in close() */ -unsigned char reserved[16 ];/* reserved for future use */ +unsigned int mode;/* For input data only, frame incoming data */ +unsigned char reserved[12 ];/* reserved for future use */ };struct snd_rawmidi_status {
src/rawmidi/rawmidi.c +83 -0
113 lines not on this page · raw message
src/rawmidi/rawmidi_hw.c +2 -0
@@ -285,6 +285,7 @@ int snd_rawmidi_hw_open(snd_rawmidi_t **inputp, snd_rawmidi_t **outputp, rmidi->poll_fd = fd; rmidi->ops = &snd_rawmidi_hw_ops; rmidi->private_data = hw; + rmidi->version = ver; hw->open++; *inputp = rmidi; }
@@ -300,6 +301,7 @@ int snd_rawmidi_hw_open(snd_rawmidi_t **inputp, snd_rawmidi_t **outputp, rmidi->poll_fd = fd; rmidi->ops = &snd_rawmidi_hw_ops; rmidi->private_data = hw; + rmidi->version = ver; hw->open++; *outputp = rmidi; }
src/rawmidi/rawmidi_local.h +2 -0
@@ -42,12 +42,14 @@ struct _snd_rawmidi {snd_rawmidi_type_t type;snd_rawmidi_stream_t stream;int mode; +int version;int poll_fd;const snd_rawmidi_ops_t *ops;void *private_data;size_t buffer_size;size_t avail_min; unsigned int no_active_sensing: 1; +int params_mode; }; int snd_rawmidi_hw_open(snd_rawmidi_t **input, snd_rawmidi_t **output,
Signature · 1 line
2.25.1
Re: [PATCH v2 1/2] Add rawmidi framing API
include/rawmidi.h typedef enum _snd_rawmidi_type { · line 85
Quoted 11 lines · David Henningsson
include/rawmidi.h +4
-0@@ -79,6 +79,27 @@ typedef enum _snd_rawmidi_type { SND_RAWMIDI_TYPE_VIRTUAL } snd_rawmidi_type_t; +#define SND_RAWMIDI_CLOCK_NONE (0<<3) +#define SND_RAWMIDI_CLOCK_REALTIME (1<<3) +#define SND_RAWMIDI_CLOCK_MONOTONIC (2<<3) +#define SND_RAWMIDI_CLOCK_MONOTONIC_RAW (3<<3)
IMO, better to be like below:
enum {
SND_RAWMIDI_CLOCK_NONE = 0,
SND_RAWMIDI_CLOCK_REALTIME = 1,
SND_RAWMIDI_CLOCK_MONOTONIC = 2,
SND_RAWMIDI_CLOCK_MONOTONIC_RAW = 3,
};
The shift should be done in the function.
The enum above can be also typedef'ed for the later reference.
include/rawmidi.h typedef enum _snd_rawmidi_type { · line 95
Quoted 6 lines
include/rawmidi.h +6
-0+typedef struct _snd_rawmidi_framing_tstamp { + /** + * For now, frame_type is always 0. Midi 2.0 is expected to add new + * types here. Applications are expected to skip unknown frame types. + */ + __u8 frame_type;
The 0 frame type should be also defined explicitly, such as SNDRV_RAWMIDI_FRAME_TYPE_XXX.
include/rawmidi.h int snd_rawmidi_params_set_avail_min(snd_rawmidi_t *rmidi, snd_rawmidi_params_t · line 150
Quoted 1 line
include/rawmidi.h +1
-0+int snd_rawmidi_params_set_framing_type (const snd_rawmidi_t *rawmidi,snd_rawmidi_params_t *params,unsigned int val);
You can define the enum type to be more specific, too.
include/rawmidi.h int snd_rawmidi_params_set_avail_min(snd_rawmidi_t *rmidi, snd_rawmidi_params_t · line 152
Quoted 1 line
include/rawmidi.h +1
-0+int snd_rawmidi_params_set_clock_type (const snd_rawmidi_t *rawmidi,snd_rawmidi_params_t *params,unsigned int val);
Ditto.
thanks,
Takashi
PATCH v2 2/2 Add test for rawmidi framing API
In reply to David HenningssonAdds a "clock type" parameter to the "rawmidi" test program, that when used and combined with -i (and -v to be useful), activates tstamp type framing with the specified clock type.
--- test/rawmidi.c | 65 +++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 59 insertions(+), 6 deletions(-)
test/rawmidi.c +59 -6
@@ -13,6 +13,7 @@ static void usage(void)fprintf (stderr," -o device-id : test ALSA output device\n" );fprintf (stderr," -I node : test input node\n" );fprintf (stderr," -O node : test output node\n" ); +fprintf (stderr," -c clock : kernel clock type (0=none, 1=realtime, 2=monotonic, 3=monotonic raw)\n" );fprintf (stderr," -t: test midi thru\n" );fprintf (stderr," example:\n" );fprintf (stderr," rawmidi -i hw:0,0 -O /dev/midi1\n" );
@@ -37,7 +38,8 @@ int main(int argc,char** argv)char *device_out =NULL ;char *node_in =NULL ;char *node_out =NULL ; - +int clock_type =-1 ; +int fd_in =-1 ,fd_out =-1 ;snd_rawmidi_t *handle_in =0 ,*handle_out =0 ;
@@ -58,6 +60,10 @@ int main(int argc,char** argv)case 't' : thru =1 ;break ; +case 'c' : +if (i +1 < argc) + clock_type =atoi (argv[++i]); +break ;case 'i' :if (i +1 < argc) device_in = argv[++i];
@@ -133,20 +139,67 @@ int main(int argc,char** argv) } } - -if (!thru) {if (handle_in || fd_in!=-1 ) { +if (clock_type !=-1 ) { +snd_rawmidi_params_t *params; +snd_rawmidi_params_malloc (¶ms); +if (!handle_in) { +fprintf (stderr,"-c only usable with -i" ); + clock_type =-1 ; + } +if (clock_type !=-1 ) { +fprintf (stderr,"Enable kernel clock type %d\n" , clock_type); +snd_rawmidi_params_current (handle_in, params); + err =snd_rawmidi_params_set_framing_type (handle_in, params,1 ); +if (err) { +fprintf (stderr,"snd_rawmidi_params_set_framing_type failed: %d\n" , err); + clock_type =-1 ; + } + } +if (clock_type !=-1 ) { + err =snd_rawmidi_params_set_clock_type (handle_in, params, clock_type); +if (err) { +fprintf (stderr,"snd_rawmidi_params_set_clock_type failed: %d\n" , err); + clock_type =-1 ; + } + } +if (clock_type !=-1 ) { + err =snd_rawmidi_params (handle_in, params); +if (err) { +fprintf (stderr,"snd_rawmidi_params failed: %d\n" , err); + clock_type =-1 ; + } + } +snd_rawmidi_params_free (params); + } +fprintf (stderr,"Read midi in\n" );fprintf (stderr,"Press ctrl-c to stop\n" ); }if (handle_in) {unsigned char ch; +snd_rawmidi_framing_tstamp_t frame;while (!stop) { -snd_rawmidi_read (handle_in,&ch,1 ); -if (verbose) { -fprintf (stderr,"read %02x\n" ,ch); +if (clock_type !=-1 ) { +snd_rawmidi_read (handle_in, &frame,sizeof (frame)); +if (verbose) { +int i; +if (frame.frame_type) { +fprintf (stderr,"read unknown frame %d" , frame.frame_type); +continue ; + } +fprintf (stderr,"read [%lld:%09d]" , frame.tv_sec, frame.tv_nsec); +for (i =0 ; i < frame.length; i++) +fprintf (stderr," %02x" , frame.data[i]); +fprintf (stderr,"\n" ); + } + } +else { +snd_rawmidi_read (handle_in,&ch,1 ); +if (verbose) +fprintf (stderr,"read %02x\n" ,ch); } } }
Signature · 1 line
2.25.1