HDR support on Windows (DirectX)

makefile

@@ -96,6 +96,10 @@ DEFS = \
 	-DUNICODE \
 	-DWIN32_LEAN_AND_MEAN
 
+!IFDEF D3D11_CTX_DEBUG
+DEFS = $(DEFS) -DD3D11_CTX_DEBUG
+!ENDIF
+
 FXCFLAGS = \
 	/O3 \
 	/Ges \

src/app.c

@@ -129,6 +129,14 @@ bool MTY_WindowSetGFX(MTY_App *app, MTY_Window window, MTY_GFX api, bool vsync)
 	return gfx_ctx ? true : false;
 }
 
+bool MTY_WindowIsHDRSupported(MTY_App *app, MTY_Window window)
+{
+	struct gfx_ctx *gfx_ctx = NULL;
+	MTY_GFX api = mty_window_get_gfx(app, window, &gfx_ctx);
+
+	return api != MTY_GFX_NONE && GFX_CTX_API[api].hdr_supported(gfx_ctx);
+}
+
 
 // Event utility
 

src/gfx/mod-ctx.h

@@ -31,7 +31,8 @@ struct gfx_ctx;
 	bool wrap(api, set_ui_texture)(struct gfx_ctx *gfx_ctx, uint32_t id, const void *rgba, \
 		uint32_t width, uint32_t height); \
 	bool wrap(api, has_ui_texture)(struct gfx_ctx *gfx_ctx, uint32_t id); \
-	bool wrap(api, make_current)(struct gfx_ctx *gfx_ctx, bool current);
+	bool wrap(api, make_current)(struct gfx_ctx *gfx_ctx, bool current); \
+	bool wrap(api, hdr_supported)(struct gfx_ctx *gfx_ctx);
 
 #define GFX_CTX_PROTOTYPES(api) \
 	GFX_CTX_DECLARE_API(api, GFX_CTX_PROTO)
@@ -49,4 +50,5 @@ struct gfx_ctx;
 		mty##api##ctx_set_ui_texture, \
 		mty##api##ctx_has_ui_texture, \
 		mty##api##ctx_make_current, \
+		mty##api##ctx_hdr_supported, \
 	},

src/matoya.h

@@ -58,21 +58,37 @@ typedef enum {
 
 /// @brief Raw image color formats.
 typedef enum {
-	MTY_COLOR_FORMAT_UNKNOWN  = 0, ///< Unknown color format.
-	MTY_COLOR_FORMAT_BGRA     = 1, ///< 8-bits per channel BGRA.
-	MTY_COLOR_FORMAT_NV12     = 2, ///< 4:2:0 full W/H Y plane followed by an interleaved half
-	                               ///<   W/H UV plane.
-	MTY_COLOR_FORMAT_I420     = 3, ///< 4:2:0 full W/H Y plane followed by a half W/H U plane
-	                               ///<   followed by a half W/H V plane.
-	MTY_COLOR_FORMAT_I444     = 4, ///< 4:4:4 full W/H consecutive Y, U, V planes.
-	MTY_COLOR_FORMAT_NV16     = 5, ///< 4:2:2 full W/H Y plane followed by an interleaved half W
-	                               ///<   full H UV plane.
-	MTY_COLOR_FORMAT_BGR565   = 6, ///< 5-bits blue, 6-bits green, 5-bits red.
-	MTY_COLOR_FORMAT_BGRA5551 = 7, ///< 5-bits per BGR channels, 1-bit alpha.
-	MTY_COLOR_FORMAT_AYUV     = 8, ///< 4:4:4 full W/H interleaved Y, U, V.
-	MTY_COLOR_FORMAT_MAKE_32 = INT32_MAX,
+	MTY_COLOR_FORMAT_UNKNOWN  = 0,  ///< Unknown color format.
+	MTY_COLOR_FORMAT_BGRA     = 1,  ///< 8-bits per channel BGRA.
+	MTY_COLOR_FORMAT_NV12     = 2,  ///< 4:2:0 full W/H Y plane followed by an interleaved half
+	                                ///<   W/H UV plane.
+	MTY_COLOR_FORMAT_I420     = 3,  ///< 4:2:0 full W/H Y plane followed by a half W/H U plane
+	                                ///<   followed by a half W/H V plane.
+	MTY_COLOR_FORMAT_I444     = 4,  ///< 4:4:4 full W/H consecutive Y, U, V planes.
+	MTY_COLOR_FORMAT_NV16     = 5,  ///< 4:2:2 full W/H Y plane followed by an interleaved half W
+	                                ///<   full H UV plane.
+	MTY_COLOR_FORMAT_BGR565   = 6,  ///< 5-bits blue, 6-bits green, 5-bits red.
+	MTY_COLOR_FORMAT_BGRA5551 = 7,  ///< 5-bits per BGR channels, 1-bit alpha.
+	MTY_COLOR_FORMAT_AYUV     = 8,  ///< 4:4:4 full W/H interleaved Y, U, V.
+	MTY_COLOR_FORMAT_Y410     = 9,  ///< 4:4:4 full W/H interleaved Y, U, V. 10-bit YUV, 2-bit alpha.
+	MTY_COLOR_FORMAT_P016     = 10, ///< 4:2:0 full W/H Y plane followed by a half W/H U plane
+	                                ///<   followed by a half W/H V plane. Supports 10-bit to 16-bit data.
+	MTY_COLOR_FORMAT_I444_10  = 11, ///< 4:4:4 full W/H consecutive Y, U, V planes. Supports 10-bit data.
+	MTY_COLOR_FORMAT_I444_16  = 12, ///< 4:4:4 full W/H consecutive Y, U, V planes. Supports 16-bit data.
+	MTY_COLOR_FORMAT_RGB10A2  = 13, ///< 10-bits per RGB channels, 2-bit alpha.
+	MTY_COLOR_FORMAT_RGBA16F  = 14, ///< 16-bits floating-point precision per channel RGBA.
+	MTY_COLOR_FORMAT_MAKE_32  = INT32_MAX,
 } MTY_ColorFormat;
 
+/// @brief Defines the color encoding of the raw image. Note that certain color spaces and color formats are tightly coupled with each other.
+typedef enum {
+	MTY_COLOR_SPACE_UNKNOWN      = 0, ///< Unknown color space.
+	MTY_COLOR_SPACE_SRGB         = 1, ///< sRGB/rec709 primaries and a non-linear transfer function (approx gamma curve of 2.2). Supported by all color formats.
+	MTY_COLOR_SPACE_SCRGB_LINEAR = 2, ///< Microsoft's scRGB wide gamut color space which is based on sRGB/rec709 primaries and has a linear transfer function. Only supported by color format MTY_COLOR_FORMAT_RGBA16F.
+	MTY_COLOR_SPACE_HDR10        = 3, ///< Uses the rec2020 color primaries and the rec2100 non-linear transfer function (ST 2084 perceptual quantizer, aka PQ). Only supported by color format MTY_COLOR_FORMAT_RGB10A2.
+	MTY_COLOR_SPACE_MAKE_32      = INT32_MAX,
+} MTY_ColorSpace;
+
 /// @brief Quad texture filtering.
 typedef enum {
 	MTY_FILTER_NEAREST        = 0, ///< Nearest neighbor filter by the GPU, can cause shimmering.
@@ -99,23 +115,39 @@ typedef enum {
 	MTY_ROTATION_MAKE_32 = INT32_MAX,
 } MTY_Rotation;
 
+/// @brief HDR metadata associated with an image being rendered.
+typedef struct {
+	float color_primary_red[2];          ///< xy coordinates for the red primary of the image's color space according to the CIE 1931 color space chromaticity diagram.
+	float color_primary_green[2];        ///< xy coordinates for the green primary of the image's color space according to the CIE 1931 color space chromaticity diagram.
+	float color_primary_blue[2];         ///< xy coordinates for the blue primary of the image's color space according to the CIE 1931 color space chromaticity diagram.
+	float white_point[2];                ///< xy coordinates for the white point of the image's color space according to the CIE 1931 color space chromaticity diagram.
+	float min_luminance;                 ///< Min luminance supported by the display that is the source of the image.
+	float max_luminance;                 ///< Max luminance supported by the display that is the source of the image.
+	float max_content_light_level;       ///< MaxCLL. This is the nit value of the brightest possible pixel that could ever occur in an image. If unknown, you can set it to max_luminance.
+	float max_frame_average_light_level; ///< MaxFALL. This is the highest nit value that an image's average luminance is expected to have. If unknown, you can set it to MaxCLL.
+} MTY_HDRDesc;
+
 /// @brief Description of a render operation.
 typedef struct {
-	MTY_ColorFormat format; ///< The color format of a raw image.
-	MTY_Rotation rotation;  ///< Rotation applied to the image.
-	MTY_Filter filter;      ///< Filter applied to the image.
-	MTY_Effect effect;      ///< Effect applied to the image.
-	uint32_t imageWidth;    ///< The width in pixels of the image.
-	uint32_t imageHeight;   ///< The height in pixels of the image.
-	uint32_t cropWidth;     ///< Desired crop width of the image from the top left corner.
-	uint32_t cropHeight;    ///< Desired crop height of the image from the top left corner.
-	uint32_t viewWidth;     ///< The width of the viewport.
-	uint32_t viewHeight;    ///< The height of the viewport.
-	float aspectRatio;      ///< Desired aspect ratio of the image. The renderer will letterbox
-	                        ///<   the image to maintain the specified aspect ratio.
-	float scale;            ///< Multiplier applied to the dimensions of the image, producing an
-	                        ///<   minimized or magnified image. This can be set to 0
-	                        ///<   if unnecessary.
+	MTY_ColorFormat format;    ///< The color format of a raw image.
+	MTY_ColorSpace colorspace; ///< Defines the color encoding of the image.
+	MTY_Rotation rotation;     ///< Rotation applied to the image.
+	MTY_Filter filter;         ///< Filter applied to the image.
+	MTY_Effect effect;         ///< Effect applied to the image.
+	uint32_t imageWidth;       ///< The width in pixels of the image.
+	uint32_t imageHeight;      ///< The height in pixels of the image.
+	uint32_t cropWidth;        ///< Desired crop width of the image from the top left corner.
+	uint32_t cropHeight;       ///< Desired crop height of the image from the top left corner.
+	uint32_t viewWidth;        ///< The width of the viewport.
+	uint32_t viewHeight;       ///< The height of the viewport.
+	float aspectRatio;         ///< Desired aspect ratio of the image. The renderer will letterbox
+	                           ///<   the image to maintain the specified aspect ratio.
+	float scale;               ///< Multiplier applied to the dimensions of the image, producing an
+	                           ///<   minimized or magnified image. This can be set to 0
+	                           ///<   if unnecessary.
+	bool fullRange;            ///< If true, then the image components comprise the range [0, 1]; else, they comprise the "partial" or "legal" range based on the format of the image.
+	bool hdrDescSpecified;     ///< Is HDR metadata provided. Only relevant if format + colorspace indicate an HDR image.
+	MTY_HDRDesc hdrDesc;       ///< HDR metadata for the image. Only relevant if format + colorspace indicate an HDR image.
 } MTY_RenderDesc;
 
 /// @brief A point with an `x` and `y` coordinate.
@@ -170,6 +202,7 @@ typedef struct {
 	uint32_t idxTotalLength; ///< Total number of indices in all command lists.
 	uint32_t vtxTotalLength; ///< Total number of vertices in all command lists.
 	bool clear;              ///< Surface should be cleared before drawing.
+	bool hdr;                ///< UI in SDR will be composited on top of an HDR quad.
 } MTY_DrawData;
 
 /// @brief Create an MTY_Renderer capable of executing drawing commands.
@@ -1257,6 +1290,13 @@ MTY_WindowSetGFX(MTY_App *app, MTY_Window window, MTY_GFX api, bool vsync);
 MTY_EXPORT MTY_ContextState
 MTY_WindowGetContextState(MTY_App *app, MTY_Window window);
 
+/// @brief Tells you whether the window can show HDR content or not.
+/// @param app The MTY_App.
+/// @param window An MTY_Window.
+/// @returns Returns true if the window can render HDR content, false otherwise.
+MTY_EXPORT bool
+MTY_WindowIsHDRSupported(MTY_App *app, MTY_Window window);
+
 /// @brief Get the string representation of a key combination.
 /// @details This function attempts to use the current locale.
 /// @param mod Combo modifier.

src/unix/apple/macosx/gfx/gl-ctx.m

@@ -190,3 +190,8 @@ bool mty_gl_ctx_make_current(struct gfx_ctx *gfx_ctx, bool current)
 
 	return true;
 }
+
+bool mty_gl_ctx_hdr_supported(struct gfx_ctx *gfx_ctx)
+{
+	return false;
+}

src/unix/apple/macosx/gfx/metal-ctx.m

@@ -183,3 +183,8 @@ bool mty_metal_ctx_make_current(struct gfx_ctx *gfx_ctx, bool current)
 {
 	return false;
 }
+
+bool mty_metal_ctx_hdr_supported(struct gfx_ctx *gfx_ctx)
+{
+	return false;
+}

src/unix/linux/android/gfx/gl-ctx.c

@@ -347,3 +347,8 @@ bool mty_gl_ctx_make_current(struct gfx_ctx *gfx_ctx, bool current)
 
 	return r;
 }
+
+bool mty_gl_ctx_hdr_supported(struct gfx_ctx *gfx_ctx)
+{
+	return false;
+}

src/unix/linux/generic/gfx/gl-ctx.c

@@ -163,3 +163,8 @@ bool mty_gl_ctx_make_current(struct gfx_ctx *gfx_ctx, bool current)
 
 	return r;
 }
+
+bool mty_gl_ctx_hdr_supported(struct gfx_ctx *gfx_ctx)
+{
+	return false;
+}

src/unix/web/gfx/gl-ctx.c

@@ -101,3 +101,8 @@ bool mty_gl_ctx_make_current(struct gfx_ctx *gfx_ctx, bool current)
 {
 	return false;
 }
+
+bool mty_gl_ctx_hdr_supported(struct gfx_ctx *gfx_ctx)
+{
+	return false;
+}