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