Supports automatic detection of monitor refresh rate (#4403)

Implements #4393

Author: hzzdev

config/keeperfx.cfg

@@ -59,9 +59,11 @@ DELTA_TIME=ON
 ; Run the game faster or slower than it is meant to be played. Default value is 20.
 TURNS_PER_SECOND=20
 
-; The maximum frame rate for drawing. Default value is 0.
+; The maximum frame rate for drawing. Default value is "AUTO 0".
+; Config format is "<main> [secondary]". secondary is optional, only used when main is set to AUTO and detection fails.
+; AUTO = auto detect monitor’s refresh rate.
 ; 0 = unlimited (uses 100% of one CPU core). Suggested value: your monitor’s refresh rate.
-FRAMES_PER_SECOND=0
+FRAMES_PER_SECOND=AUTO 0
 
 ; The maximum distance you can zoom out the camera [0 - 100].
 ; A value of 0 is equal to the original game's max distance.

src/bflib_inputctrl.cpp

@@ -355,6 +355,7 @@ static void process_event(const SDL_Event *ev)
                 {
                     mute_audio(false);
                 }
+                redetect_screen_refresh_rate_for_draw();
                 break;
             }
             case SDL_WINDOWEVENT_FOCUS_LOST:
@@ -387,6 +388,11 @@ static void process_event(const SDL_Event *ev)
                 isMouseActive = false;
                 break;
             }
+            case SDL_WINDOWEVENT_MOVED:
+            {
+                redetect_screen_refresh_rate_for_draw();
+                break;
+            }
             default: break;
         }
         /* else if (ev->window.event == SDL_WINDOWEVENT_SIZE_CHANGED) {

src/bflib_video.c

@@ -26,6 +26,8 @@
 #include "bflib_sprfnt.h"
 #include "bflib_vidsurface.h"
 
+#include "keeperfx.hpp"
+
 #include <SDL2/SDL.h>
 #include <SDL2/SDL_syswm.h>
 #include <math.h>
@@ -644,6 +646,9 @@ TbResult LbScreenSetup(TbScreenMode mode, TbScreenCoord width, TbScreenCoord hei
     }
 
     reset_bflib_render();
+
+    redetect_screen_refresh_rate_for_draw();
+
     SYNCDBG(8,"Finished");
     return Lb_SUCCESS;
 }

src/config_keeperfx.c

@@ -876,19 +876,11 @@ static void load_file_configuration(const char *fname, const char *sname, const
           }
           break;
       case 39: // FRAMES_PER_SECOND
-          if (get_conf_parameter_single(buf, &pos, len, word_buf, sizeof(word_buf)) > 0)
-          {
-              i = atoi(word_buf);
-          }
-          if ((i >= 0) && (i <= INT32_MAX))
+          if (!start_params.overrides[Clo_FramesPerSecond] && get_conf_parameter_whole(buf, &pos, len, word_buf, sizeof(word_buf)) > 0)
           {
-              if (!start_params.overrides[Clo_FramesPerSecond])
-              {
-                  start_params.num_fps_draw = i;
-              }
-          }
-          else {
-              CONFWRNLOG("Couldn't recognize \"%s\" command parameter in %s file.", COMMAND_TEXT(cmd_num), config_textname);
+              i = parse_draw_fps_config_val(word_buf, &start_params.num_fps_draw_main, &start_params.num_fps_draw_secondary);
+              if (i <= 0)
+                  CONFWRNLOG("Couldn't recognize \"%s\" command parameter in %s file.", COMMAND_TEXT(cmd_num), config_textname);
           }
           break;
       case 40: // TAG_MODE_TOGGLING
@@ -1069,4 +1061,54 @@ void process_cmdline_overrides(void)
   }
 }
 
+int parse_draw_fps_config_val(const char *arg, long *fps_draw_main, long *fps_draw_secondary)
+{
+  int cnt = 0, val1 = 0, val2 = 0;
+  long len = strlen(arg);
+  int32_t pos = 0;
+  char word_buf[32];
+  for (int i=0; i<2; i++)
+  {
+    if (get_conf_parameter_single(arg,&pos,len,word_buf,sizeof(word_buf)) <= 0)
+      break;
+
+    switch (i)
+    {
+    case 0:
+      if (strcasecmp(word_buf, "auto") == 0) {
+        val1=-1;
+        cnt++;
+      } else {
+        val1 = atoi(word_buf);
+        if (val1 >= 0){
+          cnt++;
+        } else {
+          i=2; // jump out for loop
+          break;
+        }
+      }
+      break;
+    case 1:
+        val2 = atoi(word_buf);
+        if (val2 >= 0){
+          cnt++;
+        } else {
+          i=2; // jump out for loop
+          break;
+        }
+      break;
+    }
+  }
+
+  if (cnt > 0) {
+    *fps_draw_main = val1;
+  }
+  if (cnt > 1) {
+    *fps_draw_secondary = val2;
+  }
+
+  return cnt;
+}
+
+
 /******************************************************************************/

src/config_keeperfx.h

@@ -126,6 +126,7 @@ extern TbBool IMPRISON_BUTTON_DEFAULT;
 void load_configuration_for_mod_all(void);
 short load_configuration(void);
 void process_cmdline_overrides(void);
+int parse_draw_fps_config_val(const char *arg, long *fps_draw_main, long *fps_draw_secondary);
 /******************************************************************************/
 TbBool is_feature_on(unsigned long feature);
 void set_skip_heart_zoom_feature(TbBool enable);

src/console_cmd.c

@@ -25,6 +25,7 @@
 #include "bflib_sound.h"
 #include "bflib_sndlib.h"
 #include "config.h"
+#include "config_keeperfx.h"
 #include "config_campaigns.h"
 #include "config_effects.h"
 #include "config_magic.h"
@@ -290,7 +291,7 @@ static TbBool cmd_magic_instance(PlayerNumber plyr_idx, char * args)
 
 TbBool cmd_stats(PlayerNumber plyr_idx, char * args)
 {
-    targeted_message_add(MsgType_Player, plyr_idx, plyr_idx, GUI_MESSAGES_DELAY, "turn fps is %ld, draw fps is %ld", game_num_fps, game_num_fps_draw);
+    targeted_message_add(MsgType_Player, plyr_idx, plyr_idx, GUI_MESSAGES_DELAY, "turn fps is %ld, draw fps is %ld", game_num_fps, game_num_fps_draw_current);
     return true;
 }
 
@@ -308,13 +309,8 @@ TbBool cmd_fps_turn(PlayerNumber plyr_idx, char * args)
 
 TbBool cmd_fps_draw(PlayerNumber plyr_idx, char * args)
 {
-    char * pr2str = strsep(&args, " ");
-    if (pr2str == NULL) {
-        game_num_fps_draw = start_params.num_fps_draw;
-        targeted_message_add(MsgType_Player, plyr_idx, plyr_idx, GUI_MESSAGES_DELAY, "Drawrate is %ld fps", game_num_fps_draw);
-    } else {
-        game_num_fps_draw = atoi(pr2str);
-    }
+    parse_draw_fps_config_val(args, &game_num_fps_draw_main, &game_num_fps_draw_secondary);
+    redetect_screen_refresh_rate_for_draw();
     return true;
 }
 

src/game_legacy.h

@@ -382,7 +382,11 @@ struct Game {
 /******************************************************************************/
 extern struct Game game;
 extern long game_num_fps;
-extern long game_num_fps_draw;
+
+extern long game_num_fps_draw_current;
+extern long game_num_fps_draw_main;
+extern long game_num_fps_draw_secondary;
+
 /******************************************************************************/
 #ifdef __cplusplus
 }

src/keeperfx.hpp

@@ -131,7 +131,8 @@ struct StartupParameters {
     unsigned char debug_flags;
     unsigned short computer_chat_flags;
     long num_fps;
-    long num_fps_draw;
+    long num_fps_draw_main; // -1 if auto
+    long num_fps_draw_secondary;
     TbBool packet_save_enable;
     TbBool packet_load_enable;
     char packet_fname[150];
@@ -298,11 +299,13 @@ long get_foot_creature_has_down(struct Thing *thing);
 void process_keeper_spell_aura(struct Thing *thing);
 void init_seeds();
 
+
 TbPixel get_player_path_colour(unsigned short owner);
 
 void startup_saved_packet_game(void);
 void faststartup_saved_packet_game(void);
 void reinit_level_after_load(void);
+void redetect_screen_refresh_rate_for_draw();
 void update_time(void);
 extern TbClockMSec timerstarttime;
 struct TimerTime {

src/main.cpp

@@ -145,7 +145,11 @@ struct StartupParameters start_params;
 char autostart_multiplayer_campaign[80] = "";
 int autostart_multiplayer_level = 0;
 long game_num_fps;
-long game_num_fps_draw = 0;
+
+long game_num_fps_draw_current = 0;
+long game_num_fps_draw_main = 0; // -1 if auto
+long game_num_fps_draw_secondary = 0;
+
 
 unsigned char *blue_palette;
 unsigned char *red_palette;
@@ -1122,6 +1126,7 @@ short setup_game(void)
   }
 
   game.frame_skip = start_params.frame_skip;
+  redetect_screen_refresh_rate_for_draw();
 
   // Intro problems shouldn't force the game to quit,
   // so we're re-setting the result flag
@@ -3327,10 +3332,10 @@ TbBool keeper_wait_for_next_turn(void)
 TbBool keeper_wait_for_next_draw(void)
 {
     // fps.draw is currently unable to work properly with frame_skip
-    if (game_num_fps_draw > 0 && is_feature_on(Ft_DeltaTime) == true && game.frame_skip == 0)
+    if (game_num_fps_draw_current > 0 && is_feature_on(Ft_DeltaTime) == true && game.frame_skip == 0)
     {
         const long double tick_ns_one_sec = 1000000000.0;
-        const long double tick_ns_one_frame = tick_ns_one_sec/game_num_fps_draw;
+        const long double tick_ns_one_frame = tick_ns_one_sec/game_num_fps_draw_current;
 
         static long double tick_ns_last_draw = 0;
         long double tick_ns_cur = get_time_tick_ns();
@@ -3350,6 +3355,29 @@ TbBool keeper_wait_for_next_draw(void)
     return false;
 }
 
+void redetect_screen_refresh_rate_for_draw()
+{
+    game_num_fps_draw_current = 0;
+
+    if (game_num_fps_draw_main == -1) {
+        if (game_num_fps_draw_secondary > 0)
+            game_num_fps_draw_current = game_num_fps_draw_secondary;
+
+        if (lbWindow != NULL) {
+            int display_index = SDL_GetWindowDisplayIndex(lbWindow);
+            if (display_index >= 0) {
+                SDL_DisplayMode mode;
+                if (SDL_GetCurrentDisplayMode(display_index, &mode) == 0 && mode.refresh_rate > 0) {
+                    game_num_fps_draw_current = mode.refresh_rate;
+                }
+            }
+        }
+
+    } else if (game_num_fps_draw_main > 0) {
+        game_num_fps_draw_current = game_num_fps_draw_main;
+    }
+}
+
 TbBool keeper_wait_for_screen_focus(void)
 {
     do {
@@ -3492,7 +3520,7 @@ void gameplay_loop_timestep()
         exit_keeper = 1;
     }
 
-    if (game_num_fps_draw > 0 && is_feature_on(Ft_DeltaTime) == true) {
+    if (game_num_fps_draw_current > 0 && is_feature_on(Ft_DeltaTime) == true) {
         keeper_wait_for_next_draw();
 
         if (game.turns_packetoff == game.play_gameturn) {
@@ -4058,8 +4086,8 @@ short process_command_line(unsigned short argc, char *argv[])
       if (strcasecmp(parstr, "fps_draw") == 0)
       {
           narg++;
-          start_params.num_fps_draw = atoi(pr2str);
-          start_params.overrides[Clo_FramesPerSecond] = true;
+	  if (parse_draw_fps_config_val(pr2str, &start_params.num_fps_draw_main, &start_params.num_fps_draw_secondary) > 0)
+            start_params.overrides[Clo_FramesPerSecond] = true;
       } else
       if (strcasecmp(parstr, "human") == 0)
       {

src/main_game.c

@@ -467,7 +467,9 @@ void clear_complete_game(void)
     else
         set_selected_level_number(first_singleplayer_level());
     game_num_fps = start_params.num_fps;
-    game_num_fps_draw = start_params.num_fps_draw;
+    game_num_fps_draw_current = 0;
+    game_num_fps_draw_main = start_params.num_fps_draw_main;
+    game_num_fps_draw_secondary = start_params.num_fps_draw_secondary;
     game.mode_flags = start_params.mode_flags;
     game.easter_eggs_enabled = start_params.easter_egg;
     set_flag_value(game.system_flags, GSF_AllowOnePlayer, start_params.one_player);