git.sesse.net Git - vlc/blob - 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
 310 /*****************************************************************************
 311  * Prototypes
 312  *****************************************************************************/
 313
 314 /**
 315  * Copy the source picture onto the destination picture.
 316  * \param p_this a vlc object
 317  * \param p_dst pointer to the destination picture.
 318  * \param p_src pointer to the source picture.
 319  */
 320 #define vout_CopyPicture(a,b,c) __vout_CopyPicture(VLC_OBJECT(a),b,c)
 321 VLC_EXPORT( void, __vout_CopyPicture, ( vlc_object_t *p_this, picture_t *p_dst, picture_t *p_src ) );
 322
 323 /**
 324  * Initialise different fields of a picture_t (but does not allocate memory).
 325  * \param p_this a vlc object
 326  * \param p_pic pointer to the picture structure.
 327  * \param i_chroma the wanted chroma for the picture.
 328  * \param i_width the wanted width for the picture.
 329  * \param i_height the wanted height for the picture.
 330  * \param i_aspect the wanted aspect ratio for the picture.
 331  */
 332 #define vout_InitPicture(a,b,c,d,e,f) \
 333         __vout_InitPicture(VLC_OBJECT(a),b,c,d,e,f)
 334 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 ) );
 335
 336 /**
 337  * Initialise different fields of a picture_t and allocates the picture buffer.
 338  * \param p_this a vlc object
 339  * \param p_pic pointer to the picture structure.
 340  * \param i_chroma the wanted chroma for the picture.
 341  * \param i_width the wanted width for the picture.
 342  * \param i_height the wanted height for the picture.
 343  * \param i_aspect the wanted aspect ratio for the picture.
 344  */
 345 #define vout_AllocatePicture(a,b,c,d,e,f) \
 346         __vout_AllocatePicture(VLC_OBJECT(a),b,c,d,e,f)
 347 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 ) );
 348
 349
 350 /**
 351  * \defgroup video_output Video Output
 352  * This module describes the programming interface for video output threads.
 353  * It includes functions allowing to open a new thread, send pictures to a
 354  * thread, and destroy a previously opened video output thread.
 355  * @{
 356  */
 357
 358 /**
 359  * Chroma conversion function
 360  *
 361  * This is the prototype common to all conversion functions.
 362  * \param p_vout video output thread
 363  * \param p_source source picture
 364  * \param p_dest destination picture
 365  * Picture width and source dimensions must be multiples of 16.
 366  */
 367 typedef void (vout_chroma_convert_t)( vout_thread_t *,
 368                                       picture_t *, picture_t * );
 369
 370 typedef struct vout_chroma_t
 371 {
 372     /** conversion functions */
 373     vout_chroma_convert_t *pf_convert;
 374
 375     /** Private module-dependant data */
 376     chroma_sys_t *      p_sys;                               /* private data */
 377
 378     /** Plugin used and shortcuts to access its capabilities */
 379     module_t * p_module;
 380
 381 } vout_chroma_t;
 382
 383 /** Maximum numbers of video filters2 that can be attached to a vout */
 384 #define MAX_VFILTERS 10
 385
 386 /**
 387  * Video output thread descriptor
 388  *
 389  * Any independant video output device, such as an X11 window or a GGI device,
 390  * is represented by a video output thread, and described using the following
 391  * structure.
 392  */
 393 struct vout_thread_t
 394 {
 395     VLC_COMMON_MEMBERS
 396
 397     /** \name Thread properties and locks */
 398     /**@{*/
 399     vlc_mutex_t         picture_lock;                 /**< picture heap lock */
 400     vlc_mutex_t         subpicture_lock;           /**< subpicture heap lock */
 401     vlc_mutex_t         change_lock;                 /**< thread change lock */
 402     vlc_mutex_t         vfilter_lock;         /**< video filter2 change lock */
 403     vout_sys_t *        p_sys;                     /**< system output method */
 404     /**@}*/
 405
 406     /** \name Current display properties */
 407     /**@{*/
 408     uint16_t            i_changes;          /**< changes made to the thread.
 409                                                       \see \ref vout_changes */
 410     float               f_gamma;                                  /**< gamma */
 411     vlc_bool_t          b_grayscale;         /**< color or grayscale display */
 412     vlc_bool_t          b_info;            /**< print additional information */
 413     vlc_bool_t          b_interface;                   /**< render interface */
 414     vlc_bool_t          b_scale;                  /**< allow picture scaling */
 415     vlc_bool_t          b_fullscreen;         /**< toogle fullscreen display */
 416     uint32_t            render_time;           /**< last picture render time */
 417     unsigned int        i_window_width;              /**< video window width */
 418     unsigned int        i_window_height;            /**< video window height */
 419     unsigned int        i_alignment;          /**< video alignment in window */
 420     unsigned int        i_par_num;           /**< monitor pixel aspect-ratio */
 421     unsigned int        i_par_den;           /**< monitor pixel aspect-ratio */
 422
 423     intf_thread_t       *p_parent_intf;   /**< parent interface for embedded
 424                                                                vout (if any) */
 425     /**@}*/
 426
 427     /** \name Plugin used and shortcuts to access its capabilities */
 428     /**@{*/
 429     module_t *   p_module;
 430     int       ( *pf_init )       ( vout_thread_t * );
 431     void      ( *pf_end )        ( vout_thread_t * );
 432     int       ( *pf_manage )     ( vout_thread_t * );
 433     void      ( *pf_render )     ( vout_thread_t *, picture_t * );
 434     void      ( *pf_display )    ( vout_thread_t *, picture_t * );
 435     void      ( *pf_swap )       ( vout_thread_t * );         /* OpenGL only */
 436     int       ( *pf_lock )       ( vout_thread_t * );         /* OpenGL only */
 437     void      ( *pf_unlock )     ( vout_thread_t * );         /* OpenGL only */
 438     int       ( *pf_control )    ( vout_thread_t *, int, va_list );
 439     /**@}*/
 440
 441     /** \name Statistics
 442      * These numbers are not supposed to be accurate, but are a
 443      * good indication of the thread status */
 444     /**@{*/
 445     count_t       c_fps_samples;                         /**< picture counts */
 446     mtime_t       p_fps_sample[VOUT_FPS_SAMPLES];     /**< FPS samples dates */
 447     /**@}*/
 448
 449     /** \name Video heap and translation tables */
 450     /**@{*/
 451     int                 i_heap_size;                          /**< heap size */
 452     picture_heap_t      render;                       /**< rendered pictures */
 453     picture_heap_t      output;                          /**< direct buffers */
 454     vlc_bool_t          b_direct;            /**< rendered are like direct ? */
 455     vout_chroma_t       chroma;                      /**< translation tables */
 456
 457     video_format_t      fmt_render;      /* render format (from the decoder) */
 458     video_format_t      fmt_in;            /* input (modified render) format */
 459     video_format_t      fmt_out;     /* output format (for the video output) */
 460     /**@}*/
 461
 462     /* Picture heap */
 463     picture_t           p_picture[2*VOUT_MAX_PICTURES+1];      /**< pictures */
 464
 465     /* Subpicture unit */
 466     spu_t            *p_spu;
 467
 468     /* Statistics */
 469     count_t          c_loops;
 470     count_t          c_pictures, c_late_pictures;
 471     mtime_t          display_jitter;    /**< average deviation from the PTS */
 472     count_t          c_jitter_samples;  /**< number of samples used
 473                                            for the calculation of the
 474                                            jitter  */
 475     /** delay created by internal caching */
 476     int                 i_pts_delay;
 477
 478     /* Filter chain */
 479     char *psz_filter_chain;
 480     vlc_bool_t b_filter_change;
 481
 482     /* Video filter2 chain
 483      * these are handled like in transcode.c
 484      * XXX: we might need to merge the two chains (v1 and v2 filters) */
 485     char       *psz_vfilters[MAX_VFILTERS];
 486     config_chain_t *p_vfilters_cfg[MAX_VFILTERS];
 487     int         i_vfilters_cfg;
 488
 489     filter_t   *pp_vfilters[MAX_VFILTERS];
 490     int         i_vfilters;
 491
 492     vlc_bool_t b_vfilter_change;
 493
 494     /* Misc */
 495     vlc_bool_t       b_snapshot;     /**< take one snapshot on the next loop */
 496
 497     /* Video output configuration */
 498     config_chain_t *p_cfg;
 499 };
 500
 501 #define I_OUTPUTPICTURES p_vout->output.i_pictures
 502 #define PP_OUTPUTPICTURE p_vout->output.pp_picture
 503 #define I_RENDERPICTURES p_vout->render.i_pictures
 504 #define PP_RENDERPICTURE p_vout->render.pp_picture
 505
 506 /** \defgroup vout_changes Flags for changes
 507  * These flags are set in the vout_thread_t::i_changes field when another
 508  * thread changed a variable
 509  * @{
 510  */
 511 /** b_info changed */
 512 #define VOUT_INFO_CHANGE        0x0001
 513 /** b_grayscale changed */
 514 #define VOUT_GRAYSCALE_CHANGE   0x0002
 515 /** b_interface changed */
 516 #define VOUT_INTF_CHANGE        0x0004
 517 /** b_scale changed */
 518 #define VOUT_SCALE_CHANGE       0x0008
 519 /** gamma changed */
 520 #define VOUT_GAMMA_CHANGE       0x0010
 521 /** b_cursor changed */
 522 #define VOUT_CURSOR_CHANGE      0x0020
 523 /** b_fullscreen changed */
 524 #define VOUT_FULLSCREEN_CHANGE  0x0040
 525 /** size changed */
 526 #define VOUT_SIZE_CHANGE        0x0200
 527 /** depth changed */
 528 #define VOUT_DEPTH_CHANGE       0x0400
 529 /** change chroma tables */
 530 #define VOUT_CHROMA_CHANGE      0x0800
 531 /** cropping parameters changed */
 532 #define VOUT_CROP_CHANGE        0x1000
 533 /** aspect ratio changed */
 534 #define VOUT_ASPECT_CHANGE      0x2000
 535 /** change/recreate picture buffers */
 536 #define VOUT_PICTURE_BUFFERS_CHANGE 0x4000
 537 /**@}*/
 538
 539 /* Alignment flags */
 540 #define VOUT_ALIGN_LEFT         0x0001
 541 #define VOUT_ALIGN_RIGHT        0x0002
 542 #define VOUT_ALIGN_HMASK        0x0003
 543 #define VOUT_ALIGN_TOP          0x0004
 544 #define VOUT_ALIGN_BOTTOM       0x0008
 545 #define VOUT_ALIGN_VMASK        0x000C
 546
 547 #define MAX_JITTER_SAMPLES      20
 548
 549 /*****************************************************************************
 550  * Prototypes
 551  *****************************************************************************/
 552 #define vout_Request(a,b,c) __vout_Request(VLC_OBJECT(a),b,c)
 553 VLC_EXPORT( vout_thread_t *, __vout_Request,    ( vlc_object_t *, vout_thread_t *, video_format_t * ) );
 554 #define vout_Create(a,b) __vout_Create(VLC_OBJECT(a),b)
 555 VLC_EXPORT( vout_thread_t *, __vout_Create,       ( vlc_object_t *, video_format_t * ) );
 556 VLC_EXPORT( void,            vout_Destroy,        ( vout_thread_t * ) );
 557 VLC_EXPORT( int, vout_VarCallback, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
 558
 559 VLC_EXPORT( int,             vout_ChromaCmp,      ( uint32_t, uint32_t ) );
 560
 561 VLC_EXPORT( picture_t *,     vout_CreatePicture,  ( vout_thread_t *, vlc_bool_t, vlc_bool_t, unsigned int ) );
 562 VLC_EXPORT( void,            vout_InitFormat,     ( video_frame_format_t *, uint32_t, int, int, int ) );
 563 VLC_EXPORT( void,            vout_DestroyPicture, ( vout_thread_t *, picture_t * ) );
 564 VLC_EXPORT( void,            vout_DisplayPicture, ( vout_thread_t *, picture_t * ) );
 565 VLC_EXPORT( void,            vout_DatePicture,    ( vout_thread_t *, picture_t *, mtime_t ) );
 566 VLC_EXPORT( void,            vout_LinkPicture,    ( vout_thread_t *, picture_t * ) );
 567 VLC_EXPORT( void,            vout_UnlinkPicture,  ( vout_thread_t *, picture_t * ) );
 568 VLC_EXPORT( void,            vout_PlacePicture,   ( vout_thread_t *, unsigned int, unsigned int, unsigned int *, unsigned int *, unsigned int *, unsigned int * ) );
 569 picture_t *     vout_RenderPicture  ( vout_thread_t *, picture_t *,
 570                                                        subpicture_t * );
 571
 572 VLC_EXPORT( int, vout_vaControlDefault, ( vout_thread_t *, int, va_list ) );
 573 VLC_EXPORT( void *, vout_RequestWindow, ( vout_thread_t *, int *, int *, unsigned int *, unsigned int * ) );
 574 VLC_EXPORT( void,   vout_ReleaseWindow, ( vout_thread_t *, void * ) );
 575 VLC_EXPORT( int, vout_ControlWindow, ( vout_thread_t *, void *, int, va_list ) );
 576 void vout_IntfInit( vout_thread_t * );
 577 VLC_EXPORT( int, vout_Snapshot, ( vout_thread_t *p_vout, picture_t *p_pic ) );
 578 VLC_EXPORT( void, vout_EnableFilter, ( vout_thread_t *, char *,vlc_bool_t , vlc_bool_t  ) );
 579
 580
 581 static inline int vout_vaControl( vout_thread_t *p_vout, int i_query,
 582                                   va_list args )
 583 {
 584     if( p_vout->pf_control )
 585         return p_vout->pf_control( p_vout, i_query, args );
 586     else
 587         return VLC_EGENERIC;
 588 }
 589
 590 static inline int vout_Control( vout_thread_t *p_vout, int i_query, ... )
 591 {
 592     va_list args;
 593     int i_result;
 594
 595     va_start( args, i_query );
 596     i_result = vout_vaControl( p_vout, i_query, args );
 597     va_end( args );
 598     return i_result;
 599 }
 600
 601 enum output_query_e
 602 {
 603     VOUT_GET_SIZE,         /* arg1= unsigned int*, arg2= unsigned int*, res= */
 604     VOUT_SET_SIZE,         /* arg1= unsigned int, arg2= unsigned int, res= */
 605     VOUT_SET_STAY_ON_TOP,  /* arg1= vlc_bool_t       res=    */
 606     VOUT_REPARENT,
 607     VOUT_SNAPSHOT,
 608     VOUT_CLOSE,
 609     VOUT_SET_FOCUS,         /* arg1= vlc_bool_t       res=    */
 610     VOUT_SET_VIEWPORT,      /* arg1= view rect, arg2=clip rect, res= */
 611     VOUT_REDRAW_RECT,       /* arg1= area rect, res= */
 612 };
 613
 614 typedef struct snapshot_t {
 615   char *p_data;  /* Data area */
 616
 617   int i_width;       /* In pixels */
 618   int i_height;      /* In pixels */
 619   int i_datasize;    /* In bytes */
 620   mtime_t date;      /* Presentation time */
 621 } snapshot_t;
 622
 623 /**@}*/
 624
 625 #endif /* _VLC_VIDEO_H */