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     intf_thread_t       *p_parent_intf;   /**< parent interface for embedded
  94                                                                vout (if any) */
  95     /**@}*/
  96
  97     /** \name Plugin used and shortcuts to access its capabilities */
  98     /**@{*/
  99     module_t *   p_module;
 100     int       ( *pf_init )       ( vout_thread_t * );
 101     void      ( *pf_end )        ( vout_thread_t * );
 102     int       ( *pf_manage )     ( vout_thread_t * );
 103     void      ( *pf_render )     ( vout_thread_t *, picture_t * );
 104     void      ( *pf_display )    ( vout_thread_t *, picture_t * );
 105     int       ( *pf_control )    ( vout_thread_t *, int, va_list );
 106     /**@}*/
 107
 108     /** \name Statistics
 109      * These numbers are not supposed to be accurate, but are a
 110      * good indication of the thread status */
 111     /**@{*/
 112     count_t       c_fps_samples;                         /**< picture counts */
 113     mtime_t       p_fps_sample[VOUT_FPS_SAMPLES];     /**< FPS samples dates */
 114     /**@}*/
 115
 116     /** \name Video heap and translation tables */
 117     /**@{*/
 118     int                 i_heap_size;                          /**< heap size */
 119     picture_heap_t      render;                       /**< rendered pictures */
 120     picture_heap_t      output;                          /**< direct buffers */
 121     vlc_bool_t          b_direct;            /**< rendered are like direct ? */
 122     vout_chroma_t       chroma;                      /**< translation tables */
 123     /**@}*/
 124
 125     /* Picture and subpicture heaps */
 126     picture_t           p_picture[2*VOUT_MAX_PICTURES];        /**< pictures */
 127     subpicture_t        p_subpicture[VOUT_MAX_PICTURES];    /**< subpictures */
 128     subpicture_t        *p_default_channel;   /**< subpicture in the default
 129                                                    channel */
 130     int                 i_channel_count;       /**< index of last subpicture
 131                                                     channel registered */
 132
 133     /* Statistics */
 134     count_t          c_loops;
 135     count_t          c_pictures, c_late_pictures;
 136     mtime_t          display_jitter;    /**< average deviation from the PTS */
 137     count_t          c_jitter_samples;  /**< number of samples used
 138                                            for the calculation of the
 139                                            jitter  */
 140     /** delay created by internal caching */
 141     int                 i_pts_delay;
 142
 143     /* Filter chain */
 144     char *psz_filter_chain;
 145     vlc_bool_t b_filter_change;
 146
 147     /* text renderer data */
 148     text_renderer_sys_t * p_text_renderer_data;        /**< private data for
 149                                                            the text renderer */
 150     module_t *            p_text_renderer_module;  /**< text renderer module */
 151     /** callback used when a new string needs to be shown on the vout */
 152     subpicture_t * ( *pf_add_string ) ( vout_thread_t *, int, char *,
 153                                         text_style_t *, int, int, int, mtime_t,
 154                                         mtime_t );
 155 };
 156
 157 #define I_OUTPUTPICTURES p_vout->output.i_pictures
 158 #define PP_OUTPUTPICTURE p_vout->output.pp_picture
 159 #define I_RENDERPICTURES p_vout->render.i_pictures
 160 #define PP_RENDERPICTURE p_vout->render.pp_picture
 161
 162 /** \defgroup vout_changes Flags for changes
 163  * These flags are set in the vout_thread_t::i_changes field when another
 164  * thread changed a variable
 165  * @{
 166  */
 167 /** b_info changed */
 168 #define VOUT_INFO_CHANGE        0x0001
 169 /** b_grayscale changed */
 170 #define VOUT_GRAYSCALE_CHANGE   0x0002
 171 /** b_interface changed */
 172 #define VOUT_INTF_CHANGE        0x0004
 173 /** b_scale changed */
 174 #define VOUT_SCALE_CHANGE       0x0008
 175 /** gamma changed */
 176 #define VOUT_GAMMA_CHANGE       0x0010
 177 /** b_cursor changed */
 178 #define VOUT_CURSOR_CHANGE      0x0020
 179 /** b_fullscreen changed */
 180 #define VOUT_FULLSCREEN_CHANGE  0x0040
 181 /** size changed */
 182 #define VOUT_SIZE_CHANGE        0x0200
 183 /** depth changed */
 184 #define VOUT_DEPTH_CHANGE       0x0400
 185 /** change chroma tables */
 186 #define VOUT_CHROMA_CHANGE      0x0800
 187 /** change/recreate picture buffers */
 188 #define VOUT_PICTURE_BUFFERS_CHANGE 0x1000
 189 /**@}*/
 190
 191 /* Alignment flags */
 192 #define VOUT_ALIGN_LEFT         0x0001
 193 #define VOUT_ALIGN_RIGHT        0x0002
 194 #define VOUT_ALIGN_HMASK        0x0003
 195 #define VOUT_ALIGN_TOP          0x0004
 196 #define VOUT_ALIGN_BOTTOM       0x0008
 197 #define VOUT_ALIGN_VMASK        0x000C
 198
 199 #define MAX_JITTER_SAMPLES      20
 200
 201 /*****************************************************************************
 202  * Prototypes
 203  *****************************************************************************/
 204 #define vout_Request(a,b,c,d,e,f) __vout_Request(VLC_OBJECT(a),b,c,d,e,f)
 205 VLC_EXPORT( vout_thread_t *, __vout_Request,      ( vlc_object_t *, vout_thread_t *, unsigned int, unsigned int, uint32_t, unsigned int ) );
 206 #define vout_Create(a,b,c,d,e) __vout_Create(VLC_OBJECT(a),b,c,d,e)
 207 VLC_EXPORT( vout_thread_t *, __vout_Create,       ( vlc_object_t *, unsigned int, unsigned int, uint32_t, unsigned int ) );
 208 VLC_EXPORT( void,            vout_Destroy,        ( vout_thread_t * ) );
 209 VLC_EXPORT( int, vout_VarCallback, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
 210
 211 VLC_EXPORT( int,             vout_ChromaCmp,      ( uint32_t, uint32_t ) );
 212
 213 VLC_EXPORT( picture_t *,     vout_CreatePicture,  ( vout_thread_t *, vlc_bool_t, vlc_bool_t, unsigned int ) );
 214 VLC_EXPORT( void,            vout_InitFormat,     ( video_frame_format_t *, uint32_t, int, int, int ) );
 215 VLC_EXPORT( void,            vout_InitPicture,    ( vlc_object_t *, picture_t *, uint32_t, int, int, int ) );
 216 VLC_EXPORT( void,            vout_AllocatePicture,( vlc_object_t *, picture_t *, uint32_t, int, int, int ) );
 217 VLC_EXPORT( void,            vout_DestroyPicture, ( vout_thread_t *, picture_t * ) );
 218 VLC_EXPORT( void,            vout_DisplayPicture, ( vout_thread_t *, picture_t * ) );
 219 VLC_EXPORT( void,            vout_DatePicture,    ( vout_thread_t *, picture_t *, mtime_t ) );
 220 VLC_EXPORT( void,            vout_LinkPicture,    ( vout_thread_t *, picture_t * ) );
 221 VLC_EXPORT( void,            vout_UnlinkPicture,  ( vout_thread_t *, picture_t * ) );
 222 VLC_EXPORT( void,            vout_PlacePicture,   ( vout_thread_t *, unsigned int, unsigned int, unsigned int *, unsigned int *, unsigned int *, unsigned int * ) );
 223 picture_t *     vout_RenderPicture  ( vout_thread_t *, picture_t *,
 224                                                        subpicture_t * );
 225
 226 VLC_EXPORT( int, vout_vaControlDefault, ( vout_thread_t *, int, va_list ) );
 227 VLC_EXPORT( void *, vout_RequestWindow, ( vout_thread_t *, int *, int *, unsigned int *, unsigned int * ) );
 228 VLC_EXPORT( void,   vout_ReleaseWindow, ( vout_thread_t *, void * ) );
 229 VLC_EXPORT( int, vout_ControlWindow, ( vout_thread_t *, void *, int, va_list ) );
 230
 231 static inline int vout_vaControl( vout_thread_t *p_vout, int i_query,
 232                                   va_list args )
 233 {
 234     if( p_vout->pf_control )
 235         return p_vout->pf_control( p_vout, i_query, args );
 236     else
 237         return VLC_EGENERIC;
 238 }
 239
 240 static inline int vout_Control( vout_thread_t *p_vout, int i_query, ... )
 241 {
 242     va_list args;
 243     int i_result;
 244
 245     va_start( args, i_query );
 246     i_result = vout_vaControl( p_vout, i_query, args );
 247     va_end( args );
 248     return i_result;
 249 }
 250
 251 enum output_query_e
 252 {
 253     VOUT_SET_ZOOM,         /* arg1= double           res=    */
 254     VOUT_SET_STAY_ON_TOP,  /* arg1= vlc_bool_t       res=    */
 255     VOUT_REPARENT,
 256     VOUT_CLOSE
 257 };
 258
 259 /**
 260  * \addtogroup subpicture
 261  * @{
 262  */
 263 VLC_EXPORT( subpicture_t *,  vout_CreateSubPicture,   ( vout_thread_t *, int, int ) );
 264 VLC_EXPORT( void,            vout_DestroySubPicture,  ( vout_thread_t *, subpicture_t * ) );
 265 VLC_EXPORT( void,            vout_DisplaySubPicture,  ( vout_thread_t *, subpicture_t * ) );
 266 VLC_EXPORT( int,             vout_RegisterOSDChannel, ( vout_thread_t * ) );
 267 VLC_EXPORT( void,            vout_ClearOSDChannel,    ( vout_thread_t *, int ) );
 268
 269 subpicture_t *  vout_SortSubPictures    ( vout_thread_t *, mtime_t );
 270 void            vout_RenderSubPictures  ( vout_thread_t *, picture_t *,
 271                                                            subpicture_t * );
 272 /** @}*/
 273 /**
 274  * @}
 275  */