1 /*****************************************************************************
2 * vlc_video.h: common video definitions
3 *****************************************************************************
4 * Copyright (C) 1999 - 2005 the VideoLAN team
7 * Authors: Vincent Seguin <seguin@via.ecp.fr>
8 * Samuel Hocevar <sam@via.ecp.fr>
9 * Olivier Aubert <oaubert 47 videolan d07 org>
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 #if !defined( __LIBVLC__ )
27 #error You are not libvlc or one of its plugins. You cannot include this file
31 #define _VLC_VOUT_H_ 1
35 /** Description of a planar graphic field */
36 typedef struct plane_t
38 uint8_t *p_pixels; /**< Start of the plane's data */
40 /* Variables used for fast memcpy operations */
41 int i_lines; /**< Number of lines, including margins */
42 int i_pitch; /**< Number of bytes in a line, including margins */
44 /** Size of a macropixel, defaults to 1 */
47 /* Variables used for pictures with margins */
48 int i_visible_lines; /**< How many visible lines are there ? */
49 int i_visible_pitch; /**< How many visible pixels are there ? */
56 * Any picture destined to be displayed by a video output thread should be
57 * stored in this structure from it's creation to it's effective display.
58 * Picture type and flags should only be modified by the output thread. Note
59 * that an empty picture MUST have its flags set to 0.
64 * The properties of the picture
66 video_frame_format_t format;
68 /** Picture data - data can always be freely modified, but p_data may
69 * NEVER be modified. A direct buffer can be handled as the plugin
70 * wishes, it can even swap p_pixels buffers. */
72 void *p_data_orig; /**< pointer before memalign */
73 plane_t p[ VOUT_MAX_PLANES ]; /**< description of the planes */
74 int i_planes; /**< number of allocated planes */
76 /** \name Type and flags
77 * Should NOT be modified except by the vout thread
79 int i_status; /**< picture flags */
80 int i_type; /**< is picture a direct buffer ? */
81 vlc_bool_t b_slow; /**< is picture in slow memory ? */
82 int i_matrix_coefficients; /**< in YUV type, encoding type */
85 /** \name Picture management properties
86 * These properties can be modified using the video output thread API,
87 * but should never be written directly */
89 unsigned i_refcount; /**< link reference counter */
90 mtime_t date; /**< display date */
94 /** \name Picture dynamic properties
95 * Those properties can be changed by the decoder
98 vlc_bool_t b_progressive; /**< is it a progressive frame ? */
99 unsigned int i_nb_fields; /**< # of displayed fields */
100 vlc_bool_t b_top_field_first; /**< which field is first */
103 /** The picture heap we are attached to */
104 picture_heap_t* p_heap;
106 /* Some vouts require the picture to be locked before it can be modified */
107 int (* pf_lock) ( vout_thread_t *, picture_t * );
108 int (* pf_unlock) ( vout_thread_t *, picture_t * );
110 /** Private data - the video output plugin might want to put stuff here to
111 * keep track of the picture */
112 picture_sys_t * p_sys;
114 /** This way the picture_Release can be overloaded */
115 void (*pf_release)( picture_t * );
117 /** Next picture in a FIFO a pictures */
118 struct picture_t *p_next;
122 * Video picture heap, either render (to store pictures used
123 * by the decoder) or output (to store pictures displayed by the vout plugin)
125 struct picture_heap_t
127 int i_pictures; /**< current heap size */
129 /* \name Picture static properties
130 * Those properties are fixed at initialization and should NOT be modified
133 unsigned int i_width; /**< picture width */
134 unsigned int i_height; /**< picture height */
135 vlc_fourcc_t i_chroma; /**< picture chroma */
136 unsigned int i_aspect; /**< aspect ratio */
140 picture_t* pp_picture[VOUT_MAX_PICTURES]; /**< pictures */
141 int i_last_used_pic; /**< last used pic in heap */
142 vlc_bool_t b_allow_modify_pics;
144 /* Stuff used for truecolor RGB planes */
145 uint32_t i_rmask; int i_rrshift, i_lrshift;
146 uint32_t i_gmask; int i_rgshift, i_lgshift;
147 uint32_t i_bmask; int i_rbshift, i_lbshift;
149 /** Stuff used for palettized RGB planes */
150 void (* pf_setpalette) ( vout_thread_t *, uint16_t *, uint16_t *, uint16_t * );
153 /*****************************************************************************
154 * Flags used to describe the status of a picture
155 *****************************************************************************/
158 #define EMPTY_PICTURE 0 /* empty buffer */
159 #define MEMORY_PICTURE 100 /* heap-allocated buffer */
160 #define DIRECT_PICTURE 200 /* direct buffer */
163 #define FREE_PICTURE 0 /* free and not allocated */
164 #define RESERVED_PICTURE 1 /* allocated and reserved */
165 #define RESERVED_DATED_PICTURE 2 /* waiting for DisplayPicture */
166 #define RESERVED_DISP_PICTURE 3 /* waiting for a DatePicture */
167 #define READY_PICTURE 4 /* ready for display */
168 #define DISPLAYED_PICTURE 5 /* been displayed but is linked */
169 #define DESTROYED_PICTURE 6 /* allocated but no more used */
171 /*****************************************************************************
172 * Shortcuts to access image components
173 *****************************************************************************/
182 #define Y_PIXELS p[Y_PLANE].p_pixels
183 #define Y_PITCH p[Y_PLANE].i_pitch
184 #define U_PIXELS p[U_PLANE].p_pixels
185 #define U_PITCH p[U_PLANE].i_pitch
186 #define V_PIXELS p[V_PLANE].p_pixels
187 #define V_PITCH p[V_PLANE].i_pitch
188 #define A_PIXELS p[A_PLANE].p_pixels
189 #define A_PITCH p[A_PLANE].i_pitch
192 * \defgroup subpicture Video Subpictures
193 * Subpictures are pictures that should be displayed on top of the video, like
195 * \ingroup video_output
200 * Video subtitle region
202 * A subtitle region is defined by a picture (graphic) and its rendering
204 * Subtitles contain a list of regions.
206 struct subpicture_region_t
208 video_format_t fmt; /**< format of the picture */
209 picture_t picture; /**< picture comprising this region */
211 int i_x; /**< position of region */
212 int i_y; /**< position of region */
213 int i_align; /**< alignment within a region */
215 char *psz_text; /**< text string comprising this region */
216 char *psz_html; /**< HTML version of subtitle (NULL = use psz_text) */
217 text_style_t *p_style; /* a description of the text style formatting */
219 subpicture_region_t *p_next; /**< next region in the list */
220 subpicture_region_t *p_cache; /**< modified version of this region */
226 * Any subtitle destined to be displayed by a video output thread should
227 * be stored in this structure from it's creation to it's effective display.
228 * Subtitle type and flags should only be modified by the output thread. Note
229 * that an empty subtitle MUST have its flags set to 0.
233 /** \name Channel ID */
235 int i_channel; /**< subpicture channel ID */
238 /** \name Type and flags
239 Should NOT be modified except by the vout thread */
241 int i_type; /**< type */
242 int i_status; /**< flags */
243 subpicture_t * p_next; /**< next subtitle to be displayed */
246 /** \name Date properties */
248 mtime_t i_start; /**< beginning of display date */
249 mtime_t i_stop; /**< end of display date */
250 vlc_bool_t b_ephemer; /**< If this flag is set to true the subtitle
251 will be displayed untill the next one appear */
252 vlc_bool_t b_fade; /**< enable fading */
253 vlc_bool_t b_pausable; /**< subpicture will be paused if
257 subpicture_region_t *p_region; /**< region list composing this subtitle */
259 /** \name Display properties
260 * These properties are only indicative and may be
261 * changed by the video output thread, or simply ignored depending of the
264 int i_x; /**< offset from alignment position */
265 int i_y; /**< offset from alignment position */
266 int i_width; /**< picture width */
267 int i_height; /**< picture height */
268 int i_alpha; /**< transparency */
269 int i_original_picture_width; /**< original width of the movie */
270 int i_original_picture_height;/**< original height of the movie */
271 vlc_bool_t b_absolute; /**< position is absolute */
272 int i_flags; /**< position flags */
275 /** Pointer to function that renders this subtitle in a picture */
276 void ( *pf_render ) ( vout_thread_t *, picture_t *, const subpicture_t * );
277 /** Pointer to function that cleans up the private data of this subtitle */
278 void ( *pf_destroy ) ( subpicture_t * );
280 /** Pointer to functions for region management */
281 subpicture_region_t * ( *pf_create_region ) ( vlc_object_t *,
283 subpicture_region_t * ( *pf_make_region ) ( vlc_object_t *,
284 video_format_t *, picture_t * );
285 void ( *pf_destroy_region ) ( vlc_object_t *, subpicture_region_t * );
287 void ( *pf_pre_render ) ( video_format_t *, spu_t *, subpicture_t *, mtime_t );
288 subpicture_region_t * ( *pf_update_regions ) ( video_format_t *, spu_t *,
289 subpicture_t *, mtime_t );
291 /** Private data - the subtitle plugin might want to put stuff here to
292 * keep track of the subpicture */
293 subpicture_sys_t *p_sys; /* subpicture data */
296 /* Subpicture type */
297 #define EMPTY_SUBPICTURE 0 /* subtitle slot is empty and available */
298 #define MEMORY_SUBPICTURE 100 /* subpicture stored in memory */
300 /* Default subpicture channel ID */
301 #define DEFAULT_CHAN 1
303 /* Subpicture status */
304 #define FREE_SUBPICTURE 0 /* free and not allocated */
305 #define RESERVED_SUBPICTURE 1 /* allocated and reserved */
306 #define READY_SUBPICTURE 2 /* ready for display */
308 /* Subpicture position flags */
309 #define SUBPICTURE_ALIGN_LEFT 0x1
310 #define SUBPICTURE_ALIGN_RIGHT 0x2
311 #define SUBPICTURE_ALIGN_TOP 0x4
312 #define SUBPICTURE_ALIGN_BOTTOM 0x8
313 #define SUBPICTURE_ALIGN_MASK ( SUBPICTURE_ALIGN_LEFT|SUBPICTURE_ALIGN_RIGHT| \
314 SUBPICTURE_ALIGN_TOP |SUBPICTURE_ALIGN_BOTTOM )
316 /* Subpicture rendered flag - should only be used by vout_subpictures */
317 #define SUBPICTURE_RENDERED 0x10
319 /*****************************************************************************
321 *****************************************************************************/
324 * Copy the source picture onto the destination picture.
325 * \param p_this a vlc object
326 * \param p_dst pointer to the destination picture.
327 * \param p_src pointer to the source picture.
329 #define vout_CopyPicture(a,b,c) __vout_CopyPicture(VLC_OBJECT(a),b,c)
330 VLC_EXPORT( void, __vout_CopyPicture, ( vlc_object_t *p_this, picture_t *p_dst, picture_t *p_src ) );
333 * Initialise different fields of a picture_t (but does not allocate memory).
334 * \param p_this a vlc object
335 * \param p_pic pointer to the picture structure.
336 * \param i_chroma the wanted chroma for the picture.
337 * \param i_width the wanted width for the picture.
338 * \param i_height the wanted height for the picture.
339 * \param i_aspect the wanted aspect ratio for the picture.
341 #define vout_InitPicture(a,b,c,d,e,f) \
342 __vout_InitPicture(VLC_OBJECT(a),b,c,d,e,f)
343 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 ) );
346 * Initialise different fields of a picture_t and allocates the picture buffer.
347 * \param p_this a vlc object
348 * \param p_pic pointer to the picture structure.
349 * \param i_chroma the wanted chroma for the picture.
350 * \param i_width the wanted width for the picture.
351 * \param i_height the wanted height for the picture.
352 * \param i_aspect the wanted aspect ratio for the picture.
354 #define vout_AllocatePicture(a,b,c,d,e,f) \
355 __vout_AllocatePicture(VLC_OBJECT(a),b,c,d,e,f)
356 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 ) );
360 * \defgroup video_output Video Output
361 * This module describes the programming interface for video output threads.
362 * It includes functions allowing to open a new thread, send pictures to a
363 * thread, and destroy a previously opened video output thread.
368 * Chroma conversion function
370 * This is the prototype common to all conversion functions.
371 * \param p_vout video output thread
372 * \param p_source source picture
373 * \param p_dest destination picture
374 * Picture width and source dimensions must be multiples of 16.
376 typedef void (vout_chroma_convert_t)( vout_thread_t *,
377 picture_t *, picture_t * );
379 typedef struct vout_chroma_t
381 /** conversion functions */
382 vout_chroma_convert_t *pf_convert;
384 /** Private module-dependant data */
385 chroma_sys_t * p_sys; /* private data */
387 /** Plugin used and shortcuts to access its capabilities */
392 /** Maximum numbers of video filters2 that can be attached to a vout */
393 #define MAX_VFILTERS 10
396 * Video output thread descriptor
398 * Any independant video output device, such as an X11 window or a GGI device,
399 * is represented by a video output thread, and described using the following
406 /** \name Thread properties and locks */
408 vlc_mutex_t picture_lock; /**< picture heap lock */
409 vlc_mutex_t subpicture_lock; /**< subpicture heap lock */
410 vlc_mutex_t change_lock; /**< thread change lock */
411 vlc_mutex_t vfilter_lock; /**< video filter2 change lock */
412 vout_sys_t * p_sys; /**< system output method */
415 /** \name Current display properties */
417 uint16_t i_changes; /**< changes made to the thread.
418 \see \ref vout_changes */
419 float f_gamma; /**< gamma */
420 vlc_bool_t b_grayscale; /**< color or grayscale display */
421 vlc_bool_t b_info; /**< print additional information */
422 vlc_bool_t b_interface; /**< render interface */
423 vlc_bool_t b_scale; /**< allow picture scaling */
424 vlc_bool_t b_fullscreen; /**< toogle fullscreen display */
425 uint32_t render_time; /**< last picture render time */
426 unsigned int i_window_width; /**< video window width */
427 unsigned int i_window_height; /**< video window height */
428 unsigned int i_alignment; /**< video alignment in window */
429 unsigned int i_par_num; /**< monitor pixel aspect-ratio */
430 unsigned int i_par_den; /**< monitor pixel aspect-ratio */
432 intf_thread_t *p_parent_intf; /**< parent interface for embedded
436 /** \name Plugin used and shortcuts to access its capabilities */
439 int ( *pf_init ) ( vout_thread_t * );
440 void ( *pf_end ) ( vout_thread_t * );
441 int ( *pf_manage ) ( vout_thread_t * );
442 void ( *pf_render ) ( vout_thread_t *, picture_t * );
443 void ( *pf_display ) ( vout_thread_t *, picture_t * );
444 void ( *pf_swap ) ( vout_thread_t * ); /* OpenGL only */
445 int ( *pf_lock ) ( vout_thread_t * ); /* OpenGL only */
446 void ( *pf_unlock ) ( vout_thread_t * ); /* OpenGL only */
447 int ( *pf_control ) ( vout_thread_t *, int, va_list );
451 * These numbers are not supposed to be accurate, but are a
452 * good indication of the thread status */
454 count_t c_fps_samples; /**< picture counts */
455 mtime_t p_fps_sample[VOUT_FPS_SAMPLES]; /**< FPS samples dates */
458 /** \name Video heap and translation tables */
460 int i_heap_size; /**< heap size */
461 picture_heap_t render; /**< rendered pictures */
462 picture_heap_t output; /**< direct buffers */
463 vlc_bool_t b_direct; /**< rendered are like direct ? */
464 vout_chroma_t chroma; /**< translation tables */
466 video_format_t fmt_render; /* render format (from the decoder) */
467 video_format_t fmt_in; /* input (modified render) format */
468 video_format_t fmt_out; /* output format (for the video output) */
472 picture_t p_picture[2*VOUT_MAX_PICTURES+1]; /**< pictures */
474 /* Subpicture unit */
479 count_t c_pictures, c_late_pictures;
480 mtime_t display_jitter; /**< average deviation from the PTS */
481 count_t c_jitter_samples; /**< number of samples used
482 for the calculation of the
484 /** delay created by internal caching */
488 char *psz_filter_chain;
489 vlc_bool_t b_filter_change;
491 /* Video filter2 chain
492 * these are handled like in transcode.c
493 * XXX: we might need to merge the two chains (v1 and v2 filters) */
494 char *psz_vfilters[MAX_VFILTERS];
495 config_chain_t *p_vfilters_cfg[MAX_VFILTERS];
498 filter_t *pp_vfilters[MAX_VFILTERS];
501 vlc_bool_t b_vfilter_change;
504 vlc_bool_t b_snapshot; /**< take one snapshot on the next loop */
506 /* Video output configuration */
507 config_chain_t *p_cfg;
509 /* Show media title on videoutput */
510 vlc_bool_t b_title_show;
511 mtime_t i_title_timeout;
512 int i_title_position;
515 #define I_OUTPUTPICTURES p_vout->output.i_pictures
516 #define PP_OUTPUTPICTURE p_vout->output.pp_picture
517 #define I_RENDERPICTURES p_vout->render.i_pictures
518 #define PP_RENDERPICTURE p_vout->render.pp_picture
520 /** \defgroup vout_changes Flags for changes
521 * These flags are set in the vout_thread_t::i_changes field when another
522 * thread changed a variable
525 /** b_info changed */
526 #define VOUT_INFO_CHANGE 0x0001
527 /** b_grayscale changed */
528 #define VOUT_GRAYSCALE_CHANGE 0x0002
529 /** b_interface changed */
530 #define VOUT_INTF_CHANGE 0x0004
531 /** b_scale changed */
532 #define VOUT_SCALE_CHANGE 0x0008
534 #define VOUT_GAMMA_CHANGE 0x0010
535 /** b_cursor changed */
536 #define VOUT_CURSOR_CHANGE 0x0020
537 /** b_fullscreen changed */
538 #define VOUT_FULLSCREEN_CHANGE 0x0040
540 #define VOUT_SIZE_CHANGE 0x0200
542 #define VOUT_DEPTH_CHANGE 0x0400
543 /** change chroma tables */
544 #define VOUT_CHROMA_CHANGE 0x0800
545 /** cropping parameters changed */
546 #define VOUT_CROP_CHANGE 0x1000
547 /** aspect ratio changed */
548 #define VOUT_ASPECT_CHANGE 0x2000
549 /** change/recreate picture buffers */
550 #define VOUT_PICTURE_BUFFERS_CHANGE 0x4000
553 /* Alignment flags */
554 #define VOUT_ALIGN_LEFT 0x0001
555 #define VOUT_ALIGN_RIGHT 0x0002
556 #define VOUT_ALIGN_HMASK 0x0003
557 #define VOUT_ALIGN_TOP 0x0004
558 #define VOUT_ALIGN_BOTTOM 0x0008
559 #define VOUT_ALIGN_VMASK 0x000C
561 #define MAX_JITTER_SAMPLES 20
563 /*****************************************************************************
565 *****************************************************************************/
566 #define vout_Request(a,b,c) __vout_Request(VLC_OBJECT(a),b,c)
567 VLC_EXPORT( vout_thread_t *, __vout_Request, ( vlc_object_t *, vout_thread_t *, video_format_t * ) );
568 #define vout_Create(a,b) __vout_Create(VLC_OBJECT(a),b)
569 VLC_EXPORT( vout_thread_t *, __vout_Create, ( vlc_object_t *, video_format_t * ) );
570 VLC_EXPORT( void, vout_Destroy, ( vout_thread_t * ) );
571 VLC_EXPORT( int, vout_VarCallback, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
573 VLC_EXPORT( int, vout_ChromaCmp, ( uint32_t, uint32_t ) );
575 VLC_EXPORT( picture_t *, vout_CreatePicture, ( vout_thread_t *, vlc_bool_t, vlc_bool_t, unsigned int ) );
576 VLC_EXPORT( void, vout_InitFormat, ( video_frame_format_t *, uint32_t, int, int, int ) );
577 VLC_EXPORT( void, vout_DestroyPicture, ( vout_thread_t *, picture_t * ) );
578 VLC_EXPORT( void, vout_DisplayPicture, ( vout_thread_t *, picture_t * ) );
579 VLC_EXPORT( void, vout_DatePicture, ( vout_thread_t *, picture_t *, mtime_t ) );
580 VLC_EXPORT( void, vout_LinkPicture, ( vout_thread_t *, picture_t * ) );
581 VLC_EXPORT( void, vout_UnlinkPicture, ( vout_thread_t *, picture_t * ) );
582 VLC_EXPORT( void, vout_PlacePicture, ( vout_thread_t *, unsigned int, unsigned int, unsigned int *, unsigned int *, unsigned int *, unsigned int * ) );
583 picture_t * vout_RenderPicture ( vout_thread_t *, picture_t *,
586 VLC_EXPORT( int, vout_vaControlDefault, ( vout_thread_t *, int, va_list ) );
587 VLC_EXPORT( void *, vout_RequestWindow, ( vout_thread_t *, int *, int *, unsigned int *, unsigned int * ) );
588 VLC_EXPORT( void, vout_ReleaseWindow, ( vout_thread_t *, void * ) );
589 VLC_EXPORT( int, vout_ControlWindow, ( vout_thread_t *, void *, int, va_list ) );
590 void vout_IntfInit( vout_thread_t * );
591 VLC_EXPORT( int, vout_Snapshot, ( vout_thread_t *p_vout, picture_t *p_pic ) );
592 VLC_EXPORT( void, vout_EnableFilter, ( vout_thread_t *, char *,vlc_bool_t , vlc_bool_t ) );
595 static inline int vout_vaControl( vout_thread_t *p_vout, int i_query,
598 if( p_vout->pf_control )
599 return p_vout->pf_control( p_vout, i_query, args );
604 static inline int vout_Control( vout_thread_t *p_vout, int i_query, ... )
609 va_start( args, i_query );
610 i_result = vout_vaControl( p_vout, i_query, args );
617 VOUT_GET_SIZE, /* arg1= unsigned int*, arg2= unsigned int*, res= */
618 VOUT_SET_SIZE, /* arg1= unsigned int, arg2= unsigned int, res= */
619 VOUT_SET_STAY_ON_TOP, /* arg1= vlc_bool_t res= */
623 VOUT_SET_FOCUS, /* arg1= vlc_bool_t res= */
624 VOUT_SET_VIEWPORT, /* arg1= view rect, arg2=clip rect, res= */
625 VOUT_REDRAW_RECT, /* arg1= area rect, res= */
628 typedef struct snapshot_t {
629 char *p_data; /* Data area */
631 int i_width; /* In pixels */
632 int i_height; /* In pixels */
633 int i_datasize; /* In bytes */
634 mtime_t date; /* Presentation time */
639 #endif /* _VLC_VIDEO_H */