Zynq UltraScale+ MPSoC VCU TRD 2019.1 - SDI Video Capture and SDI Display

Table of Contents

1 Overview

The primary goal of this Design is to demonstrate the capabilities of VCU hard block present in Zynq UltraScale+ EV devices. The TRD will serve as a platform to tune the performance parameters of VCU and arrive at optimal configurations for encoder and decoder blocks. 

This design supports the following video interfaces:

Sources:

  • SDI-Rx capture pipeline implemented in the PL.
  • File source (SD card, USB storage, SATA hard disk).
  • Stream-In from network or internet.

Sinks:

  • DP Tx display pipeline in the PS.
  • SDI-Tx display pipeline implemented in the PL.

VCU Codec:

  • Video Encode/Decode capability using VCU hard block in PL 
    • AVC/HEVC encoding.
    • Encoder/decoder parameter configuration.

Streaming Interfaces:

  • 1G Ethernet PS GEM 

Video format:

  • NV12

Audio Configuration:

  • Codec: AAC
  • Format: S24_32LE
  • Channel: 2
  • Sampling rate: 48kHz

Supported Resolution

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

Resolution
GUICommand Line
Single StreamSingle Stream
4kp60X
4kp30X
1080p60X

√ - Supported
NA – Not applicable
x – Not supported

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

PipelineInput sourceOutput TypeALSA driversResolutionAudio Codec TypeAudio ConfigurationVideo encode/Decoder type Deliverables
 Record/Stream-Out pipeline SDI-Rx File Sink/ Stream-Out SDI-Rx ALSA drivers 4K/1080p AAC 2 channel @ 48 kHz HEVC/AVCSDI Rx Audio encode with soft codec and video with VCU and store it in a container format.
Playback pipelineFile Source/ Stream-InSDI-TxSDI-Tx ALSA drivers4K/1080pAAC2 channel @ 48 kHzHEVC/AVCPlayback of the local-file/stream-in with video decoded using VCU and Audio using GStreamer soft codec.
Capture--> DisplaySDI-RxSDI-TxSDI-Rx ALSA drivers and SDI-Tx ALSA drivers4K/1080pNA2 channel @ 48 kHzHEVC/AVCSDI-Rx Audio /Video pass to SDI-Tx without VCU/Audio-Codec.
Capture→ Encode--> Decode--> Display SDI-Rx SDI-Tx SDI-Rx ALSA drivers and SDI-Tx ALSA drivers 4K/1080p NA 2 channel @ 48 kHz HEVC/AVCSDI Rx raw audio and video with VCU encoder and decode to achieve AV sync.


The below figure shows the SDI Video Capture and SDI Display with Audio design hardware block diagram.


The below figure shows the SDI Video Capture and SDI Display with Audio 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 specific to SDI Video Capture and SDI Display with Audio design are placed in the following directory structure. The user needs to copy all the files from the $TRD_HOME/images/vcu_sdirxtx/ to FAT32 formatted SD card directory.


└── rdf0428-zcu106-vcu-trd-2019-1
    ├── apu
    │   ├── apps
    │   ├── vcu_petalinux_bsp
    │   ├── vcu_sdx
    │   └── ws_bypass
    ├── host_x86
    │   └── host_package
    ├── images
    │   ├── vcu_sdirxtx
    │   │   ├── autostart.sh
    │   │   ├── bin
    │   │   ├── BOOT.BIN
    │   │   ├── config
    │   │   ├── image.ub
    │   │   ├── system.dtb
    │   │   └── vcu
    ├── pl
    │   ├── constrs
    │   ├── prebuilt
    │   │   ├── vcu_sdirxtx
    │   ├── Readme.txt
    │   ├── scripts
    │   │   └── vcu_sdirxtx_proj.tcl
    │   └── srcs
    └── README.txt

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

config/
├── 4kp60
│   ├── Display
│   ├── Record
│   ├── Stream-out
│   └── Stream-in
├── 4kp30
│   ├── Display 
│   ├── Record 
│   ├── Stream-out
│   └── Stream-in 
├── 1080p60 
│   ├── Display 
│   ├── Record 
│   ├── Stream-out
│   └── Stream-in 
└── 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.

Execution of the application is shown below:

% vcu_gst_app < path to *.cfg file>


Example:

4kp60 HEVC_HIGH Display Pipeline execution

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

4kp60 HEVC_HIGH Record Pipeline execution

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

4kp60 HEVC_HIGH Stream-out Pipeline execution

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

4kp60 HEVC_HIGH Stream-in Pipeline execution

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

NOTE: Make sure SDI-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;scheduletime" ./vcu_gst_app ./input.cfg >& dump_log.txt

Refer below link for detailed run flow steps

1.3 Build Flow

Refer below link for build flow




2 Other Information

2.1 Known Issues

2.2 Limitations

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 or higher slices for better AVC encoder performance.
  • AVC standard does not support Tile mode processing which results in 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:
Provide the number of input. this is always 1 for this design.

Output:
Select the video interface.
Options: SDI or DP

Out Type:
Options: display, record, 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 Nth input configuration.
Options: 1

Input Type:
Input source type.
Options: SDI, 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.
Options: file:///media/usb/abc.ts (for file path), udp://192.168.25.89:5004/ (for Network streaming, Here 192.168.25.89 is IP address and 5004 is port no)

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

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

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

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

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

Encoder Num:
Starting Nth encoder configuration.
Options: 1.

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

Profile:
Name of the profile.
Options: baseline, main or high for AVC. Main for HEVC.

Rate Control:
Rate control options.
Options: CBR, VBR, and low-latency.

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

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

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

Latency Mode:
Encoder latency mode.
Options: normal, 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-60000

B Frames:
Number of B-frames between two consecutive P-frames
Options: 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
Options:
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
Options: 1-1000

Format:
The format of input data.
Options: NV12

Preset:
Options: 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 Configuration:
It is the starting point of record configuration.

Record Num:
Starting Nth record configuration.
Options: 1

Out File Name:
Record file path.
Options: /media/usb/abc.ts

Duration:
Duration in minutes.
Options: 1-3

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

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

Streaming Num:
Starting Nth Streaming configuration.
Options: 1.

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
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.


Sampling Rate:

To set the audio sampling rate.

Options: 48000.


Num Of Channel:

The number of audio channels.

Options: 2.


Volume:

To set the volume level. The default value is 2.0.

Options: 0.0-10.0.


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 SDI Link Status

  • Run the below command to check SDI link status and output format of the SDI input source.
# xmedia-ctl -d /dev/media0  -p
Media controller API version 4.19.0

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

Device topology
- entity 1: vcap_sdi output 0 (1 pad, 1 link)
            type Node subtype V4L flags 0
            device node name /dev/video0        --------> Video node for SDI Rx Source
        pad0: Sink
                <- "a0080000.v_proc_ss":1 [ENABLED]

- entity 5: a0030000.v_smpte_uhdsdi_rx_ss (1 pad, 1 link)
            type V4L2 subdev subtype Unknown flags 0
            device node name /dev/v4l-subdev0
        pad0: Source
                [fmt:UYVY10_1X20/3840x2160@1000/60000 field:none]   ---> Pixel format and Resolution Indicates - SDI Rx Link up
                -> "a0080000.v_proc_ss":0 [ENABLED]

- entity 7: a0080000.v_proc_ss (2 pads, 2 links)
            type V4L2 subdev subtype Unknown flags 0
            device node name /dev/v4l-subdev1
        pad0: Sink
                [fmt:UYVY10_1X20/3840x2160 field:none]
                <- "a0030000.v_smpte_uhdsdi_rx_ss":0 [ENABLED]
        pad1: Source
                [fmt:VYYUYY8_1X24/3840x2160 field:none]
                -> "vcap_sdi output 0":0 [ENABLED]

NOTE: Check resolution and frame-rate of "v_smpte_uhdsdi_rx_ss" node.

If SDI-Rx link has the issue, it appears as below.

# xmedia-ctl -d /dev/media0  -p
Media controller API version 4.19.0

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

Device topology
- entity 1: vcap_sdi output 0 (1 pad, 1 link)
            type Node subtype V4L flags 0
            device node name /dev/video0
        pad0: Sink
                <- "a0080000.v_proc_ss":1 [ENABLED]

- entity 5: a0030000.v_smpte_uhdsdi_rx_ss (1 pad, 1 link)
            type V4L2 subdev subtype Unknown flags 0
            device node name /dev/v4l-subdev0
        pad0: Source
                -> "a0080000.v_proc_ss":0 [ENABLED]    ------> There is no Pixel format and Resolution Indicates - No SDI Rx Link up

- entity 7: a0080000.v_proc_ss (2 pads, 2 links)
            type V4L2 subdev subtype Unknown flags 0
            device node name /dev/v4l-subdev1
        pad0: Sink
                [fmt:UYVY10_1X20/3840x2160 field:none]
                <- "a0030000.v_smpte_uhdsdi_rx_ss":0 [ENABLED]
        pad1: Source
                [fmt:VYYUYY8_1X24/3840x2160 field:none]
                -> "vcap_sdi output 0":0 [ENABLED]

NOTE: Check resolution and frame-rate of "v_smpte_uhdsdi_rx_ss" node.

  • Follow below steps to switch the SDI-Rx resolution from 1080p60 to 4kp60.
    • Check current SDI Input Source Resolution (1080p60) by following the above-mentioned steps.
    • Run vcu_gst_app for current SDI resolution (1080p60) by executing the following command.
$ vcu_gst_app /media/card/config/input.cfg

Below configurations needs to be set in input.cfg for SDI-1080p60.

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

Input Configuration     : START
Input Num               : 1
Input Type              : SDI
Raw                     : TRUE
Width                   : 1920
Height                  : 1080
Exit
    • Change Resolution of SDI Input Source from 1080p60 to 4kp60 by following below steps.
      • Set the SDI source resolution to 4kp60 (Home page → settings → display & Sound → Resolution → change to 4kp60).
      • Save the configuration to take place the change.
    • Verify desired SDI Input Source Resolution (4kp60) by following the above-mentioned steps.
  • Run the following gst-launch-1.0 command to display raw SDI video using GStreamer pipeline.
$ gst-launch-1.0 v4l2src device=/dev/video0 io-mode=4 ! video/x-raw, width=3840, height=2160, framerate=60/1, format=NV12 ! queue max-size-bytes=0 ! kmssink bus-id="a0070000.v_mix" alsasrc device=hw:1,1 ! queue ! audioconvert ! audioresample ! audio/x-raw, rate=48000, channels=2, format=S24_32LE ! alsasink device="hw:1,0"
  • Run the following gst-launch-1.0 command to display processed(capture → encode → decode → display) SDI video using GStreamer pipeline.
$ gst-launch-1.0 v4l2src device=/dev/video0 io-mode=4 ! video/x-raw, width=3840, height=2160, framerate=60/1, format=NV12 ! 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 latency-mode=normal ! video/x-h265, profile=main ! h265parse ! omxh265dec internal-entropy-buffers=5 latency-mode=normal ! queue max-size-bytes=0 ! kmssink bus-id="a0070000.v_mix" alsasrc device=hw:1,1 ! queue ! audioconvert ! audioresample ! audio/x-raw, rate=48000, channels=2, format=S24_32LE ! alsasink device="hw:1,0"
  • Run the following gst-launch-1.0 command to record SDI video using GStreamer pipeline.
$ gst-launch-1.0 v4l2src device=/dev/video0 io-mode=4 ! video/x-raw, format=NV12, width=3840, height=2160, 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 latency-mode=normal ! h265parse ! mux. alsasrc device=hw:1,1 ! audio/x-raw, format=S24_32LE, rate=48000, channels=2 ! queue max-size-buffers=0 max-size-time=0 ! audioconvert ! faac ! aacparse ! queue max-size-bytes=0 ! mpegtsmux name=mux ! filesink location = "/media/usb/test.ts"

NOTE: File location should be USB-3.0 to avoid the read-write bandwidth issue.

  • Run the following gst-launch-1.0 command to play the recorded file using the GStreamer pipeline.
$ gst-launch-1.0 uridecodebin uri="file:///media/usb/test.ts" name=decode ! queue max-size-bytes=0 ! kmssink bus-id="a0070000.v_mix" decode. ! audioconvert ! audioresample ! audio/x-raw, rate=48000, channnels=2, format=S24_32LE ! alsasink device="hw:1,0"

NOTE: File location should be USB-3.0 to avoid the read-write bandwidth issue.

  • Run the following gst-launch-1.0 command to stream-out SDI video using GStreamer pipeline.
$ gst-launch-1.0 v4l2src device=/dev/video0 io-mode=4 ! video/x-raw, format=NV12, width=3840, height=2160, 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 latency-mode=normal ! h265parse ! mux. alsasrc device=hw:1,1 ! audio/x-raw, format=S24_32LE, rate=48000, channels=2 ! queue max-size-buffers=0 max-size-time=0  ! audioconvert ! faac ! aacparse ! queue max-size-bytes=0 ! mpegtsmux name=mux ! rtpmp2tpay ! udpsink host=192.168.25.89 port=5004

NOTE: Here 192.168.25.89 is host/client IP address and 5004 is port no.

  • Run the following gst-launch-1.0 command to display stream-in video using Gstreamer pipeline where 5004 is port no.
$ 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 demux. ! queue ! h265parse ! omxh265dec internal-entropy-buffers=5 latency-mode=normal ! queue max-size-bytes=0 ! kmssink bus-id="a0070000.v_mix" demux. ! queue  max-size-bytes=0 max-size-time=0 max-size-buffers=0 ! aacparse ! faad ! audioconvert ! audioresample ! audio/x-raw, rate=48000, channnels=2, format=S24_32LE ! alsasink device="hw:1,0"

Note: Low latency stream-in pipeline cannot be launched with vcu-gst-app. Hence use below gst-launch pipelines.

  • Run the following gst-launch-1.0 command for low-latency stream-out pipeline. Where "videoX" indicates a video node for the input source
$ gst-launch-1.0 v4l2src device=/dev/video0 io-mode=4 ! video/x-raw, format=NV12, width=3840, height=2160, framerate=60/1 ! omxh265enc qp-mode=auto gop-mode=basic gop-length=60 b-frames=0 target-bitrate=60000 num-slices=8 control-rate=low-latency prefetch-buffer=true low-bandwidth=false filler-data=true cpb-size=1000 initial-delay=500 periodicity-idr=60 ! video/x-h265, profile=main, alignment=nal ! queue max-size-bytes=0 ! mux. alsasrc device=hw:1,1 ! audio/x-raw, format=S24_32LE, rate=48000, channels=2 ! queue max-size-buffers=0 max-size-time=0  ! audioconvert ! faac ! aacparse ! queue max-size-bytes=0 ! mpegtsmux name=mux ! rtpmp2tpay ! udpsink host=192.168.25.89 port=5004

NOTE:Here 192.168.25.89 is host/client IP address and 5004 is port no.

  • Run the following gst-launch-1.0 command to display low-latency stream-in on SDI-Tx video using Gstreamer pipeline where 5004 is port no.
$ 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 demux. ! queue ! h265parse ! video/x-h265, profile=main, alignment=nal ! omxh265dec internal-entropy-buffers=5 low-latency=1 ! queue max-size-bytes=0 ! kmssink bus-id="a0070000.v_mix" demux. ! queue  max-size-bytes=0 max-size-time=0 max-size-buffers=0 ! aacparse ! faad ! audioconvert ! audioresample ! audio/x-raw, rate=48000, channnels=2, format=S24_32LE ! alsasink device="hw:1,0" 

Notes for gst-launch-1.0 commands:

  • Make sure SDI-Rx media pipeline is configured for 4kp60 resolution and source/sink have the same colour format. Run below xmedia-ctl commands to set resolution and format of SDI scaler node.

When SDI Input Source is NVIDIA SHIELD

$ xmedia-ctl -d /dev/media0 -V ' "a0080000.v_proc_ss":0 [fmt:UYVY10_1X20/3840x2160 field:none]'
$ xmedia-ctl -d /dev/media0 -V ' "a0080000.v_proc_ss":1 [fmt:VYYUYY8_1X24/3840x2160 field:none]'

NOTE: Make sure NVIDIA SHIELD is configured for 4kp resolution and UYVY8 colour format.

When SDI Input Source is ABOX

$ xmedia-ctl -d /dev/media0 -V ' "a0080000.v_proc_ss":0 [fmt:UYVY10_1X20/3840x2160 field:none]'
$ xmedia-ctl -d /dev/media0 -V ' "a0080000.v_proc_ss":1 [fmt:VYYUYY8_1X24/3840x2160 field:none]'

NOTE: Make sure ABOX is configured for 4kp resolution and UYVY8 colour format.

Notes for modetest commands:

  • Modetest command for 4kp60 Display
$ modetest -M xlnx -s 37:3840x2160-60@YUYV  -w 37:sdi_mode:5 -w 37:sdi_data_stream:8 -w 37:is_frac:0 &
  • Modetest command for 4kp30 Display
$ modetest -M xlnx -s 37:3840x2160-60@YUYV  -w 37:sdi_mode:4 -w 37:sdi_data_stream:8 -w 37:is_frac:0 &
  • Modetest command for 1080p60 Display
$ modetest -M xlnx -s 37:1920x1080-60@YUYV  -w 37:sdi_mode:2 -w 37:sdi_data_stream:2 -w 37:is_frac:0 &