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