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 - 2005 the VideoLAN team
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, 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, including margins */
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_lines; /**< How many visible lines are there ? */
46 int i_visible_pitch; /**< How many visible pixels are there ? */
53 * Any picture destined to be displayed by a video output thread should be
54 * stored in this structure from it's creation to it's effective display.
55 * Picture type and flags should only be modified by the output thread. Note
56 * that an empty picture MUST have its flags set to 0.
61 * The properties of the picture
63 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 vlc_bool_t b_slow; /**< is picture in slow memory ? */
79 int i_matrix_coefficients; /**< in YUV type, encoding type */
82 /** \name Picture management properties
83 * These properties can be modified using the video output thread API,
84 * but should never be written directly */
86 int i_refcount; /**< link reference counter */
87 mtime_t date; /**< display date */
91 /** \name Picture dynamic properties
92 * Those properties can be changed by the decoder
95 vlc_bool_t b_progressive; /**< is it a progressive frame ? */
96 unsigned int i_nb_fields; /**< # of displayed fields */
97 vlc_bool_t b_top_field_first; /**< which field is first */
100 /** The picture heap we are attached to */
101 picture_heap_t* p_heap;
103 /* Some vouts require the picture to be locked before it can be modified */
104 int (* pf_lock) ( vout_thread_t *, picture_t * );
105 int (* pf_unlock) ( vout_thread_t *, picture_t * );
107 /** Private data - the video output plugin might want to put stuff here to
108 * keep track of the picture */
109 picture_sys_t * p_sys;
111 /** This way the picture_Release can be overloaded */
112 void (*pf_release)( picture_t * );
114 /** Next picture in a FIFO a pictures */
115 struct picture_t *p_next;
119 * Video picture heap, either render (to store pictures used
120 * by the decoder) or output (to store pictures displayed by the vout plugin)
122 struct picture_heap_t
124 int i_pictures; /**< current heap size */
126 /* \name Picture static properties
127 * Those properties are fixed at initialization and should NOT be modified
130 unsigned int i_width; /**< picture width */
131 unsigned int i_height; /**< picture height */
132 vlc_fourcc_t i_chroma; /**< picture chroma */
133 unsigned int i_aspect; /**< aspect ratio */
137 picture_t* pp_picture[VOUT_MAX_PICTURES]; /**< pictures */
138 int i_last_used_pic; /**< last used pic in heap */
139 vlc_bool_t b_allow_modify_pics;
141 /* Stuff used for truecolor RGB planes */
142 uint32_t i_rmask; int i_rrshift, i_lrshift;
143 uint32_t i_gmask; int i_rgshift, i_lgshift;
144 uint32_t i_bmask; int i_rbshift, i_lbshift;
146 /** Stuff used for palettized RGB planes */
147 void (* pf_setpalette) ( vout_thread_t *, uint16_t *, uint16_t *, uint16_t * );
150 /*****************************************************************************
151 * Flags used to describe the status of a picture
152 *****************************************************************************/
155 #define EMPTY_PICTURE 0 /* empty buffer */
156 #define MEMORY_PICTURE 100 /* heap-allocated buffer */
157 #define DIRECT_PICTURE 200 /* direct buffer */
160 #define FREE_PICTURE 0 /* free and not allocated */
161 #define RESERVED_PICTURE 1 /* allocated and reserved */
162 #define RESERVED_DATED_PICTURE 2 /* waiting for DisplayPicture */
163 #define RESERVED_DISP_PICTURE 3 /* waiting for a DatePicture */
164 #define READY_PICTURE 4 /* ready for display */
165 #define DISPLAYED_PICTURE 5 /* been displayed but is linked */
166 #define DESTROYED_PICTURE 6 /* allocated but no more used */
168 /*****************************************************************************
169 * Shortcuts to access image components
170 *****************************************************************************/
179 #define Y_PIXELS p[Y_PLANE].p_pixels
180 #define Y_PITCH p[Y_PLANE].i_pitch
181 #define U_PIXELS p[U_PLANE].p_pixels
182 #define U_PITCH p[U_PLANE].i_pitch
183 #define V_PIXELS p[V_PLANE].p_pixels
184 #define V_PITCH p[V_PLANE].i_pitch
185 #define A_PIXELS p[A_PLANE].p_pixels
186 #define A_PITCH p[A_PLANE].i_pitch
189 * \defgroup subpicture Video Subpictures
190 * Subpictures are pictures that should be displayed on top of the video, like
192 * \ingroup video_output
197 * Video subtitle region
199 * A subtitle region is defined by a picture (graphic) and its rendering
201 * Subtitles contain a list of regions.
203 struct subpicture_region_t
205 video_format_t fmt; /**< format of the picture */
206 picture_t picture; /**< picture comprising this region */
208 int i_x; /**< position of region */
209 int i_y; /**< position of region */
210 int i_align; /**< alignment within a region */
212 char *psz_text; /**< text string comprising this region */
213 text_style_t *p_style; /* a description of the text style formatting */
215 subpicture_region_t *p_next; /**< next region in the list */
216 subpicture_region_t *p_cache; /**< modified version of this region */
222 * Any subtitle destined to be displayed by a video output thread should
223 * be stored in this structure from it's creation to it's effective display.
224 * Subtitle type and flags should only be modified by the output thread. Note
225 * that an empty subtitle MUST have its flags set to 0.
229 /** \name Channel ID */
231 int i_channel; /**< subpicture channel ID */
234 /** \name Type and flags
235 Should NOT be modified except by the vout thread */
237 int i_type; /**< type */
238 int i_status; /**< flags */
239 subpicture_t * p_next; /**< next subtitle to be displayed */
242 /** \name Date properties */
244 mtime_t i_start; /**< beginning of display date */
245 mtime_t i_stop; /**< end of display date */
246 vlc_bool_t b_ephemer; /**< If this flag is set to true the subtitle
247 will be displayed untill the next one appear */
248 vlc_bool_t b_fade; /**< enable fading */
251 subpicture_region_t *p_region; /**< region list composing this subtitle */
253 /** \name Display properties
254 * These properties are only indicative and may be
255 * changed by the video output thread, or simply ignored depending of the
258 int i_x; /**< offset from alignment position */
259 int i_y; /**< offset from alignment position */
260 int i_width; /**< picture width */
261 int i_height; /**< picture height */
262 int i_alpha; /**< transparency */
263 int i_original_picture_width; /**< original width of the movie */
264 int i_original_picture_height;/**< original height of the movie */
265 vlc_bool_t b_absolute; /**< position is absolute */
266 int i_flags; /**< position flags */
269 /** Pointer to function that renders this subtitle in a picture */
270 void ( *pf_render ) ( vout_thread_t *, picture_t *, const subpicture_t * );
271 /** Pointer to function that cleans up the private data of this subtitle */
272 void ( *pf_destroy ) ( subpicture_t * );
274 /** Pointer to functions for region management */
275 subpicture_region_t * ( *pf_create_region ) ( vlc_object_t *,
277 subpicture_region_t * ( *pf_make_region ) ( vlc_object_t *,
278 video_format_t *, picture_t * );
279 void ( *pf_destroy_region ) ( vlc_object_t *, subpicture_region_t * );
281 /** Private data - the subtitle plugin might want to put stuff here to
282 * keep track of the subpicture */
283 subpicture_sys_t *p_sys; /* subpicture data */
286 /* Subpicture type */
287 #define EMPTY_SUBPICTURE 0 /* subtitle slot is empty and available */
288 #define MEMORY_SUBPICTURE 100 /* subpicture stored in memory */
290 /* Default subpicture channel ID */
291 #define DEFAULT_CHAN 1
293 /* Subpicture status */
294 #define FREE_SUBPICTURE 0 /* free and not allocated */
295 #define RESERVED_SUBPICTURE 1 /* allocated and reserved */
296 #define READY_SUBPICTURE 2 /* ready for display */
298 /* Subpicture position flags */
299 #define SUBPICTURE_ALIGN_LEFT 0x1
300 #define SUBPICTURE_ALIGN_RIGHT 0x2
301 #define SUBPICTURE_ALIGN_TOP 0x4
302 #define SUBPICTURE_ALIGN_BOTTOM 0x8
304 /*****************************************************************************
306 *****************************************************************************/
310 * Copy the source picture onto the destination picture.
311 * \param p_this a vlc object
312 * \param p_dst pointer to the destination picture.
313 * \param p_src pointer to the source picture.
315 #define vout_CopyPicture(a,b,c) __vout_CopyPicture(VLC_OBJECT(a),b,c)
316 VLC_EXPORT( void, __vout_CopyPicture, ( vlc_object_t *p_this, picture_t *p_dst, picture_t *p_src ) );
321 * Initialise different fields of a picture_t (but does not allocate memory).
322 * \param p_this a vlc object
323 * \param p_pic pointer to the picture structure.
324 * \param i_chroma the wanted chroma for the picture.
325 * \param i_width the wanted width for the picture.
326 * \param i_height the wanted height for the picture.
327 * \param i_aspect the wanted aspect ratio for the picture.
329 #define vout_InitPicture(a,b,c,d,e,f) \
330 __vout_InitPicture(VLC_OBJECT(a),b,c,d,e,f)
331 VLC_EXPORT( int, __vout_InitPicture, ( vlc_object_t *p_this, picture_t *p_pic, uint32_t i_chroma, int i_width, int i_height, int i_aspect ) );
334 * vout_AllocatePicture
336 * Initialise different fields of a picture_t and allocates the picture buffer.
337 * \param p_this a vlc object
338 * \param p_pic pointer to the picture structure.
339 * \param i_chroma the wanted chroma for the picture.
340 * \param i_width the wanted width for the picture.
341 * \param i_height the wanted height for the picture.
342 * \param i_aspect the wanted aspect ratio for the picture.
344 #define vout_AllocatePicture(a,b,c,d,e,f) \
345 __vout_AllocatePicture(VLC_OBJECT(a),b,c,d,e,f)
346 VLC_EXPORT( int, __vout_AllocatePicture,( vlc_object_t *p_this, picture_t *p_pic, uint32_t i_chroma, int i_width, int i_height, int i_aspect ) );
349 * vout_ShowTextRelative
351 * Show text on the video for some time
352 * \param p_vout pointer to the vout the text is to be showed on
353 * \param i_channel Subpicture channel
354 * \param psz_string The text to be shown
355 * \param p_style Pointer to a struct with text style info
356 * \param i_flags flags for alignment and such
357 * \param i_hmargin horizontal margin in pixels
358 * \param i_vmargin vertical margin in pixels
359 * \param i_duration Amount of time the text is to be shown.
361 VLC_EXPORT( int, vout_ShowTextRelative, ( vout_thread_t *, int, char *, text_style_t *, int, int, int, mtime_t ) );
364 * vout_ShowTextAbsolute
366 * Show text on the video from a given start date to a given end date
367 * \param p_vout pointer to the vout the text is to be showed on
368 * \param i_channel Subpicture channel
369 * \param psz_string The text to be shown
370 * \param p_style Pointer to a struct with text style info
371 * \param i_flags flags for alignment and such
372 * \param i_hmargin horizontal margin in pixels
373 * \param i_vmargin vertical margin in pixels
374 * \param i_start the time when this string is to appear on the video
375 * \param i_stop the time when this string should stop to be displayed
376 * if this is 0 the string will be shown untill the next string
377 * is about to be shown
379 VLC_EXPORT( int, vout_ShowTextAbsolute, ( vout_thread_t *, int, char *, text_style_t *, int, int, int, mtime_t, mtime_t ) );
384 * Write an informative message at the default location,
385 * for the default duration and only if the OSD option is enabled.
386 * \param p_caller The object that called the function.
387 * \param i_channel Subpicture channel
388 * \param psz_format printf style formatting
390 VLC_EXPORT( void, __vout_OSDMessage, ( vlc_object_t *, int, char *, ... ) );
393 * Same as __vlc_OSDMessage() but with automatic casting
395 #if defined(HAVE_VARIADIC_MACROS)
396 # define vout_OSDMessage( obj, chan, fmt, args...) __vout_OSDMessage( VLC_OBJECT(obj), chan, fmt, ## args )
398 # define vout_OSDMessage __vout_OSDMessage
404 * Display a slider on the video output.
405 * \param p_this The object that called the function.
406 * \param i_channel Subpicture channel
407 * \param i_postion Current position in the slider
408 * \param i_type Types are: OSD_HOR_SLIDER and OSD_VERT_SLIDER.
411 VLC_EXPORT( void, vout_OSDSlider, ( vlc_object_t *, int, int , short ) );
416 * Display an Icon on the video output.
417 * \param p_this The object that called the function.
418 * \param i_channel Subpicture channel
419 * \param i_type Types are: OSD_PLAY_ICON, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON
422 VLC_EXPORT( void, vout_OSDIcon, ( vlc_object_t *, int, short ) );
426 #endif /* _VLC_VIDEO_H */