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

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