1 /*****************************************************************************
2 * video.h: common video definitions
3 * This header is required by all modules which have to handle pictures. It
4 * includes all common video types and constants.
5 *****************************************************************************
6 * Copyright (C) 1999, 2000 VideoLAN
7 * $Id: video.h,v 1.53 2002/06/01 12:31:58 sam Exp $
9 * Authors: Vincent Seguin <seguin@via.ecp.fr>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
24 *****************************************************************************/
26 /*****************************************************************************
27 * plane_t: description of a planar graphic field
28 *****************************************************************************/
29 typedef struct plane_s
31 u8 *p_pixels; /* Start of the plane's data */
33 /* Variables used for fast memcpy operations */
34 int i_lines; /* Number of lines */
35 int i_pitch; /* Number of bytes in a line, including margins */
37 /* Size of a macropixel, defaults to 1 */
40 /* Is there a margin ? defaults to no */
43 /* Variables used for pictures with margins */
44 int i_visible_bytes; /* How many real pixels are there ? */
45 vlc_bool_t b_hidden; /* Are we allowed to write to the margin ? */
49 /*****************************************************************************
50 * picture_t: video picture
51 *****************************************************************************
52 * Any picture destined to be displayed by a video output thread should be
53 * stored in this structure from it's creation to it's effective display.
54 * Picture type and flags should only be modified by the output thread. Note
55 * that an empty picture MUST have its flags set to 0.
56 *****************************************************************************/
59 /* Picture data - data can always be freely modified, but p_data may
60 * NEVER be modified. A direct buffer can be handled as the plugin
61 * wishes, it can even swap p_pixels buffers. */
63 void *p_data_orig; /* pointer before memalign */
64 plane_t p[ VOUT_MAX_PLANES ]; /* description of the planes */
65 int i_planes; /* number of allocated planes */
67 /* Type and flags - should NOT be modified except by the vout thread */
68 int i_status; /* picture flags */
69 int i_type; /* is picture a direct buffer ? */
70 int i_matrix_coefficients; /* in YUV type, encoding type */
72 /* Picture management properties - these properties can be modified using
73 * the video output thread API, but should never be written directly */
74 int i_refcount; /* link reference counter */
75 mtime_t date; /* display date */
78 /* Picture dynamic properties - those properties can be changed by the
80 vlc_bool_t b_progressive; /* is it a progressive frame ? */
81 vlc_bool_t b_repeat_first_field; /* RFF bit */
82 vlc_bool_t b_top_field_first; /* which field is first */
84 /* The picture heap we are attached to */
85 picture_heap_t* p_heap;
87 /* Private data - the video output plugin might want to put stuff here to
88 * keep track of the picture */
89 picture_sys_t * p_sys;
92 /*****************************************************************************
93 * picture_heap_t: video picture heap, either render (to store pictures used
94 * by the decoder) or output (to store pictures displayed by the vout plugin)
95 *****************************************************************************/
98 int i_pictures; /* current heap size */
100 /* Picture static properties - those properties are fixed at initialization
101 * and should NOT be modified */
102 int i_width; /* picture width */
103 int i_height; /* picture height */
104 u32 i_chroma; /* picture chroma */
105 int i_aspect; /* aspect ratio */
108 picture_t* pp_picture[VOUT_MAX_PICTURES]; /* pictures */
110 /* Stuff used for truecolor RGB planes */
111 int i_rmask, i_rrshift, i_lrshift;
112 int i_gmask, i_rgshift, i_lgshift;
113 int i_bmask, i_rbshift, i_lbshift;
115 /* Stuff used for palettized RGB planes */
116 void (* pf_setpalette) ( vout_thread_t *, u16 *, u16 *, u16 * );
119 /* RGB2PIXEL: assemble RGB components to a pixel value, returns a u32 */
120 #define RGB2PIXEL( p_vout, i_r, i_g, i_b ) \
121 (((((u32)i_r) >> p_vout->output.i_rrshift) << p_vout->output.i_lrshift) | \
122 ((((u32)i_g) >> p_vout->output.i_rgshift) << p_vout->output.i_lgshift) | \
123 ((((u32)i_b) >> p_vout->output.i_rbshift) << p_vout->output.i_lbshift))
125 /*****************************************************************************
126 * Flags used to describe the status of a picture
127 *****************************************************************************/
130 #define EMPTY_PICTURE 0 /* empty buffer */
131 #define MEMORY_PICTURE 100 /* heap-allocated buffer */
132 #define DIRECT_PICTURE 200 /* direct buffer */
135 #define FREE_PICTURE 0 /* free and not allocated */
136 #define RESERVED_PICTURE 1 /* allocated and reserved */
137 #define RESERVED_DATED_PICTURE 2 /* waiting for DisplayPicture */
138 #define RESERVED_DISP_PICTURE 3 /* waiting for a DatePicture */
139 #define READY_PICTURE 4 /* ready for display */
140 #define DISPLAYED_PICTURE 5 /* been displayed but is linked */
141 #define DESTROYED_PICTURE 6 /* allocated but no more used */
143 /*****************************************************************************
144 * Codes used to describe picture format - see http://www.webartz.com/fourcc/
145 *****************************************************************************/
146 #define VLC_FOURCC( a, b, c, d ) \
147 ( ((u32)a) | ( ((u32)b) << 8 ) | ( ((u32)c) << 16 ) | ( ((u32)d) << 24 ) )
149 #define VLC_TWOCC( a, b ) \
150 ( (u16)(a) | ( (u16)(b) << 8 ) )
153 #define FOURCC_RIFF VLC_FOURCC('R','I','F','F')
154 #define FOURCC_LIST VLC_FOURCC('L','I','S','T')
155 #define FOURCC_JUNK VLC_FOURCC('J','U','N','K')
156 #define FOURCC_AVI VLC_FOURCC('A','V','I',' ')
157 #define FOURCC_WAVE VLC_FOURCC('W','A','V','E')
159 #define FOURCC_avih VLC_FOURCC('a','v','i','h')
160 #define FOURCC_hdrl VLC_FOURCC('h','d','r','l')
161 #define FOURCC_movi VLC_FOURCC('m','o','v','i')
162 #define FOURCC_idx1 VLC_FOURCC('i','d','x','1')
164 #define FOURCC_strl VLC_FOURCC('s','t','r','l')
165 #define FOURCC_strh VLC_FOURCC('s','t','r','h')
166 #define FOURCC_strf VLC_FOURCC('s','t','r','f')
167 #define FOURCC_strd VLC_FOURCC('s','t','r','d')
169 #define FOURCC_rec VLC_FOURCC('r','e','c',' ')
170 #define FOURCC_auds VLC_FOURCC('a','u','d','s')
171 #define FOURCC_vids VLC_FOURCC('v','i','d','s')
173 #define TWOCC_wb VLC_TWOCC('w','b')
174 #define TWOCC_db VLC_TWOCC('d','b')
175 #define TWOCC_dc VLC_TWOCC('d','c')
176 #define TWOCC_pc VLC_TWOCC('p','c')
179 #define FOURCC_DIVX VLC_FOURCC('D','I','V','X')
180 #define FOURCC_divx VLC_FOURCC('d','i','v','x')
181 #define FOURCC_DIV1 VLC_FOURCC('D','I','V','1')
182 #define FOURCC_div1 VLC_FOURCC('d','i','v','1')
183 #define FOURCC_MP4S VLC_FOURCC('M','P','4','S')
184 #define FOURCC_mp4s VLC_FOURCC('m','p','4','s')
185 #define FOURCC_M4S2 VLC_FOURCC('M','4','S','2')
186 #define FOURCC_m4s2 VLC_FOURCC('m','4','s','2')
187 #define FOURCC_xvid VLC_FOURCC('x','v','i','d')
188 #define FOURCC_XVID VLC_FOURCC('X','V','I','D')
189 #define FOURCC_XviD VLC_FOURCC('X','v','i','D')
190 #define FOURCC_DX50 VLC_FOURCC('D','X','5','0')
191 #define FOURCC_mp4v VLC_FOURCC('m','p','4','v')
192 #define FOURCC_4 VLC_FOURCC( 4, 0, 0, 0 )
195 #define FOURCC_MPG4 VLC_FOURCC('M','P','G','4')
196 #define FOURCC_mpg4 VLC_FOURCC('m','p','g','4')
197 #define FOURCC_DIV2 VLC_FOURCC('D','I','V','2')
198 #define FOURCC_div2 VLC_FOURCC('d','i','v','2')
199 #define FOURCC_MP42 VLC_FOURCC('M','P','4','2')
200 #define FOURCC_mp42 VLC_FOURCC('m','p','4','2')
202 /* MSMPEG4 v3 / M$ mpeg4 v3 */
203 #define FOURCC_MPG3 VLC_FOURCC('M','P','G','3')
204 #define FOURCC_mpg3 VLC_FOURCC('m','p','g','3')
205 #define FOURCC_div3 VLC_FOURCC('d','i','v','3')
206 #define FOURCC_MP43 VLC_FOURCC('M','P','4','3')
207 #define FOURCC_mp43 VLC_FOURCC('m','p','4','3')
210 #define FOURCC_DIV3 VLC_FOURCC('D','I','V','3')
211 #define FOURCC_DIV4 VLC_FOURCC('D','I','V','4')
212 #define FOURCC_div4 VLC_FOURCC('d','i','v','4')
213 #define FOURCC_DIV5 VLC_FOURCC('D','I','V','5')
214 #define FOURCC_div5 VLC_FOURCC('d','i','v','5')
215 #define FOURCC_DIV6 VLC_FOURCC('D','I','V','6')
216 #define FOURCC_div6 VLC_FOURCC('d','i','v','6')
218 /* AngelPotion stuff */
219 #define FOURCC_AP41 VLC_FOURCC('A','P','4','1')
222 #define FOURCC_3IV1 VLC_FOURCC('3','I','V','1')
224 /* Packed RGB for 8bpp */
225 #define FOURCC_BI_RGB VLC_FOURCC( 0 , 0 , 0 , 0 )
226 #define FOURCC_RGB2 VLC_FOURCC('R','G','B','2')
228 /* Packed RGB for 16, 24, 32bpp */
229 #define FOURCC_BI_BITFIELDS VLC_FOURCC( 0 , 0 , 0 , 3 )
231 /* Packed RGB 15bpp, 0x1f, 0x7e0, 0xf800 */
232 #define FOURCC_RV15 VLC_FOURCC('R','V','1','5')
234 /* Packed RGB 16bpp, 0x1f, 0x3e0, 0x7c00 */
235 #define FOURCC_RV16 VLC_FOURCC('R','V','1','6')
237 /* Packed RGB 24bpp, 0xff, 0xff00, 0xff0000 */
238 #define FOURCC_RV24 VLC_FOURCC('R','V','2','4')
240 /* Packed RGB 32bpp, 0xff, 0xff00, 0xff0000 */
241 #define FOURCC_RV32 VLC_FOURCC('R','V','3','2')
243 /* Planar YUV 4:2:0, Y:U:V */
244 #define FOURCC_I420 VLC_FOURCC('I','4','2','0')
245 #define FOURCC_IYUV VLC_FOURCC('I','Y','U','V')
247 /* Planar YUV 4:2:0, Y:V:U */
248 #define FOURCC_YV12 VLC_FOURCC('Y','V','1','2')
250 /* Packed YUV 4:2:2, U:Y:V:Y, interlaced */
251 #define FOURCC_IUYV VLC_FOURCC('I','U','Y','V')
253 /* Packed YUV 4:2:2, U:Y:V:Y */
254 #define FOURCC_UYVY VLC_FOURCC('U','Y','V','Y')
255 #define FOURCC_UYNV VLC_FOURCC('U','Y','N','V')
256 #define FOURCC_Y422 VLC_FOURCC('Y','4','2','2')
258 /* Packed YUV 4:2:2, U:Y:V:Y, reverted */
259 #define FOURCC_cyuv VLC_FOURCC('c','y','u','v')
261 /* Packed YUV 4:2:2, Y:U:Y:V */
262 #define FOURCC_YUY2 VLC_FOURCC('Y','U','Y','2')
263 #define FOURCC_YUNV VLC_FOURCC('Y','U','N','V')
265 /* Packed YUV 4:2:2, Y:V:Y:U */
266 #define FOURCC_YVYU VLC_FOURCC('Y','V','Y','U')
268 /* Packed YUV 2:1:1, Y:U:Y:V */
269 #define FOURCC_Y211 VLC_FOURCC('Y','2','1','1')
271 /* Custom formats which we use but which don't exist in the fourcc database */
273 /* Planar Y, packed UV, from Matrox */
274 #define FOURCC_YMGA VLC_FOURCC('Y','M','G','A')
276 /* Planar 4:2:2, Y:U:V */
277 #define FOURCC_I422 VLC_FOURCC('I','4','2','2')
279 /* Planar 4:4:4, Y:U:V */
280 #define FOURCC_I444 VLC_FOURCC('I','4','4','4')
282 /*****************************************************************************
283 * Shortcuts to access image components
284 *****************************************************************************/
292 #define Y_PIXELS p[Y_PLANE].p_pixels
293 #define Y_PITCH p[Y_PLANE].i_pitch
294 #define U_PIXELS p[U_PLANE].p_pixels
295 #define U_PITCH p[U_PLANE].i_pitch
296 #define V_PIXELS p[V_PLANE].p_pixels
297 #define V_PITCH p[V_PLANE].i_pitch
299 /*****************************************************************************
300 * subpicture_t: video subtitle
301 *****************************************************************************
302 * Any subtitle destined to be displayed by a video output thread should
303 * be stored in this structure from it's creation to it's effective display.
304 * Subtitle type and flags should only be modified by the output thread. Note
305 * that an empty subtitle MUST have its flags set to 0.
306 *****************************************************************************/
309 /* Type and flags - should NOT be modified except by the vout thread */
310 int i_type; /* type */
311 int i_status; /* flags */
312 int i_size; /* data size */
313 subpicture_t * p_next; /* next subtitle to be displayed */
315 /* Date properties */
316 mtime_t i_start; /* beginning of display date */
317 mtime_t i_stop; /* end of display date */
318 vlc_bool_t b_ephemer; /* does the subtitle have a TTL ? */
320 /* Display properties - these properties are only indicative and may be
321 * changed by the video output thread, or simply ignored depending of the
323 int i_x; /* offset from alignment position */
324 int i_y; /* offset from alignment position */
325 int i_width; /* picture width */
326 int i_height; /* picture height */
329 /* Additionnal properties depending of the subpicture type */
332 /* Text subpictures properties - text is stored in data area, in ASCIIZ
336 vout_font_t * p_font; /* font, NULL for default */
337 int i_style; /* text style */
338 u32 i_char_color; /* character color */
339 u32 i_border_color; /* border color */
340 u32 i_bg_color; /* background color */
345 /* The subpicture rendering routine */
346 void ( *pf_render ) ( vout_thread_t *, picture_t *, const subpicture_t * );
348 /* Private data - the subtitle plugin might want to put stuff here to
349 * keep track of the subpicture */
350 subpicture_sys_t *p_sys; /* subpicture data */
351 void *p_sys_orig; /* pointer before memalign */
354 /* Subpicture type */
355 #define EMPTY_SUBPICTURE 0 /* subtitle slot is empty and available */
356 #define MEMORY_SUBPICTURE 100 /* subpicture stored in memory */
358 /* Subpicture status */
359 #define FREE_SUBPICTURE 0 /* free and not allocated */
360 #define RESERVED_SUBPICTURE 1 /* allocated and reserved */
361 #define READY_SUBPICTURE 2 /* ready for display */
362 #define DESTROYED_SUBPICTURE 3 /* allocated but not used anymore */