Hey Harry,
Thank you and Simon for this great document. Really happy about it, but
obviously I've got a few notes and questions inline.
On Fri, Sep 08, 2023 at 11:02:26AM -0400, Harry Wentland wrote:
> Signed-off-by: Harry Wentland <harry.wentland@xxxxxxx>
> Cc: Ville Syrjala <ville.syrjala@xxxxxxxxxxxxxxx>
> Cc: Pekka Paalanen <pekka.paalanen@xxxxxxxxxxxxx>
> Cc: Simon Ser <contact@xxxxxxxxxxx>
> Cc: Harry Wentland <harry.wentland@xxxxxxx>
> Cc: Melissa Wen <mwen@xxxxxxxxxx>
> Cc: Jonas Ådahl <jadahl@xxxxxxxxxx>
> Cc: Sebastian Wick <sebastian.wick@xxxxxxxxxx>
> Cc: Shashank Sharma <shashank.sharma@xxxxxxx>
> Cc: Alexander Goins <agoins@xxxxxxxxxx>
> Cc: Joshua Ashton <joshua@xxxxxxxxx>
> Cc: Michel Dänzer <mdaenzer@xxxxxxxxxx>
> Cc: Aleix Pol <aleixpol@xxxxxxx>
> Cc: Xaver Hugl <xaver.hugl@xxxxxxxxx>
> Cc: Victoria Brekenfeld <victoria@xxxxxxxxxxxx>
> Cc: Daniel Vetter <daniel@xxxxxxxx>
> Cc: Uma Shankar <uma.shankar@xxxxxxxxx>
> Cc: Naseer Ahmed <quic_naseer@xxxxxxxxxxx>
> Cc: Christopher Braga <quic_cbraga@xxxxxxxxxxx>
> ---
> Documentation/gpu/rfc/color_pipeline.rst | 278 +++++++++++++++++++++++
> 1 file changed, 278 insertions(+)
> create mode 100644 Documentation/gpu/rfc/color_pipeline.rst
>
> diff --git a/Documentation/gpu/rfc/color_pipeline.rst b/Documentation/gpu/rfc/color_pipeline.rst
> new file mode 100644
> index 000000000000..bfa4a8f12087
> --- /dev/null
> +++ b/Documentation/gpu/rfc/color_pipeline.rst
> @@ -0,0 +1,278 @@
> +========================
> +Linux Color Pipeline API
> +========================
> +
> +What problem are we solving?
> +============================
> +
> +We would like to support pre-, and post-blending complex color transformations
> +in order to allow for HW-supported HDR use-cases, as well as to provide support
> +to color-managed applications, such as video or image editors.
> +
> +While it is possible to support an HDR output on HW supporting the Colorspace
> +and HDR Metadata drm_connector properties that requires the compositor or
> +application to render and compose the content into one final buffer intended for
> +display. Doing so is costly.
> +
> +Most modern display HW offers various 1D LUTs, 3D LUTs, matrices, and other
> +operations to support color transformations. These operations are often
> +implemented in fixed-function HW and therefore much more power efficient than
> +performing similar operations via shaders or CPU.
> +
> +We would like to make use of this HW functionality to support complex color
> +transformations with no, or minimal CPU or shader load.
> +
> +
> +How are other OSes solving this problem?
> +========================================
> +
> +The most widely supported use-cases regard HDR content, whether video or
> +gaming.
> +
> +Most OSes will specify the source content format (color gamut, encoding transfer
> +function, and other metadata, such as max and average light levels) to a driver.
> +Drivers will then program their fixed-function HW accordingly to map from a
> +source content buffer's space to a display's space.
> +
> +When fixed-function HW is not available the compositor will assemble a shader to
> +ask the GPU to perform the transformation from the source content format to the
> +display's format.
> +
> +A compositor's mapping function and a driver's mapping function are usually
> +entirely separate concepts. On OSes where a HW vendor has no insight into
> +closed-source compositor code such a vendor will tune their color management
> +code to visually match the compositor's. On other OSes, where both mapping
> +functions are open to an implementer they will ensure both mappings match.
> +
> +
> +Why is Linux different?
> +=======================
> +
> +Unlike other OSes, where there is one compositor for one or more drivers, on
> +Linux we have a many-to-many relationship. Many compositors; many drivers.
> +In addition each compositor vendor or community has their own view of how
> +color management should be done. This is what makes Linux so beautiful.
> +
> +This means that a HW vendor can now no longer tune their driver to one
> +compositor, as tuning it to one will almost inevitably make it look very
> +different from another compositor's color mapping.
> +
> +We need a better solution.
> +
> +
> +Descriptive API
> +===============
> +
> +An API that describes the source and destination colorspaces is a descriptive
> +API. It describes the input and output color spaces but does not describe
> +how precisely they should be mapped. Such a mapping includes many minute
> +design decision that can greatly affect the look of the final result.
> +
> +It is not feasible to describe such mapping with enough detail to ensure the
> +same result from each implementation. In fact, these mappings are a very active
> +research area.
> +
> +
> +Prescriptive API
> +================
> +
> +A prescriptive API describes not the source and destination colorspaces. It
> +instead prescribes a recipe for how to manipulate pixel values to arrive at the
> +desired outcome.
> +
> +This recipe is generally an order straight-forward operations, with clear
> +mathematical definitions, such as 1D LUTs, 3D LUTs, matrices, or other
> +operations that can be described in a precise manner.
> +
> +
> +The Color Pipeline API
> +======================
> +
> +HW color management pipelines can significantly differ between HW
> +vendors in terms of availability, ordering, and capabilities of HW
> +blocks. This makes a common definition of color management blocks and
> +their ordering nigh impossible. Instead we are defining an API that
> +allows user space to discover the HW capabilities.
> +
> +
> +drm_colorop Object & IOCTLs
> +===========================
> +
> +To support the definition of color pipelines we introduce a new DRM core
> +object, a drm_colorop. Individual drm_colorop objects will be chained
> +via the NEXT property of a drm_colorop to constitute a color pipeline.
> +Each drm_colorop object is unique, i.e., even if multiple color
> +pipelines have the same operation they won't share the same drm_colorop
> +object to describe that operation.
> +
> +Just like other DRM objects the drm_colorop objects are discovered via
> +IOCTLs:
> +
> +DRM_IOCTL_MODE_GETCOLOROPRESOURCES: This IOCTL is used to retrieve the
> +number of all drm_colorop objects.
> +
> +DRM_IOCTL_MODE_GETCOLOROP: This IOCTL is used to read one drm_colorop.
> +It includes the ID for the colorop object, as well as the plane_id of
> +the associated plane. All other values should be registered as
> +properties.
> +
> +Each drm_colorop has three core properties:
We talked a bit about how forwards compatibility will look like. When a
driver introduces a new property that user space doesn't understand yet,
for user space to make use of the pipeline, the property either has to
have a bypass property, or some other kind of standard/core property
that promises that this property is purely informational and the
existance doesn't change the result of the color pipeline. Something
like "INFORMATIONAL" or "INFO" (better suggestions welcome!).
If a property doesn't fall into the two categories, the new pipeline
would be unusable for user space. So, if this new property is added on
an existing piece of hardware, it should be done on an entirely new
pipeline to avoid user space regressions.
I believe these compatibility considerations are very important to
document.
> +
> +TYPE: The type of transformation, such as
> +* enumerated curve
> +* custom (uniform) 1D LUT
> +* 3x3 matrix
> +* 3x4 matrix
> +* 3D LUT
> +* etc.
> +
> +Depending on the type of transformation other properties will describe
> +more details.
> +
> +BYPASS: A boolean property that can be used to easily put a block into
> +bypass mode. While setting other properties might fail atomic check,
> +setting the BYPASS property to true should never fail. This allows DRM
> +clients to fallback to other methods of color management if an atomic
> +check for KMS color operations fails.
This says BYPASS is a prop but in the example below the type property is
a mutable enum with Bypass being an enum variant.
Any reason why you chose to make the type property mutable instead of a
separate BYPASS property? Personally I like the simplicity of immutable
properties and would favor a BYPASS property.
> +
> +NEXT: The ID of the next drm_colorop in a color pipeline, or 0 if this
> +drm_colorop is the last in the chain.
> +
> +An example of a drm_colorop object might look like one of these::
> +
> + Color operation 42
> + ├─ "type": enum {Bypass, 1D curve} = 1D curve
> + ├─ "1d_curve_type": enum {LUT, sRGB, PQ, BT.709, HLG, …} = LUT
> + ├─ "lut_size": immutable range = 4096
> + ├─ "lut_data": blob
> + └─ "next": immutable color operation ID = 43
> +
> + Color operation 42
> + ├─ "type": enum {Bypass, 3D LUT} = 3D LUT
> + ├─ "lut_size": immutable range = 33
> + ├─ "lut_data": blob
> + └─ "next": immutable color operation ID = 43
> +
> + Color operation 42
> + ├─ "type": enum {Bypass, Matrix} = Matrix
> + ├─ "matrix_data": blob
> + └─ "next": immutable color operation ID = 43
> +
> +
> +COLOR_PIPELINE Plane Property
> +=============================
> +
> +Because we don't have existing KMS color properties in the pre-blending
> +portion of display pipelines (i.e. on drm_planes) we are introducing
> +color pipelines here first. Eventually we'll want to use the same
> +concept for the post-blending portion, i.e. drm_crtcs.
> +
> +Color Pipelines are created by a driver and advertised via a new
> +COLOR_PIPELINE enum property on each plane. Values of the property
> +always include '0', which is the default and means all color processing
> +is disabled. Additional values will be the object IDs of the first
Regarding the requirement to never fail atomic checks which set a
colorop to bypass: I think for user space it would be sufficient if
setting the entire pipeline to bypass would not fail the atomic check.
I'm also wondering if there is/will be hardware out there which always
does some kind of transformation which cannot be turned off. How would
they implement the '0' pipeline?
> +drm_colorop in a pipeline. A driver can create and advertise none, one,
> +or more possible color pipelines. A DRM client will select a color
> +pipeline by setting the COLOR PIPELINE to the respective value.
> +
> +In the case where drivers have custom support for pre-blending color
> +processing those drivers shall reject atomic commits that are trying to
> +set both the custom color properties, as well as the COLOR_PIPELINE
> +property.
By 'not setting the COLOR_PIPELINE property' you mean any value other
than '0' I guess? Should be fine to a proper user space.
> +
> +An example of a COLOR_PIPELINE property on a plane might look like this::
> +
> + Plane 10
> + ├─ "type": immutable enum {Overlay, Primary, Cursor} = Primary
> + ├─ …
> + └─ "color_pipeline": enum {0, 42, 52} = 0
> +
> +
> +Color Pipeline Discovery
> +========================
> +
> +A DRM client wanting color management on a drm_plane will:
> +
> +1. Read all drm_colorop objects
> +2. Get the COLOR_PIPELINE property of the plane
> +3. iterate all COLOR_PIPELINE enum values
> +4. for each enum value walk the color pipeline (via the NEXT pointers)
> + and see if the available color operations are suitable for the
> + desired color management operations
> +
> +An example of chained properties to define an AMD pre-blending color
> +pipeline might look like this::
> +
> + Plane 10
> + ├─ "type": immutable enum {Overlay, Primary, Cursor} = Primary
> + └─ "color_pipeline": enum {0, 42} = 0
> + Color operation 42 (input CSC)
> + ├─ "type": enum {Bypass, Matrix} = Matrix
> + ├─ "matrix_data": blob
> + └─ "next": immutable color operation ID = 43
> + Color operation 43
> + ├─ "type": enum {Scaling} = Scaling
> + └─ "next": immutable color operation ID = 44
> + Color operation 44 (DeGamma)
> + ├─ "type": enum {Bypass, 1D curve} = 1D curve
> + ├─ "1d_curve_type": enum {sRGB, PQ, …} = sRGB
> + └─ "next": immutable color operation ID = 45
> + Color operation 45 (gamut remap)
> + ├─ "type": enum {Bypass, Matrix} = Matrix
> + ├─ "matrix_data": blob
> + └─ "next": immutable color operation ID = 46
> + Color operation 46 (shaper LUT RAM)
> + ├─ "type": enum {Bypass, 1D curve} = 1D curve
> + ├─ "1d_curve_type": enum {LUT} = LUT
> + ├─ "lut_size": immutable range = 4096
> + ├─ "lut_data": blob
> + └─ "next": immutable color operation ID = 47
> + Color operation 47 (3D LUT RAM)
> + ├─ "type": enum {Bypass, 3D LUT} = 3D LUT
> + ├─ "lut_size": immutable range = 17
> + ├─ "lut_data": blob
> + └─ "next": immutable color operation ID = 48
> + Color operation 48 (blend gamma)
> + ├─ "type": enum {Bypass, 1D curve} = 1D curve
> + ├─ "1d_curve_type": enum {LUT, sRGB, PQ, …} = LUT
> + ├─ "lut_size": immutable range = 4096
> + ├─ "lut_data": blob
> + └─ "next": immutable color operation ID = 0
> +
> +
> +Color Pipeline Programming
> +==========================
> +
> +Once a DRM client has found a suitable pipeline it will:
> +
> +1. Set the COLOR_PIPELINE enum value to the one pointing at the first
> + drm_colorop object of the desired pipeline
> +2. Set the properties for all drm_colorop objects in the pipeline to the
> + desired values, setting BYPASS to true for unused drm_colorop blocks,
> + and false for enabled drm_colorop blocks
> +3. Perform atomic_check/commit as desired
> +
> +To configure the pipeline for an HDR10 PQ plane and blending in linear
> +space, a compositor might perform an atomic commit with the following
> +property values::
> +
> + Plane 10
> + └─ "color_pipeline" = 42
> + Color operation 42 (input CSC)
> + └─ "bypass" = true
> + Color operation 44 (DeGamma)
> + └─ "bypass" = true
> + Color operation 45 (gamut remap)
> + └─ "bypasse" = true
> + Color operation 46 (shaper LUT RAM)
> + └─ "bypass" = true
> + Color operation 47 (3D LUT RAM)
> + └─ "lut_data" = Gamut mapping + tone mapping + night mode
> + Color operation 48 (blend gamma)
> + └─ "1d_curve_type" = PQ inverse EOTF
> +
> +
> +References
> +==========
> +
> +1. https://lore.kernel.org/dri-devel/QMers3awXvNCQlyhWdTtsPwkp5ie9bze_hD5nAccFW7a_RXlWjYB7MoUW_8CKLT2bSQwIXVi5H6VULYIxCdgvryZoAoJnC5lZgyK1QWn488=@emersion.fr/
> \ No newline at end of file
> --
> 2.42.0
>
