xref: /freebsd/sys/sys/soundcard.h (revision c17d43407fe04133a94055b0dbc7ea8965654a9f)
1 /*
2  * soundcard.h
3  *
4  * Copyright by Hannu Savolainen 1993
5  * Modified for the new FreeBSD sound driver by Luigi Rizzo, 1997
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above
13  *    copyright notice, this list of conditions and the following
14  *    disclaimer in the documentation and/or other materials provided
15  *    with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS''
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20  * PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR
21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
24  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
25  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
27  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  *
30  * $FreeBSD$
31  */
32 
33 #ifndef _SYS_SOUNDCARD_H_
34 #define _SYS_SOUNDCARD_H_
35  /*
36   * If you make modifications to this file, please contact me before
37   * distributing the modified version. There is already enough
38   * diversity in the world.
39   *
40   * Regards,
41   * Hannu Savolainen
42   * hannu@voxware.pp.fi
43   *
44   **********************************************************************
45   * PS.	The Hacker's Guide to VoxWare available from
46   *     nic.funet.fi:pub/Linux/ALPHA/sound. The file is
47   *	snd-sdk-doc-0.1.ps.gz (gzipped postscript). It contains
48   *	some useful information about programming with VoxWare.
49   *	(NOTE! The pub/Linux/ALPHA/ directories are hidden. You have
50   *	to cd inside them before the files are accessible.)
51   **********************************************************************
52   */
53 
54 /*
55  * SOUND_VERSION is only used by the voxware driver. Hopefully apps
56  * should not depend on it, but rather look at the capabilities
57  * of the driver in the kernel!
58  */
59 #define SOUND_VERSION  301
60 #define VOXWARE		/* does this have any use ? */
61 
62 /*
63  * Supported card ID numbers (Should be somewhere else? We keep
64  * them here just for compativility with the old driver, but these
65  * constants are of little or no use).
66  */
67 
68 #define SNDCARD_ADLIB          1
69 #define SNDCARD_SB             2
70 #define SNDCARD_PAS            3
71 #define SNDCARD_GUS            4
72 #define SNDCARD_MPU401         5
73 #define SNDCARD_SB16           6
74 #define SNDCARD_SB16MIDI       7
75 #define SNDCARD_UART6850       8
76 #define SNDCARD_GUS16          9
77 #define SNDCARD_MSS            10
78 #define SNDCARD_PSS            11
79 #define SNDCARD_SSCAPE         12
80 #define SNDCARD_PSS_MPU        13
81 #define SNDCARD_PSS_MSS        14
82 #define SNDCARD_SSCAPE_MSS     15
83 #define SNDCARD_TRXPRO         16
84 #define SNDCARD_TRXPRO_SB      17
85 #define SNDCARD_TRXPRO_MPU     18
86 #define SNDCARD_MAD16          19
87 #define SNDCARD_MAD16_MPU      20
88 #define SNDCARD_CS4232         21
89 #define SNDCARD_CS4232_MPU     22
90 #define SNDCARD_MAUI           23
91 #define SNDCARD_PSEUDO_MSS     24
92 #define SNDCARD_AWE32          25
93 #define SNDCARD_NSS            26
94 #define SNDCARD_UART16550      27
95 #define SNDCARD_OPL            28
96 
97 #include <sys/types.h>
98 #ifndef _IOWR
99 #include <sys/ioccom.h>
100 #endif  /* !_IOWR */
101 
102 /*
103  * The first part of this file contains the new FreeBSD sound ioctl
104  * interface. Tries to minimize the number of different ioctls, and
105  * to be reasonably general.
106  *
107  * 970821: some of the new calls have not been implemented yet.
108  */
109 
110 /*
111  * the following three calls extend the generic file descriptor
112  * interface. AIONWRITE is the dual of FIONREAD, i.e. returns the max
113  * number of bytes for a write operation to be non-blocking.
114  *
115  * AIOGSIZE/AIOSSIZE are used to change the behaviour of the device,
116  * from a character device (default) to a block device. In block mode,
117  * (not to be confused with blocking mode) the main difference for the
118  * application is that select() will return only when a complete
119  * block can be read/written to the device, whereas in character mode
120  * select will return true when one byte can be exchanged. For audio
121  * devices, character mode makes select almost useless since one byte
122  * will always be ready by the next sample time (which is often only a
123  * handful of microseconds away).
124  * Use a size of 0 or 1 to return to character mode.
125  */
126 #define	AIONWRITE   _IOR('A', 10, int)   /* get # bytes to write */
127 struct snd_size {
128     int play_size;
129     int rec_size;
130 };
131 #define	AIOGSIZE    _IOR('A', 11, struct snd_size)/* read current blocksize */
132 #define	AIOSSIZE    _IOWR('A', 11, struct snd_size)  /* sets blocksize */
133 
134 /*
135  * The following constants define supported audio formats. The
136  * encoding follows voxware conventions, i.e. 1 bit for each supported
137  * format. We extend it by using bit 31 (RO) to indicate full-duplex
138  * capability, and bit 29 (RO) to indicate that the card supports/
139  * needs different formats on capture & playback channels.
140  * Bit 29 (RW) is used to indicate/ask stereo.
141  *
142  * The number of bits required to store the sample is:
143  *  o  4 bits for the IDA ADPCM format,
144  *  o  8 bits for 8-bit formats, mu-law and A-law,
145  *  o  16 bits for the 16-bit formats, and
146  *  o  32 bits for the 24/32-bit formats.
147  *  o  undefined for the MPEG audio format.
148  */
149 
150 #define AFMT_QUERY	0x00000000	/* Return current format */
151 #define AFMT_MU_LAW	0x00000001	/* Logarithmic mu-law */
152 #define AFMT_A_LAW	0x00000002	/* Logarithmic A-law */
153 #define AFMT_IMA_ADPCM	0x00000004	/* A 4:1 compressed format where 16-bit
154 					 * squence represented using the
155 					 * the average 4 bits per sample */
156 #define AFMT_U8		0x00000008	/* Unsigned 8-bit */
157 #define AFMT_S16_LE	0x00000010	/* Little endian signed 16-bit */
158 #define AFMT_S16_BE	0x00000020	/* Big endian signed 16-bit */
159 #define AFMT_S8		0x00000040	/* Signed 8-bit */
160 #define AFMT_U16_LE	0x00000080	/* Little endian unsigned 16-bit */
161 #define AFMT_U16_BE	0x00000100	/* Big endian unsigned 16-bit */
162 #define AFMT_MPEG	0x00000200	/* MPEG MP2/MP3 audio */
163 #define AFMT_AC3	0x00000400	/* Dolby Digital AC3 */
164 /*
165  * 32-bit formats below used for 24-bit audio data where the data is stored
166  * in the 24 most significant bits and the least significant bits are not used
167  * (should be set to 0).
168  */
169 #define AFMT_S32_LE	0x00001000	/* Little endian signed 32-bit */
170 #define AFMT_S32_BE	0x00002000	/* Big endian signed 32-bit */
171 #define AFMT_U32_LE	0x00004000	/* Little endian unsigned 32-bit */
172 #define AFMT_U32_BE	0x00008000	/* Big endian unsigned 32-bit */
173 
174 #define AFMT_STEREO	0x10000000	/* can do/want stereo	*/
175 
176 /*
177  * the following are really capabilities
178  */
179 #define AFMT_WEIRD	0x20000000	/* weird hardware...	*/
180     /*
181      * AFMT_WEIRD reports that the hardware might need to operate
182      * with different formats in the playback and capture
183      * channels when operating in full duplex.
184      * As an example, SoundBlaster16 cards only support U8 in one
185      * direction and S16 in the other one, and applications should
186      * be aware of this limitation.
187      */
188 #define AFMT_FULLDUPLEX	0x80000000	/* can do full duplex	*/
189 
190 /*
191  * The following structure is used to get/set format and sampling rate.
192  * While it would be better to have things such as stereo, bits per
193  * sample, endiannes, etc split in different variables, it turns out
194  * that formats are not that many, and not all combinations are possible.
195  * So we followed the Voxware approach of associating one bit to each
196  * format.
197  */
198 
199 typedef struct _snd_chan_param {
200     u_long	play_rate;	/* sampling rate			*/
201     u_long	rec_rate;	/* sampling rate			*/
202     u_long	play_format;	/* everything describing the format	*/
203     u_long	rec_format;	/* everything describing the format	*/
204 } snd_chan_param;
205 #define	AIOGFMT    _IOR('f', 12, snd_chan_param)   /* get format */
206 #define	AIOSFMT    _IOWR('f', 12, snd_chan_param)  /* sets format */
207 
208 /*
209  * The following structure is used to get/set the mixer setting.
210  * Up to 32 mixers are supported, each one with up to 32 channels.
211  */
212 typedef struct _snd_mix_param {
213     u_char	subdev;	/* which output				*/
214     u_char	line;	/* which input				*/
215     u_char	left,right; /* volumes, 0..255, 0 = mute	*/
216 } snd_mix_param ;
217 
218 /* XXX AIOGMIX, AIOSMIX not implemented yet */
219 #define AIOGMIX	_IOWR('A', 13, snd_mix_param)	/* return mixer status */
220 #define AIOSMIX	_IOWR('A', 14, snd_mix_param)	/* sets mixer status   */
221 
222 /*
223  * channel specifiers used in AIOSTOP and AIOSYNC
224  */
225 #define	AIOSYNC_PLAY	0x1	/* play chan */
226 #define	AIOSYNC_CAPTURE	0x2	/* capture chan */
227 /* AIOSTOP stop & flush a channel, returns the residual count */
228 #define	AIOSTOP	_IOWR ('A', 15, int)
229 
230 /* alternate method used to notify the sync condition */
231 #define	AIOSYNC_SIGNAL	0x100
232 #define	AIOSYNC_SELECT	0x200
233 
234 /* what the 'pos' field refers to */
235 #define AIOSYNC_READY	0x400
236 #define AIOSYNC_FREE	0x800
237 
238 typedef struct _snd_sync_parm {
239     long chan ; /* play or capture channel, plus modifier */
240     long pos;
241 } snd_sync_parm;
242 #define	AIOSYNC	_IOWR ('A', 15, snd_sync_parm)	/* misc. synchronization */
243 
244 /*
245  * The following is used to return device capabilities. If the structure
246  * passed to the ioctl is zeroed, default values are returned for rate
247  * and formats, a bitmap of available mixers is returned, and values
248  * (inputs, different levels) for the first one are returned.
249  *
250  * If  formats, mixers, inputs are instantiated, then detailed info
251  * are returned depending on the call.
252  */
253 typedef struct _snd_capabilities {
254     u_long	rate_min, rate_max;	/* min-max sampling rate */
255     u_long	formats;
256     u_long	bufsize; /* DMA buffer size */
257     u_long	mixers; /* bitmap of available mixers */
258     u_long	inputs; /* bitmap of available inputs (per mixer) */
259     u_short	left, right;	/* how many levels are supported */
260 } snd_capabilities;
261 #define AIOGCAP	_IOWR('A', 15, snd_capabilities)	/* get capabilities */
262 
263 /*
264  * here is the old (Voxware) ioctl interface
265  */
266 
267 /*
268  * IOCTL Commands for /dev/sequencer
269  */
270 
271 #define SNDCTL_SEQ_RESET	_IO  ('Q', 0)
272 #define SNDCTL_SEQ_SYNC		_IO  ('Q', 1)
273 #define SNDCTL_SYNTH_INFO	_IOWR('Q', 2, struct synth_info)
274 #define SNDCTL_SEQ_CTRLRATE	_IOWR('Q', 3, int) /* Set/get timer res.(hz) */
275 #define SNDCTL_SEQ_GETOUTCOUNT	_IOR ('Q', 4, int)
276 #define SNDCTL_SEQ_GETINCOUNT	_IOR ('Q', 5, int)
277 #define SNDCTL_SEQ_PERCMODE	_IOW ('Q', 6, int)
278 #define SNDCTL_FM_LOAD_INSTR	_IOW ('Q', 7, struct sbi_instrument)	/* Valid for FM only */
279 #define SNDCTL_SEQ_TESTMIDI	_IOW ('Q', 8, int)
280 #define SNDCTL_SEQ_RESETSAMPLES	_IOW ('Q', 9, int)
281 #define SNDCTL_SEQ_NRSYNTHS	_IOR ('Q',10, int)
282 #define SNDCTL_SEQ_NRMIDIS	_IOR ('Q',11, int)
283 #define SNDCTL_MIDI_INFO	_IOWR('Q',12, struct midi_info)
284 #define SNDCTL_SEQ_THRESHOLD	_IOW ('Q',13, int)
285 #define SNDCTL_SEQ_TRESHOLD	SNDCTL_SEQ_THRESHOLD	/* there was once a typo */
286 #define SNDCTL_SYNTH_MEMAVL	_IOWR('Q',14, int) /* in=dev#, out=memsize */
287 #define SNDCTL_FM_4OP_ENABLE	_IOW ('Q',15, int) /* in=dev# */
288 #define SNDCTL_PMGR_ACCESS	_IOWR('Q',16, struct patmgr_info)
289 #define SNDCTL_SEQ_PANIC	_IO  ('Q',17)
290 #define SNDCTL_SEQ_OUTOFBAND	_IOW ('Q',18, struct seq_event_rec)
291 
292 struct seq_event_rec {
293 	u_char arr[8];
294 };
295 
296 #define SNDCTL_TMR_TIMEBASE	_IOWR('T', 1, int)
297 #define SNDCTL_TMR_START	_IO  ('T', 2)
298 #define SNDCTL_TMR_STOP		_IO  ('T', 3)
299 #define SNDCTL_TMR_CONTINUE	_IO  ('T', 4)
300 #define SNDCTL_TMR_TEMPO	_IOWR('T', 5, int)
301 #define SNDCTL_TMR_SOURCE	_IOWR('T', 6, int)
302 #   define TMR_INTERNAL		0x00000001
303 #   define TMR_EXTERNAL		0x00000002
304 #	define TMR_MODE_MIDI	0x00000010
305 #	define TMR_MODE_FSK	0x00000020
306 #	define TMR_MODE_CLS	0x00000040
307 #	define TMR_MODE_SMPTE	0x00000080
308 #define SNDCTL_TMR_METRONOME	_IOW ('T', 7, int)
309 #define SNDCTL_TMR_SELECT	_IOW ('T', 8, int)
310 
311 /*
312  *	Endian aware patch key generation algorithm.
313  */
314 
315 #if defined(_AIX) || defined(AIX)
316 #  define _PATCHKEY(id) (0xfd00|id)
317 #else
318 #  define _PATCHKEY(id) ((id<<8)|0xfd)
319 #endif
320 
321 /*
322  *	Sample loading mechanism for internal synthesizers (/dev/sequencer)
323  *	The following patch_info structure has been designed to support
324  *	Gravis UltraSound. It tries to be universal format for uploading
325  *	sample based patches but is probably too limited.
326  */
327 
328 struct patch_info {
329 /*		u_short key;		 Use GUS_PATCH here */
330 	short key;		 /* Use GUS_PATCH here */
331 #define GUS_PATCH	_PATCHKEY(0x04)
332 #define OBSOLETE_GUS_PATCH	_PATCHKEY(0x02)
333 
334 	short device_no;	/* Synthesizer number */
335 	short instr_no;		/* Midi pgm# */
336 
337 	u_long mode;
338 /*
339  * The least significant byte has the same format than the GUS .PAT
340  * files
341  */
342 #define WAVE_16_BITS	0x01	/* bit 0 = 8 or 16 bit wave data. */
343 #define WAVE_UNSIGNED	0x02	/* bit 1 = Signed - Unsigned data. */
344 #define WAVE_LOOPING	0x04	/* bit 2 = looping enabled-1. */
345 #define WAVE_BIDIR_LOOP	0x08	/* bit 3 = Set is bidirectional looping. */
346 #define WAVE_LOOP_BACK	0x10	/* bit 4 = Set is looping backward. */
347 #define WAVE_SUSTAIN_ON	0x20	/* bit 5 = Turn sustaining on. (Env. pts. 3)*/
348 #define WAVE_ENVELOPES	0x40	/* bit 6 = Enable envelopes - 1 */
349 				/* 	(use the env_rate/env_offs fields). */
350 /* Linux specific bits */
351 #define WAVE_VIBRATO	0x00010000	/* The vibrato info is valid */
352 #define WAVE_TREMOLO	0x00020000	/* The tremolo info is valid */
353 #define WAVE_SCALE	0x00040000	/* The scaling info is valid */
354 /* Other bits must be zeroed */
355 
356 	long len;	/* Size of the wave data in bytes */
357 	long loop_start, loop_end; /* Byte offsets from the beginning */
358 
359 /*
360  * The base_freq and base_note fields are used when computing the
361  * playback speed for a note. The base_note defines the tone frequency
362  * which is heard if the sample is played using the base_freq as the
363  * playback speed.
364  *
365  * The low_note and high_note fields define the minimum and maximum note
366  * frequencies for which this sample is valid. It is possible to define
367  * more than one samples for a instrument number at the same time. The
368  * low_note and high_note fields are used to select the most suitable one.
369  *
370  * The fields base_note, high_note and low_note should contain
371  * the note frequency multiplied by 1000. For example value for the
372  * middle A is 440*1000.
373  */
374 
375 	u_int base_freq;
376 	u_long base_note;
377 	u_long high_note;
378 	u_long low_note;
379 	int panning;	/* -128=left, 127=right */
380 	int detuning;
381 
382 /*	New fields introduced in version 1.99.5	*/
383 
384        /* Envelope. Enabled by mode bit WAVE_ENVELOPES	*/
385 	u_char	env_rate[ 6 ];	 /* GUS HW ramping rate */
386 	u_char	env_offset[ 6 ]; /* 255 == 100% */
387 
388 	/*
389 	 * The tremolo, vibrato and scale info are not supported yet.
390 	 * Enable by setting the mode bits WAVE_TREMOLO, WAVE_VIBRATO or
391 	 * WAVE_SCALE
392 	 */
393 
394 	u_char	tremolo_sweep;
395 	u_char	tremolo_rate;
396 	u_char	tremolo_depth;
397 
398 	u_char	vibrato_sweep;
399 	u_char	vibrato_rate;
400 	u_char	vibrato_depth;
401 
402 	int		scale_frequency;
403 	u_int	scale_factor;		/* from 0 to 2048 or 0 to 2 */
404 
405 	int		volume;
406 	int		spare[4];
407 	char data[1];	/* The waveform data starts here */
408 };
409 
410 struct sysex_info {
411 	short key;		/* Use GUS_PATCH here */
412 #define SYSEX_PATCH	_PATCHKEY(0x05)
413 #define MAUI_PATCH	_PATCHKEY(0x06)
414 	short device_no;	/* Synthesizer number */
415 	long len;	/* Size of the sysex data in bytes */
416 	u_char data[1];	/* Sysex data starts here */
417 };
418 
419 /*
420  * Patch management interface (/dev/sequencer, /dev/patmgr#)
421  * Don't use these calls if you want to maintain compatibility with
422  * the future versions of the driver.
423  */
424 
425 #define PS_NO_PATCHES		0	/* No patch support on device */
426 #define	PS_MGR_NOT_OK		1	/* Plain patch support (no mgr) */
427 #define	PS_MGR_OK		2	/* Patch manager supported */
428 #define	PS_MANAGED		3	/* Patch manager running */
429 
430 #define SNDCTL_PMGR_IFACE		_IOWR('P', 1, struct patmgr_info)
431 
432 /*
433  * The patmgr_info is a fixed size structure which is used for two
434  * different purposes. The intended use is for communication between
435  * the application using /dev/sequencer and the patch manager daemon
436  * associated with a synthesizer device (ioctl(SNDCTL_PMGR_ACCESS)).
437  *
438  * This structure is also used with ioctl(SNDCTL_PGMR_IFACE) which allows
439  * a patch manager daemon to read and write device parameters. This
440  * ioctl available through /dev/sequencer also. Avoid using it since it's
441  * extremely hardware dependent. In addition access trough /dev/sequencer
442  * may confuse the patch manager daemon.
443  */
444 
445 struct patmgr_info {	/* Note! size must be < 4k since kmalloc() is used */
446 	  u_long key;	/* Don't worry. Reserved for communication
447 	  			   between the patch manager and the driver. */
448 #define PM_K_EVENT		1 /* Event from the /dev/sequencer driver */
449 #define PM_K_COMMAND		2 /* Request from a application */
450 #define PM_K_RESPONSE		3 /* From patmgr to application */
451 #define PM_ERROR		4 /* Error returned by the patmgr */
452 	  int device;
453 	  int command;
454 
455 /*
456  * Commands 0x000 to 0xfff reserved for patch manager programs
457  */
458 #define PM_GET_DEVTYPE	1	/* Returns type of the patch mgr interface of dev */
459 #define		PMTYPE_FM2	1	/* 2 OP fm */
460 #define		PMTYPE_FM4	2	/* Mixed 4 or 2 op FM (OPL-3) */
461 #define		PMTYPE_WAVE	3	/* Wave table synthesizer (GUS) */
462 #define PM_GET_NRPGM	2	/* Returns max # of midi programs in parm1 */
463 #define PM_GET_PGMMAP	3	/* Returns map of loaded midi programs in data8 */
464 #define PM_GET_PGM_PATCHES 4	/* Return list of patches of a program (parm1) */
465 #define PM_GET_PATCH	5	/* Return patch header of patch parm1 */
466 #define PM_SET_PATCH	6	/* Set patch header of patch parm1 */
467 #define PM_READ_PATCH	7	/* Read patch (wave) data */
468 #define PM_WRITE_PATCH	8	/* Write patch (wave) data */
469 
470 /*
471  * Commands 0x1000 to 0xffff are for communication between the patch manager
472  * and the client
473  */
474 #define _PM_LOAD_PATCH	0x100
475 
476 /*
477  * Commands above 0xffff reserved for device specific use
478  */
479 
480 	long parm1;
481 	long parm2;
482 	long parm3;
483 
484 	union {
485 		u_char data8[4000];
486 		u_short data16[2000];
487 		u_long data32[1000];
488 		struct patch_info patch;
489 	} data;
490 };
491 
492 /*
493  * When a patch manager daemon is present, it will be informed by the
494  * driver when something important happens. For example when the
495  * /dev/sequencer is opened or closed. A record with key == PM_K_EVENT is
496  * returned. The command field contains the event type:
497  */
498 #define PM_E_OPENED		1	/* /dev/sequencer opened */
499 #define PM_E_CLOSED		2	/* /dev/sequencer closed */
500 #define PM_E_PATCH_RESET	3	/* SNDCTL_RESETSAMPLES called */
501 #define PM_E_PATCH_LOADED	4	/* A patch has been loaded by appl */
502 
503 /*
504  * /dev/sequencer input events.
505  *
506  * The data written to the /dev/sequencer is a stream of events. Events
507  * are records of 4 or 8 bytes. The first byte defines the size.
508  * Any number of events can be written with a write call. There
509  * is a set of macros for sending these events. Use these macros if you
510  * want to maximize portability of your program.
511  *
512  * Events SEQ_WAIT, SEQ_MIDIPUTC and SEQ_ECHO. Are also input events.
513  * (All input events are currently 4 bytes long. Be prepared to support
514  * 8 byte events also. If you receive any event having first byte >= 128,
515  * it's a 8 byte event.
516  *
517  * The events are documented at the end of this file.
518  *
519  * Normal events (4 bytes)
520  * There is also a 8 byte version of most of the 4 byte events. The
521  * 8 byte one is recommended.
522  */
523 #define SEQ_NOTEOFF		0
524 #define SEQ_FMNOTEOFF		SEQ_NOTEOFF	/* Just old name */
525 #define SEQ_NOTEON		1
526 #define	SEQ_FMNOTEON		SEQ_NOTEON
527 #define SEQ_WAIT		TMR_WAIT_ABS
528 #define SEQ_PGMCHANGE		3
529 #define SEQ_FMPGMCHANGE		SEQ_PGMCHANGE
530 #define SEQ_SYNCTIMER		TMR_START
531 #define SEQ_MIDIPUTC		5
532 #define SEQ_DRUMON		6	/*** OBSOLETE ***/
533 #define SEQ_DRUMOFF		7	/*** OBSOLETE ***/
534 #define SEQ_ECHO		TMR_ECHO	/* For synching programs with output */
535 #define SEQ_AFTERTOUCH		9
536 #define SEQ_CONTROLLER		10
537 
538 /*
539  *	Midi controller numbers
540  *
541  * Controllers 0 to 31 (0x00 to 0x1f) and 32 to 63 (0x20 to 0x3f)
542  * are continuous controllers.
543  * In the MIDI 1.0 these controllers are sent using two messages.
544  * Controller numbers 0 to 31 are used to send the MSB and the
545  * controller numbers 32 to 63 are for the LSB. Note that just 7 bits
546  * are used in MIDI bytes.
547  */
548 
549 #define	CTL_BANK_SELECT		0x00
550 #define	CTL_MODWHEEL		0x01
551 #define CTL_BREATH		0x02
552 /*	undefined		0x03 */
553 #define CTL_FOOT		0x04
554 #define CTL_PORTAMENTO_TIME	0x05
555 #define CTL_DATA_ENTRY		0x06
556 #define CTL_MAIN_VOLUME		0x07
557 #define CTL_BALANCE		0x08
558 /*	undefined		0x09 */
559 #define CTL_PAN			0x0a
560 #define CTL_EXPRESSION		0x0b
561 /*	undefined		0x0c - 0x0f */
562 #define CTL_GENERAL_PURPOSE1	0x10
563 #define CTL_GENERAL_PURPOSE2	0x11
564 #define CTL_GENERAL_PURPOSE3	0x12
565 #define CTL_GENERAL_PURPOSE4	0x13
566 /*	undefined		0x14 - 0x1f */
567 
568 /*	undefined		0x20 */
569 
570 /*
571  * The controller numbers 0x21 to 0x3f are reserved for the
572  * least significant bytes of the controllers 0x00 to 0x1f.
573  * These controllers are not recognised by the driver.
574  *
575  * Controllers 64 to 69 (0x40 to 0x45) are on/off switches.
576  * 0=OFF and 127=ON (intermediate values are possible)
577  */
578 #define CTL_DAMPER_PEDAL	0x40
579 #define CTL_SUSTAIN		CTL_DAMPER_PEDAL	/* Alias */
580 #define CTL_HOLD		CTL_DAMPER_PEDAL	/* Alias */
581 #define CTL_PORTAMENTO		0x41
582 #define CTL_SOSTENUTO		0x42
583 #define CTL_SOFT_PEDAL		0x43
584 /*	undefined		0x44 */
585 #define CTL_HOLD2		0x45
586 /*	undefined		0x46 - 0x4f */
587 
588 #define CTL_GENERAL_PURPOSE5	0x50
589 #define CTL_GENERAL_PURPOSE6	0x51
590 #define CTL_GENERAL_PURPOSE7	0x52
591 #define CTL_GENERAL_PURPOSE8	0x53
592 /*	undefined		0x54 - 0x5a */
593 #define CTL_EXT_EFF_DEPTH	0x5b
594 #define CTL_TREMOLO_DEPTH	0x5c
595 #define CTL_CHORUS_DEPTH	0x5d
596 #define CTL_DETUNE_DEPTH	0x5e
597 #define CTL_CELESTE_DEPTH	CTL_DETUNE_DEPTH /* Alias for the above one */
598 #define CTL_PHASER_DEPTH	0x5f
599 #define CTL_DATA_INCREMENT	0x60
600 #define CTL_DATA_DECREMENT	0x61
601 #define CTL_NONREG_PARM_NUM_LSB	0x62
602 #define CTL_NONREG_PARM_NUM_MSB	0x63
603 #define CTL_REGIST_PARM_NUM_LSB	0x64
604 #define CTL_REGIST_PARM_NUM_MSB	0x65
605 /*	undefined		0x66 - 0x78 */
606 /*	reserved		0x79 - 0x7f */
607 
608 /* Pseudo controllers (not midi compatible) */
609 #define CTRL_PITCH_BENDER	255
610 #define CTRL_PITCH_BENDER_RANGE	254
611 #define CTRL_EXPRESSION		253	/* Obsolete */
612 #define CTRL_MAIN_VOLUME	252	/* Obsolete */
613 
614 #define SEQ_BALANCE		11
615 #define SEQ_VOLMODE             12
616 
617 /*
618  * Volume mode decides how volumes are used
619  */
620 
621 #define VOL_METHOD_ADAGIO	1
622 #define VOL_METHOD_LINEAR	2
623 
624 /*
625  * Note! SEQ_WAIT, SEQ_MIDIPUTC and SEQ_ECHO are used also as
626  *	 input events.
627  */
628 
629 /*
630  * Event codes 0xf0 to 0xfc are reserved for future extensions.
631  */
632 
633 #define SEQ_FULLSIZE		0xfd	/* Long events */
634 /*
635  * SEQ_FULLSIZE events are used for loading patches/samples to the
636  * synthesizer devices. These events are passed directly to the driver
637  * of the associated synthesizer device. There is no limit to the size
638  * of the extended events. These events are not queued but executed
639  * immediately when the write() is called (execution can take several
640  * seconds of time).
641  *
642  * When a SEQ_FULLSIZE message is written to the device, it must
643  * be written using exactly one write() call. Other events cannot
644  * be mixed to the same write.
645  *
646  * For FM synths (YM3812/OPL3) use struct sbi_instrument and write
647  * it to the /dev/sequencer. Don't write other data together with
648  * the instrument structure Set the key field of the structure to
649  * FM_PATCH. The device field is used to route the patch to the
650  * corresponding device.
651  *
652  * For Gravis UltraSound use struct patch_info. Initialize the key field
653  * to GUS_PATCH.
654  */
655 #define SEQ_PRIVATE	0xfe	/* Low level HW dependent events (8 bytes) */
656 #define SEQ_EXTENDED	0xff	/* Extended events (8 bytes) OBSOLETE */
657 
658 /*
659  * Record for FM patches
660  */
661 
662 typedef u_char sbi_instr_data[32];
663 
664 struct sbi_instrument {
665 	u_short	key;	/* FM_PATCH or OPL3_PATCH */
666 #define FM_PATCH	_PATCHKEY(0x01)
667 #define OPL3_PATCH	_PATCHKEY(0x03)
668 	short		device;		/* Synth# (0-4)	*/
669 	int 		channel;	/* Program# to be initialized  */
670 	sbi_instr_data	operators;	/* Reg. settings for operator cells
671 					 * (.SBI format)	*/
672 };
673 
674 struct synth_info {	/* Read only */
675 	char	name[30];
676 	int	device;		/* 0-N. INITIALIZE BEFORE CALLING */
677 	int	synth_type;
678 #define SYNTH_TYPE_FM			0
679 #define SYNTH_TYPE_SAMPLE		1
680 #define SYNTH_TYPE_MIDI			2	/* Midi interface */
681 
682 	int	synth_subtype;
683 #define FM_TYPE_ADLIB			0x00
684 #define FM_TYPE_OPL3			0x01
685 
686 #define SAMPLE_TYPE_BASIC		0x10
687 #define SAMPLE_TYPE_GUS			SAMPLE_TYPE_BASIC
688 #define SAMPLE_TYPE_AWE32		0x20
689 
690 	int	perc_mode;	/* No longer supported */
691 	int	nr_voices;
692 	int	nr_drums;	/* Obsolete field */
693 	int	instr_bank_size;
694 	u_long	capabilities;
695 #define SYNTH_CAP_PERCMODE	0x00000001 /* No longer used */
696 #define SYNTH_CAP_OPL3		0x00000002 /* Set if OPL3 supported */
697 #define SYNTH_CAP_INPUT		0x00000004 /* Input (MIDI) device */
698 	int	dummies[19];	/* Reserve space */
699 };
700 
701 struct sound_timer_info {
702 	char name[32];
703 	int caps;
704 };
705 
706 #define MIDI_CAP_MPU401		1		/* MPU-401 intelligent mode */
707 
708 struct midi_info {
709 	char		name[30];
710 	int		device;		/* 0-N. INITIALIZE BEFORE CALLING */
711 	u_long	capabilities;	/* To be defined later */
712 	int		dev_type;
713 	int		dummies[18];	/* Reserve space */
714 };
715 
716 /*
717  * ioctl commands for the /dev/midi##
718  */
719 typedef struct {
720 	u_char cmd;
721 	char nr_args, nr_returns;
722 	u_char data[30];
723 } mpu_command_rec;
724 
725 #define SNDCTL_MIDI_PRETIME	_IOWR('m', 0, int)
726 #define SNDCTL_MIDI_MPUMODE	_IOWR('m', 1, int)
727 #define SNDCTL_MIDI_MPUCMD	_IOWR('m', 2, mpu_command_rec)
728 #define MIOSPASSTHRU		_IOWR('m', 3, int)
729 #define MIOGPASSTHRU		_IOWR('m', 4, int)
730 
731 /*
732  * IOCTL commands for /dev/dsp and /dev/audio
733  */
734 
735 #define SNDCTL_DSP_RESET	_IO  ('P', 0)
736 #define SNDCTL_DSP_SYNC		_IO  ('P', 1)
737 #define SNDCTL_DSP_SPEED	_IOWR('P', 2, int)
738 #define SNDCTL_DSP_STEREO	_IOWR('P', 3, int)
739 #define SNDCTL_DSP_GETBLKSIZE	_IOR('P', 4, int)
740 #define SNDCTL_DSP_SETBLKSIZE   _IOW('P', 4, int)
741 #define SNDCTL_DSP_SETFMT	_IOWR('P',5, int) /* Selects ONE fmt*/
742 
743 /*
744  * SOUND_PCM_WRITE_CHANNELS is not that different
745  * from SNDCTL_DSP_STEREO
746  */
747 #define SOUND_PCM_WRITE_CHANNELS	_IOWR('P', 6, int)
748 #define SNDCTL_DSP_CHANNELS	SOUND_PCM_WRITE_CHANNELS
749 #define SOUND_PCM_WRITE_FILTER	_IOWR('P', 7, int)
750 #define SNDCTL_DSP_POST		_IO  ('P', 8)
751 
752 /*
753  * SNDCTL_DSP_SETBLKSIZE and the following two calls mostly do
754  * the same thing, i.e. set the block size used in DMA transfers.
755  */
756 #define SNDCTL_DSP_SUBDIVIDE	_IOWR('P', 9, int)
757 #define SNDCTL_DSP_SETFRAGMENT	_IOWR('P',10, int)
758 
759 
760 #define SNDCTL_DSP_GETFMTS	_IOR ('P',11, int) /* Returns a mask */
761 /*
762  * Buffer status queries.
763  */
764 typedef struct audio_buf_info {
765     int fragments;	/* # of avail. frags (partly used ones not counted) */
766     int fragstotal;	/* Total # of fragments allocated */
767     int fragsize;	/* Size of a fragment in bytes */
768 
769     int bytes;	/* Avail. space in bytes (includes partly used fragments) */
770 		/* Note! 'bytes' could be more than fragments*fragsize */
771 } audio_buf_info;
772 
773 #define SNDCTL_DSP_GETOSPACE	_IOR ('P',12, audio_buf_info)
774 #define SNDCTL_DSP_GETISPACE	_IOR ('P',13, audio_buf_info)
775 
776 /*
777  * SNDCTL_DSP_NONBLOCK is the same (but less powerful, since the
778  * action cannot be undone) of FIONBIO. The same can be achieved
779  * by opening the device with O_NDELAY
780  */
781 #define SNDCTL_DSP_NONBLOCK	_IO  ('P',14)
782 
783 #define SNDCTL_DSP_GETCAPS	_IOR ('P',15, int)
784 #define DSP_CAP_REVISION	0x000000ff /* revision level (0 to 255) */
785 #define DSP_CAP_DUPLEX		0x00000100 /* Full duplex record/playback */
786 #define DSP_CAP_REALTIME	0x00000200 /* Real time capability */
787 #define DSP_CAP_BATCH		0x00000400
788     /*
789      * Device has some kind of internal buffers which may
790      * cause some delays and decrease precision of timing
791      */
792 #define DSP_CAP_COPROC		0x00000800
793     /* Has a coprocessor, sometimes it's a DSP but usually not */
794 #define DSP_CAP_TRIGGER		0x00001000 /* Supports SETTRIGGER */
795 #define DSP_CAP_MMAP 0x00002000 /* Supports mmap() */
796 
797 /*
798  * What do these function do ?
799  */
800 #define SNDCTL_DSP_GETTRIGGER	_IOR ('P',16, int)
801 #define SNDCTL_DSP_SETTRIGGER	_IOW ('P',16, int)
802 #define PCM_ENABLE_INPUT	0x00000001
803 #define PCM_ENABLE_OUTPUT	0x00000002
804 
805 typedef struct count_info {
806 	int bytes;	/* Total # of bytes processed */
807 	int blocks;	/* # of fragment transitions since last time */
808 	int ptr;	/* Current DMA pointer value */
809 } count_info;
810 
811 /*
812  * GETIPTR and GETISPACE are not that different... same for out.
813  */
814 #define SNDCTL_DSP_GETIPTR	_IOR ('P',17, count_info)
815 #define SNDCTL_DSP_GETOPTR	_IOR ('P',18, count_info)
816 
817 typedef struct buffmem_desc {
818 	caddr_t buffer;
819 	int size;
820 } buffmem_desc;
821 
822 #define SNDCTL_DSP_MAPINBUF	_IOR ('P', 19, buffmem_desc)
823 #define SNDCTL_DSP_MAPOUTBUF	_IOR ('P', 20, buffmem_desc)
824 #define SNDCTL_DSP_SETSYNCRO	_IO  ('P', 21)
825 #define SNDCTL_DSP_SETDUPLEX	_IO  ('P', 22)
826 #define SNDCTL_DSP_GETODELAY	_IOR ('P', 23, int)
827 
828 /*
829  * I guess these are the readonly version of the same
830  * functions that exist above as SNDCTL_DSP_...
831  */
832 #define SOUND_PCM_READ_RATE	_IOR ('P', 2, int)
833 #define SOUND_PCM_READ_CHANNELS	_IOR ('P', 6, int)
834 #define SOUND_PCM_READ_BITS	_IOR ('P', 5, int)
835 #define SOUND_PCM_READ_FILTER	_IOR ('P', 7, int)
836 
837 /*
838  * ioctl calls to be used in communication with coprocessors and
839  * DSP chips.
840  */
841 
842 typedef struct copr_buffer {
843 	int command;	/* Set to 0 if not used */
844 	int flags;
845 #define CPF_NONE		0x0000
846 #define CPF_FIRST		0x0001	/* First block */
847 #define CPF_LAST		0x0002	/* Last block */
848 	int len;
849 	int offs;	/* If required by the device (0 if not used) */
850 
851 	u_char data[4000]; /* NOTE! 4000 is not 4k */
852 } copr_buffer;
853 
854 typedef struct copr_debug_buf {
855 	int command;	/* Used internally. Set to 0 */
856 	int parm1;
857 	int parm2;
858 	int flags;
859 	int len;	/* Length of data in bytes */
860 } copr_debug_buf;
861 
862 typedef struct copr_msg {
863 	int len;
864 	u_char data[4000];
865 } copr_msg;
866 
867 #define SNDCTL_COPR_RESET       _IO  ('C',  0)
868 #define SNDCTL_COPR_LOAD	_IOWR('C',  1, copr_buffer)
869 #define SNDCTL_COPR_RDATA	_IOWR('C',  2, copr_debug_buf)
870 #define SNDCTL_COPR_RCODE	_IOWR('C',  3, copr_debug_buf)
871 #define SNDCTL_COPR_WDATA	_IOW ('C',  4, copr_debug_buf)
872 #define SNDCTL_COPR_WCODE	_IOW ('C',  5, copr_debug_buf)
873 #define SNDCTL_COPR_RUN		_IOWR('C',  6, copr_debug_buf)
874 #define SNDCTL_COPR_HALT	_IOWR('C',  7, copr_debug_buf)
875 #define SNDCTL_COPR_SENDMSG	_IOW ('C',  8, copr_msg)
876 #define SNDCTL_COPR_RCVMSG	_IOR ('C',  9, copr_msg)
877 
878 /*
879  * IOCTL commands for /dev/mixer
880  */
881 
882 /*
883  * Mixer devices
884  *
885  * There can be up to 20 different analog mixer channels. The
886  * SOUND_MIXER_NRDEVICES gives the currently supported maximum.
887  * The SOUND_MIXER_READ_DEVMASK returns a bitmask which tells
888  * the devices supported by the particular mixer.
889  */
890 
891 #define SOUND_MIXER_NRDEVICES	25
892 #define SOUND_MIXER_VOLUME	0	/* Master output level */
893 #define SOUND_MIXER_BASS	1	/* Treble level of all output channels */
894 #define SOUND_MIXER_TREBLE	2	/* Bass level of all output channels */
895 #define SOUND_MIXER_SYNTH	3	/* Volume of synthesier input */
896 #define SOUND_MIXER_PCM		4	/* Output level for the audio device */
897 #define SOUND_MIXER_SPEAKER	5	/* Output level for the PC speaker
898 					 * signals */
899 #define SOUND_MIXER_LINE	6	/* Volume level for the line in jack */
900 #define SOUND_MIXER_MIC		7	/* Volume for the signal coming from
901 					 * the microphone jack */
902 #define SOUND_MIXER_CD		8	/* Volume level for the input signal
903 					 * connected to the CD audio input */
904 #define SOUND_MIXER_IMIX	9	/* Recording monitor. It controls the
905 					 * output volume of the selected
906 					 * recording sources while recording */
907 #define SOUND_MIXER_ALTPCM	10	/* Volume of the alternative codec
908 					 * device */
909 #define SOUND_MIXER_RECLEV	11	/* Global recording level */
910 #define SOUND_MIXER_IGAIN	12	/* Input gain */
911 #define SOUND_MIXER_OGAIN	13	/* Output gain */
912 /*
913  * The AD1848 codec and compatibles have three line level inputs
914  * (line, aux1 and aux2). Since each card manufacturer have assigned
915  * different meanings to these inputs, it's inpractical to assign
916  * specific meanings (line, cd, synth etc.) to them.
917  */
918 #define SOUND_MIXER_LINE1	14	/* Input source 1  (aux1) */
919 #define SOUND_MIXER_LINE2	15	/* Input source 2  (aux2) */
920 #define SOUND_MIXER_LINE3	16	/* Input source 3  (line) */
921 #define SOUND_MIXER_DIGITAL1    17      /* Digital (input) 1 */
922 #define SOUND_MIXER_DIGITAL2    18      /* Digital (input) 2 */
923 #define SOUND_MIXER_DIGITAL3    19      /* Digital (input) 3 */
924 #define SOUND_MIXER_PHONEIN     20      /* Phone input */
925 #define SOUND_MIXER_PHONEOUT    21      /* Phone output */
926 #define SOUND_MIXER_VIDEO       22      /* Video/TV (audio) in */
927 #define SOUND_MIXER_RADIO       23      /* Radio in */
928 #define SOUND_MIXER_MONITOR     24      /* Monitor (usually mic) volume */
929 
930 
931 /*
932  * Some on/off settings (SOUND_SPECIAL_MIN - SOUND_SPECIAL_MAX)
933  * Not counted to SOUND_MIXER_NRDEVICES, but use the same number space
934  */
935 #define SOUND_ONOFF_MIN		28
936 #define SOUND_ONOFF_MAX		30
937 #define SOUND_MIXER_MUTE	28	/* 0 or 1 */
938 #define SOUND_MIXER_ENHANCE	29	/* Enhanced stereo (0, 40, 60 or 80) */
939 #define SOUND_MIXER_LOUD	30	/* 0 or 1 */
940 
941 /* Note!	Number 31 cannot be used since the sign bit is reserved */
942 #define SOUND_MIXER_NONE        31
943 
944 #define SOUND_DEVICE_LABELS	{ \
945 	"Vol  ", "Bass ", "Trebl", "Synth", "Pcm  ", "Spkr ", "Line ", \
946 	"Mic  ", "CD   ", "Mix  ", "Pcm2 ", "Rec  ", "IGain", "OGain", \
947 	"Line1", "Line2", "Line3", "Digital1", "Digital2", "Digital3", \
948 	"PhoneIn", "PhoneOut", "Video", "Radio", "Monitor"}
949 
950 #define SOUND_DEVICE_NAMES	{ \
951 	"vol", "bass", "treble", "synth", "pcm", "speaker", "line", \
952 	"mic", "cd", "mix", "pcm2", "rec", "igain", "ogain", \
953 	"line1", "line2", "line3", "dig1", "dig2", "dig3", \
954 	"phin", "phout", "video", "radio", "monitor"}
955 
956 /*	Device bitmask identifiers	*/
957 
958 #define SOUND_MIXER_RECSRC	0xff	/* 1 bit per recording source */
959 #define SOUND_MIXER_DEVMASK	0xfe	/* 1 bit per supported device */
960 #define SOUND_MIXER_RECMASK	0xfd	/* 1 bit per supp. recording source */
961 #define SOUND_MIXER_CAPS	0xfc
962 #define SOUND_CAP_EXCL_INPUT	0x00000001	/* Only 1 rec. src at a time */
963 #define SOUND_MIXER_STEREODEVS	0xfb	/* Mixer channels supporting stereo */
964 
965 /*	Device mask bits	*/
966 
967 #define SOUND_MASK_VOLUME	(1 << SOUND_MIXER_VOLUME)
968 #define SOUND_MASK_BASS		(1 << SOUND_MIXER_BASS)
969 #define SOUND_MASK_TREBLE	(1 << SOUND_MIXER_TREBLE)
970 #define SOUND_MASK_SYNTH	(1 << SOUND_MIXER_SYNTH)
971 #define SOUND_MASK_PCM		(1 << SOUND_MIXER_PCM)
972 #define SOUND_MASK_SPEAKER	(1 << SOUND_MIXER_SPEAKER)
973 #define SOUND_MASK_LINE		(1 << SOUND_MIXER_LINE)
974 #define SOUND_MASK_MIC		(1 << SOUND_MIXER_MIC)
975 #define SOUND_MASK_CD		(1 << SOUND_MIXER_CD)
976 #define SOUND_MASK_IMIX		(1 << SOUND_MIXER_IMIX)
977 #define SOUND_MASK_ALTPCM	(1 << SOUND_MIXER_ALTPCM)
978 #define SOUND_MASK_RECLEV	(1 << SOUND_MIXER_RECLEV)
979 #define SOUND_MASK_IGAIN	(1 << SOUND_MIXER_IGAIN)
980 #define SOUND_MASK_OGAIN	(1 << SOUND_MIXER_OGAIN)
981 #define SOUND_MASK_LINE1	(1 << SOUND_MIXER_LINE1)
982 #define SOUND_MASK_LINE2	(1 << SOUND_MIXER_LINE2)
983 #define SOUND_MASK_LINE3	(1 << SOUND_MIXER_LINE3)
984 #define SOUND_MASK_DIGITAL1     (1 << SOUND_MIXER_DIGITAL1)
985 #define SOUND_MASK_DIGITAL2     (1 << SOUND_MIXER_DIGITAL2)
986 #define SOUND_MASK_DIGITAL3     (1 << SOUND_MIXER_DIGITAL3)
987 #define SOUND_MASK_PHONEIN      (1 << SOUND_MIXER_PHONEIN)
988 #define SOUND_MASK_PHONEOUT     (1 << SOUND_MIXER_PHONEOUT)
989 #define SOUND_MASK_RADIO        (1 << SOUND_MIXER_RADIO)
990 #define SOUND_MASK_VIDEO        (1 << SOUND_MIXER_VIDEO)
991 #define SOUND_MASK_MONITOR      (1 << SOUND_MIXER_MONITOR)
992 
993 /* Obsolete macros */
994 #define SOUND_MASK_MUTE		(1 << SOUND_MIXER_MUTE)
995 #define SOUND_MASK_ENHANCE	(1 << SOUND_MIXER_ENHANCE)
996 #define SOUND_MASK_LOUD		(1 << SOUND_MIXER_LOUD)
997 
998 #define MIXER_READ(dev)		_IOR('M', dev, int)
999 #define SOUND_MIXER_READ_VOLUME		MIXER_READ(SOUND_MIXER_VOLUME)
1000 #define SOUND_MIXER_READ_BASS		MIXER_READ(SOUND_MIXER_BASS)
1001 #define SOUND_MIXER_READ_TREBLE		MIXER_READ(SOUND_MIXER_TREBLE)
1002 #define SOUND_MIXER_READ_SYNTH		MIXER_READ(SOUND_MIXER_SYNTH)
1003 #define SOUND_MIXER_READ_PCM		MIXER_READ(SOUND_MIXER_PCM)
1004 #define SOUND_MIXER_READ_SPEAKER	MIXER_READ(SOUND_MIXER_SPEAKER)
1005 #define SOUND_MIXER_READ_LINE		MIXER_READ(SOUND_MIXER_LINE)
1006 #define SOUND_MIXER_READ_MIC		MIXER_READ(SOUND_MIXER_MIC)
1007 #define SOUND_MIXER_READ_CD		MIXER_READ(SOUND_MIXER_CD)
1008 #define SOUND_MIXER_READ_IMIX		MIXER_READ(SOUND_MIXER_IMIX)
1009 #define SOUND_MIXER_READ_ALTPCM		MIXER_READ(SOUND_MIXER_ALTPCM)
1010 #define SOUND_MIXER_READ_RECLEV		MIXER_READ(SOUND_MIXER_RECLEV)
1011 #define SOUND_MIXER_READ_IGAIN		MIXER_READ(SOUND_MIXER_IGAIN)
1012 #define SOUND_MIXER_READ_OGAIN		MIXER_READ(SOUND_MIXER_OGAIN)
1013 #define SOUND_MIXER_READ_LINE1		MIXER_READ(SOUND_MIXER_LINE1)
1014 #define SOUND_MIXER_READ_LINE2		MIXER_READ(SOUND_MIXER_LINE2)
1015 #define SOUND_MIXER_READ_LINE3		MIXER_READ(SOUND_MIXER_LINE3)
1016 
1017 /* Obsolete macros */
1018 #define SOUND_MIXER_READ_MUTE		MIXER_READ(SOUND_MIXER_MUTE)
1019 #define SOUND_MIXER_READ_ENHANCE	MIXER_READ(SOUND_MIXER_ENHANCE)
1020 #define SOUND_MIXER_READ_LOUD		MIXER_READ(SOUND_MIXER_LOUD)
1021 
1022 #define SOUND_MIXER_READ_RECSRC		MIXER_READ(SOUND_MIXER_RECSRC)
1023 #define SOUND_MIXER_READ_DEVMASK	MIXER_READ(SOUND_MIXER_DEVMASK)
1024 #define SOUND_MIXER_READ_RECMASK	MIXER_READ(SOUND_MIXER_RECMASK)
1025 #define SOUND_MIXER_READ_STEREODEVS	MIXER_READ(SOUND_MIXER_STEREODEVS)
1026 #define SOUND_MIXER_READ_CAPS		MIXER_READ(SOUND_MIXER_CAPS)
1027 
1028 #define MIXER_WRITE(dev)		_IOWR('M', dev, int)
1029 #define SOUND_MIXER_WRITE_VOLUME	MIXER_WRITE(SOUND_MIXER_VOLUME)
1030 #define SOUND_MIXER_WRITE_BASS		MIXER_WRITE(SOUND_MIXER_BASS)
1031 #define SOUND_MIXER_WRITE_TREBLE	MIXER_WRITE(SOUND_MIXER_TREBLE)
1032 #define SOUND_MIXER_WRITE_SYNTH		MIXER_WRITE(SOUND_MIXER_SYNTH)
1033 #define SOUND_MIXER_WRITE_PCM		MIXER_WRITE(SOUND_MIXER_PCM)
1034 #define SOUND_MIXER_WRITE_SPEAKER	MIXER_WRITE(SOUND_MIXER_SPEAKER)
1035 #define SOUND_MIXER_WRITE_LINE		MIXER_WRITE(SOUND_MIXER_LINE)
1036 #define SOUND_MIXER_WRITE_MIC		MIXER_WRITE(SOUND_MIXER_MIC)
1037 #define SOUND_MIXER_WRITE_CD		MIXER_WRITE(SOUND_MIXER_CD)
1038 #define SOUND_MIXER_WRITE_IMIX		MIXER_WRITE(SOUND_MIXER_IMIX)
1039 #define SOUND_MIXER_WRITE_ALTPCM	MIXER_WRITE(SOUND_MIXER_ALTPCM)
1040 #define SOUND_MIXER_WRITE_RECLEV	MIXER_WRITE(SOUND_MIXER_RECLEV)
1041 #define SOUND_MIXER_WRITE_IGAIN		MIXER_WRITE(SOUND_MIXER_IGAIN)
1042 #define SOUND_MIXER_WRITE_OGAIN		MIXER_WRITE(SOUND_MIXER_OGAIN)
1043 #define SOUND_MIXER_WRITE_LINE1		MIXER_WRITE(SOUND_MIXER_LINE1)
1044 #define SOUND_MIXER_WRITE_LINE2		MIXER_WRITE(SOUND_MIXER_LINE2)
1045 #define SOUND_MIXER_WRITE_LINE3		MIXER_WRITE(SOUND_MIXER_LINE3)
1046 #define SOUND_MIXER_WRITE_MUTE		MIXER_WRITE(SOUND_MIXER_MUTE)
1047 #define SOUND_MIXER_WRITE_ENHANCE	MIXER_WRITE(SOUND_MIXER_ENHANCE)
1048 #define SOUND_MIXER_WRITE_LOUD		MIXER_WRITE(SOUND_MIXER_LOUD)
1049 
1050 #define SOUND_MIXER_WRITE_RECSRC	MIXER_WRITE(SOUND_MIXER_RECSRC)
1051 
1052 #define LEFT_CHN	0
1053 #define RIGHT_CHN	1
1054 
1055 /*
1056  * Level 2 event types for /dev/sequencer
1057  */
1058 
1059 /*
1060  * The 4 most significant bits of byte 0 specify the class of
1061  * the event:
1062  *
1063  *	0x8X = system level events,
1064  *	0x9X = device/port specific events, event[1] = device/port,
1065  *		The last 4 bits give the subtype:
1066  *			0x02	= Channel event (event[3] = chn).
1067  *			0x01	= note event (event[4] = note).
1068  *			(0x01 is not used alone but always with bit 0x02).
1069  *	       event[2] = MIDI message code (0x80=note off etc.)
1070  *
1071  */
1072 
1073 #define EV_SEQ_LOCAL		0x80
1074 #define EV_TIMING		0x81
1075 #define EV_CHN_COMMON		0x92
1076 #define EV_CHN_VOICE		0x93
1077 #define EV_SYSEX		0x94
1078 /*
1079  * Event types 200 to 220 are reserved for application use.
1080  * These numbers will not be used by the driver.
1081  */
1082 
1083 /*
1084  * Events for event type EV_CHN_VOICE
1085  */
1086 
1087 #define MIDI_NOTEOFF		0x80
1088 #define MIDI_NOTEON		0x90
1089 #define MIDI_KEY_PRESSURE	0xA0
1090 
1091 /*
1092  * Events for event type EV_CHN_COMMON
1093  */
1094 
1095 #define MIDI_CTL_CHANGE		0xB0
1096 #define MIDI_PGM_CHANGE		0xC0
1097 #define MIDI_CHN_PRESSURE	0xD0
1098 #define MIDI_PITCH_BEND		0xE0
1099 
1100 #define MIDI_SYSTEM_PREFIX	0xF0
1101 
1102 /*
1103  * Timer event types
1104  */
1105 #define TMR_WAIT_REL		1	/* Time relative to the prev time */
1106 #define TMR_WAIT_ABS		2	/* Absolute time since TMR_START */
1107 #define TMR_STOP		3
1108 #define TMR_START		4
1109 #define TMR_CONTINUE		5
1110 #define TMR_TEMPO		6
1111 #define TMR_ECHO		8
1112 #define TMR_CLOCK		9	/* MIDI clock */
1113 #define TMR_SPP			10	/* Song position pointer */
1114 #define TMR_TIMESIG		11	/* Time signature */
1115 
1116 /*
1117  *	Local event types
1118  */
1119 #define LOCL_STARTAUDIO		1
1120 
1121 #if (!defined(_KERNEL) && !defined(INKERNEL)) || defined(USE_SEQ_MACROS)
1122 /*
1123  *	Some convenience macros to simplify programming of the
1124  *	/dev/sequencer interface
1125  *
1126  *	These macros define the API which should be used when possible.
1127  */
1128 
1129 #ifndef USE_SIMPLE_MACROS
1130 void seqbuf_dump(void);	/* This function must be provided by programs */
1131 
1132 /* Sample seqbuf_dump() implementation:
1133  *
1134  *	SEQ_DEFINEBUF (2048);	-- Defines a buffer for 2048 bytes
1135  *
1136  *	int seqfd;		-- The file descriptor for /dev/sequencer.
1137  *
1138  *	void
1139  *	seqbuf_dump ()
1140  *	{
1141  *	  if (_seqbufptr)
1142  *	    if (write (seqfd, _seqbuf, _seqbufptr) == -1)
1143  *	      {
1144  *		perror ("write /dev/sequencer");
1145  *		exit (-1);
1146  *	      }
1147  *	  _seqbufptr = 0;
1148  *	}
1149  */
1150 
1151 #define SEQ_DEFINEBUF(len)		\
1152 	u_char _seqbuf[len]; int _seqbuflen = len;int _seqbufptr = 0
1153 #define SEQ_USE_EXTBUF()		\
1154 	extern u_char _seqbuf[]; \
1155 	extern int _seqbuflen;extern int _seqbufptr
1156 #define SEQ_DECLAREBUF()		SEQ_USE_EXTBUF()
1157 #define SEQ_PM_DEFINES			struct patmgr_info _pm_info
1158 #define _SEQ_NEEDBUF(len)		\
1159 	if ((_seqbufptr+(len)) > _seqbuflen) \
1160 		seqbuf_dump()
1161 #define _SEQ_ADVBUF(len)		_seqbufptr += len
1162 #define SEQ_DUMPBUF			seqbuf_dump
1163 #else
1164 /*
1165  * This variation of the sequencer macros is used just to format one event
1166  * using fixed buffer.
1167  *
1168  * The program using the macro library must define the following macros before
1169  * using this library.
1170  *
1171  * #define _seqbuf 		 name of the buffer (u_char[])
1172  * #define _SEQ_ADVBUF(len)	 If the applic needs to know the exact
1173  *				 size of the event, this macro can be used.
1174  *				 Otherwise this must be defined as empty.
1175  * #define _seqbufptr		 Define the name of index variable or 0 if
1176  *				 not required.
1177  */
1178 #define _SEQ_NEEDBUF(len)	/* empty */
1179 #endif
1180 
1181 #define PM_LOAD_PATCH(dev, bank, pgm)	\
1182 	(SEQ_DUMPBUF(), _pm_info.command = _PM_LOAD_PATCH, \
1183 	_pm_info.device=dev, _pm_info.data.data8[0]=pgm, \
1184 	_pm_info.parm1 = bank, _pm_info.parm2 = 1, \
1185 	ioctl(seqfd, SNDCTL_PMGR_ACCESS, &_pm_info))
1186 #define PM_LOAD_PATCHES(dev, bank, pgm) \
1187 	(SEQ_DUMPBUF(), _pm_info.command = _PM_LOAD_PATCH, \
1188 	_pm_info.device=dev, bcopy( pgm, _pm_info.data.data8,  128), \
1189 	_pm_info.parm1 = bank, _pm_info.parm2 = 128, \
1190 	ioctl(seqfd, SNDCTL_PMGR_ACCESS, &_pm_info))
1191 
1192 #define SEQ_VOLUME_MODE(dev, mode)	{ \
1193 	_SEQ_NEEDBUF(8);\
1194 	_seqbuf[_seqbufptr] = SEQ_EXTENDED;\
1195 	_seqbuf[_seqbufptr+1] = SEQ_VOLMODE;\
1196 	_seqbuf[_seqbufptr+2] = (dev);\
1197 	_seqbuf[_seqbufptr+3] = (mode);\
1198 	_seqbuf[_seqbufptr+4] = 0;\
1199 	_seqbuf[_seqbufptr+5] = 0;\
1200 	_seqbuf[_seqbufptr+6] = 0;\
1201 	_seqbuf[_seqbufptr+7] = 0;\
1202 	_SEQ_ADVBUF(8);}
1203 
1204 /*
1205  * Midi voice messages
1206  */
1207 
1208 #define _CHN_VOICE(dev, event, chn, note, parm)  { \
1209 	_SEQ_NEEDBUF(8);\
1210 	_seqbuf[_seqbufptr] = EV_CHN_VOICE;\
1211 	_seqbuf[_seqbufptr+1] = (dev);\
1212 	_seqbuf[_seqbufptr+2] = (event);\
1213 	_seqbuf[_seqbufptr+3] = (chn);\
1214 	_seqbuf[_seqbufptr+4] = (note);\
1215 	_seqbuf[_seqbufptr+5] = (parm);\
1216 	_seqbuf[_seqbufptr+6] = (0);\
1217 	_seqbuf[_seqbufptr+7] = 0;\
1218 	_SEQ_ADVBUF(8);}
1219 
1220 #define SEQ_START_NOTE(dev, chn, note, vol) \
1221 		_CHN_VOICE(dev, MIDI_NOTEON, chn, note, vol)
1222 
1223 #define SEQ_STOP_NOTE(dev, chn, note, vol) \
1224 		_CHN_VOICE(dev, MIDI_NOTEOFF, chn, note, vol)
1225 
1226 #define SEQ_KEY_PRESSURE(dev, chn, note, pressure) \
1227 		_CHN_VOICE(dev, MIDI_KEY_PRESSURE, chn, note, pressure)
1228 
1229 /*
1230  * Midi channel messages
1231  */
1232 
1233 #define _CHN_COMMON(dev, event, chn, p1, p2, w14) { \
1234 	_SEQ_NEEDBUF(8);\
1235 	_seqbuf[_seqbufptr] = EV_CHN_COMMON;\
1236 	_seqbuf[_seqbufptr+1] = (dev);\
1237 	_seqbuf[_seqbufptr+2] = (event);\
1238 	_seqbuf[_seqbufptr+3] = (chn);\
1239 	_seqbuf[_seqbufptr+4] = (p1);\
1240 	_seqbuf[_seqbufptr+5] = (p2);\
1241 	*(short *)&_seqbuf[_seqbufptr+6] = (w14);\
1242 	_SEQ_ADVBUF(8);}
1243 /*
1244  * SEQ_SYSEX permits sending of sysex messages. (It may look that it permits
1245  * sending any MIDI bytes but it's absolutely not possible. Trying to do
1246  * so _will_ cause problems with MPU401 intelligent mode).
1247  *
1248  * Sysex messages are sent in blocks of 1 to 6 bytes. Longer messages must be
1249  * sent by calling SEQ_SYSEX() several times (there must be no other events
1250  * between them). First sysex fragment must have 0xf0 in the first byte
1251  * and the last byte (buf[len-1] of the last fragment must be 0xf7. No byte
1252  * between these sysex start and end markers cannot be larger than 0x7f. Also
1253  * lengths of each fragments (except the last one) must be 6.
1254  *
1255  * Breaking the above rules may work with some MIDI ports but is likely to
1256  * cause fatal problems with some other devices (such as MPU401).
1257  */
1258 #define SEQ_SYSEX(dev, buf, len) { \
1259 	int i, l=(len); if (l>6)l=6;\
1260 	_SEQ_NEEDBUF(8);\
1261 	_seqbuf[_seqbufptr] = EV_SYSEX;\
1262 	for(i=0;i<l;i++)_seqbuf[_seqbufptr+i+1] = (buf)[i];\
1263 	for(i=l;i<6;i++)_seqbuf[_seqbufptr+i+1] = 0xff;\
1264 	_SEQ_ADVBUF(8);}
1265 
1266 #define SEQ_CHN_PRESSURE(dev, chn, pressure) \
1267 	_CHN_COMMON(dev, MIDI_CHN_PRESSURE, chn, pressure, 0, 0)
1268 
1269 #define SEQ_SET_PATCH(dev, chn, patch) \
1270 	_CHN_COMMON(dev, MIDI_PGM_CHANGE, chn, patch, 0, 0)
1271 
1272 #define SEQ_CONTROL(dev, chn, controller, value) \
1273 	_CHN_COMMON(dev, MIDI_CTL_CHANGE, chn, controller, 0, value)
1274 
1275 #define SEQ_BENDER(dev, chn, value) \
1276 	_CHN_COMMON(dev, MIDI_PITCH_BEND, chn, 0, 0, value)
1277 
1278 
1279 #define SEQ_V2_X_CONTROL(dev, voice, controller, value)	{ \
1280 	_SEQ_NEEDBUF(8);\
1281 	_seqbuf[_seqbufptr] = SEQ_EXTENDED;\
1282 	_seqbuf[_seqbufptr+1] = SEQ_CONTROLLER;\
1283 	_seqbuf[_seqbufptr+2] = (dev);\
1284 	_seqbuf[_seqbufptr+3] = (voice);\
1285 	_seqbuf[_seqbufptr+4] = (controller);\
1286 	*(short *)&_seqbuf[_seqbufptr+5] = (value);\
1287 	_seqbuf[_seqbufptr+7] = 0;\
1288 	_SEQ_ADVBUF(8);}
1289 
1290 /*
1291  * The following 5 macros are incorrectly implemented and obsolete.
1292  * Use SEQ_BENDER and SEQ_CONTROL (with proper controller) instead.
1293  */
1294 
1295 #define SEQ_PITCHBEND(dev, voice, value) \
1296 	SEQ_V2_X_CONTROL(dev, voice, CTRL_PITCH_BENDER, value)
1297 #define SEQ_BENDER_RANGE(dev, voice, value) \
1298 	SEQ_V2_X_CONTROL(dev, voice, CTRL_PITCH_BENDER_RANGE, value)
1299 #define SEQ_EXPRESSION(dev, voice, value) \
1300 	SEQ_CONTROL(dev, voice, CTL_EXPRESSION, value*128)
1301 #define SEQ_MAIN_VOLUME(dev, voice, value) \
1302 	SEQ_CONTROL(dev, voice, CTL_MAIN_VOLUME, (value*16383)/100)
1303 #define SEQ_PANNING(dev, voice, pos) \
1304 	SEQ_CONTROL(dev, voice, CTL_PAN, (pos+128) / 2)
1305 
1306 /*
1307  * Timing and syncronization macros
1308  */
1309 
1310 #define _TIMER_EVENT(ev, parm)		{ \
1311 	_SEQ_NEEDBUF(8);\
1312 	_seqbuf[_seqbufptr+0] = EV_TIMING; \
1313 	_seqbuf[_seqbufptr+1] = (ev); \
1314 	_seqbuf[_seqbufptr+2] = 0;\
1315 	_seqbuf[_seqbufptr+3] = 0;\
1316 	*(u_int *)&_seqbuf[_seqbufptr+4] = (parm); \
1317 	_SEQ_ADVBUF(8); \
1318 	}
1319 
1320 #define SEQ_START_TIMER()		_TIMER_EVENT(TMR_START, 0)
1321 #define SEQ_STOP_TIMER()		_TIMER_EVENT(TMR_STOP, 0)
1322 #define SEQ_CONTINUE_TIMER()		_TIMER_EVENT(TMR_CONTINUE, 0)
1323 #define SEQ_WAIT_TIME(ticks)		_TIMER_EVENT(TMR_WAIT_ABS, ticks)
1324 #define SEQ_DELTA_TIME(ticks)		_TIMER_EVENT(TMR_WAIT_REL, ticks)
1325 #define SEQ_ECHO_BACK(key)		_TIMER_EVENT(TMR_ECHO, key)
1326 #define SEQ_SET_TEMPO(value)		_TIMER_EVENT(TMR_TEMPO, value)
1327 #define SEQ_SONGPOS(pos)		_TIMER_EVENT(TMR_SPP, pos)
1328 #define SEQ_TIME_SIGNATURE(sig)		_TIMER_EVENT(TMR_TIMESIG, sig)
1329 
1330 /*
1331  * Local control events
1332  */
1333 
1334 #define _LOCAL_EVENT(ev, parm)		{ \
1335 	_SEQ_NEEDBUF(8);\
1336 	_seqbuf[_seqbufptr+0] = EV_SEQ_LOCAL; \
1337 	_seqbuf[_seqbufptr+1] = (ev); \
1338 	_seqbuf[_seqbufptr+2] = 0;\
1339 	_seqbuf[_seqbufptr+3] = 0;\
1340 	*(u_int *)&_seqbuf[_seqbufptr+4] = (parm); \
1341 	_SEQ_ADVBUF(8); \
1342 	}
1343 
1344 #define SEQ_PLAYAUDIO(devmask)		_LOCAL_EVENT(LOCL_STARTAUDIO, devmask)
1345 /*
1346  * Events for the level 1 interface only
1347  */
1348 
1349 #define SEQ_MIDIOUT(device, byte)	{ \
1350 	_SEQ_NEEDBUF(4);\
1351 	_seqbuf[_seqbufptr] = SEQ_MIDIPUTC;\
1352 	_seqbuf[_seqbufptr+1] = (byte);\
1353 	_seqbuf[_seqbufptr+2] = (device);\
1354 	_seqbuf[_seqbufptr+3] = 0;\
1355 	_SEQ_ADVBUF(4);}
1356 
1357 /*
1358  * Patch loading.
1359  */
1360 #define SEQ_WRPATCH(patchx, len)	{ \
1361 	if (_seqbufptr) seqbuf_dump(); \
1362 	if (write(seqfd, (char*)(patchx), len)==-1) \
1363 	   perror("Write patch: /dev/sequencer"); \
1364 	}
1365 
1366 #define SEQ_WRPATCH2(patchx, len)	\
1367 	( seqbuf_dump(), write(seqfd, (char*)(patchx), len) )
1368 
1369 #endif
1370 
1371 /*
1372  * Here I have moved all the aliases for ioctl names.
1373  */
1374 
1375 #define SNDCTL_DSP_SAMPLESIZE	SNDCTL_DSP_SETFMT
1376 #define SOUND_PCM_WRITE_BITS	SNDCTL_DSP_SETFMT
1377 #define SOUND_PCM_SETFMT	SNDCTL_DSP_SETFMT
1378 
1379 #define SOUND_PCM_WRITE_RATE	SNDCTL_DSP_SPEED
1380 #define SOUND_PCM_POST		SNDCTL_DSP_POST
1381 #define SOUND_PCM_RESET		SNDCTL_DSP_RESET
1382 #define SOUND_PCM_SYNC		SNDCTL_DSP_SYNC
1383 #define SOUND_PCM_SUBDIVIDE	SNDCTL_DSP_SUBDIVIDE
1384 #define SOUND_PCM_SETFRAGMENT	SNDCTL_DSP_SETFRAGMENT
1385 #define SOUND_PCM_GETFMTS	SNDCTL_DSP_GETFMTS
1386 #define SOUND_PCM_GETOSPACE	SNDCTL_DSP_GETOSPACE
1387 #define SOUND_PCM_GETISPACE	SNDCTL_DSP_GETISPACE
1388 #define SOUND_PCM_NONBLOCK	SNDCTL_DSP_NONBLOCK
1389 #define SOUND_PCM_GETCAPS	SNDCTL_DSP_GETCAPS
1390 #define SOUND_PCM_GETTRIGGER	SNDCTL_DSP_GETTRIGGER
1391 #define SOUND_PCM_SETTRIGGER	SNDCTL_DSP_SETTRIGGER
1392 #define SOUND_PCM_SETSYNCRO	SNDCTL_DSP_SETSYNCRO
1393 #define SOUND_PCM_GETIPTR	SNDCTL_DSP_GETIPTR
1394 #define SOUND_PCM_GETOPTR	SNDCTL_DSP_GETOPTR
1395 #define SOUND_PCM_MAPINBUF	SNDCTL_DSP_MAPINBUF
1396 #define SOUND_PCM_MAPOUTBUF	SNDCTL_DSP_MAPOUTBUF
1397 
1398 #endif	/* !_SYS_SOUNDCARD_H_ */
1399