work on 'vblank on line start' problem, var changes, mask defines
[picodrive.git] / Pico / Pico.h
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
7 // (c) Copyright 2006-2008 notaz, All rights reserved.\r
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
15 #include <stdio.h>\r
16 \r
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
24 // external funcs for Sega/Mega CD\r
25 int  mp3_get_bitrate(FILE *f, int size);\r
26 void mp3_start_play(FILE *f, int pos);\r
27 int  mp3_get_offset(void); // 0-1023\r
28 void mp3_update(int *buffer, int length, int stereo);\r
29 \r
30 \r
31 // Pico.c\r
32 #define POPT_EN_FM          (1<< 0) // 00 000x\r
33 #define POPT_EN_PSG         (1<< 1)\r
34 #define POPT_EN_Z80         (1<< 2)\r
35 #define POPT_EN_STEREO      (1<< 3)\r
36 #define POPT_ALT_RENDERER   (1<< 4) // 00 00x0\r
37 #define POPT_6BTN_PAD       (1<< 5)\r
38 #define POPT_ACC_TIMING     (1<< 6)\r
39 #define POPT_ACC_SPRITES    (1<< 7)\r
40 #define POPT_DIS_32C_BORDER (1<< 8) // 00 0x00\r
41 #define POPT_EXT_FM         (1<< 9)\r
42 #define POPT_EN_MCD_PCM     (1<<10)\r
43 #define POPT_EN_MCD_CDDA    (1<<11)\r
44 #define POPT_EN_MCD_GFX     (1<<12) // 00 x000\r
45 #define POPT_EN_MCD_PSYNC   (1<<13)\r
46 #define POPT_EN_SOFTSCALE   (1<<14)\r
47 #define POPT_EN_MCD_RAMCART (1<<15)\r
48 #define POPT_DIS_VDP_FIFO   (1<<16) // 0x 0000\r
49 #define POPT_EN_SVP_DRC     (1<<17)\r
50 extern int PicoOpt; // bitfield\r
51 extern int PicoVer;\r
52 extern int PicoSkipFrame; // skip rendering frame, but still do sound (if enabled) and emulation stuff\r
53 extern int PicoRegionOverride; // override the region detection 0: auto, 1: Japan NTSC, 2: Japan PAL, 4: US, 8: Europe\r
54 extern int PicoAutoRgnOrder; // packed priority list of regions, for example 0x148 means this detection order: EUR, USA, JAP\r
55 extern int PicoSVPCycles;\r
56 int  PicoInit(void);\r
57 void PicoExit(void);\r
58 void PicoPower(void);\r
59 int  PicoReset(void);\r
60 int  PicoFrame(void);\r
61 void PicoFrameDrawOnly(void);\r
62 extern int PicoPad[2]; // Joypads, format is MXYZ SACB RLDU\r
63 extern void (*PicoWriteSound)(int len); // called once per frame at the best time to send sound buffer (PsndOut) to hardware\r
64 extern void (*PicoMessage)(const char *msg); // callback to output text message from emu\r
65 typedef enum { PS_PAL, PS_40_CELL, PS_240_LINES } pstat_t;\r
66 int  PicoGetStat(pstat_t which);\r
67 \r
68 // cd/Pico.c\r
69 extern void (*PicoMCDopenTray)(void);\r
70 extern int  (*PicoMCDcloseTray)(void);\r
71 extern int PicoCDBuffers;\r
72 \r
73 // Area.c\r
74 typedef size_t (arearw)(void *p, size_t _size, size_t _n, void *file);\r
75 typedef size_t (areaeof)(void *file);\r
76 typedef int    (areaseek)(void *file, long offset, int whence);\r
77 typedef int    (areaclose)(void *file);\r
78 // Save or load the state from PmovFile:\r
79 int PmovState(int PmovAction, void *PmovFile); // &1=for reading &2=for writing &4=volatile &8=non-volatile\r
80 extern arearw  *areaRead;  // external read and write function pointers for\r
81 extern arearw  *areaWrite; // gzip save state ability\r
82 extern areaeof *areaEof;\r
83 extern areaseek *areaSeek;\r
84 extern areaclose *areaClose;\r
85 extern void (*PicoStateProgressCB)(const char *str);\r
86 \r
87 // cd/Area.c\r
88 int PicoCdLoadStateGfx(void *file);\r
89 \r
90 // cd/buffering.c\r
91 void PicoCDBufferInit(void);\r
92 void PicoCDBufferFree(void);\r
93 \r
94 // cd/cd_sys.c\r
95 int Insert_CD(char *iso_name, int is_bin);\r
96 void Stop_CD(void); // releases all resources taken when CD game was started.\r
97 \r
98 // Cart.c\r
99 typedef enum\r
100 {\r
101         PMT_UNCOMPRESSED = 0,\r
102         PMT_ZIP,\r
103         PMT_CSO\r
104 } pm_type;\r
105 typedef struct\r
106 {\r
107         void *file;             /* file handle */\r
108         void *param;            /* additional file related field */\r
109         unsigned int size;      /* size */\r
110         pm_type type;\r
111 } pm_file;\r
112 pm_file *pm_open(const char *path);\r
113 size_t   pm_read(void *ptr, size_t bytes, pm_file *stream);\r
114 int      pm_seek(pm_file *stream, long offset, int whence);\r
115 int      pm_close(pm_file *fp);\r
116 int PicoCartLoad(pm_file *f,unsigned char **prom,unsigned int *psize);\r
117 int PicoCartInsert(unsigned char *rom,unsigned int romsize);\r
118 void Byteswap(unsigned char *data,int len);\r
119 int PicoCartUnload(void);\r
120 extern void (*PicoCartLoadProgressCB)(int percent);\r
121 extern void (*PicoCDLoadProgressCB)(int percent);\r
122 \r
123 // Draw.c\r
124 void PicoDrawSetColorFormat(int which); // 0=BGR444, 1=RGB555, 2=8bit(HighPal pal)\r
125 extern void *DrawLineDest;\r
126 #if OVERRIDE_HIGHCOL\r
127 extern unsigned char *HighCol;\r
128 #endif\r
129 extern int (*PicoScanBegin)(unsigned int num);\r
130 extern int (*PicoScanEnd)(unsigned int num);\r
131 // utility\r
132 #ifdef _ASM_DRAW_C\r
133 void vidConvCpyRGB565(void *to, void *from, int pixels);\r
134 #endif\r
135 // internals\r
136 #define PDRAW_SPRITES_MOVED (1<<0)\r
137 #define PDRAW_WND_DIFF_PRIO (1<<1) // not all window tiles use same priority\r
138 #define PDRAW_ACC_SPRITES   (1<<2) // accurate sprites (copied from PicoOpt)\r
139 #define PDRAW_INTERLACE     (1<<3) // \r
140 #define PDRAW_DIRTY_SPRITES (1<<4)\r
141 #define PDRAW_SONIC_MODE    (1<<5) // mid-frame palette changes for 8bit renderer\r
142 #define PDRAW_PLANE_HI_PRIO (1<<6) // have layer with all hi prio tiles (mk3)\r
143 #define PDRAW_SHHI_DONE     (1<<7) // layer sh/hi already processed\r
144 #define PDRAW_EARLY_BLANK   (1<<8) // blanking enabled at the start of prev line\r
145 extern int rendstatus;\r
146 extern unsigned short HighPal[0x100];\r
147 \r
148 // Draw2.c\r
149 // stuff below is optional\r
150 extern unsigned char  *PicoDraw2FB;  // buffer for fast renderer in format (8+320)x(8+224+8) (eights for borders)\r
151 extern unsigned short *PicoCramHigh; // pointer to CRAM buff (0x40 shorts), converted to native device color (works only with 16bit for now)\r
152 extern void (*PicoPrepareCram)();    // prepares PicoCramHigh for renderer to use\r
153 \r
154 // sound.c\r
155 extern int PsndRate,PsndLen;\r
156 extern short *PsndOut;\r
157 extern void (*PsndMix_32_to_16l)(short *dest, int *src, int count);\r
158 void PsndRerate(int preserve_state);\r
159 \r
160 // Utils.c\r
161 extern int PicuAnd;\r
162 int PicuQuick(unsigned short *dest,unsigned short *src);\r
163 int PicuShrink(unsigned short *dest,int destLen,unsigned short *src,int srcLen);\r
164 int PicuShrinkReverse(unsigned short *dest,int destLen,unsigned short *src,int srcLen);\r
165 int PicuMerge(unsigned short *dest,int destLen,unsigned short *src,int srcLen);\r
166 \r
167 #ifdef __cplusplus\r
168 } // End of extern "C"\r
169 #endif\r
170 \r
171 #endif // PICO_H\r