Drop struct members display_flags and state with the next major version bump.
[ffmpeg.git] / 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 #define AV_XVMC_STATE_DISPLAY_PENDING          1  /**  the surface should be shown, the video driver manipulates this */
29 #define AV_XVMC_STATE_PREDICTION               2  /**  the surface is needed for prediction, the codec manipulates this */
30 #define AV_XVMC_STATE_OSD_SOURCE               4  /**  this surface is needed for subpicture rendering */
31 #define AV_XVMC_RENDER_MAGIC          0x1DC711C0  /**< magic value to ensure that regular pixel routines haven't corrupted the struct */
32                                                   //   1337 IDCT MCo
33
34 struct xvmc_render_state {
35 /** set by calling application */
36 //@{
37     int             magic;                        ///< used as a check against memory corruption by regular pixel routines
38
39     short*          data_blocks;
40     XvMCMacroBlock* mv_blocks;
41     int             total_number_of_mv_blocks;
42     int             total_number_of_data_blocks;
43     int             idct;                         ///< indicate that IDCT acceleration level is used
44     int             unsigned_intra;               ///< +-128 for intra pictures after clipping
45     XvMCSurface*    p_surface;                    ///< pointer to rendered surface, never changed
46 //}@
47
48 /** set by the decoder
49     used by the XvMCRenderSurface function */
50 //@{
51     XvMCSurface*    p_past_surface;               ///< pointer to the past surface
52     XvMCSurface*    p_future_surface;             ///< pointer to the future prediction surface
53
54     unsigned int    picture_structure;            ///< top/bottom fields or frame
55     unsigned int    flags;                        ///< XVMC_SECOND_FIELD - 1st or 2nd field in the sequence
56 #if LIBAVCODEC_VERSION_MAJOR < 53
57     unsigned int    display_flags;                ///< 1, 2 or 1+2 fields for XvMCPutSurface
58 #endif
59 //}@
60
61 /** modified by calling application and the decoder */
62 //@{
63 #if LIBAVCODEC_VERSION_MAJOR < 53
64     int             state;                        ///< 0 - free, 1 - waiting to display, 2 - waiting for prediction
65 #endif
66     int             start_mv_blocks_num;          ///< offset in the array for the current slice, updated by vo
67     int             filled_mv_blocks_num;         ///< processed mv block in this slice, changed by decoder
68
69     int             next_free_data_block_num;     ///< used in add_mv_block, pointer to next free block
70 //}@
71 /** extensions may be placed here */
72 #if LIBAVCODEC_VERSION_MAJOR < 53
73 //@{
74     void*           p_osd_target_surface_render;  ///< pointer to the surface where subpicture is rendered
75 //}@
76 #endif
77 };
78
79 #endif /* AVCODEC_XVMC_H */