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