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
  54 #include "libavutil/avconfig.h"
  55 #include "libavutil/attributes.h"
  56
  57 #include "avcodec.h"
  58
  59 struct AVCodecContext;
  60 struct AVFrame;
  61
  62 typedef 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  * This structure will be allocated and stored in AVCodecContext.hwaccel_context
  70  * by av_vdpau_bind_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.
  77  */
  78 typedef struct AVVDPAUContext {
  79     /**
  80      * VDPAU decoder handle
  81      *
  82      * Set by user.
  83      */
  84     VdpDecoder decoder;
  85
  86     /**
  87      * VDPAU decoder render callback
  88      *
  89      * Set by the user.
  90      */
  91     VdpDecoderRender *render;
  92
  93     AVVDPAU_Render2 render2;
  94 } AVVDPAUContext;
  95
  96 #if FF_API_VDPAU_ALLOC_GET_SET
  97 /**
  98  * @brief allocation function for AVVDPAUContext
  99  *
 100  * Allows extending the struct without breaking API/ABI
 101  * @deprecated use av_vdpau_bind_context() instead
 102  */
 103 attribute_deprecated
 104 AVVDPAUContext *av_alloc_vdpaucontext(void);
 105
 106 /**
 107  * @deprecated render2 is public and can be accessed directly
 108  */
 109 attribute_deprecated
 110 AVVDPAU_Render2 av_vdpau_hwaccel_get_render2(const AVVDPAUContext *);
 111 /**
 112  * @deprecated render2 is public and can be accessed directly
 113  */
 114 attribute_deprecated
 115 void av_vdpau_hwaccel_set_render2(AVVDPAUContext *, AVVDPAU_Render2);
 116 #endif
 117
 118 /**
 119  * Associate a VDPAU device with a codec context for hardware acceleration.
 120  * This function is meant to be called from the get_format() codec callback,
 121  * or earlier. It can also be called after avcodec_flush_buffers() to change
 122  * the underlying VDPAU device mid-stream (e.g. to recover from non-transparent
 123  * display preemption).
 124  *
 125  * @note get_format() must return AV_PIX_FMT_VDPAU if this function completes
 126  * successfully.
 127  *
 128  * @param avctx decoding context whose get_format() callback is invoked
 129  * @param device VDPAU device handle to use for hardware acceleration
 130  * @param get_proc_address VDPAU device driver
 131  * @param flags zero of more OR'd AV_HWACCEL_FLAG_* flags
 132  *
 133  * @return 0 on success, an AVERROR code on failure.
 134  */
 135 int av_vdpau_bind_context(AVCodecContext *avctx, VdpDevice device,
 136                           VdpGetProcAddress *get_proc_address, unsigned flags);
 137
 138 /**
 139  * Gets the parameters to create an adequate VDPAU video surface for the codec
 140  * context using VDPAU hardware decoding acceleration.
 141  *
 142  * @note Behavior is undefined if the context was not successfully bound to a
 143  * VDPAU device using av_vdpau_bind_context().
 144  *
 145  * @param avctx the codec context being used for decoding the stream
 146  * @param type storage space for the VDPAU video surface chroma type
 147  *              (or NULL to ignore)
 148  * @param width storage space for the VDPAU video surface pixel width
 149  *              (or NULL to ignore)
 150  * @param height storage space for the VDPAU video surface pixel height
 151  *              (or NULL to ignore)
 152  *
 153  * @return 0 on success, a negative AVERROR code on failure.
 154  */
 155 int av_vdpau_get_surface_parameters(AVCodecContext *avctx, VdpChromaType *type,
 156                                     uint32_t *width, uint32_t *height);
 157
 158 #if FF_API_VDPAU_ALLOC_GET_SET
 159 /**
 160  * Allocate an AVVDPAUContext.
 161  *
 162  * @return Newly-allocated AVVDPAUContext or NULL on failure.
 163  * @deprecated use av_vdpau_bind_context() instead
 164  */
 165 attribute_deprecated
 166 AVVDPAUContext *av_vdpau_alloc_context(void);
 167 #endif
 168
 169 /** @} */
 170
 171 #endif /* AVCODEC_VDPAU_H */