comparison xvmc.h @ 8852:ff1b704b1f8f libavcodec

doxygen style comments
author iive
date Sat, 14 Feb 2009 17:56:51 +0000
parents a8fdc730936d
children b0292c878f9d
comparison
equal deleted inserted replaced
8851:a8fdc730936d 8852:ff1b704b1f8f
23 23
24 #include <X11/extensions/XvMC.h> 24 #include <X11/extensions/XvMC.h>
25 25
26 #include "avcodec.h" 26 #include "avcodec.h"
27 27
28 #define AV_XVMC_STATE_DISPLAY_PENDING 1 // the surface should be shown, the video driver manipulates this 28 /**the surface should be shown, the video driver manipulates this*/
29 #define AV_XVMC_STATE_PREDICTION 2 // the surface is needed for prediction, the codec manipulates this 29 #define AV_XVMC_STATE_DISPLAY_PENDING 1
30 #define AV_XVMC_STATE_OSD_SOURCE 4 // this surface is needed for subpicture rendering 30 /**the surface is needed for prediction, the codec manipulates this*/
31 #define AV_XVMC_RENDER_MAGIC 0x1DC711C0 // 1337 IDCT MCo 31 #define AV_XVMC_STATE_PREDICTION 2
32 /**this surface is needed for subpicture rendering*/
33 #define AV_XVMC_STATE_OSD_SOURCE 4
34 /**<magic value to ensure that regular pixel routines haven't corrupted the struct*/
35 // 1337 IDCT MCo
36 #define AV_XVMC_RENDER_MAGIC 0x1DC711C0
32 37
33 #if LIBAVCODEC_VERSION_MAJOR < 53 38 #if LIBAVCODEC_VERSION_MAJOR < 53
34 #define MP_XVMC_STATE_DISPLAY_PENDING AV_XVMC_STATE_DISPLAY_PENDING 39 #define MP_XVMC_STATE_DISPLAY_PENDING AV_XVMC_STATE_DISPLAY_PENDING
35 #define MP_XVMC_STATE_PREDICTION AV_XVMC_STATE_PREDICTION 40 #define MP_XVMC_STATE_PREDICTION AV_XVMC_STATE_PREDICTION
36 #define MP_XVMC_STATE_OSD_SOURCE AV_XVMC_STATE_OSD_SOURCE 41 #define MP_XVMC_STATE_OSD_SOURCE AV_XVMC_STATE_OSD_SOURCE
37 #define MP_XVMC_RENDER_MAGIC AV_XVMC_RENDER_MAGIC 42 #define MP_XVMC_RENDER_MAGIC AV_XVMC_RENDER_MAGIC
38 #endif 43 #endif
39 44
40 struct xvmc_render_state { 45 struct xvmc_render_state {
41 //these are not changed by the decoder! 46 /** these are not changed by the decoder! */
42 int magic; ///< used as check for memory corruption by regular pixel routines 47 //@{
48 int magic; ///< used as check for memory corruption by regular pixel routines
43 49
44 short* data_blocks; 50 short* data_blocks;
45 XvMCMacroBlock* mv_blocks; 51 XvMCMacroBlock* mv_blocks;
46 int total_number_of_mv_blocks; 52 int total_number_of_mv_blocks;
47 int total_number_of_data_blocks; 53 int total_number_of_data_blocks;
48 int mc_type; // XVMC_MPEG1/2/4,XVMC_H263 without XVMC_IDCT 54 int mc_type; ///<XVMC_MPEG1/2/4,XVMC_H263 without XVMC_IDCT
49 int idct; ///< indicate that IDCT acceleration level is used 55 int idct; ///< indicate that IDCT acceleration level is used
50 int chroma_format; ///< XVMC_CHROMA_FORMAT_420/422/444 56 int chroma_format; ///< XVMC_CHROMA_FORMAT_420/422/444
51 int unsigned_intra; // +-128 for intra pictures after clipping 57 int unsigned_intra; ///<+-128 for intra pictures after clipping
52 XvMCSurface* p_surface; // pointer to rendered surface, never changed 58 XvMCSurface* p_surface; ///<pointer to rendered surface, never changed
59 //}@
53 60
54 //these are changed by the decoder 61 /** these are changed by the decoder
55 //used by the XvMCRenderSurface function 62 //used by the XvMCRenderSurface function */
56 XvMCSurface* p_past_surface; // pointer to the past surface 63 //@{
57 XvMCSurface* p_future_surface; // pointer to the future prediction surface 64 XvMCSurface* p_past_surface; ///<pointer to the past surface
65 XvMCSurface* p_future_surface; ///<pointer to the future prediction surface
58 66
59 unsigned int picture_structure; // top/bottom fields or frame! 67 unsigned int picture_structure; ///<top/bottom fields or frame!
60 unsigned int flags; // XVMC_SECOND_FIELD - 1st or 2nd field in the sequence 68 unsigned int flags; ///<XVMC_SECOND_FIELD - 1st or 2nd field in the sequence
61 unsigned int display_flags; // 1,2 or 1+2 fields for XvMCPutSurface 69 unsigned int display_flags; ///<1,2 or 1+2 fields for XvMCPutSurface
70 //}@
62 71
63 //these are for internal communication 72 /** these are for internal communication */
64 int state; // 0 - free, 1 - waiting to display, 2 - waiting for prediction 73 //@{
65 int start_mv_blocks_num; // offset in the array for the current slice, updated by vo 74 int state; ///<0 - free, 1 - waiting to display, 2 - waiting for prediction
66 int filled_mv_blocks_num; // processed mv block in this slice, changed by decoder 75 int start_mv_blocks_num; ///<offset in the array for the current slice, updated by vo
76 int filled_mv_blocks_num; ///<processed mv block in this slice, changed by decoder
67 77
68 int next_free_data_block_num; // used in add_mv_block, pointer to next free block 78 int next_free_data_block_num; ///<used in add_mv_block, pointer to next free block
69 //extensions 79 //}@
70 void* p_osd_target_surface_render; // pointer to the surface where subpicture is rendered 80 /**extensions*/
81 //@{
82 void * p_osd_target_surface_render; ///<pointer to the surface where subpicture is rendered
83 //}@
71 84
72 }; 85 };
73 86
74 #endif /* AVCODEC_XVMC_H */ 87 #endif /* AVCODEC_XVMC_H */