Merge commit 'c0d973c41b4568d5bad1295879e35cfa611bdcf2'
[ffmpeg.git] / libavcodec / vdpau.h
1 /*
2  * The Video Decode and Presentation API for UNIX (VDPAU) is used for
3  * hardware-accelerated decoding of MPEG-1/2, H.264 and VC-1.
4  *
5  * Copyright (C) 2008 NVIDIA
6  *
7  * This file is part of FFmpeg.
8  *
9  * FFmpeg is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 2.1 of the License, or (at your option) any later version.
13  *
14  * FFmpeg is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with FFmpeg; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22  */
23
24 #ifndef AVCODEC_VDPAU_H
25 #define AVCODEC_VDPAU_H
26
27 /**
28  * @file
29  * @ingroup lavc_codec_hwaccel_vdpau
30  * Public libavcodec VDPAU header.
31  */
32
33
34 /**
35  * @defgroup lavc_codec_hwaccel_vdpau VDPAU Decoder and Renderer
36  * @ingroup lavc_codec_hwaccel
37  *
38  * VDPAU hardware acceleration has two modules
39  * - VDPAU decoding
40  * - VDPAU presentation
41  *
42  * The VDPAU decoding module parses all headers using FFmpeg
43  * parsing mechanisms and uses VDPAU for the actual decoding.
44  *
45  * As per the current implementation, the actual decoding
46  * and rendering (API calls) are done as part of the VDPAU
47  * presentation (vo_vdpau.c) module.
48  *
49  * @{
50  */
51
52 #include <vdpau/vdpau.h>
53 #include <vdpau/vdpau_x11.h>
54 #include "libavutil/avconfig.h"
55
56 union AVVDPAUPictureInfo {
57     VdpPictureInfoH264        h264;
58     VdpPictureInfoMPEG1Or2    mpeg;
59     VdpPictureInfoVC1          vc1;
60     VdpPictureInfoMPEG4Part2 mpeg4;
61 };
62
63 /**
64  * This structure is used to share data between the libavcodec library and
65  * the client video application.
66  * The user shall zero-allocate the structure and make it available as
67  * AVCodecContext.hwaccel_context. Members can be set by the user once
68  * during initialization or through each AVCodecContext.get_buffer()
69  * function call. In any case, they must be valid prior to calling
70  * decoding functions.
71  */
72 typedef struct AVVDPAUContext {
73     /**
74      * VDPAU decoder handle
75      *
76      * Set by user.
77      */
78     VdpDecoder decoder;
79
80     /**
81      * VDPAU decoder render callback
82      *
83      * Set by the user.
84      */
85     VdpDecoderRender *render;
86
87     /**
88      * VDPAU picture information
89      *
90      * Set by libavcodec.
91      */
92     union AVVDPAUPictureInfo info;
93
94     /**
95      * Allocated size of the bitstream_buffers table.
96      *
97      * Set by libavcodec.
98      */
99     int bitstream_buffers_allocated;
100
101     /**
102      * Useful bitstream buffers in the bitstream buffers table.
103      *
104      * Set by libavcodec.
105      */
106     int bitstream_buffers_used;
107
108    /**
109      * Table of bitstream buffers.
110      * The user is responsible for freeing this buffer using av_freep().
111      *
112      * Set by libavcodec.
113      */
114     VdpBitstreamBuffer *bitstream_buffers;
115 } AVVDPAUContext;
116
117
118 /** @brief The videoSurface is used for rendering. */
119 #define FF_VDPAU_STATE_USED_FOR_RENDER 1
120
121 /**
122  * @brief The videoSurface is needed for reference/prediction.
123  * The codec manipulates this.
124  */
125 #define FF_VDPAU_STATE_USED_FOR_REFERENCE 2
126
127 /**
128  * @brief This structure is used as a callback between the FFmpeg
129  * decoder (vd_) and presentation (vo_) module.
130  * This is used for defining a video frame containing surface,
131  * picture parameter, bitstream information etc which are passed
132  * between the FFmpeg decoder and its clients.
133  */
134 struct vdpau_render_state {
135     VdpVideoSurface surface; ///< Used as rendered surface, never changed.
136
137     int state; ///< Holds FF_VDPAU_STATE_* values.
138
139 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
140     /** picture parameter information for all supported codecs */
141     union AVVDPAUPictureInfo info;
142 #endif
143
144     /** Describe size/location of the compressed video data.
145         Set to 0 when freeing bitstream_buffers. */
146     int bitstream_buffers_allocated;
147     int bitstream_buffers_used;
148     /** The user is responsible for freeing this buffer using av_freep(). */
149     VdpBitstreamBuffer *bitstream_buffers;
150
151 #if !AV_HAVE_INCOMPATIBLE_LIBAV_ABI
152     /** picture parameter information for all supported codecs */
153     union AVVDPAUPictureInfo info;
154 #endif
155 };
156
157 /* @}*/
158
159 #endif /* AVCODEC_VDPAU_H */