refactor: Several random fixes + Experimental playground (#917)

CHANGELOG.md

@@ -140,7 +140,7 @@ If you used a `.deb` package please uninstall it before you upgrade
 - Resolve enable state for v4l and screen capture (#728)
 - Enable/Disable loops for components
 - Runs now on x86_64 LibreElec (missing libs) (#736)
-- Brightness componsation is now visible for configuration (#746)
+- Brightness compensation is now visible for configuration (#746)
 - Prevent malformed image size for effects with specific led layouts (#746)
 
 ### Changed:
@@ -170,7 +170,7 @@ If you used a `.deb` package please uninstall it before you upgrade
 - Smoothing comp state on startup (#685)
 - Azure GitHub release title (#686)
 - SSL/Avahi problems in previous release (#689)
-- WebUI Version Check to SemVer. Also addes "Alpha" Channel (#692)
+- WebUI Version Check to SemVer. Also adds "Alpha" Channel (#692)
 
 ### Removed
 - Travis CI tests (#684)

CMakeLists.txt

@@ -48,6 +48,7 @@ SET ( DEFAULT_USE_SYSTEM_FLATBUFFERS_LIBS OFF )
 SET ( DEFAULT_USE_SYSTEM_PROTO_LIBS       OFF )
 SET ( DEFAULT_USE_SYSTEM_MBEDTLS_LIBS     OFF )
 SET ( DEFAULT_TESTS                       OFF )
+SET ( DEFAULT_EXPERIMENTAL                OFF )
 
 IF ( ${CMAKE_SYSTEM} MATCHES "Linux" )
 	SET ( DEFAULT_V4L2        ON )
@@ -190,6 +191,9 @@ message(STATUS "ENABLE_TESTS = ${ENABLE_TESTS}")
 option(ENABLE_PROFILER "enable profiler capabilities - not for release code" OFF)
 message(STATUS "ENABLE_PROFILER = ${ENABLE_PROFILER}")
 
+option(ENABLE_EXPERIMENTAL "Compile experimental features" ${DEFAULT_EXPERIMENTAL})
+message(STATUS "ENABLE_EXPERIMENTAL = ${ENABLE_EXPERIMENTAL}")
+
 SET ( FLATBUFFERS_INSTALL_BIN_DIR ${CMAKE_BINARY_DIR}/flatbuf )
 SET ( FLATBUFFERS_INSTALL_LIB_DIR ${CMAKE_BINARY_DIR}/flatbuf )
 

CONTRIBUTING.md

@@ -94,13 +94,13 @@ Error( log_main, "oh to crazy, aborting");
 // quick logging, when only one message exists and want no typing overhead - or usage in static functions
 Info( Logger::getInstance("LedDevice"), "Leddevice %s started", "PublicStreetLighting");
 
-// a bit mor complex - with printf like format
+// a bit more complex - with printf like format
 Info( log_main, "hello %s, you have %d messages", "Dax", 25);
 
 // conditional messages
 WarningIf( (value>threshold), log_main, "Alert, your value is greater then %d", threshold );
 ```
-The amount of "%" mus match with following arguments
+The amount of "%" must match with following arguments
 
 #### The Placeholders
  - %s for strings (this are cstrings, when having std::string use myStdString.c_str() to convert)
@@ -110,7 +110,7 @@ The amount of "%" mus match with following arguments
 
 #### Log Level
   * Debug - used when message is more or less for the developer or for trouble shooting
-  * Info - used for not absolutly developer stuff messages for what's going on
+  * Info - used for not absolutely developer stuff messages for what's going on
   * Warning - warn if something is not as it should be, but didn't harm
   * Error - used when an error occurs
 
@@ -120,7 +120,7 @@ The amount of "%" mus match with following arguments
 > TODO
 
 ## Visual Studio Code
-**We assume that you sucessfully compiled Hyperion with the [Compile HowTo](CompileHowto.md) WITHOUT Docker** \
+**We assume that you successfully compiled Hyperion with the [Compile HowTo](CompileHowto.md) WITHOUT Docker** \
 If you want to use VSCode for development follow the steps.
 
 - Install [VSCode](https://code.visualstudio.com/). On Ubuntu 16.04+ you can also use the [Snapcraft VSCode](https://snapcraft.io/code) package.

HyperionConfig.h.in

@@ -42,6 +42,9 @@
 // Define to enable profiler for development purpose
 #cmakedefine ENABLE_PROFILER
 
+// Define to enable experimental features
+#cmakedefine ENABLE_EXPERIMENTAL
+
 // the hyperion build id string
 #define HYPERION_BUILD_ID "${HYPERION_BUILD_ID}"
 #define HYPERION_GIT_REMOTE "${HYPERION_GIT_REMOTE}"

bin/compile.sh

@@ -1,24 +1,46 @@
 #!/bin/sh
 
+# exit on error
+set -e
+
 TARGET=${1:-hyperion}
 CFG="${2:-Release}"
 INST="$( [ "${3:-}" = "install" ] && echo true || echo false )"
 
 sudo apt-get update
-sudo apt-get install git cmake build-essential qtbase5-dev libqt5serialport5-dev libusb-1.0-0-dev libturbojpeg0-dev python3-dev libcec-dev libxcb-util0-dev libxcb-randr0-dev libxrandr-dev libxrender-dev libavahi-core-dev libavahi-compat-libdnssd-dev libssl-dev libjpeg-dev libqt5sql5-sqlite zlib1g-dev || exit 1
+sudo apt-get install                 \
+	git                          \
+	cmake                        \
+	build-essential              \
+	qtbase5-dev                  \
+	libqt5serialport5-dev        \
+	libusb-1.0-0-dev             \
+	libturbojpeg0-dev            \
+	python3-dev                  \
+	libcec-dev                   \
+	libxcb-util0-dev             \
+	libxcb-randr0-dev            \
+	libxrandr-dev                \
+	libxrender-dev               \
+	libavahi-core-dev            \
+	libavahi-compat-libdnssd-dev \
+	libssl-dev                   \
+	libjpeg-dev                  \
+	libqt5sql5-sqlite            \
+	zlib1g-dev                   \
 
 if [ -e /dev/vc-cma -a -e /dev/vc-mem ]
 then
-	sudo apt-get install libraspberrypi-dev || exit 1
+	sudo apt-get install libraspberrypi-dev
 fi
 
-git clone --recursive https://github.com/hyperion-project/hyperion.ng.git ${TARGET} || exit 1
+git clone --recursive https://github.com/hyperion-project/hyperion.ng.git ${TARGET}
 
 rm -rf $TARGET/build
-mkdir -p $TARGET/build           || exit 1
-cd $TARGET/build                 || exit 1
-cmake -DCMAKE_BUILD_TYPE=$CFG .. || exit 1
-make -j $(nproc)                 || exit 1
+mkdir -p $TARGET/build
+cd $TARGET/build
+cmake -DCMAKE_BUILD_TYPE=$CFG ..
+make -j $(nproc)
 
 # optional: install into your system
 $INST && sudo make install/strip

config/hyperion.config.json.commented

@@ -109,8 +109,8 @@
 	///  * cropRight            : Cropping from the right [default=0]
 	///  * cropTop              : Cropping from the top [default=0]
 	///  * cropBottom           : Cropping from the bottom [default=0]
-	///  * signalDetection      : enable/disable signal detection [default=true]
-	///  * cecDetection         : enable/disable cec detection [default=true]
+	///  * signalDetection      : enable/disable signal detection [default=false]
+	///  * cecDetection         : enable/disable cec detection [default=false]
 	///  * redSignalThreshold   : Signal threshold for the red channel between 0 and 100 [default=5]
 	///  * greenSignalThreshold : Signal threshold for the green channel between 0 and 100 [default=5]
 	///  * blueSignalThreshold  : Signal threshold for the blue channel between 0 and 100 [default=5]

libsrc/CMakeLists.txt

@@ -27,3 +27,8 @@ endif()
 if(ENABLE_AVAHI)
 	add_subdirectory(bonjour)
 endif()
+
+if(ENABLE_EXPERIMENTAL)
+	add_subdirectory(experimental)
+endif()
+