comparison xvmc.h @ 8913:c9d7846799ac libavcodec

A little better wording of doxygen comments.
author iive
date Sun, 15 Feb 2009 08:29:06 +0000
parents a11771712f48
children 20da0a97b95f
comparison
equal deleted inserted replaced
8912:63e989c76ed2 8913:c9d7846799ac
29 #define AV_XVMC_STATE_DISPLAY_PENDING 1 /** the surface should be shown, the video driver manipulates this */ 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 */ 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 /** this surface is needed for subpicture rendering */ 31 #define AV_XVMC_STATE_OSD_SOURCE 4 /** this surface is needed for subpicture rendering */
32 #endif 32 #endif
33 #define AV_XVMC_RENDER_MAGIC 0x1DC711C0 /**< magic value to ensure that regular pixel routines haven't corrupted the struct */ 33 #define AV_XVMC_RENDER_MAGIC 0x1DC711C0 /**< magic value to ensure that regular pixel routines haven't corrupted the struct */
34 // 1337 IDCT MCo 34 // 1337 IDCT MCo
35 35
36 struct xvmc_render_state { 36 struct xvmc_render_state {
37 /** set by calling application */ 37 /** Set by calling application
38 Once set these values are not supposed to be modified.
39 */
38 //@{ 40 //@{
39 int magic_id; ///< used as a check against memory corruption by regular pixel routines or other API structure 41 int magic_id; ///< used as a check against memory corruption by regular pixel routines or other API structure
40 42
41 short* data_blocks; 43 short* data_blocks;
42 XvMCMacroBlock* mv_blocks; 44 XvMCMacroBlock* mv_blocks;
45 int idct; ///< indicate that IDCT acceleration level is used 47 int idct; ///< indicate that IDCT acceleration level is used
46 int unsigned_intra; ///< +-128 for intra pictures after clipping 48 int unsigned_intra; ///< +-128 for intra pictures after clipping
47 XvMCSurface* p_surface; ///< pointer to rendered surface, never changed 49 XvMCSurface* p_surface; ///< pointer to rendered surface, never changed
48 //}@ 50 //}@
49 51
50 /** set by the decoder 52 /** Set by the decoder before calling draw_horiz_band()
51 used by the XvMCRenderSurface function */ 53 need by the XvMCRenderSurface function */
52 //@{ 54 //@{
53 XvMCSurface* p_past_surface; ///< pointer to the past surface 55 XvMCSurface* p_past_surface; ///< pointer to the past surface
54 XvMCSurface* p_future_surface; ///< pointer to the future prediction surface 56 XvMCSurface* p_future_surface; ///< pointer to the future prediction surface
55 57
56 unsigned int picture_structure; ///< top/bottom fields or frame 58 unsigned int picture_structure; ///< top/bottom field or frame
57 unsigned int flags; ///< XVMC_SECOND_FIELD - 1st or 2nd field in the sequence 59 unsigned int flags; ///< XVMC_SECOND_FIELD - 1st or 2nd field in the sequence
58 //}@ 60 //}@
59 61
60 /** Offset in the mv array for the current slice: 62 /** Offset in the mv array for the current slice:
61 - application - zeros it on get_buffer(). 63 - application - zeros it on get_buffer().
62 successful draw_horiz_band() may increment it 64 successful draw_horiz_band() may increment it
63 with filled_mb_block_num or zero both. 65 with filled_mb_block_num or zero both.
64 - libavcodec - unchanged 66 - libavcodec - unchanged
65 */ 67 */
66 int start_mv_blocks_num; 68 int start_mv_blocks_num;
69 - application - zeros it on get_buffer() or after successful draw_horiz_band() 71 - application - zeros it on get_buffer() or after successful draw_horiz_band()
70 - libavcodec - increment with one of each stored MB 72 - libavcodec - increment with one of each stored MB
71 */ 73 */
72 int filled_mv_blocks_num; 74 int filled_mv_blocks_num;
73 75
74 /** Used in add_mv_block, pointer to next free block 76 /** Offset to the next free data block. The mv_blocks hold number pointing to the data blocks.
75 - application - zeroes it on get_buffer() and after successful draw_horiz_band() 77 - application - zeroes it on get_buffer() and after successful draw_horiz_band()
76 - libvcodec - each macroblock increases it with the number of coded blocks in it. 78 - libvcodec - each macroblock increases it with the number of coded blocks in it.
77 */ 79 */
78 int next_free_data_block_num; 80 int next_free_data_block_num;
79 81
80 /** extensions may be placed here */ 82 /** extensions may be placed here */
81 #if LIBAVCODEC_VERSION_MAJOR < 53 83 #if LIBAVCODEC_VERSION_MAJOR < 53
82 //@{ 84 //@{
83 /** State - used to workaround limitations in MPlayer vo system. 85 /** State - used to workaround limitations in MPlayer video system.
84 0 -Surface not used 86 0 - Surface not used
85 1 -Surface is still hold in application to be displayed or is still visible. 87 1 - Surface is still hold in application to be displayed or is still visible.
86 2 -Surface is still hold in lavcodec buffer for prediction 88 2 - Surface is still hold in libavcodec buffer for prediction
87 */ 89 */
88 int state; 90 int state;
89 void* p_osd_target_surface_render; ///< pointer to the surface where subpicture is rendered 91 void* p_osd_target_surface_render; ///< pointer to the surface where subpicture is rendered
90 //}@ 92 //}@
91 #endif 93 #endif