README

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