root/include/linux/soundcard.h

/* [previous][next][first][last][top][bottom][index][help] */

INCLUDED FROM


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

/* [previous][next][first][last][top][bottom][index][help] */