xref: /openbmc/linux/include/sound/asequencer.h (revision 2612e3bbc0386368a850140a6c9b990cd496a5ec)
11a59d1b8SThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-or-later */
21da177e4SLinus Torvalds /*
31da177e4SLinus Torvalds  *  Main header file for the ALSA sequencer
41da177e4SLinus Torvalds  *  Copyright (c) 1998-1999 by Frank van de Pol <fvdpol@coil.demon.nl>
5c1017a4cSJaroslav Kysela  *            (c) 1998-1999 by Jaroslav Kysela <perex@perex.cz>
61da177e4SLinus Torvalds  */
71da177e4SLinus Torvalds #ifndef __SOUND_ASEQUENCER_H
81da177e4SLinus Torvalds #define __SOUND_ASEQUENCER_H
91da177e4SLinus Torvalds 
101da177e4SLinus Torvalds #include <linux/ioctl.h>
111da177e4SLinus Torvalds #include <sound/asound.h>
12674e95caSDavid Howells #include <uapi/sound/asequencer.h>
13c7e0b5bfSTakashi Iwai 
14c7e0b5bfSTakashi Iwai /* helper macro */
15c7e0b5bfSTakashi Iwai #define snd_seq_event_bounce_ext_data(ev) ((void*)((char *)(ev)->data.ext.ptr + sizeof(struct snd_seq_event_bounce)))
161da177e4SLinus Torvalds 
171da177e4SLinus Torvalds /*
181da177e4SLinus Torvalds  * type check macros
191da177e4SLinus Torvalds  */
201da177e4SLinus Torvalds /* result events: 0-4 */
21c7e0b5bfSTakashi Iwai #define snd_seq_ev_is_result_type(ev)	((ev)->type < 5)
221da177e4SLinus Torvalds /* channel specific events: 5-19 */
23c7e0b5bfSTakashi Iwai #define snd_seq_ev_is_channel_type(ev)	((ev)->type >= 5 && (ev)->type < 20)
241da177e4SLinus Torvalds /* note events: 5-9 */
25c7e0b5bfSTakashi Iwai #define snd_seq_ev_is_note_type(ev)	((ev)->type >= 5 && (ev)->type < 10)
261da177e4SLinus Torvalds /* control events: 10-19 */
27c7e0b5bfSTakashi Iwai #define snd_seq_ev_is_control_type(ev)	((ev)->type >= 10 && (ev)->type < 20)
281da177e4SLinus Torvalds /* queue control events: 30-39 */
29c7e0b5bfSTakashi Iwai #define snd_seq_ev_is_queue_type(ev)	((ev)->type >= 30 && (ev)->type < 40)
301da177e4SLinus Torvalds /* system status messages */
31c7e0b5bfSTakashi Iwai #define snd_seq_ev_is_message_type(ev)	((ev)->type >= 60 && (ev)->type < 69)
321da177e4SLinus Torvalds /* sample messages */
33c7e0b5bfSTakashi Iwai #define snd_seq_ev_is_sample_type(ev)	((ev)->type >= 70 && (ev)->type < 79)
341da177e4SLinus Torvalds /* user-defined messages */
35c7e0b5bfSTakashi Iwai #define snd_seq_ev_is_user_type(ev)	((ev)->type >= 90 && (ev)->type < 99)
361da177e4SLinus Torvalds /* fixed length events: 0-99 */
37c7e0b5bfSTakashi Iwai #define snd_seq_ev_is_fixed_type(ev)	((ev)->type < 100)
381da177e4SLinus Torvalds /* variable length events: 130-139 */
39c7e0b5bfSTakashi Iwai #define snd_seq_ev_is_variable_type(ev)	((ev)->type >= 130 && (ev)->type < 140)
401da177e4SLinus Torvalds /* reserved for kernel */
41c7e0b5bfSTakashi Iwai #define snd_seq_ev_is_reserved(ev)	((ev)->type >= 150)
421da177e4SLinus Torvalds 
431da177e4SLinus Torvalds /* direct dispatched events */
44c7e0b5bfSTakashi Iwai #define snd_seq_ev_is_direct(ev)	((ev)->queue == SNDRV_SEQ_QUEUE_DIRECT)
451da177e4SLinus Torvalds 
461da177e4SLinus Torvalds /*
471da177e4SLinus Torvalds  * macros to check event flags
481da177e4SLinus Torvalds  */
491da177e4SLinus Torvalds /* prior events */
50c7e0b5bfSTakashi Iwai #define snd_seq_ev_is_prior(ev)		(((ev)->flags & SNDRV_SEQ_PRIORITY_MASK) == SNDRV_SEQ_PRIORITY_HIGH)
511da177e4SLinus Torvalds 
521da177e4SLinus Torvalds /* event length type */
53c7e0b5bfSTakashi Iwai #define snd_seq_ev_length_type(ev)	((ev)->flags & SNDRV_SEQ_EVENT_LENGTH_MASK)
54c7e0b5bfSTakashi Iwai #define snd_seq_ev_is_fixed(ev)		(snd_seq_ev_length_type(ev) == SNDRV_SEQ_EVENT_LENGTH_FIXED)
55c7e0b5bfSTakashi Iwai #define snd_seq_ev_is_variable(ev)	(snd_seq_ev_length_type(ev) == SNDRV_SEQ_EVENT_LENGTH_VARIABLE)
56c7e0b5bfSTakashi Iwai #define snd_seq_ev_is_varusr(ev)	(snd_seq_ev_length_type(ev) == SNDRV_SEQ_EVENT_LENGTH_VARUSR)
571da177e4SLinus Torvalds 
581da177e4SLinus Torvalds /* time-stamp type */
59c7e0b5bfSTakashi Iwai #define snd_seq_ev_timestamp_type(ev)	((ev)->flags & SNDRV_SEQ_TIME_STAMP_MASK)
60c7e0b5bfSTakashi Iwai #define snd_seq_ev_is_tick(ev)		(snd_seq_ev_timestamp_type(ev) == SNDRV_SEQ_TIME_STAMP_TICK)
61c7e0b5bfSTakashi Iwai #define snd_seq_ev_is_real(ev)		(snd_seq_ev_timestamp_type(ev) == SNDRV_SEQ_TIME_STAMP_REAL)
621da177e4SLinus Torvalds 
631da177e4SLinus Torvalds /* time-mode type */
64c7e0b5bfSTakashi Iwai #define snd_seq_ev_timemode_type(ev)	((ev)->flags & SNDRV_SEQ_TIME_MODE_MASK)
65c7e0b5bfSTakashi Iwai #define snd_seq_ev_is_abstime(ev)	(snd_seq_ev_timemode_type(ev) == SNDRV_SEQ_TIME_MODE_ABS)
66c7e0b5bfSTakashi Iwai #define snd_seq_ev_is_reltime(ev)	(snd_seq_ev_timemode_type(ev) == SNDRV_SEQ_TIME_MODE_REL)
671da177e4SLinus Torvalds 
68*46397622STakashi Iwai /* check whether the given event is a UMP event */
69*46397622STakashi Iwai #define snd_seq_ev_is_ump(ev) \
70*46397622STakashi Iwai 	(IS_ENABLED(CONFIG_SND_SEQ_UMP) && ((ev)->flags & SNDRV_SEQ_EVENT_UMP))
71*46397622STakashi Iwai 
721da177e4SLinus Torvalds /* queue sync port */
73c7e0b5bfSTakashi Iwai #define snd_seq_queue_sync_port(q)	((q) + 16)
74c7e0b5bfSTakashi Iwai 
751da177e4SLinus Torvalds #endif /* __SOUND_ASEQUENCER_H */
76