libs: encoder: h265: fill tier in va seq param buf
[platform/upstream/gstreamer.git] / README
diff --git a/README b/README
index beb9a7e..6a4fed1 100644 (file)
--- a/README
+++ b/README
@@ -20,15 +20,17 @@ Overview
 gstreamer-vaapi consists in a collection of VA-API based plugins for
 GStreamer and helper libraries.
 
-  * `vaapidecode' is used to decode JPEG, MPEG-2, MPEG-4:2, H.264 AVC,
-    H.264 MVC, VP8, VC-1, WMV3 videos to VA surfaces, depending on the
-    underlying hardware capabilities. This plugin is also able to
-    implicitly download the decoded surface to raw YUV buffers.
-
-  * `vaapiencode_<CODEC>' is used to encode into MPEG-2, H.264 AVC,
-    H.264 MVC videos, depending on the actual value of <CODEC> (mpeg2,
-    h264, etc.). By default, raw format bitstreams are generated, so
-    the result may be piped to a muxer. e.g. qtmux for MP4 containers.
+  * `vaapi<CODEC>dec' is used to decode JPEG, MPEG-2, MPEG-4:2, H.264
+    AVC, H.264 MVC, VP8, VC-1, WMV3, HEVC videos to VA surfaces,
+    depending on the actual value of <CODEC> and the underlying
+    hardware capabilities.  This plugin is also able to implicitly
+    download the decoded surface to raw YUV buffers.
+
+  * `vaapi<CODEC>enc' is used to encode into MPEG-2, H.264 AVC, H.264
+    MVC, JPEG, VP8, HEVC videos, depending on the actual value of
+    <CODEC> (mpeg2, h264, etc.) and the hardware capabilities. By
+    default, raw format bitstreams are generated, so the result may be
+    piped to a muxer, e.g. qtmux for MP4 containers.
 
   * `vaapipostproc' is used to filter VA surfaces, for e.g. scaling,
     deinterlacing (bob, motion-adaptive, motion-compensated), noise
@@ -43,17 +45,21 @@ GStreamer and helper libraries.
 Features
 --------
 
-  * VA-API support from 0.29 to 0.35
-  * JPEG, MPEG-2, MPEG-4, H.264 AVC, H.264 MVC, VP8 and VC-1 ad-hoc decoders
-  * MPEG-2, H.264 AVC and H.264 MVC ad-hoc encoders
+  * VA-API support from 0.29 to 0.38
+  * JPEG, MPEG-2, MPEG-4, H.264 AVC, H.264 MVC, VP8, VC-1, HEVC and
+    VP9 ad-hoc decoders
+  * MPEG-2, H.264 AVC,H.264 MVC, JPEG, VP8 and HEVC ad-hoc encoders
   * OpenGL rendering through VA/GLX or GLX texture-from-pixmap + FBO
+  * Support for EGL backend
   * Support for the Wayland display server
   * Support for headless decode pipelines with VA/DRM
-  * Support for major HW video decoding solutions on Linux (AMD, Intel, NVIDIA)
+  * Support for major HW video decoding solutions on Linux (AMD,
+    Intel, NVIDIA)
   * Support for HW video encoding on Intel HD Graphics hardware
   * Support for VA Video Processing APIs (VA/VPP)
     - Scaling and color conversion
-    - Image enhancement filters: Sharpening, Noise Reduction
+    - Image enhancement filters: Sharpening, Noise Reductio, Color
+      Balance, Skin-Tone-Enhancement
     - Advanced deinterlacing: Motion-Adaptive, Motion-Compensated
 
 
@@ -62,54 +68,43 @@ Requirements
 
 Software requirements
 
-  * GStreamer 0.10.x [DEPRECATED]:
-      libglib2.0-dev (>= 2.28)
-      libgstreamer0.10-dev (>= 0.10.36)
-        or with GstBaseSink::query()
-      libgstreamer-plugins-base0.10-dev (>= 0.10.36)
-      libgstreamer-plugins-bad0.10-dev (>= 0.10.22.1)
-        or with GstVideoContext, GstSurfaceBuffer, codecparsers
-
-    Note: support for GStreamer 0.10 APIs is deprecated and will be
-    removed in a future release.
-
-  * GStreamer 1.0.x (up to including GStreamer 1.4):
-      libglib2.0-dev (>= 2.28)
-      libgstreamer1.0-dev (>= 1.0.0)
-      libgstreamer-plugins-base1.0-dev (>= 1.0.0)
-      libgstreamer-plugins-bad1.0-dev (>= 1.0.0)
+  * GStreamer 1.9.x:
+      libgstreamer1.0-dev (>= 1.9.x)
+      libgstreamer-plugins-base1.0-dev (>= 1.9.x)
+      libgstreamer-plugins-bad1.0-dev (>= 1.9.0)
 
   * Renderers:
       DRM: libva-dev (>= 1.1.0), libdrm-dev, libudev-dev
       X11: libva-dev (>= 1.0.1)
       GLX: libva-dev (>= 1.0.3)
-      Wayland: libva-dev (>= 1.1.0), libwayland-dev (>= 0.95.0)
+      Wayland: libva-dev (>= 1.1.0), libwayland-dev (>= 1.0.2)
 
 Hardware requirements
 
-  * AMD platforms with UVD2 (XvBA supported)
   * Intel Eaglelake (G45)
-  * Intel Ironlake, Sandybridge, Ivybridge and Haswell (HD Graphics)
+  * Intel Ironlake, Sandybridge, Ivybridge, Haswell, Broadwell,
+    Skylake, etc. (HD Graphics)
+  * Intel BayTrail, Braswell
   * Intel Poulsbo (US15W)
   * Intel Medfield or Cedar Trail
-  * NVIDIA platforms with PureVideo (VDPAU supported)
+  * Hardware supported by Mesa VA gallium state-tracker
 
 
 Usage
 -----
 
   VA elements are automatically plugged into GStreamer pipelines. So,
-  using playbin (or playbin2 with GStreamer 0.10) should work as is.
+  using playbin should work as is.
   However, here are a few alternate pipelines that could be manually
   constructed.
 
   * Play an H.264 video with an MP4 container in fullscreen mode
   $ gst-launch-1.0 -v filesrc location=/path/to/video.mp4 ! \
-      qtdemux ! vaapidecode ! vaapisink fullscreen=true
+      qtdemux ! vaapidecodebin ! vaapisink fullscreen=true
 
   * Play a raw MPEG-2 interlaced stream
   $ gst-launch-1.0 -v filesrc location=/path/to/mpeg2.bits ! \
-      mpegvideoparse ! vaapidecode ! vaapipostproc ! vaapisink
+      mpegvideoparse ! vaapimpeg2dec ! vaapipostproc ! vaapisink
 
   * Convert from one pixel format to another, while also downscaling
   $ gst-launch-1.0 -v filesrc location=/path/to/raw_video.yuv ! \
@@ -119,7 +114,7 @@ Usage
   * Encode a 1080p stream in raw I420 format into H.264
   $ gst-launch-1.0 -v filesrc location=/path/to/raw_video.yuv ! \
       videoparse format=i420 width=1920 height=1080 framerate=30/1 ! \
-      vaapiencode_h264 rate-control=cbr tune=high-compression ! \
+      vaapih264enc rate-control=cbr tune=high-compression ! \
       qtmux ! filesink location=/path/to/encoded_video.mp4
 
 
@@ -130,17 +125,14 @@ Sources
   framework are really easy to get.
 
   Stable source code releases can be found at:
-  <http://www.freedesktop.org/software/vaapi/releases/gstreamer-vaapi/>
+  <https://gstreamer.freedesktop.org/src/gstreamer-vaapi/>
 
   Git repository for work-in-progress changes is available at:
-  <http://gitorious.org/vaapi/gstreamer-vaapi>
+  <https://cgit.freedesktop.org/gstreamer/gstreamer-vaapi>
 
 
 Reporting Bugs
 --------------
 
   Bugs can be reported in the GNOME Bugzilla system at:
-  <https://bugzilla.gnome.org/enter_bug.cgi?product=gstreamer-vaapi>
-
-  From the main page, new bugs can be reported through New -> Other ->
-  gstreamer-vaapi product.
+  <https://bugzilla.gnome.org/enter_bug.cgi?product=GStreamer&component=gstreamer-vaapi>