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

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