Home | History | Annotate | Download | only in sound
      1 /*
      2  *  Main header file for the ALSA sequencer
      3  *  Copyright (c) 1998-1999 by Frank van de Pol <fvdpol (at) coil.demon.nl>
      4  *            (c) 1998-1999 by Jaroslav Kysela <perex (at) 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 
     26 /** version of the sequencer */
     27 #define SNDRV_SEQ_VERSION SNDRV_PROTOCOL_VERSION (1, 0, 1)
     28 
     29 /**
     30  * definition of sequencer event types
     31  */
     32 
     33 /** system messages
     34  * event data type = #snd_seq_result
     35  */
     36 #define SNDRV_SEQ_EVENT_SYSTEM		0
     37 #define SNDRV_SEQ_EVENT_RESULT		1
     38 
     39 /** note messages (channel specific)
     40  * event data type = #snd_seq_ev_note
     41  */
     42 #define SNDRV_SEQ_EVENT_NOTE		5
     43 #define SNDRV_SEQ_EVENT_NOTEON		6
     44 #define SNDRV_SEQ_EVENT_NOTEOFF		7
     45 #define SNDRV_SEQ_EVENT_KEYPRESS	8
     46 
     47 /** control messages (channel specific)
     48  * event data type = #snd_seq_ev_ctrl
     49  */
     50 #define SNDRV_SEQ_EVENT_CONTROLLER	10
     51 #define SNDRV_SEQ_EVENT_PGMCHANGE	11
     52 #define SNDRV_SEQ_EVENT_CHANPRESS	12
     53 #define SNDRV_SEQ_EVENT_PITCHBEND	13	/**< from -8192 to 8191 */
     54 #define SNDRV_SEQ_EVENT_CONTROL14	14	/**< 14 bit controller value */
     55 #define SNDRV_SEQ_EVENT_NONREGPARAM	15	/**< 14 bit NRPN address + 14 bit unsigned value */
     56 #define SNDRV_SEQ_EVENT_REGPARAM	16	/**< 14 bit RPN address + 14 bit unsigned value */
     57 
     58 /** synchronisation messages
     59  * event data type = #snd_seq_ev_ctrl
     60  */
     61 #define SNDRV_SEQ_EVENT_SONGPOS		20	/* Song Position Pointer with LSB and MSB values */
     62 #define SNDRV_SEQ_EVENT_SONGSEL		21	/* Song Select with song ID number */
     63 #define SNDRV_SEQ_EVENT_QFRAME		22	/* midi time code quarter frame */
     64 #define SNDRV_SEQ_EVENT_TIMESIGN	23	/* SMF Time Signature event */
     65 #define SNDRV_SEQ_EVENT_KEYSIGN		24	/* SMF Key Signature event */
     66 
     67 /** timer messages
     68  * event data type = snd_seq_ev_queue_control
     69  */
     70 #define SNDRV_SEQ_EVENT_START		30	/* midi Real Time Start message */
     71 #define SNDRV_SEQ_EVENT_CONTINUE	31	/* midi Real Time Continue message */
     72 #define SNDRV_SEQ_EVENT_STOP		32	/* midi Real Time Stop message */
     73 #define	SNDRV_SEQ_EVENT_SETPOS_TICK	33	/* set tick queue position */
     74 #define SNDRV_SEQ_EVENT_SETPOS_TIME	34	/* set realtime queue position */
     75 #define SNDRV_SEQ_EVENT_TEMPO		35	/* (SMF) Tempo event */
     76 #define SNDRV_SEQ_EVENT_CLOCK		36	/* midi Real Time Clock message */
     77 #define SNDRV_SEQ_EVENT_TICK		37	/* midi Real Time Tick message */
     78 #define SNDRV_SEQ_EVENT_QUEUE_SKEW	38	/* skew queue tempo */
     79 
     80 /** others
     81  * event data type = none
     82  */
     83 #define SNDRV_SEQ_EVENT_TUNE_REQUEST	40	/* tune request */
     84 #define SNDRV_SEQ_EVENT_RESET		41	/* reset to power-on state */
     85 #define SNDRV_SEQ_EVENT_SENSING		42	/* "active sensing" event */
     86 
     87 /** echo back, kernel private messages
     88  * event data type = any type
     89  */
     90 #define SNDRV_SEQ_EVENT_ECHO		50	/* echo event */
     91 #define SNDRV_SEQ_EVENT_OSS		51	/* OSS raw event */
     92 
     93 /** system status messages (broadcast for subscribers)
     94  * event data type = snd_seq_addr
     95  */
     96 #define SNDRV_SEQ_EVENT_CLIENT_START	60	/* new client has connected */
     97 #define SNDRV_SEQ_EVENT_CLIENT_EXIT	61	/* client has left the system */
     98 #define SNDRV_SEQ_EVENT_CLIENT_CHANGE	62	/* client status/info has changed */
     99 #define SNDRV_SEQ_EVENT_PORT_START	63	/* new port was created */
    100 #define SNDRV_SEQ_EVENT_PORT_EXIT	64	/* port was deleted from system */
    101 #define SNDRV_SEQ_EVENT_PORT_CHANGE	65	/* port status/info has changed */
    102 
    103 /** port connection changes
    104  * event data type = snd_seq_connect
    105  */
    106 #define SNDRV_SEQ_EVENT_PORT_SUBSCRIBED	66	/* ports connected */
    107 #define SNDRV_SEQ_EVENT_PORT_UNSUBSCRIBED 67	/* ports disconnected */
    108 
    109 /* 70-89:  synthesizer events - obsoleted */
    110 
    111 /** user-defined events with fixed length
    112  * event data type = any
    113  */
    114 #define SNDRV_SEQ_EVENT_USR0		90
    115 #define SNDRV_SEQ_EVENT_USR1		91
    116 #define SNDRV_SEQ_EVENT_USR2		92
    117 #define SNDRV_SEQ_EVENT_USR3		93
    118 #define SNDRV_SEQ_EVENT_USR4		94
    119 #define SNDRV_SEQ_EVENT_USR5		95
    120 #define SNDRV_SEQ_EVENT_USR6		96
    121 #define SNDRV_SEQ_EVENT_USR7		97
    122 #define SNDRV_SEQ_EVENT_USR8		98
    123 #define SNDRV_SEQ_EVENT_USR9		99
    124 
    125 /* 100-118: instrument layer - obsoleted */
    126 /* 119-129: reserved */
    127 
    128 /* 130-139: variable length events
    129  * event data type = snd_seq_ev_ext
    130  * (SNDRV_SEQ_EVENT_LENGTH_VARIABLE must be set)
    131  */
    132 #define SNDRV_SEQ_EVENT_SYSEX		130	/* system exclusive data (variable length) */
    133 #define SNDRV_SEQ_EVENT_BOUNCE		131	/* error event */
    134 /* 132-134: reserved */
    135 #define SNDRV_SEQ_EVENT_USR_VAR0	135
    136 #define SNDRV_SEQ_EVENT_USR_VAR1	136
    137 #define SNDRV_SEQ_EVENT_USR_VAR2	137
    138 #define SNDRV_SEQ_EVENT_USR_VAR3	138
    139 #define SNDRV_SEQ_EVENT_USR_VAR4	139
    140 
    141 /* 150-151: kernel events with quote - DO NOT use in user clients */
    142 #define SNDRV_SEQ_EVENT_KERNEL_ERROR	150
    143 #define SNDRV_SEQ_EVENT_KERNEL_QUOTE	151	/* obsolete */
    144 
    145 /* 152-191: reserved */
    146 
    147 /* 192-254: hardware specific events */
    148 
    149 /* 255: special event */
    150 #define SNDRV_SEQ_EVENT_NONE		255
    151 
    152 
    153 typedef unsigned char snd_seq_event_type_t;
    154 
    155 /** event address */
    156 struct snd_seq_addr {
    157 	unsigned char client;	/**< Client number:         0..255, 255 = broadcast to all clients */
    158 	unsigned char port;	/**< Port within client:    0..255, 255 = broadcast to all ports */
    159 };
    160 
    161 /** port connection */
    162 struct snd_seq_connect {
    163 	struct snd_seq_addr sender;
    164 	struct snd_seq_addr dest;
    165 };
    166 
    167 
    168 #define SNDRV_SEQ_ADDRESS_UNKNOWN	253	/* unknown source */
    169 #define SNDRV_SEQ_ADDRESS_SUBSCRIBERS	254	/* send event to all subscribed ports */
    170 #define SNDRV_SEQ_ADDRESS_BROADCAST	255	/* send event to all queues/clients/ports/channels */
    171 #define SNDRV_SEQ_QUEUE_DIRECT		253	/* direct dispatch */
    172 
    173 	/* event mode flag - NOTE: only 8 bits available! */
    174 #define SNDRV_SEQ_TIME_STAMP_TICK	(0<<0) /* timestamp in clock ticks */
    175 #define SNDRV_SEQ_TIME_STAMP_REAL	(1<<0) /* timestamp in real time */
    176 #define SNDRV_SEQ_TIME_STAMP_MASK	(1<<0)
    177 
    178 #define SNDRV_SEQ_TIME_MODE_ABS		(0<<1)	/* absolute timestamp */
    179 #define SNDRV_SEQ_TIME_MODE_REL		(1<<1)	/* relative to current time */
    180 #define SNDRV_SEQ_TIME_MODE_MASK	(1<<1)
    181 
    182 #define SNDRV_SEQ_EVENT_LENGTH_FIXED	(0<<2)	/* fixed event size */
    183 #define SNDRV_SEQ_EVENT_LENGTH_VARIABLE	(1<<2)	/* variable event size */
    184 #define SNDRV_SEQ_EVENT_LENGTH_VARUSR	(2<<2)	/* variable event size - user memory space */
    185 #define SNDRV_SEQ_EVENT_LENGTH_MASK	(3<<2)
    186 
    187 #define SNDRV_SEQ_PRIORITY_NORMAL	(0<<4)	/* normal priority */
    188 #define SNDRV_SEQ_PRIORITY_HIGH		(1<<4)	/* event should be processed before others */
    189 #define SNDRV_SEQ_PRIORITY_MASK		(1<<4)
    190 
    191 
    192 	/* note event */
    193 struct snd_seq_ev_note {
    194 	unsigned char channel;
    195 	unsigned char note;
    196 	unsigned char velocity;
    197 	unsigned char off_velocity;	/* only for SNDRV_SEQ_EVENT_NOTE */
    198 	unsigned int duration;		/* only for SNDRV_SEQ_EVENT_NOTE */
    199 };
    200 
    201 	/* controller event */
    202 struct snd_seq_ev_ctrl {
    203 	unsigned char channel;
    204 	unsigned char unused1, unused2, unused3;	/* pad */
    205 	unsigned int param;
    206 	signed int value;
    207 };
    208 
    209 	/* generic set of bytes (12x8 bit) */
    210 struct snd_seq_ev_raw8 {
    211 	unsigned char d[12];	/* 8 bit value */
    212 };
    213 
    214 	/* generic set of integers (3x32 bit) */
    215 struct snd_seq_ev_raw32 {
    216 	unsigned int d[3];	/* 32 bit value */
    217 };
    218 
    219 	/* external stored data */
    220 struct snd_seq_ev_ext {
    221 	unsigned int len;	/* length of data */
    222 	void *ptr;		/* pointer to data (note: maybe 64-bit) */
    223 } __attribute__((packed));
    224 
    225 struct snd_seq_result {
    226 	int event;		/* processed event type */
    227 	int result;
    228 };
    229 
    230 
    231 struct snd_seq_real_time {
    232 	unsigned int tv_sec;	/* seconds */
    233 	unsigned int tv_nsec;	/* nanoseconds */
    234 };
    235 
    236 typedef unsigned int snd_seq_tick_time_t;	/* midi ticks */
    237 
    238 union snd_seq_timestamp {
    239 	snd_seq_tick_time_t tick;
    240 	struct snd_seq_real_time time;
    241 };
    242 
    243 struct snd_seq_queue_skew {
    244 	unsigned int value;
    245 	unsigned int base;
    246 };
    247 
    248 	/* queue timer control */
    249 struct snd_seq_ev_queue_control {
    250 	unsigned char queue;			/* affected queue */
    251 	unsigned char pad[3];			/* reserved */
    252 	union {
    253 		signed int value;		/* affected value (e.g. tempo) */
    254 		union snd_seq_timestamp time;	/* time */
    255 		unsigned int position;		/* sync position */
    256 		struct snd_seq_queue_skew skew;
    257 		unsigned int d32[2];
    258 		unsigned char d8[8];
    259 	} param;
    260 };
    261 
    262 	/* quoted event - inside the kernel only */
    263 struct snd_seq_ev_quote {
    264 	struct snd_seq_addr origin;		/* original sender */
    265 	unsigned short value;		/* optional data */
    266 	struct snd_seq_event *event;		/* quoted event */
    267 } __attribute__((packed));
    268 
    269 
    270 	/* sequencer event */
    271 struct snd_seq_event {
    272 	snd_seq_event_type_t type;	/* event type */
    273 	unsigned char flags;		/* event flags */
    274 	char tag;
    275 
    276 	unsigned char queue;		/* schedule queue */
    277 	union snd_seq_timestamp time;	/* schedule time */
    278 
    279 
    280 	struct snd_seq_addr source;	/* source address */
    281 	struct snd_seq_addr dest;	/* destination address */
    282 
    283 	union {				/* event data... */
    284 		struct snd_seq_ev_note note;
    285 		struct snd_seq_ev_ctrl control;
    286 		struct snd_seq_ev_raw8 raw8;
    287 		struct snd_seq_ev_raw32 raw32;
    288 		struct snd_seq_ev_ext ext;
    289 		struct snd_seq_ev_queue_control queue;
    290 		union snd_seq_timestamp time;
    291 		struct snd_seq_addr addr;
    292 		struct snd_seq_connect connect;
    293 		struct snd_seq_result result;
    294 		struct snd_seq_ev_quote quote;
    295 	} data;
    296 };
    297 
    298 
    299 /*
    300  * bounce event - stored as variable size data
    301  */
    302 struct snd_seq_event_bounce {
    303 	int err;
    304 	struct snd_seq_event event;
    305 	/* external data follows here. */
    306 };
    307 
    308 
    309 	/* system information */
    310 struct snd_seq_system_info {
    311 	int queues;			/* maximum queues count */
    312 	int clients;			/* maximum clients count */
    313 	int ports;			/* maximum ports per client */
    314 	int channels;			/* maximum channels per port */
    315 	int cur_clients;		/* current clients */
    316 	int cur_queues;			/* current queues */
    317 	char reserved[24];
    318 };
    319 
    320 
    321 	/* system running information */
    322 struct snd_seq_running_info {
    323 	unsigned char client;		/* client id */
    324 	unsigned char big_endian;	/* 1 = big-endian */
    325 	unsigned char cpu_mode;		/* 4 = 32bit, 8 = 64bit */
    326 	unsigned char pad;		/* reserved */
    327 	unsigned char reserved[12];
    328 };
    329 
    330 
    331 	/* known client numbers */
    332 #define SNDRV_SEQ_CLIENT_SYSTEM		0
    333 	/* internal client numbers */
    334 #define SNDRV_SEQ_CLIENT_DUMMY		14	/* midi through */
    335 #define SNDRV_SEQ_CLIENT_OSS		15	/* oss sequencer emulator */
    336 
    337 
    338 	/* client types */
    339 typedef int __bitwise snd_seq_client_type_t;
    340 #define	NO_CLIENT	((snd_seq_client_type_t) 0)
    341 #define	USER_CLIENT	((snd_seq_client_type_t) 1)
    342 #define	KERNEL_CLIENT	((snd_seq_client_type_t) 2)
    343 
    344 	/* event filter flags */
    345 #define SNDRV_SEQ_FILTER_BROADCAST	(1<<0)	/* accept broadcast messages */
    346 #define SNDRV_SEQ_FILTER_MULTICAST	(1<<1)	/* accept multicast messages */
    347 #define SNDRV_SEQ_FILTER_BOUNCE		(1<<2)	/* accept bounce event in error */
    348 #define SNDRV_SEQ_FILTER_USE_EVENT	(1<<31)	/* use event filter */
    349 
    350 struct snd_seq_client_info {
    351 	int client;			/* client number to inquire */
    352 	snd_seq_client_type_t type;	/* client type */
    353 	char name[64];			/* client name */
    354 	unsigned int filter;		/* filter flags */
    355 	unsigned char multicast_filter[8]; /* multicast filter bitmap */
    356 	unsigned char event_filter[32];	/* event filter bitmap */
    357 	int num_ports;			/* RO: number of ports */
    358 	int event_lost;			/* number of lost events */
    359 	char reserved[64];		/* for future use */
    360 };
    361 
    362 
    363 /* client pool size */
    364 struct snd_seq_client_pool {
    365 	int client;			/* client number to inquire */
    366 	int output_pool;		/* outgoing (write) pool size */
    367 	int input_pool;			/* incoming (read) pool size */
    368 	int output_room;		/* minimum free pool size for select/blocking mode */
    369 	int output_free;		/* unused size */
    370 	int input_free;			/* unused size */
    371 	char reserved[64];
    372 };
    373 
    374 
    375 /* Remove events by specified criteria */
    376 
    377 #define SNDRV_SEQ_REMOVE_INPUT		(1<<0)	/* Flush input queues */
    378 #define SNDRV_SEQ_REMOVE_OUTPUT		(1<<1)	/* Flush output queues */
    379 #define SNDRV_SEQ_REMOVE_DEST		(1<<2)	/* Restrict by destination q:client:port */
    380 #define SNDRV_SEQ_REMOVE_DEST_CHANNEL	(1<<3)	/* Restrict by channel */
    381 #define SNDRV_SEQ_REMOVE_TIME_BEFORE	(1<<4)	/* Restrict to before time */
    382 #define SNDRV_SEQ_REMOVE_TIME_AFTER	(1<<5)	/* Restrict to time or after */
    383 #define SNDRV_SEQ_REMOVE_TIME_TICK	(1<<6)	/* Time is in ticks */
    384 #define SNDRV_SEQ_REMOVE_EVENT_TYPE	(1<<7)	/* Restrict to event type */
    385 #define SNDRV_SEQ_REMOVE_IGNORE_OFF 	(1<<8)	/* Do not flush off events */
    386 #define SNDRV_SEQ_REMOVE_TAG_MATCH 	(1<<9)	/* Restrict to events with given tag */
    387 
    388 struct snd_seq_remove_events {
    389 	unsigned int  remove_mode;	/* Flags that determine what gets removed */
    390 
    391 	union snd_seq_timestamp time;
    392 
    393 	unsigned char queue;	/* Queue for REMOVE_DEST */
    394 	struct snd_seq_addr dest;	/* Address for REMOVE_DEST */
    395 	unsigned char channel;	/* Channel for REMOVE_DEST */
    396 
    397 	int  type;	/* For REMOVE_EVENT_TYPE */
    398 	char  tag;	/* Tag for REMOVE_TAG */
    399 
    400 	int  reserved[10];	/* To allow for future binary compatibility */
    401 
    402 };
    403 
    404 
    405 	/* known port numbers */
    406 #define SNDRV_SEQ_PORT_SYSTEM_TIMER	0
    407 #define SNDRV_SEQ_PORT_SYSTEM_ANNOUNCE	1
    408 
    409 	/* port capabilities (32 bits) */
    410 #define SNDRV_SEQ_PORT_CAP_READ		(1<<0)	/* readable from this port */
    411 #define SNDRV_SEQ_PORT_CAP_WRITE	(1<<1)	/* writable to this port */
    412 
    413 #define SNDRV_SEQ_PORT_CAP_SYNC_READ	(1<<2)
    414 #define SNDRV_SEQ_PORT_CAP_SYNC_WRITE	(1<<3)
    415 
    416 #define SNDRV_SEQ_PORT_CAP_DUPLEX	(1<<4)
    417 
    418 #define SNDRV_SEQ_PORT_CAP_SUBS_READ	(1<<5)	/* allow read subscription */
    419 #define SNDRV_SEQ_PORT_CAP_SUBS_WRITE	(1<<6)	/* allow write subscription */
    420 #define SNDRV_SEQ_PORT_CAP_NO_EXPORT	(1<<7)	/* routing not allowed */
    421 
    422 	/* port type */
    423 #define SNDRV_SEQ_PORT_TYPE_SPECIFIC	(1<<0)	/* hardware specific */
    424 #define SNDRV_SEQ_PORT_TYPE_MIDI_GENERIC (1<<1)	/* generic MIDI device */
    425 #define SNDRV_SEQ_PORT_TYPE_MIDI_GM	(1<<2)	/* General MIDI compatible device */
    426 #define SNDRV_SEQ_PORT_TYPE_MIDI_GS	(1<<3)	/* GS compatible device */
    427 #define SNDRV_SEQ_PORT_TYPE_MIDI_XG	(1<<4)	/* XG compatible device */
    428 #define SNDRV_SEQ_PORT_TYPE_MIDI_MT32	(1<<5)	/* MT-32 compatible device */
    429 #define SNDRV_SEQ_PORT_TYPE_MIDI_GM2	(1<<6)	/* General MIDI 2 compatible device */
    430 
    431 /* other standards...*/
    432 #define SNDRV_SEQ_PORT_TYPE_SYNTH	(1<<10)	/* Synth device (no MIDI compatible - direct wavetable) */
    433 #define SNDRV_SEQ_PORT_TYPE_DIRECT_SAMPLE (1<<11)	/* Sampling device (support sample download) */
    434 #define SNDRV_SEQ_PORT_TYPE_SAMPLE	(1<<12)	/* Sampling device (sample can be downloaded at any time) */
    435 /*...*/
    436 #define SNDRV_SEQ_PORT_TYPE_HARDWARE	(1<<16)	/* driver for a hardware device */
    437 #define SNDRV_SEQ_PORT_TYPE_SOFTWARE	(1<<17)	/* implemented in software */
    438 #define SNDRV_SEQ_PORT_TYPE_SYNTHESIZER	(1<<18)	/* generates sound */
    439 #define SNDRV_SEQ_PORT_TYPE_PORT	(1<<19)	/* connects to other device(s) */
    440 #define SNDRV_SEQ_PORT_TYPE_APPLICATION	(1<<20)	/* application (sequencer/editor) */
    441 
    442 /* misc. conditioning flags */
    443 #define SNDRV_SEQ_PORT_FLG_GIVEN_PORT	(1<<0)
    444 #define SNDRV_SEQ_PORT_FLG_TIMESTAMP	(1<<1)
    445 #define SNDRV_SEQ_PORT_FLG_TIME_REAL	(1<<2)
    446 
    447 struct snd_seq_port_info {
    448 	struct snd_seq_addr addr;	/* client/port numbers */
    449 	char name[64];			/* port name */
    450 
    451 	unsigned int capability;	/* port capability bits */
    452 	unsigned int type;		/* port type bits */
    453 	int midi_channels;		/* channels per MIDI port */
    454 	int midi_voices;		/* voices per MIDI port */
    455 	int synth_voices;		/* voices per SYNTH port */
    456 
    457 	int read_use;			/* R/O: subscribers for output (from this port) */
    458 	int write_use;			/* R/O: subscribers for input (to this port) */
    459 
    460 	void *kernel;			/* reserved for kernel use (must be NULL) */
    461 	unsigned int flags;		/* misc. conditioning */
    462 	unsigned char time_queue;	/* queue # for timestamping */
    463 	char reserved[59];		/* for future use */
    464 };
    465 
    466 
    467 /* queue flags */
    468 #define SNDRV_SEQ_QUEUE_FLG_SYNC	(1<<0)	/* sync enabled */
    469 
    470 /* queue information */
    471 struct snd_seq_queue_info {
    472 	int queue;		/* queue id */
    473 
    474 	/*
    475 	 *  security settings, only owner of this queue can start/stop timer
    476 	 *  etc. if the queue is locked for other clients
    477 	 */
    478 	int owner;		/* client id for owner of the queue */
    479 	unsigned locked:1;	/* timing queue locked for other queues */
    480 	char name[64];		/* name of this queue */
    481 	unsigned int flags;	/* flags */
    482 	char reserved[60];	/* for future use */
    483 
    484 };
    485 
    486 /* queue info/status */
    487 struct snd_seq_queue_status {
    488 	int queue;			/* queue id */
    489 	int events;			/* read-only - queue size */
    490 	snd_seq_tick_time_t tick;	/* current tick */
    491 	struct snd_seq_real_time time;	/* current time */
    492 	int running;			/* running state of queue */
    493 	int flags;			/* various flags */
    494 	char reserved[64];		/* for the future */
    495 };
    496 
    497 
    498 /* queue tempo */
    499 struct snd_seq_queue_tempo {
    500 	int queue;			/* sequencer queue */
    501 	unsigned int tempo;		/* current tempo, us/tick */
    502 	int ppq;			/* time resolution, ticks/quarter */
    503 	unsigned int skew_value;	/* queue skew */
    504 	unsigned int skew_base;		/* queue skew base */
    505 	char reserved[24];		/* for the future */
    506 };
    507 
    508 
    509 /* sequencer timer sources */
    510 #define SNDRV_SEQ_TIMER_ALSA		0	/* ALSA timer */
    511 #define SNDRV_SEQ_TIMER_MIDI_CLOCK	1	/* Midi Clock (CLOCK event) */
    512 #define SNDRV_SEQ_TIMER_MIDI_TICK	2	/* Midi Timer Tick (TICK event) */
    513 
    514 /* queue timer info */
    515 struct snd_seq_queue_timer {
    516 	int queue;			/* sequencer queue */
    517 	int type;			/* source timer type */
    518 	union {
    519 		struct {
    520 			struct snd_timer_id id;	/* ALSA's timer ID */
    521 			unsigned int resolution;	/* resolution in Hz */
    522 		} alsa;
    523 	} u;
    524 	char reserved[64];		/* for the future use */
    525 };
    526 
    527 
    528 struct snd_seq_queue_client {
    529 	int queue;		/* sequencer queue */
    530 	int client;		/* sequencer client */
    531 	int used;		/* queue is used with this client
    532 				   (must be set for accepting events) */
    533 	/* per client watermarks */
    534 	char reserved[64];	/* for future use */
    535 };
    536 
    537 
    538 #define SNDRV_SEQ_PORT_SUBS_EXCLUSIVE	(1<<0)	/* exclusive connection */
    539 #define SNDRV_SEQ_PORT_SUBS_TIMESTAMP	(1<<1)
    540 #define SNDRV_SEQ_PORT_SUBS_TIME_REAL	(1<<2)
    541 
    542 struct snd_seq_port_subscribe {
    543 	struct snd_seq_addr sender;	/* sender address */
    544 	struct snd_seq_addr dest;	/* destination address */
    545 	unsigned int voices;		/* number of voices to be allocated (0 = don't care) */
    546 	unsigned int flags;		/* modes */
    547 	unsigned char queue;		/* input time-stamp queue (optional) */
    548 	unsigned char pad[3];		/* reserved */
    549 	char reserved[64];
    550 };
    551 
    552 /* type of query subscription */
    553 #define SNDRV_SEQ_QUERY_SUBS_READ	0
    554 #define SNDRV_SEQ_QUERY_SUBS_WRITE	1
    555 
    556 struct snd_seq_query_subs {
    557 	struct snd_seq_addr root;	/* client/port id to be searched */
    558 	int type;		/* READ or WRITE */
    559 	int index;		/* 0..N-1 */
    560 	int num_subs;		/* R/O: number of subscriptions on this port */
    561 	struct snd_seq_addr addr;	/* R/O: result */
    562 	unsigned char queue;	/* R/O: result */
    563 	unsigned int flags;	/* R/O: result */
    564 	char reserved[64];	/* for future use */
    565 };
    566 
    567 
    568 /*
    569  *  IOCTL commands
    570  */
    571 
    572 #define SNDRV_SEQ_IOCTL_PVERSION	_IOR ('S', 0x00, int)
    573 #define SNDRV_SEQ_IOCTL_CLIENT_ID	_IOR ('S', 0x01, int)
    574 #define SNDRV_SEQ_IOCTL_SYSTEM_INFO	_IOWR('S', 0x02, struct snd_seq_system_info)
    575 #define SNDRV_SEQ_IOCTL_RUNNING_MODE	_IOWR('S', 0x03, struct snd_seq_running_info)
    576 
    577 #define SNDRV_SEQ_IOCTL_GET_CLIENT_INFO	_IOWR('S', 0x10, struct snd_seq_client_info)
    578 #define SNDRV_SEQ_IOCTL_SET_CLIENT_INFO	_IOW ('S', 0x11, struct snd_seq_client_info)
    579 
    580 #define SNDRV_SEQ_IOCTL_CREATE_PORT	_IOWR('S', 0x20, struct snd_seq_port_info)
    581 #define SNDRV_SEQ_IOCTL_DELETE_PORT	_IOW ('S', 0x21, struct snd_seq_port_info)
    582 #define SNDRV_SEQ_IOCTL_GET_PORT_INFO	_IOWR('S', 0x22, struct snd_seq_port_info)
    583 #define SNDRV_SEQ_IOCTL_SET_PORT_INFO	_IOW ('S', 0x23, struct snd_seq_port_info)
    584 
    585 #define SNDRV_SEQ_IOCTL_SUBSCRIBE_PORT	_IOW ('S', 0x30, struct snd_seq_port_subscribe)
    586 #define SNDRV_SEQ_IOCTL_UNSUBSCRIBE_PORT _IOW ('S', 0x31, struct snd_seq_port_subscribe)
    587 
    588 #define SNDRV_SEQ_IOCTL_CREATE_QUEUE	_IOWR('S', 0x32, struct snd_seq_queue_info)
    589 #define SNDRV_SEQ_IOCTL_DELETE_QUEUE	_IOW ('S', 0x33, struct snd_seq_queue_info)
    590 #define SNDRV_SEQ_IOCTL_GET_QUEUE_INFO	_IOWR('S', 0x34, struct snd_seq_queue_info)
    591 #define SNDRV_SEQ_IOCTL_SET_QUEUE_INFO	_IOWR('S', 0x35, struct snd_seq_queue_info)
    592 #define SNDRV_SEQ_IOCTL_GET_NAMED_QUEUE	_IOWR('S', 0x36, struct snd_seq_queue_info)
    593 #define SNDRV_SEQ_IOCTL_GET_QUEUE_STATUS _IOWR('S', 0x40, struct snd_seq_queue_status)
    594 #define SNDRV_SEQ_IOCTL_GET_QUEUE_TEMPO	_IOWR('S', 0x41, struct snd_seq_queue_tempo)
    595 #define SNDRV_SEQ_IOCTL_SET_QUEUE_TEMPO	_IOW ('S', 0x42, struct snd_seq_queue_tempo)
    596 #define SNDRV_SEQ_IOCTL_GET_QUEUE_OWNER	_IOWR('S', 0x43, struct snd_seq_queue_owner)
    597 #define SNDRV_SEQ_IOCTL_SET_QUEUE_OWNER	_IOW ('S', 0x44, struct snd_seq_queue_owner)
    598 #define SNDRV_SEQ_IOCTL_GET_QUEUE_TIMER	_IOWR('S', 0x45, struct snd_seq_queue_timer)
    599 #define SNDRV_SEQ_IOCTL_SET_QUEUE_TIMER	_IOW ('S', 0x46, struct snd_seq_queue_timer)
    600 /* XXX
    601 #define SNDRV_SEQ_IOCTL_GET_QUEUE_SYNC	_IOWR('S', 0x53, struct snd_seq_queue_sync)
    602 #define SNDRV_SEQ_IOCTL_SET_QUEUE_SYNC	_IOW ('S', 0x54, struct snd_seq_queue_sync)
    603 */
    604 #define SNDRV_SEQ_IOCTL_GET_QUEUE_CLIENT	_IOWR('S', 0x49, struct snd_seq_queue_client)
    605 #define SNDRV_SEQ_IOCTL_SET_QUEUE_CLIENT	_IOW ('S', 0x4a, struct snd_seq_queue_client)
    606 #define SNDRV_SEQ_IOCTL_GET_CLIENT_POOL	_IOWR('S', 0x4b, struct snd_seq_client_pool)
    607 #define SNDRV_SEQ_IOCTL_SET_CLIENT_POOL	_IOW ('S', 0x4c, struct snd_seq_client_pool)
    608 #define SNDRV_SEQ_IOCTL_REMOVE_EVENTS	_IOW ('S', 0x4e, struct snd_seq_remove_events)
    609 #define SNDRV_SEQ_IOCTL_QUERY_SUBS	_IOWR('S', 0x4f, struct snd_seq_query_subs)
    610 #define SNDRV_SEQ_IOCTL_GET_SUBSCRIPTION	_IOWR('S', 0x50, struct snd_seq_port_subscribe)
    611 #define SNDRV_SEQ_IOCTL_QUERY_NEXT_CLIENT	_IOWR('S', 0x51, struct snd_seq_client_info)
    612 #define SNDRV_SEQ_IOCTL_QUERY_NEXT_PORT	_IOWR('S', 0x52, struct snd_seq_port_info)
    613 
    614 #endif /* __SOUND_ASEQUENCER_H */
    615