Re-make build system + add CI + fix showstopper bugs (fixes #1) (#2)

* CMake: Re-write build system to be standalone

* actor_projectM.cpp: Fix projectM include for libprojectM.pc version 3.1.12

* Pass CMake's PROJECT_VERSION into live plug-in metadata

* Add multi-compiler GitHub Actions CI for build on Linux

* Make GitHub Dependabot keep our GitHub Actions up to date

* Only call projectM_resetGL when window size changed

* Fix new/delete mis-matches in lv_projectm_cleanup

* Fix keyboard event handling in lv_projectm_events

* Bump version to 2.1.1

Author: hartwork

.github/dependabot.yml

@@ -0,0 +1,15 @@
+# Copyright (c) 2023 Sebastian Pipping <[email protected]>
+# Licensed under GPL v3 or later
+
+version: 2
+updates:
+
+  - package-ecosystem: "github-actions"
+    commit-message:
+      include: "scope"
+      prefix: "Actions"
+    directory: "/"
+    labels:
+      - "enhancement"
+    schedule:
+      interval: "weekly"

.github/workflows/linux.yml

@@ -0,0 +1,92 @@
+# Copyright (c) 2023 Sebastian Pipping <[email protected]>
+# Licensed under GPL v3 or later
+
+name: Build on Linux
+
+on:
+  pull_request:
+  push:
+  schedule:
+    - cron: '0 3 * * 5'  # Every Friday at 3am
+
+jobs:
+  linux:
+    name: Build (${{ matrix.cc }})
+    runs-on: ${{ matrix.runs-on }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - cc: gcc-11
+            cxx: g++-11
+            clang_major_version: null
+            clang_repo_suffix: null
+            runs-on: ubuntu-22.04
+          - cc: gcc-12
+            cxx: g++-12
+            clang_major_version: null
+            clang_repo_suffix: null
+            runs-on: ubuntu-22.04
+          - cc: clang-15
+            cxx: clang++-15
+            clang_major_version: 15
+            clang_repo_suffix: -15
+            runs-on: ubuntu-22.04
+          - cc: clang-16
+            cxx: clang++-16
+            clang_major_version: 16
+            clang_repo_suffix: -16
+            runs-on: ubuntu-22.04
+          - cc: clang-17
+            cxx: clang++-17
+            clang_major_version: 17
+            clang_repo_suffix:
+            runs-on: ubuntu-22.04
+    steps:
+      - name: Add Clang/LLVM repositories
+        if: "${{ contains(matrix.cxx, 'clang') }}"
+        run: |-
+          set -x
+          source /etc/os-release
+          wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
+          sudo add-apt-repository "deb http://apt.llvm.org/${UBUNTU_CODENAME}/ llvm-toolchain-${UBUNTU_CODENAME}${{ matrix.clang_repo_suffix }} main"
+
+      - name: Install build dependencies
+        run: |-
+          sudo apt-get update
+          sudo apt-get install --yes --no-install-recommends \
+            cmake \
+            libprojectm-dev \
+            libvisual-0.4-dev \
+            pkg-config
+
+      - name: Install build dependency Clang ${{ matrix.clang_major_version }}
+        if: "${{ contains(matrix.cxx, 'clang') }}"
+        run: |-
+          sudo apt-get install --yes --no-install-recommends -V \
+              clang-${{ matrix.clang_major_version }}
+
+      - name: Checkout Git branch
+        uses: actions/checkout@v3
+
+      - name: 'Configure with CMake'
+        run: |-
+          cmake_args=(
+            -DCMAKE_C_COMPILER="${{ matrix.cc }}"
+            -DCMAKE_CXX_COMPILER="${{ matrix.cxx }}"
+            -S ./
+            -B build/
+          )
+          set -x
+          cmake "${cmake_args[@]}"
+
+      - name: 'Build'
+        run: |-
+          set -x
+          make -C build -j$(nproc) VERBOSE=1
+
+      - name: 'Install'
+        run: |-
+          set -x -o pipefail
+          make -C build install DESTDIR="${PWD}"/ROOT/
+          find ROOT/ | sort | xargs ls -ld

CMakeLists.txt

@@ -0,0 +1,48 @@
+# Copyright (c) 2023 Sebastian Pipping <[email protected]>
+# Licensed under GPL v3 or later
+
+cmake_minimum_required(VERSION 3.6)
+# CMake features used that need more than CMake 3.0:
+# - pkg_get_variable needs >=3.4
+# - pkg_check_modules([..] IMPORTED_TARGET [..]) needs >=3.6
+
+project(libvisual-projectm VERSION 2.1.1)
+
+include(FindPkgConfig)
+
+pkg_check_modules(LIBVISUAL libvisual-0.4 REQUIRED IMPORTED_TARGET)
+pkg_get_variable(LIBVISUAL_PLUGINS_BASE_DIR libvisual-0.4 pluginsbasedir)
+set(LIBVISUAL_ACTOR_PLUGINS_DIR "${LIBVISUAL_PLUGINS_BASE_DIR}/actor")
+
+pkg_check_modules(LIBPROJECTM libprojectM REQUIRED IMPORTED_TARGET)
+pkg_get_variable(LIBPROJECTM_PREFIX libprojectM prefix)
+
+add_library(projectM_libvisual MODULE
+        src/actor_projectM.cpp
+        src/ConfigFile.cpp
+        src/ConfigFile.h
+        src/lvtoprojectM.h
+        )
+
+target_compile_definitions(projectM_libvisual
+        PRIVATE
+        PACKAGE_VERSION="${PROJECT_VERSION}"
+        PROJECTM_PREFIX="${LIBPROJECTM_PREFIX}"
+        )
+
+target_link_libraries(projectM_libvisual
+        PUBLIC
+        PkgConfig::LIBPROJECTM
+        PkgConfig::LIBVISUAL
+        )
+
+install(TARGETS projectM_libvisual
+        LIBRARY DESTINATION "${LIBVISUAL_ACTOR_PLUGINS_DIR}"
+        )
+
+message(STATUS "Configuration:")
+message(STATUS "  CMAKE_BUILD_TYPE:             \"${CMAKE_BUILD_TYPE}\"")
+message(STATUS "  CMAKE_INSTALL_PREFIX:         \"${CMAKE_INSTALL_PREFIX}\"")
+message(STATUS "  LIBPROJECTM_PREFIX:           \"${LIBPROJECTM_PREFIX}\"")
+message(STATUS "  LIBVISUAL_ACTOR_PLUGINS_DIR:  \"${LIBVISUAL_ACTOR_PLUGINS_DIR}\"")
+message(STATUS "  LIBVISUAL_PLUGINS_BASE_DIR:   \"${LIBVISUAL_PLUGINS_BASE_DIR}\"")

src/CMakeLists.txt

@@ -11,7 +11,7 @@
 #include <sys/types.h>
 
 #include <libvisual/libvisual.h>
-#include <projectM.hpp>
+#include <libprojectM/projectM.hpp>
 #include "lvtoprojectM.h"
 #include "ConfigFile.h"
 
@@ -66,7 +66,7 @@ extern "C" const VisPluginInfo *get_plugin_info (int *count)
     info[0].plugname = (char*)"projectM";
     info[0].name = (char*)"libvisual projectM";
     info[0].author = (char*)"Peter Sperl";
-    info[0].version = (char*)"1.1";
+    info[0].version = (char*)PACKAGE_VERSION;
     info[0].about = (char*)"projectM";
     info[0].help =  (char*)"";
 
@@ -121,10 +121,11 @@ extern "C" int lv_projectm_init (VisPluginData *plugin)
 extern "C" int lv_projectm_cleanup (VisPluginData *plugin)
 {
 	ProjectmPrivate *priv = (ProjectmPrivate*)visual_object_get_private (VISUAL_OBJECT (plugin));
+	visual_log_return_val_if_fail(priv != nullptr, -1);
 
 	/* Cleanup, and thus also free our private */
-	visual_mem_free (priv->PM);
-	visual_mem_free (priv);
+	delete priv->PM;
+	delete priv;
 	return 0;
 }
 
@@ -156,8 +157,16 @@ extern "C" int lv_projectm_dimension (VisPluginData *plugin, VisVideo *video, in
 	ProjectmPrivate *priv = (ProjectmPrivate*)visual_object_get_private (VISUAL_OBJECT (plugin));
 
 	visual_video_set_dimension (video, width, height);
+	
+	static int prev_width = 0;
+	static int prev_height = 0;
 
-	priv->PM->projectM_resetGL( width, height );
+	if (width != prev_width || height != prev_height) {
+		priv->PM->projectM_resetGL( width, height );
+
+		prev_width = width;
+		prev_height = height;
+	}
 
 	return 0;
 }
@@ -180,13 +189,21 @@ extern "C" int lv_projectm_events (VisPluginData *plugin, VisEventQueue *events)
 	  {
 	    switch (ev.type)
 	      {
-	      case VISUAL_EVENT_KEYUP:
+	      case VISUAL_EVENT_KEYDOWN:
 
 		evt = lv2pmEvent( ev.type );
 		key = lv2pmKeycode( ev.event.keyboard.keysym.sym );
 		mod = lv2pmModifier( ev.event.keyboard.keysym.mod );
 		priv->PM->key_handler(PROJECTM_KEYDOWN, key,mod);
 
+		break;
+	      case VISUAL_EVENT_KEYUP:
+
+		evt = lv2pmEvent( ev.type );
+		key = lv2pmKeycode( ev.event.keyboard.keysym.sym );
+		mod = lv2pmModifier( ev.event.keyboard.keysym.mod );
+		priv->PM->key_handler(PROJECTM_KEYUP, key,mod);
+
 		break;
 	      case VISUAL_EVENT_RESIZE:
 		lv_projectm_dimension (plugin, ev.event.resize.video,