cardmaker: hook, touch screen hook added

Thanks @domeori https://dev.s-ul.net/domeori/segatools/-/tree/mr-imports

cmhook/cm-dll.c

@@ -0,0 +1,106 @@
+#include <windows.h>
+
+#include <assert.h>
+#include <stdlib.h>
+
+#include "cmhook/cm-dll.h"
+
+#include "util/dll-bind.h"
+#include "util/dprintf.h"
+
+const struct dll_bind_sym cm_dll_syms[] = {
+    {
+        .sym = "cm_io_init",
+        .off = offsetof(struct cm_dll, init),
+    }, {
+        .sym = "cm_io_poll",
+        .off = offsetof(struct cm_dll, poll),
+    }, {
+        .sym = "cm_io_get_opbtns",
+        .off = offsetof(struct cm_dll, get_opbtns),
+    }
+};
+
+struct cm_dll cm_dll;
+
+// Copypasta DLL binding and diagnostic message boilerplate.
+// Not much of this lends itself to being easily factored out. Also there
+// will be a lot of API-specific branching code here eventually as new API
+// versions get defined, so even though these functions all look the same
+// now this won't remain the case forever.
+
+HRESULT cm_dll_init(const struct cm_dll_config *cfg, HINSTANCE self)
+{
+    uint16_t (*get_api_version)(void);
+    const struct dll_bind_sym *sym;
+    HINSTANCE owned;
+    HINSTANCE src;
+    HRESULT hr;
+
+    assert(cfg != NULL);
+    assert(self != NULL);
+
+    if (cfg->path[0] != L'\0') {
+        owned = LoadLibraryW(cfg->path);
+
+        if (owned == NULL) {
+            hr = HRESULT_FROM_WIN32(GetLastError());
+            dprintf("CardMaker IO: Failed to load IO DLL: %lx: %S\n",
+                    hr,
+                    cfg->path);
+
+            goto end;
+        }
+
+        dprintf("CardMaker IO: Using custom IO DLL: %S\n", cfg->path);
+        src = owned;
+    } else {
+        owned = NULL;
+        src = self;
+    }
+
+    get_api_version = (void *) GetProcAddress(src, "cm_io_get_api_version");
+
+    if (get_api_version != NULL) {
+        cm_dll.api_version = get_api_version();
+    } else {
+        cm_dll.api_version = 0x0100;
+        dprintf("Custom IO DLL does not expose cm_io_get_api_version, "
+                "assuming API version 1.0.\n"
+                "Please ask the developer to update their DLL.\n");
+    }
+
+    if (cm_dll.api_version >= 0x0200) {
+        hr = E_NOTIMPL;
+        dprintf("CardMaker IO: Custom IO DLL implements an unsupported "
+                "API version (%#04x). Please update Segatools.\n",
+                cm_dll.api_version);
+
+        goto end;
+    }
+
+    sym = cm_dll_syms;
+    hr = dll_bind(&cm_dll, src, &sym, _countof(cm_dll_syms));
+
+    if (FAILED(hr)) {
+        if (src != self) {
+            dprintf("CardMaker IO: Custom IO DLL does not provide function "
+                    "\"%s\". Please contact your IO DLL's developer for "
+                    "further assistance.\n",
+                    sym->sym);
+
+            goto end;
+        } else {
+            dprintf("Internal error: could not reflect \"%s\"\n", sym->sym);
+        }
+    }
+
+    owned = NULL;
+
+end:
+    if (owned != NULL) {
+        FreeLibrary(owned);
+    }
+
+    return hr;
+}

cmhook/cm-dll.h

@@ -0,0 +1,20 @@
+#pragma once
+
+#include <windows.h>
+
+#include "cmio/cmio.h"
+
+struct cm_dll {
+    uint16_t api_version;
+    HRESULT (*init)(void);
+    HRESULT (*poll)(void);
+    void (*get_opbtns)(uint8_t *opbtn);
+};
+
+struct cm_dll_config {
+    wchar_t path[MAX_PATH];
+};
+
+extern struct cm_dll cm_dll;
+
+HRESULT cm_dll_init(const struct cm_dll_config *cfg, HINSTANCE self);

cmhook/cmhook.def

@@ -0,0 +1,17 @@
+LIBRARY cmhook
+
+EXPORTS
+    aime_io_get_api_version
+    aime_io_init
+    aime_io_led_set_color
+    aime_io_nfc_get_aime_id
+    aime_io_nfc_get_felica_id
+    aime_io_nfc_poll
+    amDllVideoClose @2
+    amDllVideoGetVBiosVersion @4
+    amDllVideoOpen @1
+    amDllVideoSetResolution @3
+    cm_io_get_api_version
+    cm_io_get_opbtns
+    cm_io_init
+    cm_io_poll

cmhook/config.c

@@ -0,0 +1,42 @@
+#include <assert.h>
+#include <stddef.h>
+
+#include "board/config.h"
+
+#include "hooklib/config.h"
+#include "hooklib/dvd.h"
+
+#include "cmhook/config.h"
+
+#include "platform/config.h"
+
+void cm_dll_config_load(
+        struct cm_dll_config *cfg,
+        const wchar_t *filename)
+{
+    assert(cfg != NULL);
+    assert(filename != NULL);
+
+    GetPrivateProfileStringW(
+            L"cmio",
+            L"path",
+            L"",
+            cfg->path,
+            _countof(cfg->path),
+            filename);
+}
+
+void cm_hook_config_load(
+        struct cm_hook_config *cfg,
+        const wchar_t *filename)
+{
+    assert(cfg != NULL);
+    assert(filename != NULL);
+
+    platform_config_load(&cfg->platform, filename);
+    aime_config_load(&cfg->aime, filename);
+    dvd_config_load(&cfg->dvd, filename);
+    io4_config_load(&cfg->io4, filename);
+    touch_screen_config_load(&cfg->touch, filename);
+    cm_dll_config_load(&cfg->dll, filename);
+}

cmhook/config.h

@@ -0,0 +1,29 @@
+#pragma once
+
+#include <stddef.h>
+
+#include "board/config.h"
+
+#include "hooklib/dvd.h"
+#include "hooklib/touch.h"
+
+#include "cmhook/cm-dll.h"
+
+#include "platform/config.h"
+
+struct cm_hook_config {
+    struct platform_config platform;
+    struct aime_config aime;
+    struct dvd_config dvd;
+    struct io4_config io4;
+    struct cm_dll_config dll;
+    struct touch_screen_config touch;
+};
+
+void cm_dll_config_load(
+        struct cm_dll_config *cfg,
+        const wchar_t *filename);
+
+void cm_hook_config_load(
+        struct cm_hook_config *cfg,
+        const wchar_t *filename);

cmhook/dllmain.c

@@ -0,0 +1,119 @@
+#include <windows.h>
+
+#include <stdlib.h>
+
+#include "board/io4.h"
+#include "board/sg-reader.h"
+#include "board/vfd.h"
+
+#include "hook/process.h"
+
+#include "hooklib/dvd.h"
+#include "hooklib/touch.h"
+#include "hooklib/serial.h"
+#include "hooklib/spike.h"
+
+#include "cmhook/config.h"
+#include "cmhook/io4.h"
+#include "cmhook/cm-dll.h"
+#include "cmhook/unity.h"
+
+#include "platform/platform.h"
+
+#include "util/dprintf.h"
+
+static HMODULE cm_hook_mod;
+static process_entry_t cm_startup;
+static struct cm_hook_config cm_hook_cfg;
+
+static DWORD CALLBACK cm_pre_startup(void)
+{
+    HRESULT hr;
+
+    dprintf("--- Begin cm_pre_startup ---\n");
+
+    /* Load config */
+
+    cm_hook_config_load(&cm_hook_cfg, L".\\segatools.ini");
+
+    /* Hook Win32 APIs */
+
+    dvd_hook_init(&cm_hook_cfg.dvd, cm_hook_mod);
+    touch_screen_hook_init(&cm_hook_cfg.touch, cm_hook_mod);
+    serial_hook_init();
+
+    /* Initialize emulation hooks */
+
+    hr = platform_hook_init(
+            &cm_hook_cfg.platform,
+            "SDED",
+            "ACA1",
+            cm_hook_mod);
+
+    if (FAILED(hr)) {
+        goto fail;
+    }
+
+    hr = sg_reader_hook_init(&cm_hook_cfg.aime, 1, cm_hook_mod);
+
+    if (FAILED(hr)) {
+        goto fail;
+    }
+
+    hr = vfd_hook_init(3);
+
+    if (FAILED(hr)) {
+        goto fail;
+    }
+
+    hr = cm_dll_init(&cm_hook_cfg.dll, cm_hook_mod);
+
+    if (FAILED(hr)) {
+        goto fail;
+    }
+
+    hr = cm_io4_hook_init(&cm_hook_cfg.io4);
+
+    if (FAILED(hr)) {
+        goto fail;
+    }
+
+    /* Initialize Unity native plugin DLL hooks
+
+       There seems to be an issue with other DLL hooks if `LoadLibraryW` is
+       hooked earlier in the `cmhook` initialization. */
+
+    unity_hook_init();
+
+    /* Initialize debug helpers */
+
+    spike_hook_init(L".\\segatools.ini");
+
+    dprintf("---  End  cm_pre_startup ---\n");
+
+    /* Jump to EXE start address */
+
+    return cm_startup();
+
+fail:
+    ExitProcess(EXIT_FAILURE);
+}
+
+BOOL WINAPI DllMain(HMODULE mod, DWORD cause, void *ctx)
+{
+    HRESULT hr;
+
+    if (cause != DLL_PROCESS_ATTACH) {
+        return TRUE;
+    }
+
+    cm_hook_mod = mod;
+
+    hr = process_hijack_startup(cm_pre_startup, &cm_startup);
+
+    if (!SUCCEEDED(hr)) {
+        dprintf("Failed to hijack process startup: %x\n", (int) hr);
+    }
+
+    return SUCCEEDED(hr);
+}

cmhook/io4.c

@@ -0,0 +1,69 @@
+#include <windows.h>
+
+#include <assert.h>
+#include <stdlib.h>
+#include <string.h>
+
+#include "board/io4.h"
+
+#include "cmhook/cm-dll.h"
+
+#include "util/dprintf.h"
+
+static HRESULT cm_io4_poll(void *ctx, struct io4_state *state);
+static uint16_t coins;
+
+static const struct io4_ops cm_io4_ops = {
+    .poll = cm_io4_poll,
+};
+
+HRESULT cm_io4_hook_init(const struct io4_config *cfg)
+{
+    HRESULT hr;
+
+    assert(cm_dll.init != NULL);
+
+    hr = io4_hook_init(cfg, &cm_io4_ops, NULL);
+
+    if (FAILED(hr)) {
+        return hr;
+    }
+
+    return cm_dll.init();
+}
+
+static HRESULT cm_io4_poll(void *ctx, struct io4_state *state)
+{
+    uint8_t opbtn;
+    HRESULT hr;
+
+    assert(cm_dll.poll != NULL);
+    assert(cm_dll.get_opbtns != NULL);
+
+    memset(state, 0, sizeof(*state));
+
+    hr = cm_dll.poll();
+
+    if (FAILED(hr)) {
+        return hr;
+    }
+
+    opbtn = 0;
+
+    cm_dll.get_opbtns(&opbtn);
+
+    if (opbtn & CM_IO_OPBTN_TEST) {
+        state->buttons[0] |= IO4_BUTTON_TEST;
+    }
+
+    if (opbtn & CM_IO_OPBTN_SERVICE) {
+        state->buttons[0] |= IO4_BUTTON_SERVICE;
+    }
+
+    if (opbtn & CM_IO_OPBTN_COIN) {
+        coins++;
+    }
+    state->chutes[0] = coins << 8;
+
+    return S_OK;
+}

cmhook/io4.h

@@ -0,0 +1,7 @@
+#pragma once
+
+#include <windows.h>
+
+#include "board/io4.h"
+
+HRESULT cm_io4_hook_init(const struct io4_config *cfg);

cmhook/meson.build

@@ -0,0 +1,32 @@
+shared_library(
+    'cmhook',
+    name_prefix : '',
+    include_directories : inc,
+    implicit_include_directories : false,
+    vs_module_defs : 'cmhook.def',
+    c_pch : '../precompiled.h',
+    dependencies : [
+        capnhook.get_variable('hook_dep'),
+        capnhook.get_variable('hooklib_dep'),
+        xinput_lib,
+    ],
+    link_with : [
+        aimeio_lib,
+        board_lib,
+        hooklib_lib,
+        cmio_lib,
+        platform_lib,
+        util_lib,
+    ],
+    sources : [
+        'config.c',
+        'config.h',
+        'dllmain.c',
+        'io4.c',
+        'io4.h',
+        'cm-dll.c',
+        'cm-dll.h',
+        'unity.h',
+        'unity.c',
+    ],
+)

cmhook/unity.c

@@ -0,0 +1,95 @@
+#include <stdbool.h>
+
+#include <windows.h>
+
+#include "hook/table.h"
+
+#include "hooklib/dll.h"
+#include "hooklib/path.h"
+
+#include "util/dprintf.h"
+
+static void dll_hook_insert_hooks(HMODULE target);
+
+static HMODULE WINAPI my_LoadLibraryW(const wchar_t *name);
+static HMODULE (WINAPI *next_LoadLibraryW)(const wchar_t *name);
+
+static const struct hook_symbol unity_kernel32_syms[] = {
+    {
+        .name = "LoadLibraryW",
+        .patch = my_LoadLibraryW,
+        .link = (void **) &next_LoadLibraryW,
+    },
+};
+
+static const wchar_t *target_modules[] = {
+    L"mono.dll",
+    L"cri_ware_unity.dll",
+};
+static const size_t target_modules_len = _countof(target_modules);
+
+void unity_hook_init(void)
+{
+    dll_hook_insert_hooks(NULL);
+}
+
+static void dll_hook_insert_hooks(HMODULE target)
+{
+    hook_table_apply(
+            target,
+            "kernel32.dll",
+            unity_kernel32_syms,
+            _countof(unity_kernel32_syms));
+}
+
+static HMODULE WINAPI my_LoadLibraryW(const wchar_t *name)
+{
+    const wchar_t *name_end;
+    const wchar_t *target_module;
+    bool already_loaded;
+    HMODULE result;
+    size_t name_len;
+    size_t target_module_len;
+
+    if (name == NULL) {
+        SetLastError(ERROR_INVALID_PARAMETER);
+
+        return NULL;
+    }
+
+    // Check if the module is already loaded
+    already_loaded = GetModuleHandleW(name) != NULL;
+
+    // Must call the next handler so the DLL reference count is incremented
+    result = next_LoadLibraryW(name);
+
+    if (!already_loaded && result != NULL) {
+        name_len = wcslen(name);
+
+        for (size_t i = 0; i < target_modules_len; i++) {
+            target_module = target_modules[i];
+            target_module_len = wcslen(target_module);
+
+            // Check if the newly loaded library is at least the length of
+            // the name of the target module
+            if (name_len < target_module_len) {
+                continue;
+            }
+
+            name_end = &name[name_len - target_module_len];
+
+            // Check if the name of the newly loaded library is one of the
+            // modules the path hooks should be injected into
+            if (_wcsicmp(name_end, target_module) != 0) {
+                continue;
+            }
+
+            dprintf("Unity: Loaded %S\n", target_module);
+
+            dll_hook_insert_hooks(result);
+            path_hook_insert_hooks(result);
+        }
+    }
+
+    return result;
+}

cmhook/unity.h

@@ -0,0 +1,3 @@
+#pragma once
+
+void unity_hook_init(void);