comment spelling/grammar/wording fixes
[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 #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_RENDER_MAGIC          0x1DC711C0  /**< magic 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 /** Set by the calling application.
38     Once set these values are not supposed to be modified.
39 */
40 //@{
41     int             xvmc_id;                      ///< used as a check against memory corruption by regular pixel routines or other API structures
42
43     short*          data_blocks;
44     XvMCMacroBlock* mv_blocks;
45     int             total_number_of_mv_blocks;
46     int             total_number_of_data_blocks;
47     int             idct;                         ///< indicate that IDCT acceleration level is used
48     int             unsigned_intra;               ///< +-128 for intra pictures after clipping
49     XvMCSurface*    p_surface;                    ///< pointer to rendered surface, never changed
50 //}@
51
52 /** Set by the decoder before calling draw_horiz_band(),
53     needed by the XvMCRenderSurface function. */
54 //@{
55     XvMCSurface*    p_past_surface;               ///< pointer to the past surface
56     XvMCSurface*    p_future_surface;             ///< pointer to the future prediction surface
57
58     unsigned int    picture_structure;            ///< top/bottom field or frame
59     unsigned int    flags;                        ///< XVMC_SECOND_FIELD - 1st or 2nd field in the sequence
60 //}@
61
62     /** Offset in the mv array for the current slice:
63         - application - zeros it on get_buffer().
64                         A successful draw_horiz_band() may increment it
65                         with filled_mb_block_num or zero both.
66         - libavcodec  - unchanged
67     */
68     int             start_mv_blocks_num;
69
70     /** Processed mv blocks in this slice:
71         - application - zeros it on get_buffer() or after successful draw_horiz_band()
72         - libavcodec  - increment with one of each stored MB
73     */
74     int             filled_mv_blocks_num;
75
76     /** Offset to the next free data block. The mv_blocks hold number pointing to the data blocks.
77         - application - zeroes it on get_buffer() and after successful draw_horiz_band()
78         - libvcodec   - each macroblock increases it with the number of coded blocks in it.
79     */
80     int             next_free_data_block_num;
81
82 /** extensions may be placed here */
83 #if LIBAVCODEC_VERSION_MAJOR < 53
84 //@{
85     /** State - used to work around limitations in the MPlayer video system.
86         0   - Surface is not used.
87         1   - Surface is still held in application to be displayed or is still visible.
88         2   - Surface is still held in libavcodec buffer for prediction.
89     */
90     int             state;
91     void*           p_osd_target_surface_render;  ///< pointer to the surface where the subpicture is rendered
92 //}@
93 #endif
94 };
95
96 #endif /* AVCODEC_XVMC_H */