libavcodec/xvmc.h

   1 /*
   2  * Copyright (C) 2003 Ivan Kalvachev
   3  *
   4  * This file is part of FFmpeg.
   5  *
   6  * FFmpeg is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * FFmpeg is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with FFmpeg; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #ifndef AVCODEC_XVMC_H
  22 #define AVCODEC_XVMC_H
  23
  24 #include <X11/extensions/XvMC.h>
  25
  26 #include "avcodec.h"
  27
  28 #if LIBAVCODEC_VERSION_MAJOR < 53
  29 #define AV_XVMC_STATE_DISPLAY_PENDING          1  /**  the surface should be shown, the video driver manipulates this */
  30 #define AV_XVMC_STATE_PREDICTION               2  /**  the surface is needed for prediction, the codec manipulates this */
  31 #define AV_XVMC_STATE_OSD_SOURCE               4  /**  the surface is needed for subpicture rendering */
  32 #endif
  33 #define AV_XVMC_ID                    0x1DC711C0  /**< special value to ensure that regular pixel routines haven't corrupted the struct
  34                                                        the number is 1337 speak for the letters IDCT MCo (motion compensation) */
  35
  36 struct xvmc_pix_fmt {
  37     /** The field contains the special constant value AV_XVMC_ID.
  38         It is used as a test that the application correctly uses the API,
  39         and that there is no corruption caused by pixel routines.
  40         - application - set during initialization
  41         - libavcodec  - unchanged
  42     */
  43     int             xvmc_id;
  44
  45     /** Pointer to the block array allocated by XvMCCreateBlocks().
  46         The array has to be freed by XvMCDestroyBlocks().
  47         Each group of 64 values represents one data block of differential
  48         pixel information (in MoCo mode) or coefficients for IDCT.
  49         - application - set the pointer during initialization
  50         - libavcodec  - fills coefficients/pixel data into the array
  51     */
  52     short*          data_blocks;
  53
  54     /** Pointer to the macroblock description array allocated by
  55         XvMCCreateMacroBlocks() and freed by XvMCDestroyMacroBlocks().
  56         - application - set the pointer during initialization
  57         - libavcodec  - fills description data into the array
  58     */
  59     XvMCMacroBlock* mv_blocks;
  60
  61     /** Number of macroblock descriptions that can be stored in the mv_blocks
  62         array.
  63         - application - set during initialization
  64         - libavcodec  - unchanged
  65     */
  66     int             allocated_mv_blocks;
  67
  68     /** Number of blocks that can be stored at once in the data_blocks array.
  69         - application - set during initialization
  70         - libavcodec  - unchanged
  71     */
  72     int             allocated_data_blocks;
  73
  74     /** Indicates that the hardware would interpret data_blocks as IDCT
  75         coefficients and perform IDCT on them.
  76         - application - set during initialization
  77         - libavcodec  - unchanged
  78     */
  79     int             idct;
  80
  81     /** In MoCo mode it indicates that intra macroblocks are assumed to be in
  82         unsigned format; same as the XVMC_INTRA_UNSIGNED flag.
  83         - application - set during initialization
  84         - libavcodec  - unchanged
  85     */
  86     int             unsigned_intra;
  87
  88     /** Pointer to the surface allocated by XvMCCreateSurface().
  89         It has to be freed by XvMCDestroySurface() on application exit.
  90         It identifies the frame and its state on the video hardware.
  91         - application - set during initialization
  92         - libavcodec  - unchanged
  93     */
  94     XvMCSurface*    p_surface;
  95
  96 /** Set by the decoder before calling ff_draw_horiz_band(),
  97     needed by the XvMCRenderSurface function. */
  98 //@{
  99     /** Pointer to the surface used as past reference
 100         - application - unchanged
 101         - libavcodec  - set
 102     */
 103     XvMCSurface*    p_past_surface;
 104
 105     /** Pointer to the surface used as future reference
 106         - application - unchanged
 107         - libavcodec  - set
 108     */
 109     XvMCSurface*    p_future_surface;
 110
 111     /** top/bottom field or frame
 112         - application - unchanged
 113         - libavcodec  - set
 114     */
 115     unsigned int    picture_structure;
 116
 117     /** XVMC_SECOND_FIELD - 1st or 2nd field in the sequence
 118         - application - unchanged
 119         - libavcodec  - set
 120     */
 121     unsigned int    flags;
 122 //}@
 123
 124     /** Number of macroblock descriptions in the mv_blocks array
 125         that have already been passed to the hardware.
 126         - application - zeroes it on get_buffer().
 127                         A successful ff_draw_horiz_band() may increment it
 128                         with filled_mb_block_num or zero both.
 129         - libavcodec  - unchanged
 130     */
 131     int             start_mv_blocks_num;
 132
 133     /** Number of new macroblock descriptions in the mv_blocks array (after
 134         start_mv_blocks_num) that are filled by libavcodec and have to be
 135         passed to the hardware.
 136         - application - zeroes it on get_buffer() or after successful
 137                         ff_draw_horiz_band().
 138         - libavcodec  - increment with one of each stored MB
 139     */
 140     int             filled_mv_blocks_num;
 141
 142     /** Number of the the next free data block; one data block consists of
 143         64 short values in the data_blocks array.
 144         All blocks before this one have already been claimed by placing their
 145         position into the corresponding block description structure field,
 146         that are part of the mv_blocks array.
 147         - application - zeroes it on get_buffer().
 148                         A successful ff_draw_horiz_band() may zero it together
 149                         with start_mb_blocks_num.
 150         - libavcodec  - each decoded macroblock increases it by the number
 151                         of coded blocks it contains.
 152     */
 153     int             next_free_data_block_num;
 154
 155 /** extensions may be placed here */
 156 #if LIBAVCODEC_VERSION_MAJOR < 53
 157 //@{
 158     /** State flags used to work around limitations in the MPlayer video system.
 159         0   - Surface is not used.
 160         1   - Surface is still held in application to be displayed or is
 161               still visible.
 162         2   - Surface is still held in libavcodec buffer for prediction.
 163     */
 164     int             state;
 165
 166     /** pointer to the surface where the subpicture is rendered */
 167     void*           p_osd_target_surface_render;
 168 //}@
 169 #endif
 170 };
 171
 172 #endif /* AVCODEC_XVMC_H */