Merge pull request #18 from chrisgleissner/feature/improve-rendering

Optimize retry thread: eliminate 100ms polling and reduce mutex contention

Author: chrisgleissner

.github/copilot-instructions.md

@@ -411,9 +411,92 @@ When setting default user directories, use platform conventions:
 - Pay special attention to file I/O and networking code
 - Test default path behavior on each platform
 
+## Local Compilation Verification (MANDATORY)
+
+**Before announcing any change as completed, you MUST verify it builds locally on both Linux AND Windows platforms.**
+
+### Linux Verification (Required)
+```bash
+# Clean build to ensure no cached artifacts
+rm -rf build_x86_64
+cmake --preset ubuntu-x86_64
+cmake --build build_x86_64
+
+# Verify success
+if [ -f "build_x86_64/c64u-plugin-for-obs.so" ]; then
+    echo "✅ Linux build successful"
+else
+    echo "❌ Linux build failed - DO NOT proceed"
+fi
+```
+
+### Windows Verification (Required)
+Choose ONE method to verify Windows compatibility:
+
+**Method 1: Docker-based Windows simulation (Linux users)**
+```bash
+./test-windows-build.sh
+# Must show: "🎉 SUCCESS: Windows build simulation completed!"
+```
+
+**Method 2: Native Windows build (Windows users)**
+```powershell
+# Clean build
+Remove-Item "build_x64" -Recurse -Force -ErrorAction SilentlyContinue
+cmake --preset windows-x64
+cmake --build build_x64 --config RelWithDebInfo
+
+# Verify success
+if (Test-Path "build_x64\RelWithDebInfo\c64u-plugin-for-obs.dll") {
+    Write-Host "✅ Windows build successful" -ForegroundColor Green
+} else {
+    Write-Host "❌ Windows build failed - DO NOT proceed" -ForegroundColor Red
+}
+```
+
+**Method 3: CI-compatible Windows build (Advanced)**
+```powershell
+$env:CI = "1"
+cmake --preset windows-ci-x64
+cmake --build build_x64 --config RelWithDebInfo --parallel
+# Must complete without errors or warnings
+```
+
+### Validation Checklist
+
+Before announcing completion, verify ALL of the following:
+
+- [ ] **Linux build succeeds** without errors or warnings
+- [ ] **Windows build succeeds** using one of the above methods
+- [ ] **Code formatting passes**: `./build-aux/run-clang-format --check`
+- [ ] **CMake formatting passes**: `./build-aux/run-gersemi --check`
+- [ ] **No compilation warnings** in either platform
+- [ ] **Atomic types work correctly** (if atomic changes were made)
+- [ ] **Header inclusion order is correct** (if header changes were made)
+- [ ] **Cross-platform compatibility maintained** (no platform-specific assumptions)
+
+### If Verification Fails
+
+If either Linux or Windows build fails:
+1. **DO NOT announce the change as completed**
+2. **Investigate and fix the build failures**
+3. **Re-run both verifications**
+4. **Only proceed after both platforms build successfully**
+
+### Documentation Requirements
+
+When announcing completion of changes that affect build processes:
+- **Reference the appropriate build documentation**:
+  - Linux/general: `doc/developer.md`
+  - Windows-specific: `doc/windows-local-build.md`
+  - Cross-platform: Cross-Platform Development Guidelines (above)
+- **Mention which verification method was used**
+- **Confirm both platforms were tested**
+
 ## Trust These Instructions
 
 These instructions are comprehensive and tested. Only search for additional information if:
 1. Build fails with error not covered in "Common Build Issues"
 2. Instructions appear outdated (e.g., tool versions changed significantly)
 3. New platform support is needed beyond Windows/macOS/Linux
+4. The mandatory verification process fails and troubleshooting is needed

.gitignore

@@ -7,6 +7,7 @@
 !/cmake
 !/data
 !/doc
+!/docs
 !/src
 !/tests
 !/tools

CMakeLists.txt

@@ -2,7 +2,30 @@ cmake_minimum_required(VERSION 3.28...3.30)
 
 include("${CMAKE_CURRENT_SOURCE_DIR}/cmake/common/bootstrap.cmake" NO_POLICY_SCOPE)
 
-project(${_name} VERSION ${_version})
+# Determine authoritative version from git tag first
+execute_process(
+  COMMAND git describe --tags --always --dirty
+  WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+  OUTPUT_VARIABLE GIT_VERSION_TAG
+  OUTPUT_STRIP_TRAILING_WHITESPACE
+  ERROR_QUIET
+)
+
+# Extract clean version number from git tag for project version
+if(GIT_VERSION_TAG AND GIT_VERSION_TAG MATCHES "^v?([0-9]+\\.[0-9]+\\.[0-9]+)")
+  # Extract version number from tag (e.g., "v1.2.3" -> "1.2.3", "1.2.3-dirty" -> "1.2.3")
+  string(REGEX REPLACE "^v?([0-9]+\\.[0-9]+\\.[0-9]+).*" "\\1" AUTHORITATIVE_VERSION "${GIT_VERSION_TAG}")
+  message(STATUS "Using git tag version: ${AUTHORITATIVE_VERSION}")
+else()
+  # Fallback to buildspec.json version if no proper git tag is available
+  set(AUTHORITATIVE_VERSION "${_version}")
+  message(STATUS "No git tag found, using buildspec.json version: ${AUTHORITATIVE_VERSION}")
+endif()
+
+project(${_name} VERSION ${AUTHORITATIVE_VERSION})
+
+# Set dummy VirtualCam GUID to prevent Windows build warning
+set(VIRTUALCAM_GUID "{00000000-0000-0000-0000-000000000000}")
 
 option(ENABLE_FRONTEND_API "Use obs-frontend-api for UI functionality" OFF)
 option(ENABLE_QT "Use Qt functionality" OFF)
@@ -14,6 +37,45 @@ include(helpers)
 
 add_library(${CMAKE_PROJECT_NAME} MODULE)
 
+# Update buildspec.json with authoritative version if it came from git tag
+if(GIT_VERSION_TAG AND GIT_VERSION_TAG MATCHES "^v?([0-9]+\\.[0-9]+\\.[0-9]+)")
+  # Update buildspec.json with the git tag version to keep it in sync
+  # Use sed to update only line 41 (the main project version, not dependency versions)
+  execute_process(
+    COMMAND sed -i "41s/\"version\": \"[^\"]*\"/\"version\": \"${AUTHORITATIVE_VERSION}\"/" "${CMAKE_SOURCE_DIR}/buildspec.json"
+    WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
+    RESULT_VARIABLE sed_result
+  )
+
+  if(sed_result EQUAL 0)
+    message(STATUS "Updated buildspec.json version to: ${AUTHORITATIVE_VERSION}")
+  else()
+    message(WARNING "Failed to update buildspec.json version")
+  endif()
+endif()
+
+# Use git tag for display version (includes dirty/commit info), authoritative version for project
+set(DISPLAY_VERSION "${GIT_VERSION_TAG}")
+
+execute_process(
+  COMMAND git rev-parse --short HEAD
+  WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+  OUTPUT_VARIABLE GIT_HASH
+  OUTPUT_STRIP_TRAILING_WHITESPACE
+  ERROR_QUIET
+)
+if(NOT GIT_HASH)
+  set(GIT_HASH "unknown")
+endif()
+
+string(TIMESTAMP BUILD_TIME "%Y-%m-%d %H:%M:%S" UTC)
+
+target_compile_definitions(${CMAKE_PROJECT_NAME} PRIVATE
+  C64U_VERSION_TAG="${DISPLAY_VERSION}"
+  C64U_GIT_HASH="${GIT_HASH}"
+  C64U_BUILD_TIME="${BUILD_TIME}"
+)
+
 find_package(libobs REQUIRED)
 target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE OBS::libobs)
 
@@ -42,9 +104,12 @@ target_sources(
     src/c64u-network.c
     src/c64u-protocol.c
     src/c64u-video.c
+    src/c64u-color.c
     src/c64u-audio.c
     src/c64u-source.c
     src/c64u-record.c
+    src/c64u-version.c
+    src/c64u-properties.c
 )
 
 # Link resolver library for DNS functionality on Unix platforms

README.md

@@ -51,6 +51,9 @@ New-NetFirewallRule -DisplayName "C64U" -Direction Inbound -Protocol UDP -LocalP
 2. Install `c64u-plugin-for-obs-*-macos-universal.pkg` to `~/Library/Application Support/obs-studio/plugins`
 3. Restart OBS Studio
 
+> [!NOTE]
+> macOS support is currently under active development and is not yet fully functional. We're working to resolve compatibility issues and will update this documentation when macOS builds are stable.
+
 **Linux (Ubuntu/Debian):**
 1. Close OBS Studio
 2. Install `c64u-plugin-for-obs-*-x86_64-linux-gnu.deb` to `~/.config/obs-studio/plugins` by running: