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