FFmpeg 5.1.6
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"
56
57#include "avcodec.h"
58
59struct AVCodecContext;
60struct AVFrame;
61
62typedef int (*AVVDPAU_Render2)(struct AVCodecContext *, struct AVFrame *,
63 const VdpPictureInfo *, uint32_t,
64 const VdpBitstreamBuffer *);
65
66/**
67 * This structure is used to share data between the libavcodec library and
68 * the client video application.
69 * The user shall allocate the structure via the av_alloc_vdpau_hwaccel
70 * function 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 * The size of this structure is not a part of the public ABI and must not
77 * be used outside of libavcodec. Use av_vdpau_alloc_context() to allocate an
78 * AVVDPAUContext.
79 */
80typedef struct AVVDPAUContext {
81 /**
82 * VDPAU decoder handle
83 *
84 * Set by user.
85 */
86 VdpDecoder decoder;
87
88 /**
89 * VDPAU decoder render callback
90 *
91 * Set by the user.
92 */
93 VdpDecoderRender *render;
94
97
98/**
99 * @brief allocation function for AVVDPAUContext
100 *
101 * Allows extending the struct without breaking API/ABI
102 */
104
107
108/**
109 * Associate a VDPAU device with a codec context for hardware acceleration.
110 * This function is meant to be called from the get_format() codec callback,
111 * or earlier. It can also be called after avcodec_flush_buffers() to change
112 * the underlying VDPAU device mid-stream (e.g. to recover from non-transparent
113 * display preemption).
114 *
115 * @note get_format() must return AV_PIX_FMT_VDPAU if this function completes
116 * successfully.
117 *
118 * @param avctx decoding context whose get_format() callback is invoked
119 * @param device VDPAU device handle to use for hardware acceleration
120 * @param get_proc_address VDPAU device driver
121 * @param flags zero of more OR'd AV_HWACCEL_FLAG_* flags
122 *
123 * @return 0 on success, an AVERROR code on failure.
124 */
125int av_vdpau_bind_context(AVCodecContext *avctx, VdpDevice device,
126 VdpGetProcAddress *get_proc_address, unsigned flags);
127
128/**
129 * Gets the parameters to create an adequate VDPAU video surface for the codec
130 * context using VDPAU hardware decoding acceleration.
131 *
132 * @note Behavior is undefined if the context was not successfully bound to a
133 * VDPAU device using av_vdpau_bind_context().
134 *
135 * @param avctx the codec context being used for decoding the stream
136 * @param type storage space for the VDPAU video surface chroma type
137 * (or NULL to ignore)
138 * @param width storage space for the VDPAU video surface pixel width
139 * (or NULL to ignore)
140 * @param height storage space for the VDPAU video surface pixel height
141 * (or NULL to ignore)
142 *
143 * @return 0 on success, a negative AVERROR code on failure.
144 */
145int av_vdpau_get_surface_parameters(AVCodecContext *avctx, VdpChromaType *type,
146 uint32_t *width, uint32_t *height);
147
148/**
149 * Allocate an AVVDPAUContext.
150 *
151 * @return Newly-allocated AVVDPAUContext or NULL on failure.
152 */
154
155/* @}*/
156
157#endif /* AVCODEC_VDPAU_H */
Macro definitions for various function/variable attributes.
Libavcodec external API header.
static int width
static int height
AVVDPAU_Render2 av_vdpau_hwaccel_get_render2(const AVVDPAUContext *)
int(* AVVDPAU_Render2)(struct AVCodecContext *, struct AVFrame *, const VdpPictureInfo *, uint32_t, const VdpBitstreamBuffer *)
Definition: vdpau.h:62
VdpDecoder decoder
VDPAU decoder handle.
Definition: vdpau.h:86
void av_vdpau_hwaccel_set_render2(AVVDPAUContext *, AVVDPAU_Render2)
AVVDPAUContext * av_alloc_vdpaucontext(void)
allocation function for AVVDPAUContext
VdpDecoderRender * render
VDPAU decoder render callback.
Definition: vdpau.h:93
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.
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 * av_vdpau_alloc_context(void)
Allocate an AVVDPAUContext.
AVVDPAU_Render2 render2
Definition: vdpau.h:95
main external API structure.
Definition: avcodec.h:389
This structure describes decoded (raw) audio or video data.
Definition: frame.h:325
This structure is used to share data between the libavcodec library and the client video application.
Definition: vdpau.h:80