This page provides all the information related to Design Module 6 - VCU TRD PL DDR HDR10 HDMI design.

Table of Contents

1 Overview

This module supports the reception and insertion of HDR10 static metadata for HDMI. This HDR10 metadata that contains critical information needed to support HDR will be carried throughout the pipeline - from the source to the sink. It enables the capture of HDR10 video from an HDMI-Rx Subsystem implemented in the PL. The video can be displayed through HDR10 compatible HDMI-Tx through the PL and recorded in SD cards or USB/SATA drives. The module can Stream-in or Stream-out HDR10 encoded data through an Ethernet interface. This module supports single-stream for XV20 and XV15 format. It also supports DCI 4k (4096 x 2160) resolution at 60 FPS.

This is the new design approach proposed to use PL_DDR for decoding and PS_DDR for encoding so that DDR bandwidth would be enough to support high bandwidth VCU applications requiring simultaneous encoder and decoder operations and transcoding at 4k@60 FPS. This approach makes the most effective use of limited AXI4 read/write issuance capability in minimizing latency for the decoder. DMA buffer sharing requirements determine how capture, display, and intermediate processing stages should be mapped to the PS or PL DDR.

This design supports the following video interfaces:
Sources:

Sinks:

VCU Codec:

Video format:

Supported Resolution:

The table below provides the supported resolution from the command line app only in this design.

Resolution

Command Line

Single Stream

Multi-stream

4kp60

NA

4kp30

x

1080p60

x

√ - Supported
x – Not supported
NA – Not applicable

The below table gives information about the features supported in this design. 

Pipeline

Input source

Format

Output Type

Resolution

VCU codec

Serial pipeline

HDMI-Rx

XV20/ XV15

HDMI-Tx

DCI-4kp60/ 4kp60/ 4kp30/ 1080p60

HEVC/ AVC

Record/ Stream-Out pipeline

HDMI-Rx

XV20/ XV15

File Sink/ Stream-Out

DCI-4kp60/ 4kp60/ 4kp30/ 1080p60

HEVC/ AVC

File/ Streaming Playback pipeline

File Source/ Stream-In

XV20/ XV15

HDMI-Tx

DCI-4kp60/ 4kp60/ 4kp30/ 1080p60

HEVC/ AVC


The below figure shows the PL DDR HDR10 HDMI design hardware block diagram.

The below figure shows the PL DDR HDR10 HDMI design software block diagram.

1.1 Board Setup

Refer below link for Board Setup

1.2 Run Flow

The TRD package is released with the source code, Vivado project, Petalinux BSP, and SD card image that enables the user to run the demonstration. It also includes the binaries necessary to configure and boot the ZCU106 board. Prior to running the steps mentioned in this wiki page, download the TRD package and extract its contents to a directory referred to as TRD_HOME which is the home directory.

Refer below link to download all TRD contents.

TRD package contents are placed in the following directory structure. The user needs to copy all the files from the $TRD_HOME/images/vcu_trd/ to FAT32 formatted SD card directory.

rdf0428-zcu106-vcu-trd-2020.2
├── apu
│   └── vcu_petalinux_bsp
├── images
│   ├── vcu_10g
│   ├── vcu_audio
│   ├── vcu_hdr10_hdmi
│   ├── vcu_llp2_hdmi_nv12
│   ├── vcu_llp2_hdmi_nv16
│   ├── vcu_llp2_hdmi_xv20
│   ├── vcu_llp2_sdi_xv20
│   ├── vcu_multistream_nv12
│   ├── vcu_pcie
│   ├── vcu_quad_sensor
│   └── vcu_sdi_xv20
├── pcie_host_package
│   ├── COPYING
│   ├── include
│   ├── LICENSE
│   ├── readme.txt
│   ├── RELEASE
│   ├── tests
│   ├── tools
│   └── xdma
├── pl
│   ├── constrs
│   ├── designs
│   ├── prebuild
│   ├── README.md
│   └── srcs
└── README.txt

TRD package contents specific to VCU HDR10 HDMI design are placed in the following directory structure.

rdf0428-zcu106-vcu-trd-2020.2
├── apu
│   └── vcu_petalinux_bsp
│       └── xilinx-vcu-zcu106-v2020.2-final.bsp
├── images
│   ├── vcu_hdr10_hdmi
│   │   ├── autostart.sh
│   │   ├── BOOT.BIN
│   │   ├── boot.scr
│   │   ├── config
│   │   ├── image.ub
│   │   ├── system.dtb
│   │   └── vcu
├── pcie_host_package
├── pl
│   ├── constrs
│   ├── designs
│   │   └── zcu106_HDR10_DCI4K
│   ├── prebuild
│   │   └── zcu106_HDR10_DCI4K
│   ├── README.md
│   └── srcs
│       ├── hdl
│       └── ip
└── README.txt

The below snippet shows the configuration files (input.cfg) for running various resolutions for Display, Record, and Streaming use cases. All these configurations files are placed in the images folder mentioned above. The directory structure in /media/card.

config
├── 4kp60
│   ├── Display
│   ├── Record
│   ├── Stream-in
│   └── Stream-out
├── 4kp30
│   ├── Display
│   ├── Record
│   ├── Stream-in
│   └── Stream-out
├── 1080p60
│   ├── Display
│   ├── Record
│   ├── Stream-in
│   └── Stream-out
└── input.cfg

1.2.1 GStreamer Application (vcu_gst_app)

The vcu_gst_app is a command-line multi-threaded Linux application. The command-line application requires an input configuration file (input.cfg) to be provided in the plain text.

Run below modetest command to set CRTC configurations for 4Kp60:

$ modetest -D a00c0000.v_mix -s 39:3840x2160-60@BG24

Run below modetest command to set CRTC configurations for 4Kp30:

$ modetest -D a00c0000.v_mix -s 39:3840x2160-30@BG24

Execution of the application is shown below:

$ vcu_gst_app <path to *.cfg file>

Examples:

4kp60 XV20 HEVC_HIGH HDR10 Display Pipeline execution

$ vcu_gst_app /media/card/config/4kp60/Display/Single_4kp60_HEVC_HIGH.cfg

4kp60 XV20 HEVC_HIGH HDR10 Record Pipeline execution

$ vcu_gst_app /media/card/config/4kp60/Record/Single_4kp60_HEVC_HIGH.cfg

4kp60 XV20 HEVC_HIGH HDR10 Stream-out Pipeline execution

$ vcu_gst_app /media/card/config/4kp60/Stream-out/Single_4kp60_HEVC_HIGH.cfg

4kp60 XV20 HEVC_HIGH HDR10 Stream-in Pipeline execution

$ vcu_gst_app /media/card/config/4kp60/Stream-in/input.cfg
note

Make sure HDMI-Rx should be configured to 4kp60 mode

Make sure HDMI-Rx should be configured to 4kp60 mode

To measure the latency of the pipeline, run the below command. The latency data is huge, so dump it to a file.

$ GST_DEBUG="GST_TRACER:7" GST_TRACERS="latency" GST_DEBUG_FILE=/run/latency.log vcu_gst_app /media/card/config/input.cfg

Refer below link for detailed run flow steps

1.3 Build Flow

Refer below link for detailed build flow steps


2 Other Information

2.1 Known Issues

2.2 Limitations

2.3 Optimum VCU Encoder parameters for use-cases.

Video streaming:

Performance: AVC Encoder settings:

Quality: Low bitrate AVC encoding:


3 Appendix A - Input Configuration File (input.cfg)

The example configuration files are stored at /media/card/config/ folder.

Configuration Type

Configuration Name

Description

Available Options

Common

Common Configuration

It is the starting point of common configuration

Num of Input

Provide the number of inputs. Set to 1 as it supports only single stream

1

Output

Select the video interface

HDMI

Out Type

Type of output

display, record, stream

Display Rate

Pipeline frame rate

30 or 60 fps

Exit

It indicates to the application that the configuration is over

Input

Input Configuration

It is the starting point of the input configuration

Input Num

Starting Nth input configuration

1

Input Type

Input source type

HDMI, File, Stream

Uri

File path or Network URL. Applicable for file playback and stream-in pipeline only. Supported file formats for playback are ts, mp4, and mkv.

file:///run/media/sda/abc.ts (for file path), udp://192.168.25.89:5004/ (for Network streaming, Here 192.168.25.89 is Client's IP address and 5004 is port number)

Raw

To tell the pipeline is processed or pass-through

note

The raw use-case is not supported with this design as mixer is not connected to PS DDR

The raw use-case is not supported with this design as mixer is not connected to PS DDR

False

Width

The width of the live source

3840, 1920

Height

The height of the live source

2160, 1080

Format

The format of input data

XV20, XV15

Exit

It indicates to the application that the configuration is over

Encoder

Encoder Configuration

It is the starting point of encoder configuration

Encoder Num

Starting Nth encoder configuration

1

Encoder Name

Name of the encoder

AVC, HEVC

Profile

Name of the profile

AVC: High
HEVC: Main

Rate Control

Rate control options

CBR, VBR, and low-latency

Filler Data

Filler Data NAL units for CBR rate control

True, False

QP

QP control mode used by the VCU encoder

Uniform, Auto

L2 Cache

Enable or Disable L2Cache buffer in encoding process

True, False

Latency Mode

Encoder latency mode.

Normal, sub_frame

Low Bandwidth

If enabled, decrease the vertical search range used for P-frame motion estimation to reduce the bandwidth.

True, False

Gop Mode

Group of Pictures mode.

Basic, low_delay_p, low_delay_b

Bitrate

Target bitrate in Kbps

1-60000

B Frames

Number of B-frames between two consecutive P-frames

0-4

Slice

The number of slices produced for each frame. Each slice contains one or more complete macroblock/CTU row(s). Slices are distributed over the frame as regularly as possible. If slice-size is defined as well more slices may be produced to fit the slice-size requirement.

4-22 4Kp resolution with HEVC codec
4-32 4Kp resolution with AVC codec
4-32 1080p resolution with HEVC codec
4-32 1080p resolution with AVC codec

GoP Length

The distance between two consecutive I frames

1-1000

GDR Mode

It specifies which Gradual Decoder Refresh(GDR) scheme should be used when gop-mode = low_delay_p

note

GDR mode is currently supported with LLP1/LLP2 low-delay-p use-cases only

GDR mode is currently supported with LLP1/LLP2 low-delay-p use-cases only

Horizontal, Vertical, Disabled

Entropy Mode

It specifies the entropy mode for H.264 (AVC) encoding process

CAVLC, CABAC, Default

Max Picture Size

It is used to curtail instantaneous peak in the bit-stream using this parameter. It works in CBR/VBR rate-control only. When it is enabled, max-picture-size value is calculated and set with 10% of AllowedPeakMargin. i.e. max-picture-size =  (TargetBitrate / FrameRate) * 1.1

note

It works in CBR/VBR rate-control only

It works in CBR/VBR rate-control only

True, False

Format

The format of input data

NV12

Preset

Based on provided six presets, predefined configuration will be set for encoder parameters. Select custom to provide user-specific options for encoder parameters.

HEVC_HIGH, HEVC_MEDIUM, HEVC_LOW, AVC_HIGH, AVC_MEDIUM, AVC_LOW, Custom

Exit

It indicates to the application that the configuration is over

Record

Record Configuration

It is the starting point of record configuration

Record Num

Starting Nth record configuration

1

Out-File Name

Record file path

e.g. /run/media/sda/abc.ts

Duration

Duration in minutes

1-3

Exit

It indicates to the application that the configuration is over

Streaming

Streaming Configuration

It is the starting point of streaming configuration.

Streaming Num

Starting Nth Streaming configuration

1

Host IP

The host to send the packets to the client

192.168.25.89 or Windows PC IP

Port

The port to send the packets to port number

5004

Exit

It indicates to the application that the configuration is over.

Trace

Trace Configuration

It is the starting point of trace configuration

FPS Info

To display achieved frame per second information on the console

True, False

APM Info

To display APM counter number on the console

True, False

Pipeline Info

To display pipeline info on console

True, False

Exit

It indicates to the application that the configuration is over


4 Appendix B - HDMI-Rx/Tx Link-up and GStreamer Commands

This section covers configuration of HDMI-Rx using media-ctl utility and HDMI-Tx using modetest utility, along with demonstrating HDMI-Rx/Tx link-up issues and steps to switch HDMI-Rx resolution. It also contains sample GStreamer HDMI video pipelines for Display, Record & Playback, Stream-in and Stream-out use-cases.

$ media-ctl -p -d /dev/media0
$ media-ctl -p -d /dev/media0
root@zcu106_vcu_hdr10_dci4k:/media/card# media-ctl -p -d /dev/media0
Media controller API version 5.4.0

Media device information
------------------------
driver          xilinx-video
model           Xilinx Video Composite Device
serial          
bus info        
hw revision     0x0
driver version  5.4.0

Device topology
- entity 1: vcap_hdmi_input_v_proc_ss_0 out (1 pad, 1 link)
            type Node subtype V4L flags 0
            device node name /dev/video0 -----> Video node for HDMI-Rx source
	pad0: Sink
		<- "a0040000.v_proc_ss":1 [ENABLED]

- entity 5: a0040000.v_proc_ss (2 pads, 2 links)
            type V4L2 subdev subtype Unknown flags 0
            device node name /dev/v4l-subdev0
	pad0: Sink
		[fmt:VYYUYY10_4X20/1280x720 field:none colorspace:srgb]
		<- "a0400000.v_hdmi_rx_ss":0 [ENABLED]
	pad1: Source
		[fmt:VYYUYY10_4X20/1920x1080 field:none colorspace:srgb]
		-> "vcap_hdmi_input_v_proc_ss_0 out":0 [ENABLED]

- entity 8: a0400000.v_hdmi_rx_ss (1 pad, 1 link)
            type V4L2 subdev subtype Unknown flags 0
            device node name /dev/v4l-subdev1
	pad0: Source
		[fmt:RBG888_1X24/3840x2160 field:none]
		[dv.caps:BT.656/1120 min:0x0@25000000 max:4096x2160@297000000 stds:CEA-861,DMT,CVT,GTF caps:progressive,reduced-blanking,custom]
		[dv.detect:BT.656/1120 3840x2160p60 (4400x2250) stds:CEA-861 flags:CE-video] -----> Resolution and Frame-rate of HDMI-Rx source
		-> "a0040000.v_proc_ss":0 [ENABLED]
note

Check resolution and frame-rate of dv.detect under v_hdmi_rx_ss node.

Check resolution and frame-rate of dv.detect under v_hdmi_rx_ss node.

root@zcu106_vcu_hdr10_dci4k:/media/card# media-ctl -p -d /dev/media0
Media controller API version 5.4.0

Media device information
------------------------
driver          xilinx-video
model           Xilinx Video Composite Device
serial          
bus info        
hw revision     0x0
driver version  5.4.0

Device topology
- entity 1: vcap_hdmi_input_v_proc_ss_0 out (1 pad, 1 link)
            type Node subtype V4L flags 0
            device node name /dev/video0 -----> Video node for HDMI-Rx source
	pad0: Sink
		<- "a0040000.v_proc_ss":1 [ENABLED]

- entity 5: a0040000.v_proc_ss (2 pads, 2 links)
            type V4L2 subdev subtype Unknown flags 0
            device node name /dev/v4l-subdev0
	pad0: Sink
		[fmt:VYYUYY10_4X20/1280x720 field:none colorspace:srgb]
		<- "a0400000.v_hdmi_rx_ss":0 [ENABLED]
	pad1: Source
		[fmt:VYYUYY10_4X20/1920x1080 field:none colorspace:srgb]
		-> "vcap_hdmi_input_v_proc_ss_0 out":0 [ENABLED]

- entity 8: a0400000.v_hdmi_rx_ss (1 pad, 1 link)
            type V4L2 subdev subtype Unknown flags 0
            device node name /dev/v4l-subdev1
	pad0: Source
		[fmt:RBG888_1X24/3840x2160 field:none]
		[dv.caps:BT.656/1120 min:0x0@25000000 max:4096x2160@297000000 stds:CEA-861,DMT,CVT,GTF caps:progressive,reduced-blanking,custom]
		[dv.query:no-link] -----> HDMI-Rx Link Status
		-> "a0040000.v_proc_ss":0 [ENABLED]
note

Here dv.query:no-link under v_hdmi_rx_ss node shows HDMI-Rx source is not connected or HDMI-Rx source is not active (Try waking up the device by pressing a key on remote).

Here dv.query:no-link under v_hdmi_rx_ss node shows HDMI-Rx source is not connected or HDMI-Rx source is not active (Try waking up the device by pressing a key on remote).

Notes for gst-launch-1.0 commands:

$ media-ctl -p -d /dev/media0

When HDMI Input Source is NVIDIA SHIELD

$ media-ctl -d /dev/media0 -V "\"a0040000.v_proc_ss\":0 [fmt:RBG888_1X24/3840x2160 field:none]"
$ media-ctl -d /dev/media0 -V "\"a0040000.v_proc_ss\":1  [fmt:UYVY10_1X20/3840x2160 field:none]"
note

Make sure NVIDIA SHIELD is configured for 4K resolution and RBG888_1X24 format.

Make sure NVIDIA SHIELD is configured for 4K resolution and RBG888_1X24 format.

$ vcu_gst_app /media/card/config/input.cfg

Below configurations needs to be set in input.cfg for HDMI-Rx 1080p60 resolution.

Common Configuration    : START
Num Of Input            : 1
Output                  : HDMI
Out Type                : Display
Frame Rate              : 60
Exit

Input Configuration     : START
Input Num               : 1
Input Type              : hdmi
Raw                     : FALSE
Width                   : 1920
Height                  : 1080
Format                  : XV20
Exit

Encoder Configuration   : START
Encoder Num             : 1
Preset                  : HEVC_HIGH
Exit
$ modetest -D a00c0000.v_mix -s 39:3840x2160-60@BG24
$ modetest -D a00c0000.v_mix -s 39:3840x2160-30@BG24

Pixel Format

GStreamer Format

Media Bus Format

GStreamer HEVC Profile

GStreamer AVC Profile

Kmssink Plane-id

XV20

NV16_10LE32

UYVY10_1X20

main-422-10

high-4:2:2

34

XV15

NV12_10LE32

VYYUYY10_4X20

main-10

high-10

35

note
  • Make sure HDMI-Rx supports HDR10 and should be configured to 4kp60 mode before running below pipelines

  • Make sure HDMI-Tx (Monitor) is 4K HDR10 compatible before running below pipelines

  • It is mandatory to use HDR10 recorded video for all below pipelines.

  • File location should be USB-3.0/SATA/RAMFS to avoid the read-write bandwidth issue - while running record/playback pipelines

  • 192.168.25.89 is host/client IP address and 5004 is port number in streaming pipeline

  • Video0 in the each gst-launch pipelines indicates a video node for the input source

  • Make sure HDMI-Rx supports HDR10 and should be configured to 4kp60 mode before running below pipelines

  • Make sure HDMI-Tx (Monitor) is 4K HDR10 compatible before running below pipelines

  • It is mandatory to use HDR10 recorded video for all below pipelines.

  • File location should be USB-3.0/SATA/RAMFS to avoid the read-write bandwidth issue - while running record/playback pipelines

  • 192.168.25.89 is host/client IP address and 5004 is port number in streaming pipeline

  • Video0 in the each gst-launch pipelines indicates a video node for the input source

$ gst-launch-1.0 v4l2src device=/dev/video0 io-mode=4 ! video/x-raw, width=3840, height=2160, format=NV16_10LE32, framerate=60/1 ! omxh265enc qp-mode=auto gop-mode=basic gop-length=60 b-frames=0 target-bitrate=60000 num-slices=8 control-rate=constant prefetch-buffer=true low-bandwidth=false filler-data=true cpb-size=1000 initial-delay=500 ! video/x-h265, profile=main-422-10, alignment=au ! queue ! omxh265dec internal-entropy-buffers=5 low-latency=0 ! queue max-size-bytes=0 ! fpsdisplaysink text-overlay=false video-sink="kmssink bus-id="a00c0000.v_mix show-preroll-frame=false" plane-id=34 sync=true" sync=true
$ gst-launch-1.0 v4l2src device=/dev/video0 io-mode=4 num-buffers=3600 ! video/x-raw, width=3840, height=2160, format=NV16_10LE32, framerate=60/1 ! omxh265enc qp-mode=auto gop-mode=basic gop-length=60 b-frames=0 target-bitrate=60000 num-slices=8 control-rate=constant prefetch-buffer=true low-bandwidth=false filler-data=true cpb-size=1000 initial-delay=500 ! video/x-h265, profile=main-422-10, alignment=au ! h265parse ! queue ! mpegtsmux alignment=7 name=mux ! filesink location="/run/test.ts"
$ gst-launch-1.0 uridecodebin uri="file:///run/test.ts" ! queue max-size-bytes=0 ! fpsdisplaysink text-overlay=false video-sink="kmssink bus-id="a00c0000.v_mix" plane-id=34"
$ gst-launch-1.0 v4l2src device=/dev/video0 io-mode=4 ! video/x-raw, width=3840, height=2160, format=NV16_10LE32, framerate=60/1 ! omxh265enc qp-mode=auto gop-mode=basic gop-length=60 b-frames=0 target-bitrate=60000 num-slices=8 control-rate=constant prefetch-buffer=true low-bandwidth=false filler-data=true cpb-size=1000 initial-delay=500 periodicity-idr=60 ! video/x-h265, profile=main-422-10, alignment=au ! h265parse ! queue ! mpegtsmux alignment=7 name=mux ! rtpmp2tpay ! udpsink host=192.168.25.89 port=5004 buffer-size=60000000 max-bitrate=120000000 max-lateness=-1 qos-dscp=60 async=false
$ gst-launch-1.0 udpsrc port=5004 buffer-size=60000000 caps="application/x-rtp, clock-rate=90000" ! rtpjitterbuffer latency=1000 ! rtpmp2tdepay ! tsparse ! video/mpegts ! tsdemux name=demux ! queue ! h265parse ! video/x-h265, profile=main-422-10, alignment=au ! omxh265dec internal-entropy-buffers=5 low-latency=0 ! queue max-size-bytes=0 ! fpsdisplaysink text-overlay=false video-sink="kmssink bus-id="a00c0000.v_mix" plane-id=34" sync=true