include/sound/asequencer.h

   1 /*
   2  *  Main header file for the ALSA sequencer
   3  *  Copyright (c) 1998-1999 by Frank van de Pol <fvdpol@coil.demon.nl>
   4  *            (c) 1998-1999 by Jaroslav Kysela <perex@perex.cz>
   5  *
   6  *
   7  *   This program is free software; you can redistribute it and/or modify
   8  *   it under the terms of the GNU General Public License as published by
   9  *   the Free Software Foundation; either version 2 of the License, or
  10  *   (at your option) any later version.
  11  *
  12  *   This program is distributed in the hope that it will be useful,
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *   GNU General Public License for more details.
  16  *
  17  *   You should have received a copy of the GNU General Public License
  18  *   along with this program; if not, write to the Free Software
  19  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  20  *
  21  */
  22 #ifndef __SOUND_ASEQUENCER_H
  23 #define __SOUND_ASEQUENCER_H
  24
  25 #include <linux/ioctl.h>
  26 #include <sound/asound.h>
  27 #include <uapi/sound/asequencer.h>
  28
  29 /* helper macro */
  30 #define snd_seq_event_bounce_ext_data(ev) ((void*)((char *)(ev)->data.ext.ptr + sizeof(struct snd_seq_event_bounce)))
  31
  32 /*
  33  * type check macros
  34  */
  35 /* result events: 0-4 */
  36 #define snd_seq_ev_is_result_type(ev)   ((ev)->type < 5)
  37 /* channel specific events: 5-19 */
  38 #define snd_seq_ev_is_channel_type(ev)  ((ev)->type >= 5 && (ev)->type < 20)
  39 /* note events: 5-9 */
  40 #define snd_seq_ev_is_note_type(ev)     ((ev)->type >= 5 && (ev)->type < 10)
  41 /* control events: 10-19 */
  42 #define snd_seq_ev_is_control_type(ev)  ((ev)->type >= 10 && (ev)->type < 20)
  43 /* queue control events: 30-39 */
  44 #define snd_seq_ev_is_queue_type(ev)    ((ev)->type >= 30 && (ev)->type < 40)
  45 /* system status messages */
  46 #define snd_seq_ev_is_message_type(ev)  ((ev)->type >= 60 && (ev)->type < 69)
  47 /* sample messages */
  48 #define snd_seq_ev_is_sample_type(ev)   ((ev)->type >= 70 && (ev)->type < 79)
  49 /* user-defined messages */
  50 #define snd_seq_ev_is_user_type(ev)     ((ev)->type >= 90 && (ev)->type < 99)
  51 /* fixed length events: 0-99 */
  52 #define snd_seq_ev_is_fixed_type(ev)    ((ev)->type < 100)
  53 /* variable length events: 130-139 */
  54 #define snd_seq_ev_is_variable_type(ev) ((ev)->type >= 130 && (ev)->type < 140)
  55 /* reserved for kernel */
  56 #define snd_seq_ev_is_reserved(ev)      ((ev)->type >= 150)
  57
  58 /* direct dispatched events */
  59 #define snd_seq_ev_is_direct(ev)        ((ev)->queue == SNDRV_SEQ_QUEUE_DIRECT)
  60
  61 /*
  62  * macros to check event flags
  63  */
  64 /* prior events */
  65 #define snd_seq_ev_is_prior(ev)         (((ev)->flags & SNDRV_SEQ_PRIORITY_MASK) == SNDRV_SEQ_PRIORITY_HIGH)
  66
  67 /* event length type */
  68 #define snd_seq_ev_length_type(ev)      ((ev)->flags & SNDRV_SEQ_EVENT_LENGTH_MASK)
  69 #define snd_seq_ev_is_fixed(ev)         (snd_seq_ev_length_type(ev) == SNDRV_SEQ_EVENT_LENGTH_FIXED)
  70 #define snd_seq_ev_is_variable(ev)      (snd_seq_ev_length_type(ev) == SNDRV_SEQ_EVENT_LENGTH_VARIABLE)
  71 #define snd_seq_ev_is_varusr(ev)        (snd_seq_ev_length_type(ev) == SNDRV_SEQ_EVENT_LENGTH_VARUSR)
  72
  73 /* time-stamp type */
  74 #define snd_seq_ev_timestamp_type(ev)   ((ev)->flags & SNDRV_SEQ_TIME_STAMP_MASK)
  75 #define snd_seq_ev_is_tick(ev)          (snd_seq_ev_timestamp_type(ev) == SNDRV_SEQ_TIME_STAMP_TICK)
  76 #define snd_seq_ev_is_real(ev)          (snd_seq_ev_timestamp_type(ev) == SNDRV_SEQ_TIME_STAMP_REAL)
  77
  78 /* time-mode type */
  79 #define snd_seq_ev_timemode_type(ev)    ((ev)->flags & SNDRV_SEQ_TIME_MODE_MASK)
  80 #define snd_seq_ev_is_abstime(ev)       (snd_seq_ev_timemode_type(ev) == SNDRV_SEQ_TIME_MODE_ABS)
  81 #define snd_seq_ev_is_reltime(ev)       (snd_seq_ev_timemode_type(ev) == SNDRV_SEQ_TIME_MODE_REL)
  82
  83 /* queue sync port */
  84 #define snd_seq_queue_sync_port(q)      ((q) + 16)
  85
  86 #endif /* __SOUND_ASEQUENCER_H */