tests: add test for JPEG decoding.
[vaapi:halleys-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   * `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   * 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 major HW video decoding solutions on Linux (AMD, Intel, NVIDIA)
46
47
48 Requirements
49 ------------
50
51 Software requirements
52
53   * libva-dev >= 1.0.3 (VA/GLX)
54   * libgstreamer0.10-dev >= 0.10.35.1
55       or with GstBaseSink::query()
56   * libgstreamer-plugins-base0.10-dev >= 0.10.35
57   * libgstreamer-plugins-bad0.10-dev >= 0.10.22.1
58       or with GstVideoContext, GstSurfaceBuffer, codecparsers
59
60   If codecparsers-based decoders are not used:
61
62   * libavcodec-dev >= 0.6
63       or with <libavcodec/vaapi.h>
64
65 Hardware requirements
66
67   * AMD platforms with UVD2 (XvBA supported)
68   * Intel Eaglelake (G45)
69   * Intel Ironlake, Sandy Bridge and Ivy Bridge (HD Graphics)
70   * Intel Poulsbo (US15W)
71   * Intel Medfield or Cedar Trail
72   * NVIDIA platforms with PureVideo (VDPAU supported)
73
74
75 Usage
76 -----
77
78   VA elements are automatically plugged into GStreamer pipelines. So,
79   using playbin2 should work as is. However, here are a few alternate
80   pipelines constructed manually.
81
82   * Play an H.264 video with an MP4 container in fullscreen mode
83   $ gst-launch-0.10 -v filesrc location=/path/to/video.mp4 ! \
84       qtdemux ! vaapidecode ! vaapisink fullscreen=true
85
86   * Play a raw MPEG-2 interlaced stream
87   $ gst-launch-0.10 -v filesrc location=/path/to/mpeg2.bits ! \
88       mpegvideoparse ! vaapidecode ! vaapipostproc ! vaapisink