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