Mercurial > libavcodec.hg
annotate xvmc.h @ 8938:5a212db68a2f libavcodec
Doxygen spelling/wording fixes
author | diego |
---|---|
date | Sun, 15 Feb 2009 23:55:34 +0000 |
parents | 1b7db71c192d |
children | 752780e31cb6 |
rev | line source |
---|---|
8808
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
1 /* |
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
2 * Copyright (C) 2003 Ivan Kalvachev |
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
3 * |
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
4 * This file is part of FFmpeg. |
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
5 * |
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
6 * FFmpeg is free software; you can redistribute it and/or |
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
7 * modify it under the terms of the GNU Lesser General Public |
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
8 * License as published by the Free Software Foundation; either |
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
9 * version 2.1 of the License, or (at your option) any later version. |
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
10 * |
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
11 * FFmpeg is distributed in the hope that it will be useful, |
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of |
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
14 * Lesser General Public License for more details. |
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
15 * |
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
16 * You should have received a copy of the GNU Lesser General Public |
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
17 * License along with FFmpeg; if not, write to the Free Software |
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
19 */ |
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
20 |
8843 | 21 #ifndef AVCODEC_XVMC_H |
22 #define AVCODEC_XVMC_H | |
8808
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
23 |
8851
a8fdc730936d
Replace useless X11 #includes by the one that actually provides the required
diego
parents:
8850
diff
changeset
|
24 #include <X11/extensions/XvMC.h> |
8808
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
25 |
8899
856ed45c4cfa
Add avcodec.h #include so that LIBAVCODEC_VERSION_MAJOR is not undefined.
diego
parents:
8898
diff
changeset
|
26 #include "avcodec.h" |
856ed45c4cfa
Add avcodec.h #include so that LIBAVCODEC_VERSION_MAJOR is not undefined.
diego
parents:
8898
diff
changeset
|
27 |
8908
ac0ad123e3f0
Remove obsolete display_flags member from xvmc struct
iive
parents:
8907
diff
changeset
|
28 #if LIBAVCODEC_VERSION_MAJOR < 53 |
8854 | 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 */ | |
8929 | 31 #define AV_XVMC_STATE_OSD_SOURCE 4 /** the surface is needed for subpicture rendering */ |
8908
ac0ad123e3f0
Remove obsolete display_flags member from xvmc struct
iive
parents:
8907
diff
changeset
|
32 #endif |
8934
a613cd6b6071
Rename AV_XVMC_RENDER_MAGIC constant to AV_XVMC_ID to reflect a similar
diego
parents:
8931
diff
changeset
|
33 #define AV_XVMC_ID 0x1DC711C0 /**< special value to ensure that regular pixel routines haven't corrupted the struct |
8928
ef4e7c8e322a
Explain how AV_XVMC_RENDER_MAGIC got its seemingly arbitrary value.
diego
parents:
8927
diff
changeset
|
34 the number is 1337 speak for the letters IDCT MCo (motion compensation) */ |
8846 | 35 |
8925
23051e3e9d25
Rename xvmc_pixfmt_render structure to xvmc_pix_fmt.
diego
parents:
8924
diff
changeset
|
36 struct xvmc_pix_fmt { |
8929 | 37 /** Set by the calling application. |
8913 | 38 Once set these values are not supposed to be modified. |
39 */ | |
8852 | 40 //@{ |
8935
c1ee9b462f9e
spelling/grammar/wording/whitespace for Doxygen comments
diego
parents:
8934
diff
changeset
|
41 /** The field contains the special constant value AV_XVMC_ID. |
8937 | 42 It is used as a test that the application correctly uses the API, |
8931 | 43 and that there is no corruption caused by pixel routines. |
44 - application - set during initialization | |
45 - libavcodec - unchanged | |
46 */ | |
47 int xvmc_id; | |
8808
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
48 |
8931 | 49 /** Pointer to the block array allocated by XvMCCreateBlocks() |
8938 | 50 it contains differential pixel data (in MoCo mode) |
8931 | 51 or coefficients for IDCT. |
52 - application - set during initialization | |
53 - libavcodec - unchanged | |
54 */ | |
8850 | 55 short* data_blocks; |
8931 | 56 |
57 /** Pointer to the macroblock description array allocated by XvMCCreateMacroBlocks(). | |
58 - application - set during initialization | |
59 - libavcodec - unchanged | |
60 */ | |
8850 | 61 XvMCMacroBlock* mv_blocks; |
8931 | 62 |
8938 | 63 /** Number of macroblock descriptions that can be stored in the mv_blocks |
64 array. | |
8931 | 65 - application - set during initialization |
66 - libavcodec - unchanged | |
67 */ | |
8850 | 68 int total_number_of_mv_blocks; |
8931 | 69 |
8938 | 70 /** Number of blocks that can be stored at once in the data_blocks array. |
8931 | 71 - application - set during initialization |
72 - libavcodec - unchanged | |
73 */ | |
8850 | 74 int total_number_of_data_blocks; |
8931 | 75 |
8935
c1ee9b462f9e
spelling/grammar/wording/whitespace for Doxygen comments
diego
parents:
8934
diff
changeset
|
76 /** Indicates that the hardware would interpret data_blocks as IDCT coefficients |
8931 | 77 and perform IDCT on them. |
78 - application - set during initialization | |
79 - libavcodec - unchanged | |
80 */ | |
81 int idct; | |
82 | |
8938 | 83 /** In MoCo mode it indicates that intra macroblocks are assumed to be in |
84 unsigned format; same as the XVMC_INTRA_UNSIGNED flag. | |
8931 | 85 - application - set during initialization |
86 - libavcodec - unchanged | |
87 */ | |
88 int unsigned_intra; | |
89 | |
8935
c1ee9b462f9e
spelling/grammar/wording/whitespace for Doxygen comments
diego
parents:
8934
diff
changeset
|
90 /** Pointer to the surface allocated by XvMCCreateSurface(). |
8938 | 91 It identifies the frame and its state on the video hardware. |
8931 | 92 - application - set during initialization |
93 - libavcodec - unchanged | |
94 */ | |
95 XvMCSurface* p_surface; | |
8852 | 96 //}@ |
8808
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
97 |
8936 | 98 /** Set by the decoder before calling ff_draw_horiz_band(), |
8929 | 99 needed by the XvMCRenderSurface function. */ |
8852 | 100 //@{ |
8931 | 101 /** Pointer to the surface used as past reference |
102 - application - unchanged | |
103 - libavcodec - set | |
104 */ | |
105 XvMCSurface* p_past_surface; | |
106 | |
8935
c1ee9b462f9e
spelling/grammar/wording/whitespace for Doxygen comments
diego
parents:
8934
diff
changeset
|
107 /** Pointer to the surface used as future reference |
8931 | 108 - application - unchanged |
109 - libavcodec - set | |
110 */ | |
111 XvMCSurface* p_future_surface; | |
8808
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
112 |
8931 | 113 /** top/bottom field or frame |
114 - application - unchanged | |
115 - libavcodec - set | |
116 */ | |
117 unsigned int picture_structure; | |
118 | |
8935
c1ee9b462f9e
spelling/grammar/wording/whitespace for Doxygen comments
diego
parents:
8934
diff
changeset
|
119 /** XVMC_SECOND_FIELD - 1st or 2nd field in the sequence |
8931 | 120 - application - unchanged |
121 - libavcodec - set | |
122 */ | |
123 unsigned int flags; | |
8852 | 124 //}@ |
8808
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
125 |
8931 | 126 /** Offset in the mv array for the current slice. |
8938 | 127 Macroblocks described before that offset are assumed to have already |
128 been passed to the hardware. | |
8937 | 129 - application - zeroes it on get_buffer(). |
8936 | 130 A successful ff_draw_horiz_band() may increment it |
8907
c9e8aed08d17
Detailed description of the interesting fields in xvmc struct.
iive
parents:
8906
diff
changeset
|
131 with filled_mb_block_num or zero both. |
c9e8aed08d17
Detailed description of the interesting fields in xvmc struct.
iive
parents:
8906
diff
changeset
|
132 - libavcodec - unchanged |
c9e8aed08d17
Detailed description of the interesting fields in xvmc struct.
iive
parents:
8906
diff
changeset
|
133 */ |
c9e8aed08d17
Detailed description of the interesting fields in xvmc struct.
iive
parents:
8906
diff
changeset
|
134 int start_mv_blocks_num; |
8808
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
135 |
8931 | 136 /** Number of mv blocks that are filled by libavcodec and have to be passed to the hardware. |
8937 | 137 - application - zeroes it on get_buffer() or after successful ff_draw_horiz_band() |
8907
c9e8aed08d17
Detailed description of the interesting fields in xvmc struct.
iive
parents:
8906
diff
changeset
|
138 - libavcodec - increment with one of each stored MB |
c9e8aed08d17
Detailed description of the interesting fields in xvmc struct.
iive
parents:
8906
diff
changeset
|
139 */ |
c9e8aed08d17
Detailed description of the interesting fields in xvmc struct.
iive
parents:
8906
diff
changeset
|
140 int filled_mv_blocks_num; |
c9e8aed08d17
Detailed description of the interesting fields in xvmc struct.
iive
parents:
8906
diff
changeset
|
141 |
8935
c1ee9b462f9e
spelling/grammar/wording/whitespace for Doxygen comments
diego
parents:
8934
diff
changeset
|
142 /** Offset to the next free data block. The mv_blocks hold a number pointing to the data blocks. |
8936 | 143 - application - zeroes it on get_buffer() and after successful ff_draw_horiz_band() |
8907
c9e8aed08d17
Detailed description of the interesting fields in xvmc struct.
iive
parents:
8906
diff
changeset
|
144 - libvcodec - each macroblock increases it with the number of coded blocks in it. |
c9e8aed08d17
Detailed description of the interesting fields in xvmc struct.
iive
parents:
8906
diff
changeset
|
145 */ |
c9e8aed08d17
Detailed description of the interesting fields in xvmc struct.
iive
parents:
8906
diff
changeset
|
146 int next_free_data_block_num; |
c9e8aed08d17
Detailed description of the interesting fields in xvmc struct.
iive
parents:
8906
diff
changeset
|
147 |
8900 | 148 /** extensions may be placed here */ |
8898 | 149 #if LIBAVCODEC_VERSION_MAJOR < 53 |
8852 | 150 //@{ |
8929 | 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. | |
8907
c9e8aed08d17
Detailed description of the interesting fields in xvmc struct.
iive
parents:
8906
diff
changeset
|
155 */ |
c9e8aed08d17
Detailed description of the interesting fields in xvmc struct.
iive
parents:
8906
diff
changeset
|
156 int state; |
8929 | 157 void* p_osd_target_surface_render; ///< pointer to the surface where the subpicture is rendered |
8852 | 158 //}@ |
8898 | 159 #endif |
8808
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
160 }; |
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
161 |
8843 | 162 #endif /* AVCODEC_XVMC_H */ |