home *** CD-ROM | disk | FTP | other *** search
/ Maximum CD 2009 May / maximum-cd-2009-05.iso / DiscContents / vlc-0.9.8a-win32.exe / sdk / include / vlc / plugins / vlc_vout.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-12-06  |  29.0 KB  |  733 lines

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