More docs.
[platform/upstream/gstreamer-vaapi.git] / README
1
2   gstreamer-vaapi
3   VA-API support to GStreamer
4
5   Copyright (C) 2010 Splitted-Desktop Systems
6
7
8 License
9 -------
10
11 gstreamer-vaapi helper libraries are available under the terms of the
12 GNU Lesser General Public License v2.1+.
13
14 gstreamer-vaapi plugin elements are available under the terms of the
15 GNU General Public License v2+.
16
17
18 Overview
19 --------
20
21 gstreamer-vaapi consists in a collection of VA-API based plugins for
22 GStreamer and helper libraries.
23
24   * `vaapidecode' is used to decode MPEG-2, MPEG-4, H.264, VC-1, WMV3
25     videos to video/x-vaapi-surfaces surfaces, depending on the
26     underlying HW capabilities.
27
28   * `vaapiconvert' is used to convert from video/x-raw-yuv pixels to
29     video/x-vaapi-surface surfaces.
30
31   * `vaapisink' is used to display video/x-vaapi-surface surfaces to
32     screen.
33
34
35 Features
36 --------
37
38   * VA-API support from 0.29 to 0.31
39   * OpenGL rendering through VA/GLX or GLX texture-from-pixmap + FBO
40   * Support for major HW video decoding solutions on Linux (AMD, Intel, NVIDIA)
41
42
43 Requirements
44 ------------
45
46 Software requirements
47
48   * libgstreamer0.10-dev >= 0.10.0
49   * libgstreamer-plugins-base0.10-dev >= 0.10.0
50   * libva-dev >= 0.31.0-1+sds9 (VA/GLX)
51   * libavcodec-dev >= 0.6 or with <libavcodec/vaapi.h>
52
53 Hardware requirements
54
55   * AMD platforms with UVD2 (XvBA supported)
56   * Intel Poulsbo (US15W)
57   * Intel Eaglelake (G45)
58   * Intel Ironlake (HD Graphics)
59   * NVIDIA platforms with PureVideo (VDPAU supported)
60
61
62 Usage
63 -----
64
65 The GStreamer pipeline currently has to be built manually.
66 i.e. neither decodebin{,2} nor playbin{,2} would select the VA-API
67 elements automatically.
68
69   * Play an H.264 video with an MP4 container in fullscreen mode
70   $ gst-launch-0.10 -v filesrc location=/path/to/video.mp4 ! \
71       qtdemux ! vaapidecode ! vaapisink fullscreen=true
72
73
74 Caveats
75 -------
76
77   * No automatic integration within the default playbin2 pipeline
78   * No ad-hoc parser, vaapidecoder currently relies on FFmpeg
79   * MPEG-4 Part-2 (DivX) has decoding bugs