Fix non-Doxygen comment.
[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/Xlib.h>
25 #include <X11/Xutil.h>
26 #include <X11/Xatom.h>
27 #include <X11/extensions/Xv.h>
28 #include <X11/extensions/Xvlib.h>
29 #include <X11/extensions/XvMClib.h>
30
31 #include "avcodec.h"
32
33 //the surface should be shown, the video driver manipulates this
34 #define AV_XVMC_STATE_DISPLAY_PENDING 1
35 //the surface is needed for prediction, the codec manipulates this
36 #define AV_XVMC_STATE_PREDICTION      2
37 //this surface is needed for subpicture rendering
38 #define AV_XVMC_STATE_OSD_SOURCE      4
39 //                              1337    IDCT MCo
40 #define AV_XVMC_RENDER_MAGIC          0x1DC711C0
41
42 #if LIBAVCODEC_VERSION_MAJOR < 53
43 #define MP_XVMC_STATE_DISPLAY_PENDING AV_XVMC_STATE_DISPLAY_PENDING
44 #define MP_XVMC_STATE_PREDICTION      AV_XVMC_STATE_PREDICTION
45 #define MP_XVMC_STATE_OSD_SOURCE      AV_XVMC_STATE_OSD_SOURCE
46 #define MP_XVMC_RENDER_MAGIC          AV_XVMC_RENDER_MAGIC
47 #endif
48
49 struct xvmc_render_state {
50     //these are not changed by the decoder!
51     int  magic; ///< used as check for memory corruption by regular pixel routines
52
53     short * data_blocks;
54     XvMCMacroBlock * mv_blocks;
55     int total_number_of_mv_blocks;
56     int total_number_of_data_blocks;
57     int mc_type;            //XVMC_MPEG1/2/4,XVMC_H263 without XVMC_IDCT
58     int idct;               ///< indicate that IDCT acceleration level is used
59     int chroma_format;      ///< XVMC_CHROMA_FORMAT_420/422/444
60     int unsigned_intra;     //+-128 for intra pictures after clipping
61     XvMCSurface* p_surface; //pointer to rendered surface, never changed
62
63     //these are changed by the decoder
64     //used by the XvMCRenderSurface function
65     XvMCSurface* p_past_surface;    //pointer to the past surface
66     XvMCSurface* p_future_surface;  //pointer to the future prediction surface
67
68     unsigned int picture_structure; //top/bottom fields or frame!
69     unsigned int flags;             //XVMC_SECOND_FIELD - 1st or 2nd field in the sequence
70     unsigned int display_flags;     //1,2 or 1+2 fields for XvMCPutSurface
71
72     //these are for internal communication
73     int state;                      //0 - free, 1 - waiting to display, 2 - waiting for prediction
74     int start_mv_blocks_num;        //offset in the array for the current slice, updated by vo
75     int filled_mv_blocks_num;       //processed mv block in this slice, changed by decoder
76
77     int next_free_data_block_num;   //used in add_mv_block, pointer to next free block
78     //extensions
79     void * p_osd_target_surface_render; //pointer to the surface where subpicture is rendered
80
81 };
82
83 #endif /* AVCODEC_XVMC_H */