README: updates.
[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-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 MPEG-2, MPEG-4, H.264, VC-1, WMV3
23     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   * `vaapisink' is used to display video/x-vaapi-surface surfaces to
33     screen.
34
35
36 Features
37 --------
38
39   * VA-API support from 0.29 to 0.32
40   * MPEG-2, MPEG-4, H.264 and VC-1 ad-hoc decoders
41   * OpenGL rendering through VA/GLX or GLX texture-from-pixmap + FBO
42   * Support for major HW video decoding solutions on Linux (AMD, Intel, NVIDIA)
43
44
45 Requirements
46 ------------
47
48 Software requirements
49
50   * libva-dev >= 1.0.3 (VA/GLX)
51   * libgstreamer0.10-dev >= 0.10.35.1
52       or with GstBaseSink::query()
53   * libgstreamer-plugins-base0.10-dev >= 0.10.35
54   * libgstreamer-plugins-bad0.10-dev >= 0.10.22.1
55       or with GstVideoContext, GstSurfaceBuffer, codecparsers
56
57   If codecparsers-based decoders are not used:
58
59   * libavcodec-dev >= 0.6
60       or with <libavcodec/vaapi.h>
61
62 Hardware requirements
63
64   * AMD platforms with UVD2 (XvBA supported)
65   * Intel Eaglelake (G45)
66   * Intel Ironlake, Sandy Bridge and Ivy Bridge (HD Graphics)
67   * Intel Poulsbo (US15W)
68   * Intel Medfield or Cedar Trail
69   * NVIDIA platforms with PureVideo (VDPAU supported)
70
71
72 Usage
73 -----
74
75   * Play an H.264 video with an MP4 container in fullscreen mode
76   $ gst-launch-0.10 -v filesrc location=/path/to/video.mp4 ! \
77       qtdemux ! vaapidecode ! vaapisink fullscreen=true