Doxygen spelling/wording fixes
[libav.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_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 /** Set by the calling application.
38 Once set these values are not supposed to be modified.
39 */
40 //@{
41 /** The field contains the special constant value AV_XVMC_ID.
42 It is used as a test that the application correctly uses the API,
43 and that there is no corruption caused by pixel routines.
44 - application - set during initialization
45 - libavcodec - unchanged
46 */
47 int xvmc_id;
48
49 /** Pointer to the block array allocated by XvMCCreateBlocks()
50 it contains differential pixel data (in MoCo mode)
51 or coefficients for IDCT.
52 - application - set during initialization
53 - libavcodec - unchanged
54 */
55 short* data_blocks;
56
57 /** Pointer to the macroblock description array allocated by XvMCCreateMacroBlocks().
58 - application - set during initialization
59 - libavcodec - unchanged
60 */
61 XvMCMacroBlock* mv_blocks;
62
63 /** Number of macroblock descriptions that can be stored in the mv_blocks
64 array.
65 - application - set during initialization
66 - libavcodec - unchanged
67 */
68 int total_number_of_mv_blocks;
69
70 /** Number of blocks that can be stored at once in the data_blocks array.
71 - application - set during initialization
72 - libavcodec - unchanged
73 */
74 int total_number_of_data_blocks;
75
76 /** Indicates that the hardware would interpret data_blocks as IDCT coefficients
77 and perform IDCT on them.
78 - application - set during initialization
79 - libavcodec - unchanged
80 */
81 int idct;
82
83 /** In MoCo mode it indicates that intra macroblocks are assumed to be in
84 unsigned format; same as the XVMC_INTRA_UNSIGNED flag.
85 - application - set during initialization
86 - libavcodec - unchanged
87 */
88 int unsigned_intra;
89
90 /** Pointer to the surface allocated by XvMCCreateSurface().
91 It identifies the frame and its state on the video hardware.
92 - application - set during initialization
93 - libavcodec - unchanged
94 */
95 XvMCSurface* p_surface;
96 //}@
97
98 /** Set by the decoder before calling ff_draw_horiz_band(),
99 needed by the XvMCRenderSurface function. */
100 //@{
101 /** Pointer to the surface used as past reference
102 - application - unchanged
103 - libavcodec - set
104 */
105 XvMCSurface* p_past_surface;
106
107 /** Pointer to the surface used as future reference
108 - application - unchanged
109 - libavcodec - set
110 */
111 XvMCSurface* p_future_surface;
112
113 /** top/bottom field or frame
114 - application - unchanged
115 - libavcodec - set
116 */
117 unsigned int picture_structure;
118
119 /** XVMC_SECOND_FIELD - 1st or 2nd field in the sequence
120 - application - unchanged
121 - libavcodec - set
122 */
123 unsigned int flags;
124 //}@
125
126 /** Offset in the mv array for the current slice.
127 Macroblocks described before that offset are assumed to have already
128 been passed to the hardware.
129 - application - zeroes it on get_buffer().
130 A successful ff_draw_horiz_band() may increment it
131 with filled_mb_block_num or zero both.
132 - libavcodec - unchanged
133 */
134 int start_mv_blocks_num;
135
136 /** Number of mv blocks that are filled by libavcodec and have to be passed to the hardware.
137 - application - zeroes it on get_buffer() or after successful ff_draw_horiz_band()
138 - libavcodec - increment with one of each stored MB
139 */
140 int filled_mv_blocks_num;
141
142 /** Offset to the next free data block. The mv_blocks hold a number pointing to the data blocks.
143 - application - zeroes it on get_buffer() and after successful ff_draw_horiz_band()
144 - libvcodec - each macroblock increases it with the number of coded blocks in it.
145 */
146 int next_free_data_block_num;
147
148 /** extensions may be placed here */
149 #if LIBAVCODEC_VERSION_MAJOR < 53
150 //@{
151 /** State - used to work around limitations in the MPlayer video system.
152 0 - Surface is not used.
153 1 - Surface is still held in application to be displayed or is still visible.
154 2 - Surface is still held in libavcodec buffer for prediction.
155 */
156 int state;
157 void* p_osd_target_surface_render; ///< pointer to the surface where the subpicture is rendered
158 //}@
159 #endif
160 };
161
162 #endif /* AVCODEC_XVMC_H */