git.sesse.net Git - ffmpeg/blob - 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 Libav.
   8  *
   9  * Libav 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  * Libav 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 Libav; 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 Libav
  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/attributes.h"
  55
  56 #include "avcodec.h"
  57 #include "version.h"
  58
  59 /**
  60  * This structure is used to share data between the libavcodec library and
  61  * the client video application.
  62  * The user shall zero-allocate the structure and make it available as
  63  * AVCodecContext.hwaccel_context. Members can be set by the user once
  64  * during initialization or through each AVCodecContext.get_buffer()
  65  * function call. In any case, they must be valid prior to calling
  66  * decoding functions.
  67  *
  68  * The size of this structure is not a part of the public ABI and must not
  69  * be used outside of libavcodec. Use av_vdpau_alloc_context() to allocate an
  70  * AVVDPAUContext.
  71  */
  72 typedef struct AVVDPAUContext {
  73     /**
  74      * VDPAU decoder handle
  75      *
  76      * Set by user.
  77      */
  78     VdpDecoder decoder;
  79
  80     /**
  81      * VDPAU decoder render callback
  82      *
  83      * Set by the user.
  84      */
  85     VdpDecoderRender *render;
  86 } AVVDPAUContext;
  87
  88 /**
  89  * Associate a VDPAU device with a codec context for hardware acceleration.
  90  * This function is meant to be called from the get_format() codec callback,
  91  * or earlier. It can also be called after avcodec_flush_buffers() to change
  92  * the underlying VDPAU device mid-stream (e.g. to recover from non-transparent
  93  * display preemption).
  94  *
  95  * @note get_format() must return AV_PIX_FMT_VDPAU if this function completes
  96  * successfully.
  97  *
  98  * @param avctx decoding context whose get_format() callback is invoked
  99  * @param device VDPAU device handle to use for hardware acceleration
 100  * @param get_proc_address VDPAU device driver
 101  * @param flags zero of more OR'd AV_HWACCEL_FLAG_* flags
 102  *
 103  * @return 0 on success, an AVERROR code on failure.
 104  */
 105 int av_vdpau_bind_context(AVCodecContext *avctx, VdpDevice device,
 106                           VdpGetProcAddress *get_proc_address, unsigned flags);
 107
 108 /**
 109  * Gets the parameters to create an adequate VDPAU video surface for the codec
 110  * context using VDPAU hardware decoding acceleration.
 111  *
 112  * @note Behavior is undefined if the context was not successfully bound to a
 113  * VDPAU device using av_vdpau_bind_context().
 114  *
 115  * @param avctx the codec context being used for decoding the stream
 116  * @param type storage space for the VDPAU video surface chroma type
 117  *              (or NULL to ignore)
 118  * @param width storage space for the VDPAU video surface pixel width
 119  *              (or NULL to ignore)
 120  * @param height storage space for the VDPAU video surface pixel height
 121  *              (or NULL to ignore)
 122  *
 123  * @return 0 on success, a negative AVERROR code on failure.
 124  */
 125 int av_vdpau_get_surface_parameters(AVCodecContext *avctx, VdpChromaType *type,
 126                                     uint32_t *width, uint32_t *height);
 127
 128 /**
 129  * Allocate an AVVDPAUContext.
 130  *
 131  * @return Newly-allocated AVVDPAUContext or NULL on failure.
 132  */
 133 AVVDPAUContext *av_vdpau_alloc_context(void);
 134
 135 #if FF_API_VDPAU_PROFILE
 136 /**
 137  * Get a decoder profile that should be used for initializing a VDPAU decoder.
 138  * Should be called from the AVCodecContext.get_format() callback.
 139  *
 140  * @deprecated Use av_vdpau_bind_context() instead.
 141  *
 142  * @param avctx the codec context being used for decoding the stream
 143  * @param profile a pointer into which the result will be written on success.
 144  *                The contents of profile are undefined if this function returns
 145  *                an error.
 146  *
 147  * @return 0 on success (non-negative), a negative AVERROR on failure.
 148  */
 149 attribute_deprecated
 150 int av_vdpau_get_profile(AVCodecContext *avctx, VdpDecoderProfile *profile);
 151 #endif
 152
 153 /* @}*/
 154
 155 #endif /* AVCODEC_VDPAU_H */