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