VirtualBox

source: vbox/trunk/src/VBox/Runtime/testcase/soundcard.h@ 33540

Last change on this file since 33540 was 33540, checked in by vboxsync, 14 years ago

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette