blob: e85e4d9e9a26a5aaed20d9f0600ebe86d6d34ee2
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 | #include "libavutil/attributes.h" |
56 | |
57 | #include "avcodec.h" |
58 | #include "version.h" |
59 | |
60 | #if FF_API_BUFS_VDPAU |
61 | union AVVDPAUPictureInfo { |
62 | VdpPictureInfoH264 h264; |
63 | VdpPictureInfoMPEG1Or2 mpeg; |
64 | VdpPictureInfoVC1 vc1; |
65 | VdpPictureInfoMPEG4Part2 mpeg4; |
66 | }; |
67 | #endif |
68 | |
69 | struct AVCodecContext; |
70 | struct AVFrame; |
71 | |
72 | typedef int (*AVVDPAU_Render2)(struct AVCodecContext *, struct AVFrame *, |
73 | const VdpPictureInfo *, uint32_t, |
74 | const VdpBitstreamBuffer *); |
75 | |
76 | /** |
77 | * This structure is used to share data between the libavcodec library and |
78 | * the client video application. |
79 | * The user shall allocate the structure via the av_alloc_vdpau_hwaccel |
80 | * function and make it available as |
81 | * AVCodecContext.hwaccel_context. Members can be set by the user once |
82 | * during initialization or through each AVCodecContext.get_buffer() |
83 | * function call. In any case, they must be valid prior to calling |
84 | * decoding functions. |
85 | * |
86 | * The size of this structure is not a part of the public ABI and must not |
87 | * be used outside of libavcodec. Use av_vdpau_alloc_context() to allocate an |
88 | * AVVDPAUContext. |
89 | */ |
90 | typedef struct AVVDPAUContext { |
91 | /** |
92 | * VDPAU decoder handle |
93 | * |
94 | * Set by user. |
95 | */ |
96 | VdpDecoder decoder; |
97 | |
98 | /** |
99 | * VDPAU decoder render callback |
100 | * |
101 | * Set by the user. |
102 | */ |
103 | VdpDecoderRender *render; |
104 | |
105 | #if FF_API_BUFS_VDPAU |
106 | /** |
107 | * VDPAU picture information |
108 | * |
109 | * Set by libavcodec. |
110 | */ |
111 | attribute_deprecated |
112 | union AVVDPAUPictureInfo info; |
113 | |
114 | /** |
115 | * Allocated size of the bitstream_buffers table. |
116 | * |
117 | * Set by libavcodec. |
118 | */ |
119 | attribute_deprecated |
120 | int bitstream_buffers_allocated; |
121 | |
122 | /** |
123 | * Useful bitstream buffers in the bitstream buffers table. |
124 | * |
125 | * Set by libavcodec. |
126 | */ |
127 | attribute_deprecated |
128 | int bitstream_buffers_used; |
129 | |
130 | /** |
131 | * Table of bitstream buffers. |
132 | * The user is responsible for freeing this buffer using av_freep(). |
133 | * |
134 | * Set by libavcodec. |
135 | */ |
136 | attribute_deprecated |
137 | VdpBitstreamBuffer *bitstream_buffers; |
138 | #endif |
139 | AVVDPAU_Render2 render2; |
140 | } AVVDPAUContext; |
141 | |
142 | /** |
143 | * @brief allocation function for AVVDPAUContext |
144 | * |
145 | * Allows extending the struct without breaking API/ABI |
146 | */ |
147 | AVVDPAUContext *av_alloc_vdpaucontext(void); |
148 | |
149 | AVVDPAU_Render2 av_vdpau_hwaccel_get_render2(const AVVDPAUContext *); |
150 | void av_vdpau_hwaccel_set_render2(AVVDPAUContext *, AVVDPAU_Render2); |
151 | |
152 | /** |
153 | * Associate a VDPAU device with a codec context for hardware acceleration. |
154 | * This function is meant to be called from the get_format() codec callback, |
155 | * or earlier. It can also be called after avcodec_flush_buffers() to change |
156 | * the underlying VDPAU device mid-stream (e.g. to recover from non-transparent |
157 | * display preemption). |
158 | * |
159 | * @note get_format() must return AV_PIX_FMT_VDPAU if this function completes |
160 | * successfully. |
161 | * |
162 | * @param avctx decoding context whose get_format() callback is invoked |
163 | * @param device VDPAU device handle to use for hardware acceleration |
164 | * @param get_proc_address VDPAU device driver |
165 | * @param flags zero of more OR'd AV_HWACCEL_FLAG_* flags |
166 | * |
167 | * @return 0 on success, an AVERROR code on failure. |
168 | */ |
169 | int av_vdpau_bind_context(AVCodecContext *avctx, VdpDevice device, |
170 | VdpGetProcAddress *get_proc_address, unsigned flags); |
171 | |
172 | /** |
173 | * Gets the parameters to create an adequate VDPAU video surface for the codec |
174 | * context using VDPAU hardware decoding acceleration. |
175 | * |
176 | * @note Behavior is undefined if the context was not successfully bound to a |
177 | * VDPAU device using av_vdpau_bind_context(). |
178 | * |
179 | * @param avctx the codec context being used for decoding the stream |
180 | * @param type storage space for the VDPAU video surface chroma type |
181 | * (or NULL to ignore) |
182 | * @param width storage space for the VDPAU video surface pixel width |
183 | * (or NULL to ignore) |
184 | * @param height storage space for the VDPAU video surface pixel height |
185 | * (or NULL to ignore) |
186 | * |
187 | * @return 0 on success, a negative AVERROR code on failure. |
188 | */ |
189 | int av_vdpau_get_surface_parameters(AVCodecContext *avctx, VdpChromaType *type, |
190 | uint32_t *width, uint32_t *height); |
191 | |
192 | /** |
193 | * Allocate an AVVDPAUContext. |
194 | * |
195 | * @return Newly-allocated AVVDPAUContext or NULL on failure. |
196 | */ |
197 | AVVDPAUContext *av_vdpau_alloc_context(void); |
198 | |
199 | #if FF_API_VDPAU_PROFILE |
200 | /** |
201 | * Get a decoder profile that should be used for initializing a VDPAU decoder. |
202 | * Should be called from the AVCodecContext.get_format() callback. |
203 | * |
204 | * @deprecated Use av_vdpau_bind_context() instead. |
205 | * |
206 | * @param avctx the codec context being used for decoding the stream |
207 | * @param profile a pointer into which the result will be written on success. |
208 | * The contents of profile are undefined if this function returns |
209 | * an error. |
210 | * |
211 | * @return 0 on success (non-negative), a negative AVERROR on failure. |
212 | */ |
213 | attribute_deprecated |
214 | int av_vdpau_get_profile(AVCodecContext *avctx, VdpDecoderProfile *profile); |
215 | #endif |
216 | |
217 | #if FF_API_CAP_VDPAU |
218 | /** @brief The videoSurface is used for rendering. */ |
219 | #define FF_VDPAU_STATE_USED_FOR_RENDER 1 |
220 | |
221 | /** |
222 | * @brief The videoSurface is needed for reference/prediction. |
223 | * The codec manipulates this. |
224 | */ |
225 | #define FF_VDPAU_STATE_USED_FOR_REFERENCE 2 |
226 | |
227 | /** |
228 | * @brief This structure is used as a callback between the FFmpeg |
229 | * decoder (vd_) and presentation (vo_) module. |
230 | * This is used for defining a video frame containing surface, |
231 | * picture parameter, bitstream information etc which are passed |
232 | * between the FFmpeg decoder and its clients. |
233 | */ |
234 | struct vdpau_render_state { |
235 | VdpVideoSurface surface; ///< Used as rendered surface, never changed. |
236 | |
237 | int state; ///< Holds FF_VDPAU_STATE_* values. |
238 | |
239 | /** picture parameter information for all supported codecs */ |
240 | union AVVDPAUPictureInfo info; |
241 | |
242 | /** Describe size/location of the compressed video data. |
243 | Set to 0 when freeing bitstream_buffers. */ |
244 | int bitstream_buffers_allocated; |
245 | int bitstream_buffers_used; |
246 | /** The user is responsible for freeing this buffer using av_freep(). */ |
247 | VdpBitstreamBuffer *bitstream_buffers; |
248 | }; |
249 | #endif |
250 | |
251 | /* @}*/ |
252 | |
253 | #endif /* AVCODEC_VDPAU_H */ |
254 |