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