630:P1 Add UI test for ESC toggling menu overlay

.github/ISSUE_TEMPLATE/config.yml

@@ -1,5 +1,2 @@
-blank_issues_enabled: false
-contact_links:
-  - name: Create new issue
-    url: https://github.com/projectM-visualizer/projectm/issues/new/choose
-    about: Please open new issues in the main projectM repository. We will then move the issue into the correct repository for you.
+blank_issues_enabled: true
+contact_links: []

.github/workflows/buildcheck.yaml

@@ -97,8 +97,6 @@ jobs:
       USERNAME: projectM-visualizer
       VCPKG_EXE: ${{ github.workspace }}/vcpkg/vcpkg
       FEED_URL: https://nuget.pkg.github.com/projectM-visualizer/index.json
-      VCPKG_BINARY_SOURCES: "clear;nuget,https://nuget.pkg.github.com/projectM-visualizer/index.json,readwrite"
-
 
     steps:
       - name: Checkout vcpkg
@@ -108,24 +106,95 @@ jobs:
           path: vcpkg
           submodules: recursive
 
-      - name: Bootstrap vcpkg
+      # Capture the exact vcpkg repository commit being used.
+      # This ensures our cache key changes automatically if vcpkg itself is updated.
+      - name: Get vcpkg commit
+        id: vcpkg_rev
         shell: pwsh
-        run: ${{ github.workspace }}/vcpkg/bootstrap-vcpkg.bat
+        run: |
+          $rev = (git -C "${{ github.workspace }}/vcpkg" rev-parse HEAD).Trim()
+          "rev=$rev" | Out-File -FilePath $env:GITHUB_OUTPUT -Append
+
+      # Checkout this repo before hashFiles() / manifest is referenced
+      - name: Checkout projectMSDL Sources
+        uses: actions/checkout@v4
+        with:
+          path: frontend-sdl2
+          submodules: recursive
+
+      - name: Prepare vcpkg binary cache dir (forks)
+        if: github.repository != 'projectM-visualizer/frontend-sdl-cpp'
+        shell: pwsh
+        run: |
+          $cacheDir = Join-Path $env:GITHUB_WORKSPACE "vcpkg-binary-cache"
+          New-Item -ItemType Directory -Force -Path $cacheDir | Out-Null
+          Write-Host "Cache dir: $cacheDir"
+
+      # Restore fork cache (file-based binary cache persisted by actions/cache)
+      - name: Cache vcpkg binary cache (forks)
+        if: github.repository != 'projectM-visualizer/frontend-sdl-cpp'
+        uses: actions/cache@v4
+        with:
+          path: ${{ github.workspace }}\vcpkg-binary-cache
+          key: vcpkg-bincache-${{ runner.os }}-${{ steps.vcpkg_rev.outputs.rev }}-${{ hashFiles('frontend-sdl2/vcpkg.json', 'frontend-sdl2/vcpkg-configuration.json') }}
+          restore-keys: |
+            vcpkg-bincache-${{ runner.os }}-${{ steps.vcpkg_rev.outputs.rev }}-
+            vcpkg-bincache-${{ runner.os }}-
+
+      - name: Show if binary cache has contents (forks)
+        if: github.repository != 'projectM-visualizer/frontend-sdl-cpp'
+        shell: pwsh
+        run: |
+          $cacheDir = Join-Path $env:GITHUB_WORKSPACE "vcpkg-binary-cache"
+          if (Test-Path $cacheDir) {
+            Get-ChildItem -Recurse $cacheDir | Select-Object -First 30 FullName
+          } else {
+            Write-Host "Binary cache directory does not exist."
+          }
 
+      # Configure vcpkg binary cache behavior
+      - name: Configure vcpkg binary cache (upstream)
+        if: github.repository == 'projectM-visualizer/frontend-sdl-cpp'
+        shell: pwsh
+        run: |
+          Write-Host "Using NuGet binary cache (readwrite) for upstream repo"
+          "VCPKG_BINARY_SOURCES=clear;nuget,${{ env.FEED_URL }},readwrite" | Out-File -FilePath $env:GITHUB_ENV -Append
+
+      - name: Configure vcpkg binary cache (forks)
+        if: github.repository != 'projectM-visualizer/frontend-sdl-cpp'
+        shell: pwsh
+        run: |
+          Write-Host "Using local file-based binary cache (readwrite) for fork/PR"
+          $cacheDir = Join-Path $env:GITHUB_WORKSPACE "vcpkg-binary-cache"
+          "VCPKG_DEFAULT_BINARY_CACHE=$cacheDir" | Out-File -FilePath $env:GITHUB_ENV -Append
+          "VCPKG_BINARY_SOURCES=clear;files,$cacheDir,readwrite" | Out-File -FilePath $env:GITHUB_ENV -Append
+
+      # Upstream-only: authenticate to GitHub Packages NuGet feed
       - name: Add NuGet sources
+        if: github.repository == 'projectM-visualizer/frontend-sdl-cpp'
+        env:
+          VCPKG_PACKAGES_TOKEN: ${{ secrets.VCPKG_PACKAGES_TOKEN }}
         shell: pwsh
         run: |
-          .$(${{ env.VCPKG_EXE }} fetch nuget) `
-            sources add `
+          if (-not $env:VCPKG_PACKAGES_TOKEN) {
+            Write-Host "VCPKG_PACKAGES_TOKEN not set; skipping NuGet auth."
+            exit 0
+          }
+
+          $nuget = (& "${{ env.VCPKG_EXE }}" fetch nuget | Select-Object -Last 1).Trim()
+          & $nuget sources add `
             -Source "${{ env.FEED_URL }}" `
             -StorePasswordInClearText `
             -Name GitHubPackages `
             -UserName "${{ env.USERNAME }}" `
-            -Password "${{ secrets.VCPKG_PACKAGES_TOKEN }}"
-          .$(${{ env.VCPKG_EXE }} fetch nuget) `
-            setapikey "${{ secrets.VCPKG_PACKAGES_TOKEN }}" `
+            -Password "$env:VCPKG_PACKAGES_TOKEN"
+          & $nuget setapikey "$env:VCPKG_PACKAGES_TOKEN" `
             -Source "${{ env.FEED_URL }}"
 
+      - name: Bootstrap vcpkg
+        shell: pwsh
+        run: ${{ github.workspace }}/vcpkg/bootstrap-vcpkg.bat
+
       - name: Checkout libprojectM Sources
         uses: actions/checkout@v4
         with:
@@ -140,12 +209,6 @@ jobs:
           cmake --build "${{ github.workspace }}/cmake-build-libprojectm" --config Release --parallel
           cmake --install "${{ github.workspace }}/cmake-build-libprojectm" --config Release
 
-      - name: Checkout projectMSDL Sources
-        uses: actions/checkout@v4
-        with:
-          path: frontend-sdl2
-          submodules: recursive
-
       - name: Build projectMSDL
         run: |
           mkdir cmake-build-frontend-sdl2

CMakeLists.txt

@@ -6,16 +6,25 @@ set(CMAKE_POSITION_INDEPENDENT_CODE YES)
 
 set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 
-project(projectMSDL
-        LANGUAGES C CXX
-        VERSION 2.0.0
-        )
-
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
 
 option(ENABLE_FLAT_PACKAGE "Creates a \"flat\" install layout with the executable, configuration file(s) and preset/texture dirs directly in the install prefix." OFF)
 option(ENABLE_INSTALL_BDEPS "Installs all shared libraries projectMSDL requires to run. On some platforms, CMake 3.31 or higher is required for this to work!" OFF)
 
+# Added option display to cmake build to allow testing
+option(BUILD_TESTING "Build the frontend-sdl2 ctests" OFF)
+
+# Enable vcpkg manifest features according to build options (just like the projectm backend)
+if(BUILD_TESTING)
+    list(APPEND VCPKG_MANIFEST_FEATURES test)
+endif()
+
+# Moved below options to allow using options
+project(projectMSDL
+    LANGUAGES C CXX
+    VERSION 2.0.0
+)
+
 set(PROJECTMSDL_PROPERTIES_FILENAME "projectMSDL.properties")
 
 if(CMAKE_SYSTEM_NAME STREQUAL "Linux" AND NOT ENABLE_FLAT_PACKAGE)
@@ -114,8 +123,10 @@ include(ImGui.cmake)
 
 add_subdirectory(src)
 
-if(ENABLE_TESTING)
-    add_subdirectory(test)
+# Adjusted testing build from existing code
+if(BUILD_TESTING)
+    enable_testing()
+    add_subdirectory(tests)
 endif()
 
 include(install.cmake)
@@ -135,3 +146,6 @@ message(STATUS "The projectMSDL binary will look for the following hard-coded pa
 message(STATUS "    Configuration file:  ${DEFAULT_CONFIG_PATH}")
 message(STATUS "    Presets:             ${DEFAULT_PRESETS_PATH}")
 message(STATUS "    Textures:            ${DEFAULT_TEXTURES_PATH}")
+# Added testing message
+message(STATUS "=============================================")
+message(STATUS "    Tests:               ${BUILD_TESTING}")

cmake/SDL2Target.cmake

@@ -54,20 +54,30 @@ if(NOT TARGET SDL2::SDL2)
 endif()
 
 # Temporary fix to deal with wrong include dir set by SDL2's CMake configuration.
-get_target_property(_SDL2_INCLUDE_DIR SDL2::SDL2 INTERFACE_INCLUDE_DIRECTORIES)
-if(_SDL2_INCLUDE_DIR MATCHES "(.+)/SDL2\$" AND _SDL2_TARGET_TYPE STREQUAL STATIC_LIBRARY)
-    # Check if SDL2::SDL2 is aliased to SDL2::SDL2-static (will be the case for static-only builds)
-    get_target_property(_SDL2_ALIASED_TARGET SDL2::SDL2 ALIASED_TARGET)
-    if(_SDL2_ALIASED_TARGET)
-        set(_sdl2_target ${_SDL2_ALIASED_TARGET})
-    else()
-        set(_sdl2_target SDL2::SDL2)
-    endif()
+# Some SDL2 configs incorrectly report .../include/SDL2 instead of .../include.
+get_target_property(_SDL2_INCLUDE_DIRS SDL2::SDL2 INTERFACE_INCLUDE_DIRECTORIES)
+
+if(_SDL2_INCLUDE_DIRS)
+    # The property can be a list, so handle each entry.
+    foreach(_dir IN LISTS _SDL2_INCLUDE_DIRS)
+        if(_dir MATCHES "(.+)/SDL2$")
+            set(_fixed_parent "${CMAKE_MATCH_1}")
+
+            # If SDL2::SDL2 is an alias, patch the real target.
+            get_target_property(_SDL2_ALIASED_TARGET SDL2::SDL2 ALIASED_TARGET)
+            if(_SDL2_ALIASED_TARGET)
+                set(_sdl2_target "${_SDL2_ALIASED_TARGET}")
+            else()
+                set(_sdl2_target SDL2::SDL2)
+            endif()
 
-    message(STATUS "SDL2 include dir contains \"SDL2\" subdir (SDL bug #4004) - fixing to \"${CMAKE_MATCH_1}\".")
-    set_target_properties(${_sdl2_target} PROPERTIES
-            INTERFACE_INCLUDE_DIRECTORIES "${CMAKE_MATCH_1}"
+            message(STATUS "SDL2 include dir contains \"SDL2\" subdir - fixing to \"${_fixed_parent}\".")
+            set_target_properties(${_sdl2_target} PROPERTIES
+                INTERFACE_INCLUDE_DIRECTORIES "${_fixed_parent}"
             )
+            break()
+        endif()
+    endforeach()
 endif()
 
 if(SDL2_VERSION AND SDL2_VERSION VERSION_LESS "2.0.5")

src/CMakeLists.txt

@@ -5,6 +5,8 @@ set(PROJECTM_CONFIGURATION_FILE "${CMAKE_CURRENT_BINARY_DIR}/projectMSDL.propert
 set(PROJECTM_CONFIGURATION_FILE "${PROJECTM_CONFIGURATION_FILE}" PARENT_SCOPE)
 configure_file(resources/projectMSDL.properties.in "${PROJECTM_CONFIGURATION_FILE}" @ONLY)
 
+find_package(OpenGL REQUIRED)
+
 add_executable(projectMSDL WIN32 MACOSX_BUNDLE
         AudioCapture.cpp
         AudioCapture.h
@@ -82,6 +84,14 @@ target_link_libraries(projectMSDL
         SDL2::SDL2main
         )
 
+if (TARGET OpenGL::GL)
+    target_link_libraries(projectMSDL PRIVATE OpenGL::GL)
+elseif (TARGET OpenGL::OpenGL)
+    target_link_libraries(projectMSDL PRIVATE OpenGL::OpenGL)
+else()
+    message(FATAL_ERROR "No OpenGL CMake target found.")
+endif()
+
 if (MSVC)
     set_target_properties(projectMSDL
             PROPERTIES

tests/CMakeLists.txt

@@ -0,0 +1,132 @@
+# ======
+# Test-only core library
+# (Eventually this should be moved into src/CMakeLists.txt to avoid
+# duplicating source lists and dependancies.)
+# ======
+
+# Build a core library from production sources to test on
+add_library(projectMSDL_testcorelib
+    # Add .cpp files as needed for testing
+    # Examples:
+    # ${PROJECT_SOURCE_DIR}/src/SDLRenderingWindow.cpp
+    # ${PROJECT_SOURCE_DIR}/src/RenderLoop.cpp
+    # ${PROJECT_SOURCE_DIR}/src/ProjectMWrapper.cpp
+    # For now, we'll include a simple file just so this thing works. It can be removed if unneeded later.
+    ${PROJECT_SOURCE_DIR}/src/FPSLimiter.cpp
+    ${PROJECT_SOURCE_DIR}/src/ProjectMSDLApplication.cpp
+    ${PROJECT_SOURCE_DIR}/src/RenderLoop.cpp
+    ${PROJECT_SOURCE_DIR}/src/ProjectMWrapper.cpp
+    ${PROJECT_SOURCE_DIR}/src/SDLRenderingWindow.cpp
+    ${PROJECT_SOURCE_DIR}/src/AudioCapture.cpp
+)
+
+if (WIN32)
+    target_sources(projectMSDL_testcorelib PRIVATE
+        ${PROJECT_SOURCE_DIR}/src/AudioCaptureImpl_WASAPI.cpp
+    )
+    target_compile_definitions(projectMSDL_testcorelib PRIVATE
+        AUDIO_IMPL_HEADER="AudioCaptureImpl_WASAPI.h"
+        USE_GLEW
+    )
+else()
+    target_sources(projectMSDL_testcorelib PRIVATE
+        ${PROJECT_SOURCE_DIR}/src/AudioCaptureImpl_SDL.cpp
+    )
+    target_compile_definitions(projectMSDL_testcorelib PRIVATE
+        AUDIO_IMPL_HEADER="AudioCaptureImpl_SDL.h"
+    )
+endif()
+
+# Headers from the production source tree
+target_include_directories(projectMSDL_testcorelib
+    PUBLIC
+    ${PROJECT_SOURCE_DIR}/src
+)
+
+# Compile definitions that are commonly referenced
+target_compile_definitions(projectMSDL_testcorelib
+    PRIVATE
+    PROJECTMSDL_CONFIG_LOCATION="${DEFAULT_CONFIG_PATH}"
+    PROJECTMSDL_VERSION="${PROJECT_VERSION}"
+)
+
+# Linker set (add to this only when the linker asks)
+target_link_libraries(projectMSDL_testcorelib
+    PRIVATE
+    SDL2::SDL2
+    Poco::Util
+    Poco::Foundation
+    ProjectMSDL-GUI
+    ProjectMSDL-Notifications
+    libprojectM::playlist
+)
+
+# ======
+# Test-only core library WITHOUT RenderLoop
+# ======
+
+# Build a core library from production sources to test on
+add_library(projectMSDL_testcorelib_norenderloop
+    # Add .cpp files as needed for testing
+    # Examples:
+    # ${PROJECT_SOURCE_DIR}/src/SDLRenderingWindow.cpp
+    # ${PROJECT_SOURCE_DIR}/src/RenderLoop.cpp
+    # ${PROJECT_SOURCE_DIR}/src/ProjectMWrapper.cpp
+    # For now, we'll include a simple file just so this thing works. It can be removed if unneeded later.
+    ${PROJECT_SOURCE_DIR}/src/FPSLimiter.cpp
+    ${PROJECT_SOURCE_DIR}/src/ProjectMSDLApplication.cpp
+    ${PROJECT_SOURCE_DIR}/src/ProjectMWrapper.cpp
+    ${PROJECT_SOURCE_DIR}/src/SDLRenderingWindow.cpp
+    ${PROJECT_SOURCE_DIR}/src/AudioCapture.cpp
+)
+
+if (WIN32)
+    target_sources(projectMSDL_testcorelib_norenderloop PRIVATE
+        ${PROJECT_SOURCE_DIR}/src/AudioCaptureImpl_WASAPI.cpp
+    )
+    target_compile_definitions(projectMSDL_testcorelib_norenderloop PRIVATE
+        AUDIO_IMPL_HEADER="AudioCaptureImpl_WASAPI.h"
+        USE_GLEW
+    )
+else()
+    target_sources(projectMSDL_testcorelib_norenderloop PRIVATE
+        ${PROJECT_SOURCE_DIR}/src/AudioCaptureImpl_SDL.cpp
+    )
+    target_compile_definitions(projectMSDL_testcorelib_norenderloop PRIVATE
+        AUDIO_IMPL_HEADER="AudioCaptureImpl_SDL.h"
+    )
+endif()
+
+# Headers from the production source tree
+target_include_directories(projectMSDL_testcorelib_norenderloop
+    PUBLIC
+    ${PROJECT_SOURCE_DIR}/src
+)
+
+# Compile definitions that are commonly referenced
+target_compile_definitions(projectMSDL_testcorelib_norenderloop
+    PRIVATE
+    PROJECTMSDL_CONFIG_LOCATION="${DEFAULT_CONFIG_PATH}"
+    PROJECTMSDL_VERSION="${PROJECT_VERSION}"
+)
+
+# Linker set (add to this only when the linker asks)
+target_link_libraries(projectMSDL_testcorelib_norenderloop
+    PRIVATE
+    SDL2::SDL2
+    Poco::Util
+    Poco::Foundation
+    ProjectMSDL-GUI
+    ProjectMSDL-Notifications
+    libprojectM::playlist
+)
+
+# ======
+# Actual test subdirs 
+# Add to this when defining more testing directories
+# (To be kept in this file after integration of above code into src/CMakeLists.txt)
+# ======
+add_subdirectory(renderer)
+add_subdirectory(audio)
+add_subdirectory(cli)
+add_subdirectory(ui)