FFmpeg  4.2.4
vdpau.h
Go to the documentation of this file.
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 
54 #include "libavutil/avconfig.h"
55 #include "libavutil/attributes.h"
56 
57 #include "avcodec.h"
58 #include "version.h"
59 
60 struct AVCodecContext;
61 struct AVFrame;
62 
63 typedef int (*AVVDPAU_Render2)(struct AVCodecContext *, struct AVFrame *,
64  const VdpPictureInfo *, uint32_t,
65  const VdpBitstreamBuffer *);
66 
67 /**
68  * This structure is used to share data between the libavcodec library and
69  * the client video application.
70  * The user shall allocate the structure via the av_alloc_vdpau_hwaccel
71  * function and make it available as
72  * AVCodecContext.hwaccel_context. Members can be set by the user once
73  * during initialization or through each AVCodecContext.get_buffer()
74  * function call. In any case, they must be valid prior to calling
75  * decoding functions.
76  *
77  * The size of this structure is not a part of the public ABI and must not
78  * be used outside of libavcodec. Use av_vdpau_alloc_context() to allocate an
79  * AVVDPAUContext.
80  */
81 typedef struct AVVDPAUContext {
82  /**
83  * VDPAU decoder handle
84  *
85  * Set by user.
86  */
87  VdpDecoder decoder;
88 
89  /**
90  * VDPAU decoder render callback
91  *
92  * Set by the user.
93  */
94  VdpDecoderRender *render;
95 
98 
99 /**
100  * @brief allocation function for AVVDPAUContext
101  *
102  * Allows extending the struct without breaking API/ABI
103  */
105 
108 
109 /**
110  * Associate a VDPAU device with a codec context for hardware acceleration.
111  * This function is meant to be called from the get_format() codec callback,
112  * or earlier. It can also be called after avcodec_flush_buffers() to change
113  * the underlying VDPAU device mid-stream (e.g. to recover from non-transparent
114  * display preemption).
115  *
116  * @note get_format() must return AV_PIX_FMT_VDPAU if this function completes
117  * successfully.
118  *
119  * @param avctx decoding context whose get_format() callback is invoked
120  * @param device VDPAU device handle to use for hardware acceleration
121  * @param get_proc_address VDPAU device driver
122  * @param flags zero of more OR'd AV_HWACCEL_FLAG_* flags
123  *
124  * @return 0 on success, an AVERROR code on failure.
125  */
126 int av_vdpau_bind_context(AVCodecContext *avctx, VdpDevice device,
127  VdpGetProcAddress *get_proc_address, unsigned flags);
128 
129 /**
130  * Gets the parameters to create an adequate VDPAU video surface for the codec
131  * context using VDPAU hardware decoding acceleration.
132  *
133  * @note Behavior is undefined if the context was not successfully bound to a
134  * VDPAU device using av_vdpau_bind_context().
135  *
136  * @param avctx the codec context being used for decoding the stream
137  * @param type storage space for the VDPAU video surface chroma type
138  * (or NULL to ignore)
139  * @param width storage space for the VDPAU video surface pixel width
140  * (or NULL to ignore)
141  * @param height storage space for the VDPAU video surface pixel height
142  * (or NULL to ignore)
143  *
144  * @return 0 on success, a negative AVERROR code on failure.
145  */
146 int av_vdpau_get_surface_parameters(AVCodecContext *avctx, VdpChromaType *type,
147  uint32_t *width, uint32_t *height);
148 
149 /**
150  * Allocate an AVVDPAUContext.
151  *
152  * @return Newly-allocated AVVDPAUContext or NULL on failure.
153  */
155 
156 #if FF_API_VDPAU_PROFILE
157 /**
158  * Get a decoder profile that should be used for initializing a VDPAU decoder.
159  * Should be called from the AVCodecContext.get_format() callback.
160  *
161  * @deprecated Use av_vdpau_bind_context() instead.
162  *
163  * @param avctx the codec context being used for decoding the stream
164  * @param profile a pointer into which the result will be written on success.
165  * The contents of profile are undefined if this function returns
166  * an error.
167  *
168  * @return 0 on success (non-negative), a negative AVERROR on failure.
169  */
171 int av_vdpau_get_profile(AVCodecContext *avctx, VdpDecoderProfile *profile);
172 #endif
173 
174 /* @}*/
175 
176 #endif /* AVCODEC_VDPAU_H */
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:295
version.h
av_vdpau_get_surface_parameters
int av_vdpau_get_surface_parameters(AVCodecContext *avctx, VdpChromaType *type, uint32_t *width, uint32_t *height)
Gets the parameters to create an adequate VDPAU video surface for the codec context using VDPAU hardw...
AVVDPAUContext
This structure is used to share data between the libavcodec library and the client video application.
Definition: vdpau.h:81
av_vdpau_hwaccel_get_render2
AVVDPAU_Render2 av_vdpau_hwaccel_get_render2(const AVVDPAUContext *)
AVVDPAUContext::render2
AVVDPAU_Render2 render2
Definition: vdpau.h:96
av_vdpau_alloc_context
AVVDPAUContext * av_vdpau_alloc_context(void)
Allocate an AVVDPAUContext.
av_alloc_vdpaucontext
AVVDPAUContext * av_alloc_vdpaucontext(void)
allocation function for AVVDPAUContext
av_vdpau_bind_context
int av_vdpau_bind_context(AVCodecContext *avctx, VdpDevice device, VdpGetProcAddress *get_proc_address, unsigned flags)
Associate a VDPAU device with a codec context for hardware acceleration.
AVVDPAUContext::render
VdpDecoderRender * render
VDPAU decoder render callback.
Definition: vdpau.h:94
AVVDPAUContext::decoder
VdpDecoder decoder
VDPAU decoder handle.
Definition: vdpau.h:87
height
static int height
Definition: demuxing_decoding.c:39
attribute_deprecated
#define attribute_deprecated
Definition: attributes.h:98
width
static int width
Definition: demuxing_decoding.c:39
attributes.h
AVVDPAU_Render2
int(* AVVDPAU_Render2)(struct AVCodecContext *, struct AVFrame *, const VdpPictureInfo *, uint32_t, const VdpBitstreamBuffer *)
Definition: vdpau.h:63
avcodec.h
av_vdpau_get_profile
attribute_deprecated int av_vdpau_get_profile(AVCodecContext *avctx, VdpDecoderProfile *profile)
Get a decoder profile that should be used for initializing a VDPAU decoder.
AVCodecContext
main external API structure.
Definition: avcodec.h:1565
av_vdpau_hwaccel_set_render2
void av_vdpau_hwaccel_set_render2(AVVDPAUContext *, AVVDPAU_Render2)