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