docs: update README

README.md

@@ -133,7 +133,7 @@ make install
 
 ```shell
 git clone --recursive https://git.klemek.fr/klemek/forge-steel
-cd forge
+cd forge-steel
 makepkg -si
 ```
 
@@ -142,11 +142,11 @@ makepkg -si
 
 ```shell
 git clone --recursive https://git.klemek.fr/klemek/forge-steel
-cd forge
+cd forge-steel
 aclocal
 autoconf
 automake --add-missing
-./configure
+./configure --prefix=$HOME/.local
 make
 make install
 ```
@@ -174,9 +174,7 @@ These are configurable in the [`forge_project.cfg`](#forge_projectcfg).
 ### CLI arguments
 
 ```txt
-forge steel-dev
+usage: forge [-h] [-v] [-p=PROJECT_PATH] [-c=CFG_FILE] [-hr] [-s=SCREEN] [-m=SCREEN] [-mo] [-w] [-t=TEMPO] [-d] [-ar / -nar] [-arc=CYCLES] [-is=SIZE] [-ls / -nls] [-ss / -nss] [-mr / -nmr] [-tm] [-tf] [--x11] [--wayland] [--cocoa] [--win32] [-as / -nas] [-oma=MAJOR] [-omi=MINOR]
-
-usage: forge [-h] [-v] [-p=PROJECT_PATH] [-c=CFG_FILE] [-hr] [-s=SCREEN] [-m=SCREEN] [-mo] [-w] [-t=TEMPO] [-d] [-ar / -nar] [-arc=CYCLES] [-vi=FILE] [-vs=SIZE] [-vb=COUNT] [-vr / -nvr] [-vf=FOURCC] [-is=SIZE] [-ls / -nls] [-ss / -nss] [-mr / -nmr] [-tm] [-tf]
 
 Fusion Of Real-time Generative Effects.
 
@@ -195,21 +193,23 @@ options:
   -ar, --auto-random          randomize state every cycle (4 beats)
   -nar, --no-auto-random      do not randomize state (default)
   -arc, --auto-random-cycle   auto random cycle length (default: 4)
-  -vi, --video-in             path to video capture device (multiple allowed)
-  -vb, --video-buffers        number of video buffers to use (default: 1)
-  -vs, --video-size           video capture desired height (default: internal texture height)
-  -vr, --video-reconnect      auto-reconnect video (default)
-  -nvr, --no-video-reconnect  do not auto-reconnect video
-  -vf, --video-fourcc         video codec fourcc (default: YUYV)
   -is, --internal-size        internal texture height (default: 720)
   -ls, --load-state           load saved state (default)
   -nls, --no-load-state       do not load saved state
   -ss, --save-state           save state (default)
   -nss, --no-save-state       do not save state
+  -as, --auto-save            continuously save state (every ~10ms)
+  -nas, --no-auto-save        do not continuously save state (default)
   -mr, --midi-reconnect       auto-reconnect midi (default)
   -nmr, --no-midi-reconnect   do not auto-reconnect midi
   -tm, --trace-midi           print midi code and values
   -tf, --trace-fps            print fps status of subsystems
+  --x11                       force X11 GLFW backend
+  --wayland                   force Wayland GLFW backend
+  --cocoa                     force Cocoa GLFW backend
+  --win32                     force Win32 GLFW backend
+  -oma, --opengl-major-version      OpenGL major version (default: 4)
+  -omi, --opengl-minor-version      OpenGL minor version (default: 6)
 ```
 
 ## Default Project

src/args.c

@@ -49,6 +49,7 @@ static void print_help(int status_code) {
       "[--wayland] "
       "[--cocoa] "
       "[--win32] "
+      "[-as / -nas] "
       "[-oma=MAJOR] "
       "[-omi=MINOR] "
       "\n\n"
@@ -87,6 +88,8 @@ static void print_help(int status_code) {
       "  -nls, --no-load-state       do not load saved state\n"
       "  -ss, --save-state           save state (default)\n"
       "  -nss, --no-save-state       do not save state\n"
+      "  -as, --auto-save            continuously save state (every ~10ms)\n"
+      "  -nas, --no-auto-save        do not continuously save state (default)\n"
       "  -mr, --midi-reconnect       auto-reconnect midi (default)\n"
       "  -nmr, --no-midi-reconnect   do not auto-reconnect midi\n"
       "  -tm, --trace-midi           print midi code and values\n"
@@ -168,6 +171,7 @@ void args_parse(Parameters *params, int argc, char **argv) {
   params->internal_size = 720;
   params->load_state = true;
   params->save_state = true;
+  params->auto_save = false;
   params->midi_reconnect = true;
   params->trace_midi = false;
   params->trace_fps = false;
@@ -234,6 +238,10 @@ void args_parse(Parameters *params, int argc, char **argv) {
       params->save_state = true;
     } else if (is_arg(arg, "-nss") || is_arg(arg, "--no-save-state")) {
       params->save_state = false;
+    } else if (is_arg(arg, "-as") || is_arg(arg, "--auto-save")) {
+      params->auto_save = true;
+    } else if (is_arg(arg, "-nas") || is_arg(arg, "--no-auto-save")) {
+      params->auto_save = false;
     } else if (is_arg(arg, "-mr") || is_arg(arg, "--midi-reconnect")) {
       params->midi_reconnect = true;
     } else if (is_arg(arg, "-nmr") || is_arg(arg, "--no-midi-reconnect")) {

src/config.h

@@ -87,6 +87,12 @@
 #define MAX_TAP_VALUES 10
 #endif
 
+/* STATE */
+
+#ifndef STATE_AUTO_SAVE_SECONDS
+#define STATE_AUTO_SAVE_SECONDS 0.1
+#endif
+
 /* OPENGL */
 
 #ifndef OPENGL_MAJOR_VERSION
@@ -98,6 +104,7 @@
 #endif
 
 /* GLFW CONSTANTS */
+
 #ifndef GLFW_BACKENDS
 #define GLFW_BACKEND_ANY 0
 #define GLFW_BACKEND_X11 1

src/file.c

@@ -109,10 +109,12 @@ void file_dump(const char *path, const char *content) {
   fclose(file_pointer);
 }
 
-void file_write(const char *path, const StringArray *lines) {
+void file_write(const char *path, const StringArray *lines, const bool log) {
   FILE *file_pointer;
 
-  log_info("Writing %s...", path);
+  if (log) {
+    log_info("Writing %s...", path);
+  }
 
   // open file
   file_pointer = fopen(path, "w");

src/file.h

@@ -9,7 +9,7 @@ bool file_should_update(const File *file);
 
 bool file_update(File *file);
 
-void file_write(const char *path, const StringArray *lines);
+void file_write(const char *path, const StringArray *lines, const bool log);
 
 void file_dump(const char *path, const char *content);
 

src/forge.c

@@ -207,6 +207,7 @@ static void start_state_background_write() {
   process_args->context = &context;
   process_args->state_config = project.state_config;
   process_args->midi = &midi;
+  process_args->auto_save = init_params.auto_save;
   if (pthread_create(&thread, NULL, state_background_write, process_args) ==
       0) {
     pthread_detach(thread);

src/state.c

@@ -12,6 +12,7 @@
 #include "rand.h"
 #include "state.h"
 #include "tempo.h"
+#include "timer.h"
 
 static void safe_midi_write(MidiDevice midi, unsigned int code,
                             unsigned char value) {
@@ -179,10 +180,12 @@ static void load_from_index_file(Context *context, StateConfig state_config,
 }
 
 static void save_to_file(const Context *context, StateConfig state_config,
-                         const char *state_file) {
+                         const char *state_file, const bool log) {
   StringArray lines;
 
-  log_info("Saving state to '%s'...", state_file);
+  if (log) {
+    log_info("Saving state to '%s'...", state_file);
+  }
 
   lines.length = 0;
 
@@ -278,16 +281,16 @@ static void save_to_file(const Context *context, StateConfig state_config,
     }
   }
 
-  file_write(state_file, &lines);
+  file_write(state_file, &lines, log);
 }
 
 static void save_to_default_file(const Context *context,
-                                 StateConfig state_config) {
+                                 StateConfig state_config, const bool log) {
   char state_file[STR_LEN];
 
   snprintf(state_file, STR_LEN, "%s.txt", state_config.save_file_prefix);
 
-  save_to_file(context, state_config, state_file);
+  save_to_file(context, state_config, state_file, log);
 }
 
 static void save_to_index_file(const Context *context, StateConfig state_config,
@@ -297,7 +300,7 @@ static void save_to_index_file(const Context *context, StateConfig state_config,
   snprintf(state_file, STR_LEN, "%s.%d.txt", state_config.save_file_prefix,
            index);
 
-  save_to_file(context, state_config, state_file);
+  save_to_file(context, state_config, state_file, true);
 }
 
 void state_parse_config(StateConfig *state_config, const ConfigFile *config) {
@@ -756,16 +759,20 @@ void *state_background_write(void *args) {
   Context *context = process_args->context;
   StateConfig state_config = process_args->state_config;
   MidiDevice *midi = process_args->midi;
+  bool auto_save = process_args->auto_save;
 
   bool beat_active;
   bool last_active;
   bool change;
   bool last_change;
+  bool do_auto_save;
+  bool last_auto_save;
 
   log_info("(state) background writing started");
 
   last_active = false;
   last_change = false;
+  last_auto_save = false;
 
   while (!context->stop) {
     beat_active = tempo_progress(&context->tempo, 1.0) < 0.5;
@@ -791,6 +798,15 @@ void *state_background_write(void *args) {
     }
 
     last_change = change;
+
+    do_auto_save = fmod(context->time, STATE_AUTO_SAVE_SECONDS) <
+                   STATE_AUTO_SAVE_SECONDS * 0.5;
+
+    if (auto_save && do_auto_save && !last_auto_save) {
+      save_to_default_file(context, state_config, false);
+    }
+
+    last_auto_save = do_auto_save;
   }
 
   log_info("(state) background writing stopped by main thread");
@@ -831,5 +847,5 @@ void state_init(Context *context, StateConfig state_config, bool demo,
 }
 
 void state_save(const Context *context, StateConfig state_config) {
-  save_to_default_file(context, state_config);
+  save_to_default_file(context, state_config, true);
 }

src/types.h

@@ -55,6 +55,7 @@ typedef struct Parameters {
   unsigned int internal_size;
   bool load_state;
   bool save_state;
+  bool auto_save;
   bool midi_reconnect;
   bool trace_midi;
   bool trace_fps;
@@ -279,6 +280,7 @@ typedef struct StateBackgroundWriteArgs {
   Context *context;
   StateConfig state_config;
   MidiDevice *midi;
+  bool auto_save;
 } StateBackgroundWriteArgs;
 
 // timer.c