1 /*****************************************************************************
2 * vlc_video.h: common video definitions
3 *****************************************************************************
4 * Copyright (C) 1999 - 2008 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 *****************************************************************************/
27 #define _VLC_VOUT_H_ 1
30 #include <vlc_filter.h>
32 /** 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 bool 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 unsigned 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 bool b_progressive; /**< is it a progressive frame ? */
96 unsigned int i_nb_fields; /**< # of displayed fields */
97 bool 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 bool 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 */
211 int i_alpha; /**< transparency */
213 char *psz_text; /**< text string comprising this region */
214 char *psz_html; /**< HTML version of subtitle (NULL = use psz_text) */
215 text_style_t *p_style; /**< a description of the text style formatting */
217 subpicture_region_t *p_next; /**< next region in the list */
218 subpicture_region_t *p_cache; /**< modified version of this region */
224 * Any subtitle destined to be displayed by a video output thread should
225 * be stored in this structure from it's creation to it's effective display.
226 * Subtitle type and flags should only be modified by the output thread. Note
227 * that an empty subtitle MUST have its flags set to 0.
231 /** \name Channel ID */
233 int i_channel; /**< subpicture channel ID */
236 /** \name Type and flags
237 Should NOT be modified except by the vout thread */
239 int i_type; /**< type */
240 int i_status; /**< flags */
241 subpicture_t * p_next; /**< next subtitle to be displayed */
244 /** \name Date properties */
246 mtime_t i_start; /**< beginning of display date */
247 mtime_t i_stop; /**< end of display date */
248 bool b_ephemer; /**< If this flag is set to true the subtitle
249 will be displayed untill the next one appear */
250 bool b_fade; /**< enable fading */
251 bool b_pausable; /**< subpicture will be paused if
255 subpicture_region_t *p_region; /**< region list composing this subtitle */
257 /** \name Display properties
258 * These properties are only indicative and may be
259 * changed by the video output thread, or simply ignored depending of the
262 int i_x; /**< offset from alignment position */
263 int i_y; /**< offset from alignment position */
264 int i_width; /**< picture width */
265 int i_height; /**< picture height */
266 int i_alpha; /**< transparency */
267 int i_original_picture_width; /**< original width of the movie */
268 int i_original_picture_height;/**< original height of the movie */
269 bool b_absolute; /**< position is absolute */
270 int i_flags; /**< position flags */
273 /** Pointer to function that renders this subtitle in a picture */
274 void ( *pf_render ) ( vout_thread_t *, picture_t *, const subpicture_t * );
275 /** Pointer to function that cleans up the private data of this subtitle */
276 void ( *pf_destroy ) ( subpicture_t * );
278 /** Pointer to functions for region management */
279 subpicture_region_t * ( *pf_create_region ) ( vlc_object_t *,
281 subpicture_region_t * ( *pf_make_region ) ( vlc_object_t *,
282 video_format_t *, picture_t * );
283 void ( *pf_destroy_region ) ( vlc_object_t *, subpicture_region_t * );
285 void ( *pf_pre_render ) ( video_format_t *, spu_t *, subpicture_t *, mtime_t );
286 subpicture_region_t * ( *pf_update_regions ) ( video_format_t *, spu_t *,
287 subpicture_t *, mtime_t );
289 /** Private data - the subtitle plugin might want to put stuff here to
290 * keep track of the subpicture */
291 subpicture_sys_t *p_sys; /* subpicture data */
294 /* Subpicture type */
295 #define EMPTY_SUBPICTURE 0 /* subtitle slot is empty and available */
296 #define MEMORY_SUBPICTURE 100 /* subpicture stored in memory */
298 /* Default subpicture channel ID */
299 #define DEFAULT_CHAN 1
301 /* Subpicture status */
302 #define FREE_SUBPICTURE 0 /* free and not allocated */
303 #define RESERVED_SUBPICTURE 1 /* allocated and reserved */
304 #define READY_SUBPICTURE 2 /* ready for display */
306 /* Subpicture position flags */
307 #define SUBPICTURE_ALIGN_LEFT 0x1
308 #define SUBPICTURE_ALIGN_RIGHT 0x2
309 #define SUBPICTURE_ALIGN_TOP 0x4
310 #define SUBPICTURE_ALIGN_BOTTOM 0x8
311 #define SUBPICTURE_ALIGN_MASK ( SUBPICTURE_ALIGN_LEFT|SUBPICTURE_ALIGN_RIGHT| \
312 SUBPICTURE_ALIGN_TOP |SUBPICTURE_ALIGN_BOTTOM )
314 /* Subpicture rendered flag - should only be used by vout_subpictures */
315 #define SUBPICTURE_RENDERED 0x10
317 /*****************************************************************************
319 *****************************************************************************/
322 * Copy the source picture onto the destination picture.
323 * \param p_this a vlc object
324 * \param p_dst pointer to the destination picture.
325 * \param p_src pointer to the source picture.
327 #define vout_CopyPicture(a,b,c) __vout_CopyPicture(VLC_OBJECT(a),b,c)
328 VLC_EXPORT( void, __vout_CopyPicture, ( vlc_object_t *p_this, picture_t *p_dst, picture_t *p_src ) );
331 * Initialise different fields of a picture_t (but does not allocate memory).
332 * \param p_this a vlc object
333 * \param p_pic pointer to the picture structure.
334 * \param i_chroma the wanted chroma for the picture.
335 * \param i_width the wanted width for the picture.
336 * \param i_height the wanted height for the picture.
337 * \param i_aspect the wanted aspect ratio for the picture.
339 #define vout_InitPicture(a,b,c,d,e,f) \
340 __vout_InitPicture(VLC_OBJECT(a),b,c,d,e,f)
341 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 ) );
344 * Initialise different fields of a picture_t and allocates the picture buffer.
345 * \param p_this a vlc object
346 * \param p_pic pointer to the picture structure.
347 * \param i_chroma the wanted chroma for the picture.
348 * \param i_width the wanted width for the picture.
349 * \param i_height the wanted height for the picture.
350 * \param i_aspect the wanted aspect ratio for the picture.
352 #define vout_AllocatePicture(a,b,c,d,e,f) \
353 __vout_AllocatePicture(VLC_OBJECT(a),b,c,d,e,f)
354 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 ) );
358 * \defgroup video_output Video Output
359 * This module describes the programming interface for video output threads.
360 * It includes functions allowing to open a new thread, send pictures to a
361 * thread, and destroy a previously opened video output thread.
366 * Video output thread descriptor
368 * Any independent video output device, such as an X11 window or a GGI device,
369 * is represented by a video output thread, and described using the following
376 /** \name Thread properties and locks */
378 vlc_mutex_t picture_lock; /**< picture heap lock */
379 vlc_mutex_t subpicture_lock; /**< subpicture heap lock */
380 vlc_mutex_t change_lock; /**< thread change lock */
381 vlc_mutex_t vfilter_lock; /**< video filter2 change lock */
382 vout_sys_t * p_sys; /**< system output method */
385 /** \name Current display properties */
387 uint16_t i_changes; /**< changes made to the thread.
388 \see \ref vout_changes */
389 float f_gamma; /**< gamma */
390 bool b_grayscale; /**< color or grayscale display */
391 bool b_info; /**< print additional information */
392 bool b_interface; /**< render interface */
393 bool b_scale; /**< allow picture scaling */
394 bool b_fullscreen; /**< toogle fullscreen display */
395 uint32_t render_time; /**< last picture render time */
396 unsigned int i_window_width; /**< video window width */
397 unsigned int i_window_height; /**< video window height */
398 unsigned int i_alignment; /**< video alignment in window */
399 unsigned int i_par_num; /**< monitor pixel aspect-ratio */
400 unsigned int i_par_den; /**< monitor pixel aspect-ratio */
402 struct vout_window_t *p_window; /**< window for embedded vout (if any) */
405 /** \name Plugin used and shortcuts to access its capabilities */
408 int ( *pf_init ) ( vout_thread_t * );
409 void ( *pf_end ) ( vout_thread_t * );
410 int ( *pf_manage ) ( vout_thread_t * );
411 void ( *pf_render ) ( vout_thread_t *, picture_t * );
412 void ( *pf_display ) ( vout_thread_t *, picture_t * );
413 void ( *pf_swap ) ( vout_thread_t * ); /* OpenGL only */
414 int ( *pf_lock ) ( vout_thread_t * ); /* OpenGL only */
415 void ( *pf_unlock ) ( vout_thread_t * ); /* OpenGL only */
416 int ( *pf_control ) ( vout_thread_t *, int, va_list );
420 * These numbers are not supposed to be accurate, but are a
421 * good indication of the thread status */
423 count_t c_fps_samples; /**< picture counts */
424 mtime_t p_fps_sample[VOUT_FPS_SAMPLES]; /**< FPS samples dates */
427 /** \name Video heap and translation tables */
429 int i_heap_size; /**< heap size */
430 picture_heap_t render; /**< rendered pictures */
431 picture_heap_t output; /**< direct buffers */
432 bool b_direct; /**< rendered are like direct ? */
433 filter_t *p_chroma; /**< translation tables */
435 video_format_t fmt_render; /* render format (from the decoder) */
436 video_format_t fmt_in; /* input (modified render) format */
437 video_format_t fmt_out; /* output format (for the video output) */
441 picture_t p_picture[2*VOUT_MAX_PICTURES+1]; /**< pictures */
443 /* Subpicture unit */
448 count_t c_pictures, c_late_pictures;
449 mtime_t display_jitter; /**< average deviation from the PTS */
450 count_t c_jitter_samples; /**< number of samples used
451 for the calculation of the
453 /** delay created by internal caching */
457 char *psz_filter_chain;
458 bool b_filter_change;
460 /* Video filter2 chain */
461 filter_chain_t *p_vf2_chain;
465 bool b_snapshot; /**< take one snapshot on the next loop */
467 /* Video output configuration */
468 config_chain_t *p_cfg;
470 /* Show media title on videoutput */
472 mtime_t i_title_timeout;
473 int i_title_position;
476 #define I_OUTPUTPICTURES p_vout->output.i_pictures
477 #define PP_OUTPUTPICTURE p_vout->output.pp_picture
478 #define I_RENDERPICTURES p_vout->render.i_pictures
479 #define PP_RENDERPICTURE p_vout->render.pp_picture
481 /** \defgroup vout_changes Flags for changes
482 * These flags are set in the vout_thread_t::i_changes field when another
483 * thread changed a variable
486 /** b_info changed */
487 #define VOUT_INFO_CHANGE 0x0001
488 /** b_grayscale changed */
489 #define VOUT_GRAYSCALE_CHANGE 0x0002
490 /** b_interface changed */
491 #define VOUT_INTF_CHANGE 0x0004
492 /** b_scale changed */
493 #define VOUT_SCALE_CHANGE 0x0008
495 #define VOUT_GAMMA_CHANGE 0x0010
496 /** b_cursor changed */
497 #define VOUT_CURSOR_CHANGE 0x0020
498 /** b_fullscreen changed */
499 #define VOUT_FULLSCREEN_CHANGE 0x0040
501 #define VOUT_SIZE_CHANGE 0x0200
503 #define VOUT_DEPTH_CHANGE 0x0400
504 /** change chroma tables */
505 #define VOUT_CHROMA_CHANGE 0x0800
506 /** cropping parameters changed */
507 #define VOUT_CROP_CHANGE 0x1000
508 /** aspect ratio changed */
509 #define VOUT_ASPECT_CHANGE 0x2000
510 /** change/recreate picture buffers */
511 #define VOUT_PICTURE_BUFFERS_CHANGE 0x4000
514 /* Alignment flags */
515 #define VOUT_ALIGN_LEFT 0x0001
516 #define VOUT_ALIGN_RIGHT 0x0002
517 #define VOUT_ALIGN_HMASK 0x0003
518 #define VOUT_ALIGN_TOP 0x0004
519 #define VOUT_ALIGN_BOTTOM 0x0008
520 #define VOUT_ALIGN_VMASK 0x000C
522 #define MAX_JITTER_SAMPLES 20
524 /*****************************************************************************
526 *****************************************************************************/
527 #define vout_Request(a,b,c) __vout_Request(VLC_OBJECT(a),b,c)
528 VLC_EXPORT( vout_thread_t *, __vout_Request, ( vlc_object_t *, vout_thread_t *, video_format_t * ) );
529 #define vout_Create(a,b) __vout_Create(VLC_OBJECT(a),b)
530 VLC_EXPORT( vout_thread_t *, __vout_Create, ( vlc_object_t *, video_format_t * ) );
531 VLC_EXPORT( int, vout_VarCallback, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
533 VLC_EXPORT( int, vout_ChromaCmp, ( uint32_t, uint32_t ) );
535 VLC_EXPORT( picture_t *, vout_CreatePicture, ( vout_thread_t *, bool, bool, unsigned int ) );
536 VLC_EXPORT( void, vout_InitFormat, ( video_frame_format_t *, uint32_t, int, int, int ) );
537 VLC_EXPORT( void, vout_DestroyPicture, ( vout_thread_t *, picture_t * ) );
538 VLC_EXPORT( void, vout_DisplayPicture, ( vout_thread_t *, picture_t * ) );
539 VLC_EXPORT( void, vout_DatePicture, ( vout_thread_t *, picture_t *, mtime_t ) );
540 VLC_EXPORT( void, vout_LinkPicture, ( vout_thread_t *, picture_t * ) );
541 VLC_EXPORT( void, vout_UnlinkPicture, ( vout_thread_t *, picture_t * ) );
542 VLC_EXPORT( void, vout_PlacePicture, ( vout_thread_t *, unsigned int, unsigned int, unsigned int *, unsigned int *, unsigned int *, unsigned int * ) );
543 picture_t * vout_RenderPicture ( vout_thread_t *, picture_t *,
546 VLC_EXPORT( int, vout_vaControlDefault, ( vout_thread_t *, int, va_list ) );
547 VLC_EXPORT( void *, vout_RequestWindow, ( vout_thread_t *, int *, int *, unsigned int *, unsigned int * ) );
548 VLC_EXPORT( void, vout_ReleaseWindow, ( vout_thread_t *, void * ) );
549 VLC_EXPORT( int, vout_ControlWindow, ( vout_thread_t *, void *, int, va_list ) );
550 void vout_IntfInit( vout_thread_t * );
551 VLC_EXPORT( int, vout_Snapshot, ( vout_thread_t *p_vout, picture_t *p_pic ) );
552 VLC_EXPORT( void, vout_EnableFilter, ( vout_thread_t *, char *,bool , bool ) );
555 static inline int vout_vaControl( vout_thread_t *p_vout, int i_query,
558 if( p_vout->pf_control )
559 return p_vout->pf_control( p_vout, i_query, args );
564 static inline int vout_Control( vout_thread_t *p_vout, int i_query, ... )
569 va_start( args, i_query );
570 i_result = vout_vaControl( p_vout, i_query, args );
577 VOUT_GET_SIZE, /* arg1= unsigned int*, arg2= unsigned int*, res= */
578 VOUT_SET_SIZE, /* arg1= unsigned int, arg2= unsigned int, res= */
579 VOUT_SET_STAY_ON_TOP, /* arg1= bool res= */
583 VOUT_SET_FOCUS, /* arg1= bool res= */
584 VOUT_SET_VIEWPORT, /* arg1= view rect, arg2=clip rect, res= */
585 VOUT_REDRAW_RECT, /* arg1= area rect, res= */
588 typedef struct snapshot_t {
589 char *p_data; /* Data area */
591 int i_width; /* In pixels */
592 int i_height; /* In pixels */
593 int i_datasize; /* In bytes */
594 mtime_t date; /* Presentation time */
599 #endif /* _VLC_VIDEO_H */