/Media-Transport-Library

A real-time media transport (LibOS UDP and SMPTE ST 2110) stack based on DPDK and COTS hardware.

Primary LanguageCBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Intel® Media Transport Library

Ubuntu Windows Test OpenSSF Scorecard CodeQL Dependency Review

1. Overview

The Intel® Media Transport Library is a DPDK-based solution designed for high-throughput, low-latency transmission and reception of media data. It features an efficient user-space LibOS UDP stack specifically crafted for media transport, and comes equipped with a built-in SMPTE ST 2110-compliant implementation for Professional Media over Managed IP Networks.

1.1 Features

  • The User-space LibOS UDP stack features a POSIX socket compatible API.
  • Non-root run.
  • Multi-process handling, allowing for up to 8 NICs per process.
  • Virtualization support by SR-IOV.

1.1.1 ST2110 features

  • ST2110-10, ST2110-20, ST2110-21, ST2110-30, ST2110-40, ST2110-22, ST2022-7
  • 1080p, 720p, 4k, 8k and other
  • FPS: 120, 119.88, 100, 60, 59.94, 50, 30, 29.97, 25, 24, 23.98
  • All video formats listed in ST2110-20, including YUV 4:2:2 10-bit and others, are supported.
  • CSC support status: status
  • ST2022-6 by RTP passthrough interface.

1.2 Architecture

The Intel® Media Transport Library leverages DPDK features to implement a highly efficient, real-time, and low-latency media transport stack. This software-based media transport solution enables deployment on edge and cloud environments using COTS hardware.

The library introduces a tasklet asynchronous-based scheduler that maximizes CPU resources, making it easy to integrate with various packet processing units and accelerators.

The packet pacing module supports various algorithms to achieve narrow pacing, including RL (rate limit) which is partially hardware offloaded and TSC which is fully software-based.

The library also includes SIMD CSC (color space format conversion), DMA, and plugin interfaces to enable the creation of a complete video production ecosystem.

overall architecture

1.3 Ethernet supported

Regarding supported Ethernet, since MTL is based on DPDK, it can essentially run well on any Ethernet already supported by DPDK. You can refer to the site https://doc.dpdk.org/guides/nics/ for a list of supported Ethernet hardware in DPDK.

However, please note that our daily development and validation is primarily conducted on the Intel E810 series and AWS ENA, so we can't guarantee the status for other network interface cards (NICs).

An important point to note is that narrow pacing of TX is only supported for the Intel E810 series due to its rate limit feature. All other NICs have to use TSC (Timestamp Counter) as the pacing source, which can only ensure a broad wide pacing.

2. Build

Please refer to build guide for instructions on how to build DPDK, the library, and the sample application.

For Windows, please refer to the Win build guide for instructions on how to build.

3. Run ST2110

Please refer to run guide for instructions on how to set up and run the demo pipeline application based on VF with SR-IOV.

For Windows, please refer to Windows run guide.

Additionally, please refer to the VM guide and Windows VM guide for instructions on setting up Linux and Windows guest VMs based on VF passthrough.

For AWS (cloud environment), please refer to AWS run guide for instructions on how to set up and run the demo.

4. ST2110 Programmers guide

To quickly develop applications based on the Intel® Media Transport Library, please refer to the sample code.

5. User space LibOS UDP stack guide

Starting from version 23.03.0, this library extends support for a user-space UDP stack that runs directly under the current process context for improved performance. Other user-space UDP stacks typically run with a client-service architecture, which introduces cross-core message costs that can negatively impact performance.

Our stack runs the NIC tx/rx function directly from the sendto/recvfrom API, which eliminates the need for cross-core calls and maintains data affinity (LLC) to the UDP consumer.

To learn how to use the LibOS UDP stack, please refer to the udp doc.

6. Publication

MHV'23: A Real-time Media Transport Stack Based on Commercial Off-the-shelf Hardware. https://dl.acm.org/doi/10.1145/3588444.3591002

Whitepaper: Open Source Library Enables Real-Time Media over IP Networks. https://www.intel.com/content/www/us/en/content-details/786203/open-source-library-enables-real-time-media-over-ip-networks.html

2022 DPDK Userspace Summit: Real-time and low latency media transport stack based on DPDK. https://www.youtube.com/watch?v=fiiOvHezpBs

7. How to Contribute

We welcome community contributions to the Intel® Media Transport Library project. If you have any ideas or issues, please share them with us by using GitHub issues or opening a pull request.

7.1 Coding style

We use the super-linter action for style checks.

For C/C++ coding, you can run the following command to quickly fix the style:

./format-coding.sh

For other languages, please check with the following example command inside the Docker container:

# super-linter
docker run -it --rm  -v "$PWD":/opt/ --entrypoint /bin/bash github/super-linter

cd /opt/

# echo "shell check"
find ./ -name "*.sh" -exec shellcheck {} \;

# hadolint check
hadolint docker/ubuntu.dockerfile

# actionlint check
actionlint

# markdownlint check
find ./ -name "*.md" -exec markdownlint {} -c .markdown-lint.yml \;
# find ./ -name "*.md" -exec markdownlint {} --fix -c .markdown-lint.yml \;

# textlint
find ./ -name "*.md" -exec textlint {} \;
# find ./ -name "*.md" -exec textlint {} --fix \;