FreeBSD/Linux Kernel Cross Reference
sys/sys/soundcard.h
1 /*
2 * soundcard.h
3 */
4
5 /*-
6 * Copyright by Hannu Savolainen 1993 / 4Front Technologies 1993-2006
7 * Modified for the new FreeBSD sound driver by Luigi Rizzo, 1997
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above
15 * copyright notice, this list of conditions and the following
16 * disclaimer in the documentation and/or other materials provided
17 * with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS''
20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
22 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR
23 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
26 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * $FreeBSD$
33 */
34
35 /*
36 * Unless coordinating changes with 4Front Technologies, do NOT make any
37 * modifications to ioctl commands, types, etc. that would break
38 * compatibility with the OSS API.
39 */
40
41 #ifndef _SYS_SOUNDCARD_H_
42 #define _SYS_SOUNDCARD_H_
43 /*
44 * If you make modifications to this file, please contact me before
45 * distributing the modified version. There is already enough
46 * diversity in the world.
47 *
48 * Regards,
49 * Hannu Savolainen
50 * hannu@voxware.pp.fi
51 *
52 **********************************************************************
53 * PS. The Hacker's Guide to VoxWare available from
54 * nic.funet.fi:pub/Linux/ALPHA/sound. The file is
55 * snd-sdk-doc-0.1.ps.gz (gzipped postscript). It contains
56 * some useful information about programming with VoxWare.
57 * (NOTE! The pub/Linux/ALPHA/ directories are hidden. You have
58 * to cd inside them before the files are accessible.)
59 **********************************************************************
60 */
61
62 /*
63 * SOUND_VERSION is only used by the voxware driver. Hopefully apps
64 * should not depend on it, but rather look at the capabilities
65 * of the driver in the kernel!
66 */
67 #define SOUND_VERSION 301
68 #define VOXWARE /* does this have any use ? */
69
70 /*
71 * Supported card ID numbers (Should be somewhere else? We keep
72 * them here just for compativility with the old driver, but these
73 * constants are of little or no use).
74 */
75
76 #define SNDCARD_ADLIB 1
77 #define SNDCARD_SB 2
78 #define SNDCARD_PAS 3
79 #define SNDCARD_GUS 4
80 #define SNDCARD_MPU401 5
81 #define SNDCARD_SB16 6
82 #define SNDCARD_SB16MIDI 7
83 #define SNDCARD_UART6850 8
84 #define SNDCARD_GUS16 9
85 #define SNDCARD_MSS 10
86 #define SNDCARD_PSS 11
87 #define SNDCARD_SSCAPE 12
88 #define SNDCARD_PSS_MPU 13
89 #define SNDCARD_PSS_MSS 14
90 #define SNDCARD_SSCAPE_MSS 15
91 #define SNDCARD_TRXPRO 16
92 #define SNDCARD_TRXPRO_SB 17
93 #define SNDCARD_TRXPRO_MPU 18
94 #define SNDCARD_MAD16 19
95 #define SNDCARD_MAD16_MPU 20
96 #define SNDCARD_CS4232 21
97 #define SNDCARD_CS4232_MPU 22
98 #define SNDCARD_MAUI 23
99 #define SNDCARD_PSEUDO_MSS 24
100 #define SNDCARD_AWE32 25
101 #define SNDCARD_NSS 26
102 #define SNDCARD_UART16550 27
103 #define SNDCARD_OPL 28
104
105 #include <sys/types.h>
106 #include <machine/endian.h>
107 #ifndef _IOWR
108 #include <sys/ioccom.h>
109 #endif /* !_IOWR */
110
111 /*
112 * The first part of this file contains the new FreeBSD sound ioctl
113 * interface. Tries to minimize the number of different ioctls, and
114 * to be reasonably general.
115 *
116 * 970821: some of the new calls have not been implemented yet.
117 */
118
119 /*
120 * the following three calls extend the generic file descriptor
121 * interface. AIONWRITE is the dual of FIONREAD, i.e. returns the max
122 * number of bytes for a write operation to be non-blocking.
123 *
124 * AIOGSIZE/AIOSSIZE are used to change the behaviour of the device,
125 * from a character device (default) to a block device. In block mode,
126 * (not to be confused with blocking mode) the main difference for the
127 * application is that select() will return only when a complete
128 * block can be read/written to the device, whereas in character mode
129 * select will return true when one byte can be exchanged. For audio
130 * devices, character mode makes select almost useless since one byte
131 * will always be ready by the next sample time (which is often only a
132 * handful of microseconds away).
133 * Use a size of 0 or 1 to return to character mode.
134 */
135 #define AIONWRITE _IOR('A', 10, int) /* get # bytes to write */
136 struct snd_size {
137 int play_size;
138 int rec_size;
139 };
140 #define AIOGSIZE _IOR('A', 11, struct snd_size)/* read current blocksize */
141 #define AIOSSIZE _IOWR('A', 11, struct snd_size) /* sets blocksize */
142
143 /*
144 * The following constants define supported audio formats. The
145 * encoding follows voxware conventions, i.e. 1 bit for each supported
146 * format. We extend it by using bit 31 (RO) to indicate full-duplex
147 * capability, and bit 29 (RO) to indicate that the card supports/
148 * needs different formats on capture & playback channels.
149 * Bit 29 (RW) is used to indicate/ask stereo.
150 *
151 * The number of bits required to store the sample is:
152 * o 4 bits for the IDA ADPCM format,
153 * o 8 bits for 8-bit formats, mu-law and A-law,
154 * o 16 bits for the 16-bit formats, and
155 * o 32 bits for the 24/32-bit formats.
156 * o undefined for the MPEG audio format.
157 */
158
159 #define AFMT_QUERY 0x00000000 /* Return current format */
160 #define AFMT_MU_LAW 0x00000001 /* Logarithmic mu-law */
161 #define AFMT_A_LAW 0x00000002 /* Logarithmic A-law */
162 #define AFMT_IMA_ADPCM 0x00000004 /* A 4:1 compressed format where 16-bit
163 * squence represented using the
164 * the average 4 bits per sample */
165 #define AFMT_U8 0x00000008 /* Unsigned 8-bit */
166 #define AFMT_S16_LE 0x00000010 /* Little endian signed 16-bit */
167 #define AFMT_S16_BE 0x00000020 /* Big endian signed 16-bit */
168 #define AFMT_S8 0x00000040 /* Signed 8-bit */
169 #define AFMT_U16_LE 0x00000080 /* Little endian unsigned 16-bit */
170 #define AFMT_U16_BE 0x00000100 /* Big endian unsigned 16-bit */
171 #define AFMT_MPEG 0x00000200 /* MPEG MP2/MP3 audio */
172 #define AFMT_AC3 0x00000400 /* Dolby Digital AC3 */
173
174 #if _BYTE_ORDER == _LITTLE_ENDIAN
175 #define AFMT_S16_NE AFMT_S16_LE /* native endian signed 16 */
176 #else
177 #define AFMT_S16_NE AFMT_S16_BE
178 #endif
179
180 /*
181 * 32-bit formats below used for 24-bit audio data where the data is stored
182 * in the 24 most significant bits and the least significant bits are not used
183 * (should be set to 0).
184 */
185 #define AFMT_S32_LE 0x00001000 /* Little endian signed 32-bit */
186 #define AFMT_S32_BE 0x00002000 /* Big endian signed 32-bit */
187 #define AFMT_U32_LE 0x00004000 /* Little endian unsigned 32-bit */
188 #define AFMT_U32_BE 0x00008000 /* Big endian unsigned 32-bit */
189 #define AFMT_S24_LE 0x00010000 /* Little endian signed 24-bit */
190 #define AFMT_S24_BE 0x00020000 /* Big endian signed 24-bit */
191 #define AFMT_U24_LE 0x00040000 /* Little endian unsigned 24-bit */
192 #define AFMT_U24_BE 0x00080000 /* Big endian unsigned 24-bit */
193
194 #define AFMT_STEREO 0x10000000 /* can do/want stereo */
195
196 /*
197 * the following are really capabilities
198 */
199 #define AFMT_WEIRD 0x20000000 /* weird hardware... */
200 /*
201 * AFMT_WEIRD reports that the hardware might need to operate
202 * with different formats in the playback and capture
203 * channels when operating in full duplex.
204 * As an example, SoundBlaster16 cards only support U8 in one
205 * direction and S16 in the other one, and applications should
206 * be aware of this limitation.
207 */
208 #define AFMT_FULLDUPLEX 0x80000000 /* can do full duplex */
209
210 /*
211 * The following structure is used to get/set format and sampling rate.
212 * While it would be better to have things such as stereo, bits per
213 * sample, endiannes, etc split in different variables, it turns out
214 * that formats are not that many, and not all combinations are possible.
215 * So we followed the Voxware approach of associating one bit to each
216 * format.
217 */
218
219 typedef struct _snd_chan_param {
220 u_long play_rate; /* sampling rate */
221 u_long rec_rate; /* sampling rate */
222 u_long play_format; /* everything describing the format */
223 u_long rec_format; /* everything describing the format */
224 } snd_chan_param;
225 #define AIOGFMT _IOR('f', 12, snd_chan_param) /* get format */
226 #define AIOSFMT _IOWR('f', 12, snd_chan_param) /* sets format */
227
228 /*
229 * The following structure is used to get/set the mixer setting.
230 * Up to 32 mixers are supported, each one with up to 32 channels.
231 */
232 typedef struct _snd_mix_param {
233 u_char subdev; /* which output */
234 u_char line; /* which input */
235 u_char left,right; /* volumes, 0..255, 0 = mute */
236 } snd_mix_param ;
237
238 /* XXX AIOGMIX, AIOSMIX not implemented yet */
239 #define AIOGMIX _IOWR('A', 13, snd_mix_param) /* return mixer status */
240 #define AIOSMIX _IOWR('A', 14, snd_mix_param) /* sets mixer status */
241
242 /*
243 * channel specifiers used in AIOSTOP and AIOSYNC
244 */
245 #define AIOSYNC_PLAY 0x1 /* play chan */
246 #define AIOSYNC_CAPTURE 0x2 /* capture chan */
247 /* AIOSTOP stop & flush a channel, returns the residual count */
248 #define AIOSTOP _IOWR ('A', 15, int)
249
250 /* alternate method used to notify the sync condition */
251 #define AIOSYNC_SIGNAL 0x100
252 #define AIOSYNC_SELECT 0x200
253
254 /* what the 'pos' field refers to */
255 #define AIOSYNC_READY 0x400
256 #define AIOSYNC_FREE 0x800
257
258 typedef struct _snd_sync_parm {
259 long chan ; /* play or capture channel, plus modifier */
260 long pos;
261 } snd_sync_parm;
262 #define AIOSYNC _IOWR ('A', 15, snd_sync_parm) /* misc. synchronization */
263
264 /*
265 * The following is used to return device capabilities. If the structure
266 * passed to the ioctl is zeroed, default values are returned for rate
267 * and formats, a bitmap of available mixers is returned, and values
268 * (inputs, different levels) for the first one are returned.
269 *
270 * If formats, mixers, inputs are instantiated, then detailed info
271 * are returned depending on the call.
272 */
273 typedef struct _snd_capabilities {
274 u_long rate_min, rate_max; /* min-max sampling rate */
275 u_long formats;
276 u_long bufsize; /* DMA buffer size */
277 u_long mixers; /* bitmap of available mixers */
278 u_long inputs; /* bitmap of available inputs (per mixer) */
279 u_short left, right; /* how many levels are supported */
280 } snd_capabilities;
281 #define AIOGCAP _IOWR('A', 15, snd_capabilities) /* get capabilities */
282
283 /*
284 * here is the old (Voxware) ioctl interface
285 */
286
287 /*
288 * IOCTL Commands for /dev/sequencer
289 */
290
291 #define SNDCTL_SEQ_RESET _IO ('Q', 0)
292 #define SNDCTL_SEQ_SYNC _IO ('Q', 1)
293 #define SNDCTL_SYNTH_INFO _IOWR('Q', 2, struct synth_info)
294 #define SNDCTL_SEQ_CTRLRATE _IOWR('Q', 3, int) /* Set/get timer res.(hz) */
295 #define SNDCTL_SEQ_GETOUTCOUNT _IOR ('Q', 4, int)
296 #define SNDCTL_SEQ_GETINCOUNT _IOR ('Q', 5, int)
297 #define SNDCTL_SEQ_PERCMODE _IOW ('Q', 6, int)
298 #define SNDCTL_FM_LOAD_INSTR _IOW ('Q', 7, struct sbi_instrument) /* Valid for FM only */
299 #define SNDCTL_SEQ_TESTMIDI _IOW ('Q', 8, int)
300 #define SNDCTL_SEQ_RESETSAMPLES _IOW ('Q', 9, int)
301 #define SNDCTL_SEQ_NRSYNTHS _IOR ('Q',10, int)
302 #define SNDCTL_SEQ_NRMIDIS _IOR ('Q',11, int)
303 #define SNDCTL_MIDI_INFO _IOWR('Q',12, struct midi_info)
304 #define SNDCTL_SEQ_THRESHOLD _IOW ('Q',13, int)
305 #define SNDCTL_SEQ_TRESHOLD SNDCTL_SEQ_THRESHOLD /* there was once a typo */
306 #define SNDCTL_SYNTH_MEMAVL _IOWR('Q',14, int) /* in=dev#, out=memsize */
307 #define SNDCTL_FM_4OP_ENABLE _IOW ('Q',15, int) /* in=dev# */
308 #define SNDCTL_PMGR_ACCESS _IOWR('Q',16, struct patmgr_info)
309 #define SNDCTL_SEQ_PANIC _IO ('Q',17)
310 #define SNDCTL_SEQ_OUTOFBAND _IOW ('Q',18, struct seq_event_rec)
311 #define SNDCTL_SEQ_GETTIME _IOR ('Q',19, int)
312
313 struct seq_event_rec {
314 u_char arr[8];
315 };
316
317 #define SNDCTL_TMR_TIMEBASE _IOWR('T', 1, int)
318 #define SNDCTL_TMR_START _IO ('T', 2)
319 #define SNDCTL_TMR_STOP _IO ('T', 3)
320 #define SNDCTL_TMR_CONTINUE _IO ('T', 4)
321 #define SNDCTL_TMR_TEMPO _IOWR('T', 5, int)
322 #define SNDCTL_TMR_SOURCE _IOWR('T', 6, int)
323 # define TMR_INTERNAL 0x00000001
324 # define TMR_EXTERNAL 0x00000002
325 # define TMR_MODE_MIDI 0x00000010
326 # define TMR_MODE_FSK 0x00000020
327 # define TMR_MODE_CLS 0x00000040
328 # define TMR_MODE_SMPTE 0x00000080
329 #define SNDCTL_TMR_METRONOME _IOW ('T', 7, int)
330 #define SNDCTL_TMR_SELECT _IOW ('T', 8, int)
331
332 /*
333 * Endian aware patch key generation algorithm.
334 */
335
336 #if defined(_AIX) || defined(AIX)
337 # define _PATCHKEY(id) (0xfd00|id)
338 #else
339 # define _PATCHKEY(id) ((id<<8)|0xfd)
340 #endif
341
342 /*
343 * Sample loading mechanism for internal synthesizers (/dev/sequencer)
344 * The following patch_info structure has been designed to support
345 * Gravis UltraSound. It tries to be universal format for uploading
346 * sample based patches but is probably too limited.
347 */
348
349 struct patch_info {
350 /* u_short key; Use GUS_PATCH here */
351 short key; /* Use GUS_PATCH here */
352 #define GUS_PATCH _PATCHKEY(0x04)
353 #define OBSOLETE_GUS_PATCH _PATCHKEY(0x02)
354
355 short device_no; /* Synthesizer number */
356 short instr_no; /* Midi pgm# */
357
358 u_long mode;
359 /*
360 * The least significant byte has the same format than the GUS .PAT
361 * files
362 */
363 #define WAVE_16_BITS 0x01 /* bit 0 = 8 or 16 bit wave data. */
364 #define WAVE_UNSIGNED 0x02 /* bit 1 = Signed - Unsigned data. */
365 #define WAVE_LOOPING 0x04 /* bit 2 = looping enabled-1. */
366 #define WAVE_BIDIR_LOOP 0x08 /* bit 3 = Set is bidirectional looping. */
367 #define WAVE_LOOP_BACK 0x10 /* bit 4 = Set is looping backward. */
368 #define WAVE_SUSTAIN_ON 0x20 /* bit 5 = Turn sustaining on. (Env. pts. 3)*/
369 #define WAVE_ENVELOPES 0x40 /* bit 6 = Enable envelopes - 1 */
370 /* (use the env_rate/env_offs fields). */
371 /* Linux specific bits */
372 #define WAVE_VIBRATO 0x00010000 /* The vibrato info is valid */
373 #define WAVE_TREMOLO 0x00020000 /* The tremolo info is valid */
374 #define WAVE_SCALE 0x00040000 /* The scaling info is valid */
375 /* Other bits must be zeroed */
376
377 long len; /* Size of the wave data in bytes */
378 long loop_start, loop_end; /* Byte offsets from the beginning */
379
380 /*
381 * The base_freq and base_note fields are used when computing the
382 * playback speed for a note. The base_note defines the tone frequency
383 * which is heard if the sample is played using the base_freq as the
384 * playback speed.
385 *
386 * The low_note and high_note fields define the minimum and maximum note
387 * frequencies for which this sample is valid. It is possible to define
388 * more than one samples for an instrument number at the same time. The
389 * low_note and high_note fields are used to select the most suitable one.
390 *
391 * The fields base_note, high_note and low_note should contain
392 * the note frequency multiplied by 1000. For example value for the
393 * middle A is 440*1000.
394 */
395
396 u_int base_freq;
397 u_long base_note;
398 u_long high_note;
399 u_long low_note;
400 int panning; /* -128=left, 127=right */
401 int detuning;
402
403 /* New fields introduced in version 1.99.5 */
404
405 /* Envelope. Enabled by mode bit WAVE_ENVELOPES */
406 u_char env_rate[ 6 ]; /* GUS HW ramping rate */
407 u_char env_offset[ 6 ]; /* 255 == 100% */
408
409 /*
410 * The tremolo, vibrato and scale info are not supported yet.
411 * Enable by setting the mode bits WAVE_TREMOLO, WAVE_VIBRATO or
412 * WAVE_SCALE
413 */
414
415 u_char tremolo_sweep;
416 u_char tremolo_rate;
417 u_char tremolo_depth;
418
419 u_char vibrato_sweep;
420 u_char vibrato_rate;
421 u_char vibrato_depth;
422
423 int scale_frequency;
424 u_int scale_factor; /* from 0 to 2048 or 0 to 2 */
425
426 int volume;
427 int spare[4];
428 char data[1]; /* The waveform data starts here */
429 };
430
431 struct sysex_info {
432 short key; /* Use GUS_PATCH here */
433 #define SYSEX_PATCH _PATCHKEY(0x05)
434 #define MAUI_PATCH _PATCHKEY(0x06)
435 short device_no; /* Synthesizer number */
436 long len; /* Size of the sysex data in bytes */
437 u_char data[1]; /* Sysex data starts here */
438 };
439
440 /*
441 * Patch management interface (/dev/sequencer, /dev/patmgr#)
442 * Don't use these calls if you want to maintain compatibility with
443 * the future versions of the driver.
444 */
445
446 #define PS_NO_PATCHES 0 /* No patch support on device */
447 #define PS_MGR_NOT_OK 1 /* Plain patch support (no mgr) */
448 #define PS_MGR_OK 2 /* Patch manager supported */
449 #define PS_MANAGED 3 /* Patch manager running */
450
451 #define SNDCTL_PMGR_IFACE _IOWR('P', 1, struct patmgr_info)
452
453 /*
454 * The patmgr_info is a fixed size structure which is used for two
455 * different purposes. The intended use is for communication between
456 * the application using /dev/sequencer and the patch manager daemon
457 * associated with a synthesizer device (ioctl(SNDCTL_PMGR_ACCESS)).
458 *
459 * This structure is also used with ioctl(SNDCTL_PGMR_IFACE) which allows
460 * a patch manager daemon to read and write device parameters. This
461 * ioctl available through /dev/sequencer also. Avoid using it since it's
462 * extremely hardware dependent. In addition access trough /dev/sequencer
463 * may confuse the patch manager daemon.
464 */
465
466 struct patmgr_info { /* Note! size must be < 4k since kmalloc() is used */
467 u_long key; /* Don't worry. Reserved for communication
468 between the patch manager and the driver. */
469 #define PM_K_EVENT 1 /* Event from the /dev/sequencer driver */
470 #define PM_K_COMMAND 2 /* Request from an application */
471 #define PM_K_RESPONSE 3 /* From patmgr to application */
472 #define PM_ERROR 4 /* Error returned by the patmgr */
473 int device;
474 int command;
475
476 /*
477 * Commands 0x000 to 0xfff reserved for patch manager programs
478 */
479 #define PM_GET_DEVTYPE 1 /* Returns type of the patch mgr interface of dev */
480 #define PMTYPE_FM2 1 /* 2 OP fm */
481 #define PMTYPE_FM4 2 /* Mixed 4 or 2 op FM (OPL-3) */
482 #define PMTYPE_WAVE 3 /* Wave table synthesizer (GUS) */
483 #define PM_GET_NRPGM 2 /* Returns max # of midi programs in parm1 */
484 #define PM_GET_PGMMAP 3 /* Returns map of loaded midi programs in data8 */
485 #define PM_GET_PGM_PATCHES 4 /* Return list of patches of a program (parm1) */
486 #define PM_GET_PATCH 5 /* Return patch header of patch parm1 */
487 #define PM_SET_PATCH 6 /* Set patch header of patch parm1 */
488 #define PM_READ_PATCH 7 /* Read patch (wave) data */
489 #define PM_WRITE_PATCH 8 /* Write patch (wave) data */
490
491 /*
492 * Commands 0x1000 to 0xffff are for communication between the patch manager
493 * and the client
494 */
495 #define _PM_LOAD_PATCH 0x100
496
497 /*
498 * Commands above 0xffff reserved for device specific use
499 */
500
501 long parm1;
502 long parm2;
503 long parm3;
504
505 union {
506 u_char data8[4000];
507 u_short data16[2000];
508 u_long data32[1000];
509 struct patch_info patch;
510 } data;
511 };
512
513 /*
514 * When a patch manager daemon is present, it will be informed by the
515 * driver when something important happens. For example when the
516 * /dev/sequencer is opened or closed. A record with key == PM_K_EVENT is
517 * returned. The command field contains the event type:
518 */
519 #define PM_E_OPENED 1 /* /dev/sequencer opened */
520 #define PM_E_CLOSED 2 /* /dev/sequencer closed */
521 #define PM_E_PATCH_RESET 3 /* SNDCTL_RESETSAMPLES called */
522 #define PM_E_PATCH_LOADED 4 /* A patch has been loaded by appl */
523
524 /*
525 * /dev/sequencer input events.
526 *
527 * The data written to the /dev/sequencer is a stream of events. Events
528 * are records of 4 or 8 bytes. The first byte defines the size.
529 * Any number of events can be written with a write call. There
530 * is a set of macros for sending these events. Use these macros if you
531 * want to maximize portability of your program.
532 *
533 * Events SEQ_WAIT, SEQ_MIDIPUTC and SEQ_ECHO. Are also input events.
534 * (All input events are currently 4 bytes long. Be prepared to support
535 * 8 byte events also. If you receive any event having first byte >= 128,
536 * it's a 8 byte event.
537 *
538 * The events are documented at the end of this file.
539 *
540 * Normal events (4 bytes)
541 * There is also a 8 byte version of most of the 4 byte events. The
542 * 8 byte one is recommended.
543 */
544 #define SEQ_NOTEOFF 0
545 #define SEQ_FMNOTEOFF SEQ_NOTEOFF /* Just old name */
546 #define SEQ_NOTEON 1
547 #define SEQ_FMNOTEON SEQ_NOTEON
548 #define SEQ_WAIT TMR_WAIT_ABS
549 #define SEQ_PGMCHANGE 3
550 #define SEQ_FMPGMCHANGE SEQ_PGMCHANGE
551 #define SEQ_SYNCTIMER TMR_START
552 #define SEQ_MIDIPUTC 5
553 #define SEQ_DRUMON 6 /*** OBSOLETE ***/
554 #define SEQ_DRUMOFF 7 /*** OBSOLETE ***/
555 #define SEQ_ECHO TMR_ECHO /* For synching programs with output */
556 #define SEQ_AFTERTOUCH 9
557 #define SEQ_CONTROLLER 10
558
559 /*
560 * Midi controller numbers
561 *
562 * Controllers 0 to 31 (0x00 to 0x1f) and 32 to 63 (0x20 to 0x3f)
563 * are continuous controllers.
564 * In the MIDI 1.0 these controllers are sent using two messages.
565 * Controller numbers 0 to 31 are used to send the MSB and the
566 * controller numbers 32 to 63 are for the LSB. Note that just 7 bits
567 * are used in MIDI bytes.
568 */
569
570 #define CTL_BANK_SELECT 0x00
571 #define CTL_MODWHEEL 0x01
572 #define CTL_BREATH 0x02
573 /* undefined 0x03 */
574 #define CTL_FOOT 0x04
575 #define CTL_PORTAMENTO_TIME 0x05
576 #define CTL_DATA_ENTRY 0x06
577 #define CTL_MAIN_VOLUME 0x07
578 #define CTL_BALANCE 0x08
579 /* undefined 0x09 */
580 #define CTL_PAN 0x0a
581 #define CTL_EXPRESSION 0x0b
582 /* undefined 0x0c - 0x0f */
583 #define CTL_GENERAL_PURPOSE1 0x10
584 #define CTL_GENERAL_PURPOSE2 0x11
585 #define CTL_GENERAL_PURPOSE3 0x12
586 #define CTL_GENERAL_PURPOSE4 0x13
587 /* undefined 0x14 - 0x1f */
588
589 /* undefined 0x20 */
590
591 /*
592 * The controller numbers 0x21 to 0x3f are reserved for the
593 * least significant bytes of the controllers 0x00 to 0x1f.
594 * These controllers are not recognised by the driver.
595 *
596 * Controllers 64 to 69 (0x40 to 0x45) are on/off switches.
597 * 0=OFF and 127=ON (intermediate values are possible)
598 */
599 #define CTL_DAMPER_PEDAL 0x40
600 #define CTL_SUSTAIN CTL_DAMPER_PEDAL /* Alias */
601 #define CTL_HOLD CTL_DAMPER_PEDAL /* Alias */
602 #define CTL_PORTAMENTO 0x41
603 #define CTL_SOSTENUTO 0x42
604 #define CTL_SOFT_PEDAL 0x43
605 /* undefined 0x44 */
606 #define CTL_HOLD2 0x45
607 /* undefined 0x46 - 0x4f */
608
609 #define CTL_GENERAL_PURPOSE5 0x50
610 #define CTL_GENERAL_PURPOSE6 0x51
611 #define CTL_GENERAL_PURPOSE7 0x52
612 #define CTL_GENERAL_PURPOSE8 0x53
613 /* undefined 0x54 - 0x5a */
614 #define CTL_EXT_EFF_DEPTH 0x5b
615 #define CTL_TREMOLO_DEPTH 0x5c
616 #define CTL_CHORUS_DEPTH 0x5d
617 #define CTL_DETUNE_DEPTH 0x5e
618 #define CTL_CELESTE_DEPTH CTL_DETUNE_DEPTH /* Alias for the above one */
619 #define CTL_PHASER_DEPTH 0x5f
620 #define CTL_DATA_INCREMENT 0x60
621 #define CTL_DATA_DECREMENT 0x61
622 #define CTL_NONREG_PARM_NUM_LSB 0x62
623 #define CTL_NONREG_PARM_NUM_MSB 0x63
624 #define CTL_REGIST_PARM_NUM_LSB 0x64
625 #define CTL_REGIST_PARM_NUM_MSB 0x65
626 /* undefined 0x66 - 0x78 */
627 /* reserved 0x79 - 0x7f */
628
629 /* Pseudo controllers (not midi compatible) */
630 #define CTRL_PITCH_BENDER 255
631 #define CTRL_PITCH_BENDER_RANGE 254
632 #define CTRL_EXPRESSION 253 /* Obsolete */
633 #define CTRL_MAIN_VOLUME 252 /* Obsolete */
634
635 #define SEQ_BALANCE 11
636 #define SEQ_VOLMODE 12
637
638 /*
639 * Volume mode decides how volumes are used
640 */
641
642 #define VOL_METHOD_ADAGIO 1
643 #define VOL_METHOD_LINEAR 2
644
645 /*
646 * Note! SEQ_WAIT, SEQ_MIDIPUTC and SEQ_ECHO are used also as
647 * input events.
648 */
649
650 /*
651 * Event codes 0xf0 to 0xfc are reserved for future extensions.
652 */
653
654 #define SEQ_FULLSIZE 0xfd /* Long events */
655 /*
656 * SEQ_FULLSIZE events are used for loading patches/samples to the
657 * synthesizer devices. These events are passed directly to the driver
658 * of the associated synthesizer device. There is no limit to the size
659 * of the extended events. These events are not queued but executed
660 * immediately when the write() is called (execution can take several
661 * seconds of time).
662 *
663 * When a SEQ_FULLSIZE message is written to the device, it must
664 * be written using exactly one write() call. Other events cannot
665 * be mixed to the same write.
666 *
667 * For FM synths (YM3812/OPL3) use struct sbi_instrument and write
668 * it to the /dev/sequencer. Don't write other data together with
669 * the instrument structure Set the key field of the structure to
670 * FM_PATCH. The device field is used to route the patch to the
671 * corresponding device.
672 *
673 * For Gravis UltraSound use struct patch_info. Initialize the key field
674 * to GUS_PATCH.
675 */
676 #define SEQ_PRIVATE 0xfe /* Low level HW dependent events (8 bytes) */
677 #define SEQ_EXTENDED 0xff /* Extended events (8 bytes) OBSOLETE */
678
679 /*
680 * Record for FM patches
681 */
682
683 typedef u_char sbi_instr_data[32];
684
685 struct sbi_instrument {
686 u_short key; /* FM_PATCH or OPL3_PATCH */
687 #define FM_PATCH _PATCHKEY(0x01)
688 #define OPL3_PATCH _PATCHKEY(0x03)
689 short device; /* Synth# (0-4) */
690 int channel; /* Program# to be initialized */
691 sbi_instr_data operators; /* Reg. settings for operator cells
692 * (.SBI format) */
693 };
694
695 struct synth_info { /* Read only */
696 char name[30];
697 int device; /* 0-N. INITIALIZE BEFORE CALLING */
698 int synth_type;
699 #define SYNTH_TYPE_FM 0
700 #define SYNTH_TYPE_SAMPLE 1
701 #define SYNTH_TYPE_MIDI 2 /* Midi interface */
702
703 int synth_subtype;
704 #define FM_TYPE_ADLIB 0x00
705 #define FM_TYPE_OPL3 0x01
706 #define MIDI_TYPE_MPU401 0x401
707
708 #define SAMPLE_TYPE_BASIC 0x10
709 #define SAMPLE_TYPE_GUS SAMPLE_TYPE_BASIC
710 #define SAMPLE_TYPE_AWE32 0x20
711
712 int perc_mode; /* No longer supported */
713 int nr_voices;
714 int nr_drums; /* Obsolete field */
715 int instr_bank_size;
716 u_long capabilities;
717 #define SYNTH_CAP_PERCMODE 0x00000001 /* No longer used */
718 #define SYNTH_CAP_OPL3 0x00000002 /* Set if OPL3 supported */
719 #define SYNTH_CAP_INPUT 0x00000004 /* Input (MIDI) device */
720 int dummies[19]; /* Reserve space */
721 };
722
723 struct sound_timer_info {
724 char name[32];
725 int caps;
726 };
727
728 struct midi_info {
729 char name[30];
730 int device; /* 0-N. INITIALIZE BEFORE CALLING */
731 u_long capabilities; /* To be defined later */
732 int dev_type;
733 int dummies[18]; /* Reserve space */
734 };
735
736 /*
737 * ioctl commands for the /dev/midi##
738 */
739 typedef struct {
740 u_char cmd;
741 char nr_args, nr_returns;
742 u_char data[30];
743 } mpu_command_rec;
744
745 #define SNDCTL_MIDI_PRETIME _IOWR('m', 0, int)
746 #define SNDCTL_MIDI_MPUMODE _IOWR('m', 1, int)
747 #define SNDCTL_MIDI_MPUCMD _IOWR('m', 2, mpu_command_rec)
748 #define MIOSPASSTHRU _IOWR('m', 3, int)
749 #define MIOGPASSTHRU _IOWR('m', 4, int)
750
751 /*
752 * IOCTL commands for /dev/dsp and /dev/audio
753 */
754
755 #define SNDCTL_DSP_HALT _IO ('P', 0)
756 #define SNDCTL_DSP_RESET SNDCTL_DSP_HALT
757 #define SNDCTL_DSP_SYNC _IO ('P', 1)
758 #define SNDCTL_DSP_SPEED _IOWR('P', 2, int)
759 #define SNDCTL_DSP_STEREO _IOWR('P', 3, int)
760 #define SNDCTL_DSP_GETBLKSIZE _IOR('P', 4, int)
761 #define SNDCTL_DSP_SETBLKSIZE _IOW('P', 4, int)
762 #define SNDCTL_DSP_SETFMT _IOWR('P',5, int) /* Selects ONE fmt*/
763
764 /*
765 * SOUND_PCM_WRITE_CHANNELS is not that different
766 * from SNDCTL_DSP_STEREO
767 */
768 #define SOUND_PCM_WRITE_CHANNELS _IOWR('P', 6, int)
769 #define SNDCTL_DSP_CHANNELS SOUND_PCM_WRITE_CHANNELS
770 #define SOUND_PCM_WRITE_FILTER _IOWR('P', 7, int)
771 #define SNDCTL_DSP_POST _IO ('P', 8)
772
773 /*
774 * SNDCTL_DSP_SETBLKSIZE and the following two calls mostly do
775 * the same thing, i.e. set the block size used in DMA transfers.
776 */
777 #define SNDCTL_DSP_SUBDIVIDE _IOWR('P', 9, int)
778 #define SNDCTL_DSP_SETFRAGMENT _IOWR('P',10, int)
779
780
781 #define SNDCTL_DSP_GETFMTS _IOR ('P',11, int) /* Returns a mask */
782 /*
783 * Buffer status queries.
784 */
785 typedef struct audio_buf_info {
786 int fragments; /* # of avail. frags (partly used ones not counted) */
787 int fragstotal; /* Total # of fragments allocated */
788 int fragsize; /* Size of a fragment in bytes */
789
790 int bytes; /* Avail. space in bytes (includes partly used fragments) */
791 /* Note! 'bytes' could be more than fragments*fragsize */
792 } audio_buf_info;
793
794 #define SNDCTL_DSP_GETOSPACE _IOR ('P',12, audio_buf_info)
795 #define SNDCTL_DSP_GETISPACE _IOR ('P',13, audio_buf_info)
796
797 /*
798 * SNDCTL_DSP_NONBLOCK is the same (but less powerful, since the
799 * action cannot be undone) of FIONBIO. The same can be achieved
800 * by opening the device with O_NDELAY
801 */
802 #define SNDCTL_DSP_NONBLOCK _IO ('P',14)
803
804 #define SNDCTL_DSP_GETCAPS _IOR ('P',15, int)
805 #define DSP_CAP_REVISION 0x000000ff /* revision level (0 to 255) */
806 #define DSP_CAP_DUPLEX 0x00000100 /* Full duplex record/playback */
807 #define DSP_CAP_REALTIME 0x00000200 /* Real time capability */
808 #define DSP_CAP_BATCH 0x00000400
809 /*
810 * Device has some kind of internal buffers which may
811 * cause some delays and decrease precision of timing
812 */
813 #define DSP_CAP_COPROC 0x00000800
814 /* Has a coprocessor, sometimes it's a DSP but usually not */
815 #define DSP_CAP_TRIGGER 0x00001000 /* Supports SETTRIGGER */
816 #define DSP_CAP_MMAP 0x00002000 /* Supports mmap() */
817
818 /*
819 * What do these function do ?
820 */
821 #define SNDCTL_DSP_GETTRIGGER _IOR ('P',16, int)
822 #define SNDCTL_DSP_SETTRIGGER _IOW ('P',16, int)
823 #define PCM_ENABLE_INPUT 0x00000001
824 #define PCM_ENABLE_OUTPUT 0x00000002
825
826 typedef struct count_info {
827 int bytes; /* Total # of bytes processed */
828 int blocks; /* # of fragment transitions since last time */
829 int ptr; /* Current DMA pointer value */
830 } count_info;
831
832 /*
833 * GETIPTR and GETISPACE are not that different... same for out.
834 */
835 #define SNDCTL_DSP_GETIPTR _IOR ('P',17, count_info)
836 #define SNDCTL_DSP_GETOPTR _IOR ('P',18, count_info)
837
838 typedef struct buffmem_desc {
839 caddr_t buffer;
840 int size;
841 } buffmem_desc;
842
843 #define SNDCTL_DSP_MAPINBUF _IOR ('P', 19, buffmem_desc)
844 #define SNDCTL_DSP_MAPOUTBUF _IOR ('P', 20, buffmem_desc)
845 #define SNDCTL_DSP_SETSYNCRO _IO ('P', 21)
846 #define SNDCTL_DSP_SETDUPLEX _IO ('P', 22)
847 #define SNDCTL_DSP_GETODELAY _IOR ('P', 23, int)
848
849 /*
850 * I guess these are the readonly version of the same
851 * functions that exist above as SNDCTL_DSP_...
852 */
853 #define SOUND_PCM_READ_RATE _IOR ('P', 2, int)
854 #define SOUND_PCM_READ_CHANNELS _IOR ('P', 6, int)
855 #define SOUND_PCM_READ_BITS _IOR ('P', 5, int)
856 #define SOUND_PCM_READ_FILTER _IOR ('P', 7, int)
857
858 /*
859 * ioctl calls to be used in communication with coprocessors and
860 * DSP chips.
861 */
862
863 typedef struct copr_buffer {
864 int command; /* Set to 0 if not used */
865 int flags;
866 #define CPF_NONE 0x0000
867 #define CPF_FIRST 0x0001 /* First block */
868 #define CPF_LAST 0x0002 /* Last block */
869 int len;
870 int offs; /* If required by the device (0 if not used) */
871
872 u_char data[4000]; /* NOTE! 4000 is not 4k */
873 } copr_buffer;
874
875 typedef struct copr_debug_buf {
876 int command; /* Used internally. Set to 0 */
877 int parm1;
878 int parm2;
879 int flags;
880 int len; /* Length of data in bytes */
881 } copr_debug_buf;
882
883 typedef struct copr_msg {
884 int len;
885 u_char data[4000];
886 } copr_msg;
887
888 #define SNDCTL_COPR_RESET _IO ('C', 0)
889 #define SNDCTL_COPR_LOAD _IOWR('C', 1, copr_buffer)
890 #define SNDCTL_COPR_RDATA _IOWR('C', 2, copr_debug_buf)
891 #define SNDCTL_COPR_RCODE _IOWR('C', 3, copr_debug_buf)
892 #define SNDCTL_COPR_WDATA _IOW ('C', 4, copr_debug_buf)
893 #define SNDCTL_COPR_WCODE _IOW ('C', 5, copr_debug_buf)
894 #define SNDCTL_COPR_RUN _IOWR('C', 6, copr_debug_buf)
895 #define SNDCTL_COPR_HALT _IOWR('C', 7, copr_debug_buf)
896 #define SNDCTL_COPR_SENDMSG _IOW ('C', 8, copr_msg)
897 #define SNDCTL_COPR_RCVMSG _IOR ('C', 9, copr_msg)
898
899 /*
900 * IOCTL commands for /dev/mixer
901 */
902
903 /*
904 * Mixer devices
905 *
906 * There can be up to 20 different analog mixer channels. The
907 * SOUND_MIXER_NRDEVICES gives the currently supported maximum.
908 * The SOUND_MIXER_READ_DEVMASK returns a bitmask which tells
909 * the devices supported by the particular mixer.
910 */
911
912 #define SOUND_MIXER_NRDEVICES 25
913 #define SOUND_MIXER_VOLUME 0 /* Master output level */
914 #define SOUND_MIXER_BASS 1 /* Treble level of all output channels */
915 #define SOUND_MIXER_TREBLE 2 /* Bass level of all output channels */
916 #define SOUND_MIXER_SYNTH 3 /* Volume of synthesier input */
917 #define SOUND_MIXER_PCM 4 /* Output level for the audio device */
918 #define SOUND_MIXER_SPEAKER 5 /* Output level for the PC speaker
919 * signals */
920 #define SOUND_MIXER_LINE 6 /* Volume level for the line in jack */
921 #define SOUND_MIXER_MIC 7 /* Volume for the signal coming from
922 * the microphone jack */
923 #define SOUND_MIXER_CD 8 /* Volume level for the input signal
924 * connected to the CD audio input */
925 #define SOUND_MIXER_IMIX 9 /* Recording monitor. It controls the
926 * output volume of the selected
927 * recording sources while recording */
928 #define SOUND_MIXER_ALTPCM 10 /* Volume of the alternative codec
929 * device */
930 #define SOUND_MIXER_RECLEV 11 /* Global recording level */
931 #define SOUND_MIXER_IGAIN 12 /* Input gain */
932 #define SOUND_MIXER_OGAIN 13 /* Output gain */
933 /*
934 * The AD1848 codec and compatibles have three line level inputs
935 * (line, aux1 and aux2). Since each card manufacturer have assigned
936 * different meanings to these inputs, it's inpractical to assign
937 * specific meanings (line, cd, synth etc.) to them.
938 */
939 #define SOUND_MIXER_LINE1 14 /* Input source 1 (aux1) */
940 #define SOUND_MIXER_LINE2 15 /* Input source 2 (aux2) */
941 #define SOUND_MIXER_LINE3 16 /* Input source 3 (line) */
942 #define SOUND_MIXER_DIGITAL1 17 /* Digital (input) 1 */
943 #define SOUND_MIXER_DIGITAL2 18 /* Digital (input) 2 */
944 #define SOUND_MIXER_DIGITAL3 19 /* Digital (input) 3 */
945 #define SOUND_MIXER_PHONEIN 20 /* Phone input */
946 #define SOUND_MIXER_PHONEOUT 21 /* Phone output */
947 #define SOUND_MIXER_VIDEO 22 /* Video/TV (audio) in */
948 #define SOUND_MIXER_RADIO 23 /* Radio in */
949 #define SOUND_MIXER_MONITOR 24 /* Monitor (usually mic) volume */
950
951
952 /*
953 * Some on/off settings (SOUND_SPECIAL_MIN - SOUND_SPECIAL_MAX)
954 * Not counted to SOUND_MIXER_NRDEVICES, but use the same number space
955 */
956 #define SOUND_ONOFF_MIN 28
957 #define SOUND_ONOFF_MAX 30
958 #define SOUND_MIXER_MUTE 28 /* 0 or 1 */
959 #define SOUND_MIXER_ENHANCE 29 /* Enhanced stereo (0, 40, 60 or 80) */
960 #define SOUND_MIXER_LOUD 30 /* 0 or 1 */
961
962 /* Note! Number 31 cannot be used since the sign bit is reserved */
963 #define SOUND_MIXER_NONE 31
964
965 #define SOUND_DEVICE_LABELS { \
966 "Vol ", "Bass ", "Trebl", "Synth", "Pcm ", "Spkr ", "Line ", \
967 "Mic ", "CD ", "Mix ", "Pcm2 ", "Rec ", "IGain", "OGain", \
968 "Line1", "Line2", "Line3", "Digital1", "Digital2", "Digital3", \
969 "PhoneIn", "PhoneOut", "Video", "Radio", "Monitor"}
970
971 #define SOUND_DEVICE_NAMES { \
972 "vol", "bass", "treble", "synth", "pcm", "speaker", "line", \
973 "mic", "cd", "mix", "pcm2", "rec", "igain", "ogain", \
974 "line1", "line2", "line3", "dig1", "dig2", "dig3", \
975 "phin", "phout", "video", "radio", "monitor"}
976
977 /* Device bitmask identifiers */
978
979 #define SOUND_MIXER_RECSRC 0xff /* 1 bit per recording source */
980 #define SOUND_MIXER_DEVMASK 0xfe /* 1 bit per supported device */
981 #define SOUND_MIXER_RECMASK 0xfd /* 1 bit per supp. recording source */
982 #define SOUND_MIXER_CAPS 0xfc
983 #define SOUND_CAP_EXCL_INPUT 0x00000001 /* Only 1 rec. src at a time */
984 #define SOUND_MIXER_STEREODEVS 0xfb /* Mixer channels supporting stereo */
985
986 /* Device mask bits */
987
988 #define SOUND_MASK_VOLUME (1 << SOUND_MIXER_VOLUME)
989 #define SOUND_MASK_BASS (1 << SOUND_MIXER_BASS)
990 #define SOUND_MASK_TREBLE (1 << SOUND_MIXER_TREBLE)
991 #define SOUND_MASK_SYNTH (1 << SOUND_MIXER_SYNTH)
992 #define SOUND_MASK_PCM (1 << SOUND_MIXER_PCM)
993 #define SOUND_MASK_SPEAKER (1 << SOUND_MIXER_SPEAKER)
994 #define SOUND_MASK_LINE (1 << SOUND_MIXER_LINE)
995 #define SOUND_MASK_MIC (1 << SOUND_MIXER_MIC)
996 #define SOUND_MASK_CD (1 << SOUND_MIXER_CD)
997 #define SOUND_MASK_IMIX (1 << SOUND_MIXER_IMIX)
998 #define SOUND_MASK_ALTPCM (1 << SOUND_MIXER_ALTPCM)
999 #define SOUND_MASK_RECLEV (1 << SOUND_MIXER_RECLEV)
1000 #define SOUND_MASK_IGAIN (1 << SOUND_MIXER_IGAIN)
1001 #define SOUND_MASK_OGAIN (1 << SOUND_MIXER_OGAIN)
1002 #define SOUND_MASK_LINE1 (1 << SOUND_MIXER_LINE1)
1003 #define SOUND_MASK_LINE2 (1 << SOUND_MIXER_LINE2)
1004 #define SOUND_MASK_LINE3 (1 << SOUND_MIXER_LINE3)
1005 #define SOUND_MASK_DIGITAL1 (1 << SOUND_MIXER_DIGITAL1)
1006 #define SOUND_MASK_DIGITAL2 (1 << SOUND_MIXER_DIGITAL2)
1007 #define SOUND_MASK_DIGITAL3 (1 << SOUND_MIXER_DIGITAL3)
1008 #define SOUND_MASK_PHONEIN (1 << SOUND_MIXER_PHONEIN)
1009 #define SOUND_MASK_PHONEOUT (1 << SOUND_MIXER_PHONEOUT)
1010 #define SOUND_MASK_RADIO (1 << SOUND_MIXER_RADIO)
1011 #define SOUND_MASK_VIDEO (1 << SOUND_MIXER_VIDEO)
1012 #define SOUND_MASK_MONITOR (1 << SOUND_MIXER_MONITOR)
1013
1014 /* Obsolete macros */
1015 #define SOUND_MASK_MUTE (1 << SOUND_MIXER_MUTE)
1016 #define SOUND_MASK_ENHANCE (1 << SOUND_MIXER_ENHANCE)
1017 #define SOUND_MASK_LOUD (1 << SOUND_MIXER_LOUD)
1018
1019 #define MIXER_READ(dev) _IOR('M', dev, int)
1020 #define SOUND_MIXER_READ_VOLUME MIXER_READ(SOUND_MIXER_VOLUME)
1021 #define SOUND_MIXER_READ_BASS MIXER_READ(SOUND_MIXER_BASS)
1022 #define SOUND_MIXER_READ_TREBLE MIXER_READ(SOUND_MIXER_TREBLE)
1023 #define SOUND_MIXER_READ_SYNTH MIXER_READ(SOUND_MIXER_SYNTH)
1024 #define SOUND_MIXER_READ_PCM MIXER_READ(SOUND_MIXER_PCM)
1025 #define SOUND_MIXER_READ_SPEAKER MIXER_READ(SOUND_MIXER_SPEAKER)
1026 #define SOUND_MIXER_READ_LINE MIXER_READ(SOUND_MIXER_LINE)
1027 #define SOUND_MIXER_READ_MIC MIXER_READ(SOUND_MIXER_MIC)
1028 #define SOUND_MIXER_READ_CD MIXER_READ(SOUND_MIXER_CD)
1029 #define SOUND_MIXER_READ_IMIX MIXER_READ(SOUND_MIXER_IMIX)
1030 #define SOUND_MIXER_READ_ALTPCM MIXER_READ(SOUND_MIXER_ALTPCM)
1031 #define SOUND_MIXER_READ_RECLEV MIXER_READ(SOUND_MIXER_RECLEV)
1032 #define SOUND_MIXER_READ_IGAIN MIXER_READ(SOUND_MIXER_IGAIN)
1033 #define SOUND_MIXER_READ_OGAIN MIXER_READ(SOUND_MIXER_OGAIN)
1034 #define SOUND_MIXER_READ_LINE1 MIXER_READ(SOUND_MIXER_LINE1)
1035 #define SOUND_MIXER_READ_LINE2 MIXER_READ(SOUND_MIXER_LINE2)
1036 #define SOUND_MIXER_READ_LINE3 MIXER_READ(SOUND_MIXER_LINE3)
1037 #define SOUND_MIXER_READ_DIGITAL1 MIXER_READ(SOUND_MIXER_DIGITAL1)
1038 #define SOUND_MIXER_READ_DIGITAL2 MIXER_READ(SOUND_MIXER_DIGITAL2)
1039 #define SOUND_MIXER_READ_DIGITAL3 MIXER_READ(SOUND_MIXER_DIGITAL3)
1040 #define SOUND_MIXER_READ_PHONEIN MIXER_READ(SOUND_MIXER_PHONEIN)
1041 #define SOUND_MIXER_READ_PHONEOUT MIXER_READ(SOUND_MIXER_PHONEOUT)
1042 #define SOUND_MIXER_READ_RADIO MIXER_READ(SOUND_MIXER_RADIO)
1043 #define SOUND_MIXER_READ_VIDEO MIXER_READ(SOUND_MIXER_VIDEO)
1044 #define SOUND_MIXER_READ_MONITOR MIXER_READ(SOUND_MIXER_MONITOR)
1045
1046 /* Obsolete macros */
1047 #define SOUND_MIXER_READ_MUTE MIXER_READ(SOUND_MIXER_MUTE)
1048 #define SOUND_MIXER_READ_ENHANCE MIXER_READ(SOUND_MIXER_ENHANCE)
1049 #define SOUND_MIXER_READ_LOUD MIXER_READ(SOUND_MIXER_LOUD)
1050
1051 #define SOUND_MIXER_READ_RECSRC MIXER_READ(SOUND_MIXER_RECSRC)
1052 #define SOUND_MIXER_READ_DEVMASK MIXER_READ(SOUND_MIXER_DEVMASK)
1053 #define SOUND_MIXER_READ_RECMASK MIXER_READ(SOUND_MIXER_RECMASK)
1054 #define SOUND_MIXER_READ_STEREODEVS MIXER_READ(SOUND_MIXER_STEREODEVS)
1055 #define SOUND_MIXER_READ_CAPS MIXER_READ(SOUND_MIXER_CAPS)
1056
1057 #define MIXER_WRITE(dev) _IOWR('M', dev, int)
1058 #define SOUND_MIXER_WRITE_VOLUME MIXER_WRITE(SOUND_MIXER_VOLUME)
1059 #define SOUND_MIXER_WRITE_BASS MIXER_WRITE(SOUND_MIXER_BASS)
1060 #define SOUND_MIXER_WRITE_TREBLE MIXER_WRITE(SOUND_MIXER_TREBLE)
1061 #define SOUND_MIXER_WRITE_SYNTH MIXER_WRITE(SOUND_MIXER_SYNTH)
1062 #define SOUND_MIXER_WRITE_PCM MIXER_WRITE(SOUND_MIXER_PCM)
1063 #define SOUND_MIXER_WRITE_SPEAKER MIXER_WRITE(SOUND_MIXER_SPEAKER)
1064 #define SOUND_MIXER_WRITE_LINE MIXER_WRITE(SOUND_MIXER_LINE)
1065 #define SOUND_MIXER_WRITE_MIC MIXER_WRITE(SOUND_MIXER_MIC)
1066 #define SOUND_MIXER_WRITE_CD MIXER_WRITE(SOUND_MIXER_CD)
1067 #define SOUND_MIXER_WRITE_IMIX MIXER_WRITE(SOUND_MIXER_IMIX)
1068 #define SOUND_MIXER_WRITE_ALTPCM MIXER_WRITE(SOUND_MIXER_ALTPCM)
1069 #define SOUND_MIXER_WRITE_RECLEV MIXER_WRITE(SOUND_MIXER_RECLEV)
1070 #define SOUND_MIXER_WRITE_IGAIN MIXER_WRITE(SOUND_MIXER_IGAIN)
1071 #define SOUND_MIXER_WRITE_OGAIN MIXER_WRITE(SOUND_MIXER_OGAIN)
1072 #define SOUND_MIXER_WRITE_LINE1 MIXER_WRITE(SOUND_MIXER_LINE1)
1073 #define SOUND_MIXER_WRITE_LINE2 MIXER_WRITE(SOUND_MIXER_LINE2)
1074 #define SOUND_MIXER_WRITE_LINE3 MIXER_WRITE(SOUND_MIXER_LINE3)
1075 #define SOUND_MIXER_WRITE_DIGITAL1 MIXER_WRITE(SOUND_MIXER_DIGITAL1)
1076 #define SOUND_MIXER_WRITE_DIGITAL2 MIXER_WRITE(SOUND_MIXER_DIGITAL2)
1077 #define SOUND_MIXER_WRITE_DIGITAL3 MIXER_WRITE(SOUND_MIXER_DIGITAL3)
1078 #define SOUND_MIXER_WRITE_PHONEIN MIXER_WRITE(SOUND_MIXER_PHONEIN)
1079 #define SOUND_MIXER_WRITE_PHONEOUT MIXER_WRITE(SOUND_MIXER_PHONEOUT)
1080 #define SOUND_MIXER_WRITE_RADIO MIXER_WRITE(SOUND_MIXER_RADIO)
1081 #define SOUND_MIXER_WRITE_VIDEO MIXER_WRITE(SOUND_MIXER_VIDEO)
1082 #define SOUND_MIXER_WRITE_MONITOR MIXER_WRITE(SOUND_MIXER_MONITOR)
1083
1084 #define SOUND_MIXER_WRITE_MUTE MIXER_WRITE(SOUND_MIXER_MUTE)
1085 #define SOUND_MIXER_WRITE_ENHANCE MIXER_WRITE(SOUND_MIXER_ENHANCE)
1086 #define SOUND_MIXER_WRITE_LOUD MIXER_WRITE(SOUND_MIXER_LOUD)
1087
1088 #define SOUND_MIXER_WRITE_RECSRC MIXER_WRITE(SOUND_MIXER_RECSRC)
1089
1090 typedef struct mixer_info {
1091 char id[16];
1092 char name[32];
1093 int modify_counter;
1094 int fillers[10];
1095 } mixer_info;
1096
1097 #define SOUND_MIXER_INFO _IOR('M', 101, mixer_info)
1098
1099 #define LEFT_CHN 0
1100 #define RIGHT_CHN 1
1101
1102 /*
1103 * Level 2 event types for /dev/sequencer
1104 */
1105
1106 /*
1107 * The 4 most significant bits of byte 0 specify the class of
1108 * the event:
1109 *
1110 * 0x8X = system level events,
1111 * 0x9X = device/port specific events, event[1] = device/port,
1112 * The last 4 bits give the subtype:
1113 * 0x02 = Channel event (event[3] = chn).
1114 * 0x01 = note event (event[4] = note).
1115 * (0x01 is not used alone but always with bit 0x02).
1116 * event[2] = MIDI message code (0x80=note off etc.)
1117 *
1118 */
1119
1120 #define EV_SEQ_LOCAL 0x80
1121 #define EV_TIMING 0x81
1122 #define EV_CHN_COMMON 0x92
1123 #define EV_CHN_VOICE 0x93
1124 #define EV_SYSEX 0x94
1125 /*
1126 * Event types 200 to 220 are reserved for application use.
1127 * These numbers will not be used by the driver.
1128 */
1129
1130 /*
1131 * Events for event type EV_CHN_VOICE
1132 */
1133
1134 #define MIDI_NOTEOFF 0x80
1135 #define MIDI_NOTEON 0x90
1136 #define MIDI_KEY_PRESSURE 0xA0
1137
1138 /*
1139 * Events for event type EV_CHN_COMMON
1140 */
1141
1142 #define MIDI_CTL_CHANGE 0xB0
1143 #define MIDI_PGM_CHANGE 0xC0
1144 #define MIDI_CHN_PRESSURE 0xD0
1145 #define MIDI_PITCH_BEND 0xE0
1146
1147 #define MIDI_SYSTEM_PREFIX 0xF0
1148
1149 /*
1150 * Timer event types
1151 */
1152 #define TMR_WAIT_REL 1 /* Time relative to the prev time */
1153 #define TMR_WAIT_ABS 2 /* Absolute time since TMR_START */
1154 #define TMR_STOP 3
1155 #define TMR_START 4
1156 #define TMR_CONTINUE 5
1157 #define TMR_TEMPO 6
1158 #define TMR_ECHO 8
1159 #define TMR_CLOCK 9 /* MIDI clock */
1160 #define TMR_SPP 10 /* Song position pointer */
1161 #define TMR_TIMESIG 11 /* Time signature */
1162
1163 /*
1164 * Local event types
1165 */
1166 #define LOCL_STARTAUDIO 1
1167
1168 #if (!defined(_KERNEL) && !defined(INKERNEL)) || defined(USE_SEQ_MACROS)
1169 /*
1170 * Some convenience macros to simplify programming of the
1171 * /dev/sequencer interface
1172 *
1173 * These macros define the API which should be used when possible.
1174 */
1175
1176 #ifndef USE_SIMPLE_MACROS
1177 void seqbuf_dump(void); /* This function must be provided by programs */
1178
1179 /* Sample seqbuf_dump() implementation:
1180 *
1181 * SEQ_DEFINEBUF (2048); -- Defines a buffer for 2048 bytes
1182 *
1183 * int seqfd; -- The file descriptor for /dev/sequencer.
1184 *
1185 * void
1186 * seqbuf_dump ()
1187 * {
1188 * if (_seqbufptr)
1189 * if (write (seqfd, _seqbuf, _seqbufptr) == -1)
1190 * {
1191 * perror ("write /dev/sequencer");
1192 * exit (-1);
1193 * }
1194 * _seqbufptr = 0;
1195 * }
1196 */
1197
1198 #define SEQ_DEFINEBUF(len) \
1199 u_char _seqbuf[len]; int _seqbuflen = len;int _seqbufptr = 0
1200 #define SEQ_USE_EXTBUF() \
1201 extern u_char _seqbuf[]; \
1202 extern int _seqbuflen;extern int _seqbufptr
1203 #define SEQ_DECLAREBUF() SEQ_USE_EXTBUF()
1204 #define SEQ_PM_DEFINES struct patmgr_info _pm_info
1205 #define _SEQ_NEEDBUF(len) \
1206 if ((_seqbufptr+(len)) > _seqbuflen) \
1207 seqbuf_dump()
1208 #define _SEQ_ADVBUF(len) _seqbufptr += len
1209 #define SEQ_DUMPBUF seqbuf_dump
1210 #else
1211 /*
1212 * This variation of the sequencer macros is used just to format one event
1213 * using fixed buffer.
1214 *
1215 * The program using the macro library must define the following macros before
1216 * using this library.
1217 *
1218 * #define _seqbuf name of the buffer (u_char[])
1219 * #define _SEQ_ADVBUF(len) If the applic needs to know the exact
1220 * size of the event, this macro can be used.
1221 * Otherwise this must be defined as empty.
1222 * #define _seqbufptr Define the name of index variable or 0 if
1223 * not required.
1224 */
1225 #define _SEQ_NEEDBUF(len) /* empty */
1226 #endif
1227
1228 #define PM_LOAD_PATCH(dev, bank, pgm) \
1229 (SEQ_DUMPBUF(), _pm_info.command = _PM_LOAD_PATCH, \
1230 _pm_info.device=dev, _pm_info.data.data8[0]=pgm, \
1231 _pm_info.parm1 = bank, _pm_info.parm2 = 1, \
1232 ioctl(seqfd, SNDCTL_PMGR_ACCESS, &_pm_info))
1233 #define PM_LOAD_PATCHES(dev, bank, pgm) \
1234 (SEQ_DUMPBUF(), _pm_info.command = _PM_LOAD_PATCH, \
1235 _pm_info.device=dev, bcopy( pgm, _pm_info.data.data8, 128), \
1236 _pm_info.parm1 = bank, _pm_info.parm2 = 128, \
1237 ioctl(seqfd, SNDCTL_PMGR_ACCESS, &_pm_info))
1238
1239 #define SEQ_VOLUME_MODE(dev, mode) { \
1240 _SEQ_NEEDBUF(8);\
1241 _seqbuf[_seqbufptr] = SEQ_EXTENDED;\
1242 _seqbuf[_seqbufptr+1] = SEQ_VOLMODE;\
1243 _seqbuf[_seqbufptr+2] = (dev);\
1244 _seqbuf[_seqbufptr+3] = (mode);\
1245 _seqbuf[_seqbufptr+4] = 0;\
1246 _seqbuf[_seqbufptr+5] = 0;\
1247 _seqbuf[_seqbufptr+6] = 0;\
1248 _seqbuf[_seqbufptr+7] = 0;\
1249 _SEQ_ADVBUF(8);}
1250
1251 /*
1252 * Midi voice messages
1253 */
1254
1255 #define _CHN_VOICE(dev, event, chn, note, parm) { \
1256 _SEQ_NEEDBUF(8);\
1257 _seqbuf[_seqbufptr] = EV_CHN_VOICE;\
1258 _seqbuf[_seqbufptr+1] = (dev);\
1259 _seqbuf[_seqbufptr+2] = (event);\
1260 _seqbuf[_seqbufptr+3] = (chn);\
1261 _seqbuf[_seqbufptr+4] = (note);\
1262 _seqbuf[_seqbufptr+5] = (parm);\
1263 _seqbuf[_seqbufptr+6] = (0);\
1264 _seqbuf[_seqbufptr+7] = 0;\
1265 _SEQ_ADVBUF(8);}
1266
1267 #define SEQ_START_NOTE(dev, chn, note, vol) \
1268 _CHN_VOICE(dev, MIDI_NOTEON, chn, note, vol)
1269
1270 #define SEQ_STOP_NOTE(dev, chn, note, vol) \
1271 _CHN_VOICE(dev, MIDI_NOTEOFF, chn, note, vol)
1272
1273 #define SEQ_KEY_PRESSURE(dev, chn, note, pressure) \
1274 _CHN_VOICE(dev, MIDI_KEY_PRESSURE, chn, note, pressure)
1275
1276 /*
1277 * Midi channel messages
1278 */
1279
1280 #define _CHN_COMMON(dev, event, chn, p1, p2, w14) { \
1281 _SEQ_NEEDBUF(8);\
1282 _seqbuf[_seqbufptr] = EV_CHN_COMMON;\
1283 _seqbuf[_seqbufptr+1] = (dev);\
1284 _seqbuf[_seqbufptr+2] = (event);\
1285 _seqbuf[_seqbufptr+3] = (chn);\
1286 _seqbuf[_seqbufptr+4] = (p1);\
1287 _seqbuf[_seqbufptr+5] = (p2);\
1288 *(short *)&_seqbuf[_seqbufptr+6] = (w14);\
1289 _SEQ_ADVBUF(8);}
1290 /*
1291 * SEQ_SYSEX permits sending of sysex messages. (It may look that it permits
1292 * sending any MIDI bytes but it's absolutely not possible. Trying to do
1293 * so _will_ cause problems with MPU401 intelligent mode).
1294 *
1295 * Sysex messages are sent in blocks of 1 to 6 bytes. Longer messages must be
1296 * sent by calling SEQ_SYSEX() several times (there must be no other events
1297 * between them). First sysex fragment must have 0xf0 in the first byte
1298 * and the last byte (buf[len-1] of the last fragment must be 0xf7. No byte
1299 * between these sysex start and end markers cannot be larger than 0x7f. Also
1300 * lengths of each fragments (except the last one) must be 6.
1301 *
1302 * Breaking the above rules may work with some MIDI ports but is likely to
1303 * cause fatal problems with some other devices (such as MPU401).
1304 */
1305 #define SEQ_SYSEX(dev, buf, len) { \
1306 int i, l=(len); if (l>6)l=6;\
1307 _SEQ_NEEDBUF(8);\
1308 _seqbuf[_seqbufptr] = EV_SYSEX;\
1309 for(i=0;i<l;i++)_seqbuf[_seqbufptr+i+1] = (buf)[i];\
1310 for(i=l;i<6;i++)_seqbuf[_seqbufptr+i+1] = 0xff;\
1311 _SEQ_ADVBUF(8);}
1312
1313 #define SEQ_CHN_PRESSURE(dev, chn, pressure) \
1314 _CHN_COMMON(dev, MIDI_CHN_PRESSURE, chn, pressure, 0, 0)
1315
1316 #define SEQ_SET_PATCH(dev, chn, patch) \
1317 _CHN_COMMON(dev, MIDI_PGM_CHANGE, chn, patch, 0, 0)
1318
1319 #define SEQ_CONTROL(dev, chn, controller, value) \
1320 _CHN_COMMON(dev, MIDI_CTL_CHANGE, chn, controller, 0, value)
1321
1322 #define SEQ_BENDER(dev, chn, value) \
1323 _CHN_COMMON(dev, MIDI_PITCH_BEND, chn, 0, 0, value)
1324
1325
1326 #define SEQ_V2_X_CONTROL(dev, voice, controller, value) { \
1327 _SEQ_NEEDBUF(8);\
1328 _seqbuf[_seqbufptr] = SEQ_EXTENDED;\
1329 _seqbuf[_seqbufptr+1] = SEQ_CONTROLLER;\
1330 _seqbuf[_seqbufptr+2] = (dev);\
1331 _seqbuf[_seqbufptr+3] = (voice);\
1332 _seqbuf[_seqbufptr+4] = (controller);\
1333 *(short *)&_seqbuf[_seqbufptr+5] = (value);\
1334 _seqbuf[_seqbufptr+7] = 0;\
1335 _SEQ_ADVBUF(8);}
1336
1337 /*
1338 * The following 5 macros are incorrectly implemented and obsolete.
1339 * Use SEQ_BENDER and SEQ_CONTROL (with proper controller) instead.
1340 */
1341
1342 #define SEQ_PITCHBEND(dev, voice, value) \
1343 SEQ_V2_X_CONTROL(dev, voice, CTRL_PITCH_BENDER, value)
1344 #define SEQ_BENDER_RANGE(dev, voice, value) \
1345 SEQ_V2_X_CONTROL(dev, voice, CTRL_PITCH_BENDER_RANGE, value)
1346 #define SEQ_EXPRESSION(dev, voice, value) \
1347 SEQ_CONTROL(dev, voice, CTL_EXPRESSION, value*128)
1348 #define SEQ_MAIN_VOLUME(dev, voice, value) \
1349 SEQ_CONTROL(dev, voice, CTL_MAIN_VOLUME, (value*16383)/100)
1350 #define SEQ_PANNING(dev, voice, pos) \
1351 SEQ_CONTROL(dev, voice, CTL_PAN, (pos+128) / 2)
1352
1353 /*
1354 * Timing and syncronization macros
1355 */
1356
1357 #define _TIMER_EVENT(ev, parm) { \
1358 _SEQ_NEEDBUF(8);\
1359 _seqbuf[_seqbufptr+0] = EV_TIMING; \
1360 _seqbuf[_seqbufptr+1] = (ev); \
1361 _seqbuf[_seqbufptr+2] = 0;\
1362 _seqbuf[_seqbufptr+3] = 0;\
1363 *(u_int *)&_seqbuf[_seqbufptr+4] = (parm); \
1364 _SEQ_ADVBUF(8); \
1365 }
1366
1367 #define SEQ_START_TIMER() _TIMER_EVENT(TMR_START, 0)
1368 #define SEQ_STOP_TIMER() _TIMER_EVENT(TMR_STOP, 0)
1369 #define SEQ_CONTINUE_TIMER() _TIMER_EVENT(TMR_CONTINUE, 0)
1370 #define SEQ_WAIT_TIME(ticks) _TIMER_EVENT(TMR_WAIT_ABS, ticks)
1371 #define SEQ_DELTA_TIME(ticks) _TIMER_EVENT(TMR_WAIT_REL, ticks)
1372 #define SEQ_ECHO_BACK(key) _TIMER_EVENT(TMR_ECHO, key)
1373 #define SEQ_SET_TEMPO(value) _TIMER_EVENT(TMR_TEMPO, value)
1374 #define SEQ_SONGPOS(pos) _TIMER_EVENT(TMR_SPP, pos)
1375 #define SEQ_TIME_SIGNATURE(sig) _TIMER_EVENT(TMR_TIMESIG, sig)
1376
1377 /*
1378 * Local control events
1379 */
1380
1381 #define _LOCAL_EVENT(ev, parm) { \
1382 _SEQ_NEEDBUF(8);\
1383 _seqbuf[_seqbufptr+0] = EV_SEQ_LOCAL; \
1384 _seqbuf[_seqbufptr+1] = (ev); \
1385 _seqbuf[_seqbufptr+2] = 0;\
1386 _seqbuf[_seqbufptr+3] = 0;\
1387 *(u_int *)&_seqbuf[_seqbufptr+4] = (parm); \
1388 _SEQ_ADVBUF(8); \
1389 }
1390
1391 #define SEQ_PLAYAUDIO(devmask) _LOCAL_EVENT(LOCL_STARTAUDIO, devmask)
1392 /*
1393 * Events for the level 1 interface only
1394 */
1395
1396 #define SEQ_MIDIOUT(device, byte) { \
1397 _SEQ_NEEDBUF(4);\
1398 _seqbuf[_seqbufptr] = SEQ_MIDIPUTC;\
1399 _seqbuf[_seqbufptr+1] = (byte);\
1400 _seqbuf[_seqbufptr+2] = (device);\
1401 _seqbuf[_seqbufptr+3] = 0;\
1402 _SEQ_ADVBUF(4);}
1403
1404 /*
1405 * Patch loading.
1406 */
1407 #define SEQ_WRPATCH(patchx, len) { \
1408 if (_seqbufptr) seqbuf_dump(); \
1409 if (write(seqfd, (char*)(patchx), len)==-1) \
1410 perror("Write patch: /dev/sequencer"); \
1411 }
1412
1413 #define SEQ_WRPATCH2(patchx, len) \
1414 ( seqbuf_dump(), write(seqfd, (char*)(patchx), len) )
1415
1416 #endif
1417
1418 /*
1419 * Here I have moved all the aliases for ioctl names.
1420 */
1421
1422 #define SNDCTL_DSP_SAMPLESIZE SNDCTL_DSP_SETFMT
1423 #define SOUND_PCM_WRITE_BITS SNDCTL_DSP_SETFMT
1424 #define SOUND_PCM_SETFMT SNDCTL_DSP_SETFMT
1425
1426 #define SOUND_PCM_WRITE_RATE SNDCTL_DSP_SPEED
1427 #define SOUND_PCM_POST SNDCTL_DSP_POST
1428 #define SOUND_PCM_RESET SNDCTL_DSP_RESET
1429 #define SOUND_PCM_SYNC SNDCTL_DSP_SYNC
1430 #define SOUND_PCM_SUBDIVIDE SNDCTL_DSP_SUBDIVIDE
1431 #define SOUND_PCM_SETFRAGMENT SNDCTL_DSP_SETFRAGMENT
1432 #define SOUND_PCM_GETFMTS SNDCTL_DSP_GETFMTS
1433 #define SOUND_PCM_GETOSPACE SNDCTL_DSP_GETOSPACE
1434 #define SOUND_PCM_GETISPACE SNDCTL_DSP_GETISPACE
1435 #define SOUND_PCM_NONBLOCK SNDCTL_DSP_NONBLOCK
1436 #define SOUND_PCM_GETCAPS SNDCTL_DSP_GETCAPS
1437 #define SOUND_PCM_GETTRIGGER SNDCTL_DSP_GETTRIGGER
1438 #define SOUND_PCM_SETTRIGGER SNDCTL_DSP_SETTRIGGER
1439 #define SOUND_PCM_SETSYNCRO SNDCTL_DSP_SETSYNCRO
1440 #define SOUND_PCM_GETIPTR SNDCTL_DSP_GETIPTR
1441 #define SOUND_PCM_GETOPTR SNDCTL_DSP_GETOPTR
1442 #define SOUND_PCM_MAPINBUF SNDCTL_DSP_MAPINBUF
1443 #define SOUND_PCM_MAPOUTBUF SNDCTL_DSP_MAPOUTBUF
1444
1445 /***********************************************************************/
1446
1447 /**
1448 * XXX OSSv4 defines -- some bits taken straight out of the new
1449 * sys/soundcard.h bundled with recent OSS releases.
1450 *
1451 * NB: These macros and structures will be reorganized and inserted
1452 * in appropriate places throughout this file once the code begins
1453 * to take shape.
1454 *
1455 * @todo reorganize layout more like the 4Front version
1456 * @todo ask about maintaining __SIOWR vs. _IOWR ioctl cmd defines
1457 */
1458
1459 /**
1460 * @note The @c OSSV4_EXPERIMENT macro is meant to wrap new development code
1461 * in the sound system relevant to adopting 4Front's OSSv4 specification.
1462 * Users should not enable this! Really!
1463 */
1464 #if 0
1465 # define OSSV4_EXPERIMENT 1
1466 #else
1467 # undef OSSV4_EXPERIMENT
1468 #endif
1469
1470 #ifdef SOUND_VERSION
1471 # undef SOUND_VERSION
1472 # define SOUND_VERSION 0x040000
1473 #endif /* !SOUND_VERSION */
1474
1475 #define OSS_LONGNAME_SIZE 64
1476 #define OSS_LABEL_SIZE 16
1477 #define OSS_DEVNODE_SIZE 32
1478 typedef char oss_longname_t[OSS_LONGNAME_SIZE];
1479 typedef char oss_label_t[OSS_LABEL_SIZE];
1480 typedef char oss_devnode_t[OSS_DEVNODE_SIZE];
1481
1482 typedef struct audio_errinfo
1483 {
1484 int play_underruns;
1485 int rec_overruns;
1486 unsigned int play_ptradjust;
1487 unsigned int rec_ptradjust;
1488 int play_errorcount;
1489 int rec_errorcount;
1490 int play_lasterror;
1491 int rec_lasterror;
1492 long play_errorparm;
1493 long rec_errorparm;
1494 int filler[16];
1495 } audio_errinfo;
1496
1497 #define SNDCTL_DSP_GETPLAYVOL _IOR ('P', 24, int)
1498 #define SNDCTL_DSP_SETPLAYVOL _IOWR('P', 24, int)
1499 #define SNDCTL_DSP_GETERROR _IOR ('P', 25, audio_errinfo)
1500
1501
1502 /*
1503 ****************************************************************************
1504 * Sync groups for audio devices
1505 */
1506 typedef struct oss_syncgroup
1507 {
1508 int id;
1509 int mode;
1510 int filler[16];
1511 } oss_syncgroup;
1512
1513 #define SNDCTL_DSP_SYNCGROUP _IOWR('P', 28, oss_syncgroup)
1514 #define SNDCTL_DSP_SYNCSTART _IOW ('P', 29, int)
1515
1516 /*
1517 **************************************************************************
1518 * "cooked" mode enables software based conversions for sample rate, sample
1519 * format (bits) and number of channels (mono/stereo). These conversions are
1520 * required with some devices that support only one sample rate or just stereo
1521 * to let the applications to use other formats. The cooked mode is enabled by
1522 * default. However it's necessary to disable this mode when mmap() is used or
1523 * when very deterministic timing is required. SNDCTL_DSP_COOKEDMODE is an
1524 * optional call introduced in OSS 3.9.6f. It's _error return must be ignored_
1525 * since normally this call will return erno=EINVAL.
1526 *
1527 * SNDCTL_DSP_COOKEDMODE must be called immediately after open before doing
1528 * anything else. Otherwise the call will not have any effect.
1529 */
1530 #define SNDCTL_DSP_COOKEDMODE _IOW ('P', 30, int)
1531
1532 /*
1533 **************************************************************************
1534 * SNDCTL_DSP_SILENCE and SNDCTL_DSP_SKIP are new calls in OSS 3.99.0
1535 * that can be used to implement pause/continue during playback (no effect
1536 * on recording).
1537 */
1538 #define SNDCTL_DSP_SILENCE _IO ('P', 31)
1539 #define SNDCTL_DSP_SKIP _IO ('P', 32)
1540
1541 /*
1542 ****************************************************************************
1543 * Abort transfer (reset) functions for input and output
1544 */
1545 #define SNDCTL_DSP_HALT_INPUT _IO ('P', 33)
1546 #define SNDCTL_DSP_RESET_INPUT SNDCTL_DSP_HALT_INPUT /* Old name */
1547 #define SNDCTL_DSP_HALT_OUTPUT _IO ('P', 34)
1548 #define SNDCTL_DSP_RESET_OUTPUT SNDCTL_DSP_HALT_OUTPUT /* Old name */
1549
1550 /*
1551 ****************************************************************************
1552 * Low water level control
1553 */
1554 #define SNDCTL_DSP_LOW_WATER _IOW ('P', 34, int)
1555
1556 /** @todo Get rid of OSS_NO_LONG_LONG references? */
1557
1558 /*
1559 ****************************************************************************
1560 * 64 bit pointer support. Only available in environments that support
1561 * the 64 bit (long long) integer type.
1562 */
1563 #ifndef OSS_NO_LONG_LONG
1564 typedef struct
1565 {
1566 long long samples;
1567 int fifo_samples;
1568 int filler[32]; /* For future use */
1569 } oss_count_t;
1570
1571 #define SNDCTL_DSP_CURRENT_IPTR _IOR ('P', 35, oss_count_t)
1572 #define SNDCTL_DSP_CURRENT_OPTR _IOR ('P', 36, oss_count_t)
1573 #endif
1574
1575 /*
1576 ****************************************************************************
1577 * Interface for selecting recording sources and playback output routings.
1578 */
1579 #define SNDCTL_DSP_GET_RECSRC_NAMES _IOR ('P', 37, oss_mixer_enuminfo)
1580 #define SNDCTL_DSP_GET_RECSRC _IOR ('P', 38, int)
1581 #define SNDCTL_DSP_SET_RECSRC _IOWR('P', 38, int)
1582
1583 #define SNDCTL_DSP_GET_PLAYTGT_NAMES _IOR ('P', 39, oss_mixer_enuminfo)
1584 #define SNDCTL_DSP_GET_PLAYTGT _IOR ('P', 40, int)
1585 #define SNDCTL_DSP_SET_PLAYTGT _IOWR('P', 40, int)
1586 #define SNDCTL_DSP_GETRECVOL _IOR ('P', 41, int)
1587 #define SNDCTL_DSP_SETRECVOL _IOWR('P', 41, int)
1588
1589 /*
1590 ***************************************************************************
1591 * Some calls for setting the channel assignment with multi channel devices
1592 * (see the manual for details). */
1593 #define SNDCTL_DSP_GET_CHNORDER _IOR ('P', 42, unsigned long long)
1594 #define SNDCTL_DSP_SET_CHNORDER _IOWR('P', 42, unsigned long long)
1595 # define CHID_UNDEF 0
1596 # define CHID_L 1 # define CHID_R 2
1597 # define CHID_C 3
1598 # define CHID_LFE 4
1599 # define CHID_LS 5
1600 # define CHID_RS 6
1601 # define CHID_LR 7
1602 # define CHID_RR 8
1603 #define CHNORDER_UNDEF 0x0000000000000000ULL
1604 #define CHNORDER_NORMAL 0x0000000087654321ULL
1605
1606 #define MAX_PEAK_CHANNELS 128
1607 typedef unsigned short oss_peaks_t[MAX_PEAK_CHANNELS];
1608 #define SNDCTL_DSP_GETIPEAKS _IOR('P', 43, oss_peaks_t)
1609 #define SNDCTL_DSP_GETOPEAKS _IOR('P', 44, oss_peaks_t)
1610 #define SNDCTL_DSP_POLICY _IOW('P', 45, int) /* See the manual */
1611
1612 /*
1613 * OSS_SYSIFO is obsolete. Use SNDCTL_SYSINFO insteads.
1614 */
1615 #define OSS_GETVERSION _IOR ('M', 118, int)
1616
1617 /**
1618 * @brief Argument for SNDCTL_SYSINFO ioctl.
1619 *
1620 * For use w/ the SNDCTL_SYSINFO ioctl available on audio (/dev/dsp*),
1621 * mixer, and MIDI devices.
1622 */
1623 typedef struct oss_sysinfo
1624 {
1625 char product[32]; /* For example OSS/Free, OSS/Linux or
1626 OSS/Solaris */
1627 char version[32]; /* For example 4.0a */
1628 int versionnum; /* See OSS_GETVERSION */
1629 char options[128]; /* Reserved */
1630
1631 int numaudios; /* # of audio/dsp devices */
1632 int openedaudio[8]; /* Bit mask telling which audio devices
1633 are busy */
1634
1635 int numsynths; /* # of availavle synth devices */
1636 int nummidis; /* # of available MIDI ports */
1637 int numtimers; /* # of available timer devices */
1638 int nummixers; /* # of mixer devices */
1639
1640 int openedmidi[8]; /* Bit mask telling which midi devices
1641 are busy */
1642 int numcards; /* Number of sound cards in the system */
1643 int filler[241]; /* For future expansion (set to -1) */
1644 } oss_sysinfo;
1645
1646 typedef struct oss_mixext
1647 {
1648 int dev; /* Mixer device number */
1649 int ctrl; /* Controller number */
1650 int type; /* Entry type */
1651 # define MIXT_DEVROOT 0 /* Device root entry */
1652 # define MIXT_GROUP 1 /* Controller group */
1653 # define MIXT_ONOFF 2 /* OFF (0) or ON (1) */
1654 # define MIXT_ENUM 3 /* Enumerated (0 to maxvalue) */
1655 # define MIXT_MONOSLIDER 4 /* Mono slider (0 to 100) */
1656 # define MIXT_STEREOSLIDER 5 /* Stereo slider (dual 0 to 100) */
1657 # define MIXT_MESSAGE 6 /* (Readable) textual message */
1658 # define MIXT_MONOVU 7 /* VU meter value (mono) */
1659 # define MIXT_STEREOVU 8 /* VU meter value (stereo) */
1660 # define MIXT_MONOPEAK 9 /* VU meter peak value (mono) */
1661 # define MIXT_STEREOPEAK 10 /* VU meter peak value (stereo) */
1662 # define MIXT_RADIOGROUP 11 /* Radio button group */
1663 # define MIXT_MARKER 12 /* Separator between normal and extension entries */
1664 # define MIXT_VALUE 13 /* Decimal value entry */
1665 # define MIXT_HEXVALUE 14 /* Hexadecimal value entry */
1666 # define MIXT_MONODB 15 /* Mono atten. slider (0 to -144) */
1667 # define MIXT_STEREODB 16 /* Stereo atten. slider (dual 0 to -144) */
1668 # define MIXT_SLIDER 17 /* Slider (mono) with full integer range */
1669 # define MIXT_3D 18
1670
1671 /* Possible value range (minvalue to maxvalue) */
1672 /* Note that maxvalue may also be smaller than minvalue */
1673 int maxvalue;
1674 int minvalue;
1675
1676 int flags;
1677 # define MIXF_READABLE 0x00000001 /* Has readable value */
1678 # define MIXF_WRITEABLE 0x00000002 /* Has writeable value */
1679 # define MIXF_POLL 0x00000004 /* May change itself */
1680 # define MIXF_HZ 0x00000008 /* Herz scale */
1681 # define MIXF_STRING 0x00000010 /* Use dynamic extensions for value */
1682 # define MIXF_DYNAMIC 0x00000010 /* Supports dynamic extensions */
1683 # define MIXF_OKFAIL 0x00000020 /* Interpret value as 1=OK, 0=FAIL */
1684 # define MIXF_FLAT 0x00000040 /* Flat vertical space requirements */
1685 # define MIXF_LEGACY 0x00000080 /* Legacy mixer control group */
1686 char id[16]; /* Mnemonic ID (mainly for internal use) */
1687 int parent; /* Entry# of parent (group) node (-1 if root) */
1688
1689 int dummy; /* Internal use */
1690
1691 int timestamp;
1692
1693 char data[64]; /* Misc data (entry type dependent) */
1694 unsigned char enum_present[32]; /* Mask of allowed enum values */
1695 int control_no; /* SOUND_MIXER_VOLUME..SOUND_MIXER_MIDI */
1696 /* (-1 means not indicated) */
1697
1698 /*
1699 * The desc field is reserved for internal purposes of OSS. It should not be
1700 * used by applications.
1701 */
1702 unsigned int desc;
1703 #define MIXEXT_SCOPE_MASK 0x0000003f
1704 #define MIXEXT_SCOPE_OTHER 0x00000000
1705 #define MIXEXT_SCOPE_INPUT 0x00000001
1706 #define MIXEXT_SCOPE_OUTPUT 0x00000002
1707 #define MIXEXT_SCOPE_MONITOR 0x00000003
1708 #define MIXEXT_SCOPE_RECSWITCH 0x00000004
1709
1710 char extname[32];
1711 int update_counter;
1712 int filler[7];
1713 } oss_mixext;
1714
1715 typedef struct oss_mixext_root
1716 {
1717 char id[16];
1718 char name[48];
1719 } oss_mixext_root;
1720
1721 typedef struct oss_mixer_value
1722 {
1723 int dev;
1724 int ctrl;
1725 int value;
1726 int flags; /* Reserved for future use. Initialize to 0 */
1727 int timestamp; /* Must be set to oss_mixext.timestamp */
1728 int filler[8]; /* Reserved for future use. Initialize to 0 */
1729 } oss_mixer_value;
1730
1731 #define OSS_ENUM_MAXVALUE 255
1732 typedef struct oss_mixer_enuminfo
1733 {
1734 int dev;
1735 int ctrl;
1736 int nvalues;
1737 int version; /* Read the manual */
1738 short strindex[OSS_ENUM_MAXVALUE];
1739 char strings[3000];
1740 } oss_mixer_enuminfo;
1741
1742 #define OPEN_READ PCM_ENABLE_INPUT
1743 #define OPEN_WRITE PCM_ENABLE_OUTPUT
1744 #define OPEN_READWRITE (OPEN_READ|OPEN_WRITE)
1745
1746 /**
1747 * @brief Argument for SNDCTL_AUDIOINFO ioctl.
1748 *
1749 * For use w/ the SNDCTL_AUDIOINFO ioctl available on audio (/dev/dsp*)
1750 * devices.
1751 */
1752 typedef struct oss_audioinfo
1753 {
1754 int dev; /* Audio device number */
1755 char name[64];
1756 int busy; /* 0, OPEN_READ, OPEN_WRITE or OPEN_READWRITE */
1757 int pid;
1758 int caps; /* DSP_CAP_INPUT, DSP_CAP_OUTPUT */
1759 int iformats;
1760 int oformats;
1761 int magic; /* Reserved for internal use */
1762 char cmd[64]; /* Command using the device (if known) */
1763 int card_number;
1764 int port_number;
1765 int mixer_dev;
1766 int real_device; /* Obsolete field. Replaced by devnode */
1767 int enabled; /* 1=enabled, 0=device not ready at this
1768 moment */
1769 int flags; /* For internal use only - no practical
1770 meaning */
1771 int min_rate; /* Sample rate limits */
1772 int max_rate;
1773 int min_channels; /* Number of channels supported */
1774 int max_channels;
1775 int binding; /* DSP_BIND_FRONT, etc. 0 means undefined */
1776 int rate_source;
1777 char handle[32];
1778 #define OSS_MAX_SAMPLE_RATES 20 /* Cannot be changed */
1779 unsigned int nrates;
1780 unsigned int rates[OSS_MAX_SAMPLE_RATES]; /* Please read the manual before using these */
1781 oss_longname_t song_name; /* Song name (if given) */
1782 oss_label_t label; /* Device label (if given) */
1783 int latency; /* In usecs, -1=unknown */
1784 oss_devnode_t devnode; /* Device special file name (inside
1785 /dev) */
1786 int filler[186];
1787 } oss_audioinfo;
1788
1789 typedef struct oss_mixerinfo
1790 {
1791 int dev;
1792 char id[16];
1793 char name[32];
1794 int modify_counter;
1795 int card_number;
1796 int port_number;
1797 char handle[32];
1798 int magic; /* Reserved */
1799 int enabled; /* Reserved */
1800 int caps;
1801 #define MIXER_CAP_VIRTUAL 0x00000001
1802 int flags; /* Reserved */
1803 int nrext;
1804 /*
1805 * The priority field can be used to select the default (motherboard)
1806 * mixer device. The mixer with the highest priority is the
1807 * most preferred one. -2 or less means that this device cannot be used
1808 * as the default mixer.
1809 */
1810 int priority;
1811 int filler[254]; /* Reserved */
1812 } oss_mixerinfo;
1813
1814 typedef struct oss_midi_info
1815 {
1816 int dev; /* Midi device number */
1817 char name[64];
1818 int busy; /* 0, OPEN_READ, OPEN_WRITE or OPEN_READWRITE */
1819 int pid;
1820 char cmd[64]; /* Command using the device (if known) */
1821 int caps;
1822 #define MIDI_CAP_MPU401 0x00000001 /**** OBSOLETE ****/
1823 #define MIDI_CAP_INPUT 0x00000002
1824 #define MIDI_CAP_OUTPUT 0x00000004
1825 #define MIDI_CAP_INOUT (MIDI_CAP_INPUT|MIDI_CAP_OUTPUT)
1826 #define MIDI_CAP_VIRTUAL 0x00000008 /* Pseudo device */
1827 #define MIDI_CAP_MTCINPUT 0x00000010 /* Supports SNDCTL_MIDI_MTCINPUT */
1828 #define MIDI_CAP_CLIENT 0x00000020 /* Virtual client side device */
1829 #define MIDI_CAP_SERVER 0x00000040 /* Virtual server side device */
1830 #define MIDI_CAP_INTERNAL 0x00000080 /* Internal (synth) device */
1831 #define MIDI_CAP_EXTERNAL 0x00000100 /* external (MIDI port) device */
1832 #define MIDI_CAP_PTOP 0x00000200 /* Point to point link to one device */
1833 #define MIDI_CAP_MTC 0x00000400 /* MTC/SMPTE (control) device */
1834 int magic; /* Reserved for internal use */
1835 int card_number;
1836 int port_number;
1837 int enabled; /* 1=enabled, 0=device not ready at this moment */
1838 int flags; /* For internal use only - no practical meaning */
1839 char handle[32];
1840 oss_longname_t song_name; /* Song name (if known) */
1841 oss_label_t label; /* Device label (if given) */
1842 int latency; /* In usecs, -1=unknown */
1843 int filler[244];
1844 } oss_midi_info;
1845
1846 typedef struct oss_card_info
1847 {
1848 int card;
1849 char shortname[16];
1850 char longname[128];
1851 int flags;
1852 int filler[256];
1853 } oss_card_info;
1854
1855 #define SNDCTL_SYSINFO _IOR ('X', 1, oss_sysinfo)
1856 #define OSS_SYSINFO SNDCTL_SYSINFO /* Old name */
1857
1858 #define SNDCTL_MIX_NRMIX _IOR ('X', 2, int)
1859 #define SNDCTL_MIX_NREXT _IOWR('X', 3, int)
1860 #define SNDCTL_MIX_EXTINFO _IOWR('X', 4, oss_mixext)
1861 #define SNDCTL_MIX_READ _IOWR('X', 5, oss_mixer_value)
1862 #define SNDCTL_MIX_WRITE _IOWR('X', 6, oss_mixer_value)
1863
1864 #define SNDCTL_AUDIOINFO _IOWR('X', 7, oss_audioinfo)
1865 #define SNDCTL_MIX_ENUMINFO _IOWR('X', 8, oss_mixer_enuminfo)
1866 #define SNDCTL_MIDIINFO _IOWR('X', 9, oss_midi_info)
1867 #define SNDCTL_MIXERINFO _IOWR('X',10, oss_mixerinfo)
1868 #define SNDCTL_CARDINFO _IOWR('X',11, oss_card_info)
1869
1870 /*
1871 * Few more "globally" available ioctl calls.
1872 */
1873 #define SNDCTL_SETSONG _IOW ('Y', 2, oss_longname_t)
1874 #define SNDCTL_GETSONG _IOR ('Y', 2, oss_longname_t)
1875 #define SNDCTL_SETNAME _IOW ('Y', 3, oss_longname_t)
1876 #define SNDCTL_SETLABEL _IOW ('Y', 4, oss_label_t)
1877 #define SNDCTL_GETLABEL _IOR ('Y', 4, oss_label_t)
1878
1879 #endif /* !_SYS_SOUNDCARD_H_ */
Cache object: 67c3a3ad8e140744bdb97c7f35f079b1
|