Merge remote-tracking branch 'upstream/master' into feature/document-…

…raspi-netboot
LibreELEC · Oct 9, 2022 · ef8fb12 · ef8fb12
2 parents 7d72a31 + e214b5b
commit ef8fb12
Show file tree

Hide file tree

Showing 45 changed files with 1,101 additions and 261 deletions.
diff --git a/.gitbook.yaml b/.gitbook.yaml
@@ -4,6 +4,7 @@ redirects:
     how_to/add_firmware: how-to/add-firmware.md
     how_to/blacklist_module: how-to/add-firmware.md
     how_to/change_bootscreen: how-to/change-bootscreen.md
+    how_to/mount_network_share: how-to/mount_network_share.md
     how_to/provide_logfile: support/log-files.md
     infrared_remotes: configuration/ir-remotes.md
     libreelec: README.md

diff --git a/.gitbook/assets/image (3).png b/.gitbook/assets/image (3).png
diff --git a/.gitbook/assets/image (4) (1).png b/.gitbook/assets/image (4) (1).png
diff --git a/.gitbook/assets/image (4).png b/.gitbook/assets/image (4).png
diff --git a/.gitbook/assets/image (5).png b/.gitbook/assets/image (5).png
diff --git a/.gitbook/assets/image (6).png b/.gitbook/assets/image (6).png
diff --git a/.gitbook/assets/kodi-safe_1.png b/.gitbook/assets/kodi-safe_1.png
diff --git a/.gitbook/assets/kodi-safe_2.png b/.gitbook/assets/kodi-safe_2.png
diff --git a/.gitbook/assets/kodi-safe_3.png b/.gitbook/assets/kodi-safe_3.png
diff --git a/.gitbook/assets/kodi-safe_4.png b/.gitbook/assets/kodi-safe_4.png
diff --git a/.gitbook/assets/kodi-safe_5.png b/.gitbook/assets/kodi-safe_5.png
diff --git a/.gitbook/assets/wsl-website (1).png b/.gitbook/assets/wsl-website (1).png
diff --git a/.gitbook/assets/wsl-website.png b/.gitbook/assets/wsl-website.png
diff --git a/GLOSSARY.md b/GLOSSARY.md
@@ -0,0 +1,5 @@
+## PR
+Pull Request
+
+## V4L2
+Video4Linux2 (V4L2 for short) is the second version of Video4Linux (V4L).
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -16,19 +16,21 @@
 ## Hardware
 
 * [Allwinner](hardware/allwinner.md)
-* [Amlogic](hardware/amlogic.md)
-* [NXP \(iMX6\)](hardware/nxp-imx6.md)
-* [Intel x86-64 \(Generic\)](hardware/intel-x86-64-generic.md)
+* [Amlogic](hardware/amlogic/README.md)
+  * [LaFrite](hardware/amlogic/lafrite.md)
+* [NXP - iMX6/iMX8](hardware/nxp-imx6-im8.md)
+* [Intel x86-64 (Generic)](hardware/intel-x86-64-generic.md)
 * [Qualcomm](hardware/qualcomm.md)
 * [Raspberry Pi](hardware/raspberry-pi.md)
 * [Rockchip](hardware/rockchip.md)
-* [Samsung \(Exynos\)](hardware/samsung-exynos.md)
+* [Samsung (Exynos)](hardware/samsung-exynos.md)
 * [Virtual Image](hardware/virtual.md)
 
 ## Configuration
 
+* [4K / HDR](configuration/4k-hdr.md)
 * [Blu-Ray Playback](configuration/blu-ray.md)
-* [Config.txt](configuration/config_txt.md)
+* [Config.txt](configuration/config\_txt.md)
 * [Dual Boot](configuration/dual-boot.md)
 * [EDID](configuration/edid.md)
 * [Hypercon](configuration/hypercon.md)
@@ -37,8 +39,9 @@
 * [LCDProc](configuration/lcdproc.md)
 * [Network Boot](configuration/network-boot.md)
 * [Pulseaudio](configuration/pulseaudio.md)
+* [Safe Mode](configuration/safe-mode.md)
 * [Startup & Shutdown](configuration/startup-shutdown.md)
-* [Useful Scripts](configuration/useful_scripts.md)
+* [Useful Scripts](configuration/useful\_scripts.md)
 * [WireGuard](configuration/wireguard.md)
 
 ## How To
@@ -47,21 +50,27 @@
 * [Blacklist Kernel Module](how-to/blacklist-kernel-module.md)
 * [Change Bootsplash](how-to/change-bootscreen.md)
 * [Force Add-on Update](how-to/force-add-on-update.md)
+* [Mount Network Share](how-to/mount\_network\_share.md)
 
-## Development <a id="development-1"></a>
+## Development <a href="#development-1" id="development-1"></a>
 
-* [Building \(Basics\)](development-1/build-basics.md)
-* [Building \(Advanced\)](development-1/build-advanced.md)
+* [Building (Basics)](development-1/build-basics.md)
+* [Building (Docker)](development-1/build-docker.md)
+* [Building (Advanced)](development-1/build-advanced.md)
+* [Building (Windows WSL)](development-1/building-windows-wsl.md)
 * [Beginners Guide to Git](development-1/git-tutorial.md)
 * [Build Commands](development-1/build-commands/README.md)
-  * [Build Commands \(Add-ons\)](development-1/build-commands/build-addons.md)
+  * [Build Commands LE 11.0.x](development-1/build-commands/build-commands-le-11.0.x.md)
+  * [Build Commands (Add-ons)](development-1/build-commands/build-addons.md)
   * [Build Commands LE 10.0.x](development-1/build-commands/build-commands-le10.md)
   * [Build Commands LE 9.2.x](development-1/build-commands/build-commands-le92.md)
   * [Build Commands LE 9.0.x](development-1/build-commands/build-commands-le90.md)
   * [Build Commands LE 8.2.x](development-1/build-commands/build-commands-le82.md)
   * [Build Commands LE 8.0.x](development-1/build-commands/build-commands-le80.md)
   * [Build Commands LE 7.0.x](development-1/build-commands/build-commands-le70.md)
 * [Nightly Images](development-1/jenkins-ci.md)
+* [Release Management](development-1/release-management.md)
+* [Website](development-1/website.md)
 
 ## Project
 
@@ -71,4 +80,3 @@
   * [Source Code](project/license/source-code.md)
   * [Documentation](project/license/documentation.md)
 * [Mirrors](project/mirrors.md)
-
diff --git a/configuration/4k-hdr.md b/configuration/4k-hdr.md
@@ -0,0 +1,76 @@
+# 4K / HDR
+
+This page explains the configuration points:
+
+* Desktop Resolution
+* Modeline Whitelist
+* Adjust Refresh
+* Deinterlacing
+* HDR Questions
+
+### Desktop Resolution
+
+The primary impact of the Kodi desktop resolution is GUI performance, or how Kodi feels when you navigate around menus and libraries. Kodi leverages GPU hardware to accelerate rendering of GUI elements, but fanart and thumbnails are frequently adapted from original artwork on-the-fly as you scroll around, and even when all images have been pre-processed, they must still be read from disk caches before being displayed. Higher levels of CPU activity from larger artwork and media also mean higher power consumption from the HTPC device.
+
+The second impact of the Kodi desktop resolution is how media is scaled. If "Adjust Refresh" is not enabled, Kodi will scale all media played up or down to the desktop resolution and refresh rate, which by default is 1080p @ 60 fps. Scaling SD and 720p media to 1080p while adding extra frames to match 60fps is handled well, as Kodi simply needs to duplicate frames to reach the higher fps rate, and the simple scaling algorithms which Kodi uses to reduce artefacts in the upscaled image move smaller amounts of data in/out of memory. Hardware as low-spec as the first generation Raspberry Pi can normally manage this well.&#x20;
+
+Scaling SD and 1080p media to 4K is a literally bigger challenge. Frame sizes for 4K media are 4x the size of 1080p so the amount of data being processed in/out of memory increases and the CPU resources needed also increase. Scaling 4K to 1080p is a larger challenge again. Source 4K media has huge frame sizes and sophisticated (down)scaling algorithms are required to create a lossy image without massive visual artefacts.
+
+Higher-spec Intel CPU devices with recent Core i7 chips and SSD storage can normally run the Kodi GUI at 4K with 60fps refresh rates and scale media with reasonable quality, but older and lower-spec Intel CPU devices and anything running from a spinning HDD or removable USB/SD media will struggle with a 4K desktop, and ARM SoC devices simply fail as they don't have the memory bandwidth or CPU speeds to process the data volumes needed.
+
+However, all 4K resolution TV's have dedicated scaling hardware using sophisticated algorithms to upscale 1080p images to the native 4K resolution of the screen. TVs do this better and much more efficiently than Kodi can scale images itself.
+
+<mark style="color:red;">**Recommendation: Keep the Desktop resolution at 1080p, with 60fps refresh rate. Allow Kodi to upscale SD media to HD, and let the TV handle upscaling to 4K**</mark>
+
+### Mode Whitelist
+
+Most 4K televisions support a broad range of resolutions and refresh rates to support different media standards. In Linux each output format is known as a "modeline" and Kodi allows you to configure a list of allowed modes to use in combination with the "Adjust Refresh" option.
+
+Raspberry Pi 4 devices require specific configuration in config.txt to enable 4K @ 60/59.94/50 mode output, but nearly all streaming media uses 4K@30/23.976 modes so most users do not need to enable these modes. Enabling 4K60 output also increases power consumption.
+
+4K @ 60/59.94/50 modes require hardware that supports HDMI 2.0 or higher, and an HDMI cable that supports the higher bandwidth needed. Suitable cables are normally sold as 4K@60 "certified" cables. Cheaper and lower-spec cables that support HDMI 1.4 modes (up to 4K@30) are a frequent cause of "I enabled 4K@60 but have a blank screen" issue reports in the forums.
+
+Some hardware supports 4096x2160 modes. Kodi evaulates the whitelist using the height (2160) and refresh rate, so if you include these in your whitelist selection Kodi will switch to them instead of 3840x2160 modes which are an exact or more accurate match with 4K streaming media. If you see black bars on the sides of 4K media while playing, remove 4096 modes from the whitelist.
+
+<mark style="color:red;">**Recommendation: Configure Kodi to allow the following modes, if available:**</mark>
+
+* <mark style="color:red;">**3840x2160 @ 60/59.94/50/30/29.97/25/24/23.976**</mark>
+* <mark style="color:red;">**1920x1080 @ 60/59.94/50/24/23.976**</mark>
+
+### Adjust Refresh
+
+Kodi can either upscale media to match the desktop resolution and refresh rate, or automatically switch to a resolution and rate that exactly or better matches the media. Switching to match the rate can eliminate or minimse the need for Kodi to make corrections (to keep things in-sync) by adding or dropping frames. Adding frames to the stream is generally harmless and rarely causes noticable artefacts, but dropping frames causes skips, glitches and audio pops.
+
+Kodi has three "Adjust Refresh" settings:
+
+* Off (scale media to the dekstop resolution/rate)
+* On start/stop (change resolution/rate when playback starts and stops)
+* Allways (change on start/stop and during playback if the media changes resolution/rate)
+
+<mark style="color:red;">**Recommendation: Set the Adjust Refresh setting to "On Start/Stop"**</mark>
+
+### Deinterlacing
+
+4K media is progressive so this is not a requirement for 4K or HDR playback, but many Kodi users have DVB setups where interlaced streams are common so we need to set the mode whitelist to support them. The challenge with interlaced media is:
+
+* Kodi cannot output interlaced frames, it always outputs progressive frames
+* Kodi cannot detect media is interlaced until you start playing it
+
+Kodi converts interlaced media for progressive output by doubling the original refresh rate and rendering each half-frame in its own full frame, e.g. PAL 1080i @ 25fps media becomes 1080p @ 50fps, and NTSC 1080i @ 29.97 becomes 1080p @ 59.94fps. For this rate doubling to work, we need to ensure the whitelisted 1080p modes do not contain 1080p @ 25/29.97/30Hz rates, else Kodi will see an exact match against resolution and refresh rate and you will see high CPU loads and 50% of frames being dropped. If the modes are removed, Kodi will use 50Hz/59.94Hz rates, and if the media is interlaced, Kodi can still render 100% of the frames.
+
+<mark style="color:red;">**Recommendation: Remove 1080 @ 30, 29.97 and 25 fps rates from the Modelist**</mark>
+
+### HDR
+
+Broadcast and Internet media follow a multitude of formal standards for resolution, refresh-rate, bit-depth, video format and colour-space. HDR formats add static or dynamic metadata to the stream or even individual video frames to enhance how colours are displayed. Kodi on Linux can support HDR formats like HLG, HDR10, and HDR10+ but not proprietary formats like Dolby Vision which do not have open-source implementations. Users should understand HDR is not a simple "My TV can do 4K" type standard. HDR is a collection of competing technical standards (format wars are in progress) and the number of variables that must be determined and processed to render something nice looking on screen is huge.&#x20;
+
+Kodi aims to hide the mind-bending complexity of choosing how HDR media will be displayed on screen by detecting what your HTPC device and TV support and what the media to be played requires, allowing the display pipeline to automatically configure itself for the best result; whether that is an exact match or the best compromise. Kodi and LibreELEC support for HDR formats is still in early stages.
+
+<mark style="color:red;">**Recommendation: There is nothing specific to configure for HDR itself (only 4K things) so sit back and enjoy that Kodi and LibreELEC developers are working to bring HDR support to your living room, for free. Please be patient, because it's a long and complicated task!**</mark>&#x20;
+
+Here are some answers to common HDR questions:
+
+* Kodi does not (yet) support HDR to SDR conversion, known as tonemapping. If you play HDR media on a TV that does not support HDR, it will often play but colours will be muted and washed out. In the future Kodi may support conversion, but it is not currently implemented.
+* Kodi has no way to present OSD menus in SDR when playing HDR media, so menus will have bright saturated colours. In the future, plane based tonemapping may be able to correct this, but it is not currently implemented and not all hardware supports multiple planes.
+* Kodi will attempt to output in the highest bit-depth supported by the display pipeline, e.g. on a Raspberry Pi 4 it will attempt 12-bit before falling back to 10-bit, then 8-bit. Not all 4K HDR capable hardware supports higher 12-bit and 10-bit depths.
+* Kodi supports Dolby Vision under Android (if the device is licensed for it) but not Linux. Dolby requires manufacturers to license their Intellectual Property and use integration libraries to decode the HDR metadata. Until FFMpeg comes up with a "clean room" reverse engineered open-source implementation, Kodi will not support it.&#x20;
diff --git a/configuration/hyperion.md b/configuration/hyperion.md
@@ -1,6 +1,6 @@
 # Hyperion
 
-Hyperion requires some hardware and software configuration. For the software configuration pls head over to [Hypercon](hypercon.md). This page will describe the process to add Hyperion to Generic x86\_64 and Raspberry Pi hardware.
+[Hyperion](https://github.com/hyperion-project/hyperion) is an open source project that provides an ambient lighting system, compatiblie with Kodi. Hyperion requires hardware and software configuration. This page describes the process to add Hyperion to Generic x86\_64 and Raspberry Pi hardware. For software configuration please head over to [Hypercon](hypercon.md). 
 
 ## Adalight