adab0a665502cdcbc767c1732f2baea7f0d2481e
[vlc.git] / include / vlc_vout.h
1 /*****************************************************************************
2  * vlc_video.h: common video definitions
3  *****************************************************************************
4  * Copyright (C) 1999 - 2008 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Vincent Seguin <seguin@via.ecp.fr>
8  *          Samuel Hocevar <sam@via.ecp.fr>
9  *          Olivier Aubert <oaubert 47 videolan d07 org>
10  *
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.
15  *
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.
20  *
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  *****************************************************************************/
25
26 #ifndef VLC_VOUT_H_
27 #define VLC_VOUT_H_ 1
28
29 /**
30  * \file
31  * This file defines common video output structures and functions in vlc
32  */
33
34 #include <vlc_es.h>
35 #include <vlc_filter.h>
36
37 /** Description of a planar graphic field */
38 typedef struct plane_t
39 {
40     uint8_t *p_pixels;                        /**< Start of the plane's data */
41
42     /* Variables used for fast memcpy operations */
43     int i_lines;           /**< Number of lines, including margins */
44     int i_pitch;           /**< Number of bytes in a line, including margins */
45
46     /** Size of a macropixel, defaults to 1 */
47     int i_pixel_pitch;
48
49     /* Variables used for pictures with margins */
50     int i_visible_lines;            /**< How many visible lines are there ? */
51     int i_visible_pitch;            /**< How many visible pixels are there ? */
52
53 } plane_t;
54
55 /**
56  * Video picture
57  *
58  * Any picture destined to be displayed by a video output thread should be
59  * stored in this structure from it's creation to it's effective display.
60  * Picture type and flags should only be modified by the output thread. Note
61  * that an empty picture MUST have its flags set to 0.
62  */
63 struct picture_t
64 {
65     /**
66      * The properties of the picture
67      */
68     video_frame_format_t format;
69
70     /** Picture data - data can always be freely modified, but p_data may
71      * NEVER be modified. A direct buffer can be handled as the plugin
72      * wishes, it can even swap p_pixels buffers. */
73     uint8_t        *p_data;
74     void           *p_data_orig;                /**< pointer before memalign */
75     plane_t         p[ VOUT_MAX_PLANES ];     /**< description of the planes */
76     int             i_planes;                /**< number of allocated planes */
77
78     /** \name Type and flags
79      * Should NOT be modified except by the vout thread
80      * @{*/
81     int             i_status;                             /**< picture flags */
82     int             i_type;                /**< is picture a direct buffer ? */
83     bool            b_slow;                 /**< is picture in slow memory ? */
84     /**@}*/
85
86     /** \name Picture management properties
87      * These properties can be modified using the video output thread API,
88      * but should never be written directly */
89     /**@{*/
90     unsigned        i_refcount;                  /**< link reference counter */
91     mtime_t         date;                                  /**< display date */
92     bool            b_force;
93     /**@}*/
94
95     /** \name Picture dynamic properties
96      * Those properties can be changed by the decoder
97      * @{
98      */
99     bool            b_progressive;          /**< is it a progressive frame ? */
100     unsigned int    i_nb_fields;                  /**< # of displayed fields */
101     bool            b_top_field_first;             /**< which field is first */
102     uint8_t        *p_q;                           /**< quantification table */
103     int             i_qstride;                    /**< quantification stride */
104     int             i_qtype;                       /**< quantification style */
105     /**@}*/
106
107     /** The picture heap we are attached to */
108     picture_heap_t* p_heap;
109
110     /* Some vouts require the picture to be locked before it can be modified */
111     int (* pf_lock) ( vout_thread_t *, picture_t * );
112     int (* pf_unlock) ( vout_thread_t *, picture_t * );
113
114     /** Private data - the video output plugin might want to put stuff here to
115      * keep track of the picture */
116     picture_sys_t * p_sys;
117
118     /** This way the picture_Release can be overloaded */
119     void (*pf_release)( picture_t * );
120
121     /** Next picture in a FIFO a pictures */
122     struct picture_t *p_next;
123 };
124
125 /**
126  * This function will create a new picture.
127  * The picture created will implement a default release management compatible
128  * with picture_Hold and picture_Release. This default management will release
129  * picture_sys_t *p_sys field if non NULL.
130  */
131 VLC_EXPORT( picture_t *, picture_New, ( vlc_fourcc_t i_chroma, int i_width, int i_height, int i_aspect ) );
132
133 /**
134  * This function will force the destruction a picture.
135  * The value of the picture reference count should be 0 before entering this
136  * function.
137  * Unless used for reimplementing pf_release, you should not use this
138  * function but picture_Release.
139  */
140 VLC_EXPORT( void, picture_Delete, ( picture_t * ) );
141
142 /**
143  * This function will increase the picture reference count.
144  * It will not have any effect on picture obtained from vout
145  */
146 static inline void picture_Hold( picture_t *p_picture )
147 {
148     if( p_picture->pf_release )
149         p_picture->i_refcount++;
150 }
151 /**
152  * This function will release a picture.
153  * It will not have any effect on picture obtained from vout
154  */
155 static inline void picture_Release( picture_t *p_picture )
156 {
157     /* FIXME why do we let pf_release handle the i_refcount ? */
158     if( p_picture->pf_release )
159         p_picture->pf_release( p_picture );
160 }
161
162 /**
163  * Cleanup quantization matrix data and set to 0
164  */
165 static inline void picture_CleanupQuant( picture_t *p_pic )
166 {
167     free( p_pic->p_q );
168     p_pic->p_q = NULL;
169     p_pic->i_qstride = 0;
170     p_pic->i_qtype = 0;
171 }
172
173 /**
174  * This function will copy all picture dynamic properties.
175  */
176 static inline void picture_CopyProperties( picture_t *p_dst, const picture_t *p_src )
177 {
178     p_dst->date = p_src->date;
179     p_dst->b_force = p_src->b_force;
180
181     p_dst->b_progressive = p_src->b_progressive;
182     p_dst->i_nb_fields = p_src->i_nb_fields;
183     p_dst->b_top_field_first = p_src->b_top_field_first;
184
185     /* FIXME: copy ->p_q and ->p_qstride */
186 }
187
188 /**
189  * This function will copy the picture pixels.
190  * You can safely copy between pictures that do not have the same size,
191  * only the compatible(smaller) part will be copied.
192  */
193 VLC_EXPORT( void, picture_CopyPixels, ( picture_t *p_dst, const picture_t *p_src ) );
194 VLC_EXPORT( void, plane_CopyPixels, ( plane_t *p_dst, const plane_t *p_src ) );
195
196 /**
197  * This function will copy both picture dynamic properties and pixels.
198  * You have to notice that sometime a simple picture_Hold may do what
199  * you want without the copy overhead.
200  * Provided for convenience.
201  *
202  * \param p_dst pointer to the destination picture.
203  * \param p_src pointer to the source picture.
204  */
205 static inline void picture_Copy( picture_t *p_dst, const picture_t *p_src )
206 {
207     picture_CopyPixels( p_dst, p_src );
208     picture_CopyProperties( p_dst, p_src );
209 }
210
211 /**
212  * Video picture heap, either render (to store pictures used
213  * by the decoder) or output (to store pictures displayed by the vout plugin)
214  */
215 struct picture_heap_t
216 {
217     int i_pictures;                                   /**< current heap size */
218
219     /* \name Picture static properties
220      * Those properties are fixed at initialization and should NOT be modified
221      * @{
222      */
223     unsigned int i_width;                                 /**< picture width */
224     unsigned int i_height;                               /**< picture height */
225     vlc_fourcc_t i_chroma;                               /**< picture chroma */
226     unsigned int i_aspect;                                 /**< aspect ratio */
227     /**@}*/
228
229     /* Real pictures */
230     picture_t*      pp_picture[VOUT_MAX_PICTURES];             /**< pictures */
231     int             i_last_used_pic;              /**< last used pic in heap */
232     bool            b_allow_modify_pics;
233
234     /* Stuff used for truecolor RGB planes */
235     uint32_t i_rmask; int i_rrshift, i_lrshift;
236     uint32_t i_gmask; int i_rgshift, i_lgshift;
237     uint32_t i_bmask; int i_rbshift, i_lbshift;
238
239     /** Stuff used for palettized RGB planes */
240     void (* pf_setpalette) ( vout_thread_t *, uint16_t *, uint16_t *, uint16_t * );
241 };
242
243 /*****************************************************************************
244  * Flags used to describe the status of a picture
245  *****************************************************************************/
246
247 /* Picture type
248  * FIXME are the values meaningfull ? */
249 enum
250 {
251     EMPTY_PICTURE = 0,                             /* empty buffer */
252     MEMORY_PICTURE = 100,                 /* heap-allocated buffer */
253     DIRECT_PICTURE = 200,                         /* direct buffer */
254 };
255
256 /* Picture status */
257 enum
258 {
259     FREE_PICTURE,                              /* free and not allocated */
260     RESERVED_PICTURE,                          /* allocated and reserved */
261     READY_PICTURE,                                  /* ready for display */
262     DISPLAYED_PICTURE,                   /* been displayed but is linked */
263     DESTROYED_PICTURE,                     /* allocated but no more used */
264 };
265
266 /* Quantification type */
267 enum
268 {
269     QTYPE_MPEG1,
270     QTYPE_MPEG2,
271     QTYPE_H264,
272 };
273
274 /*****************************************************************************
275  * Shortcuts to access image components
276  *****************************************************************************/
277
278 /* Plane indices */
279 enum
280 {
281     Y_PLANE = 0,
282     U_PLANE = 1,
283     V_PLANE = 2,
284     A_PLANE = 3,
285 };
286
287 /* Shortcuts */
288 #define Y_PIXELS     p[Y_PLANE].p_pixels
289 #define Y_PITCH      p[Y_PLANE].i_pitch
290 #define U_PIXELS     p[U_PLANE].p_pixels
291 #define U_PITCH      p[U_PLANE].i_pitch
292 #define V_PIXELS     p[V_PLANE].p_pixels
293 #define V_PITCH      p[V_PLANE].i_pitch
294 #define A_PIXELS     p[A_PLANE].p_pixels
295 #define A_PITCH      p[A_PLANE].i_pitch
296
297 /**
298  * \defgroup subpicture Video Subpictures
299  * Subpictures are pictures that should be displayed on top of the video, like
300  * subtitles and OSD
301  * \ingroup video_output
302  * @{
303  */
304
305 /**
306  * Video subtitle region spu core private
307  */
308 typedef struct subpicture_region_private_t subpicture_region_private_t;
309
310 /**
311  * Video subtitle region
312  *
313  * A subtitle region is defined by a picture (graphic) and its rendering
314  * coordinates.
315  * Subtitles contain a list of regions.
316  */
317 struct subpicture_region_t
318 {
319     video_format_t  fmt;                          /**< format of the picture */
320     picture_t       *p_picture;          /**< picture comprising this region */
321
322     int             i_x;                             /**< position of region */
323     int             i_y;                             /**< position of region */
324     int             i_align;                  /**< alignment within a region */
325     int             i_alpha;                               /**< transparency */
326
327     char            *psz_text;       /**< text string comprising this region */
328     char            *psz_html;       /**< HTML version of subtitle (NULL = use psz_text) */
329     text_style_t    *p_style;        /**< a description of the text style formatting */
330
331     subpicture_region_t *p_next;                /**< next region in the list */
332     subpicture_region_private_t *p_private;  /**< Private data for spu_t *only* */
333 };
334
335 /* Subpicture region position flags */
336 #define SUBPICTURE_ALIGN_LEFT 0x1
337 #define SUBPICTURE_ALIGN_RIGHT 0x2
338 #define SUBPICTURE_ALIGN_TOP 0x4
339 #define SUBPICTURE_ALIGN_BOTTOM 0x8
340 #define SUBPICTURE_ALIGN_MASK ( SUBPICTURE_ALIGN_LEFT|SUBPICTURE_ALIGN_RIGHT| \
341                                 SUBPICTURE_ALIGN_TOP |SUBPICTURE_ALIGN_BOTTOM )
342
343 /**
344  * This function will create a new subpicture region.
345  *
346  * You must use subpicture_region_Delete to destroy it.
347  */
348 VLC_EXPORT( subpicture_region_t *, subpicture_region_New, ( const video_format_t *p_fmt ) );
349
350 /**
351  * This function will destroy a subpicture region allocated by
352  * subpicture_region_New.
353  *
354  * You may give it NULL.
355  */
356 VLC_EXPORT( void, subpicture_region_Delete, ( subpicture_region_t *p_region ) );
357
358 /**
359  * This function will destroy a list of subpicture regions allocated by
360  * subpicture_region_New.
361  *
362  * Provided for convenience.
363  */
364 VLC_EXPORT( void, subpicture_region_ChainDelete, ( subpicture_region_t *p_head ) );
365
366 /**
367  * Video subtitle
368  *
369  * Any subtitle destined to be displayed by a video output thread should
370  * be stored in this structure from it's creation to it's effective display.
371  * Subtitle type and flags should only be modified by the output thread. Note
372  * that an empty subtitle MUST have its flags set to 0.
373  */
374 struct subpicture_t
375 {
376     /** \name Channel ID */
377     /**@{*/
378     int             i_channel;                    /**< subpicture channel ID */
379     /**@}*/
380
381     /** \name Type and flags
382        Should NOT be modified except by the vout thread */
383     /**@{*/
384     int64_t         i_order;                 /** an increasing unique number */
385     subpicture_t *  p_next;               /**< next subtitle to be displayed */
386     /**@}*/
387
388     /** \name Date properties */
389     /**@{*/
390     mtime_t         i_start;                  /**< beginning of display date */
391     mtime_t         i_stop;                         /**< end of display date */
392     bool            b_ephemer;    /**< If this flag is set to true the subtitle
393                                 will be displayed untill the next one appear */
394     bool            b_fade;                               /**< enable fading */
395     /**@}*/
396
397     subpicture_region_t *p_region;  /**< region list composing this subtitle */
398
399     /** \name Display properties
400      * These properties are only indicative and may be
401      * changed by the video output thread, or simply ignored depending of the
402      * subtitle type. */
403     /**@{*/
404     int          i_original_picture_width;  /**< original width of the movie */
405     int          i_original_picture_height;/**< original height of the movie */
406     bool         b_subtitle;            /**< the picture is a movie subtitle */
407     bool         b_absolute;                       /**< position is absolute */
408     int          i_alpha;                                  /**< transparency */
409      /**@}*/
410
411     /** Pointer to function that renders this subtitle in a picture */
412     void ( *pf_render )  ( vout_thread_t *, picture_t *, const subpicture_t * );
413     /** Pointer to function that cleans up the private data of this subtitle */
414     void ( *pf_destroy ) ( subpicture_t * );
415
416     /** Pointer to functions for region management */
417     void (*pf_pre_render)    ( spu_t *, subpicture_t *, const video_format_t * );
418     void (*pf_update_regions)( spu_t *,
419                                subpicture_t *, const video_format_t *, mtime_t );
420
421     /** Private data - the subtitle plugin might want to put stuff here to
422      * keep track of the subpicture */
423     subpicture_sys_t *p_sys;                              /* subpicture data */
424 };
425
426
427 /**
428  * This function create a new empty subpicture.
429  *
430  * You must use subpicture_Delete to destroy it.
431  */
432 VLC_EXPORT( subpicture_t *, subpicture_New, ( void ) );
433
434 /**
435  * This function delete a subpicture created by subpicture_New.
436  * You may give it NULL.
437  */
438 VLC_EXPORT( void,  subpicture_Delete, ( subpicture_t *p_subpic ) );
439
440 /* Default subpicture channel ID */
441 #define DEFAULT_CHAN           1
442
443 /*****************************************************************************
444  * Prototypes
445  *****************************************************************************/
446
447 /**
448  * Initialise different fields of a picture_t (but does not allocate memory).
449  * \param p_this a vlc object
450  * \param p_pic pointer to the picture structure.
451  * \param i_chroma the wanted chroma for the picture.
452  * \param i_width the wanted width for the picture.
453  * \param i_height the wanted height for the picture.
454  * \param i_aspect the wanted aspect ratio for the picture.
455  */
456 #define vout_InitPicture(a,b,c,d,e,f) \
457         __vout_InitPicture(VLC_OBJECT(a),b,c,d,e,f)
458 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 ) );
459
460 /**
461  * Initialise different fields of a picture_t and allocates the picture buffer.
462  * \param p_this a vlc object
463  * \param p_pic pointer to the picture structure.
464  * \param i_chroma the wanted chroma for the picture.
465  * \param i_width the wanted width for the picture.
466  * \param i_height the wanted height for the picture.
467  * \param i_aspect the wanted aspect ratio for the picture.
468  */
469 #define vout_AllocatePicture(a,b,c,d,e,f) \
470         __vout_AllocatePicture(VLC_OBJECT(a),b,c,d,e,f)
471 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 ) );
472
473
474 /**
475  * \defgroup video_output Video Output
476  * This module describes the programming interface for video output threads.
477  * It includes functions allowing to open a new thread, send pictures to a
478  * thread, and destroy a previously opened video output thread.
479  * @{
480  */
481
482 /**
483  * Video ouput thread private structure
484  */
485 typedef struct vout_thread_sys_t vout_thread_sys_t;
486
487 /**
488  * Video output thread descriptor
489  *
490  * Any independent video output device, such as an X11 window or a GGI device,
491  * is represented by a video output thread, and described using the following
492  * structure.
493  */
494 struct vout_thread_t
495 {
496     VLC_COMMON_MEMBERS
497
498     /** \name Thread properties and locks */
499     /**@{*/
500     vlc_mutex_t         picture_lock;                 /**< picture heap lock */
501     vlc_mutex_t         change_lock;                 /**< thread change lock */
502     vout_sys_t *        p_sys;                     /**< system output method */
503     /**@}*/
504
505     /** \name Current display properties */
506     /**@{*/
507     uint16_t            i_changes;          /**< changes made to the thread.
508                                                       \see \ref vout_changes */
509     bool                b_scale;                  /**< allow picture scaling */
510     bool                b_fullscreen;         /**< toogle fullscreen display */
511     unsigned int        i_window_width;              /**< video window width */
512     unsigned int        i_window_height;            /**< video window height */
513     unsigned int        i_alignment;          /**< video alignment in window */
514
515     /**@}*/
516
517     /** \name Plugin used and shortcuts to access its capabilities */
518     /**@{*/
519     module_t *   p_module;
520     int       ( *pf_init )       ( vout_thread_t * );
521     void      ( *pf_end )        ( vout_thread_t * );
522     int       ( *pf_manage )     ( vout_thread_t * );
523     void      ( *pf_render )     ( vout_thread_t *, picture_t * );
524     void      ( *pf_display )    ( vout_thread_t *, picture_t * );
525     void      ( *pf_swap )       ( vout_thread_t * );         /* OpenGL only */
526     int       ( *pf_lock )       ( vout_thread_t * );         /* OpenGL only */
527     void      ( *pf_unlock )     ( vout_thread_t * );         /* OpenGL only */
528     int       ( *pf_control )    ( vout_thread_t *, int, va_list );
529     /**@}*/
530
531     /** \name Video heap and translation tables */
532     /**@{*/
533     int                 i_heap_size;                          /**< heap size */
534     picture_heap_t      render;                       /**< rendered pictures */
535     picture_heap_t      output;                          /**< direct buffers */
536
537     video_format_t      fmt_render;      /* render format (from the decoder) */
538     video_format_t      fmt_in;            /* input (modified render) format */
539     video_format_t      fmt_out;     /* output format (for the video output) */
540     /**@}*/
541
542     /* Picture heap */
543     picture_t           p_picture[2*VOUT_MAX_PICTURES+1];      /**< pictures */
544
545     /* Subpicture unit */
546     spu_t          *p_spu;
547
548     /* Video output configuration */
549     config_chain_t *p_cfg;
550
551     /* Private vout_thread data */
552     vout_thread_sys_t *p;
553 };
554
555 #define I_OUTPUTPICTURES p_vout->output.i_pictures
556 #define PP_OUTPUTPICTURE p_vout->output.pp_picture
557 #define I_RENDERPICTURES p_vout->render.i_pictures
558 #define PP_RENDERPICTURE p_vout->render.pp_picture
559
560 /** \defgroup vout_changes Flags for changes
561  * These flags are set in the vout_thread_t::i_changes field when another
562  * thread changed a variable
563  * @{
564  */
565 /** b_info changed */
566 #define VOUT_INFO_CHANGE        0x0001
567 /** b_interface changed */
568 #define VOUT_INTF_CHANGE        0x0004
569 /** b_scale changed */
570 #define VOUT_SCALE_CHANGE       0x0008
571 /** b_cursor changed */
572 #define VOUT_CURSOR_CHANGE      0x0020
573 /** b_fullscreen changed */
574 #define VOUT_FULLSCREEN_CHANGE  0x0040
575 /** size changed */
576 #define VOUT_SIZE_CHANGE        0x0200
577 /** depth changed */
578 #define VOUT_DEPTH_CHANGE       0x0400
579 /** change chroma tables */
580 #define VOUT_CHROMA_CHANGE      0x0800
581 /** cropping parameters changed */
582 #define VOUT_CROP_CHANGE        0x1000
583 /** aspect ratio changed */
584 #define VOUT_ASPECT_CHANGE      0x2000
585 /** change/recreate picture buffers */
586 #define VOUT_PICTURE_BUFFERS_CHANGE 0x4000
587 /**@}*/
588
589 /* Alignment flags */
590 #define VOUT_ALIGN_LEFT         0x0001
591 #define VOUT_ALIGN_RIGHT        0x0002
592 #define VOUT_ALIGN_HMASK        0x0003
593 #define VOUT_ALIGN_TOP          0x0004
594 #define VOUT_ALIGN_BOTTOM       0x0008
595 #define VOUT_ALIGN_VMASK        0x000C
596
597 #define MAX_JITTER_SAMPLES      20
598
599 /*****************************************************************************
600  * Prototypes
601  *****************************************************************************/
602
603 /**
604  * This function will
605  *  - returns a suitable vout (if requested by a non NULL p_fmt)
606  *  - recycles an old vout (if given) by either destroying it or by saving it
607  *  for latter usage.
608  *
609  * The purpose of this function is to avoid unnecessary creation/destruction of
610  * vout (and to allow optional vout reusing).
611  *
612  * You can call vout_Request on a vout created by vout_Create or by a previous
613  * call to vout_Request.
614  * You can release the returned value either by vout_Request or vout_Close()
615  * followed by a vlc_object_release() or shorter vout_CloseAndRelease()
616  *
617  * \param p_this a vlc object
618  * \param p_vout a vout candidate
619  * \param p_fmt the video format requested or NULL
620  * \return a vout if p_fmt is non NULL and the request is successfull, NULL
621  * otherwise
622  */
623 #define vout_Request(a,b,c) __vout_Request(VLC_OBJECT(a),b,c)
624 VLC_EXPORT( vout_thread_t *, __vout_Request,    ( vlc_object_t *p_this, vout_thread_t *p_vout, video_format_t *p_fmt ) );
625
626 /**
627  * This function will create a suitable vout for a given p_fmt. It will never
628  * reuse an already existing unused vout.
629  *
630  * You have to call either vout_Close or vout_Request on the returned value
631  * \param p_this a vlc object to which the returned vout will be attached
632  * \param p_fmt the video format requested
633  * \return a vout if the request is successfull, NULL otherwise
634  */
635 #define vout_Create(a,b) __vout_Create(VLC_OBJECT(a),b)
636 VLC_EXPORT( vout_thread_t *, __vout_Create,       ( vlc_object_t *p_this, video_format_t *p_fmt ) );
637
638 /**
639  * This function will close a vout created by vout_Create or vout_Request.
640  * The associated vout module is closed.
641  * Note: It is not released yet, you'll have to call vlc_object_release()
642  * or use the convenient vout_CloseAndRelease().
643  *
644  * \param p_vout the vout to close
645  */
646 VLC_EXPORT( void,            vout_Close,        ( vout_thread_t *p_vout ) );
647
648 /**
649  * This function will close a vout created by vout_Create
650  * and then release it.
651  *
652  * \param p_vout the vout to close and release
653  */
654 static inline void vout_CloseAndRelease( vout_thread_t *p_vout )
655 {
656     vout_Close( p_vout );
657     vlc_object_release( p_vout );
658 }
659
660 /* */
661 VLC_EXPORT( int,             vout_ChromaCmp,      ( uint32_t, uint32_t ) );
662
663 VLC_EXPORT( picture_t *,     vout_CreatePicture,  ( vout_thread_t *, bool, bool, unsigned int ) );
664 VLC_EXPORT( void,            vout_InitFormat,     ( video_frame_format_t *, uint32_t, int, int, int ) );
665 VLC_EXPORT( void,            vout_DestroyPicture, ( vout_thread_t *, picture_t * ) );
666 VLC_EXPORT( void,            vout_DisplayPicture, ( vout_thread_t *, picture_t * ) );
667 VLC_EXPORT( void,            vout_LinkPicture,    ( vout_thread_t *, picture_t * ) );
668 VLC_EXPORT( void,            vout_UnlinkPicture,  ( vout_thread_t *, picture_t * ) );
669 VLC_EXPORT( void,            vout_PlacePicture,   ( const vout_thread_t *, unsigned int, unsigned int, unsigned int *, unsigned int *, unsigned int *, unsigned int * ) );
670
671 VLC_EXPORT( int, vout_vaControlDefault, ( vout_thread_t *, int, va_list ) );
672 void vout_IntfInit( vout_thread_t * );
673 VLC_EXPORT( int, vout_Snapshot, ( vout_thread_t *p_vout, picture_t *p_pic ) );
674 VLC_EXPORT( void, vout_EnableFilter, ( vout_thread_t *, char *,bool , bool  ) );
675
676
677 static inline int vout_vaControl( vout_thread_t *p_vout, int i_query,
678                                   va_list args )
679 {
680     if( p_vout->pf_control )
681         return p_vout->pf_control( p_vout, i_query, args );
682     else
683         return VLC_EGENERIC;
684 }
685
686 static inline int vout_Control( vout_thread_t *p_vout, int i_query, ... )
687 {
688     va_list args;
689     int i_result;
690
691     va_start( args, i_query );
692     i_result = vout_vaControl( p_vout, i_query, args );
693     va_end( args );
694     return i_result;
695 }
696
697 enum output_query_e
698 {
699     VOUT_GET_SIZE,         /* arg1= unsigned int*, arg2= unsigned int*, res= */
700     VOUT_SET_SIZE,         /* arg1= unsigned int, arg2= unsigned int, res= */
701     VOUT_SET_STAY_ON_TOP,  /* arg1= bool       res=    */
702     VOUT_REPARENT,
703     VOUT_SNAPSHOT,
704     VOUT_CLOSE,
705     VOUT_SET_FOCUS,         /* arg1= bool       res=    */
706     VOUT_SET_VIEWPORT,      /* arg1= view rect, arg2=clip rect, res= */
707     VOUT_REDRAW_RECT,       /* arg1= area rect, res= */
708 };
709
710 typedef struct snapshot_t {
711   char *p_data;  /* Data area */
712
713   int i_width;       /* In pixels */
714   int i_height;      /* In pixels */
715   int i_datasize;    /* In bytes */
716   mtime_t date;      /* Presentation time */
717   vlc_cond_t p_condvar;
718   vlc_mutex_t p_mutex;
719 } snapshot_t;
720
721 /**@}*/
722
723 #endif /* _VLC_VIDEO_H */