pico/pico.h

   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
   9 \r
  10 #ifndef PICO_H\r
  11 #define PICO_H\r
  12 \r
  13 #include <stdlib.h> // size_t\r
  14 \r
  15 #ifdef __cplusplus\r
  16 extern "C" {\r
  17 #endif\r
  18 \r
  19 // message log\r
  20 extern void lprintf(const char *fmt, ...);\r
  21 \r
  22 // external funcs for Sega/Mega CD\r
  23 extern int  mp3_get_bitrate(void *f, int size);\r
  24 extern void mp3_start_play(void *f, int pos);\r
  25 extern 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
  29 // used by dynarecs\r
  30 extern void cache_flush_d_inval_i(void *start_addr, void *end_addr);\r
  31 \r
  32 // attempt to alloc mem at specified address.\r
  33 // alloc anywhere else if that fails (callers should handle that)\r
  34 extern void *plat_mmap(unsigned long addr, size_t size, int need_exec, int is_fixed);\r
  35 extern void *plat_mremap(void *ptr, size_t oldsize, size_t newsize);\r
  36 extern void  plat_munmap(void *ptr, size_t size);\r
  37 \r
  38 // memory for the dynarec; plat_mem_get_for_drc() can just return NULL\r
  39 extern void *plat_mem_get_for_drc(size_t size);\r
  40 extern int   plat_mem_set_exec(void *ptr, size_t size);\r
  41 \r
  42 // this one should handle display mode changes\r
  43 extern void emu_video_mode_change(int start_line, int line_count, int is_32cols);\r
  44 \r
  45 // this must switch to 16bpp mode\r
  46 extern void emu_32x_startup(void);\r
  47 \r
  48 // optional 32X BIOS, should be left NULL if not used\r
  49 // must be 256, 2048, 1024 bytes\r
  50 extern void *p32x_bios_g, *p32x_bios_m, *p32x_bios_s;\r
  51 \r
  52 // Pico.c\r
  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
  58 // unused                   (1<< 5)\r
  59 // unused                   (1<< 6)\r
  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
  66 // unused                   (1<<13)\r
  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
  70 #define POPT_EN_DRC         (1<<17)\r
  71 #define POPT_DIS_SPRITE_LIM (1<<18)\r
  72 #define POPT_DIS_IDLE_DET   (1<<19)\r
  73 #define POPT_EN_32X         (1<<20)\r
  74 #define POPT_EN_PWM         (1<<21)\r
  75 extern int PicoOpt; // bitfield\r
  76 \r
  77 #define PAHW_MCD  (1<<0)\r
  78 #define PAHW_32X  (1<<1)\r
  79 #define PAHW_SVP  (1<<2)\r
  80 #define PAHW_PICO (1<<3)\r
  81 #define PAHW_SMS  (1<<4)\r
  82 extern int PicoAHW;            // Pico active hw\r
  83 \r
  84 #define PQUIRK_FORCE_6BTN   (1<<0)\r
  85 extern int PicoQuirks;\r
  86 \r
  87 extern int PicoSkipFrame;      // skip rendering frame, but still do sound (if enabled) and emulation stuff\r
  88 extern int PicoRegionOverride; // override the region detection 0: auto, 1: Japan NTSC, 2: Japan PAL, 4: US, 8: Europe\r
  89 extern int PicoAutoRgnOrder;   // packed priority list of regions, for example 0x148 means this detection order: EUR, USA, JAP\r
  90 extern int PicoSVPCycles;\r
  91 void PicoInit(void);\r
  92 void PicoExit(void);\r
  93 void PicoPower(void);\r
  94 int  PicoReset(void);\r
  95 void PicoLoopPrepare(void);\r
  96 void PicoFrame(void);\r
  97 void PicoFrameDrawOnly(void);\r
  98 extern int PicoPad[2]; // Joypads, format is MXYZ SACB RLDU\r
  99 extern void (*PicoWriteSound)(int bytes); // called once per frame at the best time to send sound buffer (PsndOut) to hardware\r
 100 extern void (*PicoMessage)(const char *msg); // callback to output text message from emu\r
 101 typedef enum { PI_ROM, PI_ISPAL, PI_IS40_CELL, PI_IS240_LINES } pint_t;\r
 102 typedef union { int vint; void *vptr; } pint_ret_t;\r
 103 void PicoGetInternal(pint_t which, pint_ret_t *ret);\r
 104 \r
 105 struct PicoEState;\r
 106 \r
 107 // cd/mcd.c\r
 108 extern void (*PicoMCDopenTray)(void);\r
 109 extern void (*PicoMCDcloseTray)(void);\r
 110 \r
 111 // pico.c\r
 112 #define XPCM_BUFFER_SIZE (320+160)\r
 113 typedef struct\r
 114 {\r
 115         int pen_pos[2];\r
 116         int page;\r
 117         // internal\r
 118         int fifo_bytes;      // bytes in FIFO\r
 119         int fifo_bytes_prev;\r
 120         int fifo_line_bytes; // float part, << 16\r
 121         int line_counter;\r
 122         unsigned short r1, r12;\r
 123         unsigned char xpcm_buffer[XPCM_BUFFER_SIZE+4];\r
 124         unsigned char *xpcm_ptr;\r
 125 } picohw_state;\r
 126 extern picohw_state PicoPicohw;\r
 127 \r
 128 // area.c\r
 129 int PicoState(const char *fname, int is_save);\r
 130 int PicoStateLoadGfx(const char *fname);\r
 131 void *PicoTmpStateSave(void);\r
 132 void  PicoTmpStateRestore(void *data);\r
 133 extern void (*PicoStateProgressCB)(const char *str);\r
 134 \r
 135 // cd/cdd.c\r
 136 int cdd_load(const char *filename, int type);\r
 137 int cdd_unload(void);\r
 138 \r
 139 // Cart.c\r
 140 typedef enum\r
 141 {\r
 142         PMT_UNCOMPRESSED = 0,\r
 143         PMT_ZIP,\r
 144         PMT_CSO\r
 145 } pm_type;\r
 146 typedef struct\r
 147 {\r
 148         void *file;             /* file handle */\r
 149         void *param;            /* additional file related field */\r
 150         unsigned int size;      /* size */\r
 151         pm_type type;\r
 152         char ext[4];\r
 153 } pm_file;\r
 154 pm_file *pm_open(const char *path);\r
 155 size_t   pm_read(void *ptr, size_t bytes, pm_file *stream);\r
 156 int      pm_seek(pm_file *stream, long offset, int whence);\r
 157 int      pm_close(pm_file *fp);\r
 158 int PicoCartLoad(pm_file *f,unsigned char **prom,unsigned int *psize,int is_sms);\r
 159 int PicoCartInsert(unsigned char *rom, unsigned int romsize, const char *carthw_cfg);\r
 160 void PicoCartUnload(void);\r
 161 extern void (*PicoCartLoadProgressCB)(int percent);\r
 162 extern void (*PicoCDLoadProgressCB)(const char *fname, int percent);\r
 163 extern int PicoGameLoaded;\r
 164 \r
 165 // Draw.c\r
 166 // for line-based renderer, set conversion\r
 167 // from internal 8 bit representation in 'HighCol' to:\r
 168 typedef enum\r
 169 {\r
 170         PDF_NONE = 0,    // no conversion\r
 171         PDF_RGB555,      // RGB/BGR output, depends on compile options\r
 172         PDF_8BIT,        // 8-bit out (handles shadow/hilight mode, sonic water)\r
 173 } pdso_t;\r
 174 void PicoDrawSetOutFormat(pdso_t which, int use_32x_line_mode);\r
 175 void PicoDrawSetOutBuf(void *dest, int increment);\r
 176 void PicoDrawSetCallbacks(int (*begin)(unsigned int num), int (*end)(unsigned int num));\r
 177 // utility\r
 178 #ifdef _ASM_DRAW_C\r
 179 void vidConvCpyRGB565(void *to, void *from, int pixels);\r
 180 #endif\r
 181 void PicoDoHighPal555(int sh, int line, struct PicoEState *est);\r
 182 // internals\r
 183 #define PDRAW_SPRITES_MOVED (1<<0) // (asm)\r
 184 #define PDRAW_WND_DIFF_PRIO (1<<1) // not all window tiles use same priority\r
 185 #define PDRAW_SPR_LO_ON_HI  (1<<2) // seen sprites without layer pri bit ontop spr. with that bit\r
 186 #define PDRAW_INTERLACE     (1<<3)\r
 187 #define PDRAW_DIRTY_SPRITES (1<<4) // (asm)\r
 188 #define PDRAW_SONIC_MODE    (1<<5) // mid-frame palette changes for 8bit renderer\r
 189 #define PDRAW_PLANE_HI_PRIO (1<<6) // have layer with all hi prio tiles (mk3)\r
 190 #define PDRAW_SHHI_DONE     (1<<7) // layer sh/hi already processed\r
 191 #define PDRAW_32_COLS       (1<<8) // 32 column mode\r
 192 extern int rendstatus_old;\r
 193 extern int rendlines;\r
 194 \r
 195 // draw.c\r
 196 void PicoDrawUpdateHighPal(void);\r
 197 void PicoDrawSetInternalBuf(void *dest, int line_increment);\r
 198 \r
 199 // draw2.c\r
 200 // stuff below is optional\r
 201 extern unsigned short *PicoCramHigh; // pointer to CRAM buff (0x40 shorts), converted to native device color (works only with 16bit for now)\r
 202 extern void (*PicoPrepareCram)();    // prepares PicoCramHigh for renderer to use\r
 203 \r
 204 // pico.c (32x)\r
 205 #ifndef NO_32X\r
 206 \r
 207 void Pico32xSetClocks(int msh2_hz, int ssh2_hz);\r
 208 \r
 209 #else\r
 210 \r
 211 #define Pico32xSetClocks(msh2_khz, ssh2_khz)\r
 212 \r
 213 #endif\r
 214 \r
 215 // normally 68k clock (7670442) * 3, in reality but much lower\r
 216 // because of high memory latencies\r
 217 #define PICO_MSH2_HZ ((int)(7670442.0 * 2.4))\r
 218 #define PICO_SSH2_HZ ((int)(7670442.0 * 2.4))\r
 219 \r
 220 // sound.c\r
 221 extern int PsndRate,PsndLen;\r
 222 extern short *PsndOut;\r
 223 extern void (*PsndMix_32_to_16l)(short *dest, int *src, int count);\r
 224 void PsndRerate(int preserve_state);\r
 225 \r
 226 // media.c\r
 227 enum media_type_e {\r
 228   PM_BAD_DETECT = -1,\r
 229   PM_ERROR = -2,\r
 230   PM_BAD_CD = -3,\r
 231   PM_BAD_CD_NO_BIOS = -4,\r
 232   PM_MD_CART = 1,       /* also 32x */\r
 233   PM_MARK3,\r
 234   PM_CD,\r
 235 };\r
 236 \r
 237 enum cd_img_type\r
 238 {\r
 239   CIT_NOT_CD = 0,\r
 240   CIT_ISO,\r
 241   CIT_BIN,\r
 242   CIT_CUE\r
 243 };\r
 244 \r
 245 enum media_type_e PicoLoadMedia(const char *filename,\r
 246   const char *carthw_cfg_fname,\r
 247   const char *(*get_bios_filename)(int *region, const char *cd_fname),\r
 248   void (*do_region_override)(const char *media_filename));\r
 249 int PicoCdCheck(const char *fname_in, int *pregion);\r
 250 \r
 251 extern unsigned char media_id_header[0x100];\r
 252 \r
 253 // memory.c\r
 254 enum input_device {\r
 255   PICO_INPUT_NOTHING,\r
 256   PICO_INPUT_PAD_3BTN,\r
 257   PICO_INPUT_PAD_6BTN,\r
 258 };\r
 259 void PicoSetInputDevice(int port, enum input_device device);\r
 260 \r
 261 #ifdef __cplusplus\r
 262 } // End of extern "C"\r
 263 #endif\r
 264 \r
 265 #endif // PICO_H\r