sys/sys/soundcard.h

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