README

   1
   2   gstreamer-vaapi
   3   VA-API support to GStreamer
   4
   5   Copyright (C) 2010-2011 Splitted-Desktop Systems
   6   Copyright (C) 2011-2020 Intel Corporation
   7   Copyright (C) 2011 Collabora Ltd.
   8   Copyright (C) 2015-2020 Igalia, S.L.
   9
  10
  11 License
  12 -------
  13
  14 gstreamer-vaapi helper libraries and plugin elements are available
  15 under the terms of the GNU Lesser General Public License v2.1+
  16
  17
  18 Overview
  19 --------
  20
  21 gstreamer-vaapi consists in a collection of VA-API based plugins for
  22 GStreamer and helper libraries.
  23
  24   * `vaapi<CODEC>dec' is used to decode JPEG, MPEG-2, MPEG-4:2, H.264
  25     AVC, H.264 MVC, VP8, VP9, VC-1, WMV3, HEVC videos to VA surfaces,
  26     depending on the actual value of <CODEC> and the underlying
  27     hardware capabilities.  This plugin is also able to implicitly
  28     download the decoded surface to raw YUV buffers.
  29
  30   * `vaapi<CODEC>enc' is used to encode into MPEG-2, H.264 AVC, H.264
  31     MVC, JPEG, VP8, VP9, HEVC videos, depending on the actual value of
  32     <CODEC> (mpeg2, h264, etc.) and the hardware capabilities. By
  33     default, raw format bitstreams are generated, so the result may be
  34     piped to a muxer, e.g. qtmux for MP4 containers.
  35
  36   * `vaapipostproc' is used to filter VA surfaces, for e.g. scaling,
  37     deinterlacing (bob, motion-adaptive, motion-compensated), noise
  38     reduction or sharpening. This plugin is also used to upload raw
  39     YUV pixels into VA surfaces.
  40
  41   * `vaapisink' is used to render VA surfaces to an X11 or Wayland
  42     display. This plugin also features a "headless" mode (DRM) more
  43     suited to remote transcode scenarios, with faster throughput.
  44
  45   * `vaapioverlay` is a accelerated compositor that blends or
  46     composite different video streams.
  47
  48
  49 Features
  50 --------
  51
  52   * VA-API support from 0.39
  53   * JPEG, MPEG-2, MPEG-4, H.264 AVC, H.264 MVC, VP8, VC-1, HEVC and
  54     VP9 ad-hoc decoders
  55   * MPEG-2, H.264 AVC,H.264 MVC, JPEG, VP8, VP9 and HEVC ad-hoc
  56     encoders
  57   * OpenGL rendering through VA/GLX or GLX texture-from-pixmap + FBO
  58   * Support for EGL backend
  59   * Support for the Wayland display server
  60   * Support for headless decode pipelines with VA/DRM
  61   * Support for major HW video decoding solutions on Linux (AMD,
  62     Intel, NVIDIA)
  63   * Support for HW video encoding on Intel HD Graphics hardware
  64   * Support for VA Video Processing APIs (VA/VPP)
  65     - Scaling and color conversion
  66     - Image enhancement filters: Sharpening, Noise Reductio, Color
  67       Balance, Skin-Tone-Enhancement
  68     - Advanced deinterlacing: Motion-Adaptive, Motion-Compensated
  69
  70
  71 Requirements
  72 ------------
  73
  74 Hardware requirements
  75
  76   * Hardware supported by i965 driver or iHD, such as
  77     - Intel Ironlake, Sandybridge, Ivybridge, Haswell, Broadwell,
  78       Skylake, etc. (HD Graphics)
  79     - Intel BayTrail, Braswell
  80     - Intel Poulsbo (US15W)
  81     - Intel Medfield or Cedar Trail
  82   * Hardware supported by AMD Radeonsi driver, such as the list below
  83     - AMD Carrizo, Bristol Ridge, Raven Ridge, Picasso, Renoir
  84     - AMD Tonga, Fiji, Polaris XX, Vega XX, Navi 1X
  85   * Other hardware supported by Mesa VA gallium state-tracker
  86
  87
  88 Usage
  89 -----
  90
  91   VA elements are automatically plugged into GStreamer pipelines. So,
  92   using playbin should work as is.
  93   However, here are a few alternate pipelines that could be manually
  94   constructed.
  95
  96   * Play an H.264 video with an MP4 container in fullscreen mode
  97   $ gst-launch-1.0 -v filesrc location=/path/to/video.mp4 ! \
  98       qtdemux ! vaapidecodebin ! vaapisink fullscreen=true
  99
 100   * Play a raw MPEG-2 interlaced stream
 101   $ gst-launch-1.0 -v filesrc location=/path/to/mpeg2.bits ! \
 102       mpegvideoparse ! vaapimpeg2dec ! vaapipostproc ! vaapisink
 103
 104   * Convert from one pixel format to another, while also downscaling
 105   $ gst-launch-1.0 -v filesrc location=/path/to/raw_video.yuv ! \
 106       videoparse format=yuy2 width=1280 height=720 ! \
 107       vaapipostproc format=nv12 height=480 ! vaapisink
 108
 109   * Encode a 1080p stream in raw I420 format into H.264
 110   $ gst-launch-1.0 -v filesrc location=/path/to/raw_video.yuv ! \
 111       videoparse format=i420 width=1920 height=1080 framerate=30/1 ! \
 112       vaapih264enc rate-control=cbr tune=high-compression ! \
 113       qtmux ! filesink location=/path/to/encoded_video.mp4
 114
 115
 116 Sources
 117 -------
 118
 119   gstreamer-vaapi is Open Source software, so updates to this
 120   framework are really easy to get.
 121
 122   Stable source code releases can be found at:
 123   <https://gstreamer.freedesktop.org/src/gstreamer-vaapi/>
 124
 125   GitLab repository for work-in-progress changes is available at:
 126   <https://gitlab.freedesktop.org/gstreamer/gstreamer-vaapi>
 127
 128
 129 Reporting Bugs
 130 --------------
 131
 132   Bugs can be reported in the GStreamer's GitLab system at:
 133   <https://gitlab.freedesktop.org/gstreamer/gstreamer-vaapi/issues>