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.58 2002/11/11 14:39:11 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_t
31 uint8_t *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 /* Variables used for pictures with margins */
41 int i_visible_pitch; /* How many visible pixels are there ? */
45 /*****************************************************************************
46 * picture_t: video picture
47 *****************************************************************************
48 * Any picture destined to be displayed by a video output thread should be
49 * stored in this structure from it's creation to it's effective display.
50 * Picture type and flags should only be modified by the output thread. Note
51 * that an empty picture MUST have its flags set to 0.
52 *****************************************************************************/
55 /* Picture data - data can always be freely modified, but p_data may
56 * NEVER be modified. A direct buffer can be handled as the plugin
57 * wishes, it can even swap p_pixels buffers. */
59 void *p_data_orig; /* pointer before memalign */
60 plane_t p[ VOUT_MAX_PLANES ]; /* description of the planes */
61 int i_planes; /* number of allocated planes */
63 /* Type and flags - should NOT be modified except by the vout thread */
64 int i_status; /* picture flags */
65 int i_type; /* is picture a direct buffer ? */
66 int i_matrix_coefficients; /* in YUV type, encoding type */
68 /* Picture management properties - these properties can be modified using
69 * the video output thread API, but should never be written directly */
70 int i_refcount; /* link reference counter */
71 mtime_t date; /* display date */
74 /* Picture dynamic properties - those properties can be changed by the
76 vlc_bool_t b_progressive; /* is it a progressive frame ? */
77 vlc_bool_t b_repeat_first_field; /* RFF bit */
78 vlc_bool_t b_top_field_first; /* which field is first */
80 /* The picture heap we are attached to */
81 picture_heap_t* p_heap;
83 /* Private data - the video output plugin might want to put stuff here to
84 * keep track of the picture */
85 picture_sys_t * p_sys;
88 /*****************************************************************************
89 * picture_heap_t: video picture heap, either render (to store pictures used
90 * by the decoder) or output (to store pictures displayed by the vout plugin)
91 *****************************************************************************/
94 int i_pictures; /* current heap size */
96 /* Picture static properties - those properties are fixed at initialization
97 * and should NOT be modified */
98 int i_width; /* picture width */
99 int i_height; /* picture height */
100 vlc_fourcc_t i_chroma; /* picture chroma */
101 int i_aspect; /* aspect ratio */
104 picture_t* pp_picture[VOUT_MAX_PICTURES]; /* pictures */
106 /* Stuff used for truecolor RGB planes */
107 int i_rmask, i_rrshift, i_lrshift;
108 int i_gmask, i_rgshift, i_lgshift;
109 int i_bmask, i_rbshift, i_lbshift;
111 /* Stuff used for palettized RGB planes */
112 void (* pf_setpalette) ( vout_thread_t *, uint16_t *, uint16_t *, uint16_t * );
115 /* RGB2PIXEL: assemble RGB components to a pixel value, returns a uint32_t */
116 #define RGB2PIXEL( p_vout, i_r, i_g, i_b ) \
117 (((((uint32_t)i_r) >> p_vout->output.i_rrshift) \
118 << p_vout->output.i_lrshift) \
119 | ((((uint32_t)i_g) >> p_vout->output.i_rgshift) \
120 << p_vout->output.i_lgshift) \
121 | ((((uint32_t)i_b) >> p_vout->output.i_rbshift) \
122 << p_vout->output.i_lbshift))
124 /*****************************************************************************
125 * Flags used to describe the status of a picture
126 *****************************************************************************/
129 #define EMPTY_PICTURE 0 /* empty buffer */
130 #define MEMORY_PICTURE 100 /* heap-allocated buffer */
131 #define DIRECT_PICTURE 200 /* direct buffer */
134 #define FREE_PICTURE 0 /* free and not allocated */
135 #define RESERVED_PICTURE 1 /* allocated and reserved */
136 #define RESERVED_DATED_PICTURE 2 /* waiting for DisplayPicture */
137 #define RESERVED_DISP_PICTURE 3 /* waiting for a DatePicture */
138 #define READY_PICTURE 4 /* ready for display */
139 #define DISPLAYED_PICTURE 5 /* been displayed but is linked */
140 #define DESTROYED_PICTURE 6 /* allocated but no more used */
142 /*****************************************************************************
143 * Shortcuts to access image components
144 *****************************************************************************/
152 #define Y_PIXELS p[Y_PLANE].p_pixels
153 #define Y_PITCH p[Y_PLANE].i_pitch
154 #define U_PIXELS p[U_PLANE].p_pixels
155 #define U_PITCH p[U_PLANE].i_pitch
156 #define V_PIXELS p[V_PLANE].p_pixels
157 #define V_PITCH p[V_PLANE].i_pitch
159 /*****************************************************************************
160 * subpicture_t: video subtitle
161 *****************************************************************************
162 * Any subtitle destined to be displayed by a video output thread should
163 * be stored in this structure from it's creation to it's effective display.
164 * Subtitle type and flags should only be modified by the output thread. Note
165 * that an empty subtitle MUST have its flags set to 0.
166 *****************************************************************************/
169 /* Type and flags - should NOT be modified except by the vout thread */
170 int i_type; /* type */
171 int i_status; /* flags */
172 subpicture_t * p_next; /* next subtitle to be displayed */
174 /* Date properties */
175 mtime_t i_start; /* beginning of display date */
176 mtime_t i_stop; /* end of display date */
177 vlc_bool_t b_ephemer; /* does the subtitle have a TTL ? */
179 /* Display properties - these properties are only indicative and may be
180 * changed by the video output thread, or simply ignored depending of the
182 int i_x; /* offset from alignment position */
183 int i_y; /* offset from alignment position */
184 int i_width; /* picture width */
185 int i_height; /* picture height */
188 /* Additionnal properties depending of the subpicture type */
191 /* Text subpictures properties - text is stored in data area, in ASCIIZ
195 vout_font_t * p_font; /* font, NULL for default */
196 int i_style; /* text style */
197 uint32_t i_char_color; /* character color */
198 uint32_t i_border_color; /* border color */
199 uint32_t i_bg_color; /* background color */
204 /* The subpicture rendering and destruction routines */
205 void ( *pf_render ) ( vout_thread_t *, picture_t *, const subpicture_t * );
206 void ( *pf_destroy ) ( subpicture_t * );
208 /* Private data - the subtitle plugin might want to put stuff here to
209 * keep track of the subpicture */
210 subpicture_sys_t *p_sys; /* subpicture data */
213 /* Subpicture type */
214 #define EMPTY_SUBPICTURE 0 /* subtitle slot is empty and available */
215 #define MEMORY_SUBPICTURE 100 /* subpicture stored in memory */
217 /* Subpicture status */
218 #define FREE_SUBPICTURE 0 /* free and not allocated */
219 #define RESERVED_SUBPICTURE 1 /* allocated and reserved */
220 #define READY_SUBPICTURE 2 /* ready for display */