git.sesse.net Git - vlc/blob - include/video_output.h

   1 /*****************************************************************************
   2  * video_output.h : video output thread
   3  * This module describes the programming interface for video output threads.
   4  * It includes functions allowing to open a new thread, send pictures to a
   5  * thread, and destroy a previously opened video output thread.
   6  *****************************************************************************
   7  * Copyright (C) 1999, 2000 VideoLAN
   8  * $Id: video_output.h,v 1.98 2003/08/28 21:11:54 gbazin Exp $
   9  *
  10  * Authors: Vincent Seguin <seguin@via.ecp.fr>
  11  *          Samuel Hocevar <sam@via.ecp.fr>
  12  *
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 2 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with this program; if not, write to the Free Software
  25  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  26  *****************************************************************************/
  27
  28 /*****************************************************************************
  29  * vout_chroma_t: Chroma conversion function
  30  *****************************************************************************
  31  * This is the prototype common to all conversion functions.
  32  * Parameters:
  33  *      p_source                        source picture
  34  *      p_dest                          destination picture
  35  * Picture width and source dimensions must be multiples of 16.
  36  *****************************************************************************/
  37 typedef void (vout_chroma_convert_t)( vout_thread_t *,
  38                                       picture_t *, picture_t * );
  39
  40 typedef struct vout_chroma_t
  41 {
  42     /* conversion functions */
  43     vout_chroma_convert_t *pf_convert;
  44
  45     /* Private module-dependant data */
  46     chroma_sys_t *      p_sys;                               /* private data */
  47
  48     /* Plugin used and shortcuts to access its capabilities */
  49     module_t * p_module;
  50
  51 } vout_chroma_t;
  52
  53 /**
  54  * \brief video output thread descriptor
  55  *
  56  * Any independant video output device, such as an X11 window or a GGI device,
  57  * is represented by a video output thread, and described using the following
  58  * structure.
  59  */
  60 struct vout_thread_t
  61 {
  62     VLC_COMMON_MEMBERS
  63
  64     /** \name Thread properties and locks */
  65     /**@{*/
  66     vlc_mutex_t         picture_lock;                 /**< picture heap lock */
  67     vlc_mutex_t         subpicture_lock;           /**< subpicture heap lock */
  68     vlc_mutex_t         change_lock;                 /**< thread change lock */
  69     vout_sys_t *        p_sys;                     /**< system output method */
  70     /**@}*/
  71
  72     /** \name Current display properties */
  73     /**@{*/
  74     uint16_t            i_changes;           /**< changes made to the thread */
  75     float               f_gamma;                                  /**< gamma */
  76     vlc_bool_t          b_grayscale;         /**< color or grayscale display */
  77     vlc_bool_t          b_info;            /**< print additional information */
  78     vlc_bool_t          b_interface;                   /**< render interface */
  79     vlc_bool_t          b_scale;                  /**< allow picture scaling */
  80     vlc_bool_t          b_fullscreen;         /**< toogle fullscreen display */
  81     vlc_bool_t          b_override_aspect;       /**< aspect ratio overriden */
  82     mtime_t             render_time;           /**< last picture render time */
  83     unsigned int        i_window_width;              /**< video window width */
  84     unsigned int        i_window_height;            /**< video window height */
  85     unsigned int        i_alignment;          /**< video alignment in window */
  86     /**@}*/
  87
  88     /** \name Plugin used and shortcuts to access its capabilities */
  89     /**@{*/
  90     module_t *   p_module;
  91     int       ( *pf_init )       ( vout_thread_t * );
  92     void      ( *pf_end )        ( vout_thread_t * );
  93     int       ( *pf_manage )     ( vout_thread_t * );
  94     void      ( *pf_render )     ( vout_thread_t *, picture_t * );
  95     void      ( *pf_display )    ( vout_thread_t *, picture_t * );
  96     /**@}*/
  97
  98     /** \name Statistics
  99      * These numbers are not supposed to be accurate, but are a
 100      * good indication of the thread status */
 101     /**@{*/
 102     count_t       c_fps_samples;                         /**< picture counts */
 103     mtime_t       p_fps_sample[VOUT_FPS_SAMPLES];     /**< FPS samples dates */
 104     /**@}*/
 105
 106     /** \name Video heap and translation tables */
 107     /**@{*/
 108     int                 i_heap_size;                          /**< heap size */
 109     picture_heap_t      render;                       /**< rendered pictures */
 110     picture_heap_t      output;                          /**< direct buffers */
 111     vlc_bool_t          b_direct;            /**< rendered are like direct ? */
 112     vout_chroma_t       chroma;                      /**< translation tables */
 113     /**@}*/
 114
 115     /* Picture and subpicture heaps */
 116     picture_t           p_picture[2*VOUT_MAX_PICTURES];        /**< pictures */
 117     subpicture_t        p_subpicture[VOUT_MAX_PICTURES];    /**< subpictures */
 118
 119     /* Statistics */
 120     count_t          c_loops;
 121     count_t          c_pictures, c_late_pictures;
 122     mtime_t          display_jitter;    /**< average deviation from the PTS */
 123     count_t          c_jitter_samples;  /**< number of samples used
 124                                            for the calculation of the
 125                                            jitter  */
 126     /** delay created by internal caching */
 127     int                 i_pts_delay;
 128
 129     /* Filter chain */
 130     char *psz_filter_chain;
 131     vlc_bool_t b_filter_change;
 132
 133     /* text renderer data */
 134     text_renderer_sys_t * p_text_renderer_data;        /**< private data for
 135                                                            the text renderer */
 136     module_t *            p_text_renderer_module;  /**< text renderer module */
 137     /** callback used when a new string needs to be shown on the vout */
 138     int ( *pf_add_string ) ( vout_thread_t *, char *, text_style_t *, int,
 139                              int, int, mtime_t, mtime_t );
 140 };
 141
 142 #define I_OUTPUTPICTURES p_vout->output.i_pictures
 143 #define PP_OUTPUTPICTURE p_vout->output.pp_picture
 144 #define I_RENDERPICTURES p_vout->render.i_pictures
 145 #define PP_RENDERPICTURE p_vout->render.pp_picture
 146
 147 /* Flags for changes - these flags are set in the i_changes field when another
 148  * thread changed a variable */
 149 #define VOUT_INFO_CHANGE        0x0001                     /* b_info changed */
 150 #define VOUT_GRAYSCALE_CHANGE   0x0002                /* b_grayscale changed */
 151 #define VOUT_INTF_CHANGE        0x0004                /* b_interface changed */
 152 #define VOUT_SCALE_CHANGE       0x0008                    /* b_scale changed */
 153 #define VOUT_GAMMA_CHANGE       0x0010                      /* gamma changed */
 154 #define VOUT_CURSOR_CHANGE      0x0020                   /* b_cursor changed */
 155 #define VOUT_FULLSCREEN_CHANGE  0x0040               /* b_fullscreen changed */
 156 #define VOUT_SIZE_CHANGE        0x0200                       /* size changed */
 157 #define VOUT_DEPTH_CHANGE       0x0400                      /* depth changed */
 158 #define VOUT_CHROMA_CHANGE      0x0800               /* change chroma tables */
 159
 160 /* Alignment flags */
 161 #define VOUT_ALIGN_LEFT         0x0001
 162 #define VOUT_ALIGN_RIGHT        0x0002
 163 #define VOUT_ALIGN_HMASK        0x0003
 164 #define VOUT_ALIGN_TOP          0x0004
 165 #define VOUT_ALIGN_BOTTOM       0x0008
 166 #define VOUT_ALIGN_VMASK        0x000C
 167
 168 #define MAX_JITTER_SAMPLES      20
 169
 170 /*****************************************************************************
 171  * Prototypes
 172  *****************************************************************************/
 173 #define vout_Request(a,b,c,d,e,f) __vout_Request(VLC_OBJECT(a),b,c,d,e,f)
 174 VLC_EXPORT( vout_thread_t *, __vout_Request,      ( vlc_object_t *, vout_thread_t *, unsigned int, unsigned int, uint32_t, unsigned int ) );
 175 #define vout_Create(a,b,c,d,e) __vout_Create(VLC_OBJECT(a),b,c,d,e)
 176 VLC_EXPORT( vout_thread_t *, __vout_Create,       ( vlc_object_t *, unsigned int, unsigned int, uint32_t, unsigned int ) );
 177 VLC_EXPORT( void,            vout_Destroy,        ( vout_thread_t * ) );
 178 VLC_EXPORT( int, vout_VarCallback, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
 179
 180 VLC_EXPORT( int,             vout_ChromaCmp,      ( uint32_t, uint32_t ) );
 181
 182 VLC_EXPORT( picture_t *,     vout_CreatePicture,  ( vout_thread_t *, vlc_bool_t, vlc_bool_t, unsigned int ) );
 183 VLC_EXPORT( void,            vout_InitPicture,    ( vlc_object_t *, picture_t *, int, int, uint32_t ) );
 184 VLC_EXPORT( void,            vout_AllocatePicture,( vout_thread_t *, picture_t *, int, int, uint32_t ) );
 185 VLC_EXPORT( void,            vout_DestroyPicture, ( vout_thread_t *, picture_t * ) );
 186 VLC_EXPORT( void,            vout_DisplayPicture, ( vout_thread_t *, picture_t * ) );
 187 VLC_EXPORT( void,            vout_DatePicture,    ( vout_thread_t *, picture_t *, mtime_t ) );
 188 VLC_EXPORT( void,            vout_LinkPicture,    ( vout_thread_t *, picture_t * ) );
 189 VLC_EXPORT( void,            vout_UnlinkPicture,  ( vout_thread_t *, picture_t * ) );
 190 VLC_EXPORT( void,            vout_PlacePicture,   ( vout_thread_t *, unsigned int, unsigned int, unsigned int *, unsigned int *, unsigned int *, unsigned int * ) );
 191 picture_t *     vout_RenderPicture  ( vout_thread_t *, picture_t *,
 192                                                        subpicture_t * );
 193
 194 VLC_EXPORT( subpicture_t *,  vout_CreateSubPicture,   ( vout_thread_t *, int ) );
 195 VLC_EXPORT( void,            vout_DestroySubPicture,  ( vout_thread_t *, subpicture_t * ) );
 196 VLC_EXPORT( void,            vout_DisplaySubPicture,  ( vout_thread_t *, subpicture_t * ) );
 197
 198 subpicture_t *  vout_SortSubPictures    ( vout_thread_t *, mtime_t );
 199 void            vout_RenderSubPictures  ( vout_thread_t *, picture_t *,
 200                                                            subpicture_t * );