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 #include <vdpau/vdpau_x11.h>
  54
  55 #include "libavutil/attributes.h"
  56
  57 #include "avcodec.h"
  58 #include "version.h"
  59
  60 #if FF_API_BUFS_VDPAU
  61 union AVVDPAUPictureInfo {
  62     VdpPictureInfoH264        h264;
  63     VdpPictureInfoMPEG1Or2    mpeg;
  64     VdpPictureInfoVC1          vc1;
  65     VdpPictureInfoMPEG4Part2 mpeg4;
  66 };
  67 #endif
  68
  69 /**
  70  * This structure is used to share data between the libavcodec library and
  71  * the client video application.
  72  * The user shall zero-allocate the structure and make it available as
  73  * AVCodecContext.hwaccel_context. Members can be set by the user once
  74  * during initialization or through each AVCodecContext.get_buffer()
  75  * function call. In any case, they must be valid prior to calling
  76  * decoding functions.
  77  *
  78  * The size of this structure is not a part of the public ABI and must not
  79  * be used outside of libavcodec. Use av_vdpau_alloc_context() to allocate an
  80  * AVVDPAUContext.
  81  */
  82 typedef struct AVVDPAUContext {
  83     /**
  84      * VDPAU decoder handle
  85      *
  86      * Set by user.
  87      */
  88     VdpDecoder decoder;
  89
  90     /**
  91      * VDPAU decoder render callback
  92      *
  93      * Set by the user.
  94      */
  95     VdpDecoderRender *render;
  96
  97 #if FF_API_BUFS_VDPAU
  98     /**
  99      * VDPAU picture information
 100      *
 101      * Set by libavcodec.
 102      */
 103     attribute_deprecated
 104     union AVVDPAUPictureInfo info;
 105
 106     /**
 107      * Allocated size of the bitstream_buffers table.
 108      *
 109      * Set by libavcodec.
 110      */
 111     attribute_deprecated
 112     int bitstream_buffers_allocated;
 113
 114     /**
 115      * Useful bitstream buffers in the bitstream buffers table.
 116      *
 117      * Set by libavcodec.
 118      */
 119     attribute_deprecated
 120     int bitstream_buffers_used;
 121
 122    /**
 123      * Table of bitstream buffers.
 124      * The user is responsible for freeing this buffer using av_freep().
 125      *
 126      * Set by libavcodec.
 127      */
 128     attribute_deprecated
 129     VdpBitstreamBuffer *bitstream_buffers;
 130 #endif
 131 } AVVDPAUContext;
 132
 133 /**
 134  * Associate a VDPAU device with a codec context for hardware acceleration.
 135  * This function is meant to be called from the get_format() codec callback,
 136  * or earlier. It can also be called after avcodec_flush_buffers() to change
 137  * the underlying VDPAU device mid-stream (e.g. to recover from non-transparent
 138  * display preemption).
 139  *
 140  * @note get_format() must return AV_PIX_FMT_VDPAU if this function completes
 141  * succesfully.
 142  *
 143  * @param avctx decoding context whose get_format() callback is invoked
 144  * @param device VDPAU device handle to use for hardware acceleration
 145  * @param get_proc_address VDPAU device driver
 146  * @param flags zero of more OR'd AV_HWACCEL_FLAG_* flags
 147  *
 148  * @return 0 on success, an AVERROR code on failure.
 149  */
 150 int av_vdpau_bind_context(AVCodecContext *avctx, VdpDevice device,
 151                           VdpGetProcAddress *get_proc_address, unsigned flags);
 152
 153 /**
 154  * Gets the parameters to create an adequate VDPAU video surface for the codec
 155  * context using VDPAU hardware decoding acceleration.
 156  *
 157  * @note Behavior is undefined if the context was not successfully bound to a
 158  * VDPAU device using av_vdpau_bind_context().
 159  *
 160  * @param avctx the codec context being used for decoding the stream
 161  * @param type storage space for the VDPAU video surface chroma type
 162  *              (or NULL to ignore)
 163  * @param width storage space for the VDPAU video surface pixel width
 164  *              (or NULL to ignore)
 165  * @param height storage space for the VDPAU video surface pixel height
 166  *              (or NULL to ignore)
 167  *
 168  * @return 0 on success, a negative AVERROR code on failure.
 169  */
 170 int av_vdpau_get_surface_parameters(AVCodecContext *avctx, VdpChromaType *type,
 171                                     uint32_t *width, uint32_t *height);
 172
 173 /**
 174  * Allocate an AVVDPAUContext.
 175  *
 176  * @return Newly-allocated AVVDPAUContext or NULL on failure.
 177  */
 178 AVVDPAUContext *av_vdpau_alloc_context(void);
 179
 180 #if FF_API_VDPAU_PROFILE
 181 /**
 182  * Get a decoder profile that should be used for initializing a VDPAU decoder.
 183  * Should be called from the AVCodecContext.get_format() callback.
 184  *
 185  * @deprecated Use av_vdpau_bind_context() instead.
 186  *
 187  * @param avctx the codec context being used for decoding the stream
 188  * @param profile a pointer into which the result will be written on success.
 189  *                The contents of profile are undefined if this function returns
 190  *                an error.
 191  *
 192  * @return 0 on success (non-negative), a negative AVERROR on failure.
 193  */
 194 attribute_deprecated
 195 int av_vdpau_get_profile(AVCodecContext *avctx, VdpDecoderProfile *profile);
 196 #endif
 197
 198 #if FF_API_CAP_VDPAU
 199 /** @brief The videoSurface is used for rendering. */
 200 #define FF_VDPAU_STATE_USED_FOR_RENDER 1
 201
 202 /**
 203  * @brief The videoSurface is needed for reference/prediction.
 204  * The codec manipulates this.
 205  */
 206 #define FF_VDPAU_STATE_USED_FOR_REFERENCE 2
 207
 208 /**
 209  * @brief This structure is used as a callback between the Libav
 210  * decoder (vd_) and presentation (vo_) module.
 211  * This is used for defining a video frame containing surface,
 212  * picture parameter, bitstream information etc which are passed
 213  * between the Libav decoder and its clients.
 214  */
 215 struct vdpau_render_state {
 216     VdpVideoSurface surface; ///< Used as rendered surface, never changed.
 217
 218     int state; ///< Holds FF_VDPAU_STATE_* values.
 219
 220     /** picture parameter information for all supported codecs */
 221     union AVVDPAUPictureInfo info;
 222
 223     /** Describe size/location of the compressed video data.
 224         Set to 0 when freeing bitstream_buffers. */
 225     int bitstream_buffers_allocated;
 226     int bitstream_buffers_used;
 227     /** The user is responsible for freeing this buffer using av_freep(). */
 228     VdpBitstreamBuffer *bitstream_buffers;
 229 };
 230 #endif
 231
 232 /* @}*/
 233
 234 #endif /* AVCODEC_VDPAU_H */