]> git.sesse.net Git - vlc/blob - include/vlc_vout.h
Patch to vout_subpictures intended to resolve problems with subtitle text
[vlc] / include / vlc_vout.h
1 /*****************************************************************************
2  * vlc_video.h: common video definitions
3  *****************************************************************************
4  * Copyright (C) 1999 - 2005 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 #if !defined( __LIBVLC__ )
27   #error You are not libvlc or one of its plugins. You cannot include this file
28 #endif
29
30 #ifndef _VLC_VOUT_H_
31 #define _VLC_VOUT_H_ 1
32
33 #include <vlc_es.h>
34
35 /** Description of a planar graphic field */
36 typedef struct plane_t
37 {
38     uint8_t *p_pixels;                        /**< Start of the plane's data */
39
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 */
43
44     /** Size of a macropixel, defaults to 1 */
45     int i_pixel_pitch;
46
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 ? */
50
51 } plane_t;
52
53 /**
54  * Video picture
55  *
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.
60  */
61 struct picture_t
62 {
63     /**
64      * The properties of the picture
65      */
66     video_frame_format_t format;
67
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. */
71     uint8_t        *p_data;
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 */
75
76     /** \name Type and flags
77      * Should NOT be modified except by the vout thread
78      * @{*/
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 */
83     /**@}*/
84
85     /** \name Picture management properties
86      * These properties can be modified using the video output thread API,
87      * but should never be written directly */
88     /**@{*/
89     int             i_refcount;                  /**< link reference counter */
90     mtime_t         date;                                  /**< display date */
91     vlc_bool_t      b_force;
92     /**@}*/
93
94     /** \name Picture dynamic properties
95      * Those properties can be changed by the decoder
96      * @{
97      */
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 */
101     /**@}*/
102
103     /** The picture heap we are attached to */
104     picture_heap_t* p_heap;
105
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 * );
109
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;
113
114     /** This way the picture_Release can be overloaded */
115     void (*pf_release)( picture_t * );
116
117     /** Next picture in a FIFO a pictures */
118     struct picture_t *p_next;
119 };
120
121 /**
122  * Video picture heap, either render (to store pictures used
123  * by the decoder) or output (to store pictures displayed by the vout plugin)
124  */
125 struct picture_heap_t
126 {
127     int i_pictures;                                   /**< current heap size */
128
129     /* \name Picture static properties
130      * Those properties are fixed at initialization and should NOT be modified
131      * @{
132      */
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 */
137     /**@}*/
138
139     /* Real pictures */
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;
143
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;
148
149     /** Stuff used for palettized RGB planes */
150     void (* pf_setpalette) ( vout_thread_t *, uint16_t *, uint16_t *, uint16_t * );
151 };
152
153 /*****************************************************************************
154  * Flags used to describe the status of a picture
155  *****************************************************************************/
156
157 /* Picture type */
158 #define EMPTY_PICTURE           0                            /* empty buffer */
159 #define MEMORY_PICTURE          100                 /* heap-allocated buffer */
160 #define DIRECT_PICTURE          200                         /* direct buffer */
161
162 /* Picture status */
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 */
170
171 /*****************************************************************************
172  * Shortcuts to access image components
173  *****************************************************************************/
174
175 /* Plane indices */
176 #define Y_PLANE      0
177 #define U_PLANE      1
178 #define V_PLANE      2
179 #define A_PLANE      3
180
181 /* Shortcuts */
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
190
191 /**
192  * \defgroup subpicture Video Subpictures
193  * Subpictures are pictures that should be displayed on top of the video, like
194  * subtitles and OSD
195  * \ingroup video_output
196  * @{
197  */
198
199 /**
200  * Video subtitle region
201  *
202  * A subtitle region is defined by a picture (graphic) and its rendering
203  * coordinates.
204  * Subtitles contain a list of regions.
205  */
206 struct subpicture_region_t
207 {
208     video_format_t  fmt;                          /**< format of the picture */
209     picture_t       picture;             /**< picture comprising this region */
210
211     int             i_x;                             /**< position of region */
212     int             i_y;                             /**< position of region */
213     int             i_align;                  /**< alignment within a region */
214
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 */
218
219     subpicture_region_t *p_next;                /**< next region in the list */
220     subpicture_region_t *p_cache;       /**< modified version of this region */
221 };
222
223 /**
224  * Video subtitle
225  *
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.
230  */
231 struct subpicture_t
232 {
233     /** \name Channel ID */
234     /**@{*/
235     int             i_channel;                    /**< subpicture channel ID */
236     /**@}*/
237
238     /** \name Type and flags
239        Should NOT be modified except by the vout thread */
240     /**@{*/
241     int             i_type;                                        /**< type */
242     int             i_status;                                     /**< flags */
243     subpicture_t *  p_next;               /**< next subtitle to be displayed */
244     /**@}*/
245
246     /** \name Date properties */
247     /**@{*/
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
254                                                             stream is paused */
255     /**@}*/
256
257     subpicture_region_t *p_region;  /**< region list composing this subtitle */
258
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
262      * subtitle type. */
263     /**@{*/
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 */
273      /**@}*/
274
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 * );
279
280     /** Pointer to functions for region management */
281     subpicture_region_t * ( *pf_create_region ) ( vlc_object_t *,
282                                                   video_format_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 * );
286
287     /** Private data - the subtitle plugin might want to put stuff here to
288      * keep track of the subpicture */
289     subpicture_sys_t *p_sys;                              /* subpicture data */
290 };
291
292 /* Subpicture type */
293 #define EMPTY_SUBPICTURE       0     /* subtitle slot is empty and available */
294 #define MEMORY_SUBPICTURE      100            /* subpicture stored in memory */
295
296 /* Default subpicture channel ID */
297 #define DEFAULT_CHAN           1
298
299 /* Subpicture status */
300 #define FREE_SUBPICTURE        0                   /* free and not allocated */
301 #define RESERVED_SUBPICTURE    1                   /* allocated and reserved */
302 #define READY_SUBPICTURE       2                        /* ready for display */
303
304 /* Subpicture position flags */
305 #define SUBPICTURE_ALIGN_LEFT 0x1
306 #define SUBPICTURE_ALIGN_RIGHT 0x2
307 #define SUBPICTURE_ALIGN_TOP 0x4
308 #define SUBPICTURE_ALIGN_BOTTOM 0x8
309 #define SUBPICTURE_ALIGN_MASK ( SUBPICTURE_ALIGN_LEFT|SUBPICTURE_ALIGN_RIGHT| \
310                                 SUBPICTURE_ALIGN_TOP |SUBPICTURE_ALIGN_BOTTOM )
311
312 /* Subpicture rendered flag - should only be used by vout_subpictures */
313 #define SUBPICTURE_RENDERED  0x10
314
315 /*****************************************************************************
316  * Prototypes
317  *****************************************************************************/
318
319 /**
320  * Copy the source picture onto the destination picture.
321  * \param p_this a vlc object
322  * \param p_dst pointer to the destination picture.
323  * \param p_src pointer to the source picture.
324  */
325 #define vout_CopyPicture(a,b,c) __vout_CopyPicture(VLC_OBJECT(a),b,c)
326 VLC_EXPORT( void, __vout_CopyPicture, ( vlc_object_t *p_this, picture_t *p_dst, picture_t *p_src ) );
327
328 /**
329  * Initialise different fields of a picture_t (but does not allocate memory).
330  * \param p_this a vlc object
331  * \param p_pic pointer to the picture structure.
332  * \param i_chroma the wanted chroma for the picture.
333  * \param i_width the wanted width for the picture.
334  * \param i_height the wanted height for the picture.
335  * \param i_aspect the wanted aspect ratio for the picture.
336  */
337 #define vout_InitPicture(a,b,c,d,e,f) \
338         __vout_InitPicture(VLC_OBJECT(a),b,c,d,e,f)
339 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 ) );
340
341 /**
342  * Initialise different fields of a picture_t and allocates the picture buffer.
343  * \param p_this a vlc object
344  * \param p_pic pointer to the picture structure.
345  * \param i_chroma the wanted chroma for the picture.
346  * \param i_width the wanted width for the picture.
347  * \param i_height the wanted height for the picture.
348  * \param i_aspect the wanted aspect ratio for the picture.
349  */
350 #define vout_AllocatePicture(a,b,c,d,e,f) \
351         __vout_AllocatePicture(VLC_OBJECT(a),b,c,d,e,f)
352 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 ) );
353
354
355 /**
356  * \defgroup video_output Video Output
357  * This module describes the programming interface for video output threads.
358  * It includes functions allowing to open a new thread, send pictures to a
359  * thread, and destroy a previously opened video output thread.
360  * @{
361  */
362
363 /**
364  * Chroma conversion function
365  *
366  * This is the prototype common to all conversion functions.
367  * \param p_vout video output thread
368  * \param p_source source picture
369  * \param p_dest destination picture
370  * Picture width and source dimensions must be multiples of 16.
371  */
372 typedef void (vout_chroma_convert_t)( vout_thread_t *,
373                                       picture_t *, picture_t * );
374
375 typedef struct vout_chroma_t
376 {
377     /** conversion functions */
378     vout_chroma_convert_t *pf_convert;
379
380     /** Private module-dependant data */
381     chroma_sys_t *      p_sys;                               /* private data */
382
383     /** Plugin used and shortcuts to access its capabilities */
384     module_t * p_module;
385
386 } vout_chroma_t;
387
388 /** Maximum numbers of video filters2 that can be attached to a vout */
389 #define MAX_VFILTERS 10
390
391 /**
392  * Video output thread descriptor
393  *
394  * Any independant video output device, such as an X11 window or a GGI device,
395  * is represented by a video output thread, and described using the following
396  * structure.
397  */
398 struct vout_thread_t
399 {
400     VLC_COMMON_MEMBERS
401
402     /** \name Thread properties and locks */
403     /**@{*/
404     vlc_mutex_t         picture_lock;                 /**< picture heap lock */
405     vlc_mutex_t         subpicture_lock;           /**< subpicture heap lock */
406     vlc_mutex_t         change_lock;                 /**< thread change lock */
407     vlc_mutex_t         vfilter_lock;         /**< video filter2 change lock */
408     vout_sys_t *        p_sys;                     /**< system output method */
409     /**@}*/
410
411     /** \name Current display properties */
412     /**@{*/
413     uint16_t            i_changes;          /**< changes made to the thread.
414                                                       \see \ref vout_changes */
415     float               f_gamma;                                  /**< gamma */
416     vlc_bool_t          b_grayscale;         /**< color or grayscale display */
417     vlc_bool_t          b_info;            /**< print additional information */
418     vlc_bool_t          b_interface;                   /**< render interface */
419     vlc_bool_t          b_scale;                  /**< allow picture scaling */
420     vlc_bool_t          b_fullscreen;         /**< toogle fullscreen display */
421     uint32_t            render_time;           /**< last picture render time */
422     unsigned int        i_window_width;              /**< video window width */
423     unsigned int        i_window_height;            /**< video window height */
424     unsigned int        i_alignment;          /**< video alignment in window */
425     unsigned int        i_par_num;           /**< monitor pixel aspect-ratio */
426     unsigned int        i_par_den;           /**< monitor pixel aspect-ratio */
427
428     intf_thread_t       *p_parent_intf;   /**< parent interface for embedded
429                                                                vout (if any) */
430     /**@}*/
431
432     /** \name Plugin used and shortcuts to access its capabilities */
433     /**@{*/
434     module_t *   p_module;
435     int       ( *pf_init )       ( vout_thread_t * );
436     void      ( *pf_end )        ( vout_thread_t * );
437     int       ( *pf_manage )     ( vout_thread_t * );
438     void      ( *pf_render )     ( vout_thread_t *, picture_t * );
439     void      ( *pf_display )    ( vout_thread_t *, picture_t * );
440     void      ( *pf_swap )       ( vout_thread_t * );         /* OpenGL only */
441     int       ( *pf_lock )       ( vout_thread_t * );         /* OpenGL only */
442     void      ( *pf_unlock )     ( vout_thread_t * );         /* OpenGL only */
443     int       ( *pf_control )    ( vout_thread_t *, int, va_list );
444     /**@}*/
445
446     /** \name Statistics
447      * These numbers are not supposed to be accurate, but are a
448      * good indication of the thread status */
449     /**@{*/
450     count_t       c_fps_samples;                         /**< picture counts */
451     mtime_t       p_fps_sample[VOUT_FPS_SAMPLES];     /**< FPS samples dates */
452     /**@}*/
453
454     /** \name Video heap and translation tables */
455     /**@{*/
456     int                 i_heap_size;                          /**< heap size */
457     picture_heap_t      render;                       /**< rendered pictures */
458     picture_heap_t      output;                          /**< direct buffers */
459     vlc_bool_t          b_direct;            /**< rendered are like direct ? */
460     vout_chroma_t       chroma;                      /**< translation tables */
461
462     video_format_t      fmt_render;      /* render format (from the decoder) */
463     video_format_t      fmt_in;            /* input (modified render) format */
464     video_format_t      fmt_out;     /* output format (for the video output) */
465     /**@}*/
466
467     /* Picture heap */
468     picture_t           p_picture[2*VOUT_MAX_PICTURES+1];      /**< pictures */
469
470     /* Subpicture unit */
471     spu_t            *p_spu;
472
473     /* Statistics */
474     count_t          c_loops;
475     count_t          c_pictures, c_late_pictures;
476     mtime_t          display_jitter;    /**< average deviation from the PTS */
477     count_t          c_jitter_samples;  /**< number of samples used
478                                            for the calculation of the
479                                            jitter  */
480     /** delay created by internal caching */
481     int                 i_pts_delay;
482
483     /* Filter chain */
484     char *psz_filter_chain;
485     vlc_bool_t b_filter_change;
486
487     /* Video filter2 chain
488      * these are handled like in transcode.c
489      * XXX: we might need to merge the two chains (v1 and v2 filters) */
490     char       *psz_vfilters[MAX_VFILTERS];
491     config_chain_t *p_vfilters_cfg[MAX_VFILTERS];
492     int         i_vfilters_cfg;
493
494     filter_t   *pp_vfilters[MAX_VFILTERS];
495     int         i_vfilters;
496
497     vlc_bool_t b_vfilter_change;
498
499     /* Misc */
500     vlc_bool_t       b_snapshot;     /**< take one snapshot on the next loop */
501
502     /* Video output configuration */
503     config_chain_t *p_cfg;
504
505     /* Show media title on videoutput */
506     vlc_bool_t      b_title_show;
507     mtime_t         i_title_timeout;
508     int             i_title_position;
509 };
510
511 #define I_OUTPUTPICTURES p_vout->output.i_pictures
512 #define PP_OUTPUTPICTURE p_vout->output.pp_picture
513 #define I_RENDERPICTURES p_vout->render.i_pictures
514 #define PP_RENDERPICTURE p_vout->render.pp_picture
515
516 /** \defgroup vout_changes Flags for changes
517  * These flags are set in the vout_thread_t::i_changes field when another
518  * thread changed a variable
519  * @{
520  */
521 /** b_info changed */
522 #define VOUT_INFO_CHANGE        0x0001
523 /** b_grayscale changed */
524 #define VOUT_GRAYSCALE_CHANGE   0x0002
525 /** b_interface changed */
526 #define VOUT_INTF_CHANGE        0x0004
527 /** b_scale changed */
528 #define VOUT_SCALE_CHANGE       0x0008
529 /** gamma changed */
530 #define VOUT_GAMMA_CHANGE       0x0010
531 /** b_cursor changed */
532 #define VOUT_CURSOR_CHANGE      0x0020
533 /** b_fullscreen changed */
534 #define VOUT_FULLSCREEN_CHANGE  0x0040
535 /** size changed */
536 #define VOUT_SIZE_CHANGE        0x0200
537 /** depth changed */
538 #define VOUT_DEPTH_CHANGE       0x0400
539 /** change chroma tables */
540 #define VOUT_CHROMA_CHANGE      0x0800
541 /** cropping parameters changed */
542 #define VOUT_CROP_CHANGE        0x1000
543 /** aspect ratio changed */
544 #define VOUT_ASPECT_CHANGE      0x2000
545 /** change/recreate picture buffers */
546 #define VOUT_PICTURE_BUFFERS_CHANGE 0x4000
547 /**@}*/
548
549 /* Alignment flags */
550 #define VOUT_ALIGN_LEFT         0x0001
551 #define VOUT_ALIGN_RIGHT        0x0002
552 #define VOUT_ALIGN_HMASK        0x0003
553 #define VOUT_ALIGN_TOP          0x0004
554 #define VOUT_ALIGN_BOTTOM       0x0008
555 #define VOUT_ALIGN_VMASK        0x000C
556
557 #define MAX_JITTER_SAMPLES      20
558
559 /*****************************************************************************
560  * Prototypes
561  *****************************************************************************/
562 #define vout_Request(a,b,c) __vout_Request(VLC_OBJECT(a),b,c)
563 VLC_EXPORT( vout_thread_t *, __vout_Request,    ( vlc_object_t *, vout_thread_t *, video_format_t * ) );
564 #define vout_Create(a,b) __vout_Create(VLC_OBJECT(a),b)
565 VLC_EXPORT( vout_thread_t *, __vout_Create,       ( vlc_object_t *, video_format_t * ) );
566 VLC_EXPORT( void,            vout_Destroy,        ( vout_thread_t * ) );
567 VLC_EXPORT( int, vout_VarCallback, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
568
569 VLC_EXPORT( int,             vout_ChromaCmp,      ( uint32_t, uint32_t ) );
570
571 VLC_EXPORT( picture_t *,     vout_CreatePicture,  ( vout_thread_t *, vlc_bool_t, vlc_bool_t, unsigned int ) );
572 VLC_EXPORT( void,            vout_InitFormat,     ( video_frame_format_t *, uint32_t, int, int, int ) );
573 VLC_EXPORT( void,            vout_DestroyPicture, ( vout_thread_t *, picture_t * ) );
574 VLC_EXPORT( void,            vout_DisplayPicture, ( vout_thread_t *, picture_t * ) );
575 VLC_EXPORT( void,            vout_DatePicture,    ( vout_thread_t *, picture_t *, mtime_t ) );
576 VLC_EXPORT( void,            vout_LinkPicture,    ( vout_thread_t *, picture_t * ) );
577 VLC_EXPORT( void,            vout_UnlinkPicture,  ( vout_thread_t *, picture_t * ) );
578 VLC_EXPORT( void,            vout_PlacePicture,   ( vout_thread_t *, unsigned int, unsigned int, unsigned int *, unsigned int *, unsigned int *, unsigned int * ) );
579 picture_t *     vout_RenderPicture  ( vout_thread_t *, picture_t *,
580                                                        subpicture_t * );
581
582 VLC_EXPORT( int, vout_vaControlDefault, ( vout_thread_t *, int, va_list ) );
583 VLC_EXPORT( void *, vout_RequestWindow, ( vout_thread_t *, int *, int *, unsigned int *, unsigned int * ) );
584 VLC_EXPORT( void,   vout_ReleaseWindow, ( vout_thread_t *, void * ) );
585 VLC_EXPORT( int, vout_ControlWindow, ( vout_thread_t *, void *, int, va_list ) );
586 void vout_IntfInit( vout_thread_t * );
587 VLC_EXPORT( int, vout_Snapshot, ( vout_thread_t *p_vout, picture_t *p_pic ) );
588 VLC_EXPORT( void, vout_EnableFilter, ( vout_thread_t *, char *,vlc_bool_t , vlc_bool_t  ) );
589
590
591 static inline int vout_vaControl( vout_thread_t *p_vout, int i_query,
592                                   va_list args )
593 {
594     if( p_vout->pf_control )
595         return p_vout->pf_control( p_vout, i_query, args );
596     else
597         return VLC_EGENERIC;
598 }
599
600 static inline int vout_Control( vout_thread_t *p_vout, int i_query, ... )
601 {
602     va_list args;
603     int i_result;
604
605     va_start( args, i_query );
606     i_result = vout_vaControl( p_vout, i_query, args );
607     va_end( args );
608     return i_result;
609 }
610
611 enum output_query_e
612 {
613     VOUT_GET_SIZE,         /* arg1= unsigned int*, arg2= unsigned int*, res= */
614     VOUT_SET_SIZE,         /* arg1= unsigned int, arg2= unsigned int, res= */
615     VOUT_SET_STAY_ON_TOP,  /* arg1= vlc_bool_t       res=    */
616     VOUT_REPARENT,
617     VOUT_SNAPSHOT,
618     VOUT_CLOSE,
619     VOUT_SET_FOCUS,         /* arg1= vlc_bool_t       res=    */
620     VOUT_SET_VIEWPORT,      /* arg1= view rect, arg2=clip rect, res= */
621     VOUT_REDRAW_RECT,       /* arg1= area rect, res= */
622 };
623
624 typedef struct snapshot_t {
625   char *p_data;  /* Data area */
626
627   int i_width;       /* In pixels */
628   int i_height;      /* In pixels */
629   int i_datasize;    /* In bytes */
630   mtime_t date;      /* Presentation time */
631 } snapshot_t;
632
633 /**@}*/
634
635 #endif /* _VLC_VIDEO_H */