RetroArch/dynamic.h

188 lines
6.2 KiB
C
Raw Normal View History

2012-04-21 21:13:50 +00:00
/* RetroArch - A frontend for libretro.
2014-01-01 00:50:59 +00:00
* Copyright (C) 2010-2014 - Hans-Kristian Arntzen
2016-01-10 03:06:50 +00:00
* Copyright (C) 2011-2016 - Daniel De Matteis
2010-12-30 12:54:49 +00:00
*
2012-04-21 21:13:50 +00:00
* RetroArch is free software: you can redistribute it and/or modify it under the terms
2010-12-30 12:54:49 +00:00
* of the GNU General Public License as published by the Free Software Found-
* ation, either version 3 of the License, or (at your option) any later version.
*
2012-04-21 21:13:50 +00:00
* RetroArch is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
2010-12-30 12:54:49 +00:00
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU General Public License for more details.
*
2012-04-21 21:31:57 +00:00
* You should have received a copy of the GNU General Public License along with RetroArch.
2010-12-30 12:54:49 +00:00
* If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __DYNAMIC_H
#define __DYNAMIC_H
#include <boolean.h>
2016-06-03 00:39:35 +00:00
#include <retro_common_api.h>
#include <libretro.h>
2016-02-04 19:56:22 +00:00
2016-03-22 01:56:06 +00:00
#include "core_type.h"
2010-12-30 12:54:49 +00:00
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
2016-06-03 00:39:35 +00:00
RETRO_BEGIN_DECLS
2013-02-09 09:36:39 +00:00
2015-01-09 20:30:07 +00:00
/**
* libretro_get_environment_info:
* @func : Function pointer for get_environment_info.
* @load_no_content : If true, core should be able to auto-start
* without any content loaded.
*
* Sets environment callback in order to get statically known
2014-09-02 03:57:53 +00:00
* information from it.
*
* Fetched via environment callbacks instead of
* retro_get_system_info(), as this info is part of extensions.
*
* Should only be called once right after core load to
* avoid overwriting the "real" environ callback.
*
* For statically linked cores, pass retro_set_environment as argument.
*/
2014-09-07 03:47:18 +00:00
void libretro_get_environment_info(void (*)(retro_environment_t),
bool *load_no_content);
2013-03-17 19:08:24 +00:00
#ifdef HAVE_DYNAMIC
2015-01-09 20:30:07 +00:00
/**
* libretro_get_system_info:
* @path : Path to libretro library.
* @info : System info information.
* @load_no_content : If true, core should be able to auto-start
* without any content loaded.
*
* Gets system info from an arbitrary lib.
* The struct returned must be freed as strings are allocated dynamically.
*
* Returns: true (1) if successful, otherwise false (0).
**/
2014-09-07 03:47:18 +00:00
bool libretro_get_system_info(const char *path,
struct retro_system_info *info, bool *load_no_content);
#else
/**
* libretro_get_system_info_static:
* @info : System info information.
* @load_no_content : If true, core should be able to auto-start
* without any content loaded.
*
* Gets system info from the current statically linked libretro library.
* The struct returned must be freed as strings are allocated dynamically.
*
* Returns: true (1) if successful, otherwise false (0).
**/
bool libretro_get_system_info_static(struct retro_system_info *info,
bool *load_no_content);
#endif
2014-09-02 03:57:53 +00:00
2015-01-09 20:30:07 +00:00
/**
* libretro_free_system_info:
* @info : Pointer to system info information.
*
* Frees system information.
**/
2013-03-17 19:08:24 +00:00
void libretro_free_system_info(struct retro_system_info *info);
2015-01-09 20:30:07 +00:00
/**
* libretro_get_current_core_pathname:
* @name : Sanitized name of libretro core.
* @size : Size of @name
*
* Transforms a library id to a name suitable as a pathname.
**/
void libretro_get_current_core_pathname(char *name, size_t size);
2014-09-02 03:57:53 +00:00
const struct retro_subsystem_info *libretro_find_subsystem_info(
const struct retro_subsystem_info *info,
unsigned num_info, const char *ident);
2015-01-15 01:48:40 +00:00
/**
* libretro_find_controller_description:
* @info : Pointer to controller info handle.
* @id : Identifier of controller to search
* for.
*
* Search for a controller of type @id in @info.
*
* Returns: controller description of found controller on success,
* otherwise NULL.
**/
2014-09-02 03:57:53 +00:00
const struct retro_controller_description *
libretro_find_controller_description(
const struct retro_controller_info *info, unsigned id);
2014-04-04 12:58:42 +00:00
2015-01-15 01:48:40 +00:00
/**
* rarch_environment_cb:
* @cmd : Identifier of command.
* @data : Pointer to data.
*
* Environment callback function implementation.
*
* Returns: true (1) if environment callback command could
* be performed, otherwise false (0).
**/
bool rarch_environment_cb(unsigned cmd, void *data);
struct retro_core_t
{
void (*retro_init)(void);
void (*retro_deinit)(void);
unsigned (*retro_api_version)(void);
void (*retro_get_system_info)(struct retro_system_info*);
void (*retro_get_system_av_info)(struct retro_system_av_info*);
void (*retro_set_environment)(retro_environment_t);
void (*retro_set_video_refresh)(retro_video_refresh_t);
void (*retro_set_audio_sample)(retro_audio_sample_t);
void (*retro_set_audio_sample_batch)(retro_audio_sample_batch_t);
void (*retro_set_input_poll)(retro_input_poll_t);
void (*retro_set_input_state)(retro_input_state_t);
void (*retro_set_controller_port_device)(unsigned, unsigned);
void (*retro_reset)(void);
void (*retro_run)(void);
size_t (*retro_serialize_size)(void);
bool (*retro_serialize)(void*, size_t);
bool (*retro_unserialize)(const void*, size_t);
void (*retro_cheat_reset)(void);
void (*retro_cheat_set)(unsigned, bool, const char*);
bool (*retro_load_game)(const struct retro_game_info*);
2016-02-04 19:58:53 +00:00
bool (*retro_load_game_special)(unsigned,
const struct retro_game_info*, size_t);
void (*retro_unload_game)(void);
unsigned (*retro_get_region)(void);
void *(*retro_get_memory_data)(unsigned);
size_t (*retro_get_memory_size)(unsigned);
};
2014-09-02 03:57:53 +00:00
2015-05-08 07:44:41 +00:00
/**
* init_libretro_sym:
2015-06-20 21:42:30 +00:00
* @type : Type of core to be loaded.
* If CORE_TYPE_DUMMY, will
* load dummy symbols.
2015-05-08 07:44:41 +00:00
*
* Initializes libretro symbols and
* setups environment callback functions.
**/
2016-02-04 19:58:53 +00:00
void init_libretro_sym(enum rarch_core_type type,
struct retro_core_t *core);
2015-05-08 07:44:41 +00:00
/**
* uninit_libretro_sym:
*
* Frees libretro core.
*
* Frees all core options,
* associated state, and
* unbind all libretro callback symbols.
**/
2016-01-28 02:36:14 +00:00
void uninit_libretro_sym(struct retro_core_t *core);
2015-05-08 07:44:41 +00:00
2016-06-03 00:39:35 +00:00
RETRO_END_DECLS
2013-02-09 09:36:39 +00:00
2010-12-30 12:54:49 +00:00
#endif