xref: /linux/include/sound/asequencer.h (revision e5c91aac491def6ab3f90c4cc246e3fcb0f8f058)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  *  Main header file for the ALSA sequencer
4  *  Copyright (c) 1998-1999 by Frank van de Pol <fvdpol@coil.demon.nl>
5  *            (c) 1998-1999 by Jaroslav Kysela <perex@perex.cz>
6  */
7 #ifndef __SOUND_ASEQUENCER_H
8 #define __SOUND_ASEQUENCER_H
9 
10 #include <linux/ioctl.h>
11 #include <sound/asound.h>
12 #include <uapi/sound/asequencer.h>
13 
14 /*
15  * type check macros
16  */
17 /* result events: 0-4 */
18 #define snd_seq_ev_is_result_type(ev)	((ev)->type < 5)
19 /* channel specific events: 5-19 */
20 #define snd_seq_ev_is_channel_type(ev)	((ev)->type >= 5 && (ev)->type < 20)
21 /* note events: 5-9 */
22 #define snd_seq_ev_is_note_type(ev)	((ev)->type >= 5 && (ev)->type < 10)
23 /* control events: 10-19 */
24 #define snd_seq_ev_is_control_type(ev)	((ev)->type >= 10 && (ev)->type < 20)
25 /* queue control events: 30-39 */
26 #define snd_seq_ev_is_queue_type(ev)	((ev)->type >= 30 && (ev)->type < 40)
27 /* system status messages */
28 #define snd_seq_ev_is_message_type(ev)	((ev)->type >= 60 && (ev)->type < 69)
29 /* sample messages */
30 #define snd_seq_ev_is_sample_type(ev)	((ev)->type >= 70 && (ev)->type < 79)
31 /* user-defined messages */
32 #define snd_seq_ev_is_user_type(ev)	((ev)->type >= 90 && (ev)->type < 99)
33 /* fixed length events: 0-99 */
34 #define snd_seq_ev_is_fixed_type(ev)	((ev)->type < 100)
35 /* variable length events: 130-139 */
36 #define snd_seq_ev_is_variable_type(ev)	((ev)->type >= 130 && (ev)->type < 140)
37 /* reserved for kernel */
38 #define snd_seq_ev_is_reserved(ev)	((ev)->type >= 150)
39 
40 /* direct dispatched events */
41 #define snd_seq_ev_is_direct(ev)	((ev)->queue == SNDRV_SEQ_QUEUE_DIRECT)
42 
43 /*
44  * macros to check event flags
45  */
46 /* prior events */
47 #define snd_seq_ev_is_prior(ev)		(((ev)->flags & SNDRV_SEQ_PRIORITY_MASK) == SNDRV_SEQ_PRIORITY_HIGH)
48 
49 /* event length type */
50 #define snd_seq_ev_length_type(ev)	((ev)->flags & SNDRV_SEQ_EVENT_LENGTH_MASK)
51 #define snd_seq_ev_is_fixed(ev)		(snd_seq_ev_length_type(ev) == SNDRV_SEQ_EVENT_LENGTH_FIXED)
52 #define snd_seq_ev_is_variable(ev)	(snd_seq_ev_length_type(ev) == SNDRV_SEQ_EVENT_LENGTH_VARIABLE)
53 #define snd_seq_ev_is_varusr(ev)	(snd_seq_ev_length_type(ev) == SNDRV_SEQ_EVENT_LENGTH_VARUSR)
54 
55 /* time-stamp type */
56 #define snd_seq_ev_timestamp_type(ev)	((ev)->flags & SNDRV_SEQ_TIME_STAMP_MASK)
57 #define snd_seq_ev_is_tick(ev)		(snd_seq_ev_timestamp_type(ev) == SNDRV_SEQ_TIME_STAMP_TICK)
58 #define snd_seq_ev_is_real(ev)		(snd_seq_ev_timestamp_type(ev) == SNDRV_SEQ_TIME_STAMP_REAL)
59 
60 /* time-mode type */
61 #define snd_seq_ev_timemode_type(ev)	((ev)->flags & SNDRV_SEQ_TIME_MODE_MASK)
62 #define snd_seq_ev_is_abstime(ev)	(snd_seq_ev_timemode_type(ev) == SNDRV_SEQ_TIME_MODE_ABS)
63 #define snd_seq_ev_is_reltime(ev)	(snd_seq_ev_timemode_type(ev) == SNDRV_SEQ_TIME_MODE_REL)
64 
65 /* check whether the given event is a UMP event */
66 #define snd_seq_ev_is_ump(ev) \
67 	(IS_ENABLED(CONFIG_SND_SEQ_UMP) && ((ev)->flags & SNDRV_SEQ_EVENT_UMP))
68 
69 /* queue sync port */
70 #define snd_seq_queue_sync_port(q)	((q) + 16)
71 
72 #endif /* __SOUND_ASEQUENCER_H */
73