Saturation & Brightness/Value Gain using Oklab color space (#1477)

* Imported Oklab reference implementation

* Add Okhsv conversions

* Fixed formatting error

* Add saturation and value gain to schemas

* Add english translation for saturation, value gain

* Created OkhsvTransform

* Make OkhsvTransform configurable

* Apply OkhvsTransform

* Clamped values during transform

* Precalculate isIdentity in OkhsvTransform

* Skip OkhsvTransform if it is the identity function

* Added changelog message

* Allow for full desaturation

* Imported recommended changes by LordGrey

* Fixed typo in constant

* Fixed anti-pattern in ok_color.h

* Correct indentions

* Correct remote-control

* Limited maximum gain settings to practical range

* Renane valueGain to brightnessGain for clarity and understanding

Co-authored-by: LordGrey <[email protected]>

Author: xkns

3RD_PARTY_LICENSES

@@ -1874,3 +1874,27 @@ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGES.
 
                      END OF TERMS AND CONDITIONS
+
+==========================================
+Oklab Color Space Reference Implementation
+==========================================
+
+Copyright (c) 2021 Björn Ottosson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

CHANGELOG.md

@@ -10,6 +10,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Added saturation gain and brightness/value gain as new color processing settings
+
 ### Changed
 
 ### Fixed
@@ -22,15 +24,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Allow to build a "light" version of Hyperion, i.e. no grabbers, or services like flat-/proto buffers, boblight, CEC
 - Allow to restart Hyperion via Systray
 - mDNS support for all platforms inkl. Windows (#740)
-- Forwarder: mDNS discovery support and ease of configuration of other Hyperion instances 
+- Forwarder: mDNS discovery support and ease of configuration of other Hyperion instances
 - Grabber: mDNS discovery for standalone grabbers
 - Grabber: Dynamic loading of the Dispmanx Grabber (#1418)
 - Flatbuffer/Protobuf are now able to receive RGBA data
 - Added the instance number as part of the logline (#910). In the UI Log the instance is presented as a readable name.
 - New language: Japanese
 
 ##### LED-Devices
-- Support retry attempts enabling devices, e.g. to open devices after network or a device itself got available (#1302). Fixes that devices got "stuck", if initial open failed e.g. for WLED, Hue 
+- Support retry attempts enabling devices, e.g. to open devices after network or a device itself got available (#1302). Fixes that devices got "stuck", if initial open failed e.g. for WLED, Hue
 - New UDP-DDP (Distributed Display Protocol) device to overcome the 490 LEDs limitation of UDP-RAW
 - mDNS discovery support and ease of configuration (Cololight, Nanoleaf, Philips-Hue, WLED, Yeelight); removes the need to configure IP-Address, as address is resolved automatically.
 - Allow to disable switching LEDs on during startup (#1390)
@@ -116,7 +118,7 @@ Note: Existing configurations are migrated to new structures automatically
 - Fixed hyperion-remote when sending multiple Hex-Colors with "Set Color" option
 - UI: Fixed "Selected Hyperion instance isn't running" issue (#1357)
 - Fixed Database migration version handling
-- Fixed Python ModuleNotFoundError (#1109) 
+- Fixed Python ModuleNotFoundError (#1109)
 
 ### Technical
 
@@ -135,7 +137,7 @@ We did not weaken security, but provide you with an easy to use script to switch
 ### Added:
 - Script to change the user Hyperion is executed with.
 To run Hyperion with root privileges (e.g. for WS281x) execute <br> `sudo updateHyperionUser -u root`
-- Gif effects can source Gifs via URLs in addition to local files as input 
+- Gif effects can source Gifs via URLs in addition to local files as input
 
 - System info screen: Added used config path and "is run under root/admin"
 - LED-Device enhancements
@@ -167,7 +169,7 @@ To run Hyperion with root privileges (e.g. for WS281x) execute <br> `sudo update
 - Escape XSS payload to avoid execution (#1292)
 - Include libqt5sql5-sqlite packaging dependency
 - Fixed embedded Python location (#1109)
- 
+
 - LED-Devices
   - Fixed Philips Hue wizard (#1276)
   - Fixed AtmoOrb wizard
@@ -193,12 +195,12 @@ The refined color coding in the user-interfaces, helps you to quickly identify i
 
 Of course, the release brings new features (e.g. USB Capture on Windows), as well as minor enhancements and a good number of fixes.
 
-Note: 
+Note:
 
 - **IMPORTANT:** Due to the rework of the grabbers, both screen- and video grabbers are disabled after the upgrade to the new version.
 Please, re-enable the grabber of choice via the UI, validate the configuration and save the setup. The grabber should the restart.
 
-- Hyperion packages can now be installed under Ubuntu (x64) and Debian (amd64/armhf) (incl. Raspberry Pi OS) via our own APT server. 
+- Hyperion packages can now be installed under Ubuntu (x64) and Debian (amd64/armhf) (incl. Raspberry Pi OS) via our own APT server.
 Details about the installation can be found in the [installation.md](https://github.com/hyperion-project/hyperion.ng/blob/master/Installation.md) and at [apt.hyperion-project.org](apt.hyperion-project.org).
 - Find here more details on [supported platforms and configuration sets](https://github.com/hyperion-project/hyperion.ng/blob/master/doc/development/SupportedPlatforms.md)
 

assets/webconfig/i18n/en.json

@@ -88,16 +88,16 @@
     "conf_leds_layout_cl_leftbottom": "Left 50% - 100% Bottom",
     "conf_leds_layout_cl_leftmiddle": "Left 25% - 75% Middle",
     "conf_leds_layout_cl_lefttop": "Left 0% - 50% Top",
-    "conf_leds_layout_cl_lightPosBottomLeft14": "Bottom: 0  - 25%  from Left", 
+    "conf_leds_layout_cl_lightPosBottomLeft14": "Bottom: 0  - 25%  from Left",
     "conf_leds_layout_cl_lightPosBottomLeft12": "Bottom: 25 - 50%  from Left",
     "conf_leds_layout_cl_lightPosBottomLeft34": "Bottom: 50 - 75%  from Left",
     "conf_leds_layout_cl_lightPosBottomLeft11": "Bottom: 75 - 100% from Left",
-    "conf_leds_layout_cl_lightPosBottomLeft112": "Bottom: 0  - 50%  from Left",   
+    "conf_leds_layout_cl_lightPosBottomLeft112": "Bottom: 0  - 50%  from Left",
     "conf_leds_layout_cl_lightPosBottomLeft121": "Bottom: 50 - 100% from Left",
     "conf_leds_layout_cl_lightPosBottomLeftNewMid": "Bottom: 25  - 75%  from Left",
-    "conf_leds_layout_cl_lightPosTopLeft112": "Top: 0  - 50%  from Left",   
+    "conf_leds_layout_cl_lightPosTopLeft112": "Top: 0  - 50%  from Left",
     "conf_leds_layout_cl_lightPosTopLeft121": "Top: 50 - 100% from Left",
-    "conf_leds_layout_cl_lightPosTopLeftNewMid": "Top: 25  - 75%  from Left",    
+    "conf_leds_layout_cl_lightPosTopLeftNewMid": "Top: 25  - 75%  from Left",
     "conf_leds_layout_cl_overlap": "Overlap",
     "conf_leds_layout_cl_reversdir": "Reverse direction",
     "conf_leds_layout_cl_right": "Right",
@@ -284,6 +284,10 @@
     "edt_conf_color_magenta_title": "Magenta",
     "edt_conf_color_red_expl": "The calibrated red value.",
     "edt_conf_color_red_title": "Red",
+    "edt_conf_color_saturationGain_expl": "Adjusts the saturation of colors. 1.0 means no change, over 1.0 increases saturation, under 1.0 desaturates.",
+    "edt_conf_color_saturationGain_title": "Saturation gain",
+    "edt_conf_color_brightnessGain_expl": "Adjusts the brightness of colors. 1.0 means no change, over 1.0 increases brightness, under 1.0 decreases brightness.",
+    "edt_conf_color_brightnessGain_title": "Brightness gain",
     "edt_conf_color_white_expl": "The calibrated white value.",
     "edt_conf_color_white_title": "White",
     "edt_conf_color_yellow_expl": "The calibrated yellow value.",
@@ -551,7 +555,7 @@
     "edt_dev_spec_brightnessOverwrite_title": "Overwrite brightness",
     "edt_dev_spec_brightnessThreshold_title": "Signal detection brightness minimum",
     "edt_dev_spec_brightness_title": "Brightness",
-    "edt_dev_spec_candyGamma_title" : "'Candy' mode (double gamma correction)",    
+    "edt_dev_spec_candyGamma_title" : "'Candy' mode (double gamma correction)",
     "edt_dev_spec_chanperfixture_title": "Channels per Fixture",
     "edt_dev_spec_cid_title": "CID",
     "edt_dev_spec_clientKey_title": "Clientkey",
@@ -862,7 +866,7 @@
     "general_speech_fr": "French",
     "general_speech_hu": "Hungarian",
     "general_speech_it": "Italian",
-    "general_speech_ja": "Japanese",    
+    "general_speech_ja": "Japanese",
     "general_speech_nb": "Norwegian (Bokmål)",
     "general_speech_nl": "Dutch",
     "general_speech_pl": "Polish",

assets/webconfig/js/content_remote.js

@@ -56,10 +56,20 @@ $(document).ready(function () {
         });
       }
       else {
-        if (sColor[key].key == "brightness" || sColor[key].key == "brightnessCompensation" || sColor[key].key == "backlightThreshold")
-          property = '<div class="input-group"><input id="cr_' + sColor[key].key + '" type="number" class="form-control" min="0" max="100" step="10" value="' + value + '"/><span class="input-group-addon">' + $.i18n("edt_append_percent") + '</span></div>';
-        else
+        if (sColor[key].key == "brightness" ||
+          sColor[key].key == "brightnessCompensation" ||
+          sColor[key].key == "backlightThreshold" ||
+          sColor[key].key == "saturationGain" ||
+          sColor[key].key == "brightnessGain") {
+
+          property = '<input id="cr_' + sColor[key].key + '" type="number" class="form-control" min="' + sColor[key].minimum + '" max="' + sColor[key].maximum + '" step="' + sColor[key].step + '" value="' + value + '"/>';
+          if (sColor[key].append === "edt_append_percent") {
+            property = '<div class="input-group">' + property + '<span class="input-group-addon">' + $.i18n("edt_append_percent") + '</span></div>';
+          }
+        }
+        else {
           property = '<input id="cr_' + sColor[key].key + '" type="number" class="form-control" min="0.1" max="4.0" step="0.1" value="' + value + '"/>';
+        }
 
         $('.crtbody').append(createTableRow([title, property], false, true));
         $('#cr_' + sColor[key].key).off().on('change', function (e) {
@@ -134,7 +144,7 @@ $(document).ready(function () {
           owner = $.i18n('remote_color_label_color') + '  ' + '<div style="width:18px; height:18px; border-radius:20px; margin-bottom:-4px; border:1px grey solid; background-color: rgb(' + value + '); display:inline-block" title="RGB: (' + value + ')"></div>';
           break;
         case "IMAGE":
-          owner = $.i18n('remote_effects_label_picture') + (owner !== undefined ? ('  ' + owner): "");
+          owner = $.i18n('remote_effects_label_picture') + (owner !== undefined ? ('  ' + owner) : "");
           break;
         case "GRABBER":
           owner = $.i18n('general_comp_GRABBER') + ': (' + owner + ')';
@@ -153,8 +163,7 @@ $(document).ready(function () {
           break;
       }
 
-      if (!(duration && duration < 0))
-      {
+      if (!(duration && duration < 0)) {
         if (duration && compId != "GRABBER" && compId != "FLATBUFSERVER" && compId != "PROTOSERVER")
           owner += '<br/><span style="font-size:80%; color:grey;">' + $.i18n('remote_input_duration') + ' ' + duration.toFixed(0) + $.i18n('edt_append_s') + '</span>';
 
@@ -386,7 +395,6 @@ $(document).ready(function () {
     $('#effect_row').hide();
   }
 
-
   // interval updates
 
   $(window.hyperion).on('components-updated', function (e, comp) {
@@ -415,3 +423,4 @@ $(document).ready(function () {
 
   removeOverlay();
 });
+

config/hyperion.config.json.default

@@ -46,7 +46,9 @@
 				"backlightThreshold"  : 0,
 				"backlightColored"  : false,
 				"brightness" : 100,
-				"brightnessCompensation" : 100
+				"brightnessCompensation" : 100,
+				"saturationGain" : 1.0,
+				"brightnessGain" : 1.0
 			}
 		]
 	},