vlc_vout.h
上传用户:kjfoods
上传日期:2020-07-06
资源大小:29949k
文件大小:27k
源码类别:

midi

开发平台:

Unix_Linux

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