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