command.h

Go to the documentation of this file.

/* RetroArch - A frontend for libretro.
 * Copyright (C) 2010-2014 - Hans-Kristian Arntzen
 * Copyright (C) 2011-2016 - Daniel De Matteis
 * Copyright (C) 2016 - Brad Parker
 *
 * RetroArch is free software: you can redistribute it and/or modify it under the terms
 * 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.
 *
 * RetroArch is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 * PURPOSE. See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with RetroArch.
 * If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef COMMAND_H__
#define COMMAND_H__

#include <stdint.h>

#include <boolean.h>
#include <retro_common_api.h>

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "playlist.h"

RETRO_BEGIN_DECLS

typedef struct command command_t;

typedef struct command_handle
{
 command_t *handle;
 unsigned id;
} command_handle_t;

enum event_command
{
 CMD_EVENT_NONE = 0,
 /* Resets RetroArch. */
 CMD_EVENT_RESET,
 CMD_EVENT_SET_PER_GAME_RESOLUTION,
 CMD_EVENT_SET_FRAME_LIMIT,
 /* Loads core. */
 CMD_EVENT_LOAD_CORE,
 CMD_EVENT_LOAD_CORE_PERSIST,
 CMD_EVENT_UNLOAD_CORE,
 CMD_EVENT_LOAD_STATE,
 /* Swaps the current state with what's on the undo load buffer */
 CMD_EVENT_UNDO_LOAD_STATE,
 /* Rewrites a savestate on disk */
 CMD_EVENT_UNDO_SAVE_STATE,
 CMD_EVENT_SAVE_STATE,
 CMD_EVENT_SAVE_STATE_DECREMENT,
 CMD_EVENT_SAVE_STATE_INCREMENT,
 /* Takes screenshot. */
 CMD_EVENT_TAKE_SCREENSHOT,
 /* Quits RetroArch. */
 CMD_EVENT_QUIT,
 /* Reinitialize all drivers. */
 CMD_EVENT_REINIT_FROM_TOGGLE,
 /* Reinitialize all drivers. */
 CMD_EVENT_REINIT,
 /* Toggles cheevos hardcore mode. */
 CMD_EVENT_CHEEVOS_HARDCORE_MODE_TOGGLE,
 /* Deinitialize rewind. */
 CMD_EVENT_REWIND_DEINIT,
 /* Initializes rewind. */
 CMD_EVENT_REWIND_INIT,
 /* Toggles rewind. */
 CMD_EVENT_REWIND_TOGGLE,
 /* Deinitializes autosave. */
 CMD_EVENT_AUTOSAVE_DEINIT,
 /* Initializes autosave. */
 CMD_EVENT_AUTOSAVE_INIT,
 CMD_EVENT_AUTOSAVE_STATE,
 /* Stops audio. */
 CMD_EVENT_AUDIO_STOP,
 /* Starts audio. */
 CMD_EVENT_AUDIO_START,
 /* Mutes audio. */
 CMD_EVENT_AUDIO_MUTE_TOGGLE,
 /* Toggles FPS counter. */
 CMD_EVENT_FPS_TOGGLE,
 /* Initializes overlay. */
 CMD_EVENT_OVERLAY_INIT,
 /* Deinitializes overlay. */
 CMD_EVENT_OVERLAY_DEINIT,
 /* Sets current scale factor for overlay. */
 CMD_EVENT_OVERLAY_SET_SCALE_FACTOR,
 /* Sets current alpha modulation for overlay. */
 CMD_EVENT_OVERLAY_SET_ALPHA_MOD,
 /* Cycle to next overlay. */
 CMD_EVENT_OVERLAY_NEXT,
 /* Deinitializes overlay. */
 CMD_EVENT_DSP_FILTER_INIT,
 /* Deinitializes graphics filter. */
 CMD_EVENT_DSP_FILTER_DEINIT,
 /* Deinitializes GPU recoring. */
 CMD_EVENT_GPU_RECORD_DEINIT,
 /* Initializes recording system. */
 CMD_EVENT_RECORD_INIT,
 /* Deinitializes recording system. */
 CMD_EVENT_RECORD_DEINIT,
 /* Deinitializes history playlist. */
 CMD_EVENT_HISTORY_DEINIT,
 /* Initializes history playlist. */
 CMD_EVENT_HISTORY_INIT,
 /* Deinitializes core information. */
 CMD_EVENT_CORE_INFO_DEINIT,
 /* Initializes core information. */
 CMD_EVENT_CORE_INFO_INIT,
 /* Deinitializes core. */
 CMD_EVENT_CORE_DEINIT,
 /* Initializes core. */
 CMD_EVENT_CORE_INIT,
 /* Set audio blocking state. */
 CMD_EVENT_AUDIO_SET_BLOCKING_STATE,
 /* Set audio nonblocking state. */
 CMD_EVENT_AUDIO_SET_NONBLOCKING_STATE,
 /* Apply video state changes. */
 CMD_EVENT_VIDEO_APPLY_STATE_CHANGES,
 /* Set video blocking state. */
 CMD_EVENT_VIDEO_SET_BLOCKING_STATE,
 /* Set video nonblocking state. */
 CMD_EVENT_VIDEO_SET_NONBLOCKING_STATE,
 /* Sets current aspect ratio index. */
 CMD_EVENT_VIDEO_SET_ASPECT_RATIO,
 CMD_EVENT_RESET_CONTEXT,
 /* Restarts RetroArch. */
 CMD_EVENT_RESTART_RETROARCH,
 /* Shutdown the OS */
 CMD_EVENT_SHUTDOWN,
 /* Reboot the OS */
 CMD_EVENT_REBOOT,
 /* Resume RetroArch when in menu. */
 CMD_EVENT_RESUME,
 /* Add a playlist entry to favorites. */
 CMD_EVENT_ADD_TO_FAVORITES,
 /* Reset playlist entry associated core to DETECT */
 CMD_EVENT_RESET_CORE_ASSOCIATION,
 /* Toggles pause. */
 CMD_EVENT_PAUSE_TOGGLE,
 /* Pauses RetroArch. */
 CMD_EVENT_UNPAUSE,
 /* Unpauses retroArch. */
 CMD_EVENT_PAUSE,
 CMD_EVENT_PAUSE_CHECKS,
 CMD_EVENT_MENU_RESET_TO_DEFAULT_CONFIG,
 CMD_EVENT_MENU_SAVE_CURRENT_CONFIG,
 CMD_EVENT_MENU_SAVE_CURRENT_CONFIG_OVERRIDE_CORE,
 CMD_EVENT_MENU_SAVE_CURRENT_CONFIG_OVERRIDE_CONTENT_DIR,
 CMD_EVENT_MENU_SAVE_CURRENT_CONFIG_OVERRIDE_GAME,
 CMD_EVENT_MENU_SAVE_CONFIG,
 CMD_EVENT_MENU_PAUSE_LIBRETRO,
 /* Toggles menu on/off. */
 CMD_EVENT_MENU_TOGGLE,
 /* Applies shader changes. */
 CMD_EVENT_SHADERS_APPLY_CHANGES,
 /* A new shader preset has been loaded */
 CMD_EVENT_SHADER_PRESET_LOADED,
 /* Initializes shader directory. */
 CMD_EVENT_SHADER_DIR_INIT,
 /* Deinitializes shader directory. */
 CMD_EVENT_SHADER_DIR_DEINIT,
 /* Initializes controllers. */
 CMD_EVENT_CONTROLLERS_INIT,
 /* Initializes cheats. */
 CMD_EVENT_CHEATS_INIT,
 /* Deinitializes cheats. */
 CMD_EVENT_CHEATS_DEINIT,
 /* Apply cheats. */
 CMD_EVENT_CHEATS_APPLY,
 /* Deinitializes network system. */
 CMD_EVENT_NETWORK_DEINIT,
 /* Initializes network system. */
 CMD_EVENT_NETWORK_INIT,
 /* Initializes netplay system with a string or no host specified. */
 CMD_EVENT_NETPLAY_INIT,
 /* Initializes netplay system with a direct host specified. */
 CMD_EVENT_NETPLAY_INIT_DIRECT,
 /* Initializes netplay system with a direct host specified after loading content. */
 CMD_EVENT_NETPLAY_INIT_DIRECT_DEFERRED,
 /* Deinitializes netplay system. */
 CMD_EVENT_NETPLAY_DEINIT,
 /* Switch between netplay gaming and watching. */
 CMD_EVENT_NETPLAY_GAME_WATCH,
 /* Initializes BSV movie. */
 CMD_EVENT_BSV_MOVIE_INIT,
 /* Deinitializes BSV movie. */
 CMD_EVENT_BSV_MOVIE_DEINIT,
 /* Initializes command interface. */
 CMD_EVENT_COMMAND_INIT,
 /* Deinitialize command interface. */
 CMD_EVENT_COMMAND_DEINIT,
 /* Initializes remote gamepad interface. */
 CMD_EVENT_REMOTE_INIT,
 /* Deinitializes remote gamepad interface. */
 CMD_EVENT_REMOTE_DEINIT,
 /* Initializes keyboard to gamepad mapper interface. */
 CMD_EVENT_MAPPER_INIT,
 /* Deinitializes keyboard to gamepad mapper interface. */
 CMD_EVENT_MAPPER_DEINIT,
 /* Reinitializes audio driver. */
 CMD_EVENT_AUDIO_REINIT,
 /* Resizes windowed scale. Will reinitialize video driver. */
 CMD_EVENT_RESIZE_WINDOWED_SCALE,
 CMD_EVENT_LOG_FILE_DEINIT,
 /* Toggles disk eject. */
 CMD_EVENT_DISK_EJECT_TOGGLE,
 /* Cycle to next disk. */
 CMD_EVENT_DISK_NEXT,
 /* Cycle to previous disk. */
 CMD_EVENT_DISK_PREV,
 /* Appends disk image to disk image list. */
 CMD_EVENT_DISK_APPEND_IMAGE,
 /* Stops rumbling. */
 CMD_EVENT_RUMBLE_STOP,
 /* Toggles mouse grab. */
 CMD_EVENT_GRAB_MOUSE_TOGGLE,
 /* Toggles game focus. */
 CMD_EVENT_GAME_FOCUS_TOGGLE,
 /* Toggles desktop menu. */
 CMD_EVENT_UI_COMPANION_TOGGLE,
 /* Toggles fullscreen mode. */
 CMD_EVENT_FULLSCREEN_TOGGLE,
 CMD_EVENT_PERFCNT_REPORT_FRONTEND_LOG,
 CMD_EVENT_VOLUME_UP,
 CMD_EVENT_VOLUME_DOWN,
 CMD_EVENT_MIXER_VOLUME_UP,
 CMD_EVENT_MIXER_VOLUME_DOWN,
 CMD_EVENT_DISABLE_OVERRIDES,
 CMD_EVENT_RESTORE_REMAPS,
 CMD_EVENT_RESTORE_DEFAULT_SHADER_PRESET,
 CMD_EVENT_DISCORD_INIT,
 CMD_EVENT_DISCORD_DEINIT,
 CMD_EVENT_DISCORD_UPDATE
};

bool command_set_shader(const char *arg);

bool command_network_send(const char *cmd_);

bool command_network_new(
 command_t *handle,
 bool stdin_enable,
 bool network_enable,
 uint16_t port);

command_t *command_new(void);

bool command_poll(command_t *handle);

bool command_get(command_handle_t *handle);

bool command_set(command_handle_t *handle);

bool command_free(command_t *handle);

bool command_event(enum event_command action, void *data);

void command_playlist_push_write(
 playlist_t *playlist,
 const char *path,
 const char *label,
 const char *core_path,
 const char *core_name);

void command_playlist_update_write(
 playlist_t *playlist,
 size_t idx,
 const char *path,
 const char *label,
 const char *core_path,
 const char *core_display_name,
 const char *crc32,
 const char *db_name);

RETRO_END_DECLS

#endif