This page provides all the information related to Design Module 3 - VCU TRD Multi stream Audio-Video design.

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 with soft audio codec. The TRD will serve as a platform to tune the performance parameters of VCU and arrive at optimal configurations for encoder and decoder blocks with audio-video synchronization.

This design supports the following video interfaces:

Sources:

• HDMI-Rx capture pipeline implemented in the PL

• MIPI CSI-2 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

• HDMI-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: 48 kHz

• Source: HDMI-Rx/ I2S-Rx

• Render: HDMI-Tx/ I2S-Tx/ DP

Audio Deliverables:

• Supports 1-4Kp60 Single Stream with either HDMI-Rx or I2S-Rx as input Audio source + HDMI-Rx / MIPI Rx as input Video source; and HDMI-Tx / I2S-Tx as Output Audio Sink + HDMI-Tx / DP as Output Video sink pipeline

• Supports 1-4Kp30 Single Stream with either HDMI-Rx or I2S-Rx as input Audio source + HDMI-Rx / MIPI Rx as input Video source; and HDMI-Tx / I2S-Tx as Output Audio Sink + HDMI-Tx / DP as Output Video sink pipeline

• Supports 1-1080p60 Single Stream with either HDMI-Rx or I2S-Rx as input Audio source + HDMI-Rx / MIPI Rx as input Video source; and HDMI-Tx / I2S-Tx as Output Audio Sink + HDMI-Tx / DP as Output Video sink pipeline

• Supports 2-4Kp30 multi-stream feature with HDMI-Rx and I2S-Rx as input Audio sources, with HDMI-Rx and MIPI Rx as an input Video sources;  and with HDMI-Tx and I2S-Tx as Output Audio Sink + HDMI-Tx as Output Video sink pipeline

• Supports 2-1080p60 multi-stream feature with HDMI-Rx and I2S-Rx as input Audio sources with HDMI-Rx and MIPI Rx as an input Video sources; and with HDMI-Tx and I2S-Tx as Output Audio Sink + HDMI-Tx as Output Video sink pipeline

Other features:

• This design supports single-channel Stream-Based SCD(Scene Change Detection) IP, only for the HDMI input source. SCD must be enabled for the HDMI input source through configuration.

Supported Resolution:

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

√ - Supported
x – Not supported
NA – Not applicable

The below sections describe the HDMI / MIPI Video Capture and HDMI Display with the Audio from HDMI / I2S sources. It is VCU TRD design supporting HDMI-Rx audio/video + HDMI-Tx with Audio/video and MIPI-Rx video + I2S-Rx audio with HDMI-Tx video + I2S-Tx audio.

For the overview, software tools, system requirements, and design files follow the link below:

• Zynq UltraScale+ MPSoC VCU TRD 2020.1

The below figure shows the HDMI, MIPI Video Capture along with HDMI, I2S Audio Capture and HDMI Display with Audio design hardware block diagram.

The below figure shows the HDMI, MIPI Video Capture  along with HDMI, I2S Audio Capture and HDMI Display with Audio design software block diagram.

                                                         

1.1 Board Setup

Refer below link for Board Setup

• Zynq UltraScale+ MPSoC VCU TRD 2020.1 Board Setup

• I2S Audio. signals from MPSoC PL fabric are connected to PMOD0 GPIO Header (J55 - right angle female connector )

• PMOD I2S2 Add on card connects to J55 connector and its Master/Slave select jumper (JP1) should be placed into the Slave (SLV) position

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.

• 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_audio/ to FAT32 formatted SD card directory.

TRD package contents specific to Multi-stream Audio-Video design is 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.

Execution of the application is shown below:

Example:

4Kp60 HEVC_HIGH Display Pipeline execution

4Kp60 HEVC_HIGH Record Pipeline execution

4Kp60 HEVC_HIGH Stream-out Pipeline execution

4Kp60 HEVC_HIGH Stream-in Pipeline execution

Latency Measurement: 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 Build Flow

• Zynq UltraScale+ MPSoC VCU TRD 2020.1 - Build Flow

2 Other Information

2.1 Known Issues

• Block Noise is observed in AVC_MEDIUM and AVC_LOW in 4Kp60 pipelines

• The digilent PMOD card cannot support the passive source like MICROPHONES. Only active sources are to be connected. Here the source is from the Aux cable which is connected in between the source (laptop) and PMOD card.

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

2.2 Limitations

• For playback in DP, video input resolution should match to DP's native resolution. This constraint is due to the support of the GUI. In the GUI case if we allow video source other than native resolution(by setting full screen overlay) then the graphics layer will disappear. To recover back GUI user need to kill and relaunch the GUI app. To avoid such condition TRD only supports video input resolution which is equal to DP's native resolution.

• 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 a 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 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 bitrate

2.4 Audio-Video Synchronization

Clocks and synchronization in GStreamer

When playing complex media, each sound and video sample must be played in a specific order at a specific time. For this purpose, GStreamer provides a synchronization mechanism.

GStreamer provides support for the following use cases:

• Non-live sources with access faster than playback rate. This is the case where one is reading media from a file and playing it back in a synchronized fashion. In this case, multiple streams need to be synchronized, like audio, video and subtitles.

• Capture and synchronized muxing/mixing of media from multiple live sources. This is a typical use case where you record audio and video from a microphone/camera and mux it into a file for storage.

• Streaming from (slow) network streams with buffering. This is the typical web streaming case where you access content from a streaming server using HTTP.

• Capture from live source and playback with configurable latency. This is used, for example, when capturing from a camera, applying an effect and displaying the result. It is also used when streaming low latency content over a network with UDP.

• Simultaneous live capture and playback from prerecorded content. This is used in audio recording cases where you play a previously recorded audio and record new samples, the purpose is to have the new audio perfectly in sync with the previously recorded data.

GStreamer uses a GstClock object, buffer timestamps and a SEGMENT event to synchronize streams in a pipeline as we will see in the next sections.

See the GStreamer documenation for more information:

• https://gstreamer.freedesktop.org/documentation/application-development/advanced/clocks.html?gi-language=c

Clock running-time

In a typical computer, there are many sources that can be used as a time source, e.g., the system time, soundcards, CPU performance counters, etc. For this reason, GStreamer has many GstClock implementations available. Note that clock time doesn't have to start from 0 or any other known value. Some clocks start counting from a particular start date, others from the last reboot, etc.

A GstClock returns the absolute-time according to that clock with gst_clock_get_time (). The absolute-time (or clock time) of a clock is monotonically increasing.
A running-time is the difference between a previous snapshot of the absolute-time called the base-time, and any other absolute-time.
running-time = absolute-time - base-time

A GStreamer GstPipeline object maintains a GstClock object and a base-time when it goes to the PLAYING state. The pipeline gives a handle to the selected GstClock to each element in the pipeline along with selected base-time. The pipeline will select a base-time in such a way that the running-time reflects the total time spent in the PLAYING state. As a result, when the pipeline is PAUSED, the running-time stands still.

Because all objects in the pipeline have the same clock and base-time, they can thus all calculate the running-time according to the pipeline clock.

Buffer running-time

To calculate a buffer running-time, we need a buffer timestamp and the SEGMENT event that preceded the buffer. First we can convert the SEGMENT event into a GstSegment object and then we can use the gst_segment_to_running_time () function to perform the calculation of the buffer running-time.

Synchronization is now a matter of making sure that a buffer with a certain running-time is played when the clock reaches the same running-time. Usually, this task is performed by sink elements. These elements also have to take into account the configured pipeline's latency and add it to the buffer running-time before synchronizing to the pipeline clock.

Non-live sources timestamp buffers with a running-time starting from 0. After a flushing seek, they will produce buffers again from a running-time of 0.
Live sources need to timestamp buffers with a running-time matching the pipeline running-time when the first byte of the buffer was captured.

Buffer stream-time

The buffer stream-time, also known as the position in the stream, is a value between 0 and the total duration of the media and it's calculated from the buffer timestamps and the preceding SEGMENT event.

The stream-time is used in:

• Report the current position in the stream with the POSITION query

• The position used in the seek events and queries

• The position used to synchronize controlled values

The stream-time is never used to synchronize streams, this is only done with the running-time.

Time overview

Here is an overview of the various timelines used in GStreamer.

The image below represents the different times in the pipeline when playing a 100ms sample and repeating the part between 50ms and 100ms.

You can see how the running-time of a buffer always increments monotonically along with the clock-time. Buffers are played when their running-time is equal to the clock-time - base-time. The stream-time represents the position in the stream and jumps backwards when repeating.

Clock providers

A clock provider is an element in the pipeline that can provide a GstClock object. The clock object needs to report an absolute-time that is monotonically increasing when the element is in the PLAYING state. It is allowed to pause the clock while the element is PAUSED.

Clock providers exist because they play back media at some rate, and this rate is not necessarily the same as the system clock rate. For example, a sound card may play back at 44.1 kHz, but that doesn't mean that after exactly 1 second according to the system clock, the sound card has played back 44100 samples. This is only true by approximation. In fact, the audio device has an internal clock based on the number of samples played that we can expose.

If an element with an internal clock needs to synchronize, it needs to estimate when a time according to the pipeline clock will take place according to the internal clock. To estimate this, it needs to slave its clock to the pipeline clock.

If the pipeline clock is exactly the internal clock of an element, the element can skip the slaving step and directly use the pipeline clock to schedule playback. This can be both faster and more accurate. Therefore, generally, elements with an internal clock like audio input or output devices will be a clock provider for the pipeline.

When the pipeline goes to the PLAYING state, it will go over all elements in the pipeline from sink to source and ask each element if they can provide a clock. The last element that can provide a clock will be used as the clock provider in the pipeline. This algorithm prefers a clock from an audio sink in a typical playback pipeline and a clock from source elements in a typical capture pipeline.

There exist some bus messages to let you know about the clock and clock providers in the pipeline. You can see what clock is selected in the pipeline by looking at the NEW_CLOCK message on the bus. When a clock provider is removed from the pipeline, a CLOCK_LOST message is posted and the application should go to PAUSED and back to PLAYING to select a new clock.

For more detail please refer: https://gstreamer.freedesktop.org/documentation/application-development/advanced/clocks.html?gi-language=c

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 inputs. This is 1 for single stream and 2 in case of Multi-stream.

Output:
Select the video interface
Options: HDMI 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 N^th input configuration
Options: 1-2

Input Type:
Input source type
Options: HDMI, MIPI, File, Stream

Uri:
File path or Network URL. Applicable for file playback and stream-in pipeline only. Supported file formats for playback are ts and mkv.
Options: file:///run/media/sda/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 number)

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

Format:
The format of input data.
Options: NV12

Enable SCD:
Stream-based SCD supports with HDMI input source only and must be enabled
Options: True, False

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

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

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

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 N^th record configuration
Options: 1-2

Out-File Name:
Record file path
e.g. /run/media/sda/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 N^th Streaming configuration
Options: 1-2

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, 5006

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 to the audio
Options: S24_32LE

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

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

Volume:
To set the volume level. The default value is 2.0
Options: 0.0 - 10.0

Source:
To set audio input source
Options: HDMI or I2S

Renderer:
To set audio output device
Options: HDMI, DP or I2S

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.

Mount Locations:

The mount locations for various devices can be found in the below table.
The mount locations can vary.  Users can use lsblk or mount to find the location of the mounted devices.

Below are some example mount points

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 Audio+Video (also I2S Audio + MIPI CSI Video pipelines for Display, Record & Playback, Stream-in and Stream-out use-cases.

• Kill the Qt GUI application running on the target board by executing the below commands from the serial console.

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

• When HDMI source is connected to 4Kp60 resolution, it shows as below:

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

Notes to set the format of SCD channel in media1 node:

• Run the following command to check the current resolution of SCD node (here media1 have combined SCD node with Video0).

• Make sure SCD media node resolution is set as per current pipeline resolution

Run the following command to change the resolution of SCD nodes(here media1 is combined with SCD media node and xlnx-scdchan.0 is SCD channel)

• For 4K resolution

• For 1080p resolution

• 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

  • Set config file for HDMI-1080p60

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

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

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

  • Set the HDMI source resolution to 4Kp60 (Home page → 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:

If DP-Tx link-up issue is observed after Linux booting, use the following command:

• Display RAW use case for HDMI: Run the following gst-launch-1.0 command to capture and display pass-through HDMI video and Audio using the GStreamer pipeline.

• Serial use case for HDMI: Run the following gst-launch-1.0 command to capture and display processed(capture → encode → decode → display) HDMI video and raw HDMI Audio using the GStreamer pipeline.

• Record use case for HDMI: Run the following gst-launch-1.0 command to record HDMI video and audio using the GStreamer pipeline.

• File Playback use case for HDMI: Run the following gst-launch-1.0 command to play the recorded file and HDMI audio using the GStreamer pipeline.

• Stream-out use case for HDMI: Run the following gst-launch-1.0 command to stream-out HDMI video and audio using the GStreamer pipeline.

• Stream-in use case for HDMI: Run the following gst-launch-1.0 command to play stream-in video and audio using the Gstreamer pipeline where 5004 is port number.

gst-launch-1.0 commands for MIPI video, I2S Audio: 

• Display RAW use case for MIPI and I2S audio input: Run the following gst-launch-1.0 command to capture and display passthrough MIPI video and I2S Audio using the GStreamer pipeline.

• Serial use case for MIPI and I2S audio input: Run the following gst-launch-1.0 command to capture and display processed (capture → encode → decode → display) MIPI video and raw I2S Audio using the GStreamer pipeline.

• Record use case for MIPI and I2S audio input: Run the following gst-launch-1.0 command to record MIPI video and I2S audio using the GStreamer pipeline.

• File Playback use case with I2S audio output: Run the following gst-launch-1.0 command to play the recorded file using the GStreamer pipeline.

• Stream-out use case for MIPI and I2S audio input: Run the following gst-launch-1.0 command to stream-out MIPI video and I2S audio using the GStreamer pipeline.

• Stream-in use case for I2S audio output: Run the following gst-launch-1.0 command to play stream-in video and audio using the Gstreamer pipeline where 5004 is port number.

Notes for gst-launch-1.0 commands:

• Make sure the HDMI-Rx media pipeline is configured for 4Kp60 resolution and source/sink has the same color format. Run below media-ctl commands to set the resolution and format of the HDMI scaler node.

• When HDMI Input Source is NVIDIA SHIELD

• When HDMI Input Source is ABOX