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   * `vaapidecode' is used to decode JPEG, MPEG-2, MPEG-4:2, H.264 AVC,
  24     H.264 MVC, VP8, VC-1, WMV3 videos to VA surfaces, depending on the
  25     underlying hardware capabilities. This plugin is also able to
  26     implicitly download the decoded surface to raw YUV buffers.
  27
  28   * `vaapiencode_<CODEC>' is used to encode into MPEG-2, H.264 AVC,
  29     H.264 MVC, JPEG, VP8 videos, depending on the actual value of
  30     <CODEC> (mpeg2, h264, etc.). By default, raw format bitstreams
  31     are generated, so the result may be piped to a muxer.
  32     e.g. qtmux for MP4 containers.
  33
  34   * `vaapipostproc' is used to filter VA surfaces, for e.g. scaling,
  35     deinterlacing (bob, motion-adaptive, motion-compensated), noise
  36     reduction or sharpening. This plugin is also used to upload raw
  37     YUV pixels into VA surfaces.
  38
  39   * `vaapisink' is used to render VA surfaces to an X11 or Wayland
  40     display. This plugin also features a "headless" mode (DRM) more
  41     suited to remote transcode scenarios, with faster throughput.
  42
  43
  44 Features
  45 --------
  46
  47   * VA-API support from 0.29 to 0.37
  48   * JPEG, MPEG-2, MPEG-4, H.264 AVC, H.264 MVC, VP8 and VC-1 ad-hoc decoders
  49   * MPEG-2, H.264 AVC,H.264 MVC, JPEG and VP8 ad-hoc encoders
  50   * OpenGL rendering through VA/GLX or GLX texture-from-pixmap + FBO
  51   * Support for the Wayland display server
  52   * Support for headless decode pipelines with VA/DRM
  53   * Support for major HW video decoding solutions on Linux (AMD, Intel, NVIDIA)
  54   * Support for HW video encoding on Intel HD Graphics hardware
  55   * Support for VA Video Processing APIs (VA/VPP)
  56     - Scaling and color conversion
  57     - Image enhancement filters: Sharpening, Noise Reduction
  58     - Advanced deinterlacing: Motion-Adaptive, Motion-Compensated
  59
  60
  61 Requirements
  62 ------------
  63
  64 Software requirements
  65
  66   * GStreamer 1.2.x (up to including GStreamer 1.6):
  67       libglib2.0-dev (>= 2.28)
  68       libgstreamer1.0-dev (>= 1.2.0)
  69       libgstreamer-plugins-base1.0-dev (>= 1.2.0)
  70       libgstreamer-plugins-bad1.0-dev (>= 1.2.0)
  71
  72   * Renderers:
  73       DRM: libva-dev (>= 1.1.0), libdrm-dev, libudev-dev
  74       X11: libva-dev (>= 1.0.1)
  75       GLX: libva-dev (>= 1.0.3)
  76       Wayland: libva-dev (>= 1.1.0), libwayland-dev (>= 0.95.0)
  77
  78 Hardware requirements
  79
  80   * AMD platforms with UVD2 (XvBA supported)
  81   * Intel Eaglelake (G45)
  82   * Intel Ironlake, Sandybridge, Ivybridge, Haswell and Broadwell (HD Graphics)
  83   * Intel BayTrail
  84   * Intel Poulsbo (US15W)
  85   * Intel Medfield or Cedar Trail
  86   * NVIDIA platforms with PureVideo (VDPAU supported)
  87
  88
  89 Usage
  90 -----
  91
  92   VA elements are automatically plugged into GStreamer pipelines. So,
  93   using playbin should work as is.
  94   However, here are a few alternate pipelines that could be manually
  95   constructed.
  96
  97   * Play an H.264 video with an MP4 container in fullscreen mode
  98   $ gst-launch-1.0 -v filesrc location=/path/to/video.mp4 ! \
  99       qtdemux ! vaapidecode ! vaapisink fullscreen=true
 100
 101   * Play a raw MPEG-2 interlaced stream
 102   $ gst-launch-1.0 -v filesrc location=/path/to/mpeg2.bits ! \
 103       mpegvideoparse ! vaapidecode ! vaapipostproc ! vaapisink
 104
 105   * Convert from one pixel format to another, while also downscaling
 106   $ gst-launch-1.0 -v filesrc location=/path/to/raw_video.yuv ! \
 107       videoparse format=yuy2 width=1280 height=720 ! \
 108       vaapipostproc format=nv12 height=480 ! vaapisink
 109
 110   * Encode a 1080p stream in raw I420 format into H.264
 111   $ gst-launch-1.0 -v filesrc location=/path/to/raw_video.yuv ! \
 112       videoparse format=i420 width=1920 height=1080 framerate=30/1 ! \
 113       vaapiencode_h264 rate-control=cbr tune=high-compression ! \
 114       qtmux ! filesink location=/path/to/encoded_video.mp4
 115
 116
 117 Sources
 118 -------
 119
 120   gstreamer-vaapi is Open Source software, so updates to this
 121   framework are really easy to get.
 122
 123   Stable source code releases can be found at:
 124   <http://www.freedesktop.org/software/vaapi/releases/gstreamer-vaapi/>
 125
 126   Git repository for work-in-progress changes is available at:
 127   <https://github.com/01org/gstreamer-vaapi>
 128
 129
 130 Reporting Bugs
 131 --------------
 132
 133   Bugs can be reported in the GNOME Bugzilla system at:
 134   <https://bugzilla.gnome.org/enter_bug.cgi?product=gstreamer-vaapi>
 135
 136   From the main page, new bugs can be reported through New -> Other ->
 137   gstreamer-vaapi product.