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