soundcard.h revision 6959
1#ifndef _MACHINE_SOUNDCARD_H_ 2#define _MACHINE_SOUNDCARD_H_ 3 4/* 5 * Copyright by Hannu Savolainen 1993 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 copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 * $Id: soundcard.h,v 1.11 1995/02/13 22:48:54 jkh Exp $ 29 */ 30 31 /* 32 * If you make modifications to this file, please contact me before 33 * distributing the modified version. There is already enough 34 * divercity in the world. 35 * 36 * Regards, 37 * Hannu Savolainen 38 * hannu@voxware.pp.fi 39 */ 40 41#define SOUND_VERSION 203 42#define VOXWARE 43 44#include <sys/ioctl.h> 45 46/* 47 * Supported card ID numbers (Should be somewhere else?) 48 */ 49 50#define SNDCARD_ADLIB 1 51#define SNDCARD_SB 2 52#define SNDCARD_PAS 3 53#define SNDCARD_GUS 4 54#define SNDCARD_MPU401 5 55#define SNDCARD_SB16 6 56#define SNDCARD_SB16MIDI 7 57#define SNDCARD_UART6850 8 58#define SNDCARD_GUS16 9 59#define SNDCARD_MSS 10 60#define SNDCARD_PSS 11 61 62/*********************************** 63 * IOCTL Commands for /dev/sequencer 64 */ 65 66 67#define SNDCTL_SEQ_RESET _IO ('Q', 0) 68#define SNDCTL_SEQ_SYNC _IO ('Q', 1) 69#define SNDCTL_SYNTH_INFO _IOWR('Q', 2, struct synth_info) 70#define SNDCTL_SEQ_CTRLRATE _IOWR('Q', 3, int) /* Set/get timer resolution (HZ) */ 71#define SNDCTL_SEQ_GETOUTCOUNT _IOR ('Q', 4, int) 72#define SNDCTL_SEQ_GETINCOUNT _IOR ('Q', 5, int) 73#define SNDCTL_SEQ_PERCMODE _IOW ('Q', 6, int) 74#define SNDCTL_FM_LOAD_INSTR _IOW ('Q', 7, struct sbi_instrument) /* Valid for FM only */ 75#define SNDCTL_SEQ_TESTMIDI _IOW ('Q', 8, int) 76#define SNDCTL_SEQ_RESETSAMPLES _IOW ('Q', 9, int) 77#define SNDCTL_SEQ_NRSYNTHS _IOR ('Q',10, int) 78#define SNDCTL_SEQ_NRMIDIS _IOR ('Q',11, int) 79#define SNDCTL_MIDI_INFO _IOWR('Q',12, struct midi_info) 80#define SNDCTL_SEQ_TRESHOLD _IOW ('Q',13, int) 81#define SNDCTL_SYNTH_MEMAVL _IOWR('Q',14, int) /* in=dev#, out=memsize */ 82#define SNDCTL_FM_4OP_ENABLE _IOW ('Q',15, int) /* in=dev# */ 83#define SNDCTL_PMGR_ACCESS _IOWR('Q',16, struct patmgr_info) 84#define SNDCTL_SEQ_PANIC _IO ('Q',17) 85 86#define SNDCTL_TMR_TIMEBASE _IOWR('T', 1, int) 87#define SNDCTL_TMR_START _IO ('T', 2) 88#define SNDCTL_TMR_STOP _IO ('T', 3) 89#define SNDCTL_TMR_CONTINUE _IO ('T', 4) 90#define SNDCTL_TMR_TEMPO _IOWR('T', 5, int) 91#define SNDCTL_TMR_SOURCE _IOWR('T', 6, int) 92# define TMR_INTERNAL 0x00000001 93# define TMR_EXTERNAL 0x00000002 94# define TMR_MODE_MIDI 0x00000010 95# define TMR_MODE_FSK 0x00000020 96# define TMR_MODE_CLS 0x00000040 97# define TMR_MODE_SMPTE 0x00000080 98#define SNDCTL_TMR_METRONOME _IOW ('T', 7, int) 99#define SNDCTL_TMR_SELECT _IOW ('T', 8, int) 100 101/* 102 * Sample loading mechanism for internal synthesizers (/dev/sequencer) 103 * The following patch_info structure has been designed to support 104 * Gravis UltraSound. It tries to be universal format for uploading 105 * sample based patches but is propably too limited. 106 */ 107 108struct patch_info { 109 short key; /* Use GUS_PATCH here */ 110#define GUS_PATCH 0x04fd 111#define OBSOLETE_GUS_PATCH 0x02fd 112 short device_no; /* Synthesizer number */ 113 short instr_no; /* Midi pgm# */ 114 115 unsigned long mode; 116/* 117 * The least significant byte has the same format than the GUS .PAT 118 * files 119 */ 120#define WAVE_16_BITS 0x01 /* bit 0 = 8 or 16 bit wave data. */ 121#define WAVE_UNSIGNED 0x02 /* bit 1 = Signed - Unsigned data. */ 122#define WAVE_LOOPING 0x04 /* bit 2 = looping enabled-1. */ 123#define WAVE_BIDIR_LOOP 0x08 /* bit 3 = Set is bidirectional looping. */ 124#define WAVE_LOOP_BACK 0x10 /* bit 4 = Set is looping backward. */ 125#define WAVE_SUSTAIN_ON 0x20 /* bit 5 = Turn sustaining on. (Env. pts. 3)*/ 126#define WAVE_ENVELOPES 0x40 /* bit 6 = Enable envelopes - 1 */ 127 /* (use the env_rate/env_offs fields). */ 128/* Linux specific bits */ 129#define WAVE_VIBRATO 0x00010000 /* The vibrato info is valid */ 130#define WAVE_TREMOLO 0x00020000 /* The tremolo info is valid */ 131#define WAVE_SCALE 0x00040000 /* The scaling info is valid */ 132/* Other bits must be zeroed */ 133 134 long len; /* Size of the wave data in bytes */ 135 long loop_start, loop_end; /* Byte offsets from the beginning */ 136 137/* 138 * The base_freq and base_note fields are used when computing the 139 * playback speed for a note. The base_note defines the tone frequency 140 * which is heard if the sample is played using the base_freq as the 141 * playback speed. 142 * 143 * The low_note and high_note fields define the minimum and maximum note 144 * frequencies for which this sample is valid. It is possible to define 145 * more than one samples for a instrument number at the same time. The 146 * low_note and high_note fields are used to select the most suitable one. 147 * 148 * The fields base_note, high_note and low_note should contain 149 * the note frequency multiplied by 1000. For example value for the 150 * middle A is 440*1000. 151 */ 152 153 unsigned int base_freq; 154 unsigned long base_note; 155 unsigned long high_note; 156 unsigned long low_note; 157 int panning; /* -128=left, 127=right */ 158 int detuning; 159 160/* New fields introduced in version 1.99.5 */ 161 162 /* Envelope. Enabled by mode bit WAVE_ENVELOPES */ 163 unsigned char env_rate[ 6 ]; /* GUS HW ramping rate */ 164 unsigned char env_offset[ 6 ]; /* 255 == 100% */ 165 166 /* 167 * The tremolo, vibrato and scale info are not supported yet. 168 * Enable by setting the mode bits WAVE_TREMOLO, WAVE_VIBRATO or 169 * WAVE_SCALE 170 */ 171 172 unsigned char tremolo_sweep; 173 unsigned char tremolo_rate; 174 unsigned char tremolo_depth; 175 176 unsigned char vibrato_sweep; 177 unsigned char vibrato_rate; 178 unsigned char vibrato_depth; 179 180 int scale_frequency; 181 unsigned int scale_factor; /* from 0 to 2048 or 0 to 2 */ 182 183 int volume; 184 int spare[4]; 185 char data[1]; /* The waveform data starts here */ 186 }; 187 188 189struct sysex_info { 190 short key; /* Use GUS_PATCH here */ 191#define SYSEX_PATCH 0x05fd 192 short device_no; /* Synthesizer number */ 193 long len; /* Size of the sysex data in bytes */ 194 unsigned char data[1]; /* Sysex data starts here */ 195 }; 196 197/* 198 * Patch management interface (/dev/sequencer, /dev/patmgr#) 199 * Don't use these calls if you want to maintain compatibility with 200 * the future versions of the driver. 201 */ 202 203#define PS_NO_PATCHES 0 /* No patch support on device */ 204#define PS_MGR_NOT_OK 1 /* Plain patch support (no mgr) */ 205#define PS_MGR_OK 2 /* Patch manager supported */ 206#define PS_MANAGED 3 /* Patch manager running */ 207 208#define SNDCTL_PMGR_IFACE _IOWR('P', 1, struct patmgr_info) 209 210/* 211 * The patmgr_info is a fixed size structure which is used for two 212 * different purposes. The intended use is for communication between 213 * the application using /dev/sequencer and the patch manager daemon 214 * associated with a synthesizer device (ioctl(SNDCTL_PMGR_ACCESS)). 215 * 216 * This structure is also used with ioctl(SNDCTL_PGMR_IFACE) which allows 217 * a patch manager daemon to read and write device parameters. This 218 * ioctl available through /dev/sequencer also. Avoid using it since it's 219 * extremely hardware dependent. In addition access trough /dev/sequencer 220 * may confuse the patch manager daemon. 221 */ 222 223struct patmgr_info { /* Note! size must be < 4k since kmalloc() is used */ 224 unsigned long key; /* Don't worry. Reserved for communication 225 between the patch manager and the driver. */ 226#define PM_K_EVENT 1 /* Event from the /dev/sequencer driver */ 227#define PM_K_COMMAND 2 /* Request from a application */ 228#define PM_K_RESPONSE 3 /* From patmgr to application */ 229#define PM_ERROR 4 /* Error returned by the patmgr */ 230 int device; 231 int command; 232 233/* 234 * Commands 0x000 to 0xfff reserved for patch manager programs 235 */ 236#define PM_GET_DEVTYPE 1 /* Returns type of the patch mgr interface of dev */ 237#define PMTYPE_FM2 1 /* 2 OP fm */ 238#define PMTYPE_FM4 2 /* Mixed 4 or 2 op FM (OPL-3) */ 239#define PMTYPE_WAVE 3 /* Wave table synthesizer (GUS) */ 240#define PM_GET_NRPGM 2 /* Returns max # of midi programs in parm1 */ 241#define PM_GET_PGMMAP 3 /* Returns map of loaded midi programs in data8 */ 242#define PM_GET_PGM_PATCHES 4 /* Return list of patches of a program (parm1) */ 243#define PM_GET_PATCH 5 /* Return patch header of patch parm1 */ 244#define PM_SET_PATCH 6 /* Set patch header of patch parm1 */ 245#define PM_READ_PATCH 7 /* Read patch (wave) data */ 246#define PM_WRITE_PATCH 8 /* Write patch (wave) data */ 247 248/* 249 * Commands 0x1000 to 0xffff are for communication between the patch manager 250 * and the client 251 */ 252#define _PM_LOAD_PATCH 0x100 253 254/* 255 * Commands above 0xffff reserved for device specific use 256 */ 257 258 long parm1; 259 long parm2; 260 long parm3; 261 262 union { 263 unsigned char data8[4000]; 264 unsigned short data16[2000]; 265 unsigned long data32[1000]; 266 struct patch_info patch; 267 } data; 268 }; 269 270/* 271 * When a patch manager daemon is present, it will be informed by the 272 * driver when something important happens. For example when the 273 * /dev/sequencer is opened or closed. A record with key == PM_K_EVENT is 274 * returned. The command field contains the event type: 275 */ 276#define PM_E_OPENED 1 /* /dev/sequencer opened */ 277#define PM_E_CLOSED 2 /* /dev/sequencer closed */ 278#define PM_E_PATCH_RESET 3 /* SNDCTL_RESETSAMPLES called */ 279#define PM_E_PATCH_LOADED 4 /* A patch has been loaded by appl */ 280 281/* 282 * /dev/sequencer input events. 283 * 284 * The data written to the /dev/sequencer is a stream of events. Events 285 * are records of 4 or 8 bytes. The first byte defines the size. 286 * Any number of events can be written with a write call. There 287 * is a set of macros for sending these events. Use these macros if you 288 * want to maximize portability of your program. 289 * 290 * Events SEQ_WAIT, SEQ_MIDIPUTC and SEQ_ECHO. Are also input events. 291 * (All input events are currently 4 bytes long. Be prepared to support 292 * 8 byte events also. If you receive any event having first byte >= 128, 293 * it's a 8 byte event. 294 * 295 * The events are documented at the end of this file. 296 * 297 * Normal events (4 bytes) 298 * There is also a 8 byte version of most of the 4 byte events. The 299 * 8 byte one is recommended. 300 */ 301#define SEQ_NOTEOFF 0 302#define SEQ_FMNOTEOFF SEQ_NOTEOFF /* Just old name */ 303#define SEQ_NOTEON 1 304#define SEQ_FMNOTEON SEQ_NOTEON 305#define SEQ_WAIT TMR_WAIT_ABS 306#define SEQ_PGMCHANGE 3 307#define SEQ_FMPGMCHANGE SEQ_PGMCHANGE 308#define SEQ_SYNCTIMER TMR_START 309#define SEQ_MIDIPUTC 5 310#define SEQ_DRUMON 6 /*** OBSOLETE ***/ 311#define SEQ_DRUMOFF 7 /*** OBSOLETE ***/ 312#define SEQ_ECHO TMR_ECHO /* For synching programs with output */ 313#define SEQ_AFTERTOUCH 9 314#define SEQ_CONTROLLER 10 315 316/******************************************* 317 * Midi controller numbers 318 ******************************************* 319 * Controllers 0 to 31 (0x00 to 0x1f) and 320 * 32 to 63 (0x20 to 0x3f) are continuous 321 * controllers. 322 * In the MIDI 1.0 these controllers are sent using 323 * two messages. Controller numbers 0 to 31 are used 324 * to send the LSB and the controller numbers 32 to 63 325 * are for the LSB. 326 * 327 * This driver uses just the numbers 0 to 31 to store both 328 * the LSB and MSB. The controller value is a unsigned short 329 * and it's valid range is between 0 and 16383 (0x0000 to 0x3fff). 330 * The driver sends the controller value using two messages when 331 * necessary. 332 */ 333 334#define CTL_BANK_SELECT 0x00 335#define CTL_MODWHEEL 0x01 336#define CTL_BREATH 0x02 337/* undefined 0x03 */ 338#define CTL_FOOT 0x04 339#define CTL_PORTAMENTO_TIME 0x05 340#define CTL_DATA_ENTRY 0x06 341#define CTL_MAIN_VOLUME 0x07 342#define CTL_BALANCE 0x08 343/* undefined 0x09 */ 344#define CTL_PAN 0x0a 345#define CTL_EXPRESSION 0x0b 346/* undefined 0x0c */ 347/* undefined 0x0d */ 348/* undefined 0x0e */ 349/* undefined 0x0f */ 350#define CTL_GENERAL_PURPOSE1 0x10 351#define CTL_GENERAL_PURPOSE2 0x11 352#define CTL_GENERAL_PURPOSE3 0x12 353#define CTL_GENERAL_PURPOSE4 0x13 354/* undefined 0x14 - 0x1f */ 355 356/* undefined 0x20 */ 357/* The controller numbers 0x21 to 0x3f are reserved for the */ 358/* least significant bytes of the controllers 0x00 to 0x1f. */ 359/* These controllers are not recognised by the driver. */ 360 361/* Controllers 64 to 69 (0x40 to 0x45) are on/off switches. */ 362/* 0=OFF and 127=ON (intermediate values are possible) */ 363#define CTL_DAMPER_PEDAL 0x40 364#define CTL_SUSTAIN 0x40 /* Alias */ 365#define CTL_HOLD 0x40 /* Alias */ 366#define CTL_PORTAMENTO 0x41 367#define CTL_SOSTENUTO 0x42 368#define CTL_SOFT_PEDAL 0x43 369/* undefined 0x44 */ 370#define CTL_HOLD2 0x45 371/* undefined 0x46 - 0x4f */ 372 373#define CTL_GENERAL_PURPOSE5 0x50 374#define CTL_GENERAL_PURPOSE6 0x51 375#define CTL_GENERAL_PURPOSE7 0x52 376#define CTL_GENERAL_PURPOSE8 0x53 377/* undefined 0x54 - 0x5a */ 378#define CTL_EXT_EFF_DEPTH 0x5b 379#define CTL_TREMOLO_DEPTH 0x5c 380#define CTL_CHORUS_DEPTH 0x5d 381#define CTL_DETUNE_DEPTH 0x5e 382#define CTL_CELESTE_DEPTH 0x5e /* Alias for the above one */ 383#define CTL_PHASER_DEPTH 0x5f 384#define CTL_DATA_INCREMENT 0x60 385#define CTL_DATA_DECREMENT 0x61 386#define CTL_NONREG_PARM_NUM_LSB 0x62 387#define CTL_NONREG_PARM_NUM_MSB 0x63 388#define CTL_REGIST_PARM_NUM_LSB 0x64 389#define CTL_REGIST_PARM_NUM_MSB 0x65 390/* undefined 0x66 - 0x78 */ 391/* reserved 0x79 - 0x7f */ 392 393/* Pseudo controllers (not midi compatible) */ 394#define CTRL_PITCH_BENDER 255 395#define CTRL_PITCH_BENDER_RANGE 254 396#define CTRL_EXPRESSION 253 /* Obsolete */ 397#define CTRL_MAIN_VOLUME 252 /* Obsolete */ 398#define SEQ_BALANCE 11 399#define SEQ_VOLMODE 12 400 401/* 402 * Volume mode decides how volumes are used 403 */ 404 405#define VOL_METHOD_ADAGIO 1 406#define VOL_METHOD_LINEAR 2 407 408/* 409 * Note! SEQ_WAIT, SEQ_MIDIPUTC and SEQ_ECHO are used also as 410 * input events. 411 */ 412 413/* 414 * Event codes 0xf0 to 0xfc are reserved for future extensions. 415 */ 416 417#define SEQ_FULLSIZE 0xfd /* Long events */ 418/* 419 * SEQ_FULLSIZE events are used for loading patches/samples to the 420 * synthesizer devices. These events are passed directly to the driver 421 * of the associated synthesizer device. There is no limit to the size 422 * of the extended events. These events are not queued but executed 423 * immediately when the write() is called (execution can take several 424 * seconds of time). 425 * 426 * When a SEQ_FULLSIZE message is written to the device, it must 427 * be written using exactly one write() call. Other events cannot 428 * be mixed to the same write. 429 * 430 * For FM synths (YM3812/OPL3) use struct sbi_instrument and write it to the 431 * /dev/sequencer. Don't write other data together with the instrument structure 432 * Set the key field of the structure to FM_PATCH. The device field is used to 433 * route the patch to the corresponding device. 434 * 435 * For Gravis UltraSound use struct patch_info. Initialize the key field 436 * to GUS_PATCH. 437 */ 438#define SEQ_PRIVATE 0xfe /* Low level HW dependent events (8 bytes) */ 439#define SEQ_EXTENDED 0xff /* Extended events (8 bytes) OBSOLETE */ 440 441/* 442 * Record for FM patches 443 */ 444 445typedef unsigned char sbi_instr_data[32]; 446 447struct sbi_instrument { 448 unsigned short key; /* Initialize to FM_PATCH or OPL3_PATCH */ 449#define FM_PATCH 0x01fd 450#define OPL3_PATCH 0x03fd 451 short device; /* Synth# (0-4) */ 452 int channel; /* Program# to be initialized */ 453 sbi_instr_data operators; /* Register settings for operator cells (.SBI format) */ 454 }; 455 456struct synth_info { /* Read only */ 457 char name[30]; 458 int device; /* 0-N. INITIALIZE BEFORE CALLING */ 459 int synth_type; 460#define SYNTH_TYPE_FM 0 461#define SYNTH_TYPE_SAMPLE 1 462#define SYNTH_TYPE_MIDI 2 /* Midi interface */ 463 464 int synth_subtype; 465#define FM_TYPE_ADLIB 0x00 466#define FM_TYPE_OPL3 0x01 467 468#define SAMPLE_TYPE_GUS 0x10 469 470 int perc_mode; /* No longer supported */ 471 int nr_voices; 472 int nr_drums; /* Obsolete field */ 473 int instr_bank_size; 474 unsigned long capabilities; 475#define SYNTH_CAP_PERCMODE 0x00000001 /* No longer used */ 476#define SYNTH_CAP_OPL3 0x00000002 /* Set if OPL3 supported */ 477#define SYNTH_CAP_INPUT 0x00000004 /* Input (MIDI) device */ 478 int dummies[19]; /* Reserve space */ 479 }; 480 481struct sound_timer_info { 482 char name[30]; 483 int caps; 484 }; 485 486#define MIDI_CAP_MPU401 1 /* MPU-401 intelligent mode */ 487 488struct midi_info { 489 char name[30]; 490 int device; /* 0-N. INITIALIZE BEFORE CALLING */ 491 unsigned long capabilities; /* To be defined later */ 492 int dev_type; 493 int dummies[18]; /* Reserve space */ 494 }; 495 496/******************************************** 497 * ioctl commands for the /dev/midi## 498 */ 499typedef struct { 500 unsigned char cmd; 501 char nr_args, nr_returns; 502 unsigned char data[30]; 503 } mpu_command_rec; 504 505#define SNDCTL_MIDI_PRETIME _IOWR('m', 0, int) 506#define SNDCTL_MIDI_MPUMODE _IOWR('m', 1, int) 507#define SNDCTL_MIDI_MPUCMD _IOWR('m', 2, mpu_command_rec) 508 509/******************************************** 510 * IOCTL commands for /dev/dsp and /dev/audio 511 */ 512 513#define SNDCTL_DSP_RESET _IO ('P', 0) 514#define SNDCTL_DSP_SYNC _IO ('P', 1) 515#define SNDCTL_DSP_SPEED _IOWR('P', 2, int) 516#define SNDCTL_DSP_STEREO _IOWR('P', 3, int) 517#define SNDCTL_DSP_GETBLKSIZE _IOR('P', 4, int) 518#define SNDCTL_DSP_SAMPLESIZE SNDCTL_DSP_SETFMT 519#define SOUND_PCM_WRITE_CHANNELS _IOWR('P', 6, int) 520#define SOUND_PCM_WRITE_FILTER _IOWR('P', 7, int) 521#define SNDCTL_DSP_POST _IO ('P', 8) 522#define SNDCTL_DSP_SUBDIVIDE _IOWR('P', 9, int) 523#define SNDCTL_DSP_SETFRAGMENT _IOWR('P',10, int) 524#define SNDCTL_DSP_SETBLKSIZE _IOW('P', 4, int) 525 526/* Audio data formats (Note! U8=8 and S16_LE=16 for compatibility) */ 527#define SNDCTL_DSP_GETFMTS _IOR ('P',11, int) /* Returns a mask */ 528#define SNDCTL_DSP_SETFMT _IOWR('P',5, int) /* Selects ONE fmt*/ 529# define AFMT_QUERY 0x00000000 /* Return current fmt */ 530# define AFMT_MU_LAW 0x00000001 531# define AFMT_A_LAW 0x00000002 532# define AFMT_IMA_ADPCM 0x00000004 533# define AFMT_U8 0x00000008 534# define AFMT_S16_LE 0x00000010 /* Little endian signed 16*/ 535# define AFMT_S16_BE 0x00000020 /* Big endian signed 16 */ 536# define AFMT_S8 0x00000040 537# define AFMT_U16_LE 0x00000080 /* Little endian U16 */ 538# define AFMT_U16_BE 0x00000100 /* Big endian U16 */ 539 540#define SOUND_PCM_READ_RATE _IOR ('P', 2, int) 541#define SOUND_PCM_READ_CHANNELS _IOR ('P', 6, int) 542#define SOUND_PCM_READ_BITS _IOR ('P', 5, int) 543#define SOUND_PCM_READ_FILTER _IOR ('P', 7, int) 544 545/* Some alias names */ 546#define SOUND_PCM_WRITE_BITS SNDCTL_DSP_SETFMT 547#define SOUND_PCM_WRITE_RATE SNDCTL_DSP_SPEED 548#define SOUND_PCM_POST SNDCTL_DSP_POST 549#define SOUND_PCM_RESET SNDCTL_DSP_RESET 550#define SOUND_PCM_SYNC SNDCTL_DSP_SYNC 551#define SOUND_PCM_SUBDIVIDE SNDCTL_DSP_SUBDIVIDE 552#define SOUND_PCM_SETFRAGMENT SNDCTL_DSP_SETFRAGMENT 553#define SOUND_PCM_GETFMTS SNDCTL_DSP_GETFMTS 554#define SOUND_PCM_SETFMT SNDCTL_DSP_SETFMT 555#define SOUND_PCM_SETBLKSIZE SNDCTL_DSP_SETBLKSIZE 556 557/********************************************* 558 * IOCTL /dev/pss (experimental PSS API by marc.hoffman@analog.com. 559 * likely to change in near future. 560 */ 561#define SNDCTL_PSS_RESET _IO ('C', 0) 562#define SNDCTL_PSS_SETUP_REGISTERS _IO ('C', 1) 563#define SNDCTL_PSS_SPEAKER _IOW ('C', 2, struct pss_speaker) 564 565struct pss_speaker { 566 int volume; 567 int bass; 568 int treb; 569 int mode; 570}; 571 572/********************************************* 573 * IOCTL commands for /dev/mixer 574 */ 575 576/* 577 * Mixer devices 578 * 579 * There can be up to 20 different analog mixer channels. The 580 * SOUND_MIXER_NRDEVICES gives the currently supported maximum. 581 * The SOUND_MIXER_READ_DEVMASK returns a bitmask which tells 582 * the devices supported by the particular mixer. 583 */ 584 585#define SOUND_MIXER_NRDEVICES 12 586#define SOUND_MIXER_VOLUME 0 587#define SOUND_MIXER_BASS 1 588#define SOUND_MIXER_TREBLE 2 589#define SOUND_MIXER_SYNTH 3 590#define SOUND_MIXER_PCM 4 591#define SOUND_MIXER_SPEAKER 5 592#define SOUND_MIXER_LINE 6 593#define SOUND_MIXER_MIC 7 594#define SOUND_MIXER_CD 8 595#define SOUND_MIXER_IMIX 9 /* Recording monitor */ 596#define SOUND_MIXER_ALTPCM 10 597#define SOUND_MIXER_RECLEV 11 /* Recording level */ 598 599/* Some on/off settings (SOUND_SPECIAL_MIN - SOUND_SPECIAL_MAX) */ 600/* Not counted to SOUND_MIXER_NRDEVICES, but use the same number space */ 601#define SOUND_ONOFF_MIN 28 602#define SOUND_ONOFF_MAX 30 603#define SOUND_MIXER_MUTE 28 /* 0 or 1 */ 604#define SOUND_MIXER_ENHANCE 29 /* Enhanced stereo (0, 40, 60 or 80) */ 605#define SOUND_MIXER_LOUD 30 /* 0 or 1 */ 606 607/* Note! Number 31 cannot be used since the sign bit is reserved */ 608 609#define SOUND_DEVICE_LABELS {"Vol ", "Bass ", "Trebl", "Synth", "Pcm ", "Spkr ", "Line ", \ 610 "Mic ", "CD ", "Mix ", "Pcm2 ", "rec"} 611 612#define SOUND_DEVICE_NAMES {"vol", "bass", "treble", "synth", "pcm", "speaker", "line", \ 613 "mic", "cd", "mix", "pcm2", "rec"} 614 615/* Device bitmask identifiers */ 616 617#define SOUND_MIXER_RECSRC 0xff /* Arg contains a bit for each recording source */ 618#define SOUND_MIXER_DEVMASK 0xfe /* Arg contains a bit for each supported device */ 619#define SOUND_MIXER_RECMASK 0xfd /* Arg contains a bit for each supported recording source */ 620#define SOUND_MIXER_CAPS 0xfc 621 #define SOUND_CAP_EXCL_INPUT 0x00000001 /* Only one recording source at a time */ 622#define SOUND_MIXER_STEREODEVS 0xfb /* Mixer channels supporting stereo */ 623 624/* Device mask bits */ 625 626#define SOUND_MASK_VOLUME (1 << SOUND_MIXER_VOLUME) 627#define SOUND_MASK_BASS (1 << SOUND_MIXER_BASS) 628#define SOUND_MASK_TREBLE (1 << SOUND_MIXER_TREBLE) 629#define SOUND_MASK_SYNTH (1 << SOUND_MIXER_SYNTH) 630#define SOUND_MASK_PCM (1 << SOUND_MIXER_PCM) 631#define SOUND_MASK_SPEAKER (1 << SOUND_MIXER_SPEAKER) 632#define SOUND_MASK_LINE (1 << SOUND_MIXER_LINE) 633#define SOUND_MASK_MIC (1 << SOUND_MIXER_MIC) 634#define SOUND_MASK_CD (1 << SOUND_MIXER_CD) 635#define SOUND_MASK_IMIX (1 << SOUND_MIXER_IMIX) 636#define SOUND_MASK_ALTPCM (1 << SOUND_MIXER_ALTPCM) 637#define SOUND_MASK_RECLEV (1 << SOUND_MIXER_RECLEV) 638 639#define SOUND_MASK_MUTE (1 << SOUND_MIXER_MUTE) 640#define SOUND_MASK_ENHANCE (1 << SOUND_MIXER_ENHANCE) 641#define SOUND_MASK_LOUD (1 << SOUND_MIXER_LOUD) 642 643#define MIXER_READ(dev) _IOR('M', dev, int) 644#define SOUND_MIXER_READ_VOLUME MIXER_READ(SOUND_MIXER_VOLUME) 645#define SOUND_MIXER_READ_BASS MIXER_READ(SOUND_MIXER_BASS) 646#define SOUND_MIXER_READ_TREBLE MIXER_READ(SOUND_MIXER_TREBLE) 647#define SOUND_MIXER_READ_SYNTH MIXER_READ(SOUND_MIXER_SYNTH) 648#define SOUND_MIXER_READ_PCM MIXER_READ(SOUND_MIXER_PCM) 649#define SOUND_MIXER_READ_SPEAKER MIXER_READ(SOUND_MIXER_SPEAKER) 650#define SOUND_MIXER_READ_LINE MIXER_READ(SOUND_MIXER_LINE) 651#define SOUND_MIXER_READ_MIC MIXER_READ(SOUND_MIXER_MIC) 652#define SOUND_MIXER_READ_CD MIXER_READ(SOUND_MIXER_CD) 653#define SOUND_MIXER_READ_IMIX MIXER_READ(SOUND_MIXER_IMIX) 654#define SOUND_MIXER_READ_ALTPCM MIXER_READ(SOUND_MIXER_ALTPCM) 655#define SOUND_MIXER_READ_RECLEV MIXER_READ(SOUND_MIXER_RECLEV) 656#define SOUND_MIXER_READ_MUTE MIXER_READ(SOUND_MIXER_MUTE) 657#define SOUND_MIXER_READ_ENHANCE MIXER_READ(SOUND_MIXER_ENHANCE) 658#define SOUND_MIXER_READ_LOUD MIXER_READ(SOUND_MIXER_LOUD) 659 660#define SOUND_MIXER_READ_RECSRC MIXER_READ(SOUND_MIXER_RECSRC) 661#define SOUND_MIXER_READ_DEVMASK MIXER_READ(SOUND_MIXER_DEVMASK) 662#define SOUND_MIXER_READ_RECMASK MIXER_READ(SOUND_MIXER_RECMASK) 663#define SOUND_MIXER_READ_STEREODEVS MIXER_READ(SOUND_MIXER_STEREODEVS) 664#define SOUND_MIXER_READ_CAPS MIXER_READ(SOUND_MIXER_CAPS) 665 666#define MIXER_WRITE(dev) _IOWR('M', dev, int) 667#define SOUND_MIXER_WRITE_VOLUME MIXER_WRITE(SOUND_MIXER_VOLUME) 668#define SOUND_MIXER_WRITE_BASS MIXER_WRITE(SOUND_MIXER_BASS) 669#define SOUND_MIXER_WRITE_TREBLE MIXER_WRITE(SOUND_MIXER_TREBLE) 670#define SOUND_MIXER_WRITE_SYNTH MIXER_WRITE(SOUND_MIXER_SYNTH) 671#define SOUND_MIXER_WRITE_PCM MIXER_WRITE(SOUND_MIXER_PCM) 672#define SOUND_MIXER_WRITE_SPEAKER MIXER_WRITE(SOUND_MIXER_SPEAKER) 673#define SOUND_MIXER_WRITE_LINE MIXER_WRITE(SOUND_MIXER_LINE) 674#define SOUND_MIXER_WRITE_MIC MIXER_WRITE(SOUND_MIXER_MIC) 675#define SOUND_MIXER_WRITE_CD MIXER_WRITE(SOUND_MIXER_CD) 676#define SOUND_MIXER_WRITE_IMIX MIXER_WRITE(SOUND_MIXER_IMIX) 677#define SOUND_MIXER_WRITE_ALTPCM MIXER_WRITE(SOUND_MIXER_ALTPCM) 678#define SOUND_MIXER_WRITE_RECLEV MIXER_WRITE(SOUND_MIXER_RECLEV) 679#define SOUND_MIXER_WRITE_MUTE MIXER_WRITE(SOUND_MIXER_MUTE) 680#define SOUND_MIXER_WRITE_ENHANCE MIXER_WRITE(SOUND_MIXER_ENHANCE) 681#define SOUND_MIXER_WRITE_LOUD MIXER_WRITE(SOUND_MIXER_LOUD) 682 683#define SOUND_MIXER_WRITE_RECSRC MIXER_WRITE(SOUND_MIXER_RECSRC) 684 685/* 686 * Level 2 event types for /dev/sequencer 687 */ 688 689/* 690 * The 4 most significant bits of byte 0 specify the class of 691 * the event: 692 * 693 * 0x8X = system level events, 694 * 0x9X = device/port specific events, event[1] = device/port, 695 * The last 4 bits give the subtype: 696 * 0x02 = Channel event (event[3] = chn). 697 * 0x01 = note event (event[4] = note). 698 * (0x01 is not used alone but always with bit 0x02). 699 * event[2] = MIDI message code (0x80=note off etc.) 700 * 701 */ 702 703#define EV_SEQ_LOCAL 0x80 704#define EV_TIMING 0x81 705#define EV_CHN_COMMON 0x92 706#define EV_CHN_VOICE 0x93 707/* 708 * Event types 200 to 220 are reserved for application use. 709 * These numbers will not be used by the driver. 710 */ 711 712/* 713 * Events for event type EV_CHN_VOICE 714 */ 715 716#define MIDI_NOTEOFF 0x80 717#define MIDI_NOTEON 0x90 718#define MIDI_KEY_PRESSURE 0xA0 719 720/* 721 * Events for event type EV_CHN_COMMON 722 */ 723 724#define MIDI_CTL_CHANGE 0xB0 725#define MIDI_PGM_CHANGE 0xC0 726#define MIDI_CHN_PRESSURE 0xD0 727#define MIDI_PITCH_BEND 0xE0 728 729#define MIDI_SYSTEM_PREFIX 0xF0 730 731/* 732 * Timer event types 733 */ 734#define TMR_WAIT_REL 1 /* Time relative to the prev time */ 735#define TMR_WAIT_ABS 2 /* Absolute time since TMR_START */ 736#define TMR_STOP 3 737#define TMR_START 4 738#define TMR_CONTINUE 5 739#define TMR_TEMPO 6 740#define TMR_ECHO 8 741#define TMR_CLOCK 9 /* MIDI clock */ 742#define TMR_SPP 10 /* Song position pointer */ 743#define TMR_TIMESIG 11 /* Time signature */ 744 745#if (!defined(__KERNEL__) && !defined(KERNEL) && !defined(INKERNEL) && !defined(_KERNEL)) || defined(USE_SEQ_MACROS) 746/* 747 * Some convenience macros to simplify programming of the 748 * /dev/sequencer interface 749 * 750 * These macros define the API which should be used when possible. 751 */ 752 753#ifndef USE_SIMPLE_MACROS 754void seqbuf_dump(void); /* This function must be provided by programs */ 755 756/* Sample seqbuf_dump() implementation: 757 * 758 * SEQ_DEFINEBUF (2048); -- Defines a buffer for 2048 bytes 759 * 760 * int seqfd; -- The file descriptor for /dev/sequencer. 761 * 762 * void 763 * seqbuf_dump () 764 * { 765 * if (_seqbufptr) 766 * if (write (seqfd, _seqbuf, _seqbufptr) == -1) 767 * { 768 * perror ("write /dev/sequencer"); 769 * exit (-1); 770 * } 771 * _seqbufptr = 0; 772 * } 773 */ 774 775#define SEQ_DEFINEBUF(len) unsigned char _seqbuf[len]; int _seqbuflen = len;int _seqbufptr = 0 776#define SEQ_USE_EXTBUF() extern unsigned char _seqbuf[]; extern int _seqbuflen;extern int _seqbufptr 777#define SEQ_DECLAREBUF() SEQ_USE_EXTBUF() 778#define SEQ_PM_DEFINES struct patmgr_info _pm_info 779#define _SEQ_NEEDBUF(len) if ((_seqbufptr+(len)) > _seqbuflen) seqbuf_dump() 780#define _SEQ_ADVBUF(len) _seqbufptr += len 781#define SEQ_DUMPBUF seqbuf_dump 782#else 783/* 784 * This variation of the sequencer macros is used just to format one event 785 * using fixed buffer. 786 * 787 * The program using the macro library must define the following macros before 788 * using this library. 789 * 790 * #define _seqbuf name of the buffer (unsigned char[]) 791 * #define _SEQ_ADVBUF(len) If the applic needs to know the exact 792 * size of the event, this macro can be used. 793 * Otherwise this must be defined as empty. 794 * #define _seqbufptr Define the name of index variable or 0 if 795 * not required. 796 */ 797#define _SEQ_NEEDBUF(len) /* empty */ 798#endif 799 800#define PM_LOAD_PATCH(dev, bank, pgm) (SEQ_DUMPBUF(), _pm_info.command = _PM_LOAD_PATCH, \ 801 _pm_info.device=dev, _pm_info.data.data8[0]=pgm, \ 802 _pm_info.parm1 = bank, _pm_info.parm2 = 1, \ 803 ioctl(seqfd, SNDCTL_PMGR_ACCESS, &_pm_info)) 804#define PM_LOAD_PATCHES(dev, bank, pgm) (SEQ_DUMPBUF(), _pm_info.command = _PM_LOAD_PATCH, \ 805 _pm_info.device=dev, memcpy(_pm_info.data.data8, pgm, 128), \ 806 _pm_info.parm1 = bank, _pm_info.parm2 = 128, \ 807 ioctl(seqfd, SNDCTL_PMGR_ACCESS, &_pm_info)) 808 809#define SEQ_VOLUME_MODE(dev, mode) {_SEQ_NEEDBUF(8);\ 810 _seqbuf[_seqbufptr] = SEQ_EXTENDED;\ 811 _seqbuf[_seqbufptr+1] = SEQ_VOLMODE;\ 812 _seqbuf[_seqbufptr+2] = (dev);\ 813 _seqbuf[_seqbufptr+3] = (mode);\ 814 _seqbuf[_seqbufptr+4] = 0;\ 815 _seqbuf[_seqbufptr+5] = 0;\ 816 _seqbuf[_seqbufptr+6] = 0;\ 817 _seqbuf[_seqbufptr+7] = 0;\ 818 _SEQ_ADVBUF(8);} 819 820/* 821 * Midi voice messages 822 */ 823 824#define _CHN_VOICE(dev, event, chn, note, parm) \ 825 {_SEQ_NEEDBUF(8);\ 826 _seqbuf[_seqbufptr] = EV_CHN_VOICE;\ 827 _seqbuf[_seqbufptr+1] = (dev);\ 828 _seqbuf[_seqbufptr+2] = (event);\ 829 _seqbuf[_seqbufptr+3] = (chn);\ 830 _seqbuf[_seqbufptr+4] = (note);\ 831 _seqbuf[_seqbufptr+5] = (parm);\ 832 _seqbuf[_seqbufptr+6] = (0);\ 833 _seqbuf[_seqbufptr+7] = 0;\ 834 _SEQ_ADVBUF(8);} 835 836#define SEQ_START_NOTE(dev, chn, note, vol) \ 837 _CHN_VOICE(dev, MIDI_NOTEON, chn, note, vol) 838 839#define SEQ_STOP_NOTE(dev, chn, note, vol) \ 840 _CHN_VOICE(dev, MIDI_NOTEOFF, chn, note, vol) 841 842#define SEQ_KEY_PRESSURE(dev, chn, note, pressure) \ 843 _CHN_VOICE(dev, MIDI_KEY_PRESSURE, chn, note, pressure) 844 845/* 846 * Midi channel messages 847 */ 848 849#define _CHN_COMMON(dev, event, chn, p1, p2, w14) \ 850 {_SEQ_NEEDBUF(8);\ 851 _seqbuf[_seqbufptr] = EV_CHN_COMMON;\ 852 _seqbuf[_seqbufptr+1] = (dev);\ 853 _seqbuf[_seqbufptr+2] = (event);\ 854 _seqbuf[_seqbufptr+3] = (chn);\ 855 _seqbuf[_seqbufptr+4] = (p1);\ 856 _seqbuf[_seqbufptr+5] = (p2);\ 857 *(short *)&_seqbuf[_seqbufptr+6] = (w14);\ 858 _SEQ_ADVBUF(8);} 859 860#define SEQ_CHN_PRESSURE(dev, chn, pressure) \ 861 _CHN_COMMON(dev, MIDI_CHN_PRESSURE, chn, pressure, 0, 0) 862 863#define SEQ_SET_PATCH(dev, chn, patch) \ 864 _CHN_COMMON(dev, MIDI_PGM_CHANGE, chn, patch, 0, 0) 865 866#define SEQ_CONTROL(dev, chn, controller, value) \ 867 _CHN_COMMON(dev, MIDI_CTL_CHANGE, chn, controller, 0, value) 868 869#define SEQ_BENDER(dev, chn, value) \ 870 _CHN_COMMON(dev, MIDI_PITCH_BEND, chn, 0, 0, value) 871 872/* 873 * The following 5 macros are incorrectly implemented and obsolete. 874 * Use SEQ_BENDER and SEQ_CONTROL (with proper controller) instead. 875 */ 876#define SEQ_PITCHBEND(dev, voice, value) SEQ_CONTROL(dev, voice, CTRL_PITCH_BENDER, value) 877#define SEQ_BENDER_RANGE(dev, voice, value) SEQ_CONTROL(dev, voice, CTRL_PITCH_BENDER_RANGE, value) 878#define SEQ_EXPRESSION(dev, voice, value) SEQ_CONTROL(dev, voice, CTL_EXPRESSION, value*128) 879#define SEQ_MAIN_VOLUME(dev, voice, value) SEQ_CONTROL(dev, voice, CTL_MAIN_VOLUME, (value*16383)/100) 880#define SEQ_PANNING(dev, voice, pos) SEQ_CONTROL(dev, voice, CTL_PAN, (pos+128) / 2) 881#if 0 882#define SEQ_PANNING(dev, voice, pos) {_SEQ_NEEDBUF(8);\ 883 _seqbuf[_seqbufptr] = SEQ_EXTENDED;\ 884 _seqbuf[_seqbufptr+1] = SEQ_BALANCE;\ 885 _seqbuf[_seqbufptr+2] = (dev);\ 886 _seqbuf[_seqbufptr+3] = (voice);\ 887 (char)_seqbuf[_seqbufptr+4] = (pos);\ 888 _seqbuf[_seqbufptr+5] = 0;\ 889 _seqbuf[_seqbufptr+6] = 0;\ 890 _seqbuf[_seqbufptr+7] = 1;\ 891 _SEQ_ADVBUF(8);} 892#endif 893 894/* 895 * Timing and syncronization macros 896 */ 897 898#define _TIMER_EVENT(ev, parm) {_SEQ_NEEDBUF(8);\ 899 _seqbuf[_seqbufptr+0] = EV_TIMING; \ 900 _seqbuf[_seqbufptr+1] = (ev); \ 901 _seqbuf[_seqbufptr+2] = 0;\ 902 _seqbuf[_seqbufptr+3] = 0;\ 903 *(unsigned int *)&_seqbuf[_seqbufptr+4] = (parm); \ 904 _SEQ_ADVBUF(8);} 905 906#define SEQ_START_TIMER() _TIMER_EVENT(TMR_START, 0) 907#define SEQ_STOP_TIMER() _TIMER_EVENT(TMR_STOP, 0) 908#define SEQ_CONTINUE_TIMER() _TIMER_EVENT(TMR_CONTINUE, 0) 909#define SEQ_WAIT_TIME(ticks) _TIMER_EVENT(TMR_WAIT_ABS, ticks) 910#define SEQ_DELTA_TIME(ticks) _TIMER_EVENT(TMR_WAIT_REL, ticks) 911#define SEQ_ECHO_BACK(key) _TIMER_EVENT(TMR_ECHO, key) 912#define SEQ_SET_TEMPO(value) _TIMER_EVENT(TMR_TEMPO, value) 913#define SEQ_SONGPOS(pos) _TIMER_EVENT(TMR_SPP, pos) 914#define SEQ_TIME_SIGNATURE(sig) _TIMER_EVENT(TMR_TIMESIG, sig) 915 916/* 917 * Events for the level 1 interface only 918 */ 919 920#define SEQ_MIDIOUT(device, byte) {_SEQ_NEEDBUF(4);\ 921 _seqbuf[_seqbufptr] = SEQ_MIDIPUTC;\ 922 _seqbuf[_seqbufptr+1] = (byte);\ 923 _seqbuf[_seqbufptr+2] = (device);\ 924 _seqbuf[_seqbufptr+3] = 0;\ 925 _SEQ_ADVBUF(4);} 926 927/* 928 * Patch loading. 929 */ 930#define SEQ_WRPATCH(patchx, len) {if (_seqbufptr) seqbuf_dump();\ 931 if (write(seqfd, (char*)(patchx), len)==-1) \ 932 perror("Write patch: /dev/sequencer");} 933#define SEQ_WRPATCH2(patchx, len) (seqbuf_dump(), write(seqfd, (char*)(patchx), len)) 934 935#endif /* !_KERNEL_SPAM */ 936 937#endif /* !_MACHINE_SOUNDCARD_H_ */ 938