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/* helper macro */
15#define snd_seq_event_bounce_ext_data(ev) ((void*)((char *)(ev)->data.ext.ptr + sizeof(struct snd_seq_event_bounce)))
16
17/*
18 * type check macros
19 */
20/* result events: 0-4 */
21#define snd_seq_ev_is_result_type(ev) ((ev)->type < 5)
22/* channel specific events: 5-19 */
23#define snd_seq_ev_is_channel_type(ev) ((ev)->type >= 5 && (ev)->type < 20)
24/* note events: 5-9 */
25#define snd_seq_ev_is_note_type(ev) ((ev)->type >= 5 && (ev)->type < 10)
26/* control events: 10-19 */
27#define snd_seq_ev_is_control_type(ev) ((ev)->type >= 10 && (ev)->type < 20)
28/* queue control events: 30-39 */
29#define snd_seq_ev_is_queue_type(ev) ((ev)->type >= 30 && (ev)->type < 40)
30/* system status messages */
31#define snd_seq_ev_is_message_type(ev) ((ev)->type >= 60 && (ev)->type < 69)
32/* sample messages */
33#define snd_seq_ev_is_sample_type(ev) ((ev)->type >= 70 && (ev)->type < 79)
34/* user-defined messages */
35#define snd_seq_ev_is_user_type(ev) ((ev)->type >= 90 && (ev)->type < 99)
36/* fixed length events: 0-99 */
37#define snd_seq_ev_is_fixed_type(ev) ((ev)->type < 100)
38/* variable length events: 130-139 */
39#define snd_seq_ev_is_variable_type(ev) ((ev)->type >= 130 && (ev)->type < 140)
40/* reserved for kernel */
41#define snd_seq_ev_is_reserved(ev) ((ev)->type >= 150)
42
43/* direct dispatched events */
44#define snd_seq_ev_is_direct(ev) ((ev)->queue == SNDRV_SEQ_QUEUE_DIRECT)
45
46/*
47 * macros to check event flags
48 */
49/* prior events */
50#define snd_seq_ev_is_prior(ev) (((ev)->flags & SNDRV_SEQ_PRIORITY_MASK) == SNDRV_SEQ_PRIORITY_HIGH)
51
52/* event length type */
53#define snd_seq_ev_length_type(ev) ((ev)->flags & SNDRV_SEQ_EVENT_LENGTH_MASK)
54#define snd_seq_ev_is_fixed(ev) (snd_seq_ev_length_type(ev) == SNDRV_SEQ_EVENT_LENGTH_FIXED)
55#define snd_seq_ev_is_variable(ev) (snd_seq_ev_length_type(ev) == SNDRV_SEQ_EVENT_LENGTH_VARIABLE)
56#define snd_seq_ev_is_varusr(ev) (snd_seq_ev_length_type(ev) == SNDRV_SEQ_EVENT_LENGTH_VARUSR)
57
58/* time-stamp type */
59#define snd_seq_ev_timestamp_type(ev) ((ev)->flags & SNDRV_SEQ_TIME_STAMP_MASK)
60#define snd_seq_ev_is_tick(ev) (snd_seq_ev_timestamp_type(ev) == SNDRV_SEQ_TIME_STAMP_TICK)
61#define snd_seq_ev_is_real(ev) (snd_seq_ev_timestamp_type(ev) == SNDRV_SEQ_TIME_STAMP_REAL)
62
63/* time-mode type */
64#define snd_seq_ev_timemode_type(ev) ((ev)->flags & SNDRV_SEQ_TIME_MODE_MASK)
65#define snd_seq_ev_is_abstime(ev) (snd_seq_ev_timemode_type(ev) == SNDRV_SEQ_TIME_MODE_ABS)
66#define snd_seq_ev_is_reltime(ev) (snd_seq_ev_timemode_type(ev) == SNDRV_SEQ_TIME_MODE_REL)
67
68/* check whether the given event is a UMP event */
69#define snd_seq_ev_is_ump(ev) \
70 (IS_ENABLED(CONFIG_SND_SEQ_UMP) && ((ev)->flags & SNDRV_SEQ_EVENT_UMP))
71
72/* queue sync port */
73#define snd_seq_queue_sync_port(q) ((q) + 16)
74
75#endif /* __SOUND_ASEQUENCER_H */
76