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