Mercurial > libavcodec.hg
annotate xvmc.h @ 8943:c1fd3c6a8533 libavcodec
Doxygen comment wording fix
author | diego |
---|---|
date | Mon, 16 Feb 2009 01:59:51 +0000 |
parents | 42a048ecbba3 |
children | 3fb542a23731 |
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 |
8939
752780e31cb6
cosmetics: Keep lines below 80 characters where sensibly possible.
diego
parents:
8938
diff
changeset
|
57 /** Pointer to the macroblock description array allocated by |
752780e31cb6
cosmetics: Keep lines below 80 characters where sensibly possible.
diego
parents:
8938
diff
changeset
|
58 XvMCCreateMacroBlocks(). |
8931 | 59 - application - set during initialization |
60 - libavcodec - unchanged | |
61 */ | |
8850 | 62 XvMCMacroBlock* mv_blocks; |
8931 | 63 |
8938 | 64 /** Number of macroblock descriptions that can be stored in the mv_blocks |
65 array. | |
8931 | 66 - application - set during initialization |
67 - libavcodec - unchanged | |
68 */ | |
8941 | 69 int allocated_mv_blocks; |
8931 | 70 |
8938 | 71 /** Number of blocks that can be stored at once in the data_blocks array. |
8931 | 72 - application - set during initialization |
73 - libavcodec - unchanged | |
74 */ | |
8941 | 75 int allocated_data_blocks; |
8931 | 76 |
8939
752780e31cb6
cosmetics: Keep lines below 80 characters where sensibly possible.
diego
parents:
8938
diff
changeset
|
77 /** Indicates that the hardware would interpret data_blocks as IDCT |
752780e31cb6
cosmetics: Keep lines below 80 characters where sensibly possible.
diego
parents:
8938
diff
changeset
|
78 coefficients and perform IDCT on them. |
8931 | 79 - application - set during initialization |
80 - libavcodec - unchanged | |
81 */ | |
82 int idct; | |
83 | |
8938 | 84 /** In MoCo mode it indicates that intra macroblocks are assumed to be in |
85 unsigned format; same as the XVMC_INTRA_UNSIGNED flag. | |
8931 | 86 - application - set during initialization |
87 - libavcodec - unchanged | |
88 */ | |
89 int unsigned_intra; | |
90 | |
8935
c1ee9b462f9e
spelling/grammar/wording/whitespace for Doxygen comments
diego
parents:
8934
diff
changeset
|
91 /** Pointer to the surface allocated by XvMCCreateSurface(). |
8938 | 92 It identifies the frame and its state on the video hardware. |
8931 | 93 - application - set during initialization |
94 - libavcodec - unchanged | |
95 */ | |
96 XvMCSurface* p_surface; | |
8852 | 97 //}@ |
8808
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
98 |
8936 | 99 /** Set by the decoder before calling ff_draw_horiz_band(), |
8929 | 100 needed by the XvMCRenderSurface function. */ |
8852 | 101 //@{ |
8931 | 102 /** Pointer to the surface used as past reference |
103 - application - unchanged | |
104 - libavcodec - set | |
105 */ | |
106 XvMCSurface* p_past_surface; | |
107 | |
8935
c1ee9b462f9e
spelling/grammar/wording/whitespace for Doxygen comments
diego
parents:
8934
diff
changeset
|
108 /** Pointer to the surface used as future reference |
8931 | 109 - application - unchanged |
110 - libavcodec - set | |
111 */ | |
112 XvMCSurface* p_future_surface; | |
8808
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
113 |
8931 | 114 /** top/bottom field or frame |
115 - application - unchanged | |
116 - libavcodec - set | |
117 */ | |
118 unsigned int picture_structure; | |
119 | |
8935
c1ee9b462f9e
spelling/grammar/wording/whitespace for Doxygen comments
diego
parents:
8934
diff
changeset
|
120 /** XVMC_SECOND_FIELD - 1st or 2nd field in the sequence |
8931 | 121 - application - unchanged |
122 - libavcodec - set | |
123 */ | |
124 unsigned int flags; | |
8852 | 125 //}@ |
8808
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
126 |
8931 | 127 /** Offset in the mv array for the current slice. |
8938 | 128 Macroblocks described before that offset are assumed to have already |
129 been passed to the hardware. | |
8937 | 130 - application - zeroes it on get_buffer(). |
8936 | 131 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
|
132 with filled_mb_block_num or zero both. |
c9e8aed08d17
Detailed description of the interesting fields in xvmc struct.
iive
parents:
8906
diff
changeset
|
133 - libavcodec - unchanged |
c9e8aed08d17
Detailed description of the interesting fields in xvmc struct.
iive
parents:
8906
diff
changeset
|
134 */ |
c9e8aed08d17
Detailed description of the interesting fields in xvmc struct.
iive
parents:
8906
diff
changeset
|
135 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
|
136 |
8939
752780e31cb6
cosmetics: Keep lines below 80 characters where sensibly possible.
diego
parents:
8938
diff
changeset
|
137 /** Number of mv blocks that are filled by libavcodec and have to be |
752780e31cb6
cosmetics: Keep lines below 80 characters where sensibly possible.
diego
parents:
8938
diff
changeset
|
138 passed to the hardware. |
752780e31cb6
cosmetics: Keep lines below 80 characters where sensibly possible.
diego
parents:
8938
diff
changeset
|
139 - application - zeroes it on get_buffer() or after successful |
752780e31cb6
cosmetics: Keep lines below 80 characters where sensibly possible.
diego
parents:
8938
diff
changeset
|
140 ff_draw_horiz_band(). |
8907
c9e8aed08d17
Detailed description of the interesting fields in xvmc struct.
iive
parents:
8906
diff
changeset
|
141 - libavcodec - increment with one of each stored MB |
c9e8aed08d17
Detailed description of the interesting fields in xvmc struct.
iive
parents:
8906
diff
changeset
|
142 */ |
c9e8aed08d17
Detailed description of the interesting fields in xvmc struct.
iive
parents:
8906
diff
changeset
|
143 int filled_mv_blocks_num; |
c9e8aed08d17
Detailed description of the interesting fields in xvmc struct.
iive
parents:
8906
diff
changeset
|
144 |
8943 | 145 /** Offset to the next free data block. The mv_blocks field holds a number |
8939
752780e31cb6
cosmetics: Keep lines below 80 characters where sensibly possible.
diego
parents:
8938
diff
changeset
|
146 pointing to the data blocks. |
752780e31cb6
cosmetics: Keep lines below 80 characters where sensibly possible.
diego
parents:
8938
diff
changeset
|
147 - application - zeroes it on get_buffer() and after successful |
752780e31cb6
cosmetics: Keep lines below 80 characters where sensibly possible.
diego
parents:
8938
diff
changeset
|
148 ff_draw_horiz_band(). |
752780e31cb6
cosmetics: Keep lines below 80 characters where sensibly possible.
diego
parents:
8938
diff
changeset
|
149 - libavcodec - each macroblock increases it with the number |
8940 | 150 of coded blocks it contains. |
8907
c9e8aed08d17
Detailed description of the interesting fields in xvmc struct.
iive
parents:
8906
diff
changeset
|
151 */ |
c9e8aed08d17
Detailed description of the interesting fields in xvmc struct.
iive
parents:
8906
diff
changeset
|
152 int next_free_data_block_num; |
c9e8aed08d17
Detailed description of the interesting fields in xvmc struct.
iive
parents:
8906
diff
changeset
|
153 |
8900 | 154 /** extensions may be placed here */ |
8898 | 155 #if LIBAVCODEC_VERSION_MAJOR < 53 |
8852 | 156 //@{ |
8929 | 157 /** State - used to work around limitations in the MPlayer video system. |
158 0 - Surface is not used. | |
8939
752780e31cb6
cosmetics: Keep lines below 80 characters where sensibly possible.
diego
parents:
8938
diff
changeset
|
159 1 - Surface is still held in application to be displayed or is |
752780e31cb6
cosmetics: Keep lines below 80 characters where sensibly possible.
diego
parents:
8938
diff
changeset
|
160 still visible. |
8929 | 161 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
|
162 */ |
c9e8aed08d17
Detailed description of the interesting fields in xvmc struct.
iive
parents:
8906
diff
changeset
|
163 int state; |
8939
752780e31cb6
cosmetics: Keep lines below 80 characters where sensibly possible.
diego
parents:
8938
diff
changeset
|
164 |
752780e31cb6
cosmetics: Keep lines below 80 characters where sensibly possible.
diego
parents:
8938
diff
changeset
|
165 /** pointer to the surface where the subpicture is rendered */ |
752780e31cb6
cosmetics: Keep lines below 80 characters where sensibly possible.
diego
parents:
8938
diff
changeset
|
166 void* p_osd_target_surface_render; |
8852 | 167 //}@ |
8898 | 168 #endif |
8808
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
169 }; |
36f2dabd58c9
Rename xvmc_render.h --> xvmc_pixfmt.h and vdpau.h --> vdpau_pixfmt.h as
diego
parents:
diff
changeset
|
170 |
8843 | 171 #endif /* AVCODEC_XVMC_H */ |