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 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 #include <vdpau/vdpau_x11.h>
  54 #include "libavutil/avconfig.h"
  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 struct AVCodecContext;
  70 struct AVFrame;
  71
  72 typedef int (*AVVDPAU_Render2)(struct AVCodecContext *, struct AVFrame *,
  73                                const VdpPictureInfo *, uint32_t,
  74                                const VdpBitstreamBuffer *);
  75
  76 /**
  77  * This structure is used to share data between the libavcodec library and
  78  * the client video application.
  79  * The user shall allocate the structure via the av_alloc_vdpau_hwaccel
  80  * function and make it available as
  81  * AVCodecContext.hwaccel_context. Members can be set by the user once
  82  * during initialization or through each AVCodecContext.get_buffer()
  83  * function call. In any case, they must be valid prior to calling
  84  * decoding functions.
  85  *
  86  * The size of this structure is not a part of the public ABI and must not
  87  * be used outside of libavcodec. Use av_vdpau_alloc_context() to allocate an
  88  * AVVDPAUContext.
  89  */
  90 typedef struct AVVDPAUContext {
  91     /**
  92      * VDPAU decoder handle
  93      *
  94      * Set by user.
  95      */
  96     VdpDecoder decoder;
  97
  98     /**
  99      * VDPAU decoder render callback
 100      *
 101      * Set by the user.
 102      */
 103     VdpDecoderRender *render;
 104
 105 #if FF_API_BUFS_VDPAU
 106     /**
 107      * VDPAU picture information
 108      *
 109      * Set by libavcodec.
 110      */
 111     attribute_deprecated
 112     union AVVDPAUPictureInfo info;
 113
 114     /**
 115      * Allocated size of the bitstream_buffers table.
 116      *
 117      * Set by libavcodec.
 118      */
 119     attribute_deprecated
 120     int bitstream_buffers_allocated;
 121
 122     /**
 123      * Useful bitstream buffers in the bitstream buffers table.
 124      *
 125      * Set by libavcodec.
 126      */
 127     attribute_deprecated
 128     int bitstream_buffers_used;
 129
 130    /**
 131      * Table of bitstream buffers.
 132      * The user is responsible for freeing this buffer using av_freep().
 133      *
 134      * Set by libavcodec.
 135      */
 136     attribute_deprecated
 137     VdpBitstreamBuffer *bitstream_buffers;
 138 #endif
 139     AVVDPAU_Render2 render2;
 140 } AVVDPAUContext;
 141
 142 /**
 143  * @brief allocation function for AVVDPAUContext
 144  *
 145  * Allows extending the struct without breaking API/ABI
 146  */
 147 AVVDPAUContext *av_alloc_vdpaucontext(void);
 148
 149 AVVDPAU_Render2 av_vdpau_hwaccel_get_render2(const AVVDPAUContext *);
 150 void av_vdpau_hwaccel_set_render2(AVVDPAUContext *, AVVDPAU_Render2);
 151
 152 /**
 153  * Allocate an AVVDPAUContext.
 154  *
 155  * @return Newly-allocated AVVDPAUContext or NULL on failure.
 156  */
 157 AVVDPAUContext *av_vdpau_alloc_context(void);
 158
 159 /**
 160  * Get a decoder profile that should be used for initializing a VDPAU decoder.
 161  * Should be called from the AVCodecContext.get_format() callback.
 162  *
 163  * @param avctx the codec context being used for decoding the stream
 164  * @param profile a pointer into which the result will be written on success.
 165  *                The contents of profile are undefined if this function returns
 166  *                an error.
 167  *
 168  * @return 0 on success (non-negative), a negative AVERROR on failure.
 169  */
 170 int av_vdpau_get_profile(AVCodecContext *avctx, VdpDecoderProfile *profile);
 171
 172 #if FF_API_CAP_VDPAU
 173 /** @brief The videoSurface is used for rendering. */
 174 #define FF_VDPAU_STATE_USED_FOR_RENDER 1
 175
 176 /**
 177  * @brief The videoSurface is needed for reference/prediction.
 178  * The codec manipulates this.
 179  */
 180 #define FF_VDPAU_STATE_USED_FOR_REFERENCE 2
 181
 182 /**
 183  * @brief This structure is used as a callback between the FFmpeg
 184  * decoder (vd_) and presentation (vo_) module.
 185  * This is used for defining a video frame containing surface,
 186  * picture parameter, bitstream information etc which are passed
 187  * between the FFmpeg decoder and its clients.
 188  */
 189 struct vdpau_render_state {
 190     VdpVideoSurface surface; ///< Used as rendered surface, never changed.
 191
 192     int state; ///< Holds FF_VDPAU_STATE_* values.
 193
 194 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
 195     /** picture parameter information for all supported codecs */
 196     union AVVDPAUPictureInfo info;
 197 #endif
 198
 199     /** Describe size/location of the compressed video data.
 200         Set to 0 when freeing bitstream_buffers. */
 201     int bitstream_buffers_allocated;
 202     int bitstream_buffers_used;
 203     /** The user is responsible for freeing this buffer using av_freep(). */
 204     VdpBitstreamBuffer *bitstream_buffers;
 205
 206 #if !AV_HAVE_INCOMPATIBLE_LIBAV_ABI
 207     /** picture parameter information for all supported codecs */
 208     union AVVDPAUPictureInfo info;
 209 #endif
 210 };
 211 #endif
 212
 213 /* @}*/
 214
 215 #endif /* AVCODEC_VDPAU_H */