RetroArch/content.h

147 lines
4.7 KiB
C
Raw Normal View History

2012-04-21 17:13:50 -04:00
/* RetroArch - A frontend for libretro.
2013-12-31 19:50:59 -05:00
* Copyright (C) 2010-2014 - Hans-Kristian Arntzen
2017-03-21 22:09:18 -04:00
* Copyright (C) 2011-2017 - Daniel De Matteis
2019-02-22 16:31:54 -05:00
* Copyright (C) 2016-2019 - Brad Parker
2016-10-02 04:03:35 -04:00
*
2012-04-21 17:13:50 -04:00
* RetroArch is free software: you can redistribute it and/or modify it under the terms
2010-12-23 19:33:40 -05: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 17:13:50 -04:00
* RetroArch is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
2010-12-23 19:33:40 -05: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 17:31:57 -04:00
* You should have received a copy of the GNU General Public License along with RetroArch.
2010-12-23 19:33:40 -05:00
* If not, see <http://www.gnu.org/licenses/>.
*/
2012-04-21 17:25:32 -04:00
#ifndef __RARCH_FILE_H
#define __RARCH_FILE_H
#include <stdio.h>
2012-06-24 15:55:36 -04:00
#include <stdint.h>
#include <stddef.h>
2011-01-07 14:52:12 -05:00
#include <sys/types.h>
2016-02-04 14:56:22 -05:00
#include <boolean.h>
#include <retro_common_api.h>
#include <retro_miscellaneous.h>
2016-02-04 14:56:22 -05:00
2016-02-14 19:22:28 -05:00
#include "frontend/frontend_driver.h"
RETRO_BEGIN_DECLS
2016-02-15 23:34:33 -05:00
typedef struct content_ctx_info
{
char **argv; /* Argument variable list. */
void *args; /* Arguments passed from callee */
environment_get_t environ_get; /* Function passed for environment_get function */
2020-08-15 17:10:31 -04:00
int argc; /* Argument count. */
2016-02-15 23:34:33 -05:00
} content_ctx_info_t;
2016-02-14 19:22:28 -05:00
/* Load a state from memory. */
bool content_load_state_from_ram(void);
/* Save a state to memory. */
bool content_save_state_to_ram(void);
/* Save a ram state from memory to disk. */
bool content_ram_state_to_file(const char *path);
2016-05-07 22:31:56 -04:00
/* Load a state from disk to memory. */
2016-10-02 04:03:35 -04:00
bool content_load_state(const char* path, bool load_to_backup_buffer, bool autoload);
2016-05-07 22:31:56 -04:00
/* Save a state from memory to disk. */
bool content_save_state(const char *path, bool save_to_disk);
/* Save an automatic savestate to disk. */
bool content_auto_save_state(const char *path);
2016-05-07 22:31:56 -04:00
/* Check a ram state write to disk. */
bool content_ram_state_pending(void);
/* Gets the number of bytes required to serialize the state. */
2021-02-18 09:44:52 -05:00
size_t content_get_serialized_size(void);
/* Gets the number of bytes required to serialize the state for rewind. */
size_t content_get_serialized_size_rewind(void);
/* Serializes the current state for rewinding. buffer must be at least content_get_serialized_size bytes */
bool content_serialize_state_rewind(void* buffer, size_t buffer_size);
/* Deserializes the current state. */
bool content_deserialize_state(const void* serialized_data, size_t serialized_size);
2020-07-10 21:39:13 -04:00
/* Waits for any in-progress save state tasks to finish */
void content_wait_for_save_state_task(void);
/* Waits for any in-progress load state tasks to finish */
void content_wait_for_load_state_task(void);
/* Copy a save state. */
bool content_rename_state(const char *origin, const char *dest);
/* Undoes the last load state operation that was done */
2016-06-30 00:11:55 -04:00
bool content_undo_load_state(void);
/* Restores the last savestate file which was overwritten */
2016-06-30 00:11:55 -04:00
bool content_undo_save_state(void);
uint8_t content_get_flags(void);
2016-05-07 23:17:31 -04:00
void content_set_does_not_need_content(void);
void content_unset_does_not_need_content(void);
2017-05-06 10:41:22 -04:00
uint32_t content_get_crc(void);
2016-05-07 23:17:31 -04:00
void content_deinit(void);
/* Initializes and loads a content file for the currently
* selected libretro core. */
bool content_init(void);
2015-11-30 13:09:12 -05:00
/* Resets the state and savefile backup buffers */
void content_reset_savestate_backups(void);
/* Checks if the buffers are empty */
2016-06-30 00:11:55 -04:00
bool content_undo_load_buf_is_empty(void);
bool content_undo_save_buf_is_empty(void);
/* Clears the pending subsystem rom buffer */
2018-02-11 10:00:08 -05:00
bool content_is_subsystem_pending_load(void);
/* Clears the pending subsystem rom buffer */
void content_clear_subsystem(void);
/* Set the current subsystem*/
void content_set_subsystem(unsigned subsystem);
2018-02-11 10:00:08 -05:00
/* Get the current subsystem*/
int content_get_subsystem(void);
2018-02-11 10:00:08 -05:00
/* Add a rom to the subsystem rom buffer */
void content_add_subsystem(const char* path);
2018-02-11 10:10:52 -05:00
/* Get the current subsystem rom id */
unsigned content_get_subsystem_rom_id(void);
2018-02-11 10:10:52 -05:00
2018-02-11 15:18:40 -05:00
/* Set environment variables before a subsystem load */
void content_set_subsystem_info(void);
2018-12-16 11:39:38 -05:00
/* Get the path to the last selected subsystem rom */
char* content_get_subsystem_rom(unsigned index);
/* Sets the subsystem by name */
bool content_set_subsystem_by_name(const char* subsystem_name);
/* Get the current subsystem "friendly name" */
void content_get_subsystem_friendly_name(const char* subsystem_name, char* subsystem_friendly_name, size_t len);
/* Sets overrides which modify frontend handling of
* specific content file types */
bool content_file_override_set(const struct retro_system_content_info_override *overrides);
RETRO_END_DECLS
#endif