add packing.log to track rebase

[profile/ivi/gstreamer-vaapi.git] / README

diff --git a/README b/README
index ce09558..91dc108 100644 (file)
--- a/README
+++ b/README
@@ -19,8 +19,8 @@ Overview
 gstreamer-vaapi consists in a collection of VA-API based plugins for
 GStreamer and helper libraries.
 
-  * `vaapidecode' is used to decode MPEG-2, MPEG-4, H.264, VC-1, WMV3
-    videos to video/x-vaapi-surfaces surfaces, depending on the
+  * `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.
 
   * `vaapiupload' is used to convert from video/x-raw-yuv pixels to
@@ -40,8 +40,10 @@ Features
 --------
 
   * VA-API support from 0.29 to 0.32
-  * MPEG-2, MPEG-4, H.264 and VC-1 ad-hoc decoders
+  * JPEG, MPEG-2, MPEG-4, H.264 and VC-1 ad-hoc decoders
   * 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
   * Support for major HW video decoding solutions on Linux (AMD, Intel, NVIDIA)
 
 
@@ -50,17 +52,19 @@ Requirements
 
 Software requirements
 
-  * libva-dev >= 1.0.3 (VA/GLX)
-  * libgstreamer0.10-dev >= 0.10.35.1
-      or with GstBaseSink::query()
-  * libgstreamer-plugins-base0.10-dev >= 0.10.35
-  * libgstreamer-plugins-bad0.10-dev >= 0.10.22.1
-      or with GstVideoContext, GstSurfaceBuffer, codecparsers
+  * GStreamer 0.10.x:
+      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
 
-  If codecparsers-based decoders are not used:
-
-  * libavcodec-dev >= 0.6
-      or with <libavcodec/vaapi.h>
+  * 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)
 
 Hardware requirements
 
@@ -75,6 +79,14 @@ Hardware requirements
 Usage
 -----
 
+  VA elements are automatically plugged into GStreamer pipelines. So,
+  using playbin2 should work as is. However, here are a few alternate
+  pipelines constructed manually.
+
   * Play an H.264 video with an MP4 container in fullscreen mode
   $ gst-launch-0.10 -v filesrc location=/path/to/video.mp4 ! \
       qtdemux ! vaapidecode ! vaapisink fullscreen=true
+
+  * Play a raw MPEG-2 interlaced stream
+  $ gst-launch-0.10 -v filesrc location=/path/to/mpeg2.bits ! \
+      mpegvideoparse ! vaapidecode ! vaapipostproc ! vaapisink