Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[RT Common] Changed references of oneVPL to Intel VPL in Readme.md #325

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[RT Common] Changed references of oneVPL to Intel VPL in Readme.md #325

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 24 additions & 24 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Intel® oneVPL GPU Runtime
# Intel® Video Processing Library (Intel® VPL) GPU Runtime

Intel® oneVPL GPU Runtime is a Runtime implementation of [oneVPL](https://github.com/oneapi-src/oneVPL/)
Intel® Video Processing Library (Intel® VPL) GPU Runtime is a Runtime implementation of [Intel® VPL](https://github.com/intel/vpl-gpu-rt/)
API for Intel Gen GPUs. Runtime provides access to hardware-accelerated video decode, encode and filtering.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here the original link is the dispatcher link (https://github.com/oneapi-src/oneVPL/), so link "https://github.com/intel/vpl-gpu-rt/" should be changed to "https://github.com/intel/libvpl/"


**Supported video encoders**: HEVC, AVC, MPEG-2, JPEG, VP9
Expand All @@ -9,29 +9,29 @@ API for Intel Gen GPUs. Runtime provides access to hardware-accelerated video de

Implementation is written in C++ 14 with parts in C-for-Media (CM).

oneVPL GPU Runtime is a part of Intel software stack for graphics:
Intel® VPL GPU Runtime is a part of Intel software stack for graphics:
* [Linux Graphics Drivers](https://intel.com/linux-graphics-drivers) - General Purpose GPU Drivers for Linux Operating Systems
* Visit [documentation](https://dgpu-docs.intel.com) for instructions on installing, deploying, and updating Intel software to enable general purpose GPU (GPGPU) capabilities for Linux-based operating system distributions.

oneVPL Library and oneVPL GPU Runtime are successors for Intel [Media SDK](https://github.com/Intel-Media-SDK/MediaSDK).
Intel® VPL Library and Intel® VPL GPU Runtime are successors for Intel [Media SDK](https://github.com/Intel-Media-SDK/MediaSDK).

# How to use

This runtime implementation is not self-sufficient. Application should use
one of the available frontend dispatcher libraries:

* [oneVPL](https://github.com/oneapi-src/oneVPL/)
* [Intel® VPL](https://github.com/intel/libvpl/)
* [Media SDK](https://github.com/Intel-Media-SDK/MediaSDK)

We strongly recommend to use [oneVPL](https://github.com/oneapi-src/oneVPL/)
We strongly recommend to use [Intel® VPL](https://github.com/intel/libvpl/)
as a dispatcher frontend (libvpl.so.2). [Media SDK](https://github.com/Intel-Media-SDK/MediaSDK)
dispatcher (libmfx.so.1) can be used as well, but you will get capabilities limited by those which
are exposed via Media SDK API and which are actually implemented by oneVPL
are exposed via Media SDK API and which are actually implemented by Intel® VPL
Runtime. Basically, compatibility with Media SDK is provided to support
Media SDK based applications which did not yet migrate to oneVPL on a new HW
Media SDK based applications which did not yet migrate to Intel® VPL on a new HW
platforms.

oneVPL Gen Runtime implementation supports the following hardware platforms:
Intel® VPL Gen Runtime implementation supports the following hardware platforms:

| GPU | Supported |
| --- | --------- |
Expand All @@ -42,9 +42,9 @@ oneVPL Gen Runtime implementation supports the following hardware platforms:
| ADL-P (Alder Lake P) | ✔ |

# Dependencies
oneVPL GPU Runtime depends on [LibVA](https://github.com/intel/libva/).
This version of oneVPL GPU Runtime is compatible with the open source [Intel Media Driver for VAAPI](https://github.com/intel/media-driver).
Dispatcher and Samples code hosted in [oneVPL](https://github.com/oneapi-src/oneVPL/) repository.
Intel® VPL GPU Runtime depends on [LibVA](https://github.com/intel/libva/).
This version of Intel® VPL GPU Runtime is compatible with the open source [Intel Media Driver for VAAPI](https://github.com/intel/media-driver).
Dispatcher and Samples code hosted in [Intel® VPL](https://github.com/intel/libvpl/) repository.

# Table of contents

Expand All @@ -58,7 +58,7 @@ Dispatcher and Samples code hosted in [oneVPL](https://github.com/oneapi-src/one
* [See also](#see-also)

# License
oneVPL GPU Runtime is licensed under MIT license. See [LICENSE](./LICENSE) for details.
Intel® VPL GPU Runtime is licensed under MIT license. See [LICENSE](./LICENSE) for details.

# How to contribute
See [CONTRIBUTING](./CONTRIBUTING.md) for details. Thank you!
Expand All @@ -81,35 +81,35 @@ See [CONTRIBUTING](./CONTRIBUTING.md) for details. Thank you!

## Build steps

Get sources with the following Git* command (pay attention that to get full oneVPL GPU Runtime sources bundle it is required to have Git* with [LFS](https://git-lfs.github.com/) support):
Get sources with the following Git* command (pay attention that to get full Intel® VPL GPU Runtime sources bundle it is required to have Git* with [LFS](https://git-lfs.github.com/) support):
```sh
git clone https://github.com/oneapi-src/oneVPL-intel-gpu onevpl-gpu
cd onevpl-gpu
git clone https://github.com/intel/vpl-gpu-rt vpl-gpu-rt
cd vpl-gpu-rt
```

To configure and build oneVPL GPU Runtime install cmake version 3.14 or later and run the following commands:
To configure and build Intel® VPL GPU Runtime install cmake version 3.14 or later and run the following commands:
```sh
mkdir build && cd build
cmake ..
make
make install
```
oneVPL GPU Runtime depends on a number of packages which are identified and checked for the proper version during configuration stage. Please, make sure to install these packages to satisfy oneVPL GPU Runtime requirements. After successful configuration 'make' will build oneVPL GPU Runtime binaries and samples. The following cmake configuration options can be used to customize the build:
Intel® VPL GPU Runtime depends on a number of packages which are identified and checked for the proper version during configuration stage. Please, make sure to install these packages to satisfy Intel® VPL GPU Runtime requirements. After successful configuration 'make' will build Intel® VPL GPU Runtime binaries and samples. The following cmake configuration options can be used to customize the build:

| Option | Values | Description |
| ------ | ------ | ----------- |
| ENABLE_ITT | ON\|OFF | Enable ITT (VTune) instrumentation support (default: OFF) |
| ENABLE_TEXTLOG | ON\|OFF | Enable textlog trace support (default: OFF) |
| ENABLE_STAT | ON\|OFF | Enable stat trace support (default: OFF) |
| BUILD_ALL | ON\|OFF | Build all the BUILD_* targets below (default: OFF) |
| BUILD_RUNTIME | ON\|OFF | Build oneVPL runtime (default: ON) |
| BUILD_RUNTIME | ON\|OFF | Build Intel® VPL runtime (default: ON) |
| BUILD_TESTS | ON\|OFF | Build unit tests (default: OFF) |
| USE_SYSTEM_GTEST | ON\|OFF | Use system gtest version instead of bundled (default: OFF) |
| BUILD_TOOLS | ON\|OFF | Build tools (default: OFF) |
| MFX_ENABLE_KERNELS | ON\|OFF | Build oneVPL with [media shaders](https://github.com/Intel-Media-SDK/MediaSDK/wiki/Media-SDK-Shaders-(EU-Kernels)) support (default: ON) |
| MFX_ENABLE_KERNELS | ON\|OFF | Build Intel® VPL with [media shaders](https://github.com/Intel-Media-SDK/MediaSDK/wiki/Media-SDK-Shaders-(EU-Kernels)) support (default: ON) |


The following cmake settings can be used to adjust search path locations for some components oneVPL GPU Runtime build may depend on:
The following cmake settings can be used to adjust search path locations for some components Intel® VPL GPU Runtime build may depend on:

| Setting | Values | Description |
| ------- | ------ | ----------- |
Expand All @@ -122,12 +122,12 @@ To enable the Instrumentation and Tracing Technology (ITT) API you need to:
* Either install [Intel® VTune™ Amplifier](https://software.intel.com/en-us/intel-vtune-amplifier-xe)
* Or manually build an open source version (see [ITT API](https://github.com/intel/ittapi) for details)

and configure oneVPL GPU Runtime with the -DENABLE_ITT=ON. In case of VTune it will be searched in the default location (/opt/intel/vtune_amplifier). You can adjust ITT search path with either CMAKE_ITT_HOME or CMAKE_VTUNE_HOME.
and configure Intel® VPL GPU Runtime with the -DENABLE_ITT=ON. In case of VTune it will be searched in the default location (/opt/intel/vtune_amplifier). You can adjust ITT search path with either CMAKE_ITT_HOME or CMAKE_VTUNE_HOME.

Once oneVPL GPU Runtime was built with ITT support, enable it in a runtime creating per-user configuration file ($HOME/.mfx_trace) or a system wide configuration file (/etc/mfx_trace) with the following content:
Once Intel® VPL GPU Runtime was built with ITT support, enable it in a runtime creating per-user configuration file ($HOME/.mfx_trace) or a system wide configuration file (/etc/mfx_trace) with the following content:
```sh
Output=0x10
```
# Recommendations

* In case of GCC compiler it is strongly recommended to use GCC version 6 or later since that's the first GCC version which has non-experimental support of C++14 being used in oneVPL GPU Runtime.
* In case of GCC compiler it is strongly recommended to use GCC version 6 or later since that's the first GCC version which has non-experimental support of C++14 being used in Intel® VPL GPU Runtime.
Loading