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