Make new VDPAU easier to use by adding context to callback.
[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 #include "libavutil/attributes.h"
56
57 #ifndef FF_API_CAP_VDPAU
58 #define FF_API_CAP_VDPAU 1
59 #endif
60 #ifndef FF_API_BUFS_VDPAU
61 #define FF_API_BUFS_VDPAU 1
62 #endif
63
64 #if FF_API_BUFS_VDPAU
65 union AVVDPAUPictureInfo {
66     VdpPictureInfoH264        h264;
67     VdpPictureInfoMPEG1Or2    mpeg;
68     VdpPictureInfoVC1          vc1;
69     VdpPictureInfoMPEG4Part2 mpeg4;
70 };
71 #endif
72
73 struct AVCodecContext;
74 struct AVFrame;
75
76 typedef int (*AVVDPAU_Render2)(struct AVCodecContext *, struct AVFrame *,
77                                const VdpPictureInfo *, uint32_t,
78                                const VdpBitstreamBuffer *);
79
80 /**
81  * This structure is used to share data between the libavcodec library and
82  * the client video application.
83  * The user shall allocate the structure via the av_alloc_vdpau_hwaccel
84  * function and make it available as
85  * AVCodecContext.hwaccel_context. Members can be set by the user once
86  * during initialization or through each AVCodecContext.get_buffer()
87  * function call. In any case, they must be valid prior to calling
88  * decoding functions.
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 #if FF_API_CAP_VDPAU
153 /** @brief The videoSurface is used for rendering. */
154 #define FF_VDPAU_STATE_USED_FOR_RENDER 1
155
156 /**
157  * @brief The videoSurface is needed for reference/prediction.
158  * The codec manipulates this.
159  */
160 #define FF_VDPAU_STATE_USED_FOR_REFERENCE 2
161
162 /**
163  * @brief This structure is used as a callback between the FFmpeg
164  * decoder (vd_) and presentation (vo_) module.
165  * This is used for defining a video frame containing surface,
166  * picture parameter, bitstream information etc which are passed
167  * between the FFmpeg decoder and its clients.
168  */
169 struct vdpau_render_state {
170     VdpVideoSurface surface; ///< Used as rendered surface, never changed.
171
172     int state; ///< Holds FF_VDPAU_STATE_* values.
173
174 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
175     /** picture parameter information for all supported codecs */
176     union AVVDPAUPictureInfo info;
177 #endif
178
179     /** Describe size/location of the compressed video data.
180         Set to 0 when freeing bitstream_buffers. */
181     int bitstream_buffers_allocated;
182     int bitstream_buffers_used;
183     /** The user is responsible for freeing this buffer using av_freep(). */
184     VdpBitstreamBuffer *bitstream_buffers;
185
186 #if !AV_HAVE_INCOMPATIBLE_LIBAV_ABI
187     /** picture parameter information for all supported codecs */
188     union AVVDPAUPictureInfo info;
189 #endif
190 };
191 #endif
192
193 /* @}*/
194
195 #endif /* AVCODEC_VDPAU_H */