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 #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 #include <vlc_filter.h>
  35
  36 /** Description of a planar graphic field */
  37 typedef struct plane_t
  38 {
  39     uint8_t *p_pixels;                        /**< Start of the plane's data */
  40
  41     /* Variables used for fast memcpy operations */
  42     int i_lines;           /**< Number of lines, including margins */
  43     int i_pitch;           /**< Number of bytes in a line, including margins */
  44
  45     /** Size of a macropixel, defaults to 1 */
  46     int i_pixel_pitch;
  47
  48     /* Variables used for pictures with margins */
  49     int i_visible_lines;            /**< How many visible lines are there ? */
  50     int i_visible_pitch;            /**< How many visible pixels are there ? */
  51
  52 } plane_t;
  53
  54 /**
  55  * Video picture
  56  *
  57  * Any picture destined to be displayed by a video output thread should be
  58  * stored in this structure from it's creation to it's effective display.
  59  * Picture type and flags should only be modified by the output thread. Note
  60  * that an empty picture MUST have its flags set to 0.
  61  */
  62 struct picture_t
  63 {
  64     /**
  65      * The properties of the picture
  66      */
  67     video_frame_format_t format;
  68
  69     /** Picture data - data can always be freely modified, but p_data may
  70      * NEVER be modified. A direct buffer can be handled as the plugin
  71      * wishes, it can even swap p_pixels buffers. */
  72     uint8_t        *p_data;
  73     void           *p_data_orig;                /**< pointer before memalign */
  74     plane_t         p[ VOUT_MAX_PLANES ];     /**< description of the planes */
  75     int             i_planes;                /**< number of allocated planes */
  76
  77     /** \name Type and flags
  78      * Should NOT be modified except by the vout thread
  79      * @{*/
  80     int             i_status;                             /**< picture flags */
  81     int             i_type;                /**< is picture a direct buffer ? */
  82     bool            b_slow;                 /**< is picture in slow memory ? */
  83     int             i_matrix_coefficients;   /**< in YUV type, encoding type */
  84     /**@}*/
  85
  86     /** \name Picture management properties
  87      * These properties can be modified using the video output thread API,
  88      * but should never be written directly */
  89     /**@{*/
  90     unsigned        i_refcount;                  /**< link reference counter */
  91     mtime_t         date;                                  /**< display date */
  92     bool            b_force;
  93     /**@}*/
  94
  95     /** \name Picture dynamic properties
  96      * Those properties can be changed by the decoder
  97      * @{
  98      */
  99     bool            b_progressive;          /**< is it a progressive frame ? */
 100     unsigned int    i_nb_fields;                  /**< # of displayed fields */
 101     bool            b_top_field_first;             /**< which field is first */
 102     /**@}*/
 103
 104     /** The picture heap we are attached to */
 105     picture_heap_t* p_heap;
 106
 107     /* Some vouts require the picture to be locked before it can be modified */
 108     int (* pf_lock) ( vout_thread_t *, picture_t * );
 109     int (* pf_unlock) ( vout_thread_t *, picture_t * );
 110
 111     /** Private data - the video output plugin might want to put stuff here to
 112      * keep track of the picture */
 113     picture_sys_t * p_sys;
 114
 115     /** This way the picture_Release can be overloaded */
 116     void (*pf_release)( picture_t * );
 117
 118     /** Next picture in a FIFO a pictures */
 119     struct picture_t *p_next;
 120 };
 121
 122 /**
 123  * Video picture heap, either render (to store pictures used
 124  * by the decoder) or output (to store pictures displayed by the vout plugin)
 125  */
 126 struct picture_heap_t
 127 {
 128     int i_pictures;                                   /**< current heap size */
 129
 130     /* \name Picture static properties
 131      * Those properties are fixed at initialization and should NOT be modified
 132      * @{
 133      */
 134     unsigned int i_width;                                 /**< picture width */
 135     unsigned int i_height;                               /**< picture height */
 136     vlc_fourcc_t i_chroma;                               /**< picture chroma */
 137     unsigned int i_aspect;                                 /**< aspect ratio */
 138     /**@}*/
 139
 140     /* Real pictures */
 141     picture_t*      pp_picture[VOUT_MAX_PICTURES];             /**< pictures */
 142     int             i_last_used_pic;              /**< last used pic in heap */
 143     bool            b_allow_modify_pics;
 144
 145     /* Stuff used for truecolor RGB planes */
 146     uint32_t i_rmask; int i_rrshift, i_lrshift;
 147     uint32_t i_gmask; int i_rgshift, i_lgshift;
 148     uint32_t i_bmask; int i_rbshift, i_lbshift;
 149
 150     /** Stuff used for palettized RGB planes */
 151     void (* pf_setpalette) ( vout_thread_t *, uint16_t *, uint16_t *, uint16_t * );
 152 };
 153
 154 /*****************************************************************************
 155  * Flags used to describe the status of a picture
 156  *****************************************************************************/
 157
 158 /* Picture type */
 159 #define EMPTY_PICTURE           0                            /* empty buffer */
 160 #define MEMORY_PICTURE          100                 /* heap-allocated buffer */
 161 #define DIRECT_PICTURE          200                         /* direct buffer */
 162
 163 /* Picture status */
 164 #define FREE_PICTURE            0                  /* free and not allocated */
 165 #define RESERVED_PICTURE        1                  /* allocated and reserved */
 166 #define RESERVED_DATED_PICTURE  2              /* waiting for DisplayPicture */
 167 #define RESERVED_DISP_PICTURE   3               /* waiting for a DatePicture */
 168 #define READY_PICTURE           4                       /* ready for display */
 169 #define DISPLAYED_PICTURE       5            /* been displayed but is linked */
 170 #define DESTROYED_PICTURE       6              /* allocated but no more used */
 171
 172 /*****************************************************************************
 173  * Shortcuts to access image components
 174  *****************************************************************************/
 175
 176 /* Plane indices */
 177 #define Y_PLANE      0
 178 #define U_PLANE      1
 179 #define V_PLANE      2
 180 #define A_PLANE      3
 181
 182 /* Shortcuts */
 183 #define Y_PIXELS     p[Y_PLANE].p_pixels
 184 #define Y_PITCH      p[Y_PLANE].i_pitch
 185 #define U_PIXELS     p[U_PLANE].p_pixels
 186 #define U_PITCH      p[U_PLANE].i_pitch
 187 #define V_PIXELS     p[V_PLANE].p_pixels
 188 #define V_PITCH      p[V_PLANE].i_pitch
 189 #define A_PIXELS     p[A_PLANE].p_pixels
 190 #define A_PITCH      p[A_PLANE].i_pitch
 191
 192 /**
 193  * \defgroup subpicture Video Subpictures
 194  * Subpictures are pictures that should be displayed on top of the video, like
 195  * subtitles and OSD
 196  * \ingroup video_output
 197  * @{
 198  */
 199
 200 /**
 201  * Video subtitle region
 202  *
 203  * A subtitle region is defined by a picture (graphic) and its rendering
 204  * coordinates.
 205  * Subtitles contain a list of regions.
 206  */
 207 struct subpicture_region_t
 208 {
 209     video_format_t  fmt;                          /**< format of the picture */
 210     picture_t       picture;             /**< picture comprising this region */
 211
 212     int             i_x;                             /**< position of region */
 213     int             i_y;                             /**< position of region */
 214     int             i_align;                  /**< alignment within a region */
 215     int             i_alpha;                               /**< transparency */
 216
 217     char            *psz_text;       /**< text string comprising this region */
 218     char            *psz_html;       /**< HTML version of subtitle (NULL = use psz_text) */
 219     text_style_t    *p_style;        /**< a description of the text style formatting */
 220
 221     subpicture_region_t *p_next;                /**< next region in the list */
 222     subpicture_region_t *p_cache;       /**< modified version of this region */
 223 };
 224
 225 /**
 226  * Video subtitle
 227  *
 228  * Any subtitle destined to be displayed by a video output thread should
 229  * be stored in this structure from it's creation to it's effective display.
 230  * Subtitle type and flags should only be modified by the output thread. Note
 231  * that an empty subtitle MUST have its flags set to 0.
 232  */
 233 struct subpicture_t
 234 {
 235     /** \name Channel ID */
 236     /**@{*/
 237     int             i_channel;                    /**< subpicture channel ID */
 238     /**@}*/
 239
 240     /** \name Type and flags
 241        Should NOT be modified except by the vout thread */
 242     /**@{*/
 243     int             i_type;                                        /**< type */
 244     int             i_status;                                     /**< flags */
 245     subpicture_t *  p_next;               /**< next subtitle to be displayed */
 246     /**@}*/
 247
 248     /** \name Date properties */
 249     /**@{*/
 250     mtime_t         i_start;                  /**< beginning of display date */
 251     mtime_t         i_stop;                         /**< end of display date */
 252     bool            b_ephemer;    /**< If this flag is set to true the subtitle
 253                                 will be displayed untill the next one appear */
 254     bool            b_fade;                               /**< enable fading */
 255     bool            b_pausable;               /**< subpicture will be paused if
 256                                                             stream is paused */
 257     /**@}*/
 258
 259     subpicture_region_t *p_region;  /**< region list composing this subtitle */
 260
 261     /** \name Display properties
 262      * These properties are only indicative and may be
 263      * changed by the video output thread, or simply ignored depending of the
 264      * subtitle type. */
 265     /**@{*/
 266     int          i_x;                    /**< offset from alignment position */
 267     int          i_y;                    /**< offset from alignment position */
 268     int          i_width;                                 /**< picture width */
 269     int          i_height;                               /**< picture height */
 270     int          i_alpha;                                  /**< transparency */
 271     int          i_original_picture_width;  /**< original width of the movie */
 272     int          i_original_picture_height;/**< original height of the movie */
 273     bool         b_absolute;                       /**< position is absolute */
 274     int          i_flags;                                /**< position flags */
 275      /**@}*/
 276
 277     /** Pointer to function that renders this subtitle in a picture */
 278     void ( *pf_render )  ( vout_thread_t *, picture_t *, const subpicture_t * );
 279     /** Pointer to function that cleans up the private data of this subtitle */
 280     void ( *pf_destroy ) ( subpicture_t * );
 281
 282     /** Pointer to functions for region management */
 283     subpicture_region_t * ( *pf_create_region ) ( vlc_object_t *,
 284                                                   video_format_t * );
 285     subpicture_region_t * ( *pf_make_region ) ( vlc_object_t *,
 286                                                 video_format_t *, picture_t * );
 287     void ( *pf_destroy_region ) ( vlc_object_t *, subpicture_region_t * );
 288
 289     void ( *pf_pre_render ) ( video_format_t *, spu_t *, subpicture_t *, mtime_t );
 290     subpicture_region_t * ( *pf_update_regions ) ( video_format_t *, spu_t *,
 291                                                    subpicture_t *, mtime_t );
 292
 293     /** Private data - the subtitle plugin might want to put stuff here to
 294      * keep track of the subpicture */
 295     subpicture_sys_t *p_sys;                              /* subpicture data */
 296 };
 297
 298 /* Subpicture type */
 299 #define EMPTY_SUBPICTURE       0     /* subtitle slot is empty and available */
 300 #define MEMORY_SUBPICTURE      100            /* subpicture stored in memory */
 301
 302 /* Default subpicture channel ID */
 303 #define DEFAULT_CHAN           1
 304
 305 /* Subpicture status */
 306 #define FREE_SUBPICTURE        0                   /* free and not allocated */
 307 #define RESERVED_SUBPICTURE    1                   /* allocated and reserved */
 308 #define READY_SUBPICTURE       2                        /* ready for display */
 309
 310 /* Subpicture position flags */
 311 #define SUBPICTURE_ALIGN_LEFT 0x1
 312 #define SUBPICTURE_ALIGN_RIGHT 0x2
 313 #define SUBPICTURE_ALIGN_TOP 0x4
 314 #define SUBPICTURE_ALIGN_BOTTOM 0x8
 315 #define SUBPICTURE_ALIGN_MASK ( SUBPICTURE_ALIGN_LEFT|SUBPICTURE_ALIGN_RIGHT| \
 316                                 SUBPICTURE_ALIGN_TOP |SUBPICTURE_ALIGN_BOTTOM )
 317
 318 /* Subpicture rendered flag - should only be used by vout_subpictures */
 319 #define SUBPICTURE_RENDERED  0x10
 320
 321 /*****************************************************************************
 322  * Prototypes
 323  *****************************************************************************/
 324
 325 /**
 326  * Copy the source picture onto the destination picture.
 327  * \param p_this a vlc object
 328  * \param p_dst pointer to the destination picture.
 329  * \param p_src pointer to the source picture.
 330  */
 331 #define vout_CopyPicture(a,b,c) __vout_CopyPicture(VLC_OBJECT(a),b,c)
 332 VLC_EXPORT( void, __vout_CopyPicture, ( vlc_object_t *p_this, picture_t *p_dst, picture_t *p_src ) );
 333
 334 /**
 335  * Initialise different fields of a picture_t (but does not allocate memory).
 336  * \param p_this a vlc object
 337  * \param p_pic pointer to the picture structure.
 338  * \param i_chroma the wanted chroma for the picture.
 339  * \param i_width the wanted width for the picture.
 340  * \param i_height the wanted height for the picture.
 341  * \param i_aspect the wanted aspect ratio for the picture.
 342  */
 343 #define vout_InitPicture(a,b,c,d,e,f) \
 344         __vout_InitPicture(VLC_OBJECT(a),b,c,d,e,f)
 345 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 ) );
 346
 347 /**
 348  * Initialise different fields of a picture_t and allocates the picture buffer.
 349  * \param p_this a vlc object
 350  * \param p_pic pointer to the picture structure.
 351  * \param i_chroma the wanted chroma for the picture.
 352  * \param i_width the wanted width for the picture.
 353  * \param i_height the wanted height for the picture.
 354  * \param i_aspect the wanted aspect ratio for the picture.
 355  */
 356 #define vout_AllocatePicture(a,b,c,d,e,f) \
 357         __vout_AllocatePicture(VLC_OBJECT(a),b,c,d,e,f)
 358 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 ) );
 359
 360
 361 /**
 362  * \defgroup video_output Video Output
 363  * This module describes the programming interface for video output threads.
 364  * It includes functions allowing to open a new thread, send pictures to a
 365  * thread, and destroy a previously opened video output thread.
 366  * @{
 367  */
 368
 369 /**
 370  * Video output thread descriptor
 371  *
 372  * Any independent video output device, such as an X11 window or a GGI device,
 373  * is represented by a video output thread, and described using the following
 374  * structure.
 375  */
 376 struct vout_thread_t
 377 {
 378     VLC_COMMON_MEMBERS
 379
 380     /** \name Thread properties and locks */
 381     /**@{*/
 382     vlc_mutex_t         picture_lock;                 /**< picture heap lock */
 383     vlc_mutex_t         subpicture_lock;           /**< subpicture heap lock */
 384     vlc_mutex_t         change_lock;                 /**< thread change lock */
 385     vlc_mutex_t         vfilter_lock;         /**< video filter2 change lock */
 386     vout_sys_t *        p_sys;                     /**< system output method */
 387     /**@}*/
 388
 389     /** \name Current display properties */
 390     /**@{*/
 391     uint16_t            i_changes;          /**< changes made to the thread.
 392                                                       \see \ref vout_changes */
 393     float               f_gamma;                                  /**< gamma */
 394     bool                b_grayscale;         /**< color or grayscale display */
 395     bool                b_info;            /**< print additional information */
 396     bool                b_interface;                   /**< render interface */
 397     bool                b_scale;                  /**< allow picture scaling */
 398     bool                b_fullscreen;         /**< toogle fullscreen display */
 399     uint32_t            render_time;           /**< last picture render time */
 400     unsigned int        i_window_width;              /**< video window width */
 401     unsigned int        i_window_height;            /**< video window height */
 402     unsigned int        i_alignment;          /**< video alignment in window */
 403     unsigned int        i_par_num;           /**< monitor pixel aspect-ratio */
 404     unsigned int        i_par_den;           /**< monitor pixel aspect-ratio */
 405
 406     intf_thread_t       *p_parent_intf;   /**< parent interface for embedded
 407                                                                vout (if any) */
 408     /**@}*/
 409
 410     /** \name Plugin used and shortcuts to access its capabilities */
 411     /**@{*/
 412     module_t *   p_module;
 413     int       ( *pf_init )       ( vout_thread_t * );
 414     void      ( *pf_end )        ( vout_thread_t * );
 415     int       ( *pf_manage )     ( vout_thread_t * );
 416     void      ( *pf_render )     ( vout_thread_t *, picture_t * );
 417     void      ( *pf_display )    ( vout_thread_t *, picture_t * );
 418     void      ( *pf_swap )       ( vout_thread_t * );         /* OpenGL only */
 419     int       ( *pf_lock )       ( vout_thread_t * );         /* OpenGL only */
 420     void      ( *pf_unlock )     ( vout_thread_t * );         /* OpenGL only */
 421     int       ( *pf_control )    ( vout_thread_t *, int, va_list );
 422     /**@}*/
 423
 424     /** \name Statistics
 425      * These numbers are not supposed to be accurate, but are a
 426      * good indication of the thread status */
 427     /**@{*/
 428     count_t       c_fps_samples;                         /**< picture counts */
 429     mtime_t       p_fps_sample[VOUT_FPS_SAMPLES];     /**< FPS samples dates */
 430     /**@}*/
 431
 432     /** \name Video heap and translation tables */
 433     /**@{*/
 434     int                 i_heap_size;                          /**< heap size */
 435     picture_heap_t      render;                       /**< rendered pictures */
 436     picture_heap_t      output;                          /**< direct buffers */
 437     bool                b_direct;            /**< rendered are like direct ? */
 438     filter_t           *p_chroma;                    /**< translation tables */
 439
 440     video_format_t      fmt_render;      /* render format (from the decoder) */
 441     video_format_t      fmt_in;            /* input (modified render) format */
 442     video_format_t      fmt_out;     /* output format (for the video output) */
 443     /**@}*/
 444
 445     /* Picture heap */
 446     picture_t           p_picture[2*VOUT_MAX_PICTURES+1];      /**< pictures */
 447
 448     /* Subpicture unit */
 449     spu_t          *p_spu;
 450
 451     /* Statistics */
 452     count_t         c_loops;
 453     count_t         c_pictures, c_late_pictures;
 454     mtime_t         display_jitter;    /**< average deviation from the PTS */
 455     count_t         c_jitter_samples;  /**< number of samples used
 456                                            for the calculation of the
 457                                            jitter  */
 458     /** delay created by internal caching */
 459     int             i_pts_delay;
 460
 461     /* Filter chain */
 462     char           *psz_filter_chain;
 463     bool            b_filter_change;
 464
 465     /* Video filter2 chain */
 466     filter_chain_t *p_vf2_chain;
 467     char           *psz_vf2;
 468
 469     /* Misc */
 470     bool            b_snapshot;     /**< take one snapshot on the next loop */
 471
 472     /* Video output configuration */
 473     config_chain_t *p_cfg;
 474
 475     /* Show media title on videoutput */
 476     bool            b_title_show;
 477     mtime_t         i_title_timeout;
 478     int             i_title_position;
 479 };
 480
 481 #define I_OUTPUTPICTURES p_vout->output.i_pictures
 482 #define PP_OUTPUTPICTURE p_vout->output.pp_picture
 483 #define I_RENDERPICTURES p_vout->render.i_pictures
 484 #define PP_RENDERPICTURE p_vout->render.pp_picture
 485
 486 /** \defgroup vout_changes Flags for changes
 487  * These flags are set in the vout_thread_t::i_changes field when another
 488  * thread changed a variable
 489  * @{
 490  */
 491 /** b_info changed */
 492 #define VOUT_INFO_CHANGE        0x0001
 493 /** b_grayscale changed */
 494 #define VOUT_GRAYSCALE_CHANGE   0x0002
 495 /** b_interface changed */
 496 #define VOUT_INTF_CHANGE        0x0004
 497 /** b_scale changed */
 498 #define VOUT_SCALE_CHANGE       0x0008
 499 /** gamma changed */
 500 #define VOUT_GAMMA_CHANGE       0x0010
 501 /** b_cursor changed */
 502 #define VOUT_CURSOR_CHANGE      0x0020
 503 /** b_fullscreen changed */
 504 #define VOUT_FULLSCREEN_CHANGE  0x0040
 505 /** size changed */
 506 #define VOUT_SIZE_CHANGE        0x0200
 507 /** depth changed */
 508 #define VOUT_DEPTH_CHANGE       0x0400
 509 /** change chroma tables */
 510 #define VOUT_CHROMA_CHANGE      0x0800
 511 /** cropping parameters changed */
 512 #define VOUT_CROP_CHANGE        0x1000
 513 /** aspect ratio changed */
 514 #define VOUT_ASPECT_CHANGE      0x2000
 515 /** change/recreate picture buffers */
 516 #define VOUT_PICTURE_BUFFERS_CHANGE 0x4000
 517 /**@}*/
 518
 519 /* Alignment flags */
 520 #define VOUT_ALIGN_LEFT         0x0001
 521 #define VOUT_ALIGN_RIGHT        0x0002
 522 #define VOUT_ALIGN_HMASK        0x0003
 523 #define VOUT_ALIGN_TOP          0x0004
 524 #define VOUT_ALIGN_BOTTOM       0x0008
 525 #define VOUT_ALIGN_VMASK        0x000C
 526
 527 #define MAX_JITTER_SAMPLES      20
 528
 529 /*****************************************************************************
 530  * Prototypes
 531  *****************************************************************************/
 532 #define vout_Request(a,b,c) __vout_Request(VLC_OBJECT(a),b,c)
 533 VLC_EXPORT( vout_thread_t *, __vout_Request,    ( vlc_object_t *, vout_thread_t *, video_format_t * ) );
 534 #define vout_Create(a,b) __vout_Create(VLC_OBJECT(a),b)
 535 VLC_EXPORT( vout_thread_t *, __vout_Create,       ( vlc_object_t *, video_format_t * ) );
 536 VLC_EXPORT( int, vout_VarCallback, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
 537
 538 VLC_EXPORT( int,             vout_ChromaCmp,      ( uint32_t, uint32_t ) );
 539
 540 VLC_EXPORT( picture_t *,     vout_CreatePicture,  ( vout_thread_t *, bool, bool, unsigned int ) );
 541 VLC_EXPORT( void,            vout_InitFormat,     ( video_frame_format_t *, uint32_t, int, int, int ) );
 542 VLC_EXPORT( void,            vout_DestroyPicture, ( vout_thread_t *, picture_t * ) );
 543 VLC_EXPORT( void,            vout_DisplayPicture, ( vout_thread_t *, picture_t * ) );
 544 VLC_EXPORT( void,            vout_DatePicture,    ( vout_thread_t *, picture_t *, mtime_t ) );
 545 VLC_EXPORT( void,            vout_LinkPicture,    ( vout_thread_t *, picture_t * ) );
 546 VLC_EXPORT( void,            vout_UnlinkPicture,  ( vout_thread_t *, picture_t * ) );
 547 VLC_EXPORT( void,            vout_PlacePicture,   ( vout_thread_t *, unsigned int, unsigned int, unsigned int *, unsigned int *, unsigned int *, unsigned int * ) );
 548 picture_t *     vout_RenderPicture  ( vout_thread_t *, picture_t *,
 549                                                        subpicture_t * );
 550
 551 VLC_EXPORT( int, vout_vaControlDefault, ( vout_thread_t *, int, va_list ) );
 552 VLC_EXPORT( void *, vout_RequestWindow, ( vout_thread_t *, int *, int *, unsigned int *, unsigned int * ) );
 553 VLC_EXPORT( void,   vout_ReleaseWindow, ( vout_thread_t *, void * ) );
 554 VLC_EXPORT( int, vout_ControlWindow, ( vout_thread_t *, void *, int, va_list ) );
 555 void vout_IntfInit( vout_thread_t * );
 556 VLC_EXPORT( int, vout_Snapshot, ( vout_thread_t *p_vout, picture_t *p_pic ) );
 557 VLC_EXPORT( void, vout_EnableFilter, ( vout_thread_t *, char *,bool , bool  ) );
 558
 559
 560 static inline int vout_vaControl( vout_thread_t *p_vout, int i_query,
 561                                   va_list args )
 562 {
 563     if( p_vout->pf_control )
 564         return p_vout->pf_control( p_vout, i_query, args );
 565     else
 566         return VLC_EGENERIC;
 567 }
 568
 569 static inline int vout_Control( vout_thread_t *p_vout, int i_query, ... )
 570 {
 571     va_list args;
 572     int i_result;
 573
 574     va_start( args, i_query );
 575     i_result = vout_vaControl( p_vout, i_query, args );
 576     va_end( args );
 577     return i_result;
 578 }
 579
 580 enum output_query_e
 581 {
 582     VOUT_GET_SIZE,         /* arg1= unsigned int*, arg2= unsigned int*, res= */
 583     VOUT_SET_SIZE,         /* arg1= unsigned int, arg2= unsigned int, res= */
 584     VOUT_SET_STAY_ON_TOP,  /* arg1= bool       res=    */
 585     VOUT_REPARENT,
 586     VOUT_SNAPSHOT,
 587     VOUT_CLOSE,
 588     VOUT_SET_FOCUS,         /* arg1= bool       res=    */
 589     VOUT_SET_VIEWPORT,      /* arg1= view rect, arg2=clip rect, res= */
 590     VOUT_REDRAW_RECT,       /* arg1= area rect, res= */
 591 };
 592
 593 typedef struct snapshot_t {
 594   char *p_data;  /* Data area */
 595
 596   int i_width;       /* In pixels */
 597   int i_height;      /* In pixels */
 598   int i_datasize;    /* In bytes */
 599   mtime_t date;      /* Presentation time */
 600 } snapshot_t;
 601
 602 /**@}*/
 603
 604 #endif /* _VLC_VIDEO_H */