1 /*****************************************************************************
2 * vlc_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
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 #define _VLC_VIDEO_H 1
31 * Description of a planar graphic field
33 typedef struct plane_t
35 uint8_t *p_pixels; /**< Start of the plane's data */
37 /* Variables used for fast memcpy operations */
38 int i_lines; /**< Number of lines */
39 int i_pitch; /**< Number of bytes in a line, including margins */
41 /** Size of a macropixel, defaults to 1 */
44 /* Variables used for pictures with margins */
45 int i_visible_pitch; /**< How many visible pixels are there ? */
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.
59 /** \name Picture format
60 * Describes the properties of the picture
62 video_frame_format_t format;
65 /** Picture data - data can always be freely modified, but p_data may
66 * NEVER be modified. A direct buffer can be handled as the plugin
67 * wishes, it can even swap p_pixels buffers. */
69 void *p_data_orig; /**< pointer before memalign */
70 plane_t p[ VOUT_MAX_PLANES ]; /**< description of the planes */
71 int i_planes; /**< number of allocated planes */
73 /** \name Type and flags
74 * Should NOT be modified except by the vout thread
76 int i_status; /**< picture flags */
77 int i_type; /**< is picture a direct buffer ? */
78 int i_matrix_coefficients; /**< in YUV type, encoding type */
81 /** \name Picture management properties
82 * These properties can be modified using the video output thread API,
83 * but should never be written directly */
85 int i_refcount; /**< link reference counter */
86 mtime_t date; /**< display date */
90 /** \name Picture dynamic properties
91 * Those properties can be changed by the decoder
94 vlc_bool_t b_progressive; /**< is it a progressive frame ? */
95 unsigned int i_nb_fields; /**< # of displayed fields */
96 vlc_bool_t b_top_field_first; /**< which field is first */
99 /** The picture heap we are attached to */
100 picture_heap_t* p_heap;
102 /* Some vouts require the picture to be locked before it can be modified */
103 int (* pf_lock) ( vout_thread_t *, picture_t * );
104 int (* pf_unlock) ( vout_thread_t *, picture_t * );
106 /** Private data - the video output plugin might want to put stuff here to
107 * keep track of the picture */
108 picture_sys_t * p_sys;
112 * Video picture heap, either render (to store pictures used
113 * by the decoder) or output (to store pictures displayed by the vout plugin)
115 struct picture_heap_t
117 int i_pictures; /**< current heap size */
119 /* \name Picture static properties
120 * Those properties are fixed at initialization and should NOT be modified
123 unsigned int i_width; /**< picture width */
124 unsigned int i_height; /**< picture height */
125 vlc_fourcc_t i_chroma; /**< picture chroma */
126 unsigned int i_aspect; /**< aspect ratio */
130 picture_t* pp_picture[VOUT_MAX_PICTURES]; /**< pictures */
131 int i_last_used_pic; /**< last used pic in heap */
132 vlc_bool_t b_allow_modify_pics;
134 /* Stuff used for truecolor RGB planes */
135 int i_rmask, i_rrshift, i_lrshift;
136 int i_gmask, i_rgshift, i_lgshift;
137 int i_bmask, i_rbshift, i_lbshift;
139 /** Stuff used for palettized RGB planes */
140 void (* pf_setpalette) ( vout_thread_t *, uint16_t *, uint16_t *, uint16_t * );
143 /*****************************************************************************
144 * Flags used to describe the status of a picture
145 *****************************************************************************/
148 #define EMPTY_PICTURE 0 /* empty buffer */
149 #define MEMORY_PICTURE 100 /* heap-allocated buffer */
150 #define DIRECT_PICTURE 200 /* direct buffer */
153 #define FREE_PICTURE 0 /* free and not allocated */
154 #define RESERVED_PICTURE 1 /* allocated and reserved */
155 #define RESERVED_DATED_PICTURE 2 /* waiting for DisplayPicture */
156 #define RESERVED_DISP_PICTURE 3 /* waiting for a DatePicture */
157 #define READY_PICTURE 4 /* ready for display */
158 #define DISPLAYED_PICTURE 5 /* been displayed but is linked */
159 #define DESTROYED_PICTURE 6 /* allocated but no more used */
161 /*****************************************************************************
162 * Shortcuts to access image components
163 *****************************************************************************/
171 #define Y_PIXELS p[Y_PLANE].p_pixels
172 #define Y_PITCH p[Y_PLANE].i_pitch
173 #define U_PIXELS p[U_PLANE].p_pixels
174 #define U_PITCH p[U_PLANE].i_pitch
175 #define V_PIXELS p[V_PLANE].p_pixels
176 #define V_PITCH p[V_PLANE].i_pitch
179 * \defgroup subpicture Video Subpictures
180 * Subpictures are pictures that should be displayed on top of the video, like
182 * \ingroup video_output
189 * Any subtitle destined to be displayed by a video output thread should
190 * be stored in this structure from it's creation to it's effective display.
191 * Subtitle type and flags should only be modified by the output thread. Note
192 * that an empty subtitle MUST have its flags set to 0.
196 /** \name Channel ID */
198 int i_channel; /**< subpicture channel ID */
201 /** \name Type and flags
202 Should NOT be modified except by the vout thread */
204 int i_type; /**< type */
205 int i_status; /**< flags */
206 subpicture_t * p_next; /**< next subtitle to be displayed */
209 /** \name Date properties */
211 mtime_t i_start; /**< beginning of display date */
212 mtime_t i_stop; /**< end of display date */
213 vlc_bool_t b_ephemer; /**< If this flag is set to true
214 the subtitle will be displayed
215 untill the next one appear */
218 /** \name Display properties
219 * These properties are only indicative and may be
220 * changed by the video output thread, or simply ignored depending of the
223 int i_x; /**< offset from alignment position */
224 int i_y; /**< offset from alignment position */
225 int i_width; /**< picture width */
226 int i_height; /**< picture height */
229 /** Pointer to function that renders this subtitle in a picture */
230 void ( *pf_render ) ( vout_thread_t *, picture_t *, const subpicture_t * );
231 /** Pointer to function that cleans up the private data of this subtitle */
232 void ( *pf_destroy ) ( subpicture_t * );
234 /** Private data - the subtitle plugin might want to put stuff here to
235 * keep track of the subpicture */
236 subpicture_sys_t *p_sys; /* subpicture data */
239 /* Subpicture type */
240 #define EMPTY_SUBPICTURE 0 /* subtitle slot is empty and available */
241 #define MEMORY_SUBPICTURE 100 /* subpicture stored in memory */
243 /* Default subpicture channel ID */
244 #define DEFAULT_CHAN 1
246 /* Subpicture status */
247 #define FREE_SUBPICTURE 0 /* free and not allocated */
248 #define RESERVED_SUBPICTURE 1 /* allocated and reserved */
249 #define READY_SUBPICTURE 2 /* ready for display */
251 /*****************************************************************************
253 *****************************************************************************/
257 * Set the i_aspect_x and i_aspect_y from the encoded aspect ratio i_aspect.
258 * \param i_aspect the encoded aspect ratio
259 * \param i_aspect_x the decoded x-axis portion of i_aspect. This is set.
260 * \param i_aspect_y the decoded y-axis portion of i_aspect This is set.
262 VLC_EXPORT( void, vout_AspectRatio, ( unsigned int i_aspect, unsigned int *i_aspect_x, unsigned int *i_aspect_y ) );
266 #endif /* _VLC_VIDEO_H */