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