RetroArch/movie.c
2016-01-29 14:30:09 +01:00

447 lines
12 KiB
C

/* RetroArch - A frontend for libretro.
* Copyright (C) 2010-2014 - Hans-Kristian Arntzen
* Copyright (C) 2011-2016 - Daniel De Matteis
*
* 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/>.
*/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <rhash.h>
#include <retro_endianness.h>
#include "movie.h"
#include "libretro_version_1.h"
#include "content.h"
#include "general.h"
#include "msg_hash.h"
#include "verbosity.h"
struct bsv_movie
{
FILE *file;
/* A ring buffer keeping track of positions
* in the file for each frame. */
size_t *frame_pos;
size_t frame_mask;
size_t frame_ptr;
size_t min_file_pos;
size_t state_size;
uint8_t *state;
bool playback;
bool first_rewind;
bool did_rewind;
};
struct bsv_state
{
/* Movie playback/recording support. */
bsv_movie_t *movie;
char movie_path[PATH_MAX_LENGTH];
bool movie_playback;
bool eof_exit;
/* Immediate playback/recording. */
char movie_start_path[PATH_MAX_LENGTH];
bool movie_start_recording;
bool movie_start_playback;
bool movie_end;
};
struct bsv_state bsv_movie_state;
static bool init_playback(bsv_movie_t *handle, const char *path)
{
uint32_t state_size;
uint32_t *content_crc_ptr = NULL;
uint32_t header[4] = {0};
handle->playback = true;
handle->file = fopen(path, "rb");
if (!handle->file)
{
RARCH_ERR("Couldn't open BSV file \"%s\" for playback.\n", path);
return false;
}
if (fread(header, sizeof(uint32_t), 4, handle->file) != 4)
{
RARCH_ERR("Couldn't read movie header.\n");
return false;
}
/* Compatibility with old implementation that
* used incorrect documentation. */
if (swap_if_little32(header[MAGIC_INDEX]) != BSV_MAGIC
&& swap_if_big32(header[MAGIC_INDEX]) != BSV_MAGIC)
{
RARCH_ERR("Movie file is not a valid BSV1 file.\n");
return false;
}
content_ctl(CONTENT_CTL_GET_CRC, &content_crc_ptr);
if (swap_if_big32(header[CRC_INDEX]) != *content_crc_ptr)
RARCH_WARN("CRC32 checksum mismatch between content file and saved content checksum in replay file header; replay highly likely to desync on playback.\n");
state_size = swap_if_big32(header[STATE_SIZE_INDEX]);
if (state_size)
{
retro_ctx_serialize_info_t serial_info;
retro_ctx_size_info_t info;
handle->state = (uint8_t*)malloc(state_size);
handle->state_size = state_size;
if (!handle->state)
return false;
if (fread(handle->state, 1, state_size, handle->file) != state_size)
{
RARCH_ERR("Couldn't read state from movie.\n");
return false;
}
core_ctl(CORE_CTL_RETRO_SERIALIZE_SIZE, &info);
if (info.size == state_size)
{
serial_info.data_const = handle->state;
serial_info.size = state_size;
core_ctl(CORE_CTL_RETRO_UNSERIALIZE, &serial_info);
}
else
RARCH_WARN("Movie format seems to have a different serializer version. Will most likely fail.\n");
}
handle->min_file_pos = sizeof(header) + state_size;
return true;
}
static bool init_record(bsv_movie_t *handle, const char *path)
{
retro_ctx_size_info_t info;
uint32_t state_size;
uint32_t header[4] = {0};
uint32_t *content_crc_ptr = NULL;
handle->file = fopen(path, "wb");
if (!handle->file)
{
RARCH_ERR("Couldn't open BSV \"%s\" for recording.\n", path);
return false;
}
content_ctl(CONTENT_CTL_GET_CRC, &content_crc_ptr);
/* This value is supposed to show up as
* BSV1 in a HEX editor, big-endian. */
header[MAGIC_INDEX] = swap_if_little32(BSV_MAGIC);
header[CRC_INDEX] = swap_if_big32(*content_crc_ptr);
core_ctl(CORE_CTL_RETRO_SERIALIZE_SIZE, &info);
state_size = info.size;
header[STATE_SIZE_INDEX] = swap_if_big32(state_size);
fwrite(header, 4, sizeof(uint32_t), handle->file);
handle->min_file_pos = sizeof(header) + state_size;
handle->state_size = state_size;
if (state_size)
{
retro_ctx_serialize_info_t serial_info;
handle->state = (uint8_t*)malloc(state_size);
if (!handle->state)
return false;
serial_info.data = handle->state;
serial_info.size = state_size;
core_ctl(CORE_CTL_RETRO_SERIALIZE, &serial_info);
fwrite(handle->state, 1, state_size, handle->file);
}
return true;
}
void bsv_movie_free(bsv_movie_t *handle)
{
if (!handle)
return;
if (handle->file)
fclose(handle->file);
free(handle->state);
free(handle->frame_pos);
free(handle);
}
bool bsv_movie_get_input(int16_t *input)
{
bsv_movie_t *handle = bsv_movie_state.movie;
if (fread(input, sizeof(int16_t), 1, handle->file) != 1)
return false;
*input = swap_if_big16(*input);
return true;
}
void bsv_movie_set_input(int16_t input)
{
bsv_movie_t *handle = bsv_movie_state.movie;
input = swap_if_big16(input);
fwrite(&input, sizeof(int16_t), 1, handle->file);
}
bsv_movie_t *bsv_movie_init(const char *path, enum rarch_movie_type type)
{
bsv_movie_t *handle = (bsv_movie_t*)calloc(1, sizeof(*handle));
if (!handle)
return NULL;
if (type == RARCH_MOVIE_PLAYBACK)
{
if (!init_playback(handle, path))
goto error;
}
else if (!init_record(handle, path))
goto error;
/* Just pick something really large
* ~1 million frames rewind should do the trick. */
if (!(handle->frame_pos = (size_t*)calloc((1 << 20), sizeof(size_t))))
goto error;
handle->frame_pos[0] = handle->min_file_pos;
handle->frame_mask = (1 << 20) - 1;
return handle;
error:
bsv_movie_free(handle);
return NULL;
}
void bsv_movie_set_frame_start(bsv_movie_t *handle)
{
if (!handle)
return;
handle->frame_pos[handle->frame_ptr] = ftell(handle->file);
}
void bsv_movie_set_frame_end(bsv_movie_t *handle)
{
if (!handle)
return;
handle->frame_ptr = (handle->frame_ptr + 1) & handle->frame_mask;
handle->first_rewind = !handle->did_rewind;
handle->did_rewind = false;
}
void bsv_movie_frame_rewind(bsv_movie_t *handle)
{
handle->did_rewind = true;
if ((handle->frame_ptr <= 1) && (handle->frame_pos[0] == handle->min_file_pos))
{
/* If we're at the beginning... */
handle->frame_ptr = 0;
fseek(handle->file, handle->min_file_pos, SEEK_SET);
}
else
{
/* First time rewind is performed, the old frame is simply replayed.
* However, playing back that frame caused us to read data, and push
* data to the ring buffer.
*
* Sucessively rewinding frames, we need to rewind past the read data,
* plus another. */
handle->frame_ptr = (handle->frame_ptr -
(handle->first_rewind ? 1 : 2)) & handle->frame_mask;
fseek(handle->file, handle->frame_pos[handle->frame_ptr], SEEK_SET);
}
if (ftell(handle->file) <= (long)handle->min_file_pos)
{
/* We rewound past the beginning. */
if (!handle->playback)
{
retro_ctx_serialize_info_t serial_info;
/* If recording, we simply reset
* the starting point. Nice and easy. */
fseek(handle->file, 4 * sizeof(uint32_t), SEEK_SET);
serial_info.data = handle->state;
serial_info.size = handle->state_size;
core_ctl(CORE_CTL_RETRO_SERIALIZE, &serial_info);
fwrite(handle->state, 1, handle->state_size, handle->file);
}
else
fseek(handle->file, handle->min_file_pos, SEEK_SET);
}
}
static void bsv_movie_init_state(void)
{
settings_t *settings = config_get_ptr();
if (bsv_movie_ctl(BSV_MOVIE_CTL_START_PLAYBACK, NULL))
{
if (!(bsv_movie_init_handle(bsv_movie_state.movie_start_path,
RARCH_MOVIE_PLAYBACK)))
{
RARCH_ERR("%s: \"%s\".\n",
msg_hash_to_str(MSG_FAILED_TO_LOAD_MOVIE_FILE),
bsv_movie_state.movie_start_path);
retro_fail(1, "event_init_movie()");
}
bsv_movie_state.movie_playback = true;
runloop_msg_queue_push(msg_hash_to_str(MSG_STARTING_MOVIE_PLAYBACK), 2, 180, false);
RARCH_LOG("%s.\n", msg_hash_to_str(MSG_STARTING_MOVIE_PLAYBACK));
settings->rewind_granularity = 1;
}
else if (bsv_movie_ctl(BSV_MOVIE_CTL_START_RECORDING, NULL))
{
char msg[256];
snprintf(msg, sizeof(msg),
"%s \"%s\".",
msg_hash_to_str(MSG_STARTING_MOVIE_RECORD_TO),
bsv_movie_state.movie_start_path);
if (!(bsv_movie_init_handle(bsv_movie_state.movie_start_path,
RARCH_MOVIE_RECORD)))
{
runloop_msg_queue_push(msg_hash_to_str(MSG_FAILED_TO_START_MOVIE_RECORD), 1, 180, true);
RARCH_ERR("%s.\n", msg_hash_to_str(MSG_FAILED_TO_START_MOVIE_RECORD));
return;
}
runloop_msg_queue_push(msg, 1, 180, true);
RARCH_LOG("%s \"%s\".\n",
msg_hash_to_str(MSG_STARTING_MOVIE_RECORD_TO),
bsv_movie_state.movie_start_path);
settings->rewind_granularity = 1;
}
}
bool bsv_movie_ctl(enum bsv_ctl_state state, void *data)
{
switch (state)
{
case BSV_MOVIE_CTL_IS_INITED:
return bsv_movie_state.movie;
case BSV_MOVIE_CTL_PLAYBACK_ON:
return bsv_movie_state.movie && bsv_movie_state.movie_playback;
case BSV_MOVIE_CTL_PLAYBACK_OFF:
return bsv_movie_state.movie && !bsv_movie_state.movie_playback;
case BSV_MOVIE_CTL_START_RECORDING:
return bsv_movie_state.movie_start_recording;
case BSV_MOVIE_CTL_SET_START_RECORDING:
bsv_movie_state.movie_start_recording = true;
break;
case BSV_MOVIE_CTL_UNSET_START_RECORDING:
bsv_movie_state.movie_start_recording = false;
break;
case BSV_MOVIE_CTL_START_PLAYBACK:
return bsv_movie_state.movie_start_playback;
case BSV_MOVIE_CTL_SET_START_PLAYBACK:
bsv_movie_state.movie_start_playback = true;
break;
case BSV_MOVIE_CTL_UNSET_START_PLAYBACK:
bsv_movie_state.movie_start_playback = false;
break;
case BSV_MOVIE_CTL_END:
return bsv_movie_state.movie_end;
case BSV_MOVIE_CTL_SET_END_EOF:
bsv_movie_state.eof_exit = true;
break;
case BSV_MOVIE_CTL_END_EOF:
return bsv_movie_state.movie_end && bsv_movie_state.eof_exit;
case BSV_MOVIE_CTL_SET_END:
bsv_movie_state.movie_end = true;
break;
case BSV_MOVIE_CTL_UNSET_END:
bsv_movie_state.movie_end = false;
break;
case BSV_MOVIE_CTL_UNSET_PLAYBACK:
bsv_movie_state.movie_playback = false;
break;
case BSV_MOVIE_CTL_DEINIT:
if (bsv_movie_state.movie)
bsv_movie_free(bsv_movie_state.movie);
bsv_movie_state.movie = NULL;
break;
case BSV_MOVIE_CTL_INIT:
bsv_movie_init_state();
break;
case BSV_MOVIE_CTL_SET_FRAME_START:
bsv_movie_set_frame_start(bsv_movie_state.movie);
break;
case BSV_MOVIE_CTL_SET_FRAME_END:
bsv_movie_set_frame_end(bsv_movie_state.movie);
break;
case BSV_MOVIE_CTL_FRAME_REWIND:
bsv_movie_frame_rewind(bsv_movie_state.movie);
break;
default:
return false;
}
return true;
}
const char *bsv_movie_get_path(void)
{
return bsv_movie_state.movie_path;
}
void bsv_movie_set_path(const char *path)
{
strlcpy(bsv_movie_state.movie_path, path, sizeof(bsv_movie_state.movie_path));
}
void bsv_movie_set_start_path(const char *path)
{
strlcpy(bsv_movie_state.movie_start_path, path,
sizeof(bsv_movie_state.movie_start_path));
}
bool bsv_movie_init_handle(const char *path, enum rarch_movie_type type)
{
bsv_movie_state.movie = bsv_movie_init(path, type);
if (!bsv_movie_state.movie)
return false;
return true;
}