[picodrive.git] / pico / pico.h

\r
// -------------------- Pico Library --------------------\r
\r
// Pico Library - Header File\r
\r
// (c) Copyright 2004 Dave, All rights reserved.\r
// (c) Copyright 2006-2009 notaz, All rights reserved.\r
// Free for non-commercial use.\r
\r
// For commercial use, separate licencing terms must be obtained.\r
\r
#ifndef PICO_H\r
#define PICO_H\r
\r
#include <stdio.h>\r
\r
// port-specific compile-time settings\r
#include <port_config.h>\r
\r
#ifdef __cplusplus\r
extern "C" {\r
#endif\r
\r
// external funcs for Sega/Mega CD\r
extern int  mp3_get_bitrate(FILE *f, int size);\r
extern void mp3_start_play(FILE *f, int pos);\r
extern void mp3_update(int *buffer, int length, int stereo);\r
\r
// this function should write-back d-cache and invalidate i-cache\r
// on a mem region [start_addr, end_addr)\r
// used by dynarecs\r
extern void cache_flush_d_inval_i(const void *start_addr, const void *end_addr);\r
\r
// attempt to alloc mem at specified address.\r
// alloc anywhere else if that fails (callers should handle that)\r
extern void *plat_mmap(unsigned long addr, size_t size);\r
extern void  plat_munmap(void *ptr, size_t size);\r
\r
// this one should handle display mode changes\r
extern void emu_video_mode_change(int start_line, int line_count, int is_32cols);\r
\r
// this must switch to 16bpp mode\r
extern void emu_32x_startup(void);\r
\r
// optional 32X BIOS, should be left NULL if not used\r
// must be 256, 2048, 1024 bytes\r
extern void *p32x_bios_g, *p32x_bios_m, *p32x_bios_s;\r
\r
// Pico.c\r
#define POPT_EN_FM          (1<< 0) // 00 000x\r
#define POPT_EN_PSG         (1<< 1)\r
#define POPT_EN_Z80         (1<< 2)\r
#define POPT_EN_STEREO      (1<< 3)\r
#define POPT_ALT_RENDERER   (1<< 4) // 00 00x0\r
#define POPT_6BTN_PAD       (1<< 5)\r
// unused                   (1<< 6)\r
#define POPT_ACC_SPRITES    (1<< 7)\r
#define POPT_DIS_32C_BORDER (1<< 8) // 00 0x00\r
#define POPT_EXT_FM         (1<< 9)\r
#define POPT_EN_MCD_PCM     (1<<10)\r
#define POPT_EN_MCD_CDDA    (1<<11)\r
#define POPT_EN_MCD_GFX     (1<<12) // 00 x000\r
#define POPT_EN_MCD_PSYNC   (1<<13)\r
#define POPT_EN_SOFTSCALE   (1<<14)\r
#define POPT_EN_MCD_RAMCART (1<<15)\r
#define POPT_DIS_VDP_FIFO   (1<<16) // 0x 0000\r
#define POPT_EN_SVP_DRC     (1<<17)\r
#define POPT_DIS_SPRITE_LIM (1<<18)\r
#define POPT_DIS_IDLE_DET   (1<<19)\r
#define POPT_EN_32X         (1<<20)\r
#define POPT_EN_PWM         (1<<21)\r
extern int PicoOpt; // bitfield\r
\r
#define PAHW_MCD  (1<<0)\r
#define PAHW_32X  (1<<1)\r
#define PAHW_SVP  (1<<2)\r
#define PAHW_PICO (1<<3)\r
#define PAHW_SMS  (1<<4)\r
extern int PicoAHW;            // Pico active hw\r
extern int PicoSkipFrame;      // skip rendering frame, but still do sound (if enabled) and emulation stuff\r
extern int PicoRegionOverride; // override the region detection 0: auto, 1: Japan NTSC, 2: Japan PAL, 4: US, 8: Europe\r
extern int PicoAutoRgnOrder;   // packed priority list of regions, for example 0x148 means this detection order: EUR, USA, JAP\r
extern int PicoSVPCycles;\r
void PicoInit(void);\r
void PicoExit(void);\r
void PicoPower(void);\r
int  PicoReset(void);\r
void PicoLoopPrepare(void);\r
void PicoFrame(void);\r
void PicoFrameDrawOnly(void);\r
extern int PicoPad[2]; // Joypads, format is MXYZ SACB RLDU\r
extern void (*PicoWriteSound)(int len); // called once per frame at the best time to send sound buffer (PsndOut) to hardware\r
extern void (*PicoMessage)(const char *msg); // callback to output text message from emu\r
typedef enum { PI_ROM, PI_ISPAL, PI_IS40_CELL, PI_IS240_LINES } pint_t;\r
typedef union { int vint; void *vptr; } pint_ret_t;\r
void PicoGetInternal(pint_t which, pint_ret_t *ret);\r
\r
// cd/Pico.c\r
extern void (*PicoMCDopenTray)(void);\r
extern void (*PicoMCDcloseTray)(void);\r
extern int PicoCDBuffers;\r
\r
// Pico/Pico.c\r
#define XPCM_BUFFER_SIZE (320+160)\r
typedef struct\r
{\r
	int pen_pos[2];\r
	int page;\r
	// internal\r
	int fifo_bytes;      // bytes in FIFO\r
	int fifo_bytes_prev;\r
	int fifo_line_bytes; // float part, << 16\r
	int line_counter;\r
	unsigned short r1, r12;\r
	unsigned char xpcm_buffer[XPCM_BUFFER_SIZE+4];\r
	unsigned char *xpcm_ptr;\r
} picohw_state;\r
extern picohw_state PicoPicohw;\r
\r
// area.c\r
int PicoState(const char *fname, int is_save);\r
int PicoStateLoadVDP(const char *fname);\r
extern void (*PicoStateProgressCB)(const char *str);\r
\r
// cd/area.c\r
int  PicoCdLoadStateGfx(void *file);\r
\r
// cd/buffering.c\r
void PicoCDBufferInit(void);\r
void PicoCDBufferFree(void);\r
void PicoCDBufferFlush(void);\r
\r
// cd/cd_sys.c\r
int Insert_CD(const char *cdimg_name, int type);\r
void Stop_CD(void); // releases all resources taken when CD game was started.\r
\r
// Cart.c\r
typedef enum\r
{\r
	PMT_UNCOMPRESSED = 0,\r
	PMT_ZIP,\r
	PMT_CSO\r
} pm_type;\r
typedef struct\r
{\r
	void *file;		/* file handle */\r
	void *param;		/* additional file related field */\r
	unsigned int size;	/* size */\r
	pm_type type;\r
	char ext[4];\r
} pm_file;\r
pm_file *pm_open(const char *path);\r
size_t   pm_read(void *ptr, size_t bytes, pm_file *stream);\r
int      pm_seek(pm_file *stream, long offset, int whence);\r
int      pm_close(pm_file *fp);\r
int PicoCartLoad(pm_file *f,unsigned char **prom,unsigned int *psize,int is_sms);\r
int PicoCartInsert(unsigned char *rom, unsigned int romsize, const char *carthw_cfg);\r
void PicoCartUnload(void);\r
extern void (*PicoCartLoadProgressCB)(int percent);\r
extern void (*PicoCDLoadProgressCB)(const char *fname, int percent);\r
\r
// Draw.c\r
void PicoDrawSetColorFormat(int which); // 0=BGR444, 1=RGB555, 2=8bit(HighPal pal)\r
extern void *DrawLineDest;\r
#if OVERRIDE_HIGHCOL\r
extern unsigned char *HighCol;\r
#else\r
extern unsigned char  HighCol[8+320+8];\r
#endif\r
extern int (*PicoScanBegin)(unsigned int num);\r
extern int (*PicoScanEnd)(unsigned int num);\r
// utility\r
#ifdef _ASM_DRAW_C\r
void vidConvCpyRGB565(void *to, void *from, int pixels);\r
#endif\r
void PicoDoHighPal555(int sh);\r
extern int PicoDrawMask;\r
#define PDRAW_LAYERB_ON      (1<<2)\r
#define PDRAW_LAYERA_ON      (1<<3)\r
#define PDRAW_SPRITES_LOW_ON (1<<4)\r
#define PDRAW_SPRITES_HI_ON  (1<<7)\r
#define PDRAW_32X_ON         (1<<8)\r
// internals\r
#define PDRAW_SPRITES_MOVED (1<<0) // (asm)\r
#define PDRAW_WND_DIFF_PRIO (1<<1) // not all window tiles use same priority\r
#define PDRAW_SPR_LO_ON_HI  (1<<2) // seen sprites without layer pri bit ontop spr. with that bit\r
#define PDRAW_INTERLACE     (1<<3)\r
#define PDRAW_DIRTY_SPRITES (1<<4) // (asm)\r
#define PDRAW_SONIC_MODE    (1<<5) // mid-frame palette changes for 8bit renderer\r
#define PDRAW_PLANE_HI_PRIO (1<<6) // have layer with all hi prio tiles (mk3)\r
#define PDRAW_SHHI_DONE     (1<<7) // layer sh/hi already processed\r
#define PDRAW_32_COLS       (1<<8) // 32 column mode\r
extern int rendstatus, rendstatus_old;\r
extern int rendlines;\r
extern unsigned short HighPal[0x100];\r
\r
// Draw2.c\r
// stuff below is optional\r
extern unsigned char  *PicoDraw2FB;  // buffer for fast renderer in format (8+320)x(8+224+8) (eights for borders)\r
extern unsigned short *PicoCramHigh; // pointer to CRAM buff (0x40 shorts), converted to native device color (works only with 16bit for now)\r
extern void (*PicoPrepareCram)();    // prepares PicoCramHigh for renderer to use\r
\r
// sound.c\r
extern int PsndRate,PsndLen;\r
extern short *PsndOut;\r
extern void (*PsndMix_32_to_16l)(short *dest, int *src, int count);\r
void PsndRerate(int preserve_state);\r
\r
// Utils.c\r
extern int PicuAnd;\r
int PicuQuick(unsigned short *dest,unsigned short *src);\r
int PicuShrink(unsigned short *dest,int destLen,unsigned short *src,int srcLen);\r
int PicuShrinkReverse(unsigned short *dest,int destLen,unsigned short *src,int srcLen);\r
int PicuMerge(unsigned short *dest,int destLen,unsigned short *src,int srcLen);\r
\r
#ifdef __cplusplus\r
} // End of extern "C"\r
#endif\r
\r
#endif // PICO_H\r
Commit	Line	Data
cc68a136	1	\r
	2	// -------------------- Pico Library --------------------\r
	3	\r
	4	// Pico Library - Header File\r
	5	\r
	6	// (c) Copyright 2004 Dave, All rights reserved.\r
19954be1	7	// (c) Copyright 2006-2009 notaz, All rights reserved.\r
cc68a136	8	// Free for non-commercial use.\r
	9	\r
	10	// For commercial use, separate licencing terms must be obtained.\r
	11	\r
	12	#ifndef PICO_H\r
	13	#define PICO_H\r
	14	\r
eff55556	15	#include <stdio.h>\r
eff55556	16	\r
cc68a136	17	// port-specific compile-time settings\r
	18	#include <port_config.h>\r
	19	\r
	20	#ifdef __cplusplus\r
	21	extern "C" {\r
	22	#endif\r
	23	\r
75736070	24	// external funcs for Sega/Mega CD\r
84100c0f	25	extern int mp3_get_bitrate(FILE *f, int size);\r
	26	extern void mp3_start_play(FILE *f, int pos);\r
	27	extern void mp3_update(int *buffer, int length, int stereo);\r
	28	\r
	29	// this function should write-back d-cache and invalidate i-cache\r
	30	// on a mem region [start_addr, end_addr)\r
b081408f	31	// used by dynarecs\r
84100c0f	32	extern void cache_flush_d_inval_i(const void start_addr, const void end_addr);\r
cb0316e4	33	\r
b081408f	34	// attempt to alloc mem at specified address.\r
	35	// alloc anywhere else if that fails (callers should handle that)\r
	36	extern void *plat_mmap(unsigned long addr, size_t size);\r
	37	extern void plat_munmap(void *ptr, size_t size);\r
	38	\r
19954be1	39	// this one should handle display mode changes\r
	40	extern void emu_video_mode_change(int start_line, int line_count, int is_32cols);\r
	41	\r
ae87bffa	42	// this must switch to 16bpp mode\r
974fdb5b	43	extern void emu_32x_startup(void);\r
974fdb5b	44	\r
83ff19ec	45	// optional 32X BIOS, should be left NULL if not used\r
	46	// must be 256, 2048, 1024 bytes\r
	47	extern void p32x_bios_g, p32x_bios_m, *p32x_bios_s;\r
	48	\r
cc68a136	49	// Pico.c\r
602133e1	50	#define POPT_EN_FM (1<< 0) // 00 000x\r
	51	#define POPT_EN_PSG (1<< 1)\r
	52	#define POPT_EN_Z80 (1<< 2)\r
	53	#define POPT_EN_STEREO (1<< 3)\r
	54	#define POPT_ALT_RENDERER (1<< 4) // 00 00x0\r
	55	#define POPT_6BTN_PAD (1<< 5)\r
2aa27095	56	// unused (1<< 6)\r
602133e1	57	#define POPT_ACC_SPRITES (1<< 7)\r
	58	#define POPT_DIS_32C_BORDER (1<< 8) // 00 0x00\r
	59	#define POPT_EXT_FM (1<< 9)\r
	60	#define POPT_EN_MCD_PCM (1<<10)\r
	61	#define POPT_EN_MCD_CDDA (1<<11)\r
	62	#define POPT_EN_MCD_GFX (1<<12) // 00 x000\r
	63	#define POPT_EN_MCD_PSYNC (1<<13)\r
	64	#define POPT_EN_SOFTSCALE (1<<14)\r
	65	#define POPT_EN_MCD_RAMCART (1<<15)\r
	66	#define POPT_DIS_VDP_FIFO (1<<16) // 0x 0000\r
	67	#define POPT_EN_SVP_DRC (1<<17)\r
381eea9b	68	#define POPT_DIS_SPRITE_LIM (1<<18)\r
053fd9b4	69	#define POPT_DIS_IDLE_DET (1<<19)\r
db1d3564	70	#define POPT_EN_32X (1<<20)\r
db1d3564	71	#define POPT_EN_PWM (1<<21)\r
602133e1	72	extern int PicoOpt; // bitfield\r
be2c4208	73	\r
fa22af4c	74	#define PAHW_MCD (1<<0)\r
	75	#define PAHW_32X (1<<1)\r
	76	#define PAHW_SVP (1<<2)\r
	77	#define PAHW_PICO (1<<3)\r
3e49ffd0	78	#define PAHW_SMS (1<<4)\r
fa22af4c	79	extern int PicoAHW; // Pico active hw\r
fa22af4c	80	extern int PicoSkipFrame; // skip rendering frame, but still do sound (if enabled) and emulation stuff\r
cc68a136	81	extern int PicoRegionOverride; // override the region detection 0: auto, 1: Japan NTSC, 2: Japan PAL, 4: US, 8: Europe\r
fa22af4c	82	extern int PicoAutoRgnOrder; // packed priority list of regions, for example 0x148 means this detection order: EUR, USA, JAP\r
0ffefdb8	83	extern int PicoSVPCycles;\r
2aa27095	84	void PicoInit(void);\r
cc68a136	85	void PicoExit(void);\r
1cb1584b	86	void PicoPower(void);\r
1cb1584b	87	int PicoReset(void);\r
5e128c6d	88	void PicoLoopPrepare(void);\r
2aa27095	89	void PicoFrame(void);\r
a12e0116	90	void PicoFrameDrawOnly(void);\r
cc68a136	91	extern int PicoPad[2]; // Joypads, format is MXYZ SACB RLDU\r
7a93adeb	92	extern void (*PicoWriteSound)(int len); // called once per frame at the best time to send sound buffer (PsndOut) to hardware\r
66fdc0f0	93	extern void (PicoMessage)(const char msg); // callback to output text message from emu\r
4609d0cd	94	typedef enum { PI_ROM, PI_ISPAL, PI_IS40_CELL, PI_IS240_LINES } pint_t;\r
	95	typedef union { int vint; void *vptr; } pint_ret_t;\r
	96	void PicoGetInternal(pint_t which, pint_ret_t *ret);\r
cc68a136	97	\r
721cd396	98	// cd/Pico.c\r
721cd396	99	extern void (*PicoMCDopenTray)(void);\r
d687ef50	100	extern void (*PicoMCDcloseTray)(void);\r
0a051f55	101	extern int PicoCDBuffers;\r
0a051f55	102	\r
406c96c5	103	// Pico/Pico.c\r
ed367a3f	104	#define XPCM_BUFFER_SIZE (320+160)\r
d49b10c2	105	typedef struct\r
	106	{\r
	107	int pen_pos[2];\r
	108	int page;\r
	109	// internal\r
fa22af4c	110	int fifo_bytes; // bytes in FIFO\r
fa22af4c	111	int fifo_bytes_prev;\r
ef4eb506	112	int fifo_line_bytes; // float part, << 16\r
d49b10c2	113	int line_counter;\r
ef4eb506	114	unsigned short r1, r12;\r
	115	unsigned char xpcm_buffer[XPCM_BUFFER_SIZE+4];\r
	116	unsigned char *xpcm_ptr;\r
d49b10c2	117	} picohw_state;\r
d49b10c2	118	extern picohw_state PicoPicohw;\r
406c96c5	119	\r
bcc9eda0	120	// area.c\r
	121	int PicoState(const char *fname, int is_save);\r
	122	int PicoStateLoadVDP(const char *fname);\r
76276b0b	123	extern void (PicoStateProgressCB)(const char str);\r
cc68a136	124	\r
bcc9eda0	125	// cd/area.c\r
2aa27095	126	int PicoCdLoadStateGfx(void *file);\r
eff55556	127	\r
0a051f55	128	// cd/buffering.c\r
	129	void PicoCDBufferInit(void);\r
	130	void PicoCDBufferFree(void);\r
c9e1affc	131	void PicoCDBufferFlush(void);\r
0a051f55	132	\r
eff55556	133	// cd/cd_sys.c\r
35e3031a	134	int Insert_CD(const char *cdimg_name, int type);\r
eff55556	135	void Stop_CD(void); // releases all resources taken when CD game was started.\r
eff55556	136	\r
cc68a136	137	// Cart.c\r
83bd0b76	138	typedef enum\r
	139	{\r
	140	PMT_UNCOMPRESSED = 0,\r
71de3cd9	141	PMT_ZIP,\r
71de3cd9	142	PMT_CSO\r
83bd0b76	143	} pm_type;\r
	144	typedef struct\r
	145	{\r
	146	void file; / file handle */\r
	147	void param; / additional file related field */\r
	148	unsigned int size; /* size */\r
	149	pm_type type;\r
87b0845f	150	char ext[4];\r
83bd0b76	151	} pm_file;\r
	152	pm_file pm_open(const char path);\r
	153	size_t pm_read(void ptr, size_t bytes, pm_file stream);\r
	154	int pm_seek(pm_file *stream, long offset, int whence);\r
	155	int pm_close(pm_file *fp);\r
3e49ffd0	156	int PicoCartLoad(pm_file f,unsigned char prom,unsigned int psize,int is_sms);\r
ae87bffa	157	int PicoCartInsert(unsigned char rom, unsigned int romsize, const char carthw_cfg);\r
2aa27095	158	void PicoCartUnload(void);\r
a9b3ffd3	159	extern void (*PicoCartLoadProgressCB)(int percent);\r
b2451ac6	160	extern void (PicoCDLoadProgressCB)(const char fname, int percent);\r
cc68a136	161	\r
	162	// Draw.c\r
	163	void PicoDrawSetColorFormat(int which); // 0=BGR444, 1=RGB555, 2=8bit(HighPal pal)\r
	164	extern void *DrawLineDest;\r
ea8c405f	165	#if OVERRIDE_HIGHCOL\r
ea8c405f	166	extern unsigned char *HighCol;\r
e55f0cbb	167	#else\r
e55f0cbb	168	extern unsigned char HighCol[8+320+8];\r
ea8c405f	169	#endif\r
602133e1	170	extern int (*PicoScanBegin)(unsigned int num);\r
602133e1	171	extern int (*PicoScanEnd)(unsigned int num);\r
cc68a136	172	// utility\r
cc68a136	173	#ifdef _ASM_DRAW_C\r
ea8c405f	174	void vidConvCpyRGB565(void to, void from, int pixels);\r
cc68a136	175	#endif\r
e55f0cbb	176	void PicoDoHighPal555(int sh);\r
fbc65db7	177	extern int PicoDrawMask;\r
	178	#define PDRAW_LAYERB_ON (1<<2)\r
	179	#define PDRAW_LAYERA_ON (1<<3)\r
	180	#define PDRAW_SPRITES_LOW_ON (1<<4)\r
	181	#define PDRAW_SPRITES_HI_ON (1<<7)\r
5e49c3a8	182	#define PDRAW_32X_ON (1<<8)\r
602133e1	183	// internals\r
947fb5f9	184	#define PDRAW_SPRITES_MOVED (1<<0) // (asm)\r
602133e1	185	#define PDRAW_WND_DIFF_PRIO (1<<1) // not all window tiles use same priority\r
f8af9634	186	#define PDRAW_SPR_LO_ON_HI (1<<2) // seen sprites without layer pri bit ontop spr. with that bit\r
947fb5f9	187	#define PDRAW_INTERLACE (1<<3)\r
947fb5f9	188	#define PDRAW_DIRTY_SPRITES (1<<4) // (asm)\r
602133e1	189	#define PDRAW_SONIC_MODE (1<<5) // mid-frame palette changes for 8bit renderer\r
	190	#define PDRAW_PLANE_HI_PRIO (1<<6) // have layer with all hi prio tiles (mk3)\r
	191	#define PDRAW_SHHI_DONE (1<<7) // layer sh/hi already processed\r
ae87bffa	192	#define PDRAW_32_COLS (1<<8) // 32 column mode\r
19954be1	193	extern int rendstatus, rendstatus_old;\r
ae87bffa	194	extern int rendlines;\r
602133e1	195	extern unsigned short HighPal[0x100];\r
cc68a136	196	\r
	197	// Draw2.c\r
	198	// stuff below is optional\r
8e5427a0	199	extern unsigned char *PicoDraw2FB; // buffer for fast renderer in format (8+320)x(8+224+8) (eights for borders)\r
cc68a136	200	extern unsigned short *PicoCramHigh; // pointer to CRAM buff (0x40 shorts), converted to native device color (works only with 16bit for now)\r
	201	extern void (*PicoPrepareCram)(); // prepares PicoCramHigh for renderer to use\r
	202	\r
	203	// sound.c\r
	204	extern int PsndRate,PsndLen;\r
	205	extern short *PsndOut;\r
4a32f01f	206	extern void (PsndMix_32_to_16l)(short dest, int *src, int count);\r
9d917eea	207	void PsndRerate(int preserve_state);\r
cc68a136	208	\r
	209	// Utils.c\r
	210	extern int PicuAnd;\r
	211	int PicuQuick(unsigned short dest,unsigned short src);\r
	212	int PicuShrink(unsigned short dest,int destLen,unsigned short src,int srcLen);\r
	213	int PicuShrinkReverse(unsigned short dest,int destLen,unsigned short src,int srcLen);\r
	214	int PicuMerge(unsigned short dest,int destLen,unsigned short src,int srcLen);\r
	215	\r
	216	#ifdef __cplusplus\r
	217	} // End of extern "C"\r
	218	#endif\r
	219	\r
	220	#endif // PICO_H\r