?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Linux v2.6.16-rc1
[linux-2.6/next.git] / include / linux / soundcard.h
blob523d069c862c4fd9e95060bf5470a4fd664c4fd5
1 #ifndef SOUNDCARD_H
2 #define SOUNDCARD_H
3 /*
4 * Copyright by Hannu Savolainen 1993-1997
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met: 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer. 2.
10 * Redistributions in binary form must reproduce the above copyright notice,
11 * this list of conditions and the following disclaimer in the documentation
12 * and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY
15 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
18 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
20 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
21 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 */
26
27
28 /*
29 * OSS interface version. With versions earlier than 3.6 this value is
30 * an integer with value less than 361. In versions 3.6 and later
31 * it's a six digit hexadecimal value. For example value
32 * of 0x030600 represents OSS version 3.6.0.
33 * Use ioctl(fd, OSS_GETVERSION, &int) to get the version number of
34 * the currently active driver.
35 */
36 #define SOUND_VERSION 0x030802
37 #define OPEN_SOUND_SYSTEM
38
39 /* In Linux we need to be prepared for cross compiling */
40 #include <linux/ioctl.h>
41
42 /* Endian macros. */
43 #ifdef __KERNEL__
44 # include <asm/byteorder.h>
45 #else
46 # include <endian.h>
47 #endif
48
49 /*
50 * Supported card ID numbers (Should be somewhere else?)
51 */
52
53 #define SNDCARD_ADLIB 1
54 #define SNDCARD_SB 2
55 #define SNDCARD_PAS 3
56 #define SNDCARD_GUS 4
57 #define SNDCARD_MPU401 5
58 #define SNDCARD_SB16 6
59 #define SNDCARD_SB16MIDI 7
60 #define SNDCARD_UART6850 8
61 #define SNDCARD_GUS16 9
62 #define SNDCARD_MSS 10
63 #define SNDCARD_PSS 11
64 #define SNDCARD_SSCAPE 12
65 #define SNDCARD_PSS_MPU 13
66 #define SNDCARD_PSS_MSS 14
67 #define SNDCARD_SSCAPE_MSS 15
68 #define SNDCARD_TRXPRO 16
69 #define SNDCARD_TRXPRO_SB 17
70 #define SNDCARD_TRXPRO_MPU 18
71 #define SNDCARD_MAD16 19
72 #define SNDCARD_MAD16_MPU 20
73 #define SNDCARD_CS4232 21
74 #define SNDCARD_CS4232_MPU 22
75 #define SNDCARD_MAUI 23
76 #define SNDCARD_PSEUDO_MSS 24
77 #define SNDCARD_GUSPNP 25
78 #define SNDCARD_UART401 26
79 /* Sound card numbers 27 to N are reserved. Don't add more numbers here. */
80
81 /***********************************
82 * IOCTL Commands for /dev/sequencer
83 */
84
85 #ifndef _SIOWR
86 #if defined(_IOWR) && (defined(_AIX) || (!defined(sun) && !defined(sparc) && !defined(__sparc__) && !defined(__INCioctlh) && !defined(__Lynx__)))
87 /* Use already defined ioctl defines if they exist (except with Sun or Sparc) */
88 #define SIOCPARM_MASK IOCPARM_MASK
89 #define SIOC_VOID IOC_VOID
90 #define SIOC_OUT IOC_OUT
91 #define SIOC_IN IOC_IN
92 #define SIOC_INOUT IOC_INOUT
93 #define _SIOC_SIZE _IOC_SIZE
94 #define _SIOC_DIR _IOC_DIR
95 #define _SIOC_NONE _IOC_NONE
96 #define _SIOC_READ _IOC_READ
97 #define _SIOC_WRITE _IOC_WRITE
98 #define _SIO _IO
99 #define _SIOR _IOR
100 #define _SIOW _IOW
101 #define _SIOWR _IOWR
102 #else
103
104 /* Ioctl's have the command encoded in the lower word,
105 * and the size of any in or out parameters in the upper
106 * word. The high 2 bits of the upper word are used
107 * to encode the in/out status of the parameter; for now
108 * we restrict parameters to at most 8191 bytes.
109 */
110 /* #define SIOCTYPE (0xff<<8) */
111 #define SIOCPARM_MASK 0x1fff /* parameters must be < 8192 bytes */
112 #define SIOC_VOID 0x00000000 /* no parameters */
113 #define SIOC_OUT 0x20000000 /* copy out parameters */
114 #define SIOC_IN 0x40000000 /* copy in parameters */
115 #define SIOC_INOUT (SIOC_IN|SIOC_OUT)
116 /* the 0x20000000 is so we can distinguish new ioctl's from old */
117 #define _SIO(x,y) ((int)(SIOC_VOID|(x<<8)|y))
118 #define _SIOR(x,y,t) ((int)(SIOC_OUT|((sizeof(t)&SIOCPARM_MASK)<<16)|(x<<8)|y))
119 #define _SIOW(x,y,t) ((int)(SIOC_IN|((sizeof(t)&SIOCPARM_MASK)<<16)|(x<<8)|y))
120 /* this should be _SIORW, but stdio got there first */
121 #define _SIOWR(x,y,t) ((int)(SIOC_INOUT|((sizeof(t)&SIOCPARM_MASK)<<16)|(x<<8)|y))
122 #define _SIOC_SIZE(x) ((x>>16)&SIOCPARM_MASK)
123 #define _SIOC_DIR(x) (x & 0xf0000000)
124 #define _SIOC_NONE SIOC_VOID
125 #define _SIOC_READ SIOC_OUT
126 #define _SIOC_WRITE SIOC_IN
127 # endif /* _IOWR */
128 #endif /* !_SIOWR */
129
130 #define SNDCTL_SEQ_RESET _SIO ('Q', 0)
131 #define SNDCTL_SEQ_SYNC _SIO ('Q', 1)
132 #define SNDCTL_SYNTH_INFO _SIOWR('Q', 2, struct synth_info)
133 #define SNDCTL_SEQ_CTRLRATE _SIOWR('Q', 3, int) /* Set/get timer resolution (HZ) */
134 #define SNDCTL_SEQ_GETOUTCOUNT _SIOR ('Q', 4, int)
135 #define SNDCTL_SEQ_GETINCOUNT _SIOR ('Q', 5, int)
136 #define SNDCTL_SEQ_PERCMODE _SIOW ('Q', 6, int)
137 #define SNDCTL_FM_LOAD_INSTR _SIOW ('Q', 7, struct sbi_instrument) /* Obsolete. Don't use!!!!!! */
138 #define SNDCTL_SEQ_TESTMIDI _SIOW ('Q', 8, int)
139 #define SNDCTL_SEQ_RESETSAMPLES _SIOW ('Q', 9, int)
140 #define SNDCTL_SEQ_NRSYNTHS _SIOR ('Q',10, int)
141 #define SNDCTL_SEQ_NRMIDIS _SIOR ('Q',11, int)
142 #define SNDCTL_MIDI_INFO _SIOWR('Q',12, struct midi_info)
143 #define SNDCTL_SEQ_THRESHOLD _SIOW ('Q',13, int)
144 #define SNDCTL_SYNTH_MEMAVL _SIOWR('Q',14, int) /* in=dev#, out=memsize */
145 #define SNDCTL_FM_4OP_ENABLE _SIOW ('Q',15, int) /* in=dev# */
146 #define SNDCTL_SEQ_PANIC _SIO ('Q',17)
147 #define SNDCTL_SEQ_OUTOFBAND _SIOW ('Q',18, struct seq_event_rec)
148 #define SNDCTL_SEQ_GETTIME _SIOR ('Q',19, int)
149 #define SNDCTL_SYNTH_ID _SIOWR('Q',20, struct synth_info)
150 #define SNDCTL_SYNTH_CONTROL _SIOWR('Q',21, struct synth_control)
151 #define SNDCTL_SYNTH_REMOVESAMPLE _SIOWR('Q',22, struct remove_sample)
152
153 typedef struct synth_control
154 {
155 int devno; /* Synthesizer # */
156 char data[4000]; /* Device spesific command/data record */
157 }synth_control;
158
159 typedef struct remove_sample
160 {
161 int devno; /* Synthesizer # */
162 int bankno; /* MIDI bank # (0=General MIDI) */
163 int instrno; /* MIDI instrument number */
164 } remove_sample;
165
166 typedef struct seq_event_rec {
167 unsigned char arr[8];
168 } seq_event_rec;
169
170 #define SNDCTL_TMR_TIMEBASE _SIOWR('T', 1, int)
171 #define SNDCTL_TMR_START _SIO ('T', 2)
172 #define SNDCTL_TMR_STOP _SIO ('T', 3)
173 #define SNDCTL_TMR_CONTINUE _SIO ('T', 4)
174 #define SNDCTL_TMR_TEMPO _SIOWR('T', 5, int)
175 #define SNDCTL_TMR_SOURCE _SIOWR('T', 6, int)
176 # define TMR_INTERNAL 0x00000001
177 # define TMR_EXTERNAL 0x00000002
178 # define TMR_MODE_MIDI 0x00000010
179 # define TMR_MODE_FSK 0x00000020
180 # define TMR_MODE_CLS 0x00000040
181 # define TMR_MODE_SMPTE 0x00000080
182 #define SNDCTL_TMR_METRONOME _SIOW ('T', 7, int)
183 #define SNDCTL_TMR_SELECT _SIOW ('T', 8, int)
184
185 /*
186 * Some big endian/little endian handling macros
187 */
188
189 #define _LINUX_PATCHKEY_H_INDIRECT
190 #include <linux/patchkey.h>
191 #undef _LINUX_PATCHKEY_H_INDIRECT
192
193 #if defined(__KERNEL__)
194 # if defined(__BIG_ENDIAN)
195 # define AFMT_S16_NE AFMT_S16_BE
196 # elif defined(__LITTLE_ENDIAN)
197 # define AFMT_S16_NE AFMT_S16_LE
198 # else
199 # error "could not determine byte order"
200 # endif
201 #elif defined(__BYTE_ORDER)
202 # if __BYTE_ORDER == __BIG_ENDIAN
203 # define AFMT_S16_NE AFMT_S16_BE
204 # elif __BYTE_ORDER == __LITTLE_ENDIAN
205 # define AFMT_S16_NE AFMT_S16_LE
206 # else
207 # error "could not determine byte order"
208 # endif
209 #endif
210
211 /*
212 * Sample loading mechanism for internal synthesizers (/dev/sequencer)
213 * The following patch_info structure has been designed to support
214 * Gravis UltraSound. It tries to be universal format for uploading
215 * sample based patches but is probably too limited.
216 *
217 * (PBD) As Hannu guessed, the GUS structure is too limited for
218 * the WaveFront, but this is the right place for a constant definition.
219 */
220
221 struct patch_info {
222 unsigned short key; /* Use WAVE_PATCH here */
223 #define WAVE_PATCH _PATCHKEY(0x04)
224 #define GUS_PATCH WAVE_PATCH
225 #define WAVEFRONT_PATCH _PATCHKEY(0x06)
226
227 short device_no; /* Synthesizer number */
228 short instr_no; /* Midi pgm# */
229
230 unsigned int mode;
231 /*
232 * The least significant byte has the same format than the GUS .PAT
233 * files
234 */
235 #define WAVE_16_BITS 0x01 /* bit 0 = 8 or 16 bit wave data. */
236 #define WAVE_UNSIGNED 0x02 /* bit 1 = Signed - Unsigned data. */
237 #define WAVE_LOOPING 0x04 /* bit 2 = looping enabled-1. */
238 #define WAVE_BIDIR_LOOP 0x08 /* bit 3 = Set is bidirectional looping. */
239 #define WAVE_LOOP_BACK 0x10 /* bit 4 = Set is looping backward. */
240 #define WAVE_SUSTAIN_ON 0x20 /* bit 5 = Turn sustaining on. (Env. pts. 3)*/
241 #define WAVE_ENVELOPES 0x40 /* bit 6 = Enable envelopes - 1 */
242 #define WAVE_FAST_RELEASE 0x80 /* bit 7 = Shut off immediately after note off */
243 /* (use the env_rate/env_offs fields). */
244 /* Linux specific bits */
245 #define WAVE_VIBRATO 0x00010000 /* The vibrato info is valid */
246 #define WAVE_TREMOLO 0x00020000 /* The tremolo info is valid */
247 #define WAVE_SCALE 0x00040000 /* The scaling info is valid */
248 #define WAVE_FRACTIONS 0x00080000 /* Fraction information is valid */
249 /* Reserved bits */
250 #define WAVE_ROM 0x40000000 /* For future use */
251 #define WAVE_MULAW 0x20000000 /* For future use */
252 /* Other bits must be zeroed */
253
254 int len; /* Size of the wave data in bytes */
255 int loop_start, loop_end; /* Byte offsets from the beginning */
256
257 /*
258 * The base_freq and base_note fields are used when computing the
259 * playback speed for a note. The base_note defines the tone frequency
260 * which is heard if the sample is played using the base_freq as the
261 * playback speed.
262 *
263 * The low_note and high_note fields define the minimum and maximum note
264 * frequencies for which this sample is valid. It is possible to define
265 * more than one samples for an instrument number at the same time. The
266 * low_note and high_note fields are used to select the most suitable one.
267 *
268 * The fields base_note, high_note and low_note should contain
269 * the note frequency multiplied by 1000. For example value for the
270 * middle A is 440*1000.
271 */
272
273 unsigned int base_freq;
274 unsigned int base_note;
275 unsigned int high_note;
276 unsigned int low_note;
277 int panning; /* -128=left, 127=right */
278 int detuning;
279
280 /* New fields introduced in version 1.99.5 */
281
282 /* Envelope. Enabled by mode bit WAVE_ENVELOPES */
283 unsigned char env_rate[ 6 ]; /* GUS HW ramping rate */
284 unsigned char env_offset[ 6 ]; /* 255 == 100% */
285
286 /*
287 * The tremolo, vibrato and scale info are not supported yet.
288 * Enable by setting the mode bits WAVE_TREMOLO, WAVE_VIBRATO or
289 * WAVE_SCALE
290 */
291
292 unsigned char tremolo_sweep;
293 unsigned char tremolo_rate;
294 unsigned char tremolo_depth;
295
296 unsigned char vibrato_sweep;
297 unsigned char vibrato_rate;
298 unsigned char vibrato_depth;
299
300 int scale_frequency;
301 unsigned int scale_factor; /* from 0 to 2048 or 0 to 2 */
302
303 int volume;
304 int fractions;
305 int reserved1;
306 int spare[2];
307 char data[1]; /* The waveform data starts here */
308 };
309
310 struct sysex_info {
311 short key; /* Use SYSEX_PATCH or MAUI_PATCH here */
312 #define SYSEX_PATCH _PATCHKEY(0x05)
313 #define MAUI_PATCH _PATCHKEY(0x06)
314 short device_no; /* Synthesizer number */
315 int len; /* Size of the sysex data in bytes */
316 unsigned char data[1]; /* Sysex data starts here */
317 };
318
319 /*
320 * /dev/sequencer input events.
321 *
322 * The data written to the /dev/sequencer is a stream of events. Events
323 * are records of 4 or 8 bytes. The first byte defines the size.
324 * Any number of events can be written with a write call. There
325 * is a set of macros for sending these events. Use these macros if you
326 * want to maximize portability of your program.
327 *
328 * Events SEQ_WAIT, SEQ_MIDIPUTC and SEQ_ECHO. Are also input events.
329 * (All input events are currently 4 bytes long. Be prepared to support
330 * 8 byte events also. If you receive any event having first byte >= 128,
331 * it's a 8 byte event.
332 *
333 * The events are documented at the end of this file.
334 *
335 * Normal events (4 bytes)
336 * There is also a 8 byte version of most of the 4 byte events. The
337 * 8 byte one is recommended.
338 */
339 #define SEQ_NOTEOFF 0
340 #define SEQ_FMNOTEOFF SEQ_NOTEOFF /* Just old name */
341 #define SEQ_NOTEON 1
342 #define SEQ_FMNOTEON SEQ_NOTEON
343 #define SEQ_WAIT TMR_WAIT_ABS
344 #define SEQ_PGMCHANGE 3
345 #define SEQ_FMPGMCHANGE SEQ_PGMCHANGE
346 #define SEQ_SYNCTIMER TMR_START
347 #define SEQ_MIDIPUTC 5
348 #define SEQ_DRUMON 6 /*** OBSOLETE ***/
349 #define SEQ_DRUMOFF 7 /*** OBSOLETE ***/
350 #define SEQ_ECHO TMR_ECHO /* For synching programs with output */
351 #define SEQ_AFTERTOUCH 9
352 #define SEQ_CONTROLLER 10
353
354 /*******************************************
355 * Midi controller numbers
356 *******************************************
357 * Controllers 0 to 31 (0x00 to 0x1f) and
358 * 32 to 63 (0x20 to 0x3f) are continuous
359 * controllers.
360 * In the MIDI 1.0 these controllers are sent using
361 * two messages. Controller numbers 0 to 31 are used
362 * to send the MSB and the controller numbers 32 to 63
363 * are for the LSB. Note that just 7 bits are used in MIDI bytes.
364 */
365
366 #define CTL_BANK_SELECT 0x00
367 #define CTL_MODWHEEL 0x01
368 #define CTL_BREATH 0x02
369 /* undefined 0x03 */
370 #define CTL_FOOT 0x04
371 #define CTL_PORTAMENTO_TIME 0x05
372 #define CTL_DATA_ENTRY 0x06
373 #define CTL_MAIN_VOLUME 0x07
374 #define CTL_BALANCE 0x08
375 /* undefined 0x09 */
376 #define CTL_PAN 0x0a
377 #define CTL_EXPRESSION 0x0b
378 /* undefined 0x0c */
379 /* undefined 0x0d */
380 /* undefined 0x0e */
381 /* undefined 0x0f */
382 #define CTL_GENERAL_PURPOSE1 0x10
383 #define CTL_GENERAL_PURPOSE2 0x11
384 #define CTL_GENERAL_PURPOSE3 0x12
385 #define CTL_GENERAL_PURPOSE4 0x13
386 /* undefined 0x14 - 0x1f */
387
388 /* undefined 0x20 */
389 /* The controller numbers 0x21 to 0x3f are reserved for the */
390 /* least significant bytes of the controllers 0x00 to 0x1f. */
391 /* These controllers are not recognised by the driver. */
392
393 /* Controllers 64 to 69 (0x40 to 0x45) are on/off switches. */
394 /* 0=OFF and 127=ON (intermediate values are possible) */
395 #define CTL_DAMPER_PEDAL 0x40
396 #define CTL_SUSTAIN 0x40 /* Alias */
397 #define CTL_HOLD 0x40 /* Alias */
398 #define CTL_PORTAMENTO 0x41
399 #define CTL_SOSTENUTO 0x42
400 #define CTL_SOFT_PEDAL 0x43
401 /* undefined 0x44 */
402 #define CTL_HOLD2 0x45
403 /* undefined 0x46 - 0x4f */
404
405 #define CTL_GENERAL_PURPOSE5 0x50
406 #define CTL_GENERAL_PURPOSE6 0x51
407 #define CTL_GENERAL_PURPOSE7 0x52
408 #define CTL_GENERAL_PURPOSE8 0x53
409 /* undefined 0x54 - 0x5a */
410 #define CTL_EXT_EFF_DEPTH 0x5b
411 #define CTL_TREMOLO_DEPTH 0x5c
412 #define CTL_CHORUS_DEPTH 0x5d
413 #define CTL_DETUNE_DEPTH 0x5e
414 #define CTL_CELESTE_DEPTH 0x5e /* Alias for the above one */
415 #define CTL_PHASER_DEPTH 0x5f
416 #define CTL_DATA_INCREMENT 0x60
417 #define CTL_DATA_DECREMENT 0x61
418 #define CTL_NONREG_PARM_NUM_LSB 0x62
419 #define CTL_NONREG_PARM_NUM_MSB 0x63
420 #define CTL_REGIST_PARM_NUM_LSB 0x64
421 #define CTL_REGIST_PARM_NUM_MSB 0x65
422 /* undefined 0x66 - 0x78 */
423 /* reserved 0x79 - 0x7f */
424
425 /* Pseudo controllers (not midi compatible) */
426 #define CTRL_PITCH_BENDER 255
427 #define CTRL_PITCH_BENDER_RANGE 254
428 #define CTRL_EXPRESSION 253 /* Obsolete */
429 #define CTRL_MAIN_VOLUME 252 /* Obsolete */
430 #define SEQ_BALANCE 11
431 #define SEQ_VOLMODE 12
432
433 /*
434 * Volume mode decides how volumes are used
435 */
436
437 #define VOL_METHOD_ADAGIO 1
438 #define VOL_METHOD_LINEAR 2
439
440 /*
441 * Note! SEQ_WAIT, SEQ_MIDIPUTC and SEQ_ECHO are used also as
442 * input events.
443 */
444
445 /*
446 * Event codes 0xf0 to 0xfc are reserved for future extensions.
447 */
448
449 #define SEQ_FULLSIZE 0xfd /* Long events */
450 /*
451 * SEQ_FULLSIZE events are used for loading patches/samples to the
452 * synthesizer devices. These events are passed directly to the driver
453 * of the associated synthesizer device. There is no limit to the size
454 * of the extended events. These events are not queued but executed
455 * immediately when the write() is called (execution can take several
456 * seconds of time).
457 *
458 * When a SEQ_FULLSIZE message is written to the device, it must
459 * be written using exactly one write() call. Other events cannot
460 * be mixed to the same write.
461 *
462 * For FM synths (YM3812/OPL3) use struct sbi_instrument and write it to the
463 * /dev/sequencer. Don't write other data together with the instrument structure
464 * Set the key field of the structure to FM_PATCH. The device field is used to
465 * route the patch to the corresponding device.
466 *
467 * For wave table use struct patch_info. Initialize the key field
468 * to WAVE_PATCH.
469 */
470 #define SEQ_PRIVATE 0xfe /* Low level HW dependent events (8 bytes) */
471 #define SEQ_EXTENDED 0xff /* Extended events (8 bytes) OBSOLETE */
472
473 /*
474 * Record for FM patches
475 */
476
477 typedef unsigned char sbi_instr_data[32];
478
479 struct sbi_instrument {
480 unsigned short key; /* FM_PATCH or OPL3_PATCH */
481 #define FM_PATCH _PATCHKEY(0x01)
482 #define OPL3_PATCH _PATCHKEY(0x03)
483 short device; /* Synth# (0-4) */
484 int channel; /* Program# to be initialized */
485 sbi_instr_data operators; /* Register settings for operator cells (.SBI format) */
486 };
487
488 struct synth_info { /* Read only */
489 char name[30];
490 int device; /* 0-N. INITIALIZE BEFORE CALLING */
491 int synth_type;
492 #define SYNTH_TYPE_FM 0
493 #define SYNTH_TYPE_SAMPLE 1
494 #define SYNTH_TYPE_MIDI 2 /* Midi interface */
495
496 int synth_subtype;
497 #define FM_TYPE_ADLIB 0x00
498 #define FM_TYPE_OPL3 0x01
499 #define MIDI_TYPE_MPU401 0x401
500
501 #define SAMPLE_TYPE_BASIC 0x10
502 #define SAMPLE_TYPE_GUS SAMPLE_TYPE_BASIC
503 #define SAMPLE_TYPE_WAVEFRONT 0x11
504
505 int perc_mode; /* No longer supported */
506 int nr_voices;
507 int nr_drums; /* Obsolete field */
508 int instr_bank_size;
509 unsigned int capabilities;
510 #define SYNTH_CAP_PERCMODE 0x00000001 /* No longer used */
511 #define SYNTH_CAP_OPL3 0x00000002 /* Set if OPL3 supported */
512 #define SYNTH_CAP_INPUT 0x00000004 /* Input (MIDI) device */
513 int dummies[19]; /* Reserve space */
514 };
515
516 struct sound_timer_info {
517 char name[32];
518 int caps;
519 };
520
521 #define MIDI_CAP_MPU401 1 /* MPU-401 intelligent mode */
522
523 struct midi_info {
524 char name[30];
525 int device; /* 0-N. INITIALIZE BEFORE CALLING */
526 unsigned int capabilities; /* To be defined later */
527 int dev_type;
528 int dummies[18]; /* Reserve space */
529 };
530
531 /********************************************
532 * ioctl commands for the /dev/midi##
533 */
534 typedef struct {
535 unsigned char cmd;
536 char nr_args, nr_returns;
537 unsigned char data[30];
538 } mpu_command_rec;
539
540 #define SNDCTL_MIDI_PRETIME _SIOWR('m', 0, int)
541 #define SNDCTL_MIDI_MPUMODE _SIOWR('m', 1, int)
542 #define SNDCTL_MIDI_MPUCMD _SIOWR('m', 2, mpu_command_rec)
543
544 /********************************************
545 * IOCTL commands for /dev/dsp and /dev/audio
546 */
547
548 #define SNDCTL_DSP_RESET _SIO ('P', 0)
549 #define SNDCTL_DSP_SYNC _SIO ('P', 1)
550 #define SNDCTL_DSP_SPEED _SIOWR('P', 2, int)
551 #define SNDCTL_DSP_STEREO _SIOWR('P', 3, int)
552 #define SNDCTL_DSP_GETBLKSIZE _SIOWR('P', 4, int)
553 #define SNDCTL_DSP_SAMPLESIZE SNDCTL_DSP_SETFMT
554 #define SNDCTL_DSP_CHANNELS _SIOWR('P', 6, int)
555 #define SOUND_PCM_WRITE_CHANNELS SNDCTL_DSP_CHANNELS
556 #define SOUND_PCM_WRITE_FILTER _SIOWR('P', 7, int)
557 #define SNDCTL_DSP_POST _SIO ('P', 8)
558 #define SNDCTL_DSP_SUBDIVIDE _SIOWR('P', 9, int)
559 #define SNDCTL_DSP_SETFRAGMENT _SIOWR('P',10, int)
560
561 /* Audio data formats (Note! U8=8 and S16_LE=16 for compatibility) */
562 #define SNDCTL_DSP_GETFMTS _SIOR ('P',11, int) /* Returns a mask */
563 #define SNDCTL_DSP_SETFMT _SIOWR('P',5, int) /* Selects ONE fmt*/
564 # define AFMT_QUERY 0x00000000 /* Return current fmt */
565 # define AFMT_MU_LAW 0x00000001
566 # define AFMT_A_LAW 0x00000002
567 # define AFMT_IMA_ADPCM 0x00000004
568 # define AFMT_U8 0x00000008
569 # define AFMT_S16_LE 0x00000010 /* Little endian signed 16*/
570 # define AFMT_S16_BE 0x00000020 /* Big endian signed 16 */
571 # define AFMT_S8 0x00000040
572 # define AFMT_U16_LE 0x00000080 /* Little endian U16 */
573 # define AFMT_U16_BE 0x00000100 /* Big endian U16 */
574 # define AFMT_MPEG 0x00000200 /* MPEG (2) audio */
575 # define AFMT_AC3 0x00000400 /* Dolby Digital AC3 */
576
577 /*
578 * Buffer status queries.
579 */
580 typedef struct audio_buf_info {
581 int fragments; /* # of available fragments (partially usend ones not counted) */
582 int fragstotal; /* Total # of fragments allocated */
583 int fragsize; /* Size of a fragment in bytes */
584
585 int bytes; /* Available space in bytes (includes partially used fragments) */
586 /* Note! 'bytes' could be more than fragments*fragsize */
587 } audio_buf_info;
588
589 #define SNDCTL_DSP_GETOSPACE _SIOR ('P',12, audio_buf_info)
590 #define SNDCTL_DSP_GETISPACE _SIOR ('P',13, audio_buf_info)
591 #define SNDCTL_DSP_NONBLOCK _SIO ('P',14)
592 #define SNDCTL_DSP_GETCAPS _SIOR ('P',15, int)
593 # define DSP_CAP_REVISION 0x000000ff /* Bits for revision level (0 to 255) */
594 # define DSP_CAP_DUPLEX 0x00000100 /* Full duplex record/playback */
595 # define DSP_CAP_REALTIME 0x00000200 /* Real time capability */
596 # define DSP_CAP_BATCH 0x00000400 /* Device has some kind of */
597 /* internal buffers which may */
598 /* cause some delays and */
599 /* decrease precision of timing */
600 # define DSP_CAP_COPROC 0x00000800 /* Has a coprocessor */
601 /* Sometimes it's a DSP */
602 /* but usually not */
603 # define DSP_CAP_TRIGGER 0x00001000 /* Supports SETTRIGGER */
604 # define DSP_CAP_MMAP 0x00002000 /* Supports mmap() */
605 # define DSP_CAP_MULTI 0x00004000 /* support multiple open */
606 # define DSP_CAP_BIND 0x00008000 /* channel binding to front/rear/cneter/lfe */
607
608
609 #define SNDCTL_DSP_GETTRIGGER _SIOR ('P',16, int)
610 #define SNDCTL_DSP_SETTRIGGER _SIOW ('P',16, int)
611 # define PCM_ENABLE_INPUT 0x00000001
612 # define PCM_ENABLE_OUTPUT 0x00000002
613
614 typedef struct count_info {
615 int bytes; /* Total # of bytes processed */
616 int blocks; /* # of fragment transitions since last time */
617 int ptr; /* Current DMA pointer value */
618 } count_info;
619
620 #define SNDCTL_DSP_GETIPTR _SIOR ('P',17, count_info)
621 #define SNDCTL_DSP_GETOPTR _SIOR ('P',18, count_info)
622
623 typedef struct buffmem_desc {
624 unsigned *buffer;
625 int size;
626 } buffmem_desc;
627 #define SNDCTL_DSP_MAPINBUF _SIOR ('P', 19, buffmem_desc)
628 #define SNDCTL_DSP_MAPOUTBUF _SIOR ('P', 20, buffmem_desc)
629 #define SNDCTL_DSP_SETSYNCRO _SIO ('P', 21)
630 #define SNDCTL_DSP_SETDUPLEX _SIO ('P', 22)
631 #define SNDCTL_DSP_GETODELAY _SIOR ('P', 23, int)
632
633 #define SNDCTL_DSP_GETCHANNELMASK _SIOWR('P', 64, int)
634 #define SNDCTL_DSP_BIND_CHANNEL _SIOWR('P', 65, int)
635 # define DSP_BIND_QUERY 0x00000000
636 # define DSP_BIND_FRONT 0x00000001
637 # define DSP_BIND_SURR 0x00000002
638 # define DSP_BIND_CENTER_LFE 0x00000004
639 # define DSP_BIND_HANDSET 0x00000008
640 # define DSP_BIND_MIC 0x00000010
641 # define DSP_BIND_MODEM1 0x00000020
642 # define DSP_BIND_MODEM2 0x00000040
643 # define DSP_BIND_I2S 0x00000080
644 # define DSP_BIND_SPDIF 0x00000100
645
646 #define SNDCTL_DSP_SETSPDIF _SIOW ('P', 66, int)
647 #define SNDCTL_DSP_GETSPDIF _SIOR ('P', 67, int)
648 # define SPDIF_PRO 0x0001
649 # define SPDIF_N_AUD 0x0002
650 # define SPDIF_COPY 0x0004
651 # define SPDIF_PRE 0x0008
652 # define SPDIF_CC 0x07f0
653 # define SPDIF_L 0x0800
654 # define SPDIF_DRS 0x4000
655 # define SPDIF_V 0x8000
656
657 /*
658 * Application's profile defines the way how playback underrun situations should be handled.
659 *
660 * APF_NORMAL (the default) and APF_NETWORK make the driver to cleanup the
661 * playback buffer whenever an underrun occurs. This consumes some time
662 * prevents looping the existing buffer.
663 * APF_CPUINTENS is intended to be set by CPU intensive applications which
664 * are likely to run out of time occasionally. In this mode the buffer cleanup is
665 * disabled which saves CPU time but also let's the previous buffer content to
666 * be played during the "pause" after the underrun.
667 */
668 #define SNDCTL_DSP_PROFILE _SIOW ('P', 23, int)
669 #define APF_NORMAL 0 /* Normal applications */
670 #define APF_NETWORK 1 /* Underruns probably caused by an "external" delay */
671 #define APF_CPUINTENS 2 /* Underruns probably caused by "overheating" the CPU */
672
673 #define SOUND_PCM_READ_RATE _SIOR ('P', 2, int)
674 #define SOUND_PCM_READ_CHANNELS _SIOR ('P', 6, int)
675 #define SOUND_PCM_READ_BITS _SIOR ('P', 5, int)
676 #define SOUND_PCM_READ_FILTER _SIOR ('P', 7, int)
677
678 /* Some alias names */
679 #define SOUND_PCM_WRITE_BITS SNDCTL_DSP_SETFMT
680 #define SOUND_PCM_WRITE_RATE SNDCTL_DSP_SPEED
681 #define SOUND_PCM_POST SNDCTL_DSP_POST
682 #define SOUND_PCM_RESET SNDCTL_DSP_RESET
683 #define SOUND_PCM_SYNC SNDCTL_DSP_SYNC
684 #define SOUND_PCM_SUBDIVIDE SNDCTL_DSP_SUBDIVIDE
685 #define SOUND_PCM_SETFRAGMENT SNDCTL_DSP_SETFRAGMENT
686 #define SOUND_PCM_GETFMTS SNDCTL_DSP_GETFMTS
687 #define SOUND_PCM_SETFMT SNDCTL_DSP_SETFMT
688 #define SOUND_PCM_GETOSPACE SNDCTL_DSP_GETOSPACE
689 #define SOUND_PCM_GETISPACE SNDCTL_DSP_GETISPACE
690 #define SOUND_PCM_NONBLOCK SNDCTL_DSP_NONBLOCK
691 #define SOUND_PCM_GETCAPS SNDCTL_DSP_GETCAPS
692 #define SOUND_PCM_GETTRIGGER SNDCTL_DSP_GETTRIGGER
693 #define SOUND_PCM_SETTRIGGER SNDCTL_DSP_SETTRIGGER
694 #define SOUND_PCM_SETSYNCRO SNDCTL_DSP_SETSYNCRO
695 #define SOUND_PCM_GETIPTR SNDCTL_DSP_GETIPTR
696 #define SOUND_PCM_GETOPTR SNDCTL_DSP_GETOPTR
697 #define SOUND_PCM_MAPINBUF SNDCTL_DSP_MAPINBUF
698 #define SOUND_PCM_MAPOUTBUF SNDCTL_DSP_MAPOUTBUF
699
700 /*
701 * ioctl calls to be used in communication with coprocessors and
702 * DSP chips.
703 */
704
705 typedef struct copr_buffer {
706 int command; /* Set to 0 if not used */
707 int flags;
708 #define CPF_NONE 0x0000
709 #define CPF_FIRST 0x0001 /* First block */
710 #define CPF_LAST 0x0002 /* Last block */
711 int len;
712 int offs; /* If required by the device (0 if not used) */
713
714 unsigned char data[4000]; /* NOTE! 4000 is not 4k */
715 } copr_buffer;
716
717 typedef struct copr_debug_buf {
718 int command; /* Used internally. Set to 0 */
719 int parm1;
720 int parm2;
721 int flags;
722 int len; /* Length of data in bytes */
723 } copr_debug_buf;
724
725 typedef struct copr_msg {
726 int len;
727 unsigned char data[4000];
728 } copr_msg;
729
730 #define SNDCTL_COPR_RESET _SIO ('C', 0)
731 #define SNDCTL_COPR_LOAD _SIOWR('C', 1, copr_buffer)
732 #define SNDCTL_COPR_RDATA _SIOWR('C', 2, copr_debug_buf)
733 #define SNDCTL_COPR_RCODE _SIOWR('C', 3, copr_debug_buf)
734 #define SNDCTL_COPR_WDATA _SIOW ('C', 4, copr_debug_buf)
735 #define SNDCTL_COPR_WCODE _SIOW ('C', 5, copr_debug_buf)
736 #define SNDCTL_COPR_RUN _SIOWR('C', 6, copr_debug_buf)
737 #define SNDCTL_COPR_HALT _SIOWR('C', 7, copr_debug_buf)
738 #define SNDCTL_COPR_SENDMSG _SIOWR('C', 8, copr_msg)
739 #define SNDCTL_COPR_RCVMSG _SIOR ('C', 9, copr_msg)
740
741 /*********************************************
742 * IOCTL commands for /dev/mixer
743 */
744
745 /*
746 * Mixer devices
747 *
748 * There can be up to 20 different analog mixer channels. The
749 * SOUND_MIXER_NRDEVICES gives the currently supported maximum.
750 * The SOUND_MIXER_READ_DEVMASK returns a bitmask which tells
751 * the devices supported by the particular mixer.
752 */
753
754 #define SOUND_MIXER_NRDEVICES 25
755 #define SOUND_MIXER_VOLUME 0
756 #define SOUND_MIXER_BASS 1
757 #define SOUND_MIXER_TREBLE 2
758 #define SOUND_MIXER_SYNTH 3
759 #define SOUND_MIXER_PCM 4
760 #define SOUND_MIXER_SPEAKER 5
761 #define SOUND_MIXER_LINE 6
762 #define SOUND_MIXER_MIC 7
763 #define SOUND_MIXER_CD 8
764 #define SOUND_MIXER_IMIX 9 /* Recording monitor */
765 #define SOUND_MIXER_ALTPCM 10
766 #define SOUND_MIXER_RECLEV 11 /* Recording level */
767 #define SOUND_MIXER_IGAIN 12 /* Input gain */
768 #define SOUND_MIXER_OGAIN 13 /* Output gain */
769 /*
770 * The AD1848 codec and compatibles have three line level inputs
771 * (line, aux1 and aux2). Since each card manufacturer have assigned
772 * different meanings to these inputs, it's inpractical to assign
773 * specific meanings (line, cd, synth etc.) to them.
774 */
775 #define SOUND_MIXER_LINE1 14 /* Input source 1 (aux1) */
776 #define SOUND_MIXER_LINE2 15 /* Input source 2 (aux2) */
777 #define SOUND_MIXER_LINE3 16 /* Input source 3 (line) */
778 #define SOUND_MIXER_DIGITAL1 17 /* Digital (input) 1 */
779 #define SOUND_MIXER_DIGITAL2 18 /* Digital (input) 2 */
780 #define SOUND_MIXER_DIGITAL3 19 /* Digital (input) 3 */
781 #define SOUND_MIXER_PHONEIN 20 /* Phone input */
782 #define SOUND_MIXER_PHONEOUT 21 /* Phone output */
783 #define SOUND_MIXER_VIDEO 22 /* Video/TV (audio) in */
784 #define SOUND_MIXER_RADIO 23 /* Radio in */
785 #define SOUND_MIXER_MONITOR 24 /* Monitor (usually mic) volume */
786
787 /* Some on/off settings (SOUND_SPECIAL_MIN - SOUND_SPECIAL_MAX) */
788 /* Not counted to SOUND_MIXER_NRDEVICES, but use the same number space */
789 #define SOUND_ONOFF_MIN 28
790 #define SOUND_ONOFF_MAX 30
791
792 /* Note! Number 31 cannot be used since the sign bit is reserved */
793 #define SOUND_MIXER_NONE 31
794
795 /*
796 * The following unsupported macros are no longer functional.
797 * Use SOUND_MIXER_PRIVATE# macros in future.
798 */
799 #define SOUND_MIXER_ENHANCE SOUND_MIXER_NONE
800 #define SOUND_MIXER_MUTE SOUND_MIXER_NONE
801 #define SOUND_MIXER_LOUD SOUND_MIXER_NONE
802
803
804 #define SOUND_DEVICE_LABELS {"Vol ", "Bass ", "Trebl", "Synth", "Pcm ", "Spkr ", "Line ", \
805 "Mic ", "CD ", "Mix ", "Pcm2 ", "Rec ", "IGain", "OGain", \
806 "Line1", "Line2", "Line3", "Digital1", "Digital2", "Digital3", \
807 "PhoneIn", "PhoneOut", "Video", "Radio", "Monitor"}
808
809 #define SOUND_DEVICE_NAMES {"vol", "bass", "treble", "synth", "pcm", "speaker", "line", \
810 "mic", "cd", "mix", "pcm2", "rec", "igain", "ogain", \
811 "line1", "line2", "line3", "dig1", "dig2", "dig3", \
812 "phin", "phout", "video", "radio", "monitor"}
813
814 /* Device bitmask identifiers */
815
816 #define SOUND_MIXER_RECSRC 0xff /* Arg contains a bit for each recording source */
817 #define SOUND_MIXER_DEVMASK 0xfe /* Arg contains a bit for each supported device */
818 #define SOUND_MIXER_RECMASK 0xfd /* Arg contains a bit for each supported recording source */
819 #define SOUND_MIXER_CAPS 0xfc
820 # define SOUND_CAP_EXCL_INPUT 0x00000001 /* Only one recording source at a time */
821 #define SOUND_MIXER_STEREODEVS 0xfb /* Mixer channels supporting stereo */
822 #define SOUND_MIXER_OUTSRC 0xfa /* Arg contains a bit for each input source to output */
823 #define SOUND_MIXER_OUTMASK 0xf9 /* Arg contains a bit for each supported input source to output */
824
825 /* Device mask bits */
826
827 #define SOUND_MASK_VOLUME (1 << SOUND_MIXER_VOLUME)
828 #define SOUND_MASK_BASS (1 << SOUND_MIXER_BASS)
829 #define SOUND_MASK_TREBLE (1 << SOUND_MIXER_TREBLE)
830 #define SOUND_MASK_SYNTH (1 << SOUND_MIXER_SYNTH)
831 #define SOUND_MASK_PCM (1 << SOUND_MIXER_PCM)
832 #define SOUND_MASK_SPEAKER (1 << SOUND_MIXER_SPEAKER)
833 #define SOUND_MASK_LINE (1 << SOUND_MIXER_LINE)
834 #define SOUND_MASK_MIC (1 << SOUND_MIXER_MIC)
835 #define SOUND_MASK_CD (1 << SOUND_MIXER_CD)
836 #define SOUND_MASK_IMIX (1 << SOUND_MIXER_IMIX)
837 #define SOUND_MASK_ALTPCM (1 << SOUND_MIXER_ALTPCM)
838 #define SOUND_MASK_RECLEV (1 << SOUND_MIXER_RECLEV)
839 #define SOUND_MASK_IGAIN (1 << SOUND_MIXER_IGAIN)
840 #define SOUND_MASK_OGAIN (1 << SOUND_MIXER_OGAIN)
841 #define SOUND_MASK_LINE1 (1 << SOUND_MIXER_LINE1)
842 #define SOUND_MASK_LINE2 (1 << SOUND_MIXER_LINE2)
843 #define SOUND_MASK_LINE3 (1 << SOUND_MIXER_LINE3)
844 #define SOUND_MASK_DIGITAL1 (1 << SOUND_MIXER_DIGITAL1)
845 #define SOUND_MASK_DIGITAL2 (1 << SOUND_MIXER_DIGITAL2)
846 #define SOUND_MASK_DIGITAL3 (1 << SOUND_MIXER_DIGITAL3)
847 #define SOUND_MASK_PHONEIN (1 << SOUND_MIXER_PHONEIN)
848 #define SOUND_MASK_PHONEOUT (1 << SOUND_MIXER_PHONEOUT)
849 #define SOUND_MASK_RADIO (1 << SOUND_MIXER_RADIO)
850 #define SOUND_MASK_VIDEO (1 << SOUND_MIXER_VIDEO)
851 #define SOUND_MASK_MONITOR (1 << SOUND_MIXER_MONITOR)
852
853 /* Obsolete macros */
854 #define SOUND_MASK_MUTE (1 << SOUND_MIXER_MUTE)
855 #define SOUND_MASK_ENHANCE (1 << SOUND_MIXER_ENHANCE)
856 #define SOUND_MASK_LOUD (1 << SOUND_MIXER_LOUD)
857
858 #define MIXER_READ(dev) _SIOR('M', dev, int)
859 #define SOUND_MIXER_READ_VOLUME MIXER_READ(SOUND_MIXER_VOLUME)
860 #define SOUND_MIXER_READ_BASS MIXER_READ(SOUND_MIXER_BASS)
861 #define SOUND_MIXER_READ_TREBLE MIXER_READ(SOUND_MIXER_TREBLE)
862 #define SOUND_MIXER_READ_SYNTH MIXER_READ(SOUND_MIXER_SYNTH)
863 #define SOUND_MIXER_READ_PCM MIXER_READ(SOUND_MIXER_PCM)
864 #define SOUND_MIXER_READ_SPEAKER MIXER_READ(SOUND_MIXER_SPEAKER)
865 #define SOUND_MIXER_READ_LINE MIXER_READ(SOUND_MIXER_LINE)
866 #define SOUND_MIXER_READ_MIC MIXER_READ(SOUND_MIXER_MIC)
867 #define SOUND_MIXER_READ_CD MIXER_READ(SOUND_MIXER_CD)
868 #define SOUND_MIXER_READ_IMIX MIXER_READ(SOUND_MIXER_IMIX)
869 #define SOUND_MIXER_READ_ALTPCM MIXER_READ(SOUND_MIXER_ALTPCM)
870 #define SOUND_MIXER_READ_RECLEV MIXER_READ(SOUND_MIXER_RECLEV)
871 #define SOUND_MIXER_READ_IGAIN MIXER_READ(SOUND_MIXER_IGAIN)
872 #define SOUND_MIXER_READ_OGAIN MIXER_READ(SOUND_MIXER_OGAIN)
873 #define SOUND_MIXER_READ_LINE1 MIXER_READ(SOUND_MIXER_LINE1)
874 #define SOUND_MIXER_READ_LINE2 MIXER_READ(SOUND_MIXER_LINE2)
875 #define SOUND_MIXER_READ_LINE3 MIXER_READ(SOUND_MIXER_LINE3)
876
877 /* Obsolete macros */
878 #define SOUND_MIXER_READ_MUTE MIXER_READ(SOUND_MIXER_MUTE)
879 #define SOUND_MIXER_READ_ENHANCE MIXER_READ(SOUND_MIXER_ENHANCE)
880 #define SOUND_MIXER_READ_LOUD MIXER_READ(SOUND_MIXER_LOUD)
881
882 #define SOUND_MIXER_READ_RECSRC MIXER_READ(SOUND_MIXER_RECSRC)
883 #define SOUND_MIXER_READ_DEVMASK MIXER_READ(SOUND_MIXER_DEVMASK)
884 #define SOUND_MIXER_READ_RECMASK MIXER_READ(SOUND_MIXER_RECMASK)
885 #define SOUND_MIXER_READ_STEREODEVS MIXER_READ(SOUND_MIXER_STEREODEVS)
886 #define SOUND_MIXER_READ_CAPS MIXER_READ(SOUND_MIXER_CAPS)
887
888 #define MIXER_WRITE(dev) _SIOWR('M', dev, int)
889 #define SOUND_MIXER_WRITE_VOLUME MIXER_WRITE(SOUND_MIXER_VOLUME)
890 #define SOUND_MIXER_WRITE_BASS MIXER_WRITE(SOUND_MIXER_BASS)
891 #define SOUND_MIXER_WRITE_TREBLE MIXER_WRITE(SOUND_MIXER_TREBLE)
892 #define SOUND_MIXER_WRITE_SYNTH MIXER_WRITE(SOUND_MIXER_SYNTH)
893 #define SOUND_MIXER_WRITE_PCM MIXER_WRITE(SOUND_MIXER_PCM)
894 #define SOUND_MIXER_WRITE_SPEAKER MIXER_WRITE(SOUND_MIXER_SPEAKER)
895 #define SOUND_MIXER_WRITE_LINE MIXER_WRITE(SOUND_MIXER_LINE)
896 #define SOUND_MIXER_WRITE_MIC MIXER_WRITE(SOUND_MIXER_MIC)
897 #define SOUND_MIXER_WRITE_CD MIXER_WRITE(SOUND_MIXER_CD)
898 #define SOUND_MIXER_WRITE_IMIX MIXER_WRITE(SOUND_MIXER_IMIX)
899 #define SOUND_MIXER_WRITE_ALTPCM MIXER_WRITE(SOUND_MIXER_ALTPCM)
900 #define SOUND_MIXER_WRITE_RECLEV MIXER_WRITE(SOUND_MIXER_RECLEV)
901 #define SOUND_MIXER_WRITE_IGAIN MIXER_WRITE(SOUND_MIXER_IGAIN)
902 #define SOUND_MIXER_WRITE_OGAIN MIXER_WRITE(SOUND_MIXER_OGAIN)
903 #define SOUND_MIXER_WRITE_LINE1 MIXER_WRITE(SOUND_MIXER_LINE1)
904 #define SOUND_MIXER_WRITE_LINE2 MIXER_WRITE(SOUND_MIXER_LINE2)
905 #define SOUND_MIXER_WRITE_LINE3 MIXER_WRITE(SOUND_MIXER_LINE3)
906
907 /* Obsolete macros */
908 #define SOUND_MIXER_WRITE_MUTE MIXER_WRITE(SOUND_MIXER_MUTE)
909 #define SOUND_MIXER_WRITE_ENHANCE MIXER_WRITE(SOUND_MIXER_ENHANCE)
910 #define SOUND_MIXER_WRITE_LOUD MIXER_WRITE(SOUND_MIXER_LOUD)
911
912 #define SOUND_MIXER_WRITE_RECSRC MIXER_WRITE(SOUND_MIXER_RECSRC)
913
914 typedef struct mixer_info
915 {
916 char id[16];
917 char name[32];
918 int modify_counter;
919 int fillers[10];
920 } mixer_info;
921
922 typedef struct _old_mixer_info /* Obsolete */
923 {
924 char id[16];
925 char name[32];
926 } _old_mixer_info;
927
928 #define SOUND_MIXER_INFO _SIOR ('M', 101, mixer_info)
929 #define SOUND_OLD_MIXER_INFO _SIOR ('M', 101, _old_mixer_info)
930
931 /*
932 * A mechanism for accessing "proprietary" mixer features. This method
933 * permits passing 128 bytes of arbitrary data between a mixer application
934 * and the mixer driver. Interpretation of the record is defined by
935 * the particular mixer driver.
936 */
937 typedef unsigned char mixer_record[128];
938
939 #define SOUND_MIXER_ACCESS _SIOWR('M', 102, mixer_record)
940
941 /*
942 * Two ioctls for special souncard function
943 */
944 #define SOUND_MIXER_AGC _SIOWR('M', 103, int)
945 #define SOUND_MIXER_3DSE _SIOWR('M', 104, int)
946
947 /*
948 * The SOUND_MIXER_PRIVATE# commands can be redefined by low level drivers.
949 * These features can be used when accessing device specific features.
950 */
951 #define SOUND_MIXER_PRIVATE1 _SIOWR('M', 111, int)
952 #define SOUND_MIXER_PRIVATE2 _SIOWR('M', 112, int)
953 #define SOUND_MIXER_PRIVATE3 _SIOWR('M', 113, int)
954 #define SOUND_MIXER_PRIVATE4 _SIOWR('M', 114, int)
955 #define SOUND_MIXER_PRIVATE5 _SIOWR('M', 115, int)
956
957 /*
958 * SOUND_MIXER_GETLEVELS and SOUND_MIXER_SETLEVELS calls can be used
959 * for querying current mixer settings from the driver and for loading
960 * default volume settings _prior_ activating the mixer (loading
961 * doesn't affect current state of the mixer hardware). These calls
962 * are for internal use only.
963 */
964
965 typedef struct mixer_vol_table {
966 int num; /* Index to volume table */
967 char name[32];
968 int levels[32];
969 } mixer_vol_table;
970
971 #define SOUND_MIXER_GETLEVELS _SIOWR('M', 116, mixer_vol_table)
972 #define SOUND_MIXER_SETLEVELS _SIOWR('M', 117, mixer_vol_table)
973
974 /*
975 * An ioctl for identifying the driver version. It will return value
976 * of the SOUND_VERSION macro used when compiling the driver.
977 * This call was introduced in OSS version 3.6 and it will not work
978 * with earlier versions (returns EINVAL).
979 */
980 #define OSS_GETVERSION _SIOR ('M', 118, int)
981
982 /*
983 * Level 2 event types for /dev/sequencer
984 */
985
986 /*
987 * The 4 most significant bits of byte 0 specify the class of
988 * the event:
989 *
990 * 0x8X = system level events,
991 * 0x9X = device/port specific events, event[1] = device/port,
992 * The last 4 bits give the subtype:
993 * 0x02 = Channel event (event[3] = chn).
994 * 0x01 = note event (event[4] = note).
995 * (0x01 is not used alone but always with bit 0x02).
996 * event[2] = MIDI message code (0x80=note off etc.)
997 *
998 */
999
1000 #define EV_SEQ_LOCAL 0x80
1001 #define EV_TIMING 0x81
1002 #define EV_CHN_COMMON 0x92
1003 #define EV_CHN_VOICE 0x93
1004 #define EV_SYSEX 0x94
1005 /*
1006 * Event types 200 to 220 are reserved for application use.
1007 * These numbers will not be used by the driver.
1008 */
1009
1010 /*
1011 * Events for event type EV_CHN_VOICE
1012 */
1013
1014 #define MIDI_NOTEOFF 0x80
1015 #define MIDI_NOTEON 0x90
1016 #define MIDI_KEY_PRESSURE 0xA0
1017
1018 /*
1019 * Events for event type EV_CHN_COMMON
1020 */
1021
1022 #define MIDI_CTL_CHANGE 0xB0
1023 #define MIDI_PGM_CHANGE 0xC0
1024 #define MIDI_CHN_PRESSURE 0xD0
1025 #define MIDI_PITCH_BEND 0xE0
1026
1027 #define MIDI_SYSTEM_PREFIX 0xF0
1028
1029 /*
1030 * Timer event types
1031 */
1032 #define TMR_WAIT_REL 1 /* Time relative to the prev time */
1033 #define TMR_WAIT_ABS 2 /* Absolute time since TMR_START */
1034 #define TMR_STOP 3
1035 #define TMR_START 4
1036 #define TMR_CONTINUE 5
1037 #define TMR_TEMPO 6
1038 #define TMR_ECHO 8
1039 #define TMR_CLOCK 9 /* MIDI clock */
1040 #define TMR_SPP 10 /* Song position pointer */
1041 #define TMR_TIMESIG 11 /* Time signature */
1042
1043 /*
1044 * Local event types
1045 */
1046 #define LOCL_STARTAUDIO 1
1047
1048 #if (!defined(__KERNEL__) && !defined(KERNEL) && !defined(INKERNEL) && !defined(_KERNEL)) || defined(USE_SEQ_MACROS)
1049 /*
1050 * Some convenience macros to simplify programming of the
1051 * /dev/sequencer interface
1052 *
1053 * These macros define the API which should be used when possible.
1054 */
1055 #define SEQ_DECLAREBUF() SEQ_USE_EXTBUF()
1056
1057 void seqbuf_dump(void); /* This function must be provided by programs */
1058
1059 extern int OSS_init(int seqfd, int buflen);
1060 extern void OSS_seqbuf_dump(int fd, unsigned char *buf, int buflen);
1061 extern void OSS_seq_advbuf(int len, int fd, unsigned char *buf, int buflen);
1062 extern void OSS_seq_needbuf(int len, int fd, unsigned char *buf, int buflen);
1063 extern void OSS_patch_caching(int dev, int chn, int patch,
1064 int fd, unsigned char *buf, int buflen);
1065 extern void OSS_drum_caching(int dev, int chn, int patch,
1066 int fd, unsigned char *buf, int buflen);
1067 extern void OSS_write_patch(int fd, unsigned char *buf, int len);
1068 extern int OSS_write_patch2(int fd, unsigned char *buf, int len);
1069
1070 #define SEQ_PM_DEFINES int __foo_bar___
1071 #ifdef OSSLIB
1072 # define SEQ_USE_EXTBUF() \
1073 extern unsigned char *_seqbuf; \
1074 extern int _seqbuflen;extern int _seqbufptr
1075 # define SEQ_DEFINEBUF(len) SEQ_USE_EXTBUF();static int _requested_seqbuflen=len
1076 # define _SEQ_ADVBUF(len) OSS_seq_advbuf(len, seqfd, _seqbuf, _seqbuflen)
1077 # define _SEQ_NEEDBUF(len) OSS_seq_needbuf(len, seqfd, _seqbuf, _seqbuflen)
1078 # define SEQ_DUMPBUF() OSS_seqbuf_dump(seqfd, _seqbuf, _seqbuflen)
1079
1080 # define SEQ_LOAD_GMINSTR(dev, instr) \
1081 OSS_patch_caching(dev, -1, instr, seqfd, _seqbuf, _seqbuflen)
1082 # define SEQ_LOAD_GMDRUM(dev, drum) \
1083 OSS_drum_caching(dev, -1, drum, seqfd, _seqbuf, _seqbuflen)
1084 #else /* !OSSLIB */
1085
1086 # define SEQ_LOAD_GMINSTR(dev, instr)
1087 # define SEQ_LOAD_GMDRUM(dev, drum)
1088
1089 # define SEQ_USE_EXTBUF() \
1090 extern unsigned char _seqbuf[]; \
1091 extern int _seqbuflen;extern int _seqbufptr
1092
1093 #ifndef USE_SIMPLE_MACROS
1094 /* Sample seqbuf_dump() implementation:
1095 *
1096 * SEQ_DEFINEBUF (2048); -- Defines a buffer for 2048 bytes
1097 *
1098 * int seqfd; -- The file descriptor for /dev/sequencer.
1099 *
1100 * void
1101 * seqbuf_dump ()
1102 * {
1103 * if (_seqbufptr)
1104 * if (write (seqfd, _seqbuf, _seqbufptr) == -1)
1105 * {
1106 * perror ("write /dev/sequencer");
1107 * exit (-1);
1108 * }
1109 * _seqbufptr = 0;
1110 * }
1111 */
1112
1113 #define SEQ_DEFINEBUF(len) unsigned char _seqbuf[len]; int _seqbuflen = len;int _seqbufptr = 0
1114 #define _SEQ_NEEDBUF(len) if ((_seqbufptr+(len)) > _seqbuflen) seqbuf_dump()
1115 #define _SEQ_ADVBUF(len) _seqbufptr += len
1116 #define SEQ_DUMPBUF seqbuf_dump
1117 #else
1118 /*
1119 * This variation of the sequencer macros is used just to format one event
1120 * using fixed buffer.
1121 *
1122 * The program using the macro library must define the following macros before
1123 * using this library.
1124 *
1125 * #define _seqbuf name of the buffer (unsigned char[])
1126 * #define _SEQ_ADVBUF(len) If the applic needs to know the exact
1127 * size of the event, this macro can be used.
1128 * Otherwise this must be defined as empty.
1129 * #define _seqbufptr Define the name of index variable or 0 if
1130 * not required.
1131 */
1132 #define _SEQ_NEEDBUF(len) /* empty */
1133 #endif
1134 #endif /* !OSSLIB */
1135
1136 #define SEQ_VOLUME_MODE(dev, mode) {_SEQ_NEEDBUF(8);\
1137 _seqbuf[_seqbufptr] = SEQ_EXTENDED;\
1138 _seqbuf[_seqbufptr+1] = SEQ_VOLMODE;\
1139 _seqbuf[_seqbufptr+2] = (dev);\
1140 _seqbuf[_seqbufptr+3] = (mode);\
1141 _seqbuf[_seqbufptr+4] = 0;\
1142 _seqbuf[_seqbufptr+5] = 0;\
1143 _seqbuf[_seqbufptr+6] = 0;\
1144 _seqbuf[_seqbufptr+7] = 0;\
1145 _SEQ_ADVBUF(8);}
1146
1147 /*
1148 * Midi voice messages
1149 */
1150
1151 #define _CHN_VOICE(dev, event, chn, note, parm) \
1152 {_SEQ_NEEDBUF(8);\
1153 _seqbuf[_seqbufptr] = EV_CHN_VOICE;\
1154 _seqbuf[_seqbufptr+1] = (dev);\
1155 _seqbuf[_seqbufptr+2] = (event);\
1156 _seqbuf[_seqbufptr+3] = (chn);\
1157 _seqbuf[_seqbufptr+4] = (note);\
1158 _seqbuf[_seqbufptr+5] = (parm);\
1159 _seqbuf[_seqbufptr+6] = (0);\
1160 _seqbuf[_seqbufptr+7] = 0;\
1161 _SEQ_ADVBUF(8);}
1162
1163 #define SEQ_START_NOTE(dev, chn, note, vol) \
1164 _CHN_VOICE(dev, MIDI_NOTEON, chn, note, vol)
1165
1166 #define SEQ_STOP_NOTE(dev, chn, note, vol) \
1167 _CHN_VOICE(dev, MIDI_NOTEOFF, chn, note, vol)
1168
1169 #define SEQ_KEY_PRESSURE(dev, chn, note, pressure) \
1170 _CHN_VOICE(dev, MIDI_KEY_PRESSURE, chn, note, pressure)
1171
1172 /*
1173 * Midi channel messages
1174 */
1175
1176 #define _CHN_COMMON(dev, event, chn, p1, p2, w14) \
1177 {_SEQ_NEEDBUF(8);\
1178 _seqbuf[_seqbufptr] = EV_CHN_COMMON;\
1179 _seqbuf[_seqbufptr+1] = (dev);\
1180 _seqbuf[_seqbufptr+2] = (event);\
1181 _seqbuf[_seqbufptr+3] = (chn);\
1182 _seqbuf[_seqbufptr+4] = (p1);\
1183 _seqbuf[_seqbufptr+5] = (p2);\
1184 *(short *)&_seqbuf[_seqbufptr+6] = (w14);\
1185 _SEQ_ADVBUF(8);}
1186 /*
1187 * SEQ_SYSEX permits sending of sysex messages. (It may look that it permits
1188 * sending any MIDI bytes but it's absolutely not possible. Trying to do
1189 * so _will_ cause problems with MPU401 intelligent mode).
1190 *
1191 * Sysex messages are sent in blocks of 1 to 6 bytes. Longer messages must be
1192 * sent by calling SEQ_SYSEX() several times (there must be no other events
1193 * between them). First sysex fragment must have 0xf0 in the first byte
1194 * and the last byte (buf[len-1] of the last fragment must be 0xf7. No byte
1195 * between these sysex start and end markers cannot be larger than 0x7f. Also
1196 * lengths of each fragments (except the last one) must be 6.
1197 *
1198 * Breaking the above rules may work with some MIDI ports but is likely to
1199 * cause fatal problems with some other devices (such as MPU401).
1200 */
1201 #define SEQ_SYSEX(dev, buf, len) \
1202 {int ii, ll=(len); \
1203 unsigned char *bufp=buf;\
1204 if (ll>6)ll=6;\
1205 _SEQ_NEEDBUF(8);\
1206 _seqbuf[_seqbufptr] = EV_SYSEX;\
1207 _seqbuf[_seqbufptr+1] = (dev);\
1208 for(ii=0;ii<ll;ii++)\
1209 _seqbuf[_seqbufptr+ii+2] = bufp[ii];\
1210 for(ii=ll;ii<6;ii++)\
1211 _seqbuf[_seqbufptr+ii+2] = 0xff;\
1212 _SEQ_ADVBUF(8);}
1213
1214 #define SEQ_CHN_PRESSURE(dev, chn, pressure) \
1215 _CHN_COMMON(dev, MIDI_CHN_PRESSURE, chn, pressure, 0, 0)
1216
1217 #define SEQ_SET_PATCH SEQ_PGM_CHANGE
1218 #ifdef OSSLIB
1219 # define SEQ_PGM_CHANGE(dev, chn, patch) \
1220 {OSS_patch_caching(dev, chn, patch, seqfd, _seqbuf, _seqbuflen); \
1221 _CHN_COMMON(dev, MIDI_PGM_CHANGE, chn, patch, 0, 0);}
1222 #else
1223 # define SEQ_PGM_CHANGE(dev, chn, patch) \
1224 _CHN_COMMON(dev, MIDI_PGM_CHANGE, chn, patch, 0, 0)
1225 #endif
1226
1227 #define SEQ_CONTROL(dev, chn, controller, value) \
1228 _CHN_COMMON(dev, MIDI_CTL_CHANGE, chn, controller, 0, value)
1229
1230 #define SEQ_BENDER(dev, chn, value) \
1231 _CHN_COMMON(dev, MIDI_PITCH_BEND, chn, 0, 0, value)
1232
1233
1234 #define SEQ_V2_X_CONTROL(dev, voice, controller, value) {_SEQ_NEEDBUF(8);\
1235 _seqbuf[_seqbufptr] = SEQ_EXTENDED;\
1236 _seqbuf[_seqbufptr+1] = SEQ_CONTROLLER;\
1237 _seqbuf[_seqbufptr+2] = (dev);\
1238 _seqbuf[_seqbufptr+3] = (voice);\
1239 _seqbuf[_seqbufptr+4] = (controller);\
1240 _seqbuf[_seqbufptr+5] = ((value)&0xff);\
1241 _seqbuf[_seqbufptr+6] = ((value>>8)&0xff);\
1242 _seqbuf[_seqbufptr+7] = 0;\
1243 _SEQ_ADVBUF(8);}
1244 /*
1245 * The following 5 macros are incorrectly implemented and obsolete.
1246 * Use SEQ_BENDER and SEQ_CONTROL (with proper controller) instead.
1247 */
1248 #define SEQ_PITCHBEND(dev, voice, value) SEQ_V2_X_CONTROL(dev, voice, CTRL_PITCH_BENDER, value)
1249 #define SEQ_BENDER_RANGE(dev, voice, value) SEQ_V2_X_CONTROL(dev, voice, CTRL_PITCH_BENDER_RANGE, value)
1250 #define SEQ_EXPRESSION(dev, voice, value) SEQ_CONTROL(dev, voice, CTL_EXPRESSION, value*128)
1251 #define SEQ_MAIN_VOLUME(dev, voice, value) SEQ_CONTROL(dev, voice, CTL_MAIN_VOLUME, (value*16383)/100)
1252 #define SEQ_PANNING(dev, voice, pos) SEQ_CONTROL(dev, voice, CTL_PAN, (pos+128) / 2)
1253
1254 /*
1255 * Timing and syncronization macros
1256 */
1257
1258 #define _TIMER_EVENT(ev, parm) {_SEQ_NEEDBUF(8);\
1259 _seqbuf[_seqbufptr+0] = EV_TIMING; \
1260 _seqbuf[_seqbufptr+1] = (ev); \
1261 _seqbuf[_seqbufptr+2] = 0;\
1262 _seqbuf[_seqbufptr+3] = 0;\
1263 *(unsigned int *)&_seqbuf[_seqbufptr+4] = (parm); \
1264 _SEQ_ADVBUF(8);}
1265
1266 #define SEQ_START_TIMER() _TIMER_EVENT(TMR_START, 0)
1267 #define SEQ_STOP_TIMER() _TIMER_EVENT(TMR_STOP, 0)
1268 #define SEQ_CONTINUE_TIMER() _TIMER_EVENT(TMR_CONTINUE, 0)
1269 #define SEQ_WAIT_TIME(ticks) _TIMER_EVENT(TMR_WAIT_ABS, ticks)
1270 #define SEQ_DELTA_TIME(ticks) _TIMER_EVENT(TMR_WAIT_REL, ticks)
1271 #define SEQ_ECHO_BACK(key) _TIMER_EVENT(TMR_ECHO, key)
1272 #define SEQ_SET_TEMPO(value) _TIMER_EVENT(TMR_TEMPO, value)
1273 #define SEQ_SONGPOS(pos) _TIMER_EVENT(TMR_SPP, pos)
1274 #define SEQ_TIME_SIGNATURE(sig) _TIMER_EVENT(TMR_TIMESIG, sig)
1275
1276 /*
1277 * Local control events
1278 */
1279
1280 #define _LOCAL_EVENT(ev, parm) {_SEQ_NEEDBUF(8);\
1281 _seqbuf[_seqbufptr+0] = EV_SEQ_LOCAL; \
1282 _seqbuf[_seqbufptr+1] = (ev); \
1283 _seqbuf[_seqbufptr+2] = 0;\
1284 _seqbuf[_seqbufptr+3] = 0;\
1285 *(unsigned int *)&_seqbuf[_seqbufptr+4] = (parm); \
1286 _SEQ_ADVBUF(8);}
1287
1288 #define SEQ_PLAYAUDIO(devmask) _LOCAL_EVENT(LOCL_STARTAUDIO, devmask)
1289 /*
1290 * Events for the level 1 interface only
1291 */
1292
1293 #define SEQ_MIDIOUT(device, byte) {_SEQ_NEEDBUF(4);\
1294 _seqbuf[_seqbufptr] = SEQ_MIDIPUTC;\
1295 _seqbuf[_seqbufptr+1] = (byte);\
1296 _seqbuf[_seqbufptr+2] = (device);\
1297 _seqbuf[_seqbufptr+3] = 0;\
1298 _SEQ_ADVBUF(4);}
1299
1300 /*
1301 * Patch loading.
1302 */
1303 #ifdef OSSLIB
1304 # define SEQ_WRPATCH(patchx, len) \
1305 OSS_write_patch(seqfd, (char*)(patchx), len)
1306 # define SEQ_WRPATCH2(patchx, len) \
1307 OSS_write_patch2(seqfd, (char*)(patchx), len)
1308 #else
1309 # define SEQ_WRPATCH(patchx, len) \
1310 {if (_seqbufptr) SEQ_DUMPBUF();\
1311 if (write(seqfd, (char*)(patchx), len)==-1) \
1312 perror("Write patch: /dev/sequencer");}
1313 # define SEQ_WRPATCH2(patchx, len) \
1314 (SEQ_DUMPBUF(), write(seqfd, (char*)(patchx), len))
1315 #endif
1316
1317 #endif
1318 #endif
linux-next