Doxygen spelling/wording fixes
[libav.git] / libavcodec / xvmc.h
CommitLineData
ef4d08ac
DB
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
af28efa2
DB
21#ifndef AVCODEC_XVMC_H
22#define AVCODEC_XVMC_H
699b3f99 23
c97dffbc 24#include <X11/extensions/XvMC.h>
7fade368 25
5d6c1110
DB
26#include "avcodec.h"
27
eb3b2ef9 28#if LIBAVCODEC_VERSION_MAJOR < 53
c1a5aa29
DB
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 */
1909fade 31#define AV_XVMC_STATE_OSD_SOURCE 4 /** the surface is needed for subpicture rendering */
eb3b2ef9 32#endif
4e30fa6e 33#define AV_XVMC_ID 0x1DC711C0 /**< special value to ensure that regular pixel routines haven't corrupted the struct
e98b4755 34 the number is 1337 speak for the letters IDCT MCo (motion compensation) */
117f9234 35
f602b044 36struct xvmc_pix_fmt {
1909fade 37/** Set by the calling application.
3fff9d92
IK
38 Once set these values are not supposed to be modified.
39*/
6785e509 40//@{
058bcd7b 41 /** The field contains the special constant value AV_XVMC_ID.
2f953883 42 It is used as a test that the application correctly uses the API,
ad0405fc
IK
43 and that there is no corruption caused by pixel routines.
44 - application - set during initialization
45 - libavcodec - unchanged
46 */
47 int xvmc_id;
7fade368 48
ad0405fc 49 /** Pointer to the block array allocated by XvMCCreateBlocks()
037f13fe 50 it contains differential pixel data (in MoCo mode)
ad0405fc
IK
51 or coefficients for IDCT.
52 - application - set during initialization
53 - libavcodec - unchanged
54 */
6b6ea1df 55 short* data_blocks;
ad0405fc
IK
56
57 /** Pointer to the macroblock description array allocated by XvMCCreateMacroBlocks().
58 - application - set during initialization
59 - libavcodec - unchanged
60 */
6b6ea1df 61 XvMCMacroBlock* mv_blocks;
ad0405fc 62
037f13fe
DB
63 /** Number of macroblock descriptions that can be stored in the mv_blocks
64 array.
ad0405fc
IK
65 - application - set during initialization
66 - libavcodec - unchanged
67 */
6b6ea1df 68 int total_number_of_mv_blocks;
ad0405fc 69
037f13fe 70 /** Number of blocks that can be stored at once in the data_blocks array.
ad0405fc
IK
71 - application - set during initialization
72 - libavcodec - unchanged
73 */
6b6ea1df 74 int total_number_of_data_blocks;
ad0405fc 75
058bcd7b 76 /** Indicates that the hardware would interpret data_blocks as IDCT coefficients
ad0405fc
IK
77 and perform IDCT on them.
78 - application - set during initialization
79 - libavcodec - unchanged
80 */
81 int idct;
82
037f13fe
DB
83 /** In MoCo mode it indicates that intra macroblocks are assumed to be in
84 unsigned format; same as the XVMC_INTRA_UNSIGNED flag.
ad0405fc
IK
85 - application - set during initialization
86 - libavcodec - unchanged
87 */
88 int unsigned_intra;
89
058bcd7b 90 /** Pointer to the surface allocated by XvMCCreateSurface().
037f13fe 91 It identifies the frame and its state on the video hardware.
ad0405fc
IK
92 - application - set during initialization
93 - libavcodec - unchanged
94 */
95 XvMCSurface* p_surface;
6785e509 96//}@
7fade368 97
8f66518d 98/** Set by the decoder before calling ff_draw_horiz_band(),
1909fade 99 needed by the XvMCRenderSurface function. */
6785e509 100//@{
ad0405fc
IK
101 /** Pointer to the surface used as past reference
102 - application - unchanged
103 - libavcodec - set
104 */
105 XvMCSurface* p_past_surface;
106
058bcd7b 107 /** Pointer to the surface used as future reference
ad0405fc
IK
108 - application - unchanged
109 - libavcodec - set
110 */
111 XvMCSurface* p_future_surface;
7fade368 112
ad0405fc
IK
113 /** top/bottom field or frame
114 - application - unchanged
115 - libavcodec - set
116 */
117 unsigned int picture_structure;
118
058bcd7b 119 /** XVMC_SECOND_FIELD - 1st or 2nd field in the sequence
ad0405fc
IK
120 - application - unchanged
121 - libavcodec - set
122 */
123 unsigned int flags;
6785e509 124//}@
7fade368 125
ad0405fc 126 /** Offset in the mv array for the current slice.
037f13fe
DB
127 Macroblocks described before that offset are assumed to have already
128 been passed to the hardware.
2f953883 129 - application - zeroes it on get_buffer().
8f66518d 130 A successful ff_draw_horiz_band() may increment it
72d38a74
IK
131 with filled_mb_block_num or zero both.
132 - libavcodec - unchanged
133 */
134 int start_mv_blocks_num;
135
ad0405fc 136 /** Number of mv blocks that are filled by libavcodec and have to be passed to the hardware.
2f953883 137 - application - zeroes it on get_buffer() or after successful ff_draw_horiz_band()
72d38a74
IK
138 - libavcodec - increment with one of each stored MB
139 */
140 int filled_mv_blocks_num;
141
058bcd7b 142 /** Offset to the next free data block. The mv_blocks hold a number pointing to the data blocks.
8f66518d 143 - application - zeroes it on get_buffer() and after successful ff_draw_horiz_band()
72d38a74
IK
144 - libvcodec - each macroblock increases it with the number of coded blocks in it.
145 */
146 int next_free_data_block_num;
115329f1 147
05c363e9 148/** extensions may be placed here */
3bffe5fc 149#if LIBAVCODEC_VERSION_MAJOR < 53
6785e509 150//@{
1909fade
DB
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.
72d38a74
IK
155 */
156 int state;
1909fade 157 void* p_osd_target_surface_render; ///< pointer to the surface where the subpicture is rendered
6785e509 158//}@
3bffe5fc 159#endif
c96da3ed 160};
699b3f99 161
af28efa2 162#endif /* AVCODEC_XVMC_H */