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