[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-2008 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
int  mp3_get_bitrate(FILE *f, int size);\r
void mp3_start_play(FILE *f, int pos);\r
void mp3_update(int *buffer, int length, int stereo);\r
\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
#define POPT_ACC_TIMING     (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
extern int PicoOpt; // bitfield\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
extern int PicoAHW;            // Pico active hw\r
extern int PicoVer;\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
int  PicoInit(void);\r
void PicoExit(void);\r
void PicoPower(void);\r
int  PicoReset(void);\r
int  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 int  (*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
typedef size_t (arearw)(void *p, size_t _size, size_t _n, void *file);\r
typedef size_t (areaeof)(void *file);\r
typedef int    (areaseek)(void *file, long offset, int whence);\r
typedef int    (areaclose)(void *file);\r
// Save or load the state from PmovFile:\r
int PmovState(int PmovAction, void *PmovFile); // &1=for reading &2=for writing &4=volatile &8=non-volatile\r
extern arearw  *areaRead;  // external read and write function pointers for\r
extern arearw  *areaWrite; // gzip save state ability\r
extern areaeof *areaEof;\r
extern areaseek *areaSeek;\r
extern areaclose *areaClose;\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(char *iso_name, int is_bin);\r
int Insert_CD(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
} 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);\r
int PicoCartInsert(unsigned char *rom,unsigned int romsize);\r
void Byteswap(unsigned char *data,int len);\r
int PicoCartUnload(void);\r
extern void (*PicoCartLoadProgressCB)(int percent);\r
extern void (*PicoCDLoadProgressCB)(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
#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
// internals\r
#define PDRAW_SPRITES_MOVED (1<<0)\r
#define PDRAW_WND_DIFF_PRIO (1<<1) // not all window tiles use same priority\r
#define PDRAW_ACC_SPRITES   (1<<2) // accurate sprites (copied from PicoOpt)\r
#define PDRAW_INTERLACE     (1<<3) //\r
#define PDRAW_DIRTY_SPRITES (1<<4)\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_EARLY_BLANK   (1<<8) // blanking enabled at the start of prev line\r
extern int rendstatus;\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
602133e1	7	// (c) Copyright 2006-2008 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
75736070	25	int mp3_get_bitrate(FILE *f, int size);\r
cb0316e4	26	void mp3_start_play(FILE *f, int pos);\r
4f265db7	27	void mp3_update(int *buffer, int length, int stereo);\r
cb0316e4	28	\r
cb0316e4	29	\r
cc68a136	30	// Pico.c\r
602133e1	31	#define POPT_EN_FM (1<< 0) // 00 000x\r
	32	#define POPT_EN_PSG (1<< 1)\r
	33	#define POPT_EN_Z80 (1<< 2)\r
	34	#define POPT_EN_STEREO (1<< 3)\r
	35	#define POPT_ALT_RENDERER (1<< 4) // 00 00x0\r
	36	#define POPT_6BTN_PAD (1<< 5)\r
	37	#define POPT_ACC_TIMING (1<< 6)\r
	38	#define POPT_ACC_SPRITES (1<< 7)\r
	39	#define POPT_DIS_32C_BORDER (1<< 8) // 00 0x00\r
	40	#define POPT_EXT_FM (1<< 9)\r
	41	#define POPT_EN_MCD_PCM (1<<10)\r
	42	#define POPT_EN_MCD_CDDA (1<<11)\r
	43	#define POPT_EN_MCD_GFX (1<<12) // 00 x000\r
	44	#define POPT_EN_MCD_PSYNC (1<<13)\r
	45	#define POPT_EN_SOFTSCALE (1<<14)\r
	46	#define POPT_EN_MCD_RAMCART (1<<15)\r
	47	#define POPT_DIS_VDP_FIFO (1<<16) // 0x 0000\r
	48	#define POPT_EN_SVP_DRC (1<<17)\r
381eea9b	49	#define POPT_DIS_SPRITE_LIM (1<<18)\r
602133e1	50	extern int PicoOpt; // bitfield\r
fa22af4c	51	#define PAHW_MCD (1<<0)\r
	52	#define PAHW_32X (1<<1)\r
	53	#define PAHW_SVP (1<<2)\r
	54	#define PAHW_PICO (1<<3)\r
	55	extern int PicoAHW; // Pico active hw\r
cc68a136	56	extern int PicoVer;\r
fa22af4c	57	extern int PicoSkipFrame; // skip rendering frame, but still do sound (if enabled) and emulation stuff\r
cc68a136	58	extern int PicoRegionOverride; // override the region detection 0: auto, 1: Japan NTSC, 2: Japan PAL, 4: US, 8: Europe\r
fa22af4c	59	extern int PicoAutoRgnOrder; // packed priority list of regions, for example 0x148 means this detection order: EUR, USA, JAP\r
0ffefdb8	60	extern int PicoSVPCycles;\r
0ffefdb8	61	int PicoInit(void);\r
cc68a136	62	void PicoExit(void);\r
1cb1584b	63	void PicoPower(void);\r
1cb1584b	64	int PicoReset(void);\r
0ffefdb8	65	int PicoFrame(void);\r
a12e0116	66	void PicoFrameDrawOnly(void);\r
cc68a136	67	extern int PicoPad[2]; // Joypads, format is MXYZ SACB RLDU\r
7a93adeb	68	extern void (*PicoWriteSound)(int len); // called once per frame at the best time to send sound buffer (PsndOut) to hardware\r
66fdc0f0	69	extern void (PicoMessage)(const char msg); // callback to output text message from emu\r
4609d0cd	70	typedef enum { PI_ROM, PI_ISPAL, PI_IS40_CELL, PI_IS240_LINES } pint_t;\r
	71	typedef union { int vint; void *vptr; } pint_ret_t;\r
	72	void PicoGetInternal(pint_t which, pint_ret_t *ret);\r
cc68a136	73	\r
721cd396	74	// cd/Pico.c\r
721cd396	75	extern void (*PicoMCDopenTray)(void);\r
721cd396	76	extern int (*PicoMCDcloseTray)(void);\r
0a051f55	77	extern int PicoCDBuffers;\r
0a051f55	78	\r
406c96c5	79	// Pico/Pico.c\r
ed367a3f	80	#define XPCM_BUFFER_SIZE (320+160)\r
d49b10c2	81	typedef struct\r
	82	{\r
	83	int pen_pos[2];\r
	84	int page;\r
	85	// internal\r
fa22af4c	86	int fifo_bytes; // bytes in FIFO\r
fa22af4c	87	int fifo_bytes_prev;\r
ef4eb506	88	int fifo_line_bytes; // float part, << 16\r
d49b10c2	89	int line_counter;\r
ef4eb506	90	unsigned short r1, r12;\r
	91	unsigned char xpcm_buffer[XPCM_BUFFER_SIZE+4];\r
	92	unsigned char *xpcm_ptr;\r
d49b10c2	93	} picohw_state;\r
d49b10c2	94	extern picohw_state PicoPicohw;\r
406c96c5	95	\r
cc68a136	96	// Area.c\r
cc68a136	97	typedef size_t (arearw)(void p, size_t _size, size_t _n, void file);\r
51a902ae	98	typedef size_t (areaeof)(void *file);\r
75736070	99	typedef int (areaseek)(void *file, long offset, int whence);\r
860c6322	100	typedef int (areaclose)(void *file);\r
cc68a136	101	// Save or load the state from PmovFile:\r
cc68a136	102	int PmovState(int PmovAction, void *PmovFile); // &1=for reading &2=for writing &4=volatile &8=non-volatile\r
51a902ae	103	extern arearw *areaRead; // external read and write function pointers for\r
	104	extern arearw *areaWrite; // gzip save state ability\r
	105	extern areaeof *areaEof;\r
75736070	106	extern areaseek *areaSeek;\r
860c6322	107	extern areaclose *areaClose;\r
76276b0b	108	extern void (PicoStateProgressCB)(const char str);\r
cc68a136	109	\r
eff55556	110	// cd/Area.c\r
	111	int PicoCdLoadStateGfx(void *file);\r
	112	\r
0a051f55	113	// cd/buffering.c\r
	114	void PicoCDBufferInit(void);\r
	115	void PicoCDBufferFree(void);\r
c9e1affc	116	void PicoCDBufferFlush(void);\r
0a051f55	117	\r
eff55556	118	// cd/cd_sys.c\r
eff55556	119	int Insert_CD(char *iso_name, int is_bin);\r
b923ecbe	120	int Insert_CD(char *cdimg_name, int type);\r
eff55556	121	void Stop_CD(void); // releases all resources taken when CD game was started.\r
eff55556	122	\r
cc68a136	123	// Cart.c\r
83bd0b76	124	typedef enum\r
	125	{\r
	126	PMT_UNCOMPRESSED = 0,\r
71de3cd9	127	PMT_ZIP,\r
71de3cd9	128	PMT_CSO\r
83bd0b76	129	} pm_type;\r
	130	typedef struct\r
	131	{\r
	132	void file; / file handle */\r
	133	void param; / additional file related field */\r
	134	unsigned int size; /* size */\r
	135	pm_type type;\r
	136	} pm_file;\r
	137	pm_file pm_open(const char path);\r
	138	size_t pm_read(void ptr, size_t bytes, pm_file stream);\r
	139	int pm_seek(pm_file *stream, long offset, int whence);\r
	140	int pm_close(pm_file *fp);\r
	141	int PicoCartLoad(pm_file f,unsigned char prom,unsigned int psize);\r
cc68a136	142	int PicoCartInsert(unsigned char *rom,unsigned int romsize);\r
cc68a136	143	void Byteswap(unsigned char *data,int len);\r
a12b1b29	144	int PicoCartUnload(void);\r
a9b3ffd3	145	extern void (*PicoCartLoadProgressCB)(int percent);\r
4b167c12	146	extern void (*PicoCDLoadProgressCB)(int percent);\r
cc68a136	147	\r
	148	// Draw.c\r
	149	void PicoDrawSetColorFormat(int which); // 0=BGR444, 1=RGB555, 2=8bit(HighPal pal)\r
	150	extern void *DrawLineDest;\r
ea8c405f	151	#if OVERRIDE_HIGHCOL\r
	152	extern unsigned char *HighCol;\r
	153	#endif\r
602133e1	154	extern int (*PicoScanBegin)(unsigned int num);\r
602133e1	155	extern int (*PicoScanEnd)(unsigned int num);\r
cc68a136	156	// utility\r
cc68a136	157	#ifdef _ASM_DRAW_C\r
ea8c405f	158	void vidConvCpyRGB565(void to, void from, int pixels);\r
cc68a136	159	#endif\r
602133e1	160	// internals\r
	161	#define PDRAW_SPRITES_MOVED (1<<0)\r
	162	#define PDRAW_WND_DIFF_PRIO (1<<1) // not all window tiles use same priority\r
	163	#define PDRAW_ACC_SPRITES (1<<2) // accurate sprites (copied from PicoOpt)\r
b923ecbe	164	#define PDRAW_INTERLACE (1<<3) //\r
602133e1	165	#define PDRAW_DIRTY_SPRITES (1<<4)\r
	166	#define PDRAW_SONIC_MODE (1<<5) // mid-frame palette changes for 8bit renderer\r
	167	#define PDRAW_PLANE_HI_PRIO (1<<6) // have layer with all hi prio tiles (mk3)\r
	168	#define PDRAW_SHHI_DONE (1<<7) // layer sh/hi already processed\r
	169	#define PDRAW_EARLY_BLANK (1<<8) // blanking enabled at the start of prev line\r
	170	extern int rendstatus;\r
	171	extern unsigned short HighPal[0x100];\r
cc68a136	172	\r
	173	// Draw2.c\r
	174	// stuff below is optional\r
8e5427a0	175	extern unsigned char *PicoDraw2FB; // buffer for fast renderer in format (8+320)x(8+224+8) (eights for borders)\r
cc68a136	176	extern unsigned short *PicoCramHigh; // pointer to CRAM buff (0x40 shorts), converted to native device color (works only with 16bit for now)\r
	177	extern void (*PicoPrepareCram)(); // prepares PicoCramHigh for renderer to use\r
	178	\r
	179	// sound.c\r
	180	extern int PsndRate,PsndLen;\r
	181	extern short *PsndOut;\r
4a32f01f	182	extern void (PsndMix_32_to_16l)(short dest, int *src, int count);\r
9d917eea	183	void PsndRerate(int preserve_state);\r
cc68a136	184	\r
	185	// Utils.c\r
	186	extern int PicuAnd;\r
	187	int PicuQuick(unsigned short dest,unsigned short src);\r
	188	int PicuShrink(unsigned short dest,int destLen,unsigned short src,int srcLen);\r
	189	int PicuShrinkReverse(unsigned short dest,int destLen,unsigned short src,int srcLen);\r
	190	int PicuMerge(unsigned short dest,int destLen,unsigned short src,int srcLen);\r
	191	\r
	192	#ifdef __cplusplus\r
	193	} // End of extern "C"\r
	194	#endif\r
	195	\r
	196	#endif // PICO_H\r