pico.h 9.9 KB

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