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