vdpau.h (5433B)
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 * @defgroup lavc_codec_hwaccel_vdpau VDPAU Decoder and Renderer 35 * @ingroup lavc_codec_hwaccel 36 * 37 * VDPAU hardware acceleration has two modules 38 * - VDPAU decoding 39 * - VDPAU presentation 40 * 41 * The VDPAU decoding module parses all headers using FFmpeg 42 * parsing mechanisms and uses VDPAU for the actual decoding. 43 * 44 * As per the current implementation, the actual decoding 45 * and rendering (API calls) are done as part of the VDPAU 46 * presentation (vo_vdpau.c) module. 47 * 48 * @{ 49 */ 50 51 #include <vdpau/vdpau.h> 52 53 #include "libavutil/avconfig.h" 54 #include "libavutil/attributes.h" 55 56 #include "avcodec.h" 57 58 struct AVCodecContext; 59 struct AVFrame; 60 61 typedef int (*AVVDPAU_Render2)(struct AVCodecContext*, struct AVFrame*, 62 const VdpPictureInfo*, uint32_t, 63 const VdpBitstreamBuffer*); 64 65 /** 66 * This structure is used to share data between the libavcodec library and 67 * the client video application. 68 * This structure will be allocated and stored in AVCodecContext.hwaccel_context 69 * by av_vdpau_bind_context(). Members can be set by the user once 70 * during initialization or through each AVCodecContext.get_buffer() 71 * function call. In any case, they must be valid prior to calling 72 * decoding functions. 73 * 74 * The size of this structure is not a part of the public ABI and must not 75 * be used outside of libavcodec. 76 */ 77 typedef struct AVVDPAUContext { 78 /** 79 * VDPAU decoder handle 80 * 81 * Set by user. 82 */ 83 VdpDecoder decoder; 84 85 /** 86 * VDPAU decoder render callback 87 * 88 * Set by the user. 89 */ 90 VdpDecoderRender* render; 91 92 AVVDPAU_Render2 render2; 93 } AVVDPAUContext; 94 95 #if FF_API_VDPAU_ALLOC_GET_SET 96 /** 97 * @brief allocation function for AVVDPAUContext 98 * 99 * Allows extending the struct without breaking API/ABI 100 * @deprecated use av_vdpau_bind_context() instead 101 */ 102 attribute_deprecated AVVDPAUContext* av_alloc_vdpaucontext(void); 103 104 /** 105 * @deprecated render2 is public and can be accessed directly 106 */ 107 attribute_deprecated AVVDPAU_Render2 108 av_vdpau_hwaccel_get_render2(const AVVDPAUContext*); 109 /** 110 * @deprecated render2 is public and can be accessed directly 111 */ 112 attribute_deprecated void av_vdpau_hwaccel_set_render2(AVVDPAUContext*, 113 AVVDPAU_Render2); 114 #endif 115 116 /** 117 * Associate a VDPAU device with a codec context for hardware acceleration. 118 * This function is meant to be called from the get_format() codec callback, 119 * or earlier. It can also be called after avcodec_flush_buffers() to change 120 * the underlying VDPAU device mid-stream (e.g. to recover from non-transparent 121 * display preemption). 122 * 123 * @note get_format() must return AV_PIX_FMT_VDPAU if this function completes 124 * successfully. 125 * 126 * @param avctx decoding context whose get_format() callback is invoked 127 * @param device VDPAU device handle to use for hardware acceleration 128 * @param get_proc_address VDPAU device driver 129 * @param flags zero of more OR'd AV_HWACCEL_FLAG_* flags 130 * 131 * @return 0 on success, an AVERROR code on failure. 132 */ 133 int av_vdpau_bind_context(AVCodecContext* avctx, VdpDevice device, 134 VdpGetProcAddress* get_proc_address, unsigned flags); 135 136 /** 137 * Gets the parameters to create an adequate VDPAU video surface for the codec 138 * context using VDPAU hardware decoding acceleration. 139 * 140 * @note Behavior is undefined if the context was not successfully bound to a 141 * VDPAU device using av_vdpau_bind_context(). 142 * 143 * @param avctx the codec context being used for decoding the stream 144 * @param type storage space for the VDPAU video surface chroma type 145 * (or NULL to ignore) 146 * @param width storage space for the VDPAU video surface pixel width 147 * (or NULL to ignore) 148 * @param height storage space for the VDPAU video surface pixel height 149 * (or NULL to ignore) 150 * 151 * @return 0 on success, a negative AVERROR code on failure. 152 */ 153 int av_vdpau_get_surface_parameters(AVCodecContext* avctx, VdpChromaType* type, 154 uint32_t* width, uint32_t* height); 155 156 #if FF_API_VDPAU_ALLOC_GET_SET 157 /** 158 * Allocate an AVVDPAUContext. 159 * 160 * @return Newly-allocated AVVDPAUContext or NULL on failure. 161 * @deprecated use av_vdpau_bind_context() instead 162 */ 163 attribute_deprecated AVVDPAUContext* av_vdpau_alloc_context(void); 164 #endif 165 166 /** @} */ 167 168 #endif /* AVCODEC_VDPAU_H */