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 #if FF_API_BUFS_VDPAU
  56 union AVVDPAUPictureInfo {
  57     VdpPictureInfoH264        h264;
  58     VdpPictureInfoMPEG1Or2    mpeg;
  59     VdpPictureInfoVC1          vc1;
  60     VdpPictureInfoMPEG4Part2 mpeg4;
  61 };
  62 #endif
  63
  64 /**
  65  * This structure is used to share data between the libavcodec library and
  66  * the client video application.
  67  * The user shall zero-allocate the structure and make it available as
  68  * AVCodecContext.hwaccel_context. Members can be set by the user once
  69  * during initialization or through each AVCodecContext.get_buffer()
  70  * function call. In any case, they must be valid prior to calling
  71  * decoding functions.
  72  */
  73 typedef struct AVVDPAUContext {
  74     /**
  75      * VDPAU decoder handle
  76      *
  77      * Set by user.
  78      */
  79     VdpDecoder decoder;
  80
  81     /**
  82      * VDPAU decoder render callback
  83      *
  84      * Set by the user.
  85      */
  86     VdpDecoderRender *render;
  87
  88 #if FF_API_BUFS_VDPAU
  89     /**
  90      * VDPAU picture information
  91      *
  92      * Set by libavcodec.
  93      */
  94     attribute_deprecated
  95     union AVVDPAUPictureInfo info;
  96
  97     /**
  98      * Allocated size of the bitstream_buffers table.
  99      *
 100      * Set by libavcodec.
 101      */
 102     attribute_deprecated
 103     int bitstream_buffers_allocated;
 104
 105     /**
 106      * Useful bitstream buffers in the bitstream buffers table.
 107      *
 108      * Set by libavcodec.
 109      */
 110     attribute_deprecated
 111     int bitstream_buffers_used;
 112
 113    /**
 114      * Table of bitstream buffers.
 115      * The user is responsible for freeing this buffer using av_freep().
 116      *
 117      * Set by libavcodec.
 118      */
 119     attribute_deprecated
 120     VdpBitstreamBuffer *bitstream_buffers;
 121 #endif
 122 } AVVDPAUContext;
 123
 124 #if FF_API_CAP_VDPAU
 125 /** @brief The videoSurface is used for rendering. */
 126 #define FF_VDPAU_STATE_USED_FOR_RENDER 1
 127
 128 /**
 129  * @brief The videoSurface is needed for reference/prediction.
 130  * The codec manipulates this.
 131  */
 132 #define FF_VDPAU_STATE_USED_FOR_REFERENCE 2
 133
 134 /**
 135  * @brief This structure is used as a callback between the Libav
 136  * decoder (vd_) and presentation (vo_) module.
 137  * This is used for defining a video frame containing surface,
 138  * picture parameter, bitstream information etc which are passed
 139  * between the Libav decoder and its clients.
 140  */
 141 struct vdpau_render_state {
 142     VdpVideoSurface surface; ///< Used as rendered surface, never changed.
 143
 144     int state; ///< Holds FF_VDPAU_STATE_* values.
 145
 146     /** picture parameter information for all supported codecs */
 147     union AVVDPAUPictureInfo info;
 148
 149     /** Describe size/location of the compressed video data.
 150         Set to 0 when freeing bitstream_buffers. */
 151     int bitstream_buffers_allocated;
 152     int bitstream_buffers_used;
 153     /** The user is responsible for freeing this buffer using av_freep(). */
 154     VdpBitstreamBuffer *bitstream_buffers;
 155 };
 156 #endif
 157
 158 /* @}*/
 159
 160 #endif /* AVCODEC_VDPAU_H */