tobi/KDEAmbi
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Add original Hyperion.ng default parameters to algorithm documentation

Browse Source
This commit is contained in:
Tobias J. Endres 2025-08-16 06:14:12 +02:00
parent 10be323a3b
commit 03c08ff4c0
1 changed files with 53 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
docs/hyperion_processor_algorithm.md
View File

@ -61,4 +61,56 @@ The `grabberconfigurator` tool serves as a visual debugging and testing utility
3. **Test LED Mapping:** Observe how the `_ledMap` is generated and how the LED regions are defined on the screen content. The visualization outlines these regions.
4. **Evaluate Color Calculation:** Ultimately, this tool will allow us to see the final calculated LED colors in real-time, helping us fine-tune the color calculation algorithms and LED layout for the best Ambilight experience.
By breaking down the complex process into these observable steps, we can systematically develop and refine our Hyperion-like image processing capabilities.
By breaking down the complex process into these observable steps, we can systematically develop and refine our Hyperion-like image processing capabilities.
## Original Hyperion.ng Default Parameters
This section outlines the default configuration parameters used by the original Hyperion.ng project for its image processing and related functionalities, as defined in its schema files. These values represent the out-of-the-box behavior of Hyperion.ng when no custom configuration is provided.
### Black Border Detector Defaults (`schema-blackborderdetector.json`)
* **`enable`**: `true` - Whether black border detection is enabled by default.
* **`threshold`**: `5` (percentage) - The luminance threshold for detecting black borders. Pixels below this threshold are considered black.
* **`unknownFrameCnt`**: `600` - Number of frames to wait before re-evaluating black borders if the state is uncertain.
* **`borderFrameCnt`**: `50` - Number of consecutive frames required to confirm a stable black border state.
* **`maxInconsistentCnt`**: `10` - Maximum number of inconsistent frames allowed before re-evaluating black borders.
* **`blurRemoveCnt`**: `1` - Number of pixels to blur at the edges to remove artifacts before black border detection.
* **`mode`**: `"default"` - The black border detection mode. Other options include "classic", "osd", "letterbox".
### Smoothing Defaults (`schema-smoothing.json`)
* **`enable`**: `true` - Whether color smoothing is enabled by default.
* **`type`**: `"linear"` - The type of smoothing algorithm used. Other options include "decay".
* **`time_ms`**: `150` (milliseconds) - The time over which colors are smoothed.
* **`updateFrequency`**: `25.0` (Hz) - The frequency at which the smoothed colors are updated.
* **`interpolationRate`**: `1.0` (Hz) - The rate at which interpolation is performed (relevant for "decay" smoothing).
* **`decay`**: `1.0` - The decay factor for "decay" smoothing.
* **`dithering`**: `true` - Whether dithering is applied during smoothing.
* **`updateDelay`**: `0` (frames) - Number of frames to delay the update of smoothed colors.
### LED Configuration Defaults (`schema-leds.json`)
This schema defines the default sampling areas for individual LEDs. Note that the total number of LEDs on each side (bottom, right, top, left) is typically configured by the user and not set as a default here.
* **`hmin`**: `0` - Minimum horizontal sampling position (0.0 to 1.0, relative to content width).
* **`hmax`**: `0.1` - Maximum horizontal sampling position (0.0 to 1.0, relative to content width).
* **`vmin`**: `0` - Minimum vertical sampling position (0.0 to 1.0, relative to content height).
* **`vmax`**: `0.1` - Maximum vertical sampling position (0.0 to 1.0, relative to content height).
* **`colorOrder`**: No default specified in this schema. Possible values include "rgb", "bgr", "rbg", "brg", "gbr", "grb". The actual default might be "rgb" if not explicitly set, or determined by the device.
### Instance Capture Defaults (`schema-instCapture.json`)
These defaults relate to the screen/video grabber settings for a Hyperion instance.
* **`systemEnable`**: `false` - Whether the system grabber (e.g., X11, Wayland) is enabled by default.
* **`systemGrabberDevice`**: `"NONE"` - The default system grabber device.
* **`systemPriority`**: `250` - The default priority for the system grabber.
* **`screenInactiveTimeout`**: `5` (seconds) - Timeout after which the screen grabber becomes inactive if no changes are detected.
* **`v4lEnable`**: `false` - Whether V4L2 grabber is enabled by default.
* **`v4lGrabberDevice`**: `"NONE"` - The default V4L2 grabber device.
* **`v4lPriority`**: `240` - The default priority for the V4L2 grabber.
* **`videoInactiveTimeout`**: `1` (second) - Timeout after which the video grabber becomes inactive.
* **`audioEnable`**: `false` - Whether audio grabber is enabled by default.
* **`audioGrabberDevice`**: `"NONE"` - The default audio grabber device.
* **`audioPriority`**: `230` - The default priority for the audio grabber.
* **`audioInactiveTimeout`**: `1` (second) - Timeout after which the audio grabber becomes inactive.