vdpau.h (5071B)
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 * The user shall allocate the structure via the av_alloc_vdpau_hwaccel 69 * function and make it available as 70 * AVCodecContext.hwaccel_context. Members can be set by the user once 71 * during initialization or through each AVCodecContext.get_buffer() 72 * function call. In any case, they must be valid prior to calling 73 * decoding functions. 74 * 75 * The size of this structure is not a part of the public ABI and must not 76 * be used outside of libavcodec. Use av_vdpau_alloc_context() to allocate an 77 * AVVDPAUContext. 78 */ 79 typedef struct AVVDPAUContext { 80 /** 81 * VDPAU decoder handle 82 * 83 * Set by user. 84 */ 85 VdpDecoder decoder; 86 87 /** 88 * VDPAU decoder render callback 89 * 90 * Set by the user. 91 */ 92 VdpDecoderRender* render; 93 94 AVVDPAU_Render2 render2; 95 } AVVDPAUContext; 96 97 /** 98 * @brief allocation function for AVVDPAUContext 99 * 100 * Allows extending the struct without breaking API/ABI 101 */ 102 AVVDPAUContext* av_alloc_vdpaucontext(void); 103 104 AVVDPAU_Render2 av_vdpau_hwaccel_get_render2(const AVVDPAUContext*); 105 void av_vdpau_hwaccel_set_render2(AVVDPAUContext*, AVVDPAU_Render2); 106 107 /** 108 * Associate a VDPAU device with a codec context for hardware acceleration. 109 * This function is meant to be called from the get_format() codec callback, 110 * or earlier. It can also be called after avcodec_flush_buffers() to change 111 * the underlying VDPAU device mid-stream (e.g. to recover from non-transparent 112 * display preemption). 113 * 114 * @note get_format() must return AV_PIX_FMT_VDPAU if this function completes 115 * successfully. 116 * 117 * @param avctx decoding context whose get_format() callback is invoked 118 * @param device VDPAU device handle to use for hardware acceleration 119 * @param get_proc_address VDPAU device driver 120 * @param flags zero of more OR'd AV_HWACCEL_FLAG_* flags 121 * 122 * @return 0 on success, an AVERROR code on failure. 123 */ 124 int av_vdpau_bind_context(AVCodecContext* avctx, VdpDevice device, 125 VdpGetProcAddress* get_proc_address, unsigned flags); 126 127 /** 128 * Gets the parameters to create an adequate VDPAU video surface for the codec 129 * context using VDPAU hardware decoding acceleration. 130 * 131 * @note Behavior is undefined if the context was not successfully bound to a 132 * VDPAU device using av_vdpau_bind_context(). 133 * 134 * @param avctx the codec context being used for decoding the stream 135 * @param type storage space for the VDPAU video surface chroma type 136 * (or NULL to ignore) 137 * @param width storage space for the VDPAU video surface pixel width 138 * (or NULL to ignore) 139 * @param height storage space for the VDPAU video surface pixel height 140 * (or NULL to ignore) 141 * 142 * @return 0 on success, a negative AVERROR code on failure. 143 */ 144 int av_vdpau_get_surface_parameters(AVCodecContext* avctx, VdpChromaType* type, 145 uint32_t* width, uint32_t* height); 146 147 /** 148 * Allocate an AVVDPAUContext. 149 * 150 * @return Newly-allocated AVVDPAUContext or NULL on failure. 151 */ 152 AVVDPAUContext* av_vdpau_alloc_context(void); 153 154 /** @} */ 155 156 #endif /* AVCODEC_VDPAU_H */