romdev-mcp 0.1.1

package/src/platforms/snes/lib/pvsneslib/include/snes/interrupt.h

@@ -0,0 +1,264 @@
+/*---------------------------------------------------------------------------------
+
+    Interrupt registers and vector pointers
+
+    Copyright (C) 2012-2017
+        Alekmaul
+
+    This software is provided 'as-is', without any express or implied
+    warranty.  In no event will the authors be held liable for any
+    damages arising from the use of this software.
+
+    Permission is granted to anyone to use this software for any
+    purpose, including commercial applications, and to alter it and
+    redistribute it freely, subject to the following restrictions:
+
+    1.	The origin of this software must not be misrepresented; you
+        must not claim that you wrote the original software. If you use
+        this software in a product, an acknowledgment in the product
+        documentation would be appreciated but is not required.
+
+    2.	Altered source versions must be plainly marked as such, and
+        must not be misrepresented as being the original software.
+
+    3.	This notice may not be removed or altered from any source
+        distribution.
+
+
+---------------------------------------------------------------------------------*/
+
+/*!
+ * \file interrupt.h
+ * \brief snes interrupt support.
+ *
+ * <h2>VBlank ISR \anchor VBlank-ISR</h2>
+ *
+ * PVSnesLib includes a Vertical Blank Interrupt Service Routine (VBlank ISR or NMI ISR) that will
+ * do the following actions (in this order) at the start of the Vertical Blanking Period when
+ * VBlank interrupts are enabled:
+ *  - Transfer #oamMemory to the PPU OAM on non lag-frames.
+ *  - Call #nmi_handler.
+ *  - Increment #snes_vblank_count.
+ *  - Read inputs from the controller ports on non lag-frames (see input.h).
+ *  - Increment #lag_frame_counter on lag-frames.
+ *
+ * A lag-frame is when the execution time between two WaitForVBlank() calls exceeds a 50/60Hz
+ * display frame.  By testing for lag-frames, the VBlank ISR will not transfer a partially
+ * populated #oamMemory to the PPU OAM.
+ *
+ * Lag-frames are determined by the #vblank_flag variable, which is set on WaitForVBlank() and
+ * cleared in the VBlank ISR.
+ *
+ * Inputs are only read on non lag-frames to prevent the input state from unexpectedly changing in
+ * the middle of the main loop (potentially causing a heisenbug).  Code that loops until a button
+ * is pressed must call WaitForVBlank() within the loop otherwise it will loop forever.
+ *
+ * The #nmi_handler function pointer (set using nmiSet()) is called on \b every VBlank interrupt
+ * (even during force-blank / setScreenOff()).
+ * To prevent glitches, #nmi_handler's should either:
+ *  - Test #vblank_flag and only update the PPU registers/memory if the #vblank_flag is set.
+ *  - Use locks or flags on every buffer/queue to prevent partially populated data from being transferred to the PPU.
+ *
+ */
+
+#ifndef SNES_INTERRUPT_INCLUDE
+#define SNES_INTERRUPT_INCLUDE
+
+#include <snes/snestypes.h>
+
+/**
+ * \brief VBlank ISR flag.
+ *
+ * Used to detect lag-frames in the VBlank ISR.
+ *
+ * This variable is set to a truthy (non-zero) value in WaitForVBlank()
+ * and cleared in the NMI ISR after the call to nmi_handler.
+ *
+ * vblank_flag can be used in a custom nmi_handler to detect lag frames.  Within nmi_handler:
+ *  - If vblank_flag is truthy (non-zero), the nmi_handler was called at the end of the frame.
+ *  - If vblank_flag is 0, the nmi_handler was called in the middle of a lag frame.
+ *
+ * \b CAUTION: This variable SHOULD NOT be changed outside of WaitForVBlank()
+ */
+extern u8 vblank_flag;
+
+/**
+ * \brief Lag-frame counter.
+ *
+ * This variable is incremented on every VBlank Interrupt that occurs during a lag-frame.
+ *
+ * \b CAUTION: The lag frame counter cannot tell the difference between a lag-frame and
+ * force-blank setup loading graphics to the PPU.
+ *
+ * \c lag_frame_counter can be modified.  This is useful in development builds to measure the
+ * amount of lag in a level by resetting \c lag_frame_counter on level load and printing
+ * \c lag_frame_counter on a pause screen or at the end of the level.
+ */
+extern u16 lag_frame_counter;
+
+/**
+ * \brief VBlank routine
+ *
+ * This function is called on \b every VBlank interrupt by the \ref VBlank-ISR "VBlank Interrupt Service Routine".
+ *
+ * \b CAUTION: Writes to \c nmi_handler are <b>not atomic</b> and can cause a crash if a VBlank
+ * Interrupt occurs in the middle of the \c nmi_handler write.  Use nmiSet() or disable NMI
+ * interrupts when modifying \c nmi_handler.
+ *
+ * <b>Assembly note:</b> This function pointer will be called with a non-zero Direct Page register
+ * to prevent \c nmi_handler from clobbering the tcc imaginary registers.
+ *
+ * \see \ref VBlank-ISR, nmiSet()
+ */
+extern void *nmi_handler;
+
+/** \brief VBlank NMI Enable  (0=Disable, 1=Enable) (Initially disabled on reset) */
+#define INT_VBLENABLE		(1 << 7) 
+/** \brief H/V IRQ (0=Disable, 1=At H=H + V=Any, 2=At V=V + H=0, 3=At H=H + V=V) */
+#define INT_HVIRQ_H			(1 << 4)   
+/** \brief H/V IRQ (0=Disable, 1=At H=H + V=Any, 2=At V=V + H=0, 3=At H=H + V=V) */
+#define INT_HVIRQ_V			(1 << 5)  
+/** \brief H/V IRQ (0=Disable, 1=At H=H + V=Any, 2=At V=V + H=0, 3=At H=H + V=V) */ 
+#define INT_HVIRQ_HV		(2 << 4)  
+/** \brief Joypad Enable    (0=Disable, 1=Enable Automatic Reading of Joypad) */
+#define INT_JOYPAD_ENABLE 	(1)  
+/** \brief V-Blank Period Flag (0=No, 1=VBlank)*/
+#define VBL_READY 			(1 << 7)     
+/** \brief H-Blank Period Flag (0=No, 1=HBlank)*/
+#define HBL_READY 			(1 << 6)     
+/** \brief Auto-Joypad-Read Busy Flag (1=Busy) (see 4200h, and 4218h..421Fh) */
+#define PAD_BUSY 			(1)           
+
+/**
+ *  \brief 
+ *      Interrupt Enable and Joypad Request (W).<br>
+ *
+ *      7     VBlank NMI Enable  (0=Disable, 1=Enable) (Initially disabled on reset)<br>
+ *      6     Not used<br>
+ *      5-4   H/V IRQ (0=Disable, 1=At H=H + V=Any, 2=At V=V + H=0, 3=At H=H + V=V)<br>
+ *      3-1   Not used<br>
+ *      0     Joypad Enable    (0=Disable, 1=Enable Automatic Reading of Joypad)<br>
+ *<br>
+ *      Disabling IRQs (via bit4-5) does additionally acknowledge IRQs.<br>
+ *      There's no such effect when disabling NMIs (via bit7).<br>
+*/
+#define REG_NMITIMEN (*(vuint8 *)0x4200)
+
+/*
+
+4207h/4208h - HTIMEL/HTIMEH - H-Count Timer Setting (W)
+
+  15-9  Not used
+  8-0   H-Count Timer Value (0..339) (+/-1 in long/short lines) (0=leftmost)
+
+The H/V-IRQ flag in Bit7 of TIMEUP, Port 4211h gets set when the H-Counter gets equal to the H-Count register value.
+
+4209h/420Ah - VTIMEL/VTIMEH - V-Count Timer Setting (W)
+
+  15-9  Not used
+  8-0   V-Count Timer Value (0..261/311, NTSC/PAL) (+1 in interlace) (0=top)
+
+The H/V-IRQ flag in Bit7 of TIMEUP, Port 4211h gets set when the V-Counter gets equal to the V-Count register value.
+*/
+
+/**
+ *  \brief 
+ *      V-Blank NMI Flag and CPU Version Number (R) (Read/Ack)<br>
+ *
+ *      7     Vblank NMI Flag  (0=None, 1=Interrupt Request) (set on Begin of Vblank)<br>
+ *      6-4   Not used<br>
+ *      3-0   CPU 5A22 Version Number (version 2 exists)<br>
+ *<br>
+ *      The NMI flag gets set at begin of Vblank (this happens even if NMIs are disabled). The flag gets reset automatically<br>
+ *      at end of Vblank, and gets also reset after reading from this register.<br>
+ *      The SNES has only one NMI source (vblank), and the NMI flag is automatically reset (on vblank end), so there's<br>
+ *      normally no need to read/acknowledge the flag, except one special case: If one does disable and re-enable NMIs,<br>
+ *      then an old NMI may be executed again; acknowledging avoids that effect.<br>
+ *      The CPU includes another internal NMI flag, which gets set when "[4200h].7 AND [4210h].7" changes from 0-to-1, and<br>
+ *      gets cleared when the NMI gets executed (which should happen around after the next opcode) (if a DMA transfer is<br>
+ *      in progress, then it is somewhere after the DMA, in that case the NMI can get executed outside of the Vblank<br>
+ *      period, ie. at a time when [4210h].7 is no longer set).<br>
+*/
+#define REG_RDNMI (*(vuint8 *)0x4210)
+
+/**
+ *  \brief 
+ *      TIMEUP - H/V-Timer IRQ Flag (R) (Read/Ack)<br><br>
+ *
+ *      7     H/V-Count Timer IRQ Flag (0=None, 1=Interrupt Request)<br>
+ *      6-0   Not used<br>
+ *<br>
+ *      The IRQ flag is automatically reset after reading from this register<br>
+ *      (except when reading at the very time when the IRQ condition is true <br>
+ *      (which lasts for 4-8 master cycles), then the CPU receives bit7=1, <br>
+ *      but register bit7 isn't cleared). The flag is also automatically cleared <br>
+ *      when disabling IRQs (by setting 4200h.Bit5-4 to zero).<br>
+ *      Unlike NMI handlers, IRQ handlers MUST acknowledge IRQs, otherwise the IRQ <br>
+ *      gets executed again (ie. immediately after the RTI opcode).<br>
+*/
+#define REG_TIMEUP (*(vuint8 *)0x4211)
+
+/**
+ *  \brief 
+ *      H/V-Blank flag and Joypad Busy flag (R).<br>
+ *
+ *      7     V-Blank Period Flag (0=No, 1=VBlank)<br>
+ *      6     H-Blank Period Flag (0=No, 1=HBlank)<br>
+ *      5-1   Not used<br>
+ *      0     Auto-Joypad-Read Busy Flag (1=Busy) (see 4200h, and 4218h..421Fh)<br>
+ *<br>
+ *      The Hblank flag gets toggled in ALL scanlines (including during Vblank/Vsync).<br>
+ *      Both Vblank and Hblank are always toggling (even during Forced Blank, <br>
+ *      and no matter if IRQs or NMIs are enabled<br>
+*/
+#define REG_HVBJOY (*(vuint8 *)0x4212)
+
+/**
+ * \brief Sets the #nmi_handler (VBlank routine).
+ *
+ * This function will also disable any active IRQ interrupts, enable VBlank interrupts and enable Joypad Auto-Read.
+ *
+ * \param vblankRoutine the function to call on every VBlank (NMI) interrupt.<br/>
+ *
+ * \b CAUTION: \p vblankRoutine is called on \b every VBlank interrupt.
+ * #vblank_flag can be used to determine if \p vblankRoutine was called during a lag-frame.
+ *
+ * \b CAUTION: This function will override the default #nmi_handler.
+ * If you are using consoleDrawText(), you will need to call consoleVblank() inside \p vblankRoutine.
+ *
+ * \see \ref VBlank-ISR, #nmi_handler
+ */
+void nmiSet(void (*vblankRoutine)(void));
+
+/**
+ * \brief Waits for a VBlank interrupt.
+ *
+ * Sets the #vblank_flag and pauses execution until the #vblank_flag is cleared (by the \ref VBlank-ISR).
+ *
+ * \b CAUTION: This function will loop forever if VBlank interrupts are disabled.
+ *
+ * <b>Assembly note</b>: This function will not modify the A/X/Y registers and can be called with an 8 or 16 bit <tt>.ACCU</tt>/<tt>.INDEX</tt>.
+*/
+void WaitForVBlank(void);
+
+/**
+ *  \brief 
+ *      Wait for VBL flag to be OK<br>
+*/
+#define WaitVBLFlag                   \
+    while ((REG_HVBJOY & VBL_READY))  \
+        ;                             \
+    while (!(REG_HVBJOY & VBL_READY)) \
+    {                                 \
+    };
+
+/**
+ *  \brief 
+ *      Wait for vblank interrupt ntime times<br>
+ *
+ *  \param 
+ *      ntime number of time to wait VBlank Interrupt<br>
+*/
+void WaitNVBlank(u16 ntime);
+
+#endif // SNES_INTERRUPTS_INCLUDE

package/src/platforms/snes/lib/pvsneslib/include/snes/libversion.h

@@ -0,0 +1,10 @@
+#ifndef __PVSNESLIBVERSION_H__
+#define __PVSNESLIBVERSION_H__
+
+#define _PVSNESLIB_MAJOR_	4
+#define _PVSNESLIB_MINOR_	5
+#define _PVSNESLIB_PATCH_	0
+
+#define _PVSNESLIB_STRING_ "PVSnesLib V4.5.0"
+
+#endif // __PVSNESLIBVERSION_H__

package/src/platforms/snes/lib/pvsneslib/include/snes/lzss.h

@@ -0,0 +1,43 @@
+/*---------------------------------------------------------------------------------
+
+    Copyright (C) 2012-2014
+        Alekmaul
+
+
+    This software is provided 'as-is', without any express or implied
+    warranty.  In no event will the authors be held liable for any
+    damages arising from the use of this software.
+
+    Permission is granted to anyone to use this software for any
+    purpose, including commercial applications, and to alter it and
+    redistribute it freely, subject to the following restrictions:
+
+    1.	The origin of this software must not be misrepresented; you
+        must not claim that you wrote the original software. If you use
+        this software in a product, an acknowledgment in the product
+        documentation would be appreciated but is not required.
+
+    2.	Altered source versions must be plainly marked as such, and
+        must not be misrepresented as being the original software.
+
+    3.	This notice may not be removed or altered from any source
+        distribution.
+
+---------------------------------------------------------------------------------*/
+/*! \file lzss.h
+\brief Wrapper functions for lzss decoding
+
+*/
+#ifndef SNES_LZSS_INCLUDE
+#define SNES_LZSS_INCLUDE
+
+#include <snes/snestypes.h>
+
+/*! \brief Decompress Lzss data to VRAM
+    \param source the source to decompress from
+    \param address vram address to decompress
+    \param size the size in bytes of the data to decompress.
+*/
+void LzssDecodeVram(u8 *source, u16 address, u16 size);
+
+#endif // SNES_LZSS_INCLUDE

package/src/platforms/snes/lib/pvsneslib/include/snes/map.h

@@ -0,0 +1,113 @@
+/*---------------------------------------------------------------------------------
+
+    map management for mode 1
+
+    Copyright (C) 2012-2013
+        Alekmaul
+
+    This software is provided 'as-is', without any express or implied
+    warranty.  In no event will the authors be held liable for any
+    damages arising from the use of this software.
+
+    Permission is granted to anyone to use this software for any
+    purpose, including commercial applications, and to alter it and
+    redistribute it freely, subject to the following restrictions:
+
+    1.	The origin of this software must not be misrepresented; you
+        must not claim that you wrote the original software. If you use
+        this software in a product, an acknowledgment in the product
+        documentation would be appreciated but is not required.
+    2.	Altered source versions must be plainly marked as such, and
+        must not be misrepresented as being the original software.
+    3.	This notice may not be removed or altered from any source
+        distribution.
+
+---------------------------------------------------------------------------------*/
+
+/*!	\file map.h
+    \brief contains the functions to manage / scroll large background MAP on SNES.
+    \brief this can only be use for mode 1
+    \brief the engine scrolls layer1 in x and y coordinates
+    \brief layer address is : 6800 for Layer 1
+*/
+#ifndef SNES_MAPS_INCLUDE
+#define SNES_MAPS_INCLUDE
+
+#include <snes/snestypes.h>
+
+#define T_EMPTY 0x0000 /*!< \brief Type Empty (action will be fall) for tile  */
+#define T_SOLID 0xFF00 /*!< \brief Type Solid (action is walk only) for tile  */
+#define T_LADDE 0x0001 /*!< \brief Type Ladder (action will be climb) for tile  */
+#define T_FIRES 0x0002 /*!< \brief Type Fire (action will be burn) for tile  */
+#define T_SPIKE 0x0004 /*!< \brief Type Spike (action will be die) for tile  */
+#define T_PLATE 0x0008 /*!< \brief Type Ground (action will be jump through and land) for tile  */
+
+#define ACT_STAND 0x0000 /*!< \brief Action type STAND for object */
+#define ACT_WALK 0x0001  /*!< \brief Action type WALK for object */
+#define ACT_JUMP 0x0002  /*!< \brief Action type JUMP for object */
+#define ACT_FALL 0x0004  /*!< \brief Action type FALL for object */
+#define ACT_CLIMB 0x0008 /*!< \brief Action type CLIMB for object */
+#define ACT_DIE 0x0010   /*!< \brief Action type DIE for object */
+#define ACT_BURN 0x0020  /*!< \brief Action type BURN for object */
+
+#define MAP_OPT_1WAY 0x01  /*!< \brief Map option to only scroll right */    
+#define MAP_OPT_BG2 0x02  /*!< \brief Map option to use BG2 instead of BG1 (address is still 6800 but scroll BG2) */    
+
+extern u16 bg_L1[32 * 32]; /*!< \brief The buffer to use when updating the whole display on layer 1 */
+
+extern u8 mapupdbuf; /*!< \brief State of buffer update (vert / horiz / all) */
+
+extern u16 x_pos, y_pos; /*!< \brief Current value of camera in x & y coordinates */
+
+/*!	\fn mapLoad(u8 *layer1map, u8 *layertiles, u8 *tilesprop)
+    \brief Load map definition into memory.
+    \brief WARNING! Map engine must be used on Background #0.
+    \param layer1map address of map with tiles
+    \param layertiles address of tiles definition
+    \param tilesprop address of tiles property definition (blocker, spikes, and so on)
+*/
+void mapLoad(u8 *layer1map, u8 *layertiles, u8 *tilesprop);
+
+/*!	\fn mapUpdate(void)
+    \brief Update map regarding current camera position (must be done once per frame)
+*/
+void mapUpdate(void);
+
+/*!	\fn mapVblank(void)
+    \brief Display map regarding current buffer (must be done once per frame, near Vblank)
+*/
+void mapVblank(void);
+
+/*!	\fn mapUpdateCamera(u16 xpos, u16 ypos)
+    \brief Update map camera (must be done once per frame)
+    \param xpos	x coordinate of object where we want to focus on
+    \param ypos	x coordinate of object where we want to focus on
+*/
+void mapUpdateCamera(u16 xpos, u16 ypos);
+
+/*!	\fn mapGetMetaTile(u16 xpos, u16 ypos)
+    \brief Get metatile value from current map
+    \param xpos	x coordinate of metatile
+    \param ypos	x coordinate of metatile
+    \return tile value
+*/
+u16 mapGetMetaTile(u16 xpos, u16 ypos);
+
+/*!	\fn mapGetMetaTilesProp(u16 xpos, u16 ypos)
+    \brief Get metatile property from current map (solid, lad, fire, etc...)
+    \param xpos	x coordinate of metatile
+    \param ypos	x coordinate of metatile
+    \return tile properties
+*/
+u16 mapGetMetaTilesProp(u16 xpos, u16 ypos);
+
+/*!	\fn mapSetMapOptions(u8 optmap)
+    \brief Put some generic options for the map
+    \param optmap	options to set
+    <br> Options are:
+    <br> MAP_OPT_1WAY: only scroll right
+    <br> MAP_OPT_BG2: option to use BG2 instead of BG1 (address is still 6800 but scroll BG2)
+*/
+void mapSetMapOptions(u8 optmap);
+
+#endif

package/src/platforms/snes/lib/pvsneslib/include/snes/object.h

@@ -0,0 +1,234 @@
+/*---------------------------------------------------------------------------------
+
+    object.h -- definitions for SNES objects
+
+    Copyright (C) 2012-2024
+        Alekmaul, Nub1604
+
+    This software is provided 'as-is', without any express or implied
+    warranty.  In no event will the authors be held liable for any
+    damages arising from the use of this software.
+
+    Permission is granted to anyone to use this software for any
+    purpose, including commercial applications, and to alter it and
+    redistribute it freely, subject to the following restrictions:
+
+    1.	The origin of this software must not be misrepresented; you
+    must not claim that you wrote the original software. If you use
+    this software in a product, an acknowledgment in the product
+    documentation would be appreciated but is not required.
+
+    2.	Altered source versions must be plainly marked as such, and
+    must not be misrepresented as being the original software.
+
+    3.	This notice may not be removed or altered from any source
+    distribution.
+
+    Special thanks to Nub1604 for the slope management
+
+---------------------------------------------------------------------------------*/
+/*! \file object.h
+    \brief snes object engine functionality.
+    \brief 64 maximum of objects managed by engine
+    \brief 32 type of objects maximum by engine
+*/
+
+#ifndef SNES_OBJECTS_INCLUDE
+#define SNES_OBJECTS_INCLUDE
+
+#include <snes/snestypes.h>
+
+#define OB_MAX              80 /*!< total number of objects in the game */
+
+#define OB_TYPE_MAX		    64	/*!< total number of type of objects in the game */
+
+/*!	\struct t_objs
+    \brief object definition (64 bytes)
+*/
+typedef struct
+{
+    u16 prev;                         /*!<  0 previous object linked list */
+    u16 next;                         /*!<  2 next object in linked list */
+    u8 type;                          /*!<  4 type of object, depend of the game */
+    u8 nID;                           /*!<  5 obj ID in linked list */
+    u16 sprnum;                       /*!<  6 sprite oam number of the object (multiple of 4) */
+    u16 sprid3216;                    /*!<  8 sprite oam id in sprite oam memory */
+    u16 sprblk3216;                   /*!< 10 sprite oam address in sprites tiles memory */
+    u8 sprflip;                       /*!< 12 sprite flip attribute */
+    u8 sprpal;                        /*!< 13 sprite palette */
+    u16 sprframe;                     /*!< 14 current frame */
+    u8 xpos[3];                       /*!< 16 x position on the screen (3 fixed point) */
+    u8 ypos[3];                       /*!< 19 y position on the screen (3 fixed point) */
+    u16 xofs;                         /*!< 22 x offset of the object (from the square 16x16 or 32x32) */
+    u16 yofs;                         /*!< 24 y offset of the object (from the square 16x16 or 32x32) */
+    u16 width;                        /*!< 26 width of the object (from the square 16x16 or 32x32) */
+    u16 height;                       /*!< 28 height of the object (from the square 16x16 or 32x32) */
+    u16 xmin;                         /*!< 30 min x coordinate for action of object, depends of game (ex: revert direction) */
+    u16 xmax;                         /*!< 32 max x coordinate for action of object, depends of game (ex: revert direction) */
+    s16 xvel;                         /*!< 34 x velocity */
+    s16 yvel;                         /*!< 36 y velocity */
+    u16 tilestand;                    /*!< 38 tile number object is standing on */
+    u16 tileabove;                    /*!< 40 tile number above object */
+    u16 tilesprop;                    /*!< 42 tile property stand on */
+    u16 tilebprop;                    /*!< 44 tile property on left/right side */
+    u16 action;                       /*!< 46 current action of the object, depends of game */
+    u8 status;                        /*!< 48 status of object regarding collision */
+    u8 tempo;                         /*!< 49 if object needs tempo */
+    u8 count;                         /*!< 50 if object needs a counter */
+    u8 dir;                           /*!< 51 if object needs to manage direction */
+    u16 parentID;                     /*!< 52 obj ID of parent (useful for projectiles) */
+    u8 hitpoints;                     /*!< 54 number of hit points of object */
+    u8 sprrefresh;                    /*!< 55 if object needs sprite to be refresh */
+    u8 onscreen;                      /*!< 56 to know if object is on screen or not */
+    u8 objnotused[7];                 /*!<  OB_SIZE-55-1 for future use */
+} t_objs __attribute__((__packed__)); // seems to do nothing :/
+
+extern u16 objptr;   /*!< \brief pointer to current object */
+extern u8 objtokill; /*!< \brief put 1 in variable to kill current object */
+extern u16 objgetid; /*!< \brief id of current object (useful when creating it) */
+
+extern t_objs objbuffers[OB_MAX]; /*!< \brief current object buffer with all objects */
+
+#define T_EMPTY 	0x0000  /*!< \brief Type Empty (action will be fall) for tile  */
+#define T_SOLID 	0xFF00  /*!< \brief Type Solid (action is walk only) for tile  */
+#define T_LADDER 	0x0001  /*!< \brief Type Ladder (action will be climb) for tile  */
+#define T_FIRES 	0x0002  /*!< \brief Type Fire (action will be burn) for tile  */
+#define T_SPIKE 	0x0004  /*!< \brief Type Spike (action will be die) for tile  */
+#define T_PLATE 	0x0008  /*!< \brief Type Plate (action will be jump through and land) for tile  */
+#define T_SLOPEU1	0x0020  /*!< \brief Type Slope 1x1 Up ◢ (action will be climb on it) for tile  */
+#define T_SLOPED1	0x0021  /*!< \brief Type Slope 1x1 Down ◣ (action will be descend on it) for tile */
+#define T_SLOPELU2	0x0022  /*!< \brief Type Slope 2x1 lower half Up ◢ (action will be climb on it) for tile */
+#define T_SLOPELD2	0x0023  /*!< \brief Type Slope 2x1 lower half Down ◣ (action will be descend on it) for tile */
+#define T_SLOPEUU2	0x0024  /*!< \brief Type Slope 2x1 upper half Up ◢ (action will be climb on it) for tile */
+#define T_SLOPEUD2	0x0025  /*!< \brief Type Slope 2x1 upper half Down ◣ (action will be descend on it) for tile  */
+
+#define ACT_STAND   0x0000  /*!< \brief Action type STAND for object */
+#define ACT_WALK    0x0001  /*!< \brief Action type WALK for object */
+#define ACT_JUMP    0x0002  /*!< \brief Action type JUMP for object */
+#define ACT_FALL    0x0004  /*!< \brief Action type FALL for object */
+#define ACT_CLIMB   0x0008  /*!< \brief Action type CLIMB for object */
+#define ACT_DIE     0x0010  /*!< \brief Action type DIE for object */
+#define ACT_BURN    0x0020  /*!< \brief Action type BURN for object */
+
+/*! \fn objInitEngine(void)
+    \brief Initialize object engine, need to be called once
+*/
+void objInitEngine(void);
+
+/*! \fn objInitGravity(u8 objgravity, u8 objfriction, u16 objvelocity)
+    \brief Initialize the object type functions (initialize, update)
+    \param objgravity  The gravity of object when falling (default is 41)
+    \param objfriction 	Friction for object when walking (default is 16)
+*/
+void objInitGravity(u16 objgravity, u16 objfriction);
+
+/*! \fn objInitFunctions(u8 objtype, void *initfct, void *updfct, void *reffct);
+    \brief Initialize the object type functions (initialize, update)
+    \param objtype  The type of object depending of the game
+    \param initfct  The address of the function when we init the type of object
+    \param updfct   The address of the function when we update the type of object (need to be called once per frame)
+    \param reffct   The address of the function when we refresh sprites of object (need to be called once per frame)
+    \brief init function must have 5 unsigned short (u16) parameters
+    \brief    - xp,yp are default coordinates values for x and y
+    \brief    - type is the type oobjects
+    \brief    - minx, miny are minimal and maximal values for objects in x axis
+    \brief update function must have 1 parameter
+    \brief    - idx is the id of the object in the object list
+    \brief refresh function must have 1 parameter
+    \brief    - idx is the id of the object in the object list
+*/
+void objInitFunctions(u8 objtype, void *initfct, void *updfct, void *reffct);
+
+/*! \fn objLoadObjects(u8 *sourceO)
+    \brief Load all objects for a specific table in memory
+    \param sourceO table of objects
+    \brief Call, after loading, each init function of the type of objects for each object
+    \brief The table has an entry with x,y,type,minx,maxx for each object
+    \brief    - x,y are coordinates of object,
+    \brief    - type if the type of the object (maximum 32 types)
+    \brief    - minx,maxx are the coordinates of minimum & maxinmum possible on x
+    \brief the last four parameters are useful to do some actions where minimum or maximum is reached
+    \brief The table needs to finish with FFFF to indicate that no more objects are availables
+*/
+void objLoadObjects(u8 *sourceO);
+
+/*! \fn objNew(u8 objtype, u16 x, u16 y)
+    \brief Initialize a new object in game, objgetid will has the id of the object
+    \param objtype  The type of object depending of the game
+    \param x 	    The X coordinate of object on map or screen
+    \param y 	    The Y coordinate of object on map or screen
+    \return id of the object in object id table
+*/
+u16 objNew(u8 objtype, u16 x, u16 y);
+
+/*! \fn objGetPointer(u16 objhandle)
+    \brief get the pointer to an object from its handle (need to do -1 to have offset after), objptr will has the pointer of the object
+    \param objhandle handle of the object
+*/
+void objGetPointer(u16 objhandle);
+
+/*! \fn objKill(u16 objhandle)
+    \brief kill an object from the game
+    \param objhandle handle of the object
+*/
+void objKill(u16 objhandle);
+
+/*! \fn objKillAll(void)
+    \brief kill all objects currently active
+*/
+void objKillAll(void);
+
+/*! \fn objUpdateAll(void)
+    \brief call update function for all objects currently active (if they are in "virtual screen" coordinates).
+    \brief  "virtual screen" coordinates are -64<x<320 and -64<y<288.
+*/
+void objUpdateAll(void);
+
+/*! \fn objRefreshAll(void)
+    \brief call refresh function for all objects currently on screen.
+    \brief  useful to avoid flickering when using a platform scrolling game.
+    \brief  screen coordinates are -32<x<256 and -32<y<y<224.
+*/
+void objRefreshAll(void);
+
+/*! \fn objCollidMap(u16 objhandle)
+    \brief check if an object collides the map
+    \param objhandle handle of the object
+    \brief update tilestand, tileabove with tiles on map regarding object attributes
+    \brief update xvel, yvel with velocity regarding tiles on map
+*/
+void objCollidMap(u16 objhandle);
+
+/*! \fn objCollidMapWithSlopes(u16 objhandle)
+    \brief check if an object collides the map with map slopes management
+    \param objhandle handle of the object
+    \brief update tilestand, tileabove with tiles on map regarding object attributes
+    \brief update xvel, yvel with velocity regarding tiles on map
+    \brief the map can contain slopes, check the constants ($20..$25) the add them to your map
+*/
+void objCollidMapWithSlopes(u16 objhandle);
+
+/*! \fn objCollidMap1D(u16 objhandle)
+    \brief check if an object collides the map
+    \param objhandle handle of the object
+    \brief update tilestand, tileabove with tiles on map regarding object attributes
+    \brief update xvel, yvel with no gravity regarding tiles on map
+*/
+void objCollidMap1D(u16 objhandle);
+
+/*! \fn objCollidObj(u16 objhandle1,u16 objhandle2)
+    \brief check if two objects are colliding
+    \param objhandle1 handle of the 1st object
+    \param objhandle2 handle of the 2nd object
+    \return 1 if collision detected, 0 elsewhere
+*/
+u16 objCollidObj(u16 objhandle1, u16 objhandle2);
+
+/*! \fn objUpdateXY(u16 objhandle)
+    \brief Update X & Y coordinates of object regarding its own velocitys
+    \param objhandle handle of the object
+    \brief It uses xvel and yvel to do such computation
+*/
+void objUpdateXY(u16 objhandle);
+
+#endif // SNES_OBJECTS_INCLUDE