README: updates.
authorGwenole Beauchesne <gwenole.beauchesne@intel.com>
Thu, 3 Jul 2014 20:34:35 +0000 (22:34 +0200)
committerGwenole Beauchesne <gwenole.beauchesne@intel.com>
Thu, 3 Jul 2014 20:35:29 +0000 (22:35 +0200)
Drop references to deprecated plugins (vaapiupload, vaapidownload),
mention that support for GStreamer 0.10 is deprecated, make overview
more descriptive in certain aspects.

README

diff --git a/README b/README
index bb5b6d3..beb9a7e 100644 (file)
--- a/README
+++ b/README
@@ -20,34 +20,32 @@ 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, H.264, VC-1,
-    WMV3 videos to video/x-vaapi-surfaces surfaces, depending on the
-    underlying HW capabilities.
+  * `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 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 an actual muxer like qtmux for MP4 containers.
+  * `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.
 
-  * `vaapiupload' is used to convert from video/x-raw-yuv pixels to
-    video/x-vaapi-surface surfaces.
+  * `vaapipostproc' is used to filter VA surfaces, for e.g. scaling,
+    deinterlacing (bob, motion-adaptive, motion-compensated), noise
+    reduction or sharpening. This plugin is also used to upload raw
+    YUV pixels into VA surfaces.
 
-  * `vaapidownload' is used to convert from video/x-vaapi-surface
-    surfaces to video/x-raw-yuv pixels.
-
-  * `vaapipostproc' is used to postprocess video/x-vaapi-surface
-    surfaces, for e.g. deinterlacing, denoising and sharpening.
-
-  * `vaapisink' is used to display video/x-vaapi-surface surfaces to
-    screen.
+  * `vaapisink' is used to render VA surfaces to an X11 or Wayland
+    display. This plugin also features a "headless" mode (DRM) more
+    suited to remote transcode scenarios, with faster throughput.
 
 
 Features
 --------
 
-  * VA-API support from 0.29 to 0.34
-  * JPEG, MPEG-2, MPEG-4, H.264 and VC-1 ad-hoc decoders
-  * MPEG-2, H.264 ad-hoc encoders
+  * 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
   * OpenGL rendering through VA/GLX or GLX texture-from-pixmap + FBO
   * Support for the Wayland display server
   * Support for headless decode pipelines with VA/DRM
@@ -72,7 +70,10 @@ Software requirements
       libgstreamer-plugins-bad0.10-dev (>= 0.10.22.1)
         or with GstVideoContext, GstSurfaceBuffer, codecparsers
 
-  * GStreamer 1.0.x (including GStreamer 1.2, 1.3):
+    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)