spelling/grammar/wording fixes for Doxygen comments
[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
e98b4755
DB
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) */
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//@{
1909fade 41 int xvmc_id; ///< used as a check against memory corruption by regular pixel routines or other API structures
7fade368 42
6b6ea1df
DB
43 short* data_blocks;
44 XvMCMacroBlock* mv_blocks;
45 int total_number_of_mv_blocks;
46 int total_number_of_data_blocks;
c1a5aa29 47 int idct; ///< indicate that IDCT acceleration level is used
c1a5aa29
DB
48 int unsigned_intra; ///< +-128 for intra pictures after clipping
49 XvMCSurface* p_surface; ///< pointer to rendered surface, never changed
6785e509 50//}@
7fade368 51
1909fade
DB
52/** Set by the decoder before calling draw_horiz_band(),
53 needed by the XvMCRenderSurface function. */
6785e509 54//@{
c1a5aa29
DB
55 XvMCSurface* p_past_surface; ///< pointer to the past surface
56 XvMCSurface* p_future_surface; ///< pointer to the future prediction surface
7fade368 57
3fff9d92 58 unsigned int picture_structure; ///< top/bottom field or frame
c1a5aa29 59 unsigned int flags; ///< XVMC_SECOND_FIELD - 1st or 2nd field in the sequence
6785e509 60//}@
7fade368 61
72d38a74 62 /** Offset in the mv array for the current slice:
3fff9d92 63 - application - zeros it on get_buffer().
1909fade 64 A successful draw_horiz_band() may increment it
72d38a74
IK
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
3fff9d92 76 /** Offset to the next free data block. The mv_blocks hold number pointing to the data blocks.
72d38a74
IK
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;
115329f1 81
05c363e9 82/** extensions may be placed here */
3bffe5fc 83#if LIBAVCODEC_VERSION_MAJOR < 53
6785e509 84//@{
1909fade
DB
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.
72d38a74
IK
89 */
90 int state;
1909fade 91 void* p_osd_target_surface_render; ///< pointer to the surface where the subpicture is rendered
6785e509 92//}@
3bffe5fc 93#endif
c96da3ed 94};
699b3f99 95
af28efa2 96#endif /* AVCODEC_XVMC_H */