Setting Up HDR Jobs Using the REST API - AWS Elemental Server

This is version 2.15 of the AWS Elemental Server documentation. This is the latest version. For prior versions, see the Previous Versions section of AWS Elemental Conductor File and AWS Elemental Server Documentation.

Setting Up HDR Jobs Using the REST API

This section provides information for setting up your AWS Elemental Server job and profile XML for HDR.

To use the information in this section, you should understand:

  • The conceptual information provided in the main body of this document.

  • How to create and modify jobs using XML.

XML Reference Tables for HDR

Managing Overwrite of Source Metadata
Element Notes
job Top-level element
input
video_selector Corresponds to the Video Selector section of the UI, under Input > Advanced. One <video_selector> element exists per job, which applies to all outputs.
force_color Corresponds to the Force Color checkbox in the UI. Set to true to overwrite the source metadata with the values in <color_space> and, for HDR10, the children of <hdr10_metadata>. Set to false to retain metadata from the source.
color_space

Corresponds to the Color Space dropdown in the Video Selector section of the UI.

Valid values are: follow, rec_601, rec_709, hdr10, hlg_2020

hdr10_metadata Contains children for specifying master display information for HDR10. See the table below.
Metadata Specific to HDR10
Child of <hdr10_metadata> Valid Range
red_primary_x 0-50000
red_primary_y 0-50000
green_primary_x 0-50000
green_primary_y 0-50000
blue_primary_x 0-50000
blue_primary_y 0-50000
white_point_x 0-50000
white_point_y 0-50000
min_lumninance 0-2147483647
max_luminance 0-2147483647
maxcll 0- 65535
maxfall 0- 65535

For the following table, different outputs can have different values for <insert_color_metadata> because this setting is contained in the stream assembly.

Including or Excluding Metadata from Outputs
Element Notes
job Top-level element
stream_assembly Use one <stream_assembly> element for each set of encoding instructions you need.
name Use the value of this element to map a stream assembly to an output.
video_description Contains settings for how the video is encoded.
insert_color_metadata Set to true to include color metadata in the output; set to false to exclude it.
output group

Use one output group element for each video package type produced.

Different outputs within the group can have different sets of encoding instructions (different stream assemblies) applied to them.

output Represents the actual set of elementary streams delivered to a single destination address.
stream_assembly_name Set the value of this element to match that of a <stream_assembly>/<name> element, which associates this output with the stream assembly.

For the following table, different outputs can have different settings for color correction because this setting is contained in the stream assembly.

Color Correction
Element Notes
job Top-level element
stream_assembly Use one <stream_assembly> element for each set of encoding instructions you need.
name Use the value of this element to map a stream assembly to an output.
video_preprocessors
color_corrector Include this element if you want color correction on your output.
color_space_conversion

Use this element to specify the color space or format you want your video stream converted to.

Supported conversions are between HDR10 and HLG, from either rec. 601 or rec. 709 to either HDR10 or HLG, and between rec. 601 and rec. 709.

Valid values are: none, force_601, force_709, force_hdr10, force_hlg_2020

brightness

Provide brightness correction value here.

Valid range is: 1 through 100

contrast

Provide contrast correction value here.

Valid range is: 1 through 100

hue

Provide hue correction value here.

Valid range is: -180 through 180

saturation

Provide saturation correction value here.

Valid range is: 1 through 100

hdr10_metadata Contains children for specifying master display information for HDR10. See the table below.
output group

Use one output group element for each video package type produced.

Different outputs within the group can have different sets of encoding instructions (different stream assemblies) applied to them.

output Represents the actual set of elementary streams delivered to a single destination address.
stream_assembly_name Set the value of this element to match that of a <stream_assembly>/<name> element, which associates this output with the stream assembly.

The following table shows HDR10-specific metadata structures and ranges for which values for the elements must be supplied by your color grader or another upstream source along with information about your specific video asset.

Metadata Specific to HDR10
Child of <hdr10_metadata> Valid Range
red_primary_x 0-50000
red_primary_y 0-50000
green_primary_x 0-50000
green_primary_y 0-50000
blue_primary_x 0-50000
blue_primary_y 0-50000
white_point_x 0-50000
white_point_y 0-50000
min_lumninance 0-2147483647
max_luminance 0-2147483647
maxcll 0- 65535
maxfall 0- 65535