Merge pull request #14 from chrisgleissner/bugfix/windows-recording

Fix Windows debugging and plugin display name

Author: chrisgleissner

.vscode/c_cpp_properties.json

@@ -1,5 +1,28 @@
 {
     "configurations": [
+        {
+            "name": "Win32",
+            "includePath": [
+                "${workspaceFolder}/**",
+                "${workspaceFolder}/.deps/obs-studio-*/libobs",
+                "${workspaceFolder}/.deps/obs-studio-*/libobs/**",
+                "${workspaceFolder}/.deps/obs-deps-*/win64/include",
+                "${workspaceFolder}/.deps/obs-deps-*/win64/include/**"
+            ],
+            "defines": [
+                "_DEBUG",
+                "UNICODE",
+                "_UNICODE",
+                "WIN32",
+                "_WIN32",
+                "_WINDOWS"
+            ],
+            "compilerPath": "cl.exe",
+            "cStandard": "c17",
+            "cppStandard": "c++17",
+            "intelliSenseMode": "windows-msvc-x64",
+            "configurationProvider": "ms-vscode.cmake-tools"
+        },
         {
             "name": "Linux",
             "includePath": [

.vscode/launch.json

@@ -1,12 +1,41 @@
 {
+    // VS Code launch configurations for debugging C64U plugin with OBS Studio
+    // 
+    // Windows users: If OBS is installed in a different location, update the "program" path
+    // Common OBS paths:
+    // - "C:/Program Files/obs-studio/bin/64bit/obs64.exe" (default)
+    // - "C:/Program Files (x86)/obs-studio/bin/64bit/obs64.exe" (32-bit system)
+    // - "${env:LOCALAPPDATA}/Programs/obs-studio/bin/64bit/obs64.exe" (portable install)
+    //
+    // Linux users: OBS is typically at "/usr/bin/obs"
+    
     "version": "0.2.0",
     "configurations": [
         {
-            "name": "Debug OBS with C64U Plugin",
+            "name": "Debug OBS with C64U Plugin (Windows)",
+            "type": "cppvsdbg",
+            "request": "launch",
+            "program": "C:/Program Files/obs-studio/bin/64bit/obs64.exe",
+            "args": ["--verbose"],
+            "stopAtEntry": false,
+            "cwd": "${workspaceFolder}",
+            "environment": [],
+            "console": "externalTerminal",
+            "preLaunchTask": "Build Debug Plugin (Windows)",
+            "logging": {
+                "moduleLoad": false,
+                "trace": false,
+                "engineLogging": false,
+                "programOutput": true,
+                "exceptions": true
+            }
+        },
+        {
+            "name": "Debug OBS with C64U Plugin (Linux)",
             "type": "cppdbg",
             "request": "launch",
             "program": "/usr/bin/obs",
-            "args": [],
+            "args": ["--verbose"],
             "stopAtEntry": false,
             "cwd": "${workspaceFolder}",
             "environment": [],
@@ -19,7 +48,7 @@
                     "ignoreFailures": true
                 }
             ],
-            "preLaunchTask": "Build Debug Plugin",
+            "preLaunchTask": "Build Debug Plugin (Linux)",
             "miDebuggerPath": "/usr/bin/gdb",
             "logging": {
                 "moduleLoad": false,

.vscode/tasks.json

@@ -2,12 +2,14 @@
     "version": "2.0.0",
     "tasks": [
         {
-            "label": "Build Debug Plugin",
+            "label": "Build Debug Plugin (Windows)",
             "type": "shell",
             "command": "cmake",
             "args": [
                 "--build",
-                "build_x86_64"
+                "build_x64",
+                "--config",
+                "Debug"
             ],
             "group": {
                 "kind": "build",
@@ -24,15 +26,67 @@
             "options": {
                 "cwd": "${workspaceFolder}"
             },
-            "dependsOn": "Install Plugin to OBS"
+            "dependsOn": "Install Plugin to OBS (Windows)",
+            "windows": {
+                "command": "cmake"
+            }
+        },
+        {
+            "label": "Build Debug Plugin (Linux)",
+            "type": "shell",
+            "command": "cmake",
+            "args": [
+                "--build",
+                "build_x86_64"
+            ],
+            "group": {
+                "kind": "build"
+            },
+            "presentation": {
+                "echo": true,
+                "reveal": "silent",
+                "focus": false,
+                "panel": "shared",
+                "showReuseMessage": true,
+                "clear": false
+            },
+            "options": {
+                "cwd": "${workspaceFolder}"
+            },
+            "dependsOn": "Install Plugin to OBS (Linux)",
+            "linux": {
+                "command": "cmake"
+            }
+        },
+        {
+            "label": "Install Plugin to OBS (Windows)",
+            "type": "shell",
+            "command": "powershell",
+            "args": [
+                "-File",
+                "${workspaceFolder}/build-aux/install-plugin-windows.ps1"
+            ],
+            "group": "build",
+            "presentation": {
+                "echo": true,
+                "reveal": "silent",
+                "focus": false,
+                "panel": "shared"
+            },
+            "options": {
+                "cwd": "${workspaceFolder}"
+            },
+            "windows": {
+                "command": "powershell"
+            }
         },
         {
-            "label": "Install Plugin to OBS",
+            "label": "Install Plugin to OBS (Linux)",
             "type": "shell",
-            "command": "cp",
+            "command": "bash",
             "args": [
-                "build_x86_64/c64u-plugin-for-obs.so",
-                "${env:HOME}/.config/obs-studio/plugins/c64u-plugin-for-obs/bin/64bit/"
+                "-c",
+                "mkdir -p \"$HOME/.config/obs-studio/plugins/c64u-plugin-for-obs/bin/64bit\" && mkdir -p \"$HOME/.config/obs-studio/plugins/c64u-plugin-for-obs/data\" && cp \"build_x86_64/c64u-plugin-for-obs.so\" \"$HOME/.config/obs-studio/plugins/c64u-plugin-for-obs/bin/64bit/\" && cp -r \"data\"/* \"$HOME/.config/obs-studio/plugins/c64u-plugin-for-obs/data/\""
             ],
             "group": "build",
             "presentation": {
@@ -43,10 +97,35 @@
             },
             "options": {
                 "cwd": "${workspaceFolder}"
+            },
+            "linux": {
+                "command": "bash"
             }
         },
         {
-            "label": "Clean Build",
+            "label": "Clean Build (Windows)",
+            "type": "shell",
+            "command": "powershell",
+            "args": [
+                "-Command",
+                "Remove-Item -Recurse -Force -Path \"build_x64\" -ErrorAction SilentlyContinue"
+            ],
+            "group": "build",
+            "presentation": {
+                "echo": true,
+                "reveal": "always",
+                "focus": false,
+                "panel": "shared"
+            },
+            "options": {
+                "cwd": "${workspaceFolder}"
+            },
+            "windows": {
+                "command": "powershell"
+            }
+        },
+        {
+            "label": "Clean Build (Linux)",
             "type": "shell",
             "command": "rm",
             "args": [
@@ -62,6 +141,9 @@
             },
             "options": {
                 "cwd": "${workspaceFolder}"
+            },
+            "linux": {
+                "command": "rm"
             }
         }
     ]

README.md

@@ -72,8 +72,8 @@ See the [OBS Plugins Guide](https://obsproject.com/kb/plugins-guide).
 2. **Open Properties:** Select the "C64U" source in your sources list, then click the "Properties" button to open the configuration dialog
 3. **Debug Logging:** Enable detailed logging for debugging connection issues (optional)
 4. **Configure Network Settings:**
-   - **C64 Ultimate IP:** Enter your Ultimate device's IP address to enable automatic streaming control from OBS (recommended for convenience), or set to `0.0.0.0` to accept streams from any C64 Ultimate on your network (requires manual control from the device)
-   - **OBS Server IP:** IP address where C64 Ultimate sends streams (auto-detected by default)
+   - **C64U Host:** Enter your Ultimate device's hostname (default: `c64u`) or IP address to enable automatic streaming control from OBS (recommended for convenience), or set to `0.0.0.0` to accept streams from any C64 Ultimate on your network (requires manual control from the device)
+   - **OBS Server IP:** IP address where C64 Ultimate sends streams (auto-detected by default)  
    - **Auto-detect OBS IP:** Automatically detect and use OBS server IP in streaming commands (recommended)
 5. **Configure Ports:** Use the default ports (video: 11000, audio: 11001) unless network conflicts require different values
 6. **Render Delay:** Adjust frame buffering (0-100 frames, default 3) to smooth UDP packet loss/reordering
@@ -90,7 +90,7 @@ Once configured, live video and audio streams from the C64 Ultimate will be avai
 
 ### Ultimate Device Setup 🎛️
 
-**Automatic Configuration (Recommended):** The OBS plugin automatically controls streaming on the Ultimate device. When you configure the Ultimate's IP address in the OBS plugin settings, the plugin tells the Ultimate device where to send streams and sends start commands automatically. Thus, no manual streaming adjustments are needed on the Ultimate device.
+**Automatic Configuration (Recommended):** The OBS plugin automatically controls streaming on the Ultimate device. When you configure the Ultimate's hostname or IP address in the OBS plugin settings, the plugin tells the Ultimate device where to send streams and sends start commands automatically. Thus, no manual streaming adjustments are needed on the Ultimate device.
 
 **Manual Configuration:**
 1. Press F2 to access the Ultimate's configuration menu
@@ -102,6 +102,30 @@ Once configured, live video and audio streams from the C64 Ultimate will be avai
 
 For comprehensive configuration details, refer to the [official C64 Ultimate documentation](https://1541u-documentation.readthedocs.io/en/latest/data_streams.html).
 
+### Hostname vs IP Address 🌐
+
+The plugin supports both **hostnames** and **IP addresses** for the C64U Host field:
+
+**Using Hostnames (Recommended):**
+- **Default:** `c64u` - The plugin will try to resolve this hostname to an IP address
+- **Custom:** `my-c64u` or `retro-pc` - Use any hostname your C64 Ultimate device is known by
+- **FQDN Support:** The plugin automatically tries both `hostname` and `hostname.` (with trailing dot) for proper DNS resolution
+
+**Using IP Addresses:**
+- **Direct IP:** `192.168.1.64` - Standard IPv4 address format
+- **Fallback:** `0.0.0.0` - Accept streams from any C64 Ultimate (no automatic control)
+
+**How it Works:**
+1. Plugin first checks if the input is already a valid IP address
+2. If not, it attempts DNS resolution of the hostname as-is
+3. If that fails, it tries FQDN resolution with a trailing dot (e.g., `c64u.`)
+4. If hostname resolution fails, the plugin logs a warning but continues using the hostname as-is
+
+**Examples:**
+- `c64u` → resolves to `192.168.1.64` (automatic)
+- `192.168.1.64` → used directly as IP address  
+- `retro-basement.local` → resolves via mDNS/Bonjour
+- `ultimate64` → tries both `ultimate64` and `ultimate64.` for resolution
 
 ## Recording Features 📹
 

build-aux/install-plugin-windows.ps1

@@ -0,0 +1,35 @@
+# PowerShell script to install C64U plugin to OBS Studio on Windows
+# This script creates the necessary directory structure and copies the plugin files
+
+$PluginPath = "$env:APPDATA\obs-studio\plugins\c64u-plugin-for-obs"
+$BinPath = "$PluginPath\bin\64bit"
+$DataPath = "$PluginPath\data"
+
+# Create directories
+Write-Host "Creating plugin directories..."
+New-Item -ItemType Directory -Force -Path $BinPath | Out-Null
+New-Item -ItemType Directory -Force -Path $DataPath | Out-Null
+
+# Copy plugin DLL
+$SourceDll = "build_x64\Debug\c64u-plugin-for-obs.dll"
+$TargetDll = "$BinPath\c64u-plugin-for-obs.dll"
+
+if (Test-Path $SourceDll) {
+    Write-Host "Copying plugin DLL: $SourceDll -> $TargetDll"
+    Copy-Item $SourceDll $TargetDll -Force
+} else {
+    Write-Error "Plugin DLL not found: $SourceDll"
+    Write-Error "Make sure to build the plugin first with: cmake --build build_x64 --config Debug"
+    exit 1
+}
+
+# Copy data files (locale and images)
+if (Test-Path "data") {
+    Write-Host "Copying plugin data files..."
+    Copy-Item "data\*" $DataPath -Recurse -Force
+} else {
+    Write-Warning "Data directory not found, plugin may not work correctly"
+}
+
+Write-Host "Plugin installed successfully to: $PluginPath"
+Write-Host "You can now launch OBS Studio to test the plugin"

data/locale/de-DE.ini

@@ -1,15 +1,15 @@
 # German localization for C64U Plugin
 # Source name and descriptions
-C64UDisplay="C64U-Anzeige"
+C64UDisplay="C64U"
 
 # Properties dialog sections
 DebugLogging="Debug-Protokollierung"
 DebugLogging.Description="Detaillierte Protokollierung zur Fehlerbehebung bei Verbindungsproblemen aktivieren"
 
 NetworkConfiguration="Netzwerkkonfiguration"
 
-C64UltimateIP="C64 Ultimate IP"
-C64UltimateIP.Description="IP-Adresse oder DNS-Name des C64 Ultimate-Geräts (0.0.0.0 verwenden, um Steuerbefehle zu überspringen)"
+C64UHost="C64U Host"
+C64UHost.Description="Hostname or IP address of C64 Ultimate device (default: c64u). Use 0.0.0.0 to skip control commands."
 
 OBSMachineIP="OBS-Server IP"
 OBSMachineIP.Description="IP-Adresse dieses OBS-Servers (wohin C64 Ultimate Streams sendet)"

data/locale/en.ini

@@ -1,15 +1,15 @@
 # English localization for C64U Plugin
 # Source name and descriptions
-C64UDisplay="C64U Display"
+C64UDisplay="C64U"
 
 # Properties dialog sections
 DebugLogging="Debug Logging"
 DebugLogging.Description="Enable detailed logging for debugging connection issues"
 
 NetworkConfiguration="Network Configuration"
 
-C64UltimateIP="C64 Ultimate IP"
-C64UltimateIP.Description="IP address or DNS name of C64 Ultimate device (use 0.0.0.0 to skip control commands)"
+C64UHost="C64U Host"
+C64UHost.Description="Hostname or IP address of C64 Ultimate device (default: c64u). Use 0.0.0.0 to skip control commands."
 
 OBSMachineIP="OBS IP"
 OBSMachineIP.Description="IP address of this OBS server (where C64 Ultimate sends streams)"

data/locale/es-ES.ini

@@ -1,15 +1,15 @@
 # Spanish localization for C64U Plugin
 # Source name and descriptions
-C64UDisplay="Pantalla C64U"
+C64UDisplay="C64U"
 
 # Properties dialog sections
 DebugLogging="Registro de depuración"
 DebugLogging.Description="Habilitar registro detallado para depurar problemas de conexión"
 
 NetworkConfiguration="Configuración de red"
 
-C64UltimateIP="IP C64 Ultimate"
-C64UltimateIP.Description="Dirección IP o nombre DNS del dispositivo C64 Ultimate (usar 0.0.0.0 para omitir comandos de control)"
+C64UHost="C64U Host"
+C64UHost.Description="Hostname or IP address of C64 Ultimate device (default: c64u). Use 0.0.0.0 to skip control commands."
 
 OBSMachineIP="IP OBS"
 OBSMachineIP.Description="Dirección IP de este servidor OBS (donde C64 Ultimate envía transmisiones)"

data/locale/fr-FR.ini

@@ -1,15 +1,15 @@
 # French localization for C64U Plugin
 # Source name and descriptions
-C64UDisplay="Affichage C64U"
+C64UDisplay="C64U"
 
 # Properties dialog sections
 DebugLogging="Journalisation de débogage"
 DebugLogging.Description="Activer la journalisation détaillée pour déboguer les problèmes de connexion"
 
 NetworkConfiguration="Configuration réseau"
 
-C64UltimateIP="IP C64 Ultimate"
-C64UltimateIP.Description="Adresse IP ou nom DNS du dispositif C64 Ultimate (utiliser 0.0.0.0 pour ignorer les commandes de contrôle)"
+C64UHost="C64U Host"
+C64UHost.Description="Hostname or IP address of C64 Ultimate device (default: c64u). Use 0.0.0.0 to skip control commands."
 
 OBSMachineIP="IP OBS"
 OBSMachineIP.Description="Adresse IP de ce serveur OBS (où C64 Ultimate envoie les flux)"