BizHawk/BizHawk.Emulation/Consoles/Nintendo/GBA/LibMeteor.cs

using System;
using System.Runtime.InteropServices;

namespace BizHawk.Emulation.Consoles.Nintendo.GBA
{
	/// <summary>
	/// bindings into libmeteor.dll
	/// </summary>
	public static class LibMeteor
	{
		/// <summary>
		/// power cycle the emulation core
		/// </summary>
		[DllImport("libmeteor.dll", CallingConvention = CallingConvention.Cdecl)]
		public static extern void libmeteor_hardreset();

		/// <summary>
		/// signal that you are removing data from the sound buffer.
		/// the next time frameadvance() is called, writing will start from the beginning
		/// </summary>
		/// <returns>the valid length of the buffer, in bytes</returns>
		[DllImport("libmeteor.dll", CallingConvention = CallingConvention.Cdecl)]
		public static extern uint libmeteor_emptysound();

		/// <summary>
		/// set up buffers for libmeteor to dump data to.  these must be valid before every frameadvance
		/// </summary>
		/// <param name="vid">buffer to hold video data as BGRA32</param>
		/// <param name="vidlen">length in bytes.  must be at least 240 * 160 * 4</param>
		/// <param name="aud">buffer to hold audio data as stereo s16le</param>
		/// <param name="audlen">length in bytes.  must be 0 mod 4 (hold a full stereo sample set)</param>
		/// <returns>false if some problem.  buffers will not be valid in this case</returns>
		[DllImport("libmeteor.dll", CallingConvention = CallingConvention.Cdecl)]
		public static extern bool libmeteor_setbuffers(IntPtr vid, uint vidlen, IntPtr aud, uint audlen);

		/// <summary>
		/// initialize the library
		/// </summary>
		[DllImport("libmeteor.dll", CallingConvention = CallingConvention.Cdecl)]
		public static extern void libmeteor_init();

		/// <summary>
		/// run emulation for one frame, updating sound and video along the way
		/// </summary>
		[DllImport("libmeteor.dll", CallingConvention = CallingConvention.Cdecl)]
		public static extern void libmeteor_frameadvance();

		/// <summary>
		/// load a rom image
		/// </summary>
		/// <param name="data">raw rom data. need not persist past this call</param>
		/// <param name="datalen">length of data in bytes</param>
		[DllImport("libmeteor.dll", CallingConvention = CallingConvention.Cdecl)]
		public static extern void libmeteor_loadrom(byte[] data, uint datalen);

		/// <summary>
		/// load a bios image
		/// </summary>
		/// <param name="data">raw bios data. need not persist past this call</param>
		/// <param name="datalen">length of data in bytes</param>
		[DllImport("libmeteor.dll", CallingConvention = CallingConvention.Cdecl)]
		public static extern void libmeteor_loadbios(byte[] data, uint datalen);

		/// <summary>
		/// core callback to print meaningful (or meaningless) log messages
		/// </summary>
		/// <param name="msg">message to be printed</param>
		/// <param name="abort">true if emulation should be aborted</param>
		[UnmanagedFunctionPointer(CallingConvention.Cdecl)]
		public delegate void MessageCallback(string msg, bool abort);

		/// <summary>
		/// set callback for log messages.  this can (and should) be called first
		/// </summary>
		/// <param name="cb"></param>
		[DllImport("libmeteor.dll", CallingConvention = CallingConvention.Cdecl)]
		public static extern void libmeteor_setmessagecallback(MessageCallback cb);

		/// <summary>
		/// combination of button flags used by the key callback
		/// </summary>
		[Flags]
		public enum Buttons : ushort
		{
			BTN_A = 0x001,
			BTN_B = 0x002,
			BTN_SELECT = 0x004,
			BTN_START = 0x008,
			BTN_RIGHT = 0x010,
			BTN_LEFT = 0x020,
			BTN_UP = 0x040,
			BTN_DOWN = 0x080,
			BTN_R = 0x100,
			BTN_L = 0x200
		}

		/// <summary>
		/// core callback to get input state
		/// </summary>
		/// <returns>buttons pressed bitfield</returns>
		[UnmanagedFunctionPointer(CallingConvention.Cdecl)]
		public delegate Buttons InputCallback();

		/// <summary>
		/// set callback for whenever input is requested
		/// </summary>
		/// <param name="callback"></param>
		[DllImport("libmeteor.dll", CallingConvention = CallingConvention.Cdecl)]
		public static extern void libmeteor_setkeycallback(InputCallback callback);

		/// <summary>
		/// parameter to libmeteor_getmemoryarea
		/// </summary>
		public enum MemoryArea
		{
			/// <summary>
			/// BIOS, may be invalid if bios not loaded. valid size: 16K.  system bus: @00000000h
			/// </summary>
			bios = 0,
			/// <summary>
			/// external workram.  valid size: 256K.  system bus: @02000000h
			/// </summary>
			ewram = 1,
			/// <summary>
			/// internal workram.  valid size: 32K.  system bus: @03000000h
			/// </summary>
			iwram = 2,
			/// <summary>
			/// palettes.  valid size: 1K.  system bus: @05000000h
			/// </summary>
			palram = 3,
			/// <summary>
			/// video ram.  valid size: 96K.  system bus: @06000000h
			/// </summary>
			vram = 4,
			/// <summary>
			/// sprite attribute ram.  valid size: 1K.  system bus: @07000000h
			/// </summary>
			oam = 5,
			/// <summary>
			/// rom.  always valid to full size, even if no rom or small rom loaded.  valid size: 32M.  system bus: @08000000h, others
			/// </summary>
			rom = 6,
			/// <summary>
			/// direct access to cached io port values.  this should NEVER be modified!  valid size: 4K.  system bus: @04000000h (sort of)
			/// </summary>
			io = 7
		}

		/// <summary>
		/// return a pointer to a memory area
		/// </summary>
		/// <param name="which"></param>
		/// <returns>IntPtr.Zero if which is unrecognized</returns>
		[DllImport("libmeteor.dll", CallingConvention = CallingConvention.Cdecl)]
		public static extern IntPtr libmeteor_getmemoryarea(MemoryArea which);

		/// <summary>
		/// core callback for tracelogging
		/// </summary>
		/// <param name="msg">disassembly of an instruction about to be run</param>
		[UnmanagedFunctionPointer(CallingConvention.Cdecl)]
		public delegate void TraceCallback(string msg);

		/// <summary>
		/// set callback to run before each instruction is executed
		/// </summary>
		/// <param name="callback">null to clear</param>
		[DllImport("libmeteor.dll", CallingConvention = CallingConvention.Cdecl)]
		public static extern void libmeteor_settracecallback(TraceCallback callback);

		/// <summary>
		/// load saveram from a byte buffer
		/// </summary>
		/// <param name="data"></param>
		/// <param name="size"></param>
		/// <returns>success</returns>
		[DllImport("libmeteor.dll", CallingConvention = CallingConvention.Cdecl)]
		public static extern bool libmeteor_loadsaveram(byte[] data, uint size);

		/// <summary>
		/// save saveram to a byte buffer
		/// </summary>
		/// <param name="data">buffer generated by core.  copy from, but do not modify</param>
		/// <param name="size">length of buffer</param>
		/// <returns>success</returns>
		[DllImport("libmeteor.dll", CallingConvention = CallingConvention.Cdecl)]
		public static extern bool libmeteor_savesaveram(ref IntPtr data, ref uint size);

		/// <summary>
		/// destroy a buffer previously returned by libmeteor_savesaveram() to avoid leakage
		/// </summary>
		/// <param name="data"></param>
		[DllImport("libmeteor.dll", CallingConvention = CallingConvention.Cdecl)]
		public static extern void libmeteor_savesaveram_destroy(IntPtr data);

		/// <summary>
		/// return true if there is saveram installed on currently loaded cart
		/// </summary>
		/// <returns></returns>
		[DllImport("libmeteor.dll", CallingConvention = CallingConvention.Cdecl)]
		public static extern bool libmeteor_hassaveram();

		/// <summary>
		/// resets the current cart's saveram
		/// </summary>
		[DllImport("libmeteor.dll", CallingConvention = CallingConvention.Cdecl)]
		public static extern void libmeteor_clearsaveram();

		/// <summary>
		/// serialize state
		/// </summary>
		/// <param name="data">buffer generated by core</param>
		/// <param name="size">size of buffer</param>
		/// <returns>success</returns>
		[DllImport("libmeteor.dll", CallingConvention = CallingConvention.Cdecl)]
		public static extern bool libmeteor_savestate(ref IntPtr data, ref uint size);

		/// <summary>
		/// destroy a buffer previously returned by libmeteor_savestate() to avoid leakage
		/// </summary>
		/// <param name="data"></param>
		[DllImport("libmeteor.dll", CallingConvention = CallingConvention.Cdecl)]
		public static extern void libmeteor_savestate_destroy(IntPtr data);

		/// <summary>
		/// unserialize state
		/// </summary>
		/// <param name="data"></param>
		/// <param name="size"></param>
		/// <returns>success</returns>
		[DllImport("libmeteor.dll", CallingConvention = CallingConvention.Cdecl)]
		public static extern bool libmeteor_loadstate(byte[] data, uint size);

		/// <summary>
		/// read a byte off the system bus.  guaranteed to have no side effects
		/// </summary>
		/// <param name="addr"></param>
		/// <returns></returns>
		[DllImport("libmeteor.dll", CallingConvention = CallingConvention.Cdecl)]
		public static extern byte libmeteor_peekbus(uint addr);

		/// <summary>
		/// write a byte to the system bus.
		/// </summary>
		/// <param name="addr"></param>
		/// <param name="val"></param>
		[DllImport("libmeteor.dll", CallingConvention = CallingConvention.Cdecl)]
		public static extern void libmeteor_writebus(uint addr, byte val);

		/// <summary>
		/// type of the scanline callback
		/// </summary>
		[UnmanagedFunctionPointer(CallingConvention.Cdecl)]
		public delegate void ScanlineCallback();

		/// <summary>
		/// set a callback to coincide with vcount interrupts
		/// </summary>
		/// <param name="callback">null to clear</param>
		/// <param name="scanline">0-227, 160 occurring first in a frame</param>
		[DllImport("libmeteor.dll", CallingConvention = CallingConvention.Cdecl)]
		public static extern void libmeteor_setscanlinecallback(ScanlineCallback callback, int scanline);
	}
}