xref: /qemu/hw/audio/fmopl.h (revision 2004429e9bf458b6415df497c19847cb4d27844c)
1 #ifndef FMOPL_H
2 #define FMOPL_H
3 
4 /* --- select emulation chips --- */
5 #define BUILD_YM3812 (HAS_YM3812)
6 
7 /* --- system optimize --- */
8 /* select bit size of output : 8 or 16 */
9 #define OPL_OUTPUT_BIT 16
10 
11 /* compiler dependence */
12 #ifndef OSD_CPU_H
13 #define OSD_CPU_H
14 typedef unsigned char	UINT8;   /* unsigned  8bit */
15 typedef unsigned short	UINT16;  /* unsigned 16bit */
16 typedef unsigned int	UINT32;  /* unsigned 32bit */
17 typedef signed char		INT8;    /* signed  8bit   */
18 typedef signed short	INT16;   /* signed 16bit   */
19 typedef signed int		INT32;   /* signed 32bit   */
20 #endif
21 
22 #if (OPL_OUTPUT_BIT==16)
23 typedef INT16 OPLSAMPLE;
24 #endif
25 #if (OPL_OUTPUT_BIT==8)
26 typedef unsigned char  OPLSAMPLE;
27 #endif
28 
29 typedef void (*OPL_TIMERHANDLER)(int channel,double interval_Sec);
30 typedef void (*OPL_IRQHANDLER)(int param,int irq);
31 typedef void (*OPL_UPDATEHANDLER)(int param,int min_interval_us);
32 typedef void (*OPL_PORTHANDLER_W)(int param,unsigned char data);
33 typedef unsigned char (*OPL_PORTHANDLER_R)(int param);
34 
35 /* !!!!! here is private section , do not access there member direct !!!!! */
36 
37 #define OPL_TYPE_WAVESEL   0x01  /* waveform select    */
38 #define OPL_TYPE_ADPCM     0x02  /* DELTA-T ADPCM unit */
39 #define OPL_TYPE_KEYBOARD  0x04  /* keyboard interface */
40 #define OPL_TYPE_IO        0x08  /* I/O port */
41 
42 /* Saving is necessary for member of the 'R' mark for suspend/resume */
43 /* ---------- OPL one of slot  ---------- */
44 typedef struct fm_opl_slot {
45 	INT32 TL;		/* total level     :TL << 8            */
46 	INT32 TLL;		/* adjusted now TL                     */
47 	UINT8  KSR;		/* key scale rate  :(shift down bit)   */
48 	INT32 *AR;		/* attack rate     :&AR_TABLE[AR<<2]   */
49 	INT32 *DR;		/* decay rate      :&DR_TALBE[DR<<2]   */
50 	INT32 SL;		/* sustin level    :SL_TALBE[SL]       */
51 	INT32 *RR;		/* release rate    :&DR_TABLE[RR<<2]   */
52 	UINT8 ksl;		/* keyscale level  :(shift down bits)  */
53 	UINT8 ksr;		/* key scale rate  :kcode>>KSR         */
54 	UINT32 mul;		/* multiple        :ML_TABLE[ML]       */
55 	UINT32 Cnt;		/* frequency count :                   */
56 	UINT32 Incr;	/* frequency step  :                   */
57 	/* envelope generator state */
58 	UINT8 eg_typ;	/* envelope type flag                  */
59 	UINT8 evm;		/* envelope phase                      */
60 	INT32 evc;		/* envelope counter                    */
61 	INT32 eve;		/* envelope counter end point          */
62 	INT32 evs;		/* envelope counter step               */
63 	INT32 evsa;	/* envelope step for AR :AR[ksr]           */
64 	INT32 evsd;	/* envelope step for DR :DR[ksr]           */
65 	INT32 evsr;	/* envelope step for RR :RR[ksr]           */
66 	/* LFO */
67 	UINT8 ams;		/* ams flag                            */
68 	UINT8 vib;		/* vibrate flag                        */
69 	/* wave selector */
70 	INT32 **wavetable;
71 }OPL_SLOT;
72 
73 /* ---------- OPL one of channel  ---------- */
74 typedef struct fm_opl_channel {
75 	OPL_SLOT SLOT[2];
76 	UINT8 CON;			/* connection type                     */
77 	UINT8 FB;			/* feed back       :(shift down bit)   */
78 	INT32 *connect1;	/* slot1 output pointer                */
79 	INT32 *connect2;	/* slot2 output pointer                */
80 	INT32 op1_out[2];	/* slot1 output for selfeedback        */
81 	/* phase generator state */
82 	UINT32  block_fnum;	/* block+fnum      :                   */
83 	UINT8 kcode;		/* key code        : KeyScaleCode      */
84 	UINT32  fc;			/* Freq. Increment base                */
85 	UINT32  ksl_base;	/* KeyScaleLevel Base step             */
86 	UINT8 keyon;		/* key on/off flag                     */
87 } OPL_CH;
88 
89 /* OPL state */
90 typedef struct fm_opl_f {
91 	UINT8 type;			/* chip type                         */
92 	int clock;			/* master clock  (Hz)                */
93 	int rate;			/* sampling rate (Hz)                */
94 	double freqbase;	/* frequency base                    */
95 	double TimerBase;	/* Timer base time (==sampling time) */
96 	UINT8 address;		/* address register                  */
97 	UINT8 status;		/* status flag                       */
98 	UINT8 statusmask;	/* status mask                       */
99 	UINT32 mode;		/* Reg.08 : CSM , notesel,etc.       */
100 	/* Timer */
101 	int T[2];			/* timer counter                     */
102 	UINT8 st[2];		/* timer enable                      */
103 	/* FM channel slots */
104 	OPL_CH *P_CH;		/* pointer of CH                     */
105 	int	max_ch;			/* maximum channel                   */
106 	/* Rhythm sention */
107 	UINT8 rhythm;		/* Rhythm mode , key flag */
108 	OPL_PORTHANDLER_R porthandler_r;
109 	OPL_PORTHANDLER_W porthandler_w;
110 	int port_param;
111 	OPL_PORTHANDLER_R keyboardhandler_r;
112 	OPL_PORTHANDLER_W keyboardhandler_w;
113 	int keyboard_param;
114 	/* time tables */
115 	INT32 AR_TABLE[75];	/* atttack rate tables */
116 	INT32 DR_TABLE[75];	/* decay rate tables   */
117 	UINT32 FN_TABLE[1024];  /* fnumber -> increment counter */
118 	/* LFO */
119 	INT32 *ams_table;
120 	INT32 *vib_table;
121 	INT32 amsCnt;
122 	INT32 amsIncr;
123 	INT32 vibCnt;
124 	INT32 vibIncr;
125 	/* wave selector enable flag */
126 	UINT8 wavesel;
127 	/* external event callback handler */
128 	OPL_TIMERHANDLER  TimerHandler;		/* TIMER handler   */
129 	int TimerParam;						/* TIMER parameter */
130 	OPL_IRQHANDLER    IRQHandler;		/* IRQ handler    */
131 	int IRQParam;						/* IRQ parameter  */
132 	OPL_UPDATEHANDLER UpdateHandler;	/* stream update handler   */
133 	int UpdateParam;					/* stream update parameter */
134 } FM_OPL;
135 
136 /* ---------- Generic interface section ---------- */
137 #define OPL_TYPE_YM3812 (OPL_TYPE_WAVESEL)
138 
139 FM_OPL *OPLCreate(int type, int clock, int rate);
140 void OPLDestroy(FM_OPL *OPL);
141 void OPLSetTimerHandler(FM_OPL *OPL,OPL_TIMERHANDLER TimerHandler,int channelOffset);
142 void OPLSetIRQHandler(FM_OPL *OPL,OPL_IRQHANDLER IRQHandler,int param);
143 void OPLSetUpdateHandler(FM_OPL *OPL,OPL_UPDATEHANDLER UpdateHandler,int param);
144 
145 void OPLResetChip(FM_OPL *OPL);
146 int OPLWrite(FM_OPL *OPL,int a,int v);
147 unsigned char OPLRead(FM_OPL *OPL,int a);
148 int OPLTimerOver(FM_OPL *OPL,int c);
149 
150 /* YM3626/YM3812 local section */
151 void YM3812UpdateOne(FM_OPL *OPL, INT16 *buffer, int length);
152 #endif
153