iidx: show error message for emulated I/O mismatch in LDJ/TDJ sub overlay (#555)

## Link to GitHub Issue, if one exists
#345 

## Description of change
When DLL is configured to use TDJ I/O but spice is in LDJ mode, show an
error in LED ticker suggesting the user to turn on `-iidxtdj`.

When DLL is configured to use LDJ I/O but spice is in TDJ mode, show an
error in TDJ overaly suggesting the user to fix the DLL.

Fix a small bug that caused a white window to be created when `-w` is
enabled even when `-iidxtdj` is not, but DLL is using TDJ I/O.

src/spice2x/games/iidx/iidx.cpp

@@ -82,6 +82,7 @@ namespace games::iidx {
     bool IIDXIO_LED_TICKER_READONLY = false;
     std::mutex IIDX_LED_TICKER_LOCK;
     bool IIDX_TDJ_MONITOR_WARNING = false;
+    iidx_aio_emulation_state CURRENT_IO_EMULATION_STATE = iidx_aio_emulation_state::unknown;
 
     // io
     static bool HAS_LIBAIO; // this is how we detect iidx27+
@@ -453,7 +454,7 @@ namespace games::iidx {
         }
 
         // windowed subscreen, enabled by default, unless turned off by user
-        if (GRAPHICS_WINDOWED && !options->at(launcher::Options::spice2x_IIDXNoSub).value_bool()) {
+        if (GRAPHICS_WINDOWED && !options->at(launcher::Options::spice2x_IIDXNoSub).value_bool() && TDJ_MODE) {
             GRAPHICS_IIDX_WSUB = true;
         }
 
@@ -934,6 +935,8 @@ namespace games::iidx {
             return;
         }
 
+        CURRENT_IO_EMULATION_STATE = state;
+
         // log_warning below could be turned into log_fatal in the future once we gain confidence
         // that this isn't triggering when it's not supposed to
         if (state == iidx_aio_emulation_state::bi2a_com2 && TDJ_MODE) {

src/spice2x/games/iidx/iidx.h

@@ -11,6 +11,12 @@
 
 namespace games::iidx {
 
+    enum class iidx_aio_emulation_state {
+        unknown,
+        bi2a_com2,
+        bi2x_hook
+    };
+
     // settings
 
     extern bool FLIP_CAMS;
@@ -38,6 +44,7 @@ namespace games::iidx {
     constexpr int IIDX_TAPELED_TOTAL = 17;
     // data mapping
     extern tapeledutils::tape_led TAPELED_MAPPING[IIDX_TAPELED_TOTAL];
+    extern iidx_aio_emulation_state CURRENT_IO_EMULATION_STATE;
 
     class IIDXGame : public games::Game {
     public:
@@ -64,9 +71,5 @@ namespace games::iidx {
     bool is_tdj_fhd();
     void apply_audio_hacks();
 
-    enum class iidx_aio_emulation_state {
-        bi2a_com2,
-        bi2x_hook
-    };
     void update_io_emulation_state(iidx_aio_emulation_state state);
 }

src/spice2x/hooks/graphics/backends/d3d9/d3d9_backend.cpp

@@ -945,26 +945,37 @@ HRESULT STDMETHODCALLTYPE WrappedIDirect3D9::CreateDeviceEx(
 
     for (size_t i = 0; i < num_adapters; i++) {
         auto *params = &pPresentationParameters[i];
-        if (!GRAPHICS_WINDOWED && i == 0) {
-            GRAPHICS_FS_ORIGINAL_WIDTH = params->BackBufferWidth;
-            GRAPHICS_FS_ORIGINAL_HEIGHT = params->BackBufferHeight;
-            log_misc("graphics::d3d9", "original resolution: {}x{}", GRAPHICS_FS_ORIGINAL_WIDTH, GRAPHICS_FS_ORIGINAL_HEIGHT);
-            if (GRAPHICS_FS_CUSTOM_RESOLUTION.has_value()) {
+        if (!GRAPHICS_WINDOWED){
+            if (i == 0) {
+                GRAPHICS_FS_ORIGINAL_WIDTH = params->BackBufferWidth;
+                GRAPHICS_FS_ORIGINAL_HEIGHT = params->BackBufferHeight;
+                log_misc("graphics::d3d9", "original resolution: {}x{}", GRAPHICS_FS_ORIGINAL_WIDTH, GRAPHICS_FS_ORIGINAL_HEIGHT);
+                if (GRAPHICS_FS_CUSTOM_RESOLUTION.has_value()) {
+                    log_misc(
+                        "graphics::d3d9",
+                        "use custom resolution {}x{} => {}x{}",
+                        params->BackBufferWidth, params->BackBufferHeight,
+                        GRAPHICS_FS_CUSTOM_RESOLUTION.value().first,
+                        GRAPHICS_FS_CUSTOM_RESOLUTION.value().second);
+                    params->BackBufferWidth = GRAPHICS_FS_CUSTOM_RESOLUTION.value().first;
+                    params->BackBufferHeight = GRAPHICS_FS_CUSTOM_RESOLUTION.value().second;
+                } else if (GRAPHICS_FS_ORIENTATION_SWAP) {
+                    log_misc(
+                        "graphics::d3d9",
+                        "swap full orientation {}x{} => {}x{}",
+                        params->BackBufferWidth, params->BackBufferHeight,
+                        params->BackBufferHeight, params->BackBufferWidth);
+                    std::swap(params->BackBufferWidth, params->BackBufferHeight);
+                }
+            } else if (i == 1 && GRAPHICS_FS_CUSTOM_RESOLUTION_SUB.has_value()) {
                 log_misc(
                     "graphics::d3d9",
-                    "use custom resolution {}x{} => {}x{}",
+                    "use custom sub resolution {}x{} => {}x{}",
                     params->BackBufferWidth, params->BackBufferHeight,
-                    GRAPHICS_FS_CUSTOM_RESOLUTION.value().first,
-                    GRAPHICS_FS_CUSTOM_RESOLUTION.value().second);
-                params->BackBufferWidth = GRAPHICS_FS_CUSTOM_RESOLUTION.value().first;
-                params->BackBufferHeight = GRAPHICS_FS_CUSTOM_RESOLUTION.value().second;
-            } else if (GRAPHICS_FS_ORIENTATION_SWAP) {
-                log_misc(
-                    "graphics::d3d9",
-                    "swap full orientation {}x{} => {}x{}",
-                    params->BackBufferWidth, params->BackBufferHeight,
-                    params->BackBufferHeight, params->BackBufferWidth);
-                std::swap(params->BackBufferWidth, params->BackBufferHeight);
+                    GRAPHICS_FS_CUSTOM_RESOLUTION_SUB.value().first,
+                    GRAPHICS_FS_CUSTOM_RESOLUTION_SUB.value().second);
+                params->BackBufferWidth = GRAPHICS_FS_CUSTOM_RESOLUTION_SUB.value().first;
+                params->BackBufferHeight = GRAPHICS_FS_CUSTOM_RESOLUTION_SUB.value().second;
             }
         }
 
@@ -992,12 +1003,17 @@ HRESULT STDMETHODCALLTYPE WrappedIDirect3D9::CreateDeviceEx(
         for (size_t i = 0; i < num_adapters; i++) {
             auto *fullscreen_display_mode = &pFullscreenDisplayMode[i];
 
-            if (!GRAPHICS_WINDOWED && i == 0) {
-                if (GRAPHICS_FS_CUSTOM_RESOLUTION.has_value()) {
-                    fullscreen_display_mode->Width = GRAPHICS_FS_CUSTOM_RESOLUTION.value().first;
-                    fullscreen_display_mode->Height = GRAPHICS_FS_CUSTOM_RESOLUTION.value().second;
-                } else if (GRAPHICS_FS_ORIENTATION_SWAP) {
-                    std::swap(fullscreen_display_mode->Width, fullscreen_display_mode->Height);
+            if (!GRAPHICS_WINDOWED) {
+                if (i == 0) {
+                    if (GRAPHICS_FS_CUSTOM_RESOLUTION.has_value()) {
+                        fullscreen_display_mode->Width = GRAPHICS_FS_CUSTOM_RESOLUTION.value().first;
+                        fullscreen_display_mode->Height = GRAPHICS_FS_CUSTOM_RESOLUTION.value().second;
+                    } else if (GRAPHICS_FS_ORIENTATION_SWAP) {
+                        std::swap(fullscreen_display_mode->Width, fullscreen_display_mode->Height);
+                    }
+                } else if (i == 1 && GRAPHICS_FS_CUSTOM_RESOLUTION_SUB.has_value()) {
+                    fullscreen_display_mode->Width = GRAPHICS_FS_CUSTOM_RESOLUTION_SUB.value().first;
+                    fullscreen_display_mode->Height = GRAPHICS_FS_CUSTOM_RESOLUTION_SUB.value().second;
                 }
             }
 

src/spice2x/hooks/graphics/graphics.cpp

@@ -71,6 +71,7 @@ bool GRAPHICS_9_ON_12_REQUESTED_BY_GAME = false;
 bool SUBSCREEN_FORCE_REDRAW = false;
 bool D3D9_DEVICE_HOOK_DISABLE = false;
 std::optional<std::pair<uint32_t, uint32_t>> GRAPHICS_FS_CUSTOM_RESOLUTION;
+std::optional<std::pair<uint32_t, uint32_t>> GRAPHICS_FS_CUSTOM_RESOLUTION_SUB;
 bool GRAPHICS_FS_ORIENTATION_SWAP = false;
 uint32_t GRAPHICS_FS_ORIGINAL_WIDTH = 0;
 uint32_t GRAPHICS_FS_ORIGINAL_HEIGHT = 0;

src/spice2x/hooks/graphics/graphics.h

@@ -37,6 +37,7 @@ extern std::optional<int> GRAPHICS_FORCE_VSYNC_BUFFER;
 extern bool GRAPHICS_FORCE_SINGLE_ADAPTER;
 extern bool GRAPHICS_PREVENT_SECONDARY_WINDOW;
 extern std::optional<std::pair<uint32_t, uint32_t>> GRAPHICS_FS_CUSTOM_RESOLUTION;
+extern std::optional<std::pair<uint32_t, uint32_t>> GRAPHICS_FS_CUSTOM_RESOLUTION_SUB;
 extern bool GRAPHICS_FS_ORIENTATION_SWAP;
 extern uint32_t GRAPHICS_FS_ORIGINAL_WIDTH;
 extern uint32_t GRAPHICS_FS_ORIGINAL_HEIGHT;

src/spice2x/hooks/graphics/graphics_windowed.cpp

@@ -173,7 +173,7 @@ void graphics_load_windowed_parameters() {
             cfg::SCREENRESIZE->window_offset_x = result.first;
             cfg::SCREENRESIZE->window_offset_y = result.second;
         } else {
-            log_warning("graphics-windowed", "failed to parse -windowpos");
+            log_fatal("graphics-windowed", "failed to parse -windowpos");
         }
     }
 
@@ -202,7 +202,7 @@ void graphics_load_windowed_subscreen_parameters() {
             GRAPHICS_WSUB_WIDTH = result.first;
             GRAPHICS_WSUB_HEIGHT = result.second;
         } else {
-            log_warning("graphics-windowed", "failed to parse -wsubsize");
+            log_fatal("graphics-windowed", "failed to parse -iidxwsubsize / -sdvxwsubsize");
         }
     }
 
@@ -216,7 +216,7 @@ void graphics_load_windowed_subscreen_parameters() {
             GRAPHICS_WSUB_X = result.first;
             GRAPHICS_WSUB_Y = result.second;
         } else {
-            log_warning("graphics-windowed", "failed to parse -wsubpos");
+            log_fatal("graphics-windowed", "failed to parse -iidxwsubpos / -sdvxwsubpos");
         }
     }
 }

src/spice2x/launcher/launcher.cpp

@@ -1083,8 +1083,8 @@ int main_implementation(int argc, char *argv[]) {
         std::pair<uint32_t, uint32_t> result;
         if (parse_width_height(options[launcher::Options::spice2x_WindowSize].value_text(), result)) {
             GRAPHICS_WINDOW_SIZE = result;
-        } else {
-            log_warning("launcher", "failed to parse -windowsize");
+        } else if (!cfg_run && !cfg::CONFIGURATOR_STANDALONE) {
+            log_fatal("launcher", "failed to parse -windowsize");
         }
     }
     if (options[launcher::Options::spice2x_WindowPosition].is_active()) {
@@ -1401,8 +1401,17 @@ int main_implementation(int argc, char *argv[]) {
         std::pair<uint32_t, uint32_t> result;
         if (parse_width_height(options[launcher::Options::FullscreenResolution].value_text(), result)) {
             GRAPHICS_FS_CUSTOM_RESOLUTION = result;
-        } else {
-            log_warning("launcher", "failed to parse -forceres");
+        } else if (!cfg_run && !cfg::CONFIGURATOR_STANDALONE) {
+            log_fatal("launcher", "failed to parse -forceres");
+        }
+    }
+
+    if (options[launcher::Options::FullscreenSubResolution].is_active()) {
+        std::pair<uint32_t, uint32_t> result;
+        if (parse_width_height(options[launcher::Options::FullscreenSubResolution].value_text(), result)) {
+            GRAPHICS_FS_CUSTOM_RESOLUTION_SUB = result;
+        } else if (!cfg_run && !cfg::CONFIGURATOR_STANDALONE) {
+            log_fatal("launcher", "failed to parse -forceressub");
         }
     }
 

src/spice2x/launcher/options.cpp

@@ -256,9 +256,21 @@ static const std::vector<OptionDefinition> OPTION_DEFINITIONS = {
         .hidden = true,
         .category = "Graphics (Full Screen)"
     },
+    {
+        // FullscreenSubResolution
+        .title = "Force FS Subscreen Resolution (EXPERIMENTAL)",
+        .name = "forceressub",
+        .desc =
+            "Override fullscreen resolution requested by the game for second monitor, "
+            "useful if you have a sub monitor that is not quite exactly what the game expects.\n\n"
+            "WARNING: experimental as we have not done extensive testing to see if this causes desyncs.",
+        .type = OptionType::Text,
+        .setting_name = "1280,720",
+        .category = "Graphics (Full Screen)"
+    },
     {
         // FullscreenSubRefreshRate
-        .title = "Force Submonitor Refresh Rate (EXPERIMENTAL)",
+        .title = "Force FS Subscreen Refresh Rate (EXPERIMENTAL)",
         .name = "graphics-force-refresh-sub",
         .desc =
             "Override fullscreen refresh rate requested by the game for second monitor, "
@@ -814,7 +826,7 @@ static const std::vector<OptionDefinition> OPTION_DEFINITIONS = {
         .category = "Game Options",
     },
     {
-        .title = "SDVX Native Touch Handling",
+        .title = "SDVX FS Subscreen Native Touch Handling",
         .name = "sdvxnativetouch",
         .desc = "Disables touch hooks and lets the game access a touch screen directly. "
                 "Requires a touch screen to be connected as a secondary monitor. "
@@ -824,6 +836,18 @@ static const std::vector<OptionDefinition> OPTION_DEFINITIONS = {
         .game_name = "Sound Voltex",
         .category = "Game Options (Advanced)",
     },
+    {
+        // spice2x_SDVXSubRedraw
+        .title = "SDVX FS Subscreen Force Redraw",
+        .name = "sp2x-sdvxsubredraw",
+        .display_name = "sdvxsubredraw",
+        .aliases= "sdvxsubredraw",
+        .desc = "Check if submonitor in fullscreen mode doesn't update every frame; "
+            "this option forces subscreen to redraw every frame.",
+        .type = OptionType::Bool,
+        .game_name = "Sound Voltex",
+        .category = "Game Options (Advanced)",
+    },
     {
         // spice2x_SDVXDigitalKnobSensitivity
         .title = "SDVX Digital Knob Sensitivity",
@@ -884,18 +908,6 @@ static const std::vector<OptionDefinition> OPTION_DEFINITIONS = {
             {"bottomright", "for landscape"},
         },
     },
-    {
-        // spice2x_SDVXSubRedraw
-        .title = "SDVX Subscreen Force Redraw",
-        .name = "sp2x-sdvxsubredraw",
-        .display_name = "sdvxsubredraw",
-        .aliases= "sdvxsubredraw",
-        .desc = "Check if second monitor for subscreen doesn't update every frame; "
-            "forces subscreen to redraw every frame, only needed for newer EG.",
-        .type = OptionType::Bool,
-        .game_name = "Sound Voltex",
-        .category = "Game Options (Advanced)",
-    },
     {
         .title = "Force Load DDR Module",
         .name = "ddr",
@@ -2251,7 +2263,7 @@ static const std::vector<OptionDefinition> OPTION_DEFINITIONS = {
     },
     {
         // spice2x_IIDXNativeTouch
-        .title = "IIDX Native Touch Handling",
+        .title = "IIDX TDJ Subscreen Native Touch Handling",
         .name = "sp2x-iidxnativetouch",
         .display_name = "iidxnativetouch",
         .aliases= "iidxnativetouch",

src/spice2x/launcher/options.h

@@ -31,6 +31,7 @@ namespace launcher {
             GraphicsForceRefresh,
             FullscreenResolution,
             FullscreenOrientationFlip,
+            FullscreenSubResolution,
             FullscreenSubRefreshRate,
             Graphics9On12,
             spice2x_Dx9On12,
@@ -85,11 +86,11 @@ namespace launcher {
             SDVXPrinterJPGQuality,
             SDVXDisableCameras,
             SDVXNativeTouch,
+            spice2x_SDVXSubRedraw,
             spice2x_SDVXDigitalKnobSensitivity,
             SDVXDigitalKnobSocd,
             spice2x_SDVXAsioDriver,
             spice2x_SDVXSubPos,
-            spice2x_SDVXSubRedraw,
             LoadDDRModule,
             DDR43Mode,
             DDRSkipCodecRegisteration,

src/spice2x/overlay/windows/generic_sub.cpp

@@ -85,10 +85,12 @@ namespace overlay::windows {
     }
 
     void GenericSubScreen::touch_transform(const ImVec2 xy_in, LONG *x_out, LONG *y_out) {}
+    void GenericSubScreen::check_for_errors() {}
 
     void GenericSubScreen::build_content() {
         this->flags |= ImGuiWindowFlags_NoBackground;
         
+        check_for_errors();
         if (this->disabled_message.has_value()) {
             this->draws_window = true;
             this->flags &= ~ImGuiWindowFlags_NoBackground;

src/spice2x/overlay/windows/generic_sub.h

@@ -31,6 +31,7 @@ namespace overlay::windows {
 
     protected:
         virtual void touch_transform(const ImVec2 xy_in, LONG *x_out, LONG *y_out);
+        virtual void check_for_errors();
         ImVec2 overlay_content_top_left;
         ImVec2 overlay_content_size;
         std::optional<std::string> disabled_message = std::nullopt;

src/spice2x/overlay/windows/iidx_seg.cpp

@@ -14,6 +14,7 @@ namespace overlay::windows {
 
     static const size_t TICKER_SIZE = 9;
     static const ImVec4 DARK_GRAY(0.1f, 0.1f, 0.1f, 1.f);
+    static const ImVec4 YELLOW(1.f, 1.f, 0.f, 1.f);
     static const ImVec4 RED(1.f, 0.f, 0.f, 1.f);
     static const float PADDING_Y = 8.f;
     static const float PADDING_X = 4.f;
@@ -91,6 +92,23 @@ namespace overlay::windows {
     }
 
     void IIDXSegmentDisplay::build_content() {
+
+        // explicitly check if TDJ I/O is enabled to account for the fact that I/O emulation may be
+        // disabled
+        if (games::iidx::CURRENT_IO_EMULATION_STATE == games::iidx::iidx_aio_emulation_state::bi2x_hook) {
+            ImGui::TextUnformatted("");
+            ImGui::TextColored(
+                YELLOW,
+                "%s",
+                "Invalid I/O mode; DLL is configured for TDJ I/O!\n"
+                "Enable -iidxtdj if you want TDJ subscreen overlay.");
+            ImGui::TextUnformatted("");
+            if (ImGui::Button("Close")) {
+                this->set_active(false);
+            }
+            return;
+        }
+
         char input_ticker[TICKER_SIZE];
 
         // get ticker content from game

src/spice2x/overlay/windows/iidx_sub.cpp

@@ -12,11 +12,9 @@ namespace overlay::windows {
         this->title = "IIDX TDJ Subscreen";
 
         if (GRAPHICS_IIDX_WSUB) {
-            this->disabled_message =
-                "Close this overlay and use the second window.\n"
-                "If you don't see the window, double check your DLL type and apply TDJ I/O patches as needed.";
+            this->disabled_message = "Close this overlay and use the second window. (try ALT+TAB)";
         } else if (games::iidx::IIDX_TDJ_MONITOR_WARNING) {
-            this->disabled_message = "TDJ mode subscreen overlay is not compatible with -monitor option";
+            this->disabled_message = "TDJ mode subscreen overlay is not compatible with -monitor option.";
         }
 
         float size = 0.5f;
@@ -44,6 +42,18 @@ namespace overlay::windows {
             ImGui::GetIO().DisplaySize.y - this->init_size.y - (ImGui::GetFrameHeight() / 2));
     }
 
+    void IIDXSubScreen::check_for_errors() {
+        if (games::iidx::CURRENT_IO_EMULATION_STATE ==
+            games::iidx::iidx_aio_emulation_state::bi2a_com2) {
+
+            // explicitly check if LDJ I/O is enabled (as opposed to checking if NOT TDJ I/O)
+            // to account for the fact that I/O emulation may be disabled
+            this->disabled_message =
+                "LDJ I/O detected; TDJ mode subscreen overlay requires TDJ I/O.\n"
+                "Ensure you apply applicable TDJ I/O patches, or run with TDJ DLL.";
+        }
+    }
+
     void IIDXSubScreen::touch_transform(const ImVec2 xy_in, LONG *x_out, LONG *y_out) {
         if (!this->get_active()) {
             return;

src/spice2x/overlay/windows/iidx_sub.h

@@ -12,6 +12,7 @@ namespace overlay::windows {
 
     protected:
         void touch_transform(const ImVec2 xy_in, LONG *x_out, LONG *y_out) override;
+        void check_for_errors() override;
     };
 }
 

src/spice2x/overlay/windows/keypad.cpp

@@ -120,7 +120,7 @@ namespace overlay::windows {
             "Lightning Model cabinets (TDJ) do not have any keypads; they use the subscreen.\n\n"
             "Fullscreen mode: bind a key in Overlay tab, and press it in game to show the subscreen, "
             "then use your mouse to click. Page Up button is the default binding.\n\n"
-            "Windowed mode: look for the second window in the taskbar.\n\n"
+            "Windowed mode: look for the second window in the taskbar (or ALT+TAB).\n\n"
             "Windowed mode with -iidxnosub: bring up the subscreen overlay (default Page Up).\n\n"
             );
 

src/spice2x/overlay/windows/sdvx_sub.cpp

@@ -18,7 +18,7 @@ namespace overlay::windows {
             if (GRAPHICS_PREVENT_SECONDARY_WINDOW) {
                 this->disabled_message = "Subscreen has been disabled by the user (-sdvxnosub).";
             } else {
-                this->disabled_message = "Overlay unavailable in windowed mode! Use the second window instead.";
+                this->disabled_message = "Overlay unavailable in windowed mode! Use the second window instead. (ALT+TAB)";
             }
         }