fix DrawSpritesHiAS
[picodrive.git] / pico / pico.h
CommitLineData
cff531af 1/*\r
2 * PicoDrive\r
3 * (c) Copyright Dave, 2004\r
4 * (C) notaz, 2006-2010\r
5 *\r
6 * This work is licensed under the terms of MAME license.\r
7 * See COPYING file in the top-level directory.\r
8 */\r
cc68a136 9\r
10#ifndef PICO_H\r
11#define PICO_H\r
12\r
21ebcfd3 13#include <stdlib.h> // size_t\r
eff55556 14\r
cc68a136 15#ifdef __cplusplus\r
16extern "C" {\r
17#endif\r
18\r
2446536b 19// message log\r
20extern void lprintf(const char *fmt, ...);\r
21\r
75736070 22// external funcs for Sega/Mega CD\r
7c18e34a 23extern int mp3_get_bitrate(void *f, int size);\r
24extern void mp3_start_play(void *f, int pos);\r
84100c0f 25extern void mp3_update(int *buffer, int length, int stereo);\r
26\r
27// this function should write-back d-cache and invalidate i-cache\r
28// on a mem region [start_addr, end_addr)\r
b081408f 29// used by dynarecs\r
2446536b 30extern void cache_flush_d_inval_i(void *start_addr, void *end_addr);\r
cb0316e4 31\r
b081408f 32// attempt to alloc mem at specified address.\r
33// alloc anywhere else if that fails (callers should handle that)\r
e743be20 34extern void *plat_mmap(unsigned long addr, size_t size, int need_exec, int is_fixed);\r
b4db550e 35extern void *plat_mremap(void *ptr, size_t oldsize, size_t newsize);\r
b081408f 36extern void plat_munmap(void *ptr, size_t size);\r
df925153 37\r
38// memory for the dynarec; plat_mem_get_for_drc() can just return NULL\r
39extern void *plat_mem_get_for_drc(size_t size);\r
c25d78ee 40extern int plat_mem_set_exec(void *ptr, size_t size);\r
b081408f 41\r
19954be1 42// this one should handle display mode changes\r
43extern void emu_video_mode_change(int start_line, int line_count, int is_32cols);\r
44\r
ae87bffa 45// this must switch to 16bpp mode\r
974fdb5b 46extern void emu_32x_startup(void);\r
47\r
83ff19ec 48// optional 32X BIOS, should be left NULL if not used\r
49// must be 256, 2048, 1024 bytes\r
50extern void *p32x_bios_g, *p32x_bios_m, *p32x_bios_s;\r
51\r
cc68a136 52// Pico.c\r
602133e1 53#define POPT_EN_FM (1<< 0) // 00 000x\r
54#define POPT_EN_PSG (1<< 1)\r
55#define POPT_EN_Z80 (1<< 2)\r
56#define POPT_EN_STEREO (1<< 3)\r
57#define POPT_ALT_RENDERER (1<< 4) // 00 00x0\r
531a8f38 58// unused (1<< 5)\r
2aa27095 59// unused (1<< 6)\r
602133e1 60#define POPT_ACC_SPRITES (1<< 7)\r
61#define POPT_DIS_32C_BORDER (1<< 8) // 00 0x00\r
62#define POPT_EXT_FM (1<< 9)\r
63#define POPT_EN_MCD_PCM (1<<10)\r
64#define POPT_EN_MCD_CDDA (1<<11)\r
65#define POPT_EN_MCD_GFX (1<<12) // 00 x000\r
92dfd9af 66// unused (1<<13)\r
602133e1 67#define POPT_EN_SOFTSCALE (1<<14)\r
68#define POPT_EN_MCD_RAMCART (1<<15)\r
69#define POPT_DIS_VDP_FIFO (1<<16) // 0x 0000\r
92dfd9af 70#define POPT_EN_DRC (1<<17)\r
381eea9b 71#define POPT_DIS_SPRITE_LIM (1<<18)\r
053fd9b4 72#define POPT_DIS_IDLE_DET (1<<19)\r
db1d3564 73#define POPT_EN_32X (1<<20)\r
74#define POPT_EN_PWM (1<<21)\r
be2c4208 75\r
fa22af4c 76#define PAHW_MCD (1<<0)\r
77#define PAHW_32X (1<<1)\r
78#define PAHW_SVP (1<<2)\r
79#define PAHW_PICO (1<<3)\r
3e49ffd0 80#define PAHW_SMS (1<<4)\r
a76fad41 81\r
82#define PQUIRK_FORCE_6BTN (1<<0)\r
a76fad41 83\r
93f9619e 84// the emulator is configured and some status is reported\r
85// through this global state (not saved in savestates)\r
86typedef struct\r
87{\r
88 unsigned int opt; // POPT_* bitfield\r
89\r
90 unsigned short pad[2]; // Joypads, format is MXYZ SACB RLDU\r
91 unsigned short padInt[2]; // internal copy\r
92 unsigned short AHW; // active addon hardware: PAHW_* bitfield\r
93\r
94 unsigned short skipFrame; // skip rendering frame, but still do sound (if enabled) and emulation stuff\r
95 unsigned short regionOverride; // override the region detection 0: auto, 1: Japan NTSC, 2: Japan PAL, 4: US, 8: Europe\r
96 unsigned short autoRgnOrder; // packed priority list of regions, for example 0x148 means this detection order: EUR, USA, JAP\r
97\r
98 unsigned short quirks; // game-specific quirks: PQUIRK_*\r
35f2b65e 99 unsigned short overclockM68k; // overclock the emulated 68k, in %\r
6311a3ba 100\r
101 int sndRate; // rate in Hz\r
102 short *sndOut; // PCM output buffer\r
103 void (*writeSound)(int len); // write .sndOut callback, called once per frame\r
104\r
105 void (*osdMessage)(const char *msg); // output OSD message from emu, optional\r
106\r
107 void (*mcdTrayOpen)(void);\r
108 void (*mcdTrayClose)(void);\r
93f9619e 109} PicoInterface;\r
110\r
111extern PicoInterface PicoIn;\r
112\r
2aa27095 113void PicoInit(void);\r
cc68a136 114void PicoExit(void);\r
1cb1584b 115void PicoPower(void);\r
116int PicoReset(void);\r
5e128c6d 117void PicoLoopPrepare(void);\r
2aa27095 118void PicoFrame(void);\r
a12e0116 119void PicoFrameDrawOnly(void);\r
4609d0cd 120typedef enum { PI_ROM, PI_ISPAL, PI_IS40_CELL, PI_IS240_LINES } pint_t;\r
121typedef union { int vint; void *vptr; } pint_ret_t;\r
122void PicoGetInternal(pint_t which, pint_ret_t *ret);\r
cc68a136 123\r
ea38612f 124struct PicoEState;\r
125\r
f3a57b2d 126// pico.c\r
ed367a3f 127#define XPCM_BUFFER_SIZE (320+160)\r
d49b10c2 128typedef struct\r
129{\r
130 int pen_pos[2];\r
131 int page;\r
132 // internal\r
fa22af4c 133 int fifo_bytes; // bytes in FIFO\r
134 int fifo_bytes_prev;\r
ef4eb506 135 int fifo_line_bytes; // float part, << 16\r
d49b10c2 136 int line_counter;\r
ef4eb506 137 unsigned short r1, r12;\r
138 unsigned char xpcm_buffer[XPCM_BUFFER_SIZE+4];\r
139 unsigned char *xpcm_ptr;\r
d49b10c2 140} picohw_state;\r
141extern picohw_state PicoPicohw;\r
406c96c5 142\r
bcc9eda0 143// area.c\r
144int PicoState(const char *fname, int is_save);\r
b4db550e 145int PicoStateLoadGfx(const char *fname);\r
146void *PicoTmpStateSave(void);\r
147void PicoTmpStateRestore(void *data);\r
76276b0b 148extern void (*PicoStateProgressCB)(const char *str);\r
cc68a136 149\r
274fcc35 150// cd/cdd.c\r
151int cdd_load(const char *filename, int type);\r
152int cdd_unload(void);\r
eff55556 153\r
cc68a136 154// Cart.c\r
83bd0b76 155typedef enum\r
156{\r
157 PMT_UNCOMPRESSED = 0,\r
71de3cd9 158 PMT_ZIP,\r
159 PMT_CSO\r
83bd0b76 160} pm_type;\r
161typedef struct\r
162{\r
163 void *file; /* file handle */\r
164 void *param; /* additional file related field */\r
165 unsigned int size; /* size */\r
166 pm_type type;\r
87b0845f 167 char ext[4];\r
83bd0b76 168} pm_file;\r
169pm_file *pm_open(const char *path);\r
170size_t pm_read(void *ptr, size_t bytes, pm_file *stream);\r
171int pm_seek(pm_file *stream, long offset, int whence);\r
172int pm_close(pm_file *fp);\r
3e49ffd0 173int PicoCartLoad(pm_file *f,unsigned char **prom,unsigned int *psize,int is_sms);\r
ae87bffa 174int PicoCartInsert(unsigned char *rom, unsigned int romsize, const char *carthw_cfg);\r
2aa27095 175void PicoCartUnload(void);\r
a9b3ffd3 176extern void (*PicoCartLoadProgressCB)(int percent);\r
b2451ac6 177extern void (*PicoCDLoadProgressCB)(const char *fname, int percent);\r
4c2e3554 178extern int PicoGameLoaded;\r
cc68a136 179\r
180// Draw.c\r
5a681086 181// for line-based renderer, set conversion\r
182// from internal 8 bit representation in 'HighCol' to:\r
183typedef enum\r
184{\r
185 PDF_NONE = 0, // no conversion\r
186 PDF_RGB555, // RGB/BGR output, depends on compile options\r
187 PDF_8BIT, // 8-bit out (handles shadow/hilight mode, sonic water)\r
188} pdso_t;\r
41946d70 189void PicoDrawSetOutFormat(pdso_t which, int use_32x_line_mode);\r
5a681086 190void PicoDrawSetOutBuf(void *dest, int increment);\r
f4750ee0 191void PicoDrawSetCallbacks(int (*begin)(unsigned int num), int (*end)(unsigned int num));\r
cc68a136 192// utility\r
193#ifdef _ASM_DRAW_C\r
ea8c405f 194void vidConvCpyRGB565(void *to, void *from, int pixels);\r
cc68a136 195#endif\r
ea38612f 196void PicoDoHighPal555(int sh, int line, struct PicoEState *est);\r
602133e1 197// internals\r
947fb5f9 198#define PDRAW_SPRITES_MOVED (1<<0) // (asm)\r
602133e1 199#define PDRAW_WND_DIFF_PRIO (1<<1) // not all window tiles use same priority\r
947fb5f9 200#define PDRAW_INTERLACE (1<<3)\r
201#define PDRAW_DIRTY_SPRITES (1<<4) // (asm)\r
602133e1 202#define PDRAW_SONIC_MODE (1<<5) // mid-frame palette changes for 8bit renderer\r
203#define PDRAW_PLANE_HI_PRIO (1<<6) // have layer with all hi prio tiles (mk3)\r
204#define PDRAW_SHHI_DONE (1<<7) // layer sh/hi already processed\r
ae87bffa 205#define PDRAW_32_COLS (1<<8) // 32 column mode\r
ea38612f 206extern int rendstatus_old;\r
ae87bffa 207extern int rendlines;\r
cc68a136 208\r
5a681086 209// draw.c\r
210void PicoDrawUpdateHighPal(void);\r
211void PicoDrawSetInternalBuf(void *dest, int line_increment);\r
212\r
213// draw2.c\r
cc68a136 214// stuff below is optional\r
215extern unsigned short *PicoCramHigh; // pointer to CRAM buff (0x40 shorts), converted to native device color (works only with 16bit for now)\r
216extern void (*PicoPrepareCram)(); // prepares PicoCramHigh for renderer to use\r
217\r
f3a57b2d 218// pico.c (32x)\r
ed4402a7 219#ifndef NO_32X\r
220\r
221void Pico32xSetClocks(int msh2_hz, int ssh2_hz);\r
fcdefcf6 222\r
ed4402a7 223#else\r
224\r
225#define Pico32xSetClocks(msh2_khz, ssh2_khz)\r
226\r
227#endif\r
228\r
229// normally 68k clock (7670442) * 3, in reality but much lower\r
230// because of high memory latencies\r
231#define PICO_MSH2_HZ ((int)(7670442.0 * 2.4))\r
232#define PICO_SSH2_HZ ((int)(7670442.0 * 2.4))\r
233\r
cc68a136 234// sound.c\r
4a32f01f 235extern void (*PsndMix_32_to_16l)(short *dest, int *src, int count);\r
9d917eea 236void PsndRerate(int preserve_state);\r
cc68a136 237\r
4c2e3554 238// media.c\r
239enum media_type_e {\r
240 PM_BAD_DETECT = -1,\r
241 PM_ERROR = -2,\r
242 PM_BAD_CD = -3,\r
243 PM_BAD_CD_NO_BIOS = -4,\r
244 PM_MD_CART = 1, /* also 32x */\r
245 PM_MARK3,\r
246 PM_CD,\r
247};\r
274fcc35 248\r
249enum cd_img_type\r
250{\r
251 CIT_NOT_CD = 0,\r
252 CIT_ISO,\r
253 CIT_BIN,\r
254 CIT_CUE\r
255};\r
256\r
4c2e3554 257enum media_type_e PicoLoadMedia(const char *filename,\r
258 const char *carthw_cfg_fname,\r
259 const char *(*get_bios_filename)(int *region, const char *cd_fname),\r
260 void (*do_region_override)(const char *media_filename));\r
261int PicoCdCheck(const char *fname_in, int *pregion);\r
262\r
263extern unsigned char media_id_header[0x100];\r
264\r
531a8f38 265// memory.c\r
266enum input_device {\r
267 PICO_INPUT_NOTHING,\r
268 PICO_INPUT_PAD_3BTN,\r
269 PICO_INPUT_PAD_6BTN,\r
270};\r
271void PicoSetInputDevice(int port, enum input_device device);\r
272\r
cc68a136 273#ifdef __cplusplus\r
274} // End of extern "C"\r
275#endif\r
276\r
277#endif // PICO_H\r