summaryrefslogtreecommitdiffstats
path: root/DOCS
diff options
context:
space:
mode:
authorKacper Michajłow <kasper93@gmail.com>2023-08-29 10:21:35 +0200
committerNiklas Haas <github-daiK1o@haasn.dev>2023-08-29 20:58:44 +0200
commit3cf71fd7c7f5d4052b67ebdf11ff416a9beffbeb (patch)
treee327c7bad2b0a5168c4f178286170ea5081decfd /DOCS
parent38ac67308bfd40340182cd3a8d4d0ae8700773db (diff)
downloadmpv-3cf71fd7c7f5d4052b67ebdf11ff416a9beffbeb.tar.bz2
mpv-3cf71fd7c7f5d4052b67ebdf11ff416a9beffbeb.tar.xz
command: add hdr-metadata property
Diffstat (limited to 'DOCS')
-rw-r--r--DOCS/interface-changes.rst1
-rw-r--r--DOCS/man/input.rst48
2 files changed, 49 insertions, 0 deletions
diff --git a/DOCS/interface-changes.rst b/DOCS/interface-changes.rst
index d5d350ee86..db590e2a6f 100644
--- a/DOCS/interface-changes.rst
+++ b/DOCS/interface-changes.rst
@@ -51,6 +51,7 @@ Interface changes
- remove `auto-forced-only` property
- rename `--sub-forced-only` to `--sub-forced-events-only`
- remove `sub-forced-only-cur` property (`--sub-forced-events-only` is a replacement)
+ - add `hdr-metadata` property
--- mpv 0.36.0 ---
- add `--target-contrast`
- Target luminance value is now also applied when ICC profile is used.
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst
index d909066ace..a70318e449 100644
--- a/DOCS/man/input.rst
+++ b/DOCS/man/input.rst
@@ -2480,6 +2480,54 @@ Property list
"average-bpp" MPV_FORMAT_INT64
"alpha" MPV_FORMAT_STRING
+``hdr-metadata``
+ Video HDR metadata per frame, including peak detection result.
+ This has a number of sub-properties:
+
+ ``hdr-metadata/min-luma``
+ Minimum luminance, as reported by HDR10 metadata (in cd/m²)
+
+ ``hdr-metadata/max-luma``
+ Maximum luminance, as reported by HDR10 metadata (in cd/m²)
+
+ ``hdr-metadata/max-cll``
+ Maximum content light level, as reported by HDR10 metadata (in cd/m²)
+
+ ``hdr-metadata/max-fall``
+ Maximum frame average light level, as reported by HDR10 metadata (in cd/m²)
+
+ ``hdr-metadata/scene-max-r``
+ MaxRGB of a scene for R component, as reported by HDR10+ metadata (in cd/m²)
+
+ ``hdr-metadata/scene-max-g``
+ MaxRGB of a scene for G component, as reported by HDR10+ metadata (in cd/m²)
+
+ ``hdr-metadata/scene-max-b``
+ MaxRGB of a scene for B component, as reported by HDR10+ metadata (in cd/m²)
+
+ ``hdr-metadata/max-pq-y``
+ Maximum PQ luminance of a frame, as reported by peak detection (in PQ, 0-1)
+
+ ``hdr-metadata/avg-pq-y``
+ Average PQ luminance of a frame, as reported by peak detection (in PQ, 0-1)
+
+ When querying the property with the client API using ``MPV_FORMAT_NODE``,
+ or with Lua ``mp.get_property_native``, this will return a mpv_node with
+ the following contents:
+
+ ::
+
+ MPV_FORMAT_NODE_MAP
+ "min-luma" MPV_FORMAT_DOUBLE
+ "max-luma" MPV_FORMAT_DOUBLE
+ "max-cll" MPV_FORMAT_DOUBLE
+ "max-fall" MPV_FORMAT_DOUBLE
+ "scene-max-r" MPV_FORMAT_DOUBLE
+ "scene-max-g" MPV_FORMAT_DOUBLE
+ "scene-max-b" MPV_FORMAT_DOUBLE
+ "max-pq-y" MPV_FORMAT_DOUBLE
+ "avg-pq-y" MPV_FORMAT_DOUBLE
+
``dwidth``, ``dheight``
Video display size. This is the video size after filters and aspect scaling
have been applied. The actual video window size can still be different