Merge remote-tracking branch 'origin/osx-playback' into osx-playback

Author: jmcker

.jenkinsfile

@@ -424,7 +424,8 @@ pipeline {
                     }
                     environment {
                         HL_OS = "Linux"
-                        HL_DOX_UNDOCUMENTED_LIMIT = 25
+                        // 25 + 40: To ignore the HulaAudioError macros that are uncommented
+                        HL_DOX_UNDOCUMENTED_LIMIT = 65
                     }
 
                     steps {

CMakeLists.txt

@@ -4,8 +4,11 @@ cmake_minimum_required (VERSION 3.5)
 
 set (CMAKE_CXX_STANDARD 14)
 
-include (cmake/Qt5.cmake)
-include (cmake/Utility.cmake)
+# Make sure we can find our Find<package>.cmake files
+list (APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake")
+
+include (${CMAKE_CURRENT_LIST_DIR}/cmake/Qt5.cmake)
+include (${CMAKE_CURRENT_LIST_DIR}/cmake/Utility.cmake)
 
 # Version
 set (HL_VERSION_MAJOR 0)
@@ -36,18 +39,8 @@ if (WIN32 AND CMAKE_GENERATOR_PLATFORM MATCHES "x64")
     set (64BIT TRUE)
 endif ()
 
-set (HL_PACKAGE_TYPE ".tar.gz")
-if (WIN32 AND 64BIT)
-    set (HL_PACKAGE_TYPE "win64.exe")
-elseif (WIN32 AND NOT 64BIT)
-    set (HL_PACKAGE_TYPE "win32.exe")
-elseif (OSX)
-    set (HL_PACKAGE_TYPE ".dmg")
-elseif (EXISTS "/etc/debian_version")
-    set (HL_PACKAGE_TYPE ".deb")
-elseif (EXISTS "/etc/redhat-release")
-    set (HL_PACKAGE_TYPE ".rpm")
-endif ()
+# Configuration code for installers
+include (${CMAKE_CURRENT_LIST_DIR}/cmake/HulaInstall.cmake)
 
 # Global build options
 option (HL_BUILD_ONLY_AUDIO "Build only the audio library." OFF)
@@ -80,13 +73,6 @@ foreach (OUTPUTCONFIG ${CMAKE_CONFIGURATION_TYPES})
     set (CMAKE_ARCHIVE_OUTPUT_DIRECTORY_${OUTPUTCONFIG} ${CMAKE_BINARY_DIR}/lib/lib)
 endforeach ()
 
-# Set output for libs compiled with --target install
-# Allow override via -DCMAKE_INSTALL_PREFIX=blah
-if (CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT AND CMAKE_BUILD_TYPE MATCHES "Debug")
-    set (CMAKE_INSTALL_PREFIX ${CMAKE_BINARY_DIR}/lib CACHE PATH "Installation path" FORCE)
-    set (CMAKE_PREFIX_PATH ${CMAKE_BINARY_DIR}/lib CACHE PATH "" FORCE) # Should this be here?
-endif ()
-
 message (STATUS "System Platform: ${CMAKE_SYSTEM_NAME} ${CMAKE_GENERATOR_PLATFORM}")
 message (STATUS "Install Prefix: ${CMAKE_INSTALL_PREFIX}\n")
 
@@ -99,9 +85,6 @@ if (WIN32)
     list (APPEND HL_LIBRARIES winmm.lib ) # TODO: Add required windows libraries
 endif ()
 
-# Make sure we can find our Find<package>.cmake files
-list (APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake")
-
 
 
 
@@ -226,13 +209,21 @@ if (NOT HL_BUILD_ONLY_AUDIO)
     endif ()
 
     add_subdirectory (${PROJECT_SOURCE_DIR}/res/translations)
-    include (cmake/Translation.cmake)
+    include (${CMAKE_CURRENT_LIST_DIR}/cmake/Translation.cmake)
 
     if (HL_BUILD_EXAMPLES)
         add_subdirectory (examples)
     endif ()
 endif ()
 
+install (
+    DIRECTORY ${CMAKE_BINARY_DIR}/bin
+    DESTINATION .
+    USE_SOURCE_PERMISSIONS
+    PATTERN "*.ilk" EXCLUDE
+    PATTERN "*.pdb" EXCLUDE
+)
+
 
 
 
@@ -243,7 +234,7 @@ endif ()
 # Build settings for DEBUG builds only
 if (CMAKE_BUILD_TYPE MATCHES "Debug")
 
-    include (cmake/Testing.cmake)
+    include (${CMAKE_CURRENT_LIST_DIR}/cmake/Testing.cmake)
 
     # Test that only rely on the audio library
     create_test ("src/test/TestOSAudio.cpp" "" 3 FALSE FALSE)

README.md

@@ -1,7 +1,7 @@
 [![Jenkins Server Status](https://img.shields.io/badge/dynamic/json.svg?label=Jenkins%20Server&url=http%3A%2F%2Fwww.symboxtra.tk%2Fstatus.php%3Fservers%3Djenkins&query=%24..jenkins&colorB=0b7cbd)](http://jenkins.symboxtra.dynu.net "Jenkins Server Status")
 [![](https://jenkins.symboxtra.dynu.net/job/HulaLoop/job/master/badge/icon)](https://jenkins.symboxtra.dynu.net/job/HulaLoop/job/master/ "Jenkins Build Status")
-[![codecov](https://codecov.io/gh/jmcker/HulaLoop/branch/master/graph/badge.svg?token=okLfIHMeEf)](https://codecov.io/gh/jmcker/HulaLoop "Code Coverage Status")
-[![CodeFactor](https://www.codefactor.io/repository/github/jmcker/hulaloop/badge)](https://www.codefactor.io/repository/github/jmcker/hulaloop "Code Factor Grade")
+[![codecov](https://codecov.io/gh/symboxtra/HulaLoop/branch/master/graph/badge.svg?token=okLfIHMeEf)](https://codecov.io/gh/symboxtra/HulaLoop "Code Coverage Status")
+[![CodeFactor](https://www.codefactor.io/repository/github/symboxtra/hulaloop/badge)](https://www.codefactor.io/repository/github/symboxtra/hulaloop "Code Factor Grade")
 [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.opensource.org/licenses/GPL-3.0)
 
 # HulaLoop #
@@ -24,12 +24,21 @@ git submodule update --remote --merge
 
 
 #### Debian-based Linux ####
-Required:
+Check which version of Debian you have by running
 ```bash
-sudo apt install g++ build-essential cmake libgl1-mesa-dev libasound2-dev libsndfile-dev pavucontrol
+cat /etc/debian_version
 ```
 
-**IMPORTANT:** This application requires Qt 5.10+. This typically has to be installed using the Qt GUI installer since ```apt``` does not backport a recent enough version. Be sure to install the extra **Qt Charts** package as the GUI relies on it.
+If running Debian Stretch:
+```bash
+sudo apt install build-essential cmake libgl1-mesa-dev libasound2-dev libsndfile-dev pavucontrol
+```
+**IMPORTANT:** This application requires Qt 5.9.5+. This typically has to be installed using the Qt GUI installer since ```apt``` on Debian Stretch does not backport an up-to-date version. Be sure to install the extra **Qt Charts** package as the GUI relies on it.
+
+If running Debian Buster:
+```bash
+sudo apt install build-essential cmake libgl1-mesa-dev libasound2 libasound2-dev pavucontrol qt5-default libqt5charts5 libqt5quickcontrols2-5
+```
 
 If using GNOME (fixes system tray icons and notifications):
 ```bash
@@ -42,10 +51,10 @@ sudo apt install python-sphinx doxygen graphviz help2man
 python -m pip install --user recommonmark
 ```
 
-#### RPM-based Linux ####
+#### Redhat-based Linux ####
 Required:
 ```bash
-sudo dnf install gcc-c++ make cmake qt5-devel qt5-qtquickcontrols2-devel alsa-lib alsa-lib-devel
+sudo dnf install gcc-c++ make cmake qt5-devel qt5-qtcharts qt5-qtquickcontrols2-devel alsa-lib alsa-lib-devel
 ```
 
 To enable the system tray icon and notifications the ```Topicons plus``` extension must be installed via ```dnf``` and enabled under *Tweaks->Extensions*.
@@ -59,6 +68,11 @@ sudo dnf install python-sphinx doxygen graphviz help2man
 python -m pip install --user recommonmark
 ```
 
+If you want to generate RPM packages:
+```bash
+sudo dnf install rpm-build
+```
+
 #### OSX ####
 Install ```brew```:
 ```bash

cmake/HulaInstall.cmake

@@ -0,0 +1,78 @@
+set (CPACK_PACKAGE_NAME "HulaLoop")
+set (CPACK_PACKAGE_VENDOR "Symboxtra Software")
+set (CPACK_PACKAGE_CONTACT "[email protected]")
+set (CPACK_PACKAGE_HOMEPAGE_URL "https://hulaloop.readthedocs.io/")
+
+set (CPACK_PACKAGE_VERSION ${HL_VERSION_STR})
+set (CPACK_PACKAGE_FILE_NAME "hulaloop-setup-${HL_VERSION_STR}")
+set (CPACK_PACKAGE_DESCRIPTION_SUMMARY "Simple cross-platform audio loopback and recording.")
+set (CPACK_RESOURCE_FILE_LICENSE ${PROJECT_SOURCE_DIR}/res/eula.txt)
+
+set (HL_PACKAGE_TYPE ".tar.gz")
+if (WIN32 OR OSX)
+
+    set (CPACK_GENERATOR "IFW")
+    set (CPACK_IFW_VERBOSE ON)
+
+    if (WIN32 AND 64BIT)
+        set (HL_PACKAGE_TYPE "win64.exe")
+        set (CPACK_IFW_PACKAGE_ICON ${PROJECT_SOURCE_DIR}/res/logo/hulaloop-logo.ico)
+        set (CPACK_PACKAGE_FILE_NAME "hulaloop-setup-${HL_VERSION_STR}-win64")
+    elseif (WIN32 AND NOT 64BIT)
+        set (HL_PACKAGE_TYPE "win32.exe")
+        set (CPACK_IFW_PACKAGE_ICON ${PROJECT_SOURCE_DIR}/res/logo/hulaloop-logo.ico)
+        set (CPACK_PACKAGE_FILE_NAME "hulaloop-setup-${HL_VERSION_STR}-win32")
+    elseif (OSX)
+        set (HL_PACKAGE_TYPE ".dmg")
+        set (CPACK_IFW_PACKAGE_ICON ${PROJECT_SOURCE_DIR}/res/logo/hulaloop-logo.icns)
+    endif ()
+
+    set (CPACK_IFW_PACKAGE_TITLE "HulaLoop")
+    set (CPACK_IFW_PACKAGE_WIZARD_STYLE "Modern")
+    set (CPACK_IFW_PACKAGE_WINDOW_ICON ${PROJECT_SOURCE_DIR}/res/logo/hulaloop-logo.png)
+    set (CPACK_IFW_PACKAGE_WATERMARK ${PROJECT_SOURCE_DIR}/res/logo/hulaloop-header-small.png)
+    set (CPACK_IFW_PACKAGE_TITLE_COLOR "#f75c26")
+
+    set (CPACK_IFW_PACKAGE_START_MENU_DIRECTORY "HulaLoop")
+    set (CPACK_IFW_TARGET_DIRECTORY "@HomeDir@/HulaLoop")
+    set (CPACK_IFW_ADMIN_TARGET_DIRECTORY "@HomeDir@/HulaLoop")
+
+    set (CPACK_IFW_PACKAGE_CONTROL_SCRIPT ${PROJECT_SOURCE_DIR}/res/installer/ifwscript.qs)
+    set (CPACK_IFW_PACKAGE_MAINTENANCE_TOOL_NAME "hulaloop-uninstaller")
+    set (CPACK_IFW_PACKAGE_MAINTENANCE_TOOL_INI_FILE "hulaloop-uninstaller")
+
+    set (CPACK_IFW_PACKAGE_ALLOW_NON_ASCII_CHARACTERS OFF)
+
+elseif (EXISTS "/etc/debian_version")
+
+    set (HL_PACKAGE_TYPE ".deb")
+    set (CPACK_GENERATOR "DEB")
+
+    set (CPACK_DEBIAN_PACKAGE_DEPENDS "g++, build-essential, cmake, libgl1-mesa-dev, libasound2, libasound2-dev, pavucontrol, qt5-default, libqt5charts5, libqt5quickcontrols2-5")
+
+    # Install logo file and the desktop shortcut
+    configure_file (
+        "${PROJECT_SOURCE_DIR}/res/installer/hulaloop.desktop.in"
+        "${CMAKE_BINARY_DIR}/hulaloop.desktop"
+    )
+    install (FILES ${CMAKE_BINARY_DIR}/hulaloop.desktop DESTINATION /usr/share/applications)
+    install (FILES ${PROJECT_SOURCE_DIR}/res/logo/hulaloop-logo.svg DESTINATION /usr/share/icons/hicolor/scalable/apps)
+
+elseif (EXISTS "/etc/redhat-release")
+
+    set (HL_PACKAGE_TYPE ".rpm")
+    set (CPACK_GENERATOR "RPM")
+
+    set (CPACK_RPM_PACKAGE_REQUIRES "gcc-c++, make, cmake, qt5-devel, qt5-qtcharts, qt5-qtquickcontrols2-devel, alsa-lib, alsa-lib-devel")
+
+    # Install logo file and the desktop shortcut
+    configure_file (
+        "${PROJECT_SOURCE_DIR}/res/installer/hulaloop.desktop.in"
+        "${CMAKE_BINARY_DIR}/hulaloop.desktop"
+    )
+    install (FILES ${CMAKE_BINARY_DIR}/hulaloop.desktop DESTINATION /usr/share/applications)
+    install (FILES ${PROJECT_SOURCE_DIR}/res/logo/hulaloop-logo.svg DESTINATION /usr/share/icons/hicolor/scalable/apps)
+
+endif ()
+
+include (CPack)

cmake/Qt5.cmake

@@ -21,8 +21,15 @@ macro (qt5_post_build_windeployqt APP QMLDIR)
         message (FATAL_ERROR "\nCould not find windeployqt.\n")
     endif ()
 
+    set (TYPEDLL "")
+    # if (CMAKE_BUILD_TYPE MATCHES "Debug")
+    #     set (TYPEDLL "--debug")
+    # elseif (CMAKE_BUILD_TYPE MATCHES "Release")
+    #     set (TYPEDLL "--release")
+    # endif ()
+
     add_custom_command (TARGET ${APP} POST_BUILD
-        COMMAND ${WINDEPLOYQT_EXECUTABLE} --verbose 0 -qmldir ${QMLDIR} $<TARGET_FILE:${APP}>
+        COMMAND ${WINDEPLOYQT_EXECUTABLE} -verbose=0 -qmldir ${QMLDIR} ${TYPEDLL} $<TARGET_FILE:${APP}>
         WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
     )
 

cmake/Utility.cmake

@@ -51,15 +51,15 @@ function (add_library_target _name _src_files)
 
     # Copy the include directory
     install (DIRECTORY include/${_name}
-        DESTINATION ${CMAKE_INSTALL_PREFIX}/include
+        DESTINATION include
     )
 
     # Copy the library
     install (TARGETS ${_name}
-        RUNTIME DESTINATION ${CMAKE_INSTALL_PREFIX}/bin                               # DLLs
-        ARCHIVE DESTINATION ${CMAKE_INSTALL_PREFIX}/lib                               # Static libs
-        LIBRARY DESTINATION ${CMAKE_INSTALL_PREFIX}/lib                               # Shared libs (non-DLL)
-        PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_PREFIX}/include/${_name}  # Headers
+        RUNTIME DESTINATION bin                     # DLLs
+        ARCHIVE DESTINATION lib                     # Static libs
+        LIBRARY DESTINATION lib                     # Shared libs (non-DLL)
+        PUBLIC_HEADER DESTINATION include/${_name}  # Headers
         COMPONENT library
     )
 

docs/read-the-docs/source/readme.md

@@ -1,7 +1,7 @@
 [![Jenkins Server Status](https://img.shields.io/badge/dynamic/json.svg?label=Jenkins%20Server&url=http%3A%2F%2Fwww.symboxtra.tk%2Fstatus.php%3Fservers%3Djenkins&query=%24..jenkins&colorB=0b7cbd)](http://jenkins.symboxtra.dynu.net "Jenkins Server Status")
 [![](https://jenkins.symboxtra.dynu.net/job/HulaLoop/job/master/badge/icon)](https://jenkins.symboxtra.dynu.net/job/HulaLoop/job/master/ "Jenkins Build Status")
-[![codecov](https://codecov.io/gh/jmcker/HulaLoop/branch/master/graph/badge.svg?token=okLfIHMeEf)](https://codecov.io/gh/jmcker/HulaLoop "Code Coverage Status")
-[![CodeFactor](https://www.codefactor.io/repository/github/jmcker/hulaloop/badge)](https://www.codefactor.io/repository/github/jmcker/hulaloop "Code Factor Grade")
+[![codecov](https://codecov.io/gh/symboxtra/HulaLoop/branch/master/graph/badge.svg?token=okLfIHMeEf)](https://codecov.io/gh/symboxtra/HulaLoop "Code Coverage Status")
+[![CodeFactor](https://www.codefactor.io/repository/github/symboxtra/hulaloop/badge)](https://www.codefactor.io/repository/github/symboxtra/hulaloop "Code Factor Grade")
 [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.opensource.org/licenses/GPL-3.0)
 
 # HulaLoop #

install.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+mkdir build 
+cd build
+cmake .. -DGEN_INSTALL=true -DCMAKE_BUILD_TYPE=Release
+make -j
+cpack ..
+sudo dpkg -i HulaLoop.deb
+rm HulaLoop.deb
+cd ..