protection and more mapper support for new mem code
[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-2009 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 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
31 // used by SVP dynarec\r
32 extern void cache_flush_d_inval_i(const void *start_addr, const void *end_addr);\r
33 \r
34 // this one should handle display mode changes\r
35 extern void emu_video_mode_change(int start_line, int line_count, int is_32cols);\r
36 \r
37 // Pico.c\r
38 #define POPT_EN_FM          (1<< 0) // 00 000x\r
39 #define POPT_EN_PSG         (1<< 1)\r
40 #define POPT_EN_Z80         (1<< 2)\r
41 #define POPT_EN_STEREO      (1<< 3)\r
42 #define POPT_ALT_RENDERER   (1<< 4) // 00 00x0\r
43 #define POPT_6BTN_PAD       (1<< 5)\r
44 // unused                   (1<< 6)\r
45 #define POPT_ACC_SPRITES    (1<< 7)\r
46 #define POPT_DIS_32C_BORDER (1<< 8) // 00 0x00\r
47 #define POPT_EXT_FM         (1<< 9)\r
48 #define POPT_EN_MCD_PCM     (1<<10)\r
49 #define POPT_EN_MCD_CDDA    (1<<11)\r
50 #define POPT_EN_MCD_GFX     (1<<12) // 00 x000\r
51 #define POPT_EN_MCD_PSYNC   (1<<13)\r
52 #define POPT_EN_SOFTSCALE   (1<<14)\r
53 #define POPT_EN_MCD_RAMCART (1<<15)\r
54 #define POPT_DIS_VDP_FIFO   (1<<16) // 0x 0000\r
55 #define POPT_EN_SVP_DRC     (1<<17)\r
56 #define POPT_DIS_SPRITE_LIM (1<<18)\r
57 #define POPT_DIS_IDLE_DET   (1<<19)\r
58 extern int PicoOpt; // bitfield\r
59 #define PAHW_MCD  (1<<0)\r
60 #define PAHW_32X  (1<<1)\r
61 #define PAHW_SVP  (1<<2)\r
62 #define PAHW_PICO (1<<3)\r
63 #define PAHW_SMS  (1<<4)\r
64 extern int PicoAHW;            // Pico active hw\r
65 extern int PicoVer;\r
66 extern int PicoSkipFrame;      // skip rendering frame, but still do sound (if enabled) and emulation stuff\r
67 extern int PicoRegionOverride; // override the region detection 0: auto, 1: Japan NTSC, 2: Japan PAL, 4: US, 8: Europe\r
68 extern int PicoAutoRgnOrder;   // packed priority list of regions, for example 0x148 means this detection order: EUR, USA, JAP\r
69 extern int PicoSVPCycles;\r
70 void PicoInit(void);\r
71 void PicoExit(void);\r
72 void PicoPower(void);\r
73 int  PicoReset(void);\r
74 void PicoFrame(void);\r
75 void PicoFrameDrawOnly(void);\r
76 extern int PicoPad[2]; // Joypads, format is MXYZ SACB RLDU\r
77 extern void (*PicoWriteSound)(int len); // called once per frame at the best time to send sound buffer (PsndOut) to hardware\r
78 extern void (*PicoMessage)(const char *msg); // callback to output text message from emu\r
79 typedef enum { PI_ROM, PI_ISPAL, PI_IS40_CELL, PI_IS240_LINES } pint_t;\r
80 typedef union { int vint; void *vptr; } pint_ret_t;\r
81 void PicoGetInternal(pint_t which, pint_ret_t *ret);\r
82 \r
83 // cd/Pico.c\r
84 extern void (*PicoMCDopenTray)(void);\r
85 extern void (*PicoMCDcloseTray)(void);\r
86 extern int PicoCDBuffers;\r
87 \r
88 // Pico/Pico.c\r
89 #define XPCM_BUFFER_SIZE (320+160)\r
90 typedef struct\r
91 {\r
92         int pen_pos[2];\r
93         int page;\r
94         // internal\r
95         int fifo_bytes;      // bytes in FIFO\r
96         int fifo_bytes_prev;\r
97         int fifo_line_bytes; // float part, << 16\r
98         int line_counter;\r
99         unsigned short r1, r12;\r
100         unsigned char xpcm_buffer[XPCM_BUFFER_SIZE+4];\r
101         unsigned char *xpcm_ptr;\r
102 } picohw_state;\r
103 extern picohw_state PicoPicohw;\r
104 \r
105 // area.c\r
106 int PicoState(const char *fname, int is_save);\r
107 int PicoStateLoadVDP(const char *fname);\r
108 extern void (*PicoStateProgressCB)(const char *str);\r
109 \r
110 // cd/area.c\r
111 int  PicoCdLoadStateGfx(void *file);\r
112 \r
113 // cd/buffering.c\r
114 void PicoCDBufferInit(void);\r
115 void PicoCDBufferFree(void);\r
116 void PicoCDBufferFlush(void);\r
117 \r
118 // cd/cd_sys.c\r
119 int Insert_CD(const char *cdimg_name, int type);\r
120 void Stop_CD(void); // releases all resources taken when CD game was started.\r
121 \r
122 // Cart.c\r
123 typedef enum\r
124 {\r
125         PMT_UNCOMPRESSED = 0,\r
126         PMT_ZIP,\r
127         PMT_CSO\r
128 } pm_type;\r
129 typedef struct\r
130 {\r
131         void *file;             /* file handle */\r
132         void *param;            /* additional file related field */\r
133         unsigned int size;      /* size */\r
134         pm_type type;\r
135         char ext[4];\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,int is_sms);\r
142 int PicoCartInsert(unsigned char *rom,unsigned int romsize);\r
143 void PicoCartUnload(void);\r
144 extern void (*PicoCartLoadProgressCB)(int percent);\r
145 extern void (*PicoCDLoadProgressCB)(const char *fname, int percent);\r
146 \r
147 // Draw.c\r
148 void PicoDrawSetColorFormat(int which); // 0=BGR444, 1=RGB555, 2=8bit(HighPal pal)\r
149 extern void *DrawLineDest;\r
150 #if OVERRIDE_HIGHCOL\r
151 extern unsigned char *HighCol;\r
152 #else\r
153 extern unsigned char  HighCol[8+320+8];\r
154 #endif\r
155 extern int (*PicoScanBegin)(unsigned int num);\r
156 extern int (*PicoScanEnd)(unsigned int num);\r
157 // utility\r
158 #ifdef _ASM_DRAW_C\r
159 void vidConvCpyRGB565(void *to, void *from, int pixels);\r
160 #endif\r
161 void PicoDoHighPal555(int sh);\r
162 extern int PicoDrawMask;\r
163 #define PDRAW_LAYERB_ON      (1<<2)\r
164 #define PDRAW_LAYERA_ON      (1<<3)\r
165 #define PDRAW_SPRITES_LOW_ON (1<<4)\r
166 #define PDRAW_SPRITES_HI_ON  (1<<7)\r
167 // internals\r
168 #define PDRAW_SPRITES_MOVED (1<<0) // (asm)\r
169 #define PDRAW_WND_DIFF_PRIO (1<<1) // not all window tiles use same priority\r
170 #define PDRAW_SPR_LO_ON_HI  (1<<2) // seen sprites without layer pri bit ontop spr. with that bit\r
171 #define PDRAW_INTERLACE     (1<<3)\r
172 #define PDRAW_DIRTY_SPRITES (1<<4) // (asm)\r
173 #define PDRAW_SONIC_MODE    (1<<5) // mid-frame palette changes for 8bit renderer\r
174 #define PDRAW_PLANE_HI_PRIO (1<<6) // have layer with all hi prio tiles (mk3)\r
175 #define PDRAW_SHHI_DONE     (1<<7) // layer sh/hi already processed\r
176 #define PDRAW_240LINES      (1<<8) // 240 line display (224 if not set)\r
177 extern int rendstatus, rendstatus_old;\r
178 extern unsigned short HighPal[0x100];\r
179 \r
180 // Draw2.c\r
181 // stuff below is optional\r
182 extern unsigned char  *PicoDraw2FB;  // buffer for fast renderer in format (8+320)x(8+224+8) (eights for borders)\r
183 extern unsigned short *PicoCramHigh; // pointer to CRAM buff (0x40 shorts), converted to native device color (works only with 16bit for now)\r
184 extern void (*PicoPrepareCram)();    // prepares PicoCramHigh for renderer to use\r
185 \r
186 // sound.c\r
187 extern int PsndRate,PsndLen;\r
188 extern short *PsndOut;\r
189 extern void (*PsndMix_32_to_16l)(short *dest, int *src, int count);\r
190 void PsndRerate(int preserve_state);\r
191 \r
192 // Utils.c\r
193 extern int PicuAnd;\r
194 int PicuQuick(unsigned short *dest,unsigned short *src);\r
195 int PicuShrink(unsigned short *dest,int destLen,unsigned short *src,int srcLen);\r
196 int PicuShrinkReverse(unsigned short *dest,int destLen,unsigned short *src,int srcLen);\r
197 int PicuMerge(unsigned short *dest,int destLen,unsigned short *src,int srcLen);\r
198 \r
199 #ifdef __cplusplus\r
200 } // End of extern "C"\r
201 #endif\r
202 \r
203 #endif // PICO_H\r