avcodec/vdpau: try to fix version macro use
[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 #include "version.h"
57
58 #if FF_API_BUFS_VDPAU
59 union AVVDPAUPictureInfo {
60     VdpPictureInfoH264        h264;
61     VdpPictureInfoMPEG1Or2    mpeg;
62     VdpPictureInfoVC1          vc1;
63     VdpPictureInfoMPEG4Part2 mpeg4;
64 };
65 #endif
66
67 struct AVCodecContext;
68 struct AVFrame;
69
70 typedef int (*AVVDPAU_Render2)(struct AVCodecContext *, struct AVFrame *,
71                                const VdpPictureInfo *, uint32_t,
72                                const VdpBitstreamBuffer *);
73
74 /**
75  * This structure is used to share data between the libavcodec library and
76  * the client video application.
77  * The user shall allocate the structure via the av_alloc_vdpau_hwaccel
78  * function and make it available as
79  * AVCodecContext.hwaccel_context. Members can be set by the user once
80  * during initialization or through each AVCodecContext.get_buffer()
81  * function call. In any case, they must be valid prior to calling
82  * decoding functions.
83  */
84 typedef struct AVVDPAUContext {
85     /**
86      * VDPAU decoder handle
87      *
88      * Set by user.
89      */
90     VdpDecoder decoder;
91
92     /**
93      * VDPAU decoder render callback
94      *
95      * Set by the user.
96      */
97     VdpDecoderRender *render;
98
99 #if FF_API_BUFS_VDPAU
100     /**
101      * VDPAU picture information
102      *
103      * Set by libavcodec.
104      */
105     attribute_deprecated
106     union AVVDPAUPictureInfo info;
107
108     /**
109      * Allocated size of the bitstream_buffers table.
110      *
111      * Set by libavcodec.
112      */
113     attribute_deprecated
114     int bitstream_buffers_allocated;
115
116     /**
117      * Useful bitstream buffers in the bitstream buffers table.
118      *
119      * Set by libavcodec.
120      */
121     attribute_deprecated
122     int bitstream_buffers_used;
123
124    /**
125      * Table of bitstream buffers.
126      * The user is responsible for freeing this buffer using av_freep().
127      *
128      * Set by libavcodec.
129      */
130     attribute_deprecated
131     VdpBitstreamBuffer *bitstream_buffers;
132 #endif
133     AVVDPAU_Render2 render2;
134 } AVVDPAUContext;
135
136 /**
137  * @brief allocation function for AVVDPAUContext
138  *
139  * Allows extending the struct without breaking API/ABI
140  */
141 AVVDPAUContext *av_alloc_vdpaucontext(void);
142
143 AVVDPAU_Render2 av_vdpau_hwaccel_get_render2(const AVVDPAUContext *);
144 void av_vdpau_hwaccel_set_render2(AVVDPAUContext *, AVVDPAU_Render2);
145
146 #if FF_API_CAP_VDPAU
147 /** @brief The videoSurface is used for rendering. */
148 #define FF_VDPAU_STATE_USED_FOR_RENDER 1
149
150 /**
151  * @brief The videoSurface is needed for reference/prediction.
152  * The codec manipulates this.
153  */
154 #define FF_VDPAU_STATE_USED_FOR_REFERENCE 2
155
156 /**
157  * @brief This structure is used as a callback between the FFmpeg
158  * decoder (vd_) and presentation (vo_) module.
159  * This is used for defining a video frame containing surface,
160  * picture parameter, bitstream information etc which are passed
161  * between the FFmpeg decoder and its clients.
162  */
163 struct vdpau_render_state {
164     VdpVideoSurface surface; ///< Used as rendered surface, never changed.
165
166     int state; ///< Holds FF_VDPAU_STATE_* values.
167
168 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
169     /** picture parameter information for all supported codecs */
170     union AVVDPAUPictureInfo info;
171 #endif
172
173     /** Describe size/location of the compressed video data.
174         Set to 0 when freeing bitstream_buffers. */
175     int bitstream_buffers_allocated;
176     int bitstream_buffers_used;
177     /** The user is responsible for freeing this buffer using av_freep(). */
178     VdpBitstreamBuffer *bitstream_buffers;
179
180 #if !AV_HAVE_INCOMPATIBLE_LIBAV_ABI
181     /** picture parameter information for all supported codecs */
182     union AVVDPAUPictureInfo info;
183 #endif
184 };
185 #endif
186
187 /* @}*/
188
189 #endif /* AVCODEC_VDPAU_H */