Skip to content

Commit adc48c8

Browse files
authored
naming: use Media Transport Library (#889)
Intel® Media Transport Library -> Media Transport Library Signed-off-by: Frank Du <[email protected]> (cherry picked from commit 6606dea)
1 parent f0e74ae commit adc48c8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+223
-223
lines changed

ATTRIBUTION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Intel® Media Transport Library
1+
# Media Transport Library
22

33
Component: json-c</br>
44
Repository: <https://github.com/json-c/json-c></br>

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@
141141
* Windows: add TAP driver support.
142142
* API: change st20_frame_meta to st20_rx_frame_meta, also add st20_tx_frame_meta for get_next_frame of st20 tx.
143143
* API: change st_frame_meta to st_frame, also change the callback arg of st20p.notify_frame_done from (void*) to struct (st_frame*).
144-
* plugin: add Intel® Media Transport Library as a plugin to OBS, only rx path now.
144+
* plugin: add Media Transport Library as a plugin to OBS, only rx path now.
145145
* fps: add 120(119.88) fps support, see ST_FPS_P119_88.
146146

147147
## Changelog for 22.06

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Intel® Media Transport Library
1+
# Media Transport Library
22

33
[![Ubuntu](https://github.com/OpenVisualCloud/Media-Transport-Library/actions/workflows/ubuntu_build.yml/badge.svg)](https://github.com/OpenVisualCloud/Media-Transport-Library/actions/workflows/ubuntu_build.yml)
44
[![Windows](https://github.com/OpenVisualCloud/Media-Transport-Library/actions/workflows/msys2_build.yml/badge.svg)](https://github.com/OpenVisualCloud/Media-Transport-Library/actions/workflows/msys2_build.yml)
@@ -10,9 +10,9 @@ Scorecard](https://api.securityscorecards.dev/projects/github.com/OpenVisualClou
1010

1111
## 1. Overview
1212

13-
The Intel® Media Transport Library(IMTL) is a software 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.
13+
The Media Transport Library(MTL) is a software 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.
1414

15-
The Intel® Media Transport Library solves the strict timing challenges of transporting ST2110 compliant media streams using a software library and through IP networks. Instead of specialized hardware, this library leverages existing commonly available CPU platforms with conventional NICs that incorporate rate limiting to meet the strict timing challenges in the SMPTE ST 2110 standard.
15+
The Media Transport Library solves the strict timing challenges of transporting ST2110 compliant media streams using a software library and through IP networks. Instead of specialized hardware, this library leverages existing commonly available CPU platforms with conventional NICs that incorporate rate limiting to meet the strict timing challenges in the SMPTE ST 2110 standard.
1616

1717
If you find value in our project, please consider giving it a star. Your support helps us grow and reach more people in the open-source community. Every star counts and is greatly appreciated.
1818

@@ -41,7 +41,7 @@ If you find value in our project, please consider giving it a star. Your support
4141

4242
### 1.2 Architecture
4343

44-
The Intel® Media Transport Library leverages DPDK (Data Plane Development Kit) EAL (Environment Abstraction Layer including the memory and core management) to implement a highly efficient, real-time, and low-latency media transport solution. This software-based media transport stack enables deployment on edge and cloud environments using COTS hardware.
44+
The Media Transport Library leverages DPDK (Data Plane Development Kit) EAL (Environment Abstraction Layer including the memory and core management) to implement a highly efficient, real-time, and low-latency media transport solution. This software-based media transport stack enables deployment on edge and cloud environments using COTS hardware.
4545

4646
The library incorporates a virtual data path backend layer, designed to abstract various NIC implementation and provide a unified packet TX/RX interface to the upper network layer. It currently supports three types of NIC devices:
4747

@@ -53,7 +53,7 @@ The library introduces a tasklet-based asynchronous scheduler that optimizes CPU
5353

5454
Additionally, the packet pacing module offers support for various pacing algorithms, including RL (Rate Limit), which is partially hardware-offloaded, and TSC (timestamp Counter), which is fully software-based.
5555

56-
IMTL also incorporates SIMD (Single Instruction, Multiple Data) for CSC (Color Space Format Conversion) of the big-endian and little-endian, DMA (Direct Memory Access), and plugin interfaces, enabling the creation of a comprehensive video production ecosystem.
56+
MTL also incorporates SIMD (Single Instruction, Multiple Data) for CSC (Color Space Format Conversion) of the big-endian and little-endian, DMA (Direct Memory Access), and plugin interfaces, enabling the creation of a comprehensive video production ecosystem.
5757

5858
For the detail design, please refer to [design guide](doc/design.md).
5959

@@ -63,11 +63,11 @@ For the detail design, please refer to [design guide](doc/design.md).
6363

6464
### 1.3 Ethernet supported
6565

66-
IMTL offers versatile Ethernet support, thanks to its compatibility with DPDK PMD, kernel socket, and AF_XDP backends.
66+
MTL offers versatile Ethernet support, thanks to its compatibility with DPDK PMD, kernel socket, and AF_XDP backends.
6767

6868
For DPDK PMD support, you can refer to the DPDK PMD site <https://doc.dpdk.org/guides/nics/> for a comprehensive list of supported Ethernet hardware.
6969

70-
In cases where your NIC is not supported by DPDK, IMTL provides a fallback option with kernel (Linux) socket transport support.
70+
In cases where your NIC is not supported by DPDK, MTL provides a fallback option with kernel (Linux) socket transport support.
7171

7272
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).
7373

@@ -93,12 +93,12 @@ To run this library on the kernel network stack with the built-in kernel NIC dri
9393

9494
## 4. ST2110 Programmers guide
9595

96-
To quickly develop applications based on the Intel® Media Transport Library, please refer to `## 6. ST2110 API` from [design guide](doc/design.md).
96+
To quickly develop applications based on the Media Transport Library, please refer to `## 6. ST2110 API` from [design guide](doc/design.md).
9797

9898
## 5. User space LibOS UDP stack guide
9999

100-
IMTL has support for a LD preload POSIX-compatible user-space UDP stack that operates directly within the current process context. This enhancement significantly boosts performance by eliminating the cross-core message costs typically associated with client-service architectures used in other user-space UDP stacks.
101-
IMTL's stack allows the NIC transmission and reception functions to run directly from the sendto/recvfrom API, eliminating the need for cross-core calls and maintaining data affinity (LLC) to the UDP consumer, thereby optimizing performance.
100+
MTL has support for a LD preload POSIX-compatible user-space UDP stack that operates directly within the current process context. This enhancement significantly boosts performance by eliminating the cross-core message costs typically associated with client-service architectures used in other user-space UDP stacks.
101+
MTL's stack allows the NIC transmission and reception functions to run directly from the sendto/recvfrom API, eliminating the need for cross-core calls and maintaining data affinity (LLC) to the UDP consumer, thereby optimizing performance.
102102

103103
To learn how to use the LibOS UDP stack, please refer to the [udp doc](doc/udp.md).
104104

@@ -112,7 +112,7 @@ Whitepaper: Open Source Library Enables Real-Time Media over IP Networks. <https
112112

113113
## 7. How to Contribute
114114

115-
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.
115+
We welcome community contributions to the 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.
116116

117117
### 7.1 Fork this repository
118118

action.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ runs:
7171
./configure --prefix=$MSYSTEM_PREFIX
7272
make && make install
7373
74-
- name: Checkout IMTL repo
74+
- name: Checkout MTL repo
7575
uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 # v4.1.2
7676
with:
7777
repository: 'OpenVisualCloud/Media-Transport-Library'
@@ -110,34 +110,34 @@ runs:
110110
meson setup build
111111
meson install -C build
112112
113-
- name: Build IMTL lib
113+
- name: Build MTL lib
114114
shell: msys2 {0}
115115
run: |
116116
meson setup build
117117
meson install -C build
118118
119-
- name: Build IMTL app
119+
- name: Build MTL app
120120
shell: msys2 {0}
121121
run: |
122122
cd app
123123
meson setup build
124124
meson compile -C build
125125
126-
- name: Build IMTL test
126+
- name: Build MTL test
127127
shell: msys2 {0}
128128
run: |
129129
cd tests
130130
meson setup build
131131
meson compile -C build
132132
133-
- name: Build IMTL plugins
133+
- name: Build MTL plugins
134134
shell: msys2 {0}
135135
run: |
136136
cd plugins
137137
meson setup build
138138
meson install -C build
139139
140-
- name: Build IMTL lib with TAP
140+
- name: Build MTL lib with TAP
141141
shell: msys2 {0}
142142
run: |
143143
meson setup tap_build -Denable_tap=${{inputs.tap}}

app/sample/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## 1. Introduction
44

5-
The dir include the simple sample code for how to develop application quickly based on Intel® Media Transport Library.
5+
The dir include the simple sample code for how to develop application quickly based on Media Transport Library.
66

77
## 2. Pipeline samples which based on get/put APIs
88

app/sample/msvc/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
## 1. Introduction
44

5-
The is sample code for how to develop MSVC application quickly based on Intel® Media Transport Library. The guide is verified with Visual Studio 2022 (v143).
5+
The is sample code for how to develop MSVC application quickly based on Media Transport Library. The guide is verified with Visual Studio 2022 (v143).
66

77
## 2. Steps
88

99
### 2.1 Prepare latest .lib file
1010

11-
* Build IMTL library in MSYS2, see [WIN build guide](../../../doc/build_WIN.md), also need to add MSYS2 binary PATH to system environment variables.
11+
* Build MTL library in MSYS2, see [WIN build guide](../../../doc/build_WIN.md), also need to add MSYS2 binary PATH to system environment variables.
1212

1313
* After build, in the build folder, you will get `libmtl.def` file.
1414

app/sample/msvc/imtl_sample/imtl_sample.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ void signalHandler(int signum) {
3131

3232
int main() {
3333
int ret = 0;
34-
std::cout << "Starting IMTL sample..." << std::endl << mtl_version() << std::endl;
34+
std::cout << "Starting MTL sample..." << std::endl << mtl_version() << std::endl;
3535

3636
std::signal(SIGINT, signalHandler);
3737

app/udp/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## 1. Introduction
44

5-
The dir include the simple sample code for how to develop application quickly based on UDP API of Intel® Media Transport Library.
5+
The dir include the simple sample code for how to develop application quickly based on UDP API of Media Transport Library.
66

77
## 2. Samples with POSIX socket compatible(file descriptor) API
88

doc/asan.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ASan guide
22

3-
AddressSanitizer (also known as ASan, <https://github.com/google/sanitizers/wiki/AddressSanitizer>) is a fast memory error detector for C/C++ developed by Google. The Intel® Media Transport Library uses ASan for memory-related checks. ASan is a part of LLVM (version 3.1+) and GCC (version 4.8+). To enable ASan, pass the -fsanitize=address option to the compiler flags.
3+
AddressSanitizer (also known as ASan, <https://github.com/google/sanitizers/wiki/AddressSanitizer>) is a fast memory error detector for C/C++ developed by Google. The Media Transport Library uses ASan for memory-related checks. ASan is a part of LLVM (version 3.1+) and GCC (version 4.8+). To enable ASan, pass the -fsanitize=address option to the compiler flags.
44

55
The library uses DPDK API to perform memory malloc/free operations. Therefore, the error monitoring capability depends on the DPDK ASan support.
66

@@ -19,7 +19,7 @@ pkg-config --libs libdpdk
1919
pkg-config --modversion libdpdk
2020
```
2121

22-
## 2. Build Intel® Media Transport Library with ASan detector
22+
## 2. Build Media Transport Library with ASan detector
2323

2424
```bash
2525
rm build/ -rf

doc/aws.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ Instance example:
1414

1515
![instance](png/instance.png)
1616

17-
## 2. Install Intel® Media Transport Library and other software
17+
## 2. Install Media Transport Library and other software
1818

19-
### 2.1 Build and install DPDK & Intel® Media Transport Library
19+
### 2.1 Build and install DPDK & Media Transport Library
2020

2121
Refer to CentOS part of [build.md](./build.md).
2222

@@ -55,7 +55,7 @@ Choose same subnet for all new interfaces, set the right security groups for you
5555

5656
Right-click on your running instance, go to `Networking > Attach network interface`, choose an idle interface.
5757

58-
After attaching the interface, remember the Private IPv4 address allocated by AWS, this will be used by Intel® Media transport library as interface IP.
58+
After attaching the interface, remember the Private IPv4 address allocated by AWS, this will be used by Media Transport Library as interface IP.
5959

6060
### 4.3 Bind interface to DPDK PMD
6161

0 commit comments

Comments
 (0)