This page provides all the information related to Design Module 11 - VCU TRD Xilinx low latency(LLP2) PL DDR NV12 HDMI design.

Table of Contents

1 Overview

This module enables capture of video and audio data from an HDMI-Rx subsystem implemented in the PL. The video and audio data can be displayed through the HDMI-Tx subsystem implemented in the PL. The module can stream-out and stream-in live captured video and audio through an Ethernet interface at ultra-low latencies using Sync IP. This module supports multi-stream video for NV12 pixel format. This module also supports single-stream audio.

The VCU encoder and decoder operate in slice mode. An input frame is divided into multiple slices (8 or 16) horizontally. The encoder generates a slice_done interrupt at every end of the slice. Generated NAL unit data can be passed to a downstream element immediately without waiting for the frame_done interrupt. The VCU decoder also starts processing data as soon as one slice of data is ready in its circular buffer instead of waiting for complete frame data. The Sync IP does an AXI transaction-level tracking so that the producer and consumer can be synchronized at the granularity of AXI transactions instead of granularity at the video buffer level. Sync IP is responsible for synchronizing buffers between Capture DMA and VCU encoder as both work on same buffer.

The capture element (FB write DMA) writes video buffers in raster-scan order. SyncIP monitors the buffer level while the capture element is writing into DRAM and allows the encoder to read input buffer data if the requested data is already written by DMA, otherwise it blocks the encoder until DMA completes its writes. On the decoder side, the VCU decoder writes decoded video buffer data into DRAM in block-raster scan order and displays reads data in raster-scan order. To avoid display under-run problems, software ensures a phase difference of "~frame_period/2", so that decoder is ahead compare to display.

This design supports the following video interfaces:

Sources:

• HDMI-Rx capture pipeline implemented in the PS.

• Stream-In from network or internet.

Sinks:

• HDMI-Tx display pipeline implemented in the PS.

VCU Codec:

• Video Encode/Decode capability using VCU hard block in PS

  • AVC/HEVC encoding

  • Encoder/decoder parameter configuration.

Video format:

• NV12

Supported Resolution:

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

√ - Supported
NA – Not applicable
x – Not supported

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

The below figure shows the Xilinx Low Latency PS DDR NV12 HDMI design hardware block diagram.

Open

The below figure shows the Xilinx Low Latency PS DDR NV12 HDMI design software block diagram.

Open

1.1 Board Setup

Refer below link for Board Setup

• Zynq UltraScale+ MPSoC VCU TRD 2020.1 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 Section 4.1 : Download the TRD of Zynq UltraScale+ MPSoC VCU TRD 2020.1 wiki page 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_llp2_hdmi_nv12/ to FAT32 formatted SD card directory.

TRD package contents specific to Xilinx Low Latency PS DDR NV12 HDMI design are placed in the following directory structure.

Configuration files(input.cfg) for various resolutions are placed in the following directory structure in /media/card.

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:

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

Execution of the application is shown below:

Example:

4kp60 NV12 HEVC_25Mbps ultra low-latency(LLP2) audio+video serial pipeline execution.

4kp60 NV12 HEVC_25Mbps ultra low-latency(LLP2) stream-out pipeline execution.

4kp60 NV12 HEVC ultra low-latency(LLP2) video stream-in pipeline execution.

4kp60 NV12 HEVC ultra low-latency(LLP2) audio+video stream-in pipeline execution. where, 192.168.25.90 is server’s IP address.

For LLP1/LLP2 Multi-stream HEVC serial and stream-out use-cases (2-4kp30, 2-1080p60, 4-1080p60), use ENC_EXTRA_OP_BUFFERS=10 variable before vcu_gst_app command. The sample pipeline is given below:

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

Refer below link for detailed run flow steps

• Zynq UltraScale+ MPSoC VCU TRD 2020.1 - Run Flow

1.3 Build Flow

Refer below link for detailed build flow steps

• Zynq UltraScale+ MPSoC VCU TRD 2020.1 - Build Flow

2 Other Information

2.1 Known Issues

• For Petalinux related known issues please refer: PetaLinux 2020.1 - Product Update Release Notes and Known Issues

• For VCU related known issues please refer AR# 66763: LogiCORE H.264/H.265 Video Codec Unit (VCU) - Release Notes and Known Issues and Xilinx Zynq UltraScale+ MPSoC Video Codec Unit.

• For latency issue with llp2 audio+video pipeline, please refer AR# 75907- Why do I see spike in end to end latency while running VCU LLP2 audio + video design in streaming use case?

2.2 Limitations

• For Petalinux related limitations please refer: PetaLinux 2020.1 - Product Update Release Notes and Known Issues

• For VCU related limitations please refer AR# 66763: LogiCORE H.264/H.265 Video Codec Unit (VCU) - Release Notes and Known Issues , Xilinx Zynq UltraScale+ MPSoC Video Codec Unit and PG252.

2.3 Optimum VCU Encoder parameters for use-cases

Video streaming:

• Video streaming use-case requires very stable bitrate graph for all pictures.

• It is good to avoid periodic large Intra pictures during the encoding session

• Low-latency rate control (hardware RC) is the preferred control-rate for video streaming, it tries to maintain equal amount frame sizes for all pictures.

• Good to avoid periodic Intra frames instead use low-delay-p (IPPPPP…)

• VBR is not a preferred mode of streaming.

Performance: AVC Encoder settings:

• It is preferred to use 8 slices only for better AVC encoder performance.

• AVC standard does not support Tile mode processing which results in the processing of MB rows sequentially for entropy coding.

Quality: Low bitrate AVC encoding:

• Enable profile=high and use qp-mode=auto for low-bitrate encoding use-cases.

• The high profile enables 8x8 transform which results in better video quality at low bitrates.

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

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

Common Configuration:
It is the starting point of common configuration.
 
Num of Input:
1, 2, 3, 4

Output:
Select the video interface.
Options: HDMI

Out Type:
Options: display and stream

Display Rate:
Pipeline frame rate.
Options: 30 FPS or 60 FPS for each stream.

Exit:
It indicates to the application that the configuration is over.

Input Configuration:
It is the starting point of the input configuration.

Input Num:
Starting N^th input configuration.
Options: 1, 2, 3, 4

Input Type:
Input source type.
Options: HDMI

Raw:
To tell the pipeline is processed or pass-through.
Options: False

Width:
The width of the live source.
Options: 3840, 1920

Height:
The height of the live source.
Options: 2160, 1080

Format:
The format of input data.
Options: NV12

Enable LLP2:
To enable LLP2 configuration.
Options: True

Exit:
It indicates to the application that the configuration is over.

Encoder Configuration:
It is the starting point of encoder configuration.

Encoder Num:
Starting N^th encoder configuration.
Options: 1, 2, 3, 4

Encoder Name:
Name of the encoder.
Options: AVC, HEVC

Profile:
Name of the profile.
Options: high for AVC and main for HEVC.

Rate Control:
Rate control options.
Options: low_latency.

Filler Data:
Filler Data NAL units for CBR rate control.
Options: False

QP:
QP control mode used by the VCU encoder.
Options: Uniform, Auto

L2 Cache:
Enable or Disable L2Cache buffer in encoding process.
Options: True, False

Latency Mode:
Encoder latency mode.
Options: sub_frame

Low Bandwidth:
If enabled, decrease the vertical search range used for P-frame motion estimation to reduce the bandwidth.
Options: True, False

Gop Mode:
Group of Pictures mode.
Options: Basic, low_delay_p, low_delay_b

Bitrate:
Target bitrate in Kbps
Options: 1-25000

B Frames:
Number of B-frames between two consecutive P-frames
Options: 0

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.
Options:
4-22 4K resolution with HEVC codec
4-32 4K 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
Options: 1-1000

GDR Mode:
It specifies which Gradual Decoder Refresh(GDR) scheme should be used when gop-mode = low_delay_p
Options: Horizontal/Vertical/Disabled

Entropy Mode:
It specifies the entropy mode for H.264 (AVC) encoding process
Options: 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
Options: TRUE/FALSE

Preset:
Options: Custom

Exit:
It indicates to the application that the configuration is over.

Streaming Configuration:
It is the starting point of streaming configuration.

Streaming Num:
Starting N^th Streaming configuration.
Options: 1, 2, 3, 4

Host IP:
The host to send the packets to
Options: 192.168.25.89 or Windows PC IP

Port:
The port to send the packets to. In case of LLP1/LLP2 audio+video rtp stream-out pipelines, rtp/rtcp audio and video port numbers are assigned in below pattern in vcu_gst_app:

Options: 5004, 5008, 5012 and 5016

Exit:
It indicates to the application that the configuration is over.

Audio Configuration:
It is the starting point of the audio configuration.

Audio Enable:
Enable or Disable audio in pipeline.
Options: True, False.

Audio Format:
The format of the audio.
Options: S24_32LE (for serial use-cases), S16LE (for stream-out use-cases)

Sampling Rate:
To set the audio sampling rate.
Options: 48000.

Num Of Channel:
The number of audio channels.
Options: 1-2

Source:
It should be HDMI, as currently only HDMI audio capture is supported.

Renderer:
It should be HDMI, as currently only HDMI audio renderer is supported.

Exit:
It indicates to the application that the configuration is over.

Trace Configuration:
It is the starting point of trace configuration.

FPS Info:
To display fps info on the console.
Options: True, False

APM Info:
To display APM counter number on the console.
Options: True, False

Pipeline Info:
To display pipeline info on console.
Options: 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 Low-Latency NV12 and Xilinx’s Ultra Low-Latency NV12 Audio+Video pipelines for Display, Stream-In and Stream-Out use-cases.

• HDMI source can be locked to any resolution. Run the below command for all media nodes to print media device topology where mediaX represents different media nodes. In the topology, log look for the v_hdmi_rx_ss string to identify the HDMI input source media node.

• To check the link status, resolution and video node of the HDMI input source, run below media-ctl command where mediaX indicates media node for the HDMI input source.

• When HDMI source is connected to 4kp60 resolution, it shows:

• When the HDMI source is not connected, it shows:

Notes for gst-launch-1.0 commands:

• Video node for HDMI-Rx source can be checked using media-ctl command. Run below media-ctl command to check video node for HDMI-Rx source where media3 indicates media node for HDMI input source.

• Make sure HDMI-Rx media pipeline is configured for 4kp60 resolution and source/sink have the same color format for connected nodes. For NV12 format, run below media-ctl commands to set resolution and format of HDMI scaler node where media3 indicates media node for HDMI input source.

• When HDMI Input Source is NVIDIA SHIELD

• Follow the below steps to switch the HDMI-Rx resolution from 1080p60 to 4kp60.

  • Check current HDMI input source resolution (1080p60) by following the steps mentioned earlier to check HDMI resolution using media-ctl command

  • Run vcu_gst_app for current HDMI resolution (1080p60) by executing the following command.

• Below configurations needs to be set in input.cfg for non-LLP2 HDMI-1080p60 use-case.

• Change Resolution of HDMI Input Source from 1080p60 to 4kp60 by following below steps.

  • Set the HDMI source resolution to 4kp60 (Homepage → Settings → Display & Sound → Resolution → change to 4kp60).

  • Save the configuration to take place the change.

• Verify the desired HDMI Input Source Resolution (4kp60) by following the above-mentioned steps.

• If HDMI-Tx link-up issue is observed after Linux booting, use the following command to get the blue screen on HDMI-Tx for 4kp60.

• The table below lists the parameters of the pixel format.

Run the following gst-launch-1.0 command to display NV12 video on HDMI-Tx using low-latency(LLP1) GStreamer pipeline.

Run the following gst-launch-1.0 command to display NV12 video on HDMI-Tx using Xilinx's ultra low-latency(LLP2) GStreamer pipeline..

Run the following gst-launch-1.0 command to capture and play Xilinx's ultra low-latency(LLP2) HDMI video and raw HDMI audio using the Gstreamer pipeline.

Run the following gst-launch-1.0 command to stream-out NV12 video using low-latency(LLP1) GStreamer pipeline. where, 192.168.25.89 is host/client IP address and 5004 is a port number.

Run the following gst-launch-1.0 command to display stream-in NV12 video on HDMI-Tx using low-latency(LLP1) GStreamer pipeline. where, 5004 is port number.

Run the following gst-launch-1.0 command to stream-out NV12 video using Xilinx's ultra low-latency(LLP2) GStreamer pipeline. where, 192.168.25.89 is host/client IP address and 5004 is a port number.

Run the following gst-launch-1.0 command to display NV12 stream-in video on HDMI-Tx using Xilinx's