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