Add about window

Author: kblaschke

src/ProjectMWrapper.cpp

@@ -179,6 +179,20 @@ void ProjectMWrapper::ChangeBeatSensitivity(float value)
         new DisplayToastNotification(Poco::format("Beat Sensitivity: %.2hf", projectm_get_beat_sensitivity(_projectM))));
 }
 
+std::string ProjectMWrapper::ProjectMBuildVersion()
+{
+    return PROJECTM_VERSION_STRING;
+}
+
+std::string ProjectMWrapper::ProjectMRuntimeVersion()
+{
+    auto* projectMVersion = projectm_get_version_string();
+    std::string projectMRuntimeVersion(projectMVersion);
+    projectm_free_string(projectMVersion);
+
+    return projectMRuntimeVersion;
+}
+
 void ProjectMWrapper::PresetSwitchedEvent(bool isHardCut, unsigned int index, void* context)
 {
     auto that = reinterpret_cast<ProjectMWrapper*>(context);

src/ProjectMWrapper.h

@@ -63,6 +63,18 @@ class ProjectMWrapper : public Poco::Util::Subsystem
      */
     void ChangeBeatSensitivity(float value);
 
+    /**
+     * @brief Returns the libprojectM version this application was built against.
+     * @return A string with the libprojectM build version.
+     */
+    std::string ProjectMBuildVersion();
+
+    /**
+     * @brief Returns the libprojectM version this applications currently runs with.
+     * @return A string with the libprojectM runtime library version.
+     */
+    std::string ProjectMRuntimeVersion();
+
 private:
     /**
      * @brief projectM callback. Called whenever a preset is switched.

src/gui/AboutWindow.cpp

@@ -0,0 +1,72 @@
+#include "AboutWindow.h"
+
+#include "ProjectMGUI.h"
+#include "SystemBrowser.h"
+
+#include "ProjectMSDLApplication.h"
+#include "ProjectMWrapper.h"
+
+#include <imgui.h>
+
+#include <Poco/Util/Application.h>
+
+AboutWindow::AboutWindow(ProjectMGUI& gui)
+    : _gui(gui)
+    , _application(ProjectMSDLApplication::instance())
+    , _projectMWrapper(Poco::Util::Application::instance().getSubsystem<ProjectMWrapper>())
+{
+}
+
+void AboutWindow::Show()
+{
+    _visible = true;
+}
+
+void AboutWindow::Draw()
+{
+    if (!_visible)
+    {
+        return;
+    }
+
+    ImGui::SetNextWindowSize(ImVec2(750, 600), ImGuiCond_FirstUseEver);
+    if (ImGui::Begin("About the projectM SDL Frontend", &_visible, ImGuiWindowFlags_NoCollapse))
+    {
+        _gui.PushToastFont();
+        ImGui::TextUnformatted("projectM SDL Frontend");
+        _gui.PopFont();
+        ImGui::Dummy({.0f, 10.0f});
+        ImGui::Text("Version: %s", PROJECTMSDL_VERSION);
+        ImGui::Text("libprojectM: %s (built with %s)", _projectMWrapper.ProjectMRuntimeVersion().c_str(), _projectMWrapper.ProjectMBuildVersion().c_str());
+        ImGui::Dummy({.0f, 20.0f});
+        ImGui::TextUnformatted("Brought to you by the projectM Team and contributors!");
+        ImGui::Dummy({.0f, 10.0f});
+        ImGui::Separator();
+        ImGui::Dummy({.0f, 10.0f});
+        ImGui::TextWrapped("The projectM SDL frontend is open-source software licensed under the GNU General Public License, version 3.");
+        ImGui::Dummy({.0f, 10.0f});
+        ImGui::TextWrapped("Get the source code on GitHub or report an issue with the SDL frontend:");
+        if (ImGui::SmallButton("https://github.com/projectM-visualizer/frontend-sdl2"))
+        {
+            SystemBrowser::OpenURL("https://github.com/projectM-visualizer/frontend-sdl2");
+        }
+        ImGui::Dummy({.0f, 10.0f});
+        if (ImGui::CollapsingHeader("Open-Source Software Used in this Application"))
+        {
+            ImGui::TextUnformatted("Used in projectM SDL:");
+            ImGui::BulletText("libprojectM by The projectM Team (GNU LGPL v2.1)");
+            ImGui::BulletText("Simple DirectMedia Layer 2 (SDL) (zlib License)");
+            ImGui::BulletText("Dear ImGui by Omar Cornut and contributors (MIT)");
+            ImGui::BulletText("The POCO C++ Framework by Applied Informatics GmbH (MIT)");
+            ImGui::BulletText("FreeType 2 (FreeType License / GNU GPL v2)");
+
+            ImGui::Dummy({.0f, 10.0f});
+            ImGui::TextUnformatted("Via libprojectM:");
+            ImGui::BulletText("projectm-eval by The projectM Team (MIT)");
+            ImGui::BulletText("SOIL2 by Martín Lucas Golini (MIT-0)");
+            ImGui::BulletText("hlslparser by Unknown Worlds Entertainment, Inc. (MIT)");
+            ImGui::BulletText("OpenGL Mathematics (GLM) by G-Truc Creation (The Happy Bunny License)");
+        }
+    }
+    ImGui::End();
+}

src/gui/AboutWindow.h

@@ -0,0 +1,32 @@
+#pragma once
+
+#include <string>
+
+class ProjectMGUI;
+class ProjectMSDLApplication;
+class ProjectMWrapper;
+
+class AboutWindow
+{
+public:
+    explicit AboutWindow(ProjectMGUI& gui);
+
+    ~AboutWindow() = default;
+
+    /**
+     * @brief Displays the about window.
+     */
+    void Show();
+
+    /**
+     * @brief Draws the about window.
+     */
+    void Draw();
+
+private:
+    ProjectMGUI& _gui; //!< Reference to the projectM GUI instance
+    ProjectMSDLApplication& _application;
+    ProjectMWrapper& _projectMWrapper;
+
+    bool _visible{false};
+};

src/gui/CMakeLists.txt

@@ -1,12 +1,12 @@
 # Font embedding
-if(CMAKE_CROSSCOMPILING)
+if (CMAKE_CROSSCOMPILING)
     find_program(BINARY_TO_COMPRESSED_EXECUTABLE binary_to_compressed_c)
-    if(NOT BINARY_TO_COMPRESSED_EXECUTABLE)
+    if (NOT BINARY_TO_COMPRESSED_EXECUTABLE)
         message(FATAL_ERROR "Could not find host-executable \"binary_to_compressed_c\" tool. Add its location to CMAKE_PREFIX_PATH.")
-    endif()
-else()
+    endif ()
+else ()
     set(BINARY_TO_COMPRESSED_EXECUTABLE "$<TARGET_FILE:ImGuiBinaryToCompressedC>")
-endif()
+endif ()
 
 add_custom_command(OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/AnonymousProFont.h"
         COMMAND ${BINARY_TO_COMPRESSED_EXECUTABLE} "${CMAKE_SOURCE_DIR}/src/resources/AnonymousPro-Regular.ttf" AnonymousPro > "${CMAKE_CURRENT_BINARY_DIR}/AnonymousProFont.h"
@@ -21,19 +21,30 @@ add_custom_command(OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/LiberationSansFont.h"
 add_library(ProjectMSDL-GUI STATIC
         "${CMAKE_CURRENT_BINARY_DIR}/AnonymousProFont.h"
         "${CMAKE_CURRENT_BINARY_DIR}/LiberationSansFont.h"
+        AboutWindow.cpp
+        AboutWindow.h
         FileChooser.cpp
         FileChooser.h
+        HelpWindow.cpp
+        HelpWindow.h
         MainMenu.cpp
         MainMenu.h
         PresetSelection.cpp
         PresetSelection.h
         ProjectMGUI.cpp
         ProjectMGUI.h
+        SettingsWindow.cpp
+        SettingsWindow.h
+        SystemBrowser.cpp
+        SystemBrowser.h
         ToastMessage.cpp
         ToastMessage.h
-        HelpWindow.cpp HelpWindow.h SettingsWindow.cpp SettingsWindow.h
-        SystemBrowser.cpp
-        SystemBrowser.h)
+        )
+
+target_compile_definitions(ProjectMSDL-GUI
+        PRIVATE
+        PROJECTMSDL_VERSION="${PROJECT_VERSION}"
+        )
 
 target_include_directories(ProjectMSDL-GUI
         PUBLIC

src/gui/MainMenu.cpp

@@ -146,6 +146,7 @@ void MainMenu::Draw()
 
             if (ImGui::MenuItem("About projectM..."))
             {
+                _gui.ShowAboutWindow();
             }
 
             ImGui::Separator();

src/gui/ProjectMGUI.cpp

@@ -163,6 +163,7 @@ void ProjectMGUI::Draw()
     {
         _mainMenu.Draw();
         _settingsWindow.Draw();
+        _aboutWindow.Draw();
         _helpWindow.Draw();
     }
 
@@ -202,6 +203,11 @@ void ProjectMGUI::ShowSettingsWindow()
     _settingsWindow.Show();
 }
 
+void ProjectMGUI::ShowAboutWindow()
+{
+    _aboutWindow.Show();
+}
+
 void ProjectMGUI::ShowHelpWindow()
 {
     _helpWindow.Show();

src/gui/ProjectMGUI.h

@@ -1,5 +1,6 @@
 #pragma once
 
+#include "AboutWindow.h"
 #include "HelpWindow.h"
 #include "MainMenu.h"
 #include "ToastMessage.h"
@@ -93,6 +94,11 @@ class ProjectMGUI : public Poco::Util::Subsystem
      */
     void ShowSettingsWindow();
 
+    /**
+     * @brief Displays the about window.
+     */
+    void ShowAboutWindow();
+
     /**
      * @brief Displays the help window.
      */
@@ -118,6 +124,7 @@ class ProjectMGUI : public Poco::Util::Subsystem
 
     MainMenu _mainMenu{*this};
     SettingsWindow _settingsWindow{*this}; //!< The settings window.
+    AboutWindow _aboutWindow{*this}; //!< The about window.
     HelpWindow _helpWindow; //!< Help window with shortcuts and tips.
 
     std::unique_ptr<ToastMessage> _toast; //!< Current toast to be displayed.