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