Incremental statestream checkpoints for replays (#18213)

Author: JoeOsborn

.dir-locals.el

@@ -2,9 +2,12 @@
 ;;; See Info node `(emacs) Directory Variables' for more information.
 
 (
- (c-mode . ((c-basic-offset . 3)
+ (c-mode . ((standard-indent . 3)
+            (c-basic-offset . 3)
             (c-file-offsets . ((arglist-intro . ++)
-                               (arglist-cont-nonempty . ++)))
+                               (arglist-cont-nonempty . ++)
+                               (block-close . 0)
+                               (block-open . 0)))
             (eval . (setq-local c-cleanup-list
                                 (cl-set-difference c-cleanup-list
                                                    '(brace-else-brace

CHANGES.md

@@ -31,6 +31,11 @@
 - INPUT: Reset and close content hotkeys now require confirmation, similar to quit
 - INPUT/ANDROID: Favor mouse coordinates for lightgun
 - INPUT/UDEV: Fix lost terminal settings after restart from menu
+- INPUT/BSV/REPLAY: Bumped replay format version to 2. Old replays will still play back fine.
+- INPUT/BSV/REPLAY: Add option to skip deserializing checkpoints from replay files (it introduces jank in some emulators).
+- INPUT/BSV/REPLAY: Add checkpoint and initial savestate compression, following the `savestate_file_compression` config boolean.  Use zstd if available, or fall back to zlib.
+- INPUT/BSV/REPLAY: Add incremental checkpoints based on statestreams (depending on `HAVE_STATESTREAM` compile time flag).  As an example, 60 `pcsx_rearmed` savestates would take 267MB uncompressed; with incremental encoding this is reduced to 77MB.  Compressing the result can reduce the size to just 4MB.
+- INPUT/BSV/REPLAY: Checkpoint compression and encoding can be combined. For example, 60 `pcsx_rearmed` checkpoints can take up just 15MB if each state is incremental and compressed. This is not as optimal as using incremental states without save state compression followed by offline compression, but is a good compromise in many use cases.
 - INTL: Add Irish Gaelic to selectable languages
 - IOS: Fix crash on iOS9 when fetching refresh rate
 - LINUX: Add full complement of key/value pairs to desktop entry

Makefile

@@ -1,4 +1,5 @@
 HAVE_FILE_LOGGER=1
+HAVE_STATESTREAM?=1
 NEED_CXX_LINKER?=0
 NEED_GOLD_LINKER?=0
 MISSING_DECLS   =0

Makefile.common

@@ -25,6 +25,10 @@ ifeq ($(HAVE_SAPI), 1)
    LIBS += sapi.dll
 endif
 
+ifeq ($(HAVE_STATESTREAM), 1)
+   DEF_FLAGS += -DHAVE_STATESTREAM
+endif
+
 ifeq ($(HAVE_GL_CONTEXT),)
    HAVE_GL_CONTEXT = 0
    HAVE_GL_MODERN  = 0
@@ -451,6 +455,8 @@ endif
 
 ifeq ($(HAVE_BSV_MOVIE), 1)
    DEFINES += -DHAVE_BSV_MOVIE
+   OBJ += input/bsv/bsvmovie.o \
+          input/bsv/uint32s_index.o
 endif
 
 ifeq ($(HAVE_RUNAHEAD), 1)

Makefile.emscripten

@@ -14,6 +14,7 @@ OBJ :=
 DEFINES := -DRARCH_INTERNAL -DHAVE_MAIN -DEMSCRIPTEN
 DEFINES += -DHAVE_FILTERS_BUILTIN -DHAVE_ONLINE_UPDATER -DHAVE_UPDATE_ASSETS -DHAVE_UPDATE_CORE_INFO
 
+HAVE_STATESTREAM ?= 1
 HAVE_PATCH = 1
 HAVE_DSP_FILTER = 1
 HAVE_VIDEO_FILTER = 1

config.def.h

@@ -1407,6 +1407,11 @@
 /* Specifies how often checkpoints will be saved to replay files during recording.
  * > Setting value to zero disables recording checkpoints. */
 #define DEFAULT_REPLAY_CHECKPOINT_INTERVAL 0
+/* Specifies whether checkpoints in replay files should be loaded
+ * during playback.  This can be helpful for cores that are not
+ * deterministic but in some cores produces janky results depending on
+ * when inputs are processed. */
+#define DEFAULT_REPLAY_CHECKPOINT_DESERIALIZE true
 
 /* Automatically saves a savestate at the end of RetroArch's lifetime.
  * The path is $SRAM_PATH.auto.

configuration.c

@@ -2247,6 +2247,9 @@ static struct config_bool_setting *populate_settings_bool(
    SETTING_BOOL("network_remote_enable",         &settings->bools.network_remote_enable, false, false /* TODO */, false);
 #endif
 #endif
+#ifdef HAVE_BSV_MOVIE
+   SETTING_BOOL("replay_checkpoint_deserialize", &settings->bools.replay_checkpoint_deserialize,  true, DEFAULT_REPLAY_CHECKPOINT_DESERIALIZE, false);
+#endif
 
 #ifdef ANDROID
    SETTING_BOOL("android_input_disconnect_workaround", &settings->bools.android_input_disconnect_workaround, true, false, false);

configuration.h

@@ -1108,6 +1108,10 @@ typedef struct settings
       bool ai_service_pause;
 
       bool gamemode_enable;
+#ifdef HAVE_BSV_MOVIE
+      bool replay_checkpoint_deserialize;
+#endif
+
 #ifdef _3DS
       bool new3ds_speedup_enable;
       bool bottom_font_enable;

griffin/griffin.c

@@ -604,6 +604,10 @@ INPUT
 ============================================================ */
 
 #include "../input/input_driver.c"
+#ifdef HAVE_BSV_MOVIE
+#include "../input/bsv/bsvmovie.c"
+#include "../input/bsv/uint32s_index.c"
+#endif
 #include "../input/input_keymaps.c"
 #include "../tasks/task_autodetect.c"
 #include "../input/input_autodetect_builtin.c"