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 * This function will increase the picture reference count.
120 * It will not have any effect on picture obtained from vout
122 static inline void picture_Yield( picture_t *p_picture )
124 if( p_picture->pf_release )
125 p_picture->i_refcount++;
128 * This function will release a picture.
129 * It will not have any effect on picture obtained from vout
131 static inline void picture_Release( picture_t *p_picture )
133 /* FIXME why do we let pf_release handle the i_refcount ? */
134 if( p_picture->pf_release )
135 p_picture->pf_release( p_picture );
139 * This function will copy all picture dynamic properties.
141 static inline void picture_CopyProperties( picture_t *p_dst, const picture_t *p_src )
143 p_dst->date = p_src->date;
144 p_dst->b_force = p_src->b_force;
146 p_dst->b_progressive = p_src->b_progressive;
147 p_dst->i_nb_fields = p_src->i_nb_fields;
148 p_dst->b_top_field_first = p_src->b_top_field_first;
152 * Video picture heap, either render (to store pictures used
153 * by the decoder) or output (to store pictures displayed by the vout plugin)
155 struct picture_heap_t
157 int i_pictures; /**< current heap size */
159 /* \name Picture static properties
160 * Those properties are fixed at initialization and should NOT be modified
163 unsigned int i_width; /**< picture width */
164 unsigned int i_height; /**< picture height */
165 vlc_fourcc_t i_chroma; /**< picture chroma */
166 unsigned int i_aspect; /**< aspect ratio */
170 picture_t* pp_picture[VOUT_MAX_PICTURES]; /**< pictures */
171 int i_last_used_pic; /**< last used pic in heap */
172 bool b_allow_modify_pics;
174 /* Stuff used for truecolor RGB planes */
175 uint32_t i_rmask; int i_rrshift, i_lrshift;
176 uint32_t i_gmask; int i_rgshift, i_lgshift;
177 uint32_t i_bmask; int i_rbshift, i_lbshift;
179 /** Stuff used for palettized RGB planes */
180 void (* pf_setpalette) ( vout_thread_t *, uint16_t *, uint16_t *, uint16_t * );
183 /*****************************************************************************
184 * Flags used to describe the status of a picture
185 *****************************************************************************/
188 #define EMPTY_PICTURE 0 /* empty buffer */
189 #define MEMORY_PICTURE 100 /* heap-allocated buffer */
190 #define DIRECT_PICTURE 200 /* direct buffer */
193 #define FREE_PICTURE 0 /* free and not allocated */
194 #define RESERVED_PICTURE 1 /* allocated and reserved */
195 #define RESERVED_DATED_PICTURE 2 /* waiting for DisplayPicture */
196 #define RESERVED_DISP_PICTURE 3 /* waiting for a DatePicture */
197 #define READY_PICTURE 4 /* ready for display */
198 #define DISPLAYED_PICTURE 5 /* been displayed but is linked */
199 #define DESTROYED_PICTURE 6 /* allocated but no more used */
201 /*****************************************************************************
202 * Shortcuts to access image components
203 *****************************************************************************/
212 #define Y_PIXELS p[Y_PLANE].p_pixels
213 #define Y_PITCH p[Y_PLANE].i_pitch
214 #define U_PIXELS p[U_PLANE].p_pixels
215 #define U_PITCH p[U_PLANE].i_pitch
216 #define V_PIXELS p[V_PLANE].p_pixels
217 #define V_PITCH p[V_PLANE].i_pitch
218 #define A_PIXELS p[A_PLANE].p_pixels
219 #define A_PITCH p[A_PLANE].i_pitch
222 * \defgroup subpicture Video Subpictures
223 * Subpictures are pictures that should be displayed on top of the video, like
225 * \ingroup video_output
230 * Video subtitle region
232 * A subtitle region is defined by a picture (graphic) and its rendering
234 * Subtitles contain a list of regions.
236 struct subpicture_region_t
238 video_format_t fmt; /**< format of the picture */
239 picture_t picture; /**< picture comprising this region */
241 int i_x; /**< position of region */
242 int i_y; /**< position of region */
243 int i_align; /**< alignment within a region */
244 int i_alpha; /**< transparency */
246 char *psz_text; /**< text string comprising this region */
247 char *psz_html; /**< HTML version of subtitle (NULL = use psz_text) */
248 text_style_t *p_style; /**< a description of the text style formatting */
250 subpicture_region_t *p_next; /**< next region in the list */
251 subpicture_region_t *p_cache; /**< modified version of this region */
257 * Any subtitle destined to be displayed by a video output thread should
258 * be stored in this structure from it's creation to it's effective display.
259 * Subtitle type and flags should only be modified by the output thread. Note
260 * that an empty subtitle MUST have its flags set to 0.
264 /** \name Channel ID */
266 int i_channel; /**< subpicture channel ID */
269 /** \name Type and flags
270 Should NOT be modified except by the vout thread */
272 int i_type; /**< type */
273 int i_status; /**< flags */
274 subpicture_t * p_next; /**< next subtitle to be displayed */
277 /** \name Date properties */
279 mtime_t i_start; /**< beginning of display date */
280 mtime_t i_stop; /**< end of display date */
281 bool b_ephemer; /**< If this flag is set to true the subtitle
282 will be displayed untill the next one appear */
283 bool b_fade; /**< enable fading */
284 bool b_pausable; /**< subpicture will be paused if
288 subpicture_region_t *p_region; /**< region list composing this subtitle */
290 /** \name Display properties
291 * These properties are only indicative and may be
292 * changed by the video output thread, or simply ignored depending of the
295 int i_x; /**< offset from alignment position */
296 int i_y; /**< offset from alignment position */
297 int i_width; /**< picture width */
298 int i_height; /**< picture height */
299 int i_alpha; /**< transparency */
300 int i_original_picture_width; /**< original width of the movie */
301 int i_original_picture_height;/**< original height of the movie */
302 bool b_absolute; /**< position is absolute */
303 int i_flags; /**< position flags */
306 /** Pointer to function that renders this subtitle in a picture */
307 void ( *pf_render ) ( vout_thread_t *, picture_t *, const subpicture_t * );
308 /** Pointer to function that cleans up the private data of this subtitle */
309 void ( *pf_destroy ) ( subpicture_t * );
311 /** Pointer to functions for region management */
312 subpicture_region_t * ( *pf_create_region ) ( vlc_object_t *,
314 subpicture_region_t * ( *pf_make_region ) ( vlc_object_t *,
315 video_format_t *, picture_t * );
316 void ( *pf_destroy_region ) ( vlc_object_t *, subpicture_region_t * );
318 void ( *pf_pre_render ) ( video_format_t *, spu_t *, subpicture_t *, mtime_t );
319 subpicture_region_t * ( *pf_update_regions ) ( video_format_t *, spu_t *,
320 subpicture_t *, mtime_t );
322 /** Private data - the subtitle plugin might want to put stuff here to
323 * keep track of the subpicture */
324 subpicture_sys_t *p_sys; /* subpicture data */
327 /* Subpicture type */
328 #define EMPTY_SUBPICTURE 0 /* subtitle slot is empty and available */
329 #define MEMORY_SUBPICTURE 100 /* subpicture stored in memory */
331 /* Default subpicture channel ID */
332 #define DEFAULT_CHAN 1
334 /* Subpicture status */
335 #define FREE_SUBPICTURE 0 /* free and not allocated */
336 #define RESERVED_SUBPICTURE 1 /* allocated and reserved */
337 #define READY_SUBPICTURE 2 /* ready for display */
339 /* Subpicture position flags */
340 #define SUBPICTURE_ALIGN_LEFT 0x1
341 #define SUBPICTURE_ALIGN_RIGHT 0x2
342 #define SUBPICTURE_ALIGN_TOP 0x4
343 #define SUBPICTURE_ALIGN_BOTTOM 0x8
344 #define SUBPICTURE_ALIGN_MASK ( SUBPICTURE_ALIGN_LEFT|SUBPICTURE_ALIGN_RIGHT| \
345 SUBPICTURE_ALIGN_TOP |SUBPICTURE_ALIGN_BOTTOM )
347 /* Subpicture rendered flag - should only be used by vout_subpictures */
348 #define SUBPICTURE_RENDERED 0x10
350 /*****************************************************************************
352 *****************************************************************************/
355 * Copy the source picture onto the destination picture.
356 * \param p_this a vlc object
357 * \param p_dst pointer to the destination picture.
358 * \param p_src pointer to the source picture.
360 #define vout_CopyPicture(a,b,c) __vout_CopyPicture(VLC_OBJECT(a),b,c)
361 VLC_EXPORT( void, __vout_CopyPicture, ( vlc_object_t *p_this, picture_t *p_dst, picture_t *p_src ) );
364 * Initialise different fields of a picture_t (but does not allocate memory).
365 * \param p_this a vlc object
366 * \param p_pic pointer to the picture structure.
367 * \param i_chroma the wanted chroma for the picture.
368 * \param i_width the wanted width for the picture.
369 * \param i_height the wanted height for the picture.
370 * \param i_aspect the wanted aspect ratio for the picture.
372 #define vout_InitPicture(a,b,c,d,e,f) \
373 __vout_InitPicture(VLC_OBJECT(a),b,c,d,e,f)
374 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 ) );
377 * Initialise different fields of a picture_t and allocates the picture buffer.
378 * \param p_this a vlc object
379 * \param p_pic pointer to the picture structure.
380 * \param i_chroma the wanted chroma for the picture.
381 * \param i_width the wanted width for the picture.
382 * \param i_height the wanted height for the picture.
383 * \param i_aspect the wanted aspect ratio for the picture.
385 #define vout_AllocatePicture(a,b,c,d,e,f) \
386 __vout_AllocatePicture(VLC_OBJECT(a),b,c,d,e,f)
387 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 ) );
391 * \defgroup video_output Video Output
392 * This module describes the programming interface for video output threads.
393 * It includes functions allowing to open a new thread, send pictures to a
394 * thread, and destroy a previously opened video output thread.
399 * Video output thread descriptor
401 * Any independent video output device, such as an X11 window or a GGI device,
402 * is represented by a video output thread, and described using the following
409 /** \name Thread properties and locks */
411 vlc_mutex_t picture_lock; /**< picture heap lock */
412 vlc_mutex_t subpicture_lock; /**< subpicture heap lock */
413 vlc_mutex_t change_lock; /**< thread change lock */
414 vlc_mutex_t vfilter_lock; /**< video filter2 change lock */
415 vout_sys_t * p_sys; /**< system output method */
418 /** \name Current display properties */
420 uint16_t i_changes; /**< changes made to the thread.
421 \see \ref vout_changes */
422 float f_gamma; /**< gamma */
423 bool b_grayscale; /**< color or grayscale display */
424 bool b_info; /**< print additional information */
425 bool b_interface; /**< render interface */
426 bool b_scale; /**< allow picture scaling */
427 bool b_fullscreen; /**< toogle fullscreen display */
428 uint32_t render_time; /**< last picture render time */
429 unsigned int i_window_width; /**< video window width */
430 unsigned int i_window_height; /**< video window height */
431 unsigned int i_alignment; /**< video alignment in window */
432 unsigned int i_par_num; /**< monitor pixel aspect-ratio */
433 unsigned int i_par_den; /**< monitor pixel aspect-ratio */
435 struct vout_window_t *p_window; /**< window for embedded vout (if any) */
438 /** \name Plugin used and shortcuts to access its capabilities */
441 int ( *pf_init ) ( vout_thread_t * );
442 void ( *pf_end ) ( vout_thread_t * );
443 int ( *pf_manage ) ( vout_thread_t * );
444 void ( *pf_render ) ( vout_thread_t *, picture_t * );
445 void ( *pf_display ) ( vout_thread_t *, picture_t * );
446 void ( *pf_swap ) ( vout_thread_t * ); /* OpenGL only */
447 int ( *pf_lock ) ( vout_thread_t * ); /* OpenGL only */
448 void ( *pf_unlock ) ( vout_thread_t * ); /* OpenGL only */
449 int ( *pf_control ) ( vout_thread_t *, int, va_list );
453 * These numbers are not supposed to be accurate, but are a
454 * good indication of the thread status */
456 count_t c_fps_samples; /**< picture counts */
457 mtime_t p_fps_sample[VOUT_FPS_SAMPLES]; /**< FPS samples dates */
460 /** \name Video heap and translation tables */
462 int i_heap_size; /**< heap size */
463 picture_heap_t render; /**< rendered pictures */
464 picture_heap_t output; /**< direct buffers */
465 bool b_direct; /**< rendered are like direct ? */
466 filter_t *p_chroma; /**< translation tables */
468 video_format_t fmt_render; /* render format (from the decoder) */
469 video_format_t fmt_in; /* input (modified render) format */
470 video_format_t fmt_out; /* output format (for the video output) */
474 picture_t p_picture[2*VOUT_MAX_PICTURES+1]; /**< pictures */
476 /* Subpicture unit */
481 count_t c_pictures, c_late_pictures;
482 mtime_t display_jitter; /**< average deviation from the PTS */
483 count_t c_jitter_samples; /**< number of samples used
484 for the calculation of the
486 /** delay created by internal caching */
490 char *psz_filter_chain;
491 bool b_filter_change;
493 /* Video filter2 chain */
494 filter_chain_t *p_vf2_chain;
498 bool b_snapshot; /**< take one snapshot on the next loop */
500 /* Video output configuration */
501 config_chain_t *p_cfg;
503 /* Show media title on videoutput */
505 mtime_t i_title_timeout;
506 int i_title_position;
509 #define I_OUTPUTPICTURES p_vout->output.i_pictures
510 #define PP_OUTPUTPICTURE p_vout->output.pp_picture
511 #define I_RENDERPICTURES p_vout->render.i_pictures
512 #define PP_RENDERPICTURE p_vout->render.pp_picture
514 /** \defgroup vout_changes Flags for changes
515 * These flags are set in the vout_thread_t::i_changes field when another
516 * thread changed a variable
519 /** b_info changed */
520 #define VOUT_INFO_CHANGE 0x0001
521 /** b_grayscale changed */
522 #define VOUT_GRAYSCALE_CHANGE 0x0002
523 /** b_interface changed */
524 #define VOUT_INTF_CHANGE 0x0004
525 /** b_scale changed */
526 #define VOUT_SCALE_CHANGE 0x0008
528 #define VOUT_GAMMA_CHANGE 0x0010
529 /** b_cursor changed */
530 #define VOUT_CURSOR_CHANGE 0x0020
531 /** b_fullscreen changed */
532 #define VOUT_FULLSCREEN_CHANGE 0x0040
534 #define VOUT_SIZE_CHANGE 0x0200
536 #define VOUT_DEPTH_CHANGE 0x0400
537 /** change chroma tables */
538 #define VOUT_CHROMA_CHANGE 0x0800
539 /** cropping parameters changed */
540 #define VOUT_CROP_CHANGE 0x1000
541 /** aspect ratio changed */
542 #define VOUT_ASPECT_CHANGE 0x2000
543 /** change/recreate picture buffers */
544 #define VOUT_PICTURE_BUFFERS_CHANGE 0x4000
547 /* Alignment flags */
548 #define VOUT_ALIGN_LEFT 0x0001
549 #define VOUT_ALIGN_RIGHT 0x0002
550 #define VOUT_ALIGN_HMASK 0x0003
551 #define VOUT_ALIGN_TOP 0x0004
552 #define VOUT_ALIGN_BOTTOM 0x0008
553 #define VOUT_ALIGN_VMASK 0x000C
555 #define MAX_JITTER_SAMPLES 20
557 /*****************************************************************************
559 *****************************************************************************/
563 * - returns a suitable vout (if requested by a non NULL p_fmt)
564 * - recycles an old vout (if given) by either destroying it or by saving it
567 * The purpose of this function is to avoid unnecessary creation/destruction of
568 * vout (and to allow optional vout reusing).
570 * You can call vout_Request on a vout created by vout_Create or by a previous
571 * call to vout_Request.
572 * You can release the returned value either by vout_Request or vout_Close()
573 * followed by a vlc_object_release() or shorter vout_CloseAndRelease()
575 * \param p_this a vlc object
576 * \param p_vout a vout candidate
577 * \param p_fmt the video format requested or NULL
578 * \return a vout if p_fmt is non NULL and the request is successfull, NULL
581 #define vout_Request(a,b,c) __vout_Request(VLC_OBJECT(a),b,c)
582 VLC_EXPORT( vout_thread_t *, __vout_Request, ( vlc_object_t *p_this, vout_thread_t *p_vout, video_format_t *p_fmt ) );
585 * This function will create a suitable vout for a given p_fmt. It will never
586 * reuse an already existing unused vout.
588 * You have to call either vout_Destroy or vout_Request on the returned value
589 * \param p_this a vlc object to which the returned vout will be attached
590 * \param p_fmt the video format requested
591 * \return a vout if the request is successfull, NULL otherwise
593 #define vout_Create(a,b) __vout_Create(VLC_OBJECT(a),b)
594 VLC_EXPORT( vout_thread_t *, __vout_Create, ( vlc_object_t *p_this, video_format_t *p_fmt ) );
597 * This function will close a vout created by vout_Create or vout_Request.
598 * The associated vout module is closed.
599 * Note: It is not released yet, you'll have to call vlc_object_release()
600 * or use the convenient vout_CloseAndRelease().
602 * \param p_vout the vout to close
604 VLC_EXPORT( void, vout_Close, ( vout_thread_t *p_vout ) );
607 * This function will close a vout created by vout_Create
608 * and then release it.
610 * \param p_vout the vout to close and release
612 static inline void vout_CloseAndRelease( vout_thread_t *p_vout )
614 vout_Close( p_vout );
615 vlc_object_release( p_vout );
619 VLC_EXPORT( int, vout_ChromaCmp, ( uint32_t, uint32_t ) );
621 VLC_EXPORT( picture_t *, vout_CreatePicture, ( vout_thread_t *, bool, bool, unsigned int ) );
622 VLC_EXPORT( void, vout_InitFormat, ( video_frame_format_t *, uint32_t, int, int, int ) );
623 VLC_EXPORT( void, vout_DestroyPicture, ( vout_thread_t *, picture_t * ) );
624 VLC_EXPORT( void, vout_DisplayPicture, ( vout_thread_t *, picture_t * ) );
625 VLC_EXPORT( void, vout_DatePicture, ( vout_thread_t *, picture_t *, mtime_t ) );
626 VLC_EXPORT( void, vout_LinkPicture, ( vout_thread_t *, picture_t * ) );
627 VLC_EXPORT( void, vout_UnlinkPicture, ( vout_thread_t *, picture_t * ) );
628 VLC_EXPORT( void, vout_PlacePicture, ( vout_thread_t *, unsigned int, unsigned int, unsigned int *, unsigned int *, unsigned int *, unsigned int * ) );
629 picture_t * vout_RenderPicture ( vout_thread_t *, picture_t *,
632 VLC_EXPORT( int, vout_vaControlDefault, ( vout_thread_t *, int, va_list ) );
633 VLC_EXPORT( void *, vout_RequestWindow, ( vout_thread_t *, int *, int *, unsigned int *, unsigned int * ) );
634 VLC_EXPORT( void, vout_ReleaseWindow, ( vout_thread_t *, void * ) );
635 VLC_EXPORT( int, vout_ControlWindow, ( vout_thread_t *, void *, int, va_list ) );
636 void vout_IntfInit( vout_thread_t * );
637 VLC_EXPORT( int, vout_Snapshot, ( vout_thread_t *p_vout, picture_t *p_pic ) );
638 VLC_EXPORT( void, vout_EnableFilter, ( vout_thread_t *, char *,bool , bool ) );
641 static inline int vout_vaControl( vout_thread_t *p_vout, int i_query,
644 if( p_vout->pf_control )
645 return p_vout->pf_control( p_vout, i_query, args );
650 static inline int vout_Control( vout_thread_t *p_vout, int i_query, ... )
655 va_start( args, i_query );
656 i_result = vout_vaControl( p_vout, i_query, args );
663 VOUT_GET_SIZE, /* arg1= unsigned int*, arg2= unsigned int*, res= */
664 VOUT_SET_SIZE, /* arg1= unsigned int, arg2= unsigned int, res= */
665 VOUT_SET_STAY_ON_TOP, /* arg1= bool res= */
669 VOUT_SET_FOCUS, /* arg1= bool res= */
670 VOUT_SET_VIEWPORT, /* arg1= view rect, arg2=clip rect, res= */
671 VOUT_REDRAW_RECT, /* arg1= area rect, res= */
674 typedef struct snapshot_t {
675 char *p_data; /* Data area */
677 int i_width; /* In pixels */
678 int i_height; /* In pixels */
679 int i_datasize; /* In bytes */
680 mtime_t date; /* Presentation time */
685 #endif /* _VLC_VIDEO_H */