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