Example Codecs

Schema for describing example/sample codec configurations. These codecs use pre-computed results (RD reports, VMAF scores) instead of running actual encoding and decoding, and are used for testing and demonstration purposes.

Note

The following top-level properties are required: example-codec-result.

Properties

[Required] example-codec-result

Path: Example Codecs > example-codec-result

Type	object
Required	Yes

Dictionary of example codec configurations. Each key is a codec name used to reference it in the main configuration file under ‘codecs.examples’.

Each entry in this object follows the structure below.

[Required] raw_type

Path: Example Codecs > example-codec-result > raw_type

Type	string
Required	Yes

Raw format associated with this codec’s decoded output. Used to determine how to handle sample data.

Example(s):

"pgx"

"yuv"

[Required] rd_preferences

Path: Example Codecs > example-codec-result > rd_preferences

Type	object
Required	Yes

Visual preferences for this codec in rate-distortion plots.

[Required] title

Path: Example Codecs > example-codec-result > rd_preferences > title

Type	string
Required	Yes

Label for this codec in RD plots.

Example(s):

"JPLM (CTC)"

"x265 (CTC)"

[Optional] color

Path: Example Codecs > example-codec-result > rd_preferences > color

Type	string
Required	No

Line/marker color for this codec in RD plots.

Example(s):

"blueviolet"

"red"

"tab:blue"

[Optional] marker

Path: Example Codecs > example-codec-result > rd_preferences > marker

Type	string
Required	No

Marker style for this codec in RD plots.

Example(s):

"o"

"x"

"+"

[Required] samples_path

Path: Example Codecs > example-codec-result > samples_path

Type	object
Required	Yes

Paths to directories containing pre-computed sample results for this codec.

[Required] rd_reports

Path: Example Codecs > example-codec-result > samples_path > rd_reports

Type	string
Required	Yes

Path to the directory containing pre-computed RD report JSON files.

Example(s):

"${base-path}/../samples/jplm/rd_reports"

[Required] vmaf

Path: Example Codecs > example-codec-result > samples_path > vmaf

Type	string
Required	Yes

Path to the directory containing pre-computed VMAF result files.

Example(s):

"${base-path}/../samples/jplm/vmaf"