Adjust letterbox effects for wide screens

Fixes #195

Author: rafalh

docs/CHANGELOG.md

@@ -21,6 +21,7 @@ Version 1.8.1 (not released yet)
 - Fix crash reporter URL
 - Fix buffer-overflow when importing mesh with more than 8000 faces in the editor
 - Fix various issues when server switches to a new level before player finishes downloading the previous one
+- Adjust letterbox effects in cutscenes and after death for wide screens
 
 Version 1.8.0 (released 2022-09-17)
 -----------------------------------

game_patch/misc/game.cpp

@@ -11,6 +11,7 @@
 #include "../rf/ui.h"
 #include "../rf/gameseq.h"
 #include "../rf/level.h"
+#include "../rf/cutscene.h"
 #include "../multi/multi.h"
 
 static std::unique_ptr<byte* []> g_screenshot_scanlines_buf;
@@ -163,6 +164,26 @@ static FunHook<void(rf::GameState, bool)> rf_do_state_hook{
     },
 };
 
+int letterbox_clip_height()
+{
+    // return std::min(9 * rf::gr::screen_width() / 16, rf::gr::screen_height() * 91 / 100);
+    return rf::gr::screen_height() * 3 / 4;
+}
+
+CodeInjection gameplay_render_frame_cutscene_letterbox_injection{
+    0x00431B30,
+    [](auto& regs) {
+        regs.esi = letterbox_clip_height();
+    },
+};
+
+CodeInjection gameplay_render_frame_death_letterbox_injection{
+    0x00432A82,
+    [](auto& regs) {
+        regs.edi = letterbox_clip_height();
+    },
+};
+
 void game_apply_patch()
 {
     // Override screenshot filename and directory
@@ -181,6 +202,10 @@ void game_apply_patch()
     // States support
     rf_do_state_hook.install();
 
+    // Adjust letterbox effects for wide screens
+    gameplay_render_frame_cutscene_letterbox_injection.install();
+    gameplay_render_frame_death_letterbox_injection.install();
+
     // Commands
     screenshot_cmd.register_cmd();
 }

game_patch/object/cutscene.cpp

@@ -64,7 +64,7 @@ FunHook<void(bool)> cutscene_do_frame_hook{
             xlog::info("Skipping cutscene...");
             disable_sound_before_cutscene_skip();
 
-            while (rf::cutscene_is_active()) {
+            while (rf::cutscene_is_playing()) {
                 int shot_time_left_ms = rf::active_cutscene->next_stage_timestamp.time_until();
 
                 if (rf::active_cutscene->current_script_index == rf::active_cutscene->num_cam_scripts - 1) {

game_patch/object/glare.cpp

@@ -35,7 +35,7 @@ static bool glare_collide_object(rf::Glare* glare, rf::Object* obj, const rf::Ve
     }
 
     rf::Vector3 hit_pt;
-    if (rf::cutscene_is_active() && obj->type == rf::OT_ENTITY) {
+    if (rf::cutscene_is_playing() && obj->type == rf::OT_ENTITY) {
         // Fix glares/coronas being visible through characters during cutscenes
         rf::Vector3 root_bone_pos;
         rf::obj_find_root_bone_pos(static_cast<rf::Entity*>(obj), root_bone_pos);

game_patch/rf/cutscene.h

@@ -44,5 +44,5 @@ namespace rf
 
     static auto& active_cutscene = addr_as_ref<Cutscene*>(0x00645320);
 
-    static auto& cutscene_is_active = addr_as_ref<bool()>(0x0045BE80);
+    static auto& cutscene_is_playing = addr_as_ref<bool()>(0x0045BE80);
 }