libmame.h

Go to the documentation of this file.

/*****************************************************************************
 * libmame.h
 *
 * Copyright Bryan Ischo and the MAME Team.
 * Visit http://mamedev.org for licensing and usage restrictions.
 * 
 *****************************************************************************/


#ifndef __LIBMAME_H__
#define __LIBMAME_H__

#include <stdarg.h>
#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#if 0 // fix emacs indentation
}
#endif
#endif

/*****************************************************************************
 * Opaque type definitions
 *****************************************************************************/

typedef struct LibMame_RunningGame LibMame_RunningGame;


/*****************************************************************************
 * Preprocessor definitions - constants
 *****************************************************************************/

#define LIBMAME_WORKINGFLAGS_WRONG_COLORS                       0x001

#define LIBMAME_WORKINGFLAGS_IMPERFECT_COLORS                   0x002

#define LIBMAME_WORKINGFLAGS_IMPERFECT_GRAPHICS                 0x004

#define LIBMAME_WORKINGFLAGS_NO_SOUND                           0x008

#define LIBMAME_WORKINGFLAGS_IMPERFECT_SOUND                    0x010

#define LIBMAME_WORKINGFLAGS_NO_COCKTAIL                        0x020

#define LIBMAME_WORKINGFLAGS_UNEMULATED_PROTECTION              0x040

#define LIBMAME_WORKINGFLAGS_NO_SAVE_STATE                      0x080

#define LIBMAME_WORKINGFLAGS_NOTWORKING                         0x100


#define LIBMAME_RENDERFLAGS_TEXTURE_ORIENTATION(flags)      ((flags) & 0x000F)

#define LIBMAME_RENDERFLAGS_TEXTURE_FORMAT(flags)           ((LibMame_TextureFormat) ((flags) & 0x00F0))

#define LIBMAME_RENDERFLAGS_BLEND_MODE(flags)               ((flags) & 0x0F00)

#define LIBMAME_RENDERFLAGS_ANTIALIAS(flags)                ((flags) & 0x1000)

#define LIBMAME_RENDERFLAGS_SCREEN_TEXTURE(flags)           ((flags) & 0x2000)

#define LIBMAME_RENDERFLAGS_TEXTURE_WRAP(flags)             ((flags) & 0x4000)


/*****************************************************************************
 * Enumerated types
 *****************************************************************************/

typedef enum
{
    LibMame_InitializeStatus_Success = 0,
    LibMame_InitializeStatus_OutOfMemory,
    LibMame_InitializeStatus_GeneralFailure
} LibMame_InitializeStatus;


typedef enum
{
    LibMame_ScreenType_Raster,
    LibMame_ScreenType_LCD,
    LibMame_ScreenType_Vector
} LibMame_ScreenType;


typedef enum
{
    LibMame_OrientationType_Normal       = 0,
    LibMame_OrientationType_90           = 5,
    LibMame_OrientationType_180          = 3,
    LibMame_OrientationType_270          = 6
} LibMame_OrientationType;


typedef enum
{
    LibMame_JoystickDirection_Up,
    LibMame_JoystickDirection_Right,
    LibMame_JoystickDirection_Down,
    LibMame_JoystickDirection_Left,
    /* This is not a type, it's the number of entries in this enum */
    LibMame_JoystickDirectionCount
} LibMame_JoystickDirection;


typedef enum
{
    LibMame_ControllerType_LeftHorizontalJoystick,
    LibMame_ControllerType_LeftVerticalJoystick,
    LibMame_ControllerType_Left4WayJoystick,
    LibMame_ControllerType_Left8WayJoystick,
    LibMame_ControllerType_RightHorizontalJoystick,
    LibMame_ControllerType_RightVerticalJoystick,
    LibMame_ControllerType_Right4WayJoystick,
    LibMame_ControllerType_Right8WayJoystick,
    LibMame_ControllerType_AnalogHorizontalJoystick,
    LibMame_ControllerType_AnalogVerticalJoystick,
    LibMame_ControllerType_Analog8WayJoystick,
    LibMame_ControllerType_Spinner,
    LibMame_ControllerType_VerticalSpinner,
    LibMame_ControllerType_Paddle,
    LibMame_ControllerType_VerticalPaddle,
    LibMame_ControllerType_Trackball,
    LibMame_ControllerType_Lightgun,
    LibMame_ControllerType_Pedal,
    LibMame_ControllerType_Pedal2,
    LibMame_ControllerType_Pedal3,
    /* This is not a type, it's the number of entries in this enum */
    LibMame_ControllerTypeCount
} LibMame_ControllerType;


typedef enum
{
    LibMame_NormalButtonType_1,
    LibMame_NormalButtonType_2,
    LibMame_NormalButtonType_3,
    LibMame_NormalButtonType_4,
    LibMame_NormalButtonType_5,
    LibMame_NormalButtonType_6,
    LibMame_NormalButtonType_7,
    LibMame_NormalButtonType_8,
    LibMame_NormalButtonType_9,
    LibMame_NormalButtonType_10,
    LibMame_NormalButtonType_11,
    LibMame_NormalButtonType_12,
    LibMame_NormalButtonType_13,
    LibMame_NormalButtonType_14,
    LibMame_NormalButtonType_15,
    LibMame_NormalButtonType_16,
    /* This is not a type, it's the number of entries in this enum */
    LibMame_NormalButtonTypeCount
} LibMame_NormalButtonType;


typedef enum
{
    LibMame_MahjongButtonType_A,
    LibMame_MahjongButtonType_B,
    LibMame_MahjongButtonType_C,
    LibMame_MahjongButtonType_D,
    LibMame_MahjongButtonType_E,
    LibMame_MahjongButtonType_F,
    LibMame_MahjongButtonType_G,
    LibMame_MahjongButtonType_H,
    LibMame_MahjongButtonType_I,
    LibMame_MahjongButtonType_J,
    LibMame_MahjongButtonType_K,
    LibMame_MahjongButtonType_L,
    LibMame_MahjongButtonType_M,
    LibMame_MahjongButtonType_N,
    LibMame_MahjongButtonType_O,
    LibMame_MahjongButtonType_P,
    LibMame_MahjongButtonType_Q,
    LibMame_MahjongButtonType_Kan,
    LibMame_MahjongButtonType_Pon,
    LibMame_MahjongButtonType_Chi,
    LibMame_MahjongButtonType_Reach,
    LibMame_MahjongButtonType_Ron,
    LibMame_MahjongButtonType_Bet,
    LibMame_MahjongButtonType_Last_Chance,
    LibMame_MahjongButtonType_Score,
    LibMame_MahjongButtonType_Double_Up,
    LibMame_MahjongButtonType_Flip_Flop,
    LibMame_MahjongButtonType_Big,
    LibMame_MahjongButtonType_Small,
    /* This is not a type, it's the number of entries in this enum */
    LibMame_MahjongButtonTypeCount
} LibMame_MahjongButtonType;


typedef enum
{
    LibMame_HanafudaButtonType_A,
    LibMame_HanafudaButtonType_B,
    LibMame_HanafudaButtonType_C,
    LibMame_HanafudaButtonType_D,
    LibMame_HanafudaButtonType_E,
    LibMame_HanafudaButtonType_F,
    LibMame_HanafudaButtonType_G,
    LibMame_HanafudaButtonType_H,
    LibMame_HanafudaButtonType_Yes,
    LibMame_HanafudaButtonType_No,
    /* This is not a type, it's the number of entries in this enum */
    LibMame_HanafudaButtonTypeCount
} LibMame_HanafudaButtonType;


typedef enum
{
    LibMame_GamblingButtonType_High,
    LibMame_GamblingButtonType_Low,
    LibMame_GamblingButtonType_Half,
    LibMame_GamblingButtonType_Deal,
    LibMame_GamblingButtonType_D_Up,
    LibMame_GamblingButtonType_Take,
    LibMame_GamblingButtonType_Stand,
    LibMame_GamblingButtonType_Bet,
    LibMame_GamblingButtonType_Keyin,
    LibMame_GamblingButtonType_Keyout,
    LibMame_GamblingButtonType_Payout,
    LibMame_GamblingButtonType_Door,
    LibMame_GamblingButtonType_Service,
    LibMame_GamblingButtonType_Book,
    LibMame_GamblingButtonType_Hold1,
    LibMame_GamblingButtonType_Hold2,
    LibMame_GamblingButtonType_Hold3,
    LibMame_GamblingButtonType_Hold4,
    LibMame_GamblingButtonType_Hold5,
    LibMame_GamblingButtonType_Cancel,
    LibMame_GamblingButtonType_Stop1,
    LibMame_GamblingButtonType_Stop2,
    LibMame_GamblingButtonType_Stop3,
    LibMame_GamblingButtonType_Stop4,
    LibMame_GamblingButtonType_Stop_All,
    /* This is not a type, it's the number of entries in this enum */
    LibMame_GamblingButtonTypeCount
} LibMame_GamblingButtonType;


typedef enum
{
    LibMame_SharedButtonType_Coin1,
    LibMame_SharedButtonType_Coin2,
    LibMame_SharedButtonType_Coin3,
    LibMame_SharedButtonType_Coin4,
    LibMame_SharedButtonType_Coin5,
    LibMame_SharedButtonType_Coin6,
    LibMame_SharedButtonType_Coin7,
    LibMame_SharedButtonType_Coin8,
    LibMame_SharedButtonType_Bill1,
    LibMame_SharedButtonType_Start1,
    LibMame_SharedButtonType_Start2,
    LibMame_SharedButtonType_Start3,
    LibMame_SharedButtonType_Start4,
    LibMame_SharedButtonType_Start5,
    LibMame_SharedButtonType_Start6,
    LibMame_SharedButtonType_Start7,
    LibMame_SharedButtonType_Start8,
    LibMame_SharedButtonType_Service,
    LibMame_SharedButtonType_Service1,
    LibMame_SharedButtonType_Service2,
    LibMame_SharedButtonType_Service3,
    LibMame_SharedButtonType_Service4,
    LibMame_SharedButtonType_Tilt,
    LibMame_SharedButtonType_Interlock,
    LibMame_SharedButtonType_Volume_Up,
    LibMame_SharedButtonType_Volume_Down,
    /* This is not a type, it's the number of entries in this enum */
    LibMame_SharedButtonTypeCount
} LibMame_SharedButtonType;


typedef enum
{
    LibMame_SpecialButtonType_1,
    LibMame_SpecialButtonType_2,
    LibMame_SpecialButtonType_3,
    LibMame_SpecialButtonType_4,
    LibMame_SpecialButtonType_5,
    LibMame_SpecialButtonType_6,
    LibMame_SpecialButtonType_7,
    LibMame_SpecialButtonType_8,
    LibMame_SpecialButtonType_9,
    LibMame_SpecialButtonType_10,
    LibMame_SpecialButtonType_11,
    LibMame_SpecialButtonType_12,
    LibMame_SpecialButtonType_13,
    LibMame_SpecialButtonType_14,
    LibMame_SpecialButtonType_15,
    LibMame_SpecialButtonType_16,
    LibMame_SpecialButtonType_17,
    LibMame_SpecialButtonType_18,
    LibMame_SpecialButtonType_19,
    LibMame_SpecialButtonType_20,
    LibMame_SpecialButtonType_21,
    LibMame_SpecialButtonType_22,
    LibMame_SpecialButtonType_23,
    LibMame_SpecialButtonType_24,
    LibMame_SpecialButtonType_25,
    LibMame_SpecialButtonType_26,
    LibMame_SpecialButtonType_27,
    LibMame_SpecialButtonType_28,
    LibMame_SpecialButtonType_29,
    LibMame_SpecialButtonType_30,
    LibMame_SpecialButtonType_31,
    LibMame_SpecialButtonType_32,
    /* This is not a type, it's the number of entries in this enum */
    LibMame_SpecialButtonTypeCount
} LibMame_SpecialButtonType;


typedef enum
{
    LibMame_UiButtonType_Configure,
    LibMame_UiButtonType_On_Screen_Display,
    LibMame_UiButtonType_Debug_Break,
    LibMame_UiButtonType_Pause,
    LibMame_UiButtonType_Reset_Machine,
    LibMame_UiButtonType_Soft_Reset,
    LibMame_UiButtonType_Show_Gfx,
    LibMame_UiButtonType_Frameskip_Dec,
    LibMame_UiButtonType_Frameskip_Inc,
    LibMame_UiButtonType_Throttle,
    LibMame_UiButtonType_Fast_Forward,
    LibMame_UiButtonType_Show_Fps,
    LibMame_UiButtonType_Snapshot,
    LibMame_UiButtonType_Record_Movie,
    LibMame_UiButtonType_Toggle_Cheat,
    LibMame_UiButtonType_Up,
    LibMame_UiButtonType_Down,
    LibMame_UiButtonType_Left,
    LibMame_UiButtonType_Right,
    LibMame_UiButtonType_Home,
    LibMame_UiButtonType_End,
    LibMame_UiButtonType_Page_Up,
    LibMame_UiButtonType_Page_Down,
    LibMame_UiButtonType_Select,
    LibMame_UiButtonType_Cancel,
    LibMame_UiButtonType_Display_Comment,
    LibMame_UiButtonType_Clear,
    LibMame_UiButtonType_Zoom_In,
    LibMame_UiButtonType_Zoom_Out,
    LibMame_UiButtonType_Prev_Group,
    LibMame_UiButtonType_Next_Group,
    LibMame_UiButtonType_Rotate,
    LibMame_UiButtonType_Show_Profiler,
    LibMame_UiButtonType_Toggle_Ui,
    LibMame_UiButtonType_Toggle_Debug,
    LibMame_UiButtonType_Paste,
    LibMame_UiButtonType_Save_State,
    LibMame_UiButtonType_Load_State,
    /* This is not a type, it's the number of entries in this enum */
    LibMame_UiButtonTypeCount
} LibMame_UiButtonType;


typedef enum LibMame_ImageStatus_Status
{
    LibMame_ImageStatus_GoodDump,
    LibMame_ImageStatus_BadDump,
    LibMame_ImageStatus_NoDump
} LibMame_ImageStatus;


typedef enum
{
    LibMame_RenderPrimitiveType_Invalid,
    LibMame_RenderPrimitiveType_Line,
    LibMame_RenderPrimitiveType_Quad
} LibMame_RenderPrimitiveType;


typedef enum
{
    LibMame_TextureFormat_Undefined     = 0x0000,
    LibMame_TextureFormat_Palette16     = 0x0010,
    LibMame_TextureFormat_PaletteA16    = 0x0020,
    LibMame_TextureFormat_RGB15         = 0x0030,
    LibMame_TextureFormat_RGB32         = 0x0040,
    LibMame_TextureFormat_ARGB32        = 0x0050,
    LibMame_TextureFormat_YUY16         = 0x0060
} LibMame_TextureFormat;


typedef enum
{
    LibMame_BlendMode_None              = 0x0000,
    LibMame_BlendMode_Alpha             = 0x0100,
    LibMame_BlendMode_RGB_Multiply      = 0x0200,
    LibMame_BlendMode_RGB_Add           = 0x0300
} LibMame_BlendMode;


typedef enum
{
    LibMame_StartupPhase_Preparing,
    LibMame_StartupPhase_LoadingRoms,
    LibMame_StartupPhase_InitializingMachine
} LibMame_StartupPhase;


typedef enum
{
    LibMame_RunGameStatus_Success,
    LibMame_RunGameStatus_InvalidGameNum,
    LibMame_RunGameStatus_FailedValidityCheck,
    LibMame_RunGameStatus_MissingFiles,
    LibMame_RunGameStatus_NoSuchGame,
    LibMame_RunGameStatus_InvalidConfig,
    LibMame_RunGameStatus_GeneralError
} LibMame_RunGameStatus;


/*****************************************************************************
 * Structured type definitions
 *****************************************************************************/

typedef struct LibMame_ScreenResolution
{
    int width, height;
} LibMame_ScreenResolution;


typedef struct LibMame_SoundSample
{
    const char *name;

    int source_gamenum;
} LibMame_SoundSample;


typedef struct LibMame_Chip
{
    int is_sound;

    const char *tag;

    const char *name;

    int clock_hz;
} LibMame_Chip;


typedef struct LibMame_Dipswitch
{
    const char *name;

    const char *tag;

    uint32_t mask;

    int value_count;

    int default_value;

    const char * const *value_names;
} LibMame_Dipswitch;


typedef struct LibMame_PerPlayerControllers
{
    int controller_flags;

    int normal_button_flags;

    const char *normal_button_names[LibMame_NormalButtonTypeCount];

    int mahjong_button_flags;

    int hanafuda_button_flags;

    int gambling_button_flags;
} LibMame_PerPlayerControllers;


typedef struct LibMame_SharedControllers
{
    int shared_button_flags;

    int special_button_flags;

    const char *special_button_names[LibMame_SpecialButtonTypeCount];
} LibMame_SharedControllers;


typedef struct LibMame_AllControllers
{
    LibMame_PerPlayerControllers per_player;

    LibMame_SharedControllers shared;
} LibMame_AllControllers;


typedef struct LibMame_BiosSet
{
    const char *name;

    const char *description;
    
    int is_default;

    int rom_count;

    const int *rom_numbers;
} LibMame_BiosSet;


typedef struct LibMame_Image
{
    const char *name;

    LibMame_ImageStatus status;

    int is_optional;

    int size_if_known;

    const char *clone_of_game;
    const char *clone_of_rom;

    const char *crc;

    const char *sha1;

    const char *md5;
} LibMame_Image;


typedef struct LibMame_PerPlayerControlsState
{
    int left_joystick_state;

    int right_joystick_state;

    int analog_joystick_horizontal_state;

    int analog_joystick_vertical_state;

    int spinner_delta;

    int vertical_spinner_delta;

    int paddle_state;

    int vertical_paddle_state;

    int trackball_horizontal_delta;

    int trackball_vertical_delta;

    int lightgun_horizontal_state;

    int lightgun_vertical_state;

    int pedal_state;

    int pedal2_state;

    int pedal3_state;

    int normal_buttons_state;

    int mahjong_buttons_state;

    int hanafuda_buttons_state;
    
    int gambling_buttons_state;
} LibMame_PerPlayerControlsState;


typedef struct LibMame_SharedControlsState
{
    int shared_buttons_state;

    int special_buttons_state;

    int ui_input_state;
} LibMame_SharedControlsState;


typedef struct LibMame_AllControlsState
{
    LibMame_PerPlayerControlsState per_player[8];

    LibMame_SharedControlsState shared;
} LibMame_AllControlsState;


typedef struct LibMame_RunGameOptions
{
    /* search paths for files of specific types; of the form DIR1;DIR2;...
       These files are only read (not written) by MAME -------------------- */

    char rom_path[1024];
    char sample_path[1024];
    char art_path[1024];
    char ctrl_path[1024];
    char ini_path[1024];
    char font_path[1024];
    char cheat_path[1024];
    char crosshair_path[1024];

    /* single directories for files of specific types.  These files are read
       and written by MAME ------------------------------------------------ */

    char nvram_directory[256];
    char memcard_directory[256];
    char input_directory[256];
    char state_directory[256];
    char snapshot_directory[256];
    char diff_directory[256];
    char comment_directory[256];

    /* state/playback options --------------------------------------------- */

    char state[1024]; 
    int autosave; 
    char playback_file[256];
    char record_file[256];
    char mngwrite_file[256];
    char aviwrite_file[256];
    char wavwrite_file[256];
    char snapsize[16];
    char snapview[64];
    int burnin;
    
    /* core performance options ------------------------------------------- */

    int auto_frame_skip;
    int frame_skip_level;
    int throttle;
    int sleep;
    float speed_multiplier;
    int auto_refresh_speed;

    /* core rotation/flip options ----------------------------------------- */

    int rotate;
    int rotate_right;
    int rotate_left;
    int auto_rotate_right;
    int auto_rotate_left;
    int flip_x;
    int flip_y;

    /* core artwork options ----------------------------------------------- */

    int crop_artwork;
    int use_backdrops;
    int use_overlays;
    int use_bezels;

    /* core screen options ------------------------------------------------ */

    float brightness;
    float contrast;
    float gamma;
    float pause_brightness;
    int quiet_startup;
    char effect[256];

    /* core vector options ------------------------------------------------ */

    int vector_antialias;
    float vector_beam;
    float vector_flicker;

    /* core sound options ------------------------------------------------- */

    int sound;
    int sample_rate;
    int use_samples;
    int volume_attenuation;

    /* core input options ------------------------------------------------- */

    int coin_lockout;
    char joystick_map[32];
    float joystick_deadzone;
    float joystick_saturation;
    int enable_steadykey;
    int enable_natural_keyboard;
    int enable_lightgun_offscreen_reload;

    /* core debugging options --------------------------------------------- */

    int verbose_output;
    int emit_log;
    int debug;
    int debug_internal;
    int debugscript;
    int update_in_pause;

    /* core misc options -------------------------------------------------- */

    char special_bios[64];
    int enable_cheats;
    int skip_gameinfo_screens;

} LibMame_RunGameOptions;


typedef struct LibMame_RenderPrimitive
{
    LibMame_RenderPrimitiveType type;

    struct {
        float x0;   /* leftmost X coordinate */
        float y0;   /* topmost Y coordinate */
        float x1;   /* rightmost X coordinate */
        float y1;   /* bottommost Y coordinate */
    } bounds;

    struct {
        float a;    /* alpha component (0.0 = transparent, 1.0 = opaque) */
        float r;    /* red component (0.0 = none, 1.0 = max) */
        float g;    /* green component (0.0 = none, 1.0 = max) */
        float b;    /* blue component (0.0 = none, 1.0 = max) */
    } color;

    uint32_t flags;

    float width;

    struct {
        void *base;           /* base of the data */

        uint32_t rowpixels;   /* pixels per row */

        uint32_t width;

        uint32_t height;      /* height of the image */

        const uint32_t *palette;

        uint32_t seqid;
    } texture;

    struct 
    {
        struct {
            float u, v;
        } top_left;

        struct {
            float u, v;
        } top_right;

        struct {
            float u, v;
        } bottom_left;

        struct {
            float u, v;
        } bottom_right;
    } quad_texuv;

    struct LibMame_RenderPrimitive *next;
} LibMame_RenderPrimitive;


typedef struct LibMame_RunGameCallbacks
{
    void (*StatusText)(const char *format, va_list args, void *callback_data);

    void (*StartingUp)(LibMame_StartupPhase phase, int pct_complete,
                       LibMame_RunningGame *running_game,
                       void *callback_data);

    void (*PollAllControlsState)(LibMame_AllControlsState *all_states,
                                 void *callback_data);

    void (*UpdateVideo)(const LibMame_RenderPrimitive *render_primitive_list,
                        void *callback_data);

    void (*UpdateAudio)(int sample_rate, int samples_this_frame, 
                        const int16_t *buffer, void *callback_data);

    void (*SetMasterVolume)(int attenuation, void *callback_data);

    void (*MakeRunningGameCalls)(void *callback_data);

    void (*Paused)(void *callback_data);
     
} LibMame_RunGameCallbacks;


/*****************************************************************************
 * Functions comprising the libmame API
 *****************************************************************************/

/*----------------------------------------------------------------------------
 * Functions for managing the library.
 ----------------------------------------------------------------------------*/

LibMame_InitializeStatus LibMame_Initialize();


void LibMame_Deinitialize();


const char *LibMame_Get_Version_String();


/*----------------------------------------------------------------------------
 * Functions for querying the supported games and their properties
 ----------------------------------------------------------------------------*/

int LibMame_Get_Game_Count(); 


int LibMame_Get_Game_Number(const char *short_name);


int LibMame_Get_Game_Matches(const char *short_name, int num_matches,
                             int *gamenums);

const char *LibMame_Get_Game_Short_Name(int gamenum);


const char *LibMame_Get_Game_Full_Name(int gamenum);


int LibMame_Get_Game_Year_Of_Release(int gamenum);


int LibMame_Get_Game_CloneOf(int gamenum);


const char *LibMame_Get_Game_Manufacturer(int gamenum);


int LibMame_Get_Game_WorkingFlags(int gamenum);


LibMame_OrientationType LibMame_Get_Game_Orientation(int gamenum);


LibMame_ScreenType LibMame_Get_Game_ScreenType(int gamenum);


LibMame_ScreenResolution LibMame_Get_Game_ScreenResolution(int gamenum);


float LibMame_Get_Game_ScreenRefreshRateHz(int gamenum);


int LibMame_Get_Game_SoundChannels(int gamenum);


int LibMame_Get_Game_SoundSamples_Count(int gamenum);


int LibMame_Get_Game_SoundSamplesSource(int gamenum);


const char *LibMame_Get_Game_SoundSampleFileName(int gamenum, int samplenum);


int LibMame_Get_Game_Chip_Count(int gamenum);


LibMame_Chip LibMame_Get_Game_Chip(int gamenum, int chipnum);


int LibMame_Get_Game_Dipswitch_Count(int gamenum);


LibMame_Dipswitch LibMame_Get_Game_Dipswitch(int gamenum, int num);


int LibMame_Get_Game_MaxSimultaneousPlayers(int gamenum);


LibMame_AllControllers LibMame_Get_Game_AllControllers(int gamenum);


int LibMame_Get_Game_BiosSet_Count(int gamenum);


LibMame_BiosSet LibMame_Get_Game_BiosSet(int gamenum, int biossetnum);


int LibMame_Get_Game_Rom_Count(int gamenum);


LibMame_Image LibMame_Get_Game_Rom(int gamenum, int romnum);


int LibMame_Get_Game_Hdd_Count(int gamenum);


LibMame_Image LibMame_Get_Game_Hdd(int gamenum, int hddnum);


const char *LibMame_Get_Game_SourceFileName(int gamenum);


/*----------------------------------------------------------------------------
 * Functions for managing options
 ----------------------------------------------------------------------------*/

void LibMame_Get_Default_RunGameOptions(LibMame_RunGameOptions *options);


/*----------------------------------------------------------------------------
 * Functions for running a game
 ----------------------------------------------------------------------------*/

LibMame_RunGameStatus LibMame_RunGame(int gamenum, int benchmarking,
                                      const LibMame_RunGameOptions *options,
                                      const LibMame_RunGameCallbacks *cbs,
                                      void *callback_data);


const char *LibMame_RunningGame_GetSpeedText(LibMame_RunningGame *game);


/*----------------------------------------------------------------------------
 * Functions for altering the state of a running game
 ----------------------------------------------------------------------------*/

void LibMame_RunningGame_Schedule_Pause(LibMame_RunningGame *game);


void LibMame_RunningGame_Schedule_Exit(LibMame_RunningGame *game);


void LibMame_RunningGame_Schedule_Hard_Reset(LibMame_RunningGame *game);


void LibMame_RunningGame_Schedule_Soft_Reset(LibMame_RunningGame *game);


void LibMame_RunningGame_SaveState(LibMame_RunningGame *game,
                                   const char *filename);


void LibMame_RunningGame_LoadState(LibMame_RunningGame *game,
                                   const char *filename);


void LibMame_RunningGame_ChangeDipswitchValue(LibMame_RunningGame *game,
                                              const char *tag, uint32_t mask,
                                              const char *value);


#ifdef __cplusplus
}
#endif

#endif /* __LIBMAME_H__ */