Skip to content
master
Switch branches/tags
Go to file
Code

README.md

Intel(R) Media Driver for VAAPI

Introduction

The Intel(R) Media Driver for VAAPI is a new VA-API (Video Acceleration API) user mode driver supporting hardware accelerated decoding, encoding, and video post processing for GEN based graphics hardware.

License

The Intel(R) Media Driver for VAAPI is distributed under the MIT license with portions covered under the BSD 3-clause "New" or "Revised" License. You may obtain a copy of the License at MIT & BSD-3-Clause

Prerequisites

For Ubuntu 16.04+

apt install autoconf libtool libdrm-dev xorg xorg-dev openbox libx11-dev libgl1-mesa-glx libgl1-mesa-dev

Equivalents for other distributions should work.

Dependencies

Building

  1. Build and install libva master
  2. Build and install gmmlib master
  3. Get media repo and format the workspace folder as below (suggest the workspace to be a dedicated one for media driver build):
<workspace>
    |- media-driver
  1. Create build_media new folder under your workspace
$ mkdir <workspace>/build_media

then the workspace looks like below

<workspace>
    |- media-driver
    |- build_media
$ cd <workspace>/build_media
$ cmake ../media-driver
$ make -j"$(nproc)"

Install

$ sudo make install

This will install the following files (e.g. on Ubuntu):

-- Installing: /usr/lib/x86_64-linux-gnu/dri/iHD_drv_video.so
-- Installing: /etc/profile.d/intel-media.sh
-- Installing: /usr/lib/x86_64-linux-gnu/igfxcmrt64.so

For iHD_drv_video.so please export related LIBVA environment variables.

export LIBVA_DRIVERS_PATH=<path-contains-iHD_drv_video.so>
export LIBVA_DRIVER_NAME=iHD

Supported Platforms

  • BDW (Broadwell)
  • SKL (Skylake)
  • BXT (Broxton) / APL (Apollo Lake)
  • KBLx (KBL/Kaby Lake; CFL/Coffe Lake; WHL/Whiskey Lake; CML/Comet Lake; AML/Amber Lake)
  • ICL (Ice Lake)
  • JSL (Jasper Lake)/EHL (Elkhart Lake)
  • TGL (Tiger Lake)
  • DG1/SG1

Components and Features

Media driver contains three components as below

  • Video decoding calls hardware-based decoder(VDBox) which provides fully-accelerated hardware video decoding to release the graphics engine for other operations.
  • Video encoding supports two modes, one calls hardware-based encoder(VDEnc/Huc) to provide low power encoding, another one is hardware(PAK)+shader(media kernel+VME) based encoding. User could choose the mode through VA-API.
  • Video processing supports several popular features by hardware-based video processor(VEBox/SFC) and shader(media kernel) based solution together.

Media driver supports two build types as below

  • Full Feature Build is default driver build, which supports all feature by hardware accelerator and close source shaders(media kernel binaries). Ubuntu intel-media-va-driver-non-free package is generated from this build type.
  • Free Kernel Build, enables fully open source shaders(media kernels) and hardware features but the features would be limited. Ubuntu intel-media-va-driver package is generated from this build type.

Decoding/Encoding Features

CODEC Build Types BDW SKL BXT/APL KBLx ICL EHL/JSL TGL/RKL/ADL-S DG1/SG1
AVC Full-Feature
Free-Kernel
D/Es
D
D/E/Es
D/E
D/E/Es
D/E
D/E/Es
D/E
D/E/Es
D/E
D/E
D/E
D/E/Es
D/E
D/E/Es
D/E
MPEG-2 Full-Feature
Free-Kernel
D/Es
D
D/Es
D
D
D
D/Es
D
D/Es
D
D
D
D/Es
D
D/Es
D
VC-1 Full-Feature
Free-Kernel
D
 
D
 
D
 
D
 
D
 
D
 
D
 
D
 
JPEG Full-Feature
Free-Kernel
D
D
D/E
D/E
D/E
D/E
D/E
D/E
D/E
D/E
D/E
D/E
D/E
D/E
D/E
D/E
VP8 Full-Feature
Free-Kernel
D
D
D
D
D
D
D/Es
D
D/Es
D
D
D
D*
D*
HEVC 8bit Full-Feature
Free-Kernel
D/Es
D
D/Es
D
D/Es
D
D/E/Es
D/E
D/E
D/E
D/E/Es
D/E
D/E/Es
D/E
HEVC 8bit 422 Full-Feature
Free-Kernel
D/Es
D
D
D
D/Es
D
D/Es
D
HEVC 8bit 444 Full-Feature
Free-Kernel
D/E
D/E
D/E
D/E
D/E
D/E
D/E
D/E
HEVC 10bit Full-Feature
Free-Kernel
D
D
D/Es
D
D/E/Es
D/E
D/E
D/E
D/E/Es
D/E
D/E/Es
D/E
HEVC 10bit 422 Full-Feature
Free-Kernel
D/Es
D
D
D
D/Es
D
D/Es
D
HEVC 10bit 444 Full-Feature
Free-Kernel
D/E
D/E
D/E
D/E
D/E
D/E
D/E
D/E
HEVC 12bit Full-Feature
Free-Kernel
D/Es
D
D/Es
D
HEVC 12bit 422 Full-Feature
Free-Kernel
D
D
D
D
HEVC 12bit 444 Full-Feature
Free-Kernel
D
D
D
D
VP9 8bit Full-Feature
Free-Kernel
D
D
D
D
D/E
D/E
D/E
D/E
D/E
D/E
D/E
D/E
VP9 8bit 444 Full-Feature
Free-Kernel
D/E
D/E
D/E
D/E
D/E
D/E
D/E
D/E
VP9 10bit Full-Feature
Free-Kernel
D
D
D/E
D/E
D/E
D/E
D/E
D/E
D/E
D/E
VP9 10bit 444 Full-Feature
Free-Kernel
D/E
D/E
D/E
D/E
D/E
D/E
D/E
D/E
VP9 12bit Full-Feature
Free-Kernel
D
D
D
D
VP9 12bit 444 Full-Feature
Free-Kernel
D
D
D
D
AV1 8bit Full-Feature
Free-Kernel
D
D**
D
D**
AV1 10bit Full-Feature
Free-Kernel
D
D**
D
D**
  • D - Hardware Decoding
  • E - Hardware Encoding, Low Power Encoding(VDEnc/Huc)
  • Es - Hardware(PAK) + Shader(media kernel+VME) Encoding

* VP8 decoding is only supported on TGL platform

** AV1 film grain kernel is not open so far

For more information, please refer to

Video Processing Features

Features Build Types BDW SKL BXT/APL KBLx ICL EHL/JSL TGL/RKL/ADL-S DG1/SG1
Blending Full-Feature
Free-Kernel
Yes
 
Yes
 
Yes
 
Yes
 
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
CSC
(Color Space Conversion)
Full-Feature
Free-Kernel
Yes
 
Yes
 
Yes
 
Yes
 
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
De-interlace Full-Feature
Free-Kernel
Yes
 
Yes
 
Yes
 
Yes
 
Yes
Yes
Yes*
Yes*
Yes
Yes
Yes
Yes
De-noise Full-Feature
Free-Kernel
Yes
 
Yes
 
Yes
 
Yes
 
Yes
 
No
 
Yes
 
Yes
 
Luma Key Full-Feature
Free-Kernel
Yes
 
Yes
 
Yes
 
Yes
 
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Mirroring Full-Feature
Free-Kernel
Yes
 
Yes
 
Yes
 
Yes
 
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
ProcAmp
(brightness,contrast,hue,saturation)
Full-Feature
Free-Kernel
Yes
 
Yes
 
Yes
 
Yes
 
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Rotation Full-Feature
Free-Kernel
Yes
 
Yes
 
Yes
 
Yes
 
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Scaling Full-Feature
Free-Kernel
Yes
 
Yes
 
Yes
 
Yes
 
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Sharpening Full-Feature
Free-Kernel
Yes
 
Yes
 
Yes
 
Yes
 
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
STD/E
(Skin Tone Detect & Enhancement)
Full-Feature
Free-Kernel
Yes
 
Yes
 
Yes
 
Yes
 
Yes
 
No
 
Yes
 
Yes
 
TCC
(Total Color Control)
Full-Feature
Free-Kernel
Yes
 
Yes
 
Yes
 
Yes
 
Yes
 
No
 
Yes
 
Yes
 
Color fill Full-Feature
Free-Kernel
Yes
 
Yes
 
Yes
 
Yes
 
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Chroma Siting Full-Feature
Free-Kernel
 
 
Yes
 
Yes
 
Yes
 
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
HDR10 Tone Mapping Full-Feature
Free-Kernel
 
 
 
 
 
 
 
 
Yes
 
No
 
Yes
 
Yes
 

* EHL/JSL only support BOB DI

For more feature information, please refer to Supported video processing csc/scaling format

Build Options

Media-driver supports few build types as described below. You could refer to the following settings to enable them.

  • Full Feature Build: ENABLE_KERNELS=ON(Default) ENABLE_NONFREE_KERNELS=ON(Default)
  • Free Kernel Build: ENABLE_KERNELS=ON ENABLE_NONFREE_KERNELS=OFF
    • If trying to use pre-built open source kernel binaries, please add BUILD_KERNELS=OFF(Default).
    • If trying to rebuild open source kernel from source code, please add BUILD_KERNELS=ON.

Media-driver requires special i915 kernel mode driver (kmd) version to support the following new platforms since upstream version of i915 kmd does not fully support them (pending patches upstream):

  • DG1
  • SG1

By default, media-driver builds against upstream i915 kmd and will miss support for the platforms listed above. To enable new platforms which require special i915 kmd specify ENABLE_PRODUCTION_KMD=ON (default: OFF) build configuration option.

Known Issues and Limitations

  1. Intel(R) Media Driver for VAAPI is recommended to be built against gcc compiler v6.1 or later, which officially supported C++11.

  2. SKL: Green or other incorrect color will be observed in output frames when using YV12/I420 as input format for csc/scaling/blending/rotation, etc. on Ubuntu 16.04 stock (with kernel 4.10). The issue can be addressed with the kernel patch: WaEnableYV12BugFixInHalfSliceChicken7

  3. HuC firmware is necessary for AVC/HEVC/VP9 low power encoding bitrate control, including CBR, VBR, etc. As of now, HuC firmware support is disabled in Linux kernels by default. kernel command line option "i915.enable_guc=2" for HuC loading can be set e.g. by doing echo "options i915 enable_guc=2" > /etc/modprobe.d/i915.conf (as root). Mind that HuC firmware support presents in the following kernels for the specified platforms:

    • APL/KBL: starting from kernel 4.11
    • CFL: starting from kernel 4.15
    • ICL: starting from kernel 5.2
    • EHL/JSL: starting from kernel 5.8
    • TGL: starting from kernel 5.9
    • RKL: drm-tip
(*) Other names and brands may be claimed as property of others.