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