[picodrive.git] / pico / sound / ym2612.h

/*\r
  header file for software emulation for FM sound generator\r
\r
*/\r
#ifndef _H_FM_FM_\r
#define _H_FM_FM_\r
\r
#include <stdlib.h>\r
\r
#define DAC_SHIFT 6\r
\r
/* compiler dependence */\r
#include "../pico_types.h"\r
#ifndef UINT8\r
typedef u8		UINT8;   /* unsigned  8bit */\r
typedef u16		UINT16;  /* unsigned 16bit */\r
typedef u32		UINT32;  /* unsigned 32bit */\r
#endif\r
#ifndef INT8\r
typedef s8		INT8;    /* signed  8bit   */\r
typedef s16		INT16;   /* signed 16bit   */\r
typedef s32		INT32;   /* signed 32bit   */\r
#endif\r
\r
#if 1\r
/* struct describing a single operator (SLOT) */\r
typedef struct\r
{\r
	INT32	*DT;		/* #0x00 detune          :dt_tab[DT] */\r
	UINT8	ar;		/* #0x04 attack rate  */\r
	UINT8	d1r;		/* #0x05 decay rate   */\r
	UINT8	d2r;		/* #0x06 sustain rate */\r
	UINT8	rr;		/* #0x07 release rate */\r
	UINT32	mul;		/* #0x08 multiple        :ML_TABLE[ML] */\r
\r
	/* Phase Generator */\r
	UINT32	phase;		/* #0x0c phase counter | need_save */\r
	UINT32	Incr;		/* #0x10 phase step */\r
\r
	UINT8	KSR;		/* #0x14 key scale rate  :3-KSR */\r
	UINT8	ksr;		/* #0x15 key scale rate  :kcode>>(3-KSR) */\r
\r
	UINT8	key;		/* #0x16 0=last key was KEY OFF, 1=KEY ON */\r
\r
	/* Envelope Generator */\r
	UINT8	state;		/* #0x17 phase type: EG_OFF=0, EG_REL, EG_SUS, EG_DEC, EG_ATT | need_save */\r
	UINT16	tl;		/* #0x18 total level: TL << 3 */\r
	INT16	volume;		/* #0x1a envelope counter | need_save */\r
	UINT32	sl;		/* #0x1c sustain level:sl_table[SL] */\r
\r
	/* asm relies on this order: */\r
	union {\r
		struct {\r
			UINT32 eg_pack_rr;  /* #0x20 1 (release state) */\r
			UINT32 eg_pack_d2r; /* #0x24 2 (sustain state) */\r
			UINT32 eg_pack_d1r; /* #0x28 3 (decay state) */\r
			UINT32 eg_pack_ar;  /* #0x2c 4 (attack state) */\r
		};\r
		UINT32 eg_pack[4];\r
	};\r
\r
	UINT8	ssg;		/* 0x30 SSG-EG waveform */\r
	UINT8	ssgn;\r
	UINT16	ar_ksr;		/* 0x32 ar+ksr */\r
	UINT16	vol_out;	/* 0x34 current output from EG (without LFO) */\r
	UINT16	pad;\r
} FM_SLOT;\r
\r
\r
typedef struct\r
{\r
	FM_SLOT	SLOT[4];	/* four SLOTs (operators) */\r
\r
	UINT8	ALGO;		/* +00 algorithm */\r
	UINT8	FB;		/* feedback shift */\r
	UINT8	pad[2];\r
	INT32	op1_out;	/* op1 output for feedback */\r
\r
	INT32	mem_value;	/* +08 delayed sample (MEM) value */\r
\r
	INT32	pms;		/* channel PMS */\r
	UINT8	ams;		/* channel AMS */\r
\r
	UINT8	kcode;		/* +11 key code:                        */\r
	UINT8	pad2;\r
	UINT8	upd_cnt;	/* eg update counter */\r
	UINT32	fc;		/* fnum,blk:adjusted to sample rate */\r
	UINT32	block_fnum;	/* current blk/fnum value for this slot (can be different betweeen slots of one channel in 3slot mode) */\r
\r
	/* LFO */\r
	UINT8	AMmasks;	/* AM enable flag */\r
	UINT8	pad3[3];\r
} FM_CH;\r
\r
typedef struct\r
{\r
	int		clock;		/* master clock  (Hz)   */\r
	int		rate;		/* sampling rate (Hz)   */\r
	double	freqbase;	/* 08 frequency base       */\r
	UINT8	address;	/* 10 address register | need_save     */\r
	UINT8	status;		/* 11 status flag | need_save          */\r
	UINT8	mode;		/* mode  CSM / 3SLOT    */\r
	UINT8	flags;		/* operational flags	*/\r
	int		TA;			/* timer a              */\r
	//int		TAC;		/* timer a maxval       */\r
	//int		TAT;		/* timer a ticker | need_save */\r
	UINT8	TB;			/* timer b              */\r
	UINT8   fn_h;		/* freq latch           */\r
	UINT8	pad2[2];\r
	//int		TBC;		/* timer b maxval       */\r
	//int		TBT;		/* timer b ticker | need_save */\r
	/* local time tables */\r
	INT32	dt_tab[8][32];/* DeTune table       */\r
} FM_ST;\r
\r
#define ST_SSG		1\r
#define ST_DAC		2\r
\r
/***********************************************************/\r
/* OPN unit                                                */\r
/***********************************************************/\r
\r
/* OPN 3slot struct */\r
typedef struct\r
{\r
	UINT32  fc[3];			/* fnum3,blk3: calculated */\r
	UINT8	fn_h;			/* freq3 latch */\r
	UINT8	kcode[3];		/* key code */\r
	UINT32	block_fnum[3];	/* current fnum value for this slot (can be different betweeen slots of one channel in 3slot mode) */\r
} FM_3SLOT;\r
\r
/* OPN/A/B common state */\r
typedef struct\r
{\r
	FM_ST	ST;				/* general state */\r
	FM_3SLOT SL3;			/* 3 slot mode state */\r
	UINT32  pan;			/* fm channels output mask (bit 1 = enable) */\r
\r
	UINT32	eg_cnt;			/* global envelope generator counter | need_save */\r
	UINT32	eg_timer;		/* global envelope generator counter works at frequency = chipclock/64/3 | need_save */\r
	UINT32	eg_timer_add;		/* step of eg_timer */\r
\r
	/* LFO */\r
	UINT32	lfo_cnt;		/* need_save */\r
	UINT32	lfo_inc;\r
	UINT32  lfo_ampm;\r
\r
	UINT32	lfo_freq[8];	/* LFO FREQ table */\r
} FM_OPN;\r
\r
/* here's the virtual YM2612 */\r
typedef struct\r
{\r
	UINT8		REGS[0x200];			/* registers (for old save states) */\r
	INT32		addr_A1;			/* address line A1 | need_save       */\r
\r
	FM_CH		CH[6];				/* channel state */\r
\r
	/* dac output (YM2612) */\r
	int		dacen;\r
	INT32		dacout;\r
\r
	FM_OPN		OPN;				/* OPN state            */\r
\r
	UINT32		slot_mask;			/* active slot mask (performance hack) */\r
	UINT32		ssg_mask;			/* active ssg mask (performance hack) */\r
} YM2612;\r
#endif\r
\r
#ifndef EXTERNAL_YM2612\r
extern YM2612 ym2612;\r
#endif\r
\r
void YM2612Init_(int baseclock, int rate, int flags);\r
void YM2612ResetChip_(void);\r
int  YM2612UpdateOne_(s32 *buffer, int length, int stereo, int is_buf_empty);\r
\r
int  YM2612Write_(unsigned int a, unsigned int v);\r
//unsigned char YM2612Read_(void);\r
\r
int  YM2612PicoTick_(int n);\r
void YM2612PicoStateLoad_(void);\r
\r
void *YM2612GetRegs(void);\r
int  YM2612PicoStateLoad2(int *tat, int *tbt, int *busy);\r
void YM2612PicoStateSave2(int tat, int tbt, int busy);\r
size_t YM2612PicoStateSave3(void *buf_, size_t size);\r
void   YM2612PicoStateLoad3(const void *buf_, size_t size);\r
\r
/* NB must be macros for compiling GP2X 940 code */\r
#ifndef __GP2X__\r
#define YM2612Init          YM2612Init_\r
#define YM2612ResetChip     YM2612ResetChip_\r
#define YM2612UpdateOne     YM2612UpdateOne_\r
#define YM2612PicoStateLoad YM2612PicoStateLoad_\r
#else\r
/* GP2X specific */\r
#include <platform/gp2x/940ctl.h>\r
#define YM2612Init(baseclock, rate, flags) \\r
	(PicoIn.opt & POPT_EXT_FM ? YM2612Init_940 : YM2612Init_)(baseclock, rate, flags)\r
#define YM2612ResetChip() \\r
	(PicoIn.opt & POPT_EXT_FM ? YM2612ResetChip_940 : YM2612ResetChip_)()\r
#define YM2612PicoStateLoad() \\r
	(PicoIn.opt & POPT_EXT_FM ? YM2612PicoStateLoad_940 : YM2612PicoStateLoad_)()\r
#define YM2612UpdateOne(buffer, length, sterao, isempty) \\r
	(PicoIn.opt & POPT_EXT_FM ? YM2612UpdateOne_940 : YM2612UpdateOne_)(buffer, length, stereo, isempty)\r
#endif /* __GP2X__ */\r
\r
\r
#endif /* _H_FM_FM_ */\r
Commit	Line	Data
	1	/*\r
	2	header file for software emulation for FM sound generator\r
	3	\r
	4	*/\r
	5	#ifndef _H_FM_FM_\r
	6	#define _H_FM_FM_\r
	7	\r
	8	#include <stdlib.h>\r
	9	\r
	10	#define DAC_SHIFT 6\r
	11	\r
	12	/* compiler dependence */\r
	13	#include "../pico_types.h"\r
	14	#ifndef UINT8\r
	15	typedef u8 UINT8; /* unsigned 8bit */\r
	16	typedef u16 UINT16; /* unsigned 16bit */\r
	17	typedef u32 UINT32; /* unsigned 32bit */\r
	18	#endif\r
	19	#ifndef INT8\r
	20	typedef s8 INT8; /* signed 8bit */\r
	21	typedef s16 INT16; /* signed 16bit */\r
	22	typedef s32 INT32; /* signed 32bit */\r
	23	#endif\r
	24	\r
	25	#if 1\r
	26	/* struct describing a single operator (SLOT) */\r
	27	typedef struct\r
	28	{\r
	29	INT32 DT; / #0x00 detune :dt_tab[DT] */\r
	30	UINT8 ar; /* #0x04 attack rate */\r
	31	UINT8 d1r; /* #0x05 decay rate */\r
	32	UINT8 d2r; /* #0x06 sustain rate */\r
	33	UINT8 rr; /* #0x07 release rate */\r
	34	UINT32 mul; /* #0x08 multiple :ML_TABLE[ML] */\r
	35	\r
	36	/* Phase Generator */\r
	37	UINT32 phase; /* #0x0c phase counter \| need_save */\r
	38	UINT32 Incr; /* #0x10 phase step */\r
	39	\r
	40	UINT8 KSR; /* #0x14 key scale rate :3-KSR */\r
	41	UINT8 ksr; /* #0x15 key scale rate :kcode>>(3-KSR) */\r
	42	\r
	43	UINT8 key; /* #0x16 0=last key was KEY OFF, 1=KEY ON */\r
	44	\r
	45	/* Envelope Generator */\r
	46	UINT8 state; /* #0x17 phase type: EG_OFF=0, EG_REL, EG_SUS, EG_DEC, EG_ATT \| need_save */\r
	47	UINT16 tl; /* #0x18 total level: TL << 3 */\r
	48	INT16 volume; /* #0x1a envelope counter \| need_save */\r
	49	UINT32 sl; /* #0x1c sustain level:sl_table[SL] */\r
	50	\r
	51	/* asm relies on this order: */\r
	52	union {\r
	53	struct {\r
	54	UINT32 eg_pack_rr; /* #0x20 1 (release state) */\r
	55	UINT32 eg_pack_d2r; /* #0x24 2 (sustain state) */\r
	56	UINT32 eg_pack_d1r; /* #0x28 3 (decay state) */\r
	57	UINT32 eg_pack_ar; /* #0x2c 4 (attack state) */\r
	58	};\r
	59	UINT32 eg_pack[4];\r
	60	};\r
	61	\r
	62	UINT8 ssg; /* 0x30 SSG-EG waveform */\r
	63	UINT8 ssgn;\r
	64	UINT16 ar_ksr; /* 0x32 ar+ksr */\r
	65	UINT16 vol_out; /* 0x34 current output from EG (without LFO) */\r
	66	UINT16 pad;\r
	67	} FM_SLOT;\r
	68	\r
	69	\r
	70	typedef struct\r
	71	{\r
	72	FM_SLOT SLOT[4]; /* four SLOTs (operators) */\r
	73	\r
	74	UINT8 ALGO; /* +00 algorithm */\r
	75	UINT8 FB; /* feedback shift */\r
	76	UINT8 pad[2];\r
	77	INT32 op1_out; /* op1 output for feedback */\r
	78	\r
	79	INT32 mem_value; /* +08 delayed sample (MEM) value */\r
	80	\r
	81	INT32 pms; /* channel PMS */\r
	82	UINT8 ams; /* channel AMS */\r
	83	\r
	84	UINT8 kcode; /* +11 key code: */\r
	85	UINT8 pad2;\r
	86	UINT8 upd_cnt; /* eg update counter */\r
	87	UINT32 fc; /* fnum,blk:adjusted to sample rate */\r
	88	UINT32 block_fnum; /* current blk/fnum value for this slot (can be different betweeen slots of one channel in 3slot mode) */\r
	89	\r
	90	/* LFO */\r
	91	UINT8 AMmasks; /* AM enable flag */\r
	92	UINT8 pad3[3];\r
	93	} FM_CH;\r
	94	\r
	95	typedef struct\r
	96	{\r
	97	int clock; /* master clock (Hz) */\r
	98	int rate; /* sampling rate (Hz) */\r
	99	double freqbase; /* 08 frequency base */\r
	100	UINT8 address; /* 10 address register \| need_save */\r
	101	UINT8 status; /* 11 status flag \| need_save */\r
	102	UINT8 mode; /* mode CSM / 3SLOT */\r
	103	UINT8 flags; /* operational flags */\r
	104	int TA; /* timer a */\r
	105	//int TAC; /* timer a maxval */\r
	106	//int TAT; /* timer a ticker \| need_save */\r
	107	UINT8 TB; /* timer b */\r
	108	UINT8 fn_h; /* freq latch */\r
	109	UINT8 pad2[2];\r
	110	//int TBC; /* timer b maxval */\r
	111	//int TBT; /* timer b ticker \| need_save */\r
	112	/* local time tables */\r
	113	INT32 dt_tab[8][32];/* DeTune table */\r
	114	} FM_ST;\r
	115	\r
	116	#define ST_SSG 1\r
	117	#define ST_DAC 2\r
	118	\r
	119	/***********************************************************/\r
	120	/* OPN unit */\r
	121	/***********************************************************/\r
	122	\r
	123	/* OPN 3slot struct */\r
	124	typedef struct\r
	125	{\r
	126	UINT32 fc[3]; /* fnum3,blk3: calculated */\r
	127	UINT8 fn_h; /* freq3 latch */\r
	128	UINT8 kcode[3]; /* key code */\r
	129	UINT32 block_fnum[3]; /* current fnum value for this slot (can be different betweeen slots of one channel in 3slot mode) */\r
	130	} FM_3SLOT;\r
	131	\r
	132	/* OPN/A/B common state */\r
	133	typedef struct\r
	134	{\r
	135	FM_ST ST; /* general state */\r
	136	FM_3SLOT SL3; /* 3 slot mode state */\r
	137	UINT32 pan; /* fm channels output mask (bit 1 = enable) */\r
	138	\r
	139	UINT32 eg_cnt; /* global envelope generator counter \| need_save */\r
	140	UINT32 eg_timer; /* global envelope generator counter works at frequency = chipclock/64/3 \| need_save */\r
	141	UINT32 eg_timer_add; /* step of eg_timer */\r
	142	\r
	143	/* LFO */\r
	144	UINT32 lfo_cnt; /* need_save */\r
	145	UINT32 lfo_inc;\r
	146	UINT32 lfo_ampm;\r
	147	\r
	148	UINT32 lfo_freq[8]; /* LFO FREQ table */\r
	149	} FM_OPN;\r
	150	\r
	151	/* here's the virtual YM2612 */\r
	152	typedef struct\r
	153	{\r
	154	UINT8 REGS[0x200]; /* registers (for old save states) */\r
	155	INT32 addr_A1; /* address line A1 \| need_save */\r
	156	\r
	157	FM_CH CH[6]; /* channel state */\r
	158	\r
	159	/* dac output (YM2612) */\r
	160	int dacen;\r
	161	INT32 dacout;\r
	162	\r
	163	FM_OPN OPN; /* OPN state */\r
	164	\r
	165	UINT32 slot_mask; /* active slot mask (performance hack) */\r
	166	UINT32 ssg_mask; /* active ssg mask (performance hack) */\r
	167	} YM2612;\r
	168	#endif\r
	169	\r
	170	#ifndef EXTERNAL_YM2612\r
	171	extern YM2612 ym2612;\r
	172	#endif\r
	173	\r
	174	void YM2612Init_(int baseclock, int rate, int flags);\r
	175	void YM2612ResetChip_(void);\r
	176	int YM2612UpdateOne_(s32 *buffer, int length, int stereo, int is_buf_empty);\r
	177	\r
	178	int YM2612Write_(unsigned int a, unsigned int v);\r
	179	//unsigned char YM2612Read_(void);\r
	180	\r
	181	int YM2612PicoTick_(int n);\r
	182	void YM2612PicoStateLoad_(void);\r
	183	\r
	184	void *YM2612GetRegs(void);\r
	185	int YM2612PicoStateLoad2(int tat, int tbt, int *busy);\r
	186	void YM2612PicoStateSave2(int tat, int tbt, int busy);\r
	187	size_t YM2612PicoStateSave3(void *buf_, size_t size);\r
	188	void YM2612PicoStateLoad3(const void *buf_, size_t size);\r
	189	\r
	190	/* NB must be macros for compiling GP2X 940 code */\r
	191	#ifndef __GP2X__\r
	192	#define YM2612Init YM2612Init_\r
	193	#define YM2612ResetChip YM2612ResetChip_\r
	194	#define YM2612UpdateOne YM2612UpdateOne_\r
	195	#define YM2612PicoStateLoad YM2612PicoStateLoad_\r
	196	#else\r
	197	/* GP2X specific */\r
	198	#include <platform/gp2x/940ctl.h>\r
	199	#define YM2612Init(baseclock, rate, flags) \\r
	200	(PicoIn.opt & POPT_EXT_FM ? YM2612Init_940 : YM2612Init_)(baseclock, rate, flags)\r
	201	#define YM2612ResetChip() \\r
	202	(PicoIn.opt & POPT_EXT_FM ? YM2612ResetChip_940 : YM2612ResetChip_)()\r
	203	#define YM2612PicoStateLoad() \\r
	204	(PicoIn.opt & POPT_EXT_FM ? YM2612PicoStateLoad_940 : YM2612PicoStateLoad_)()\r
	205	#define YM2612UpdateOne(buffer, length, sterao, isempty) \\r
	206	(PicoIn.opt & POPT_EXT_FM ? YM2612UpdateOne_940 : YM2612UpdateOne_)(buffer, length, stereo, isempty)\r
	207	#endif /* __GP2X__ */\r
	208	\r
	209	\r
	210	#endif /* _H_FM_FM_ */\r