source: cmedia/trunk/Drv16/fmadlib.h

/* SCCSID = %W% %E% */
/****************************************************************************
 *                                                                          *
 * Copyright (c) IBM Corporation 1994 - 1997.                               *
 * Copyright (c) Voyetra Technologies 1990-1993.  All rights reserved       *
 *                                                                          *
 * The following IBM OS/2 source code is provided to you solely for the     *
 * the purpose of assisting you in your development of OS/2 device drivers. *
 * You may use this code in accordance with the IBM License Agreement       *
 * provided in the IBM Device Driver Source Kit for OS/2.                   *
 *                                                                          *
 ****************************************************************************/
/**@internal %W%
 *  General purpose #define's for FMSYNTH.
 * @version %I%
 * @context
 *  Unless otherwise noted, all interfaces are Ring-0, 16-bit, kernel stack.
 * @notes
 * @history
 */

#ifndef ADLIB_INCLUDED
#define ADLIB_INCLUDED

#define MAX_NUMBER_OF_OPERATORS 14                      // 6 vx, 5 drum, 3 2op
#define MAX_NUMBER_OF_VOICES    14
#define NUMBER_OF_CHANNELS      16
#define NUMBER_OF_BUILT_IN_VOICES       128
#define DEF_PERCUSSION_CHANNEL  (16-1)
#define PERCUSSION_CHANNEL      percussion_channel
#define DEF_PERC_MODE           1
#define MIN_PGM_FOR_CTRL        126

#define BD              (6 + 3)
#define SD              (7 + 3)
#define TOM             (8 + 3)
#define CYMB            (9 + 3)
#define HIHAT           (10 +3)

#define DRUM_PATCH_OFFSET       128

/* long cur_bender[] is calc-ed so that 2048 * NR_STEP_PITCH is one half step */
#define NR_STEP_PITCH   25                      /* 25 steps within a half-tone for pitch bend */

/* Parameters of each voice: */
#define nbLocParam              5
#define OLD_LOC_PARAM           14

#define prmKsl                  1
#define prmLevel                1
#define prmWaveSel              4                       /* wave select */
#define prmFm                   4
#define prmFeedBack             prmFm                   /* use for opr. 0 only */

#define MAX_VOLUME              0x7f
#define MAX_PITCH               0x3fff
#define MID_PITCH               0x2000

#define MID_C                   60                      /* MIDI standard mid C */
#define CHIP_MID_C              48                      /* sound chip mid C */
#define NR_NOTES                96                      /* # of notes we can play on chip */

#define MAX_MELO_MODE_VX        5               // 0..8
#define MAX_PERC_MODE_VX        5               // 0..5

#define NUM_SLOTS_CHIP          36                      /* OPL3 looks like 2 ADLIB chips */
#define NUMBER_OF_OPERATORS_CHIP        6
#define NUM_SLOTS_HALF  18

#define MODE_MELO               0                       // 9 VX MELODIC MODE (MAY BE STEREO)
#define MODE_PERC               1                       // PERC MODE

#define TOT_SLOTS               (NUM_SLOTS_CHIP)                /* number of raw voice slots on card */

/**************** MISC DEFINED FOR FM CHIPS *****************/
#define MY_BEST_BD_PITCH                CHIP_MID_C

#define PATCH_NAME_LEN                  16
#define PATCH_PAD_LEN                   4
#define EXTRA_DATA_LENGTH               0
#define PATCH_LENGTH                    (4 * nbLocParam + EXTRA_DATA_LENGTH)
#define OLD_PATCH_LENGTH                (4 * OLD_LOC_PARAM + PATCH_NAME_LEN + PATCH_PAD_LEN)


/*********** CHANNEL_ENTRY STRUCTURE *******************/
/*********** USED TO KEEP TRACK OF A MIDI CHANNEL ******/

typedef struct
    {
    char        program;        // Last MIDI program change received on this channel
                                // Tells what timbre to use with next notes played on this channel
    char        volume;         // Last MIDI volume message.
    unsigned    bender;         // Last pitch bend message.  Used to determine note pitches
    char pan;                   // Last MIDI pan message value
    char sus_pedal;             // Current state of the Damper (sustenuto) pedal
    } CHANNEL_ENTRY;

/********* VOICE_STATUS_ENTRY STRUCTURE *******************/
/* NOTE: in this case, a voice is:
 *      a 4 op combination in the 2 op driver
 */
typedef struct
    {
    BYTE        cur_pitch;      // pitch, in midi note number, of this voice
    BYTE        cur_chan;       // midi channel that triggered this voice.
                                //  this is used often, especially by for_all_ops_on_channel,
                                //  when you need to do something on a channel basis.
    } VOICE_STATUS_ENTRY;


/********* STRUCTURE DEFINES FOR VOICE ALLOCATION FUNCTIONS **********/

/* OFF_ENTRY STRUCTURE
 *
 * used to make pseudo linked lists from arrays
 * these pseudo lists are character arrays where the character is
 * the next array position in the list.  There is no data stored
 * in the list, as the array position is the data.
 */
typedef struct
    {
    signed char next;
    }  OFF_ENTRY;

typedef struct
    {
    int freelist;
    int usedlist;
    int usedcount;
    int lastused;
    OFF_ENTRY * data;
    VOICE_STATUS_ENTRY * op_stats;
    } ALLOC_Q, near * NPALLOC_Q;

/***************** DERIVE DEFINE FROM DRUM_PATCH_LEN *************/

#define DRUM_PATCH_LEN  (2 * nbLocParam)

// Constants used by for_all_ops_on_chan() to select function.
#define ID_do_handle_pitch_bend 1
#define ID_shut_off_chan_voice 2
#define ID_do_sus_off 3

#endif  // ADLIB_INCLUDED