codecparsers: update to gst-vaapi-branch commit b47983a.
[vaapi:gstreamer-vaapi.git] / README
1
2   gstreamer-vaapi
3   VA-API support to GStreamer
4
5   Copyright (C) 2010-2011 Splitted-Desktop Systems
6   Copyright (C) 2011-2012 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 Overview
17 --------
18
19 gstreamer-vaapi consists in a collection of VA-API based plugins for
20 GStreamer and helper libraries.
21
22   * `vaapidecode' is used to decode JPEG, MPEG-2, MPEG-4, H.264, VC-1,
23     WMV3 videos to video/x-vaapi-surfaces surfaces, depending on the
24     underlying HW capabilities.
25
26   * `vaapiupload' is used to convert from video/x-raw-yuv pixels to
27     video/x-vaapi-surface surfaces.
28
29   * `vaapidownload' is used to convert from video/x-vaapi-surface
30     surfaces to video/x-raw-yuv pixels.
31
32   * `vaapipostproc' is used to postprocess video/x-vaapi-surface
33     surfaces, for e.g. deinterlacing.
34
35   * `vaapisink' is used to display video/x-vaapi-surface surfaces to
36     screen.
37
38
39 Features
40 --------
41
42   * VA-API support from 0.29 to 0.32
43   * JPEG, MPEG-2, MPEG-4, H.264 and VC-1 ad-hoc decoders
44   * OpenGL rendering through VA/GLX or GLX texture-from-pixmap + FBO
45   * Support for the Wayland display server
46   * Support for headless decode pipelines with VA/DRM
47   * Support for major HW video decoding solutions on Linux (AMD, Intel, NVIDIA)
48
49
50 Requirements
51 ------------
52
53 Software requirements
54
55   * GStreamer 0.10.x:
56       libglib2.0-dev (>= 2.28)
57       libgstreamer0.10-dev (>= 0.10.36)
58         or with GstBaseSink::query()
59       libgstreamer-plugins-base0.10-dev (>= 0.10.36)
60       libgstreamer-plugins-bad0.10-dev (>= 0.10.22.1)
61         or with GstVideoContext, GstSurfaceBuffer, codecparsers
62
63   * Renderers:
64       DRM: libva-dev (>= 1.1.0), libdrm-dev, libudev-dev
65       X11: libva-dev (>= 1.0.1)
66       GLX: libva-dev (>= 1.0.3)
67       Wayland: libva-dev (>= 1.1.0), libwayland-dev (>= 0.95.0)
68
69 Hardware requirements
70
71   * AMD platforms with UVD2 (XvBA supported)
72   * Intel Eaglelake (G45)
73   * Intel Ironlake, Sandy Bridge and Ivy Bridge (HD Graphics)
74   * Intel Poulsbo (US15W)
75   * Intel Medfield or Cedar Trail
76   * NVIDIA platforms with PureVideo (VDPAU supported)
77
78
79 Usage
80 -----
81
82   VA elements are automatically plugged into GStreamer pipelines. So,
83   using playbin2 should work as is. However, here are a few alternate
84   pipelines constructed manually.
85
86   * Play an H.264 video with an MP4 container in fullscreen mode
87   $ gst-launch-0.10 -v filesrc location=/path/to/video.mp4 ! \
88       qtdemux ! vaapidecode ! vaapisink fullscreen=true
89
90   * Play a raw MPEG-2 interlaced stream
91   $ gst-launch-0.10 -v filesrc location=/path/to/mpeg2.bits ! \
92       mpegvideoparse ! vaapidecode ! vaapipostproc ! vaapisink