Splitted-Desktop systems relicensed plugins and tests to LGPL v2.1+.
[platform/upstream/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 Intel Corporation
7
8
9 License
10 -------
11
12 gstreamer-vaapi helper libraries and plugin elements are available
13 under the terms of the GNU Lesser General Public License v2.1+
14
15 Overview
16 --------
17
18 gstreamer-vaapi consists in a collection of VA-API based plugins for
19 GStreamer and helper libraries.
20
21   * `vaapidecode' is used to decode MPEG-2, MPEG-4, H.264, VC-1, WMV3
22     videos to video/x-vaapi-surfaces surfaces, depending on the
23     underlying HW capabilities.
24
25   * `vaapiconvert' is used to convert from video/x-raw-yuv pixels to
26     video/x-vaapi-surface surfaces.
27
28   * `vaapisink' is used to display video/x-vaapi-surface surfaces to
29     screen.
30
31
32 Features
33 --------
34
35   * VA-API support from 0.29 to 0.31
36   * OpenGL rendering through VA/GLX or GLX texture-from-pixmap + FBO
37   * Support for major HW video decoding solutions on Linux (AMD, Intel, NVIDIA)
38
39
40 Requirements
41 ------------
42
43 Software requirements
44
45   * libgstreamer0.10-dev >= 0.10.10
46   * libgstreamer-plugins-base0.10-dev >= 0.10.16
47   * libva-dev >= 0.31.0-1+sds9 (VA/GLX)
48   * libavcodec-dev >= 0.6 or with <libavcodec/vaapi.h>
49
50 Hardware requirements
51
52   * AMD platforms with UVD2 (XvBA supported)
53   * Intel Eaglelake (G45)
54   * Intel Ironlake (HD Graphics)
55   * Intel Poulsbo (US15W)
56   * NVIDIA platforms with PureVideo (VDPAU supported)
57
58
59 Usage
60 -----
61
62   * Play an H.264 video with an MP4 container in fullscreen mode
63   $ gst-launch-0.10 -v filesrc location=/path/to/video.mp4 ! \
64       qtdemux ! vaapidecode ! vaapisink fullscreen=true
65
66
67 Caveats
68 -------
69
70   * No ad-hoc parser, vaapidecoder currently relies on FFmpeg