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