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.82 2002/07/31 20:56:50 sam 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  * vout_fifo_t
  55  *****************************************************************************/
  56 typedef struct vout_fifo_t
  57 {
  58     /* See the fifo types below */
  59     int                 i_type;
  60     vlc_bool_t          b_die;
  61     int                 i_fifo;      /* Just to keep track of the fifo index */
  62
  63     vlc_mutex_t         data_lock;
  64     vlc_cond_t          data_wait;
  65
  66 } vout_fifo_t;
  67
  68 #define VOUT_EMPTY_FIFO         0
  69 #define VOUT_YUV_FIFO           1
  70 #define VOUT_SPU_FIFO           2
  71
  72 /*****************************************************************************
  73  * vout_thread_t: video output thread descriptor
  74  *****************************************************************************
  75  * Any independant video output device, such as an X11 window or a GGI device,
  76  * is represented by a video output thread, and described using the following
  77  * structure.
  78  *****************************************************************************/
  79 struct vout_thread_t
  80 {
  81     VLC_COMMON_MEMBERS
  82
  83     /* Thread properties and lock */
  84     vlc_mutex_t         picture_lock;                   /* picture heap lock */
  85     vlc_mutex_t         subpicture_lock;             /* subpicture heap lock */
  86     vlc_mutex_t         change_lock;                   /* thread change lock */
  87     vout_sys_t *        p_sys;                       /* system output method */
  88
  89     /* Current display properties */
  90     u16                 i_changes;             /* changes made to the thread */
  91     float               f_gamma;                                    /* gamma */
  92     vlc_bool_t          b_grayscale;           /* color or grayscale display */
  93     vlc_bool_t          b_info;              /* print additional information */
  94     vlc_bool_t          b_interface;                     /* render interface */
  95     vlc_bool_t          b_scale;                    /* allow picture scaling */
  96     vlc_bool_t          b_fullscreen;           /* toogle fullscreen display */
  97     mtime_t             render_time;             /* last picture render time */
  98     int                 i_window_width;                /* video window width */
  99     int                 i_window_height;              /* video window height */
 100
 101     /* Plugin used and shortcuts to access its capabilities */
 102     module_t *   p_module;
 103     int       ( *pf_init )       ( vout_thread_t * );
 104     void      ( *pf_end )        ( vout_thread_t * );
 105     int       ( *pf_manage )     ( vout_thread_t * );
 106     void      ( *pf_render )     ( vout_thread_t *, picture_t * );
 107     void      ( *pf_display )    ( vout_thread_t *, picture_t * );
 108
 109     /* Statistics - these numbers are not supposed to be accurate, but are a
 110      * good indication of the thread status */
 111     count_t             c_fps_samples;                     /* picture counts */
 112     mtime_t             p_fps_sample[VOUT_FPS_SAMPLES]; /* FPS samples dates */
 113
 114     /* Video heap and translation tables */
 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     /* Picture and subpicture heaps */
 122     picture_t           p_picture[2*VOUT_MAX_PICTURES];          /* pictures */
 123     subpicture_t        p_subpicture[VOUT_MAX_PICTURES];      /* subpictures */
 124
 125     /* Bitmap fonts */
 126     vout_font_t *       p_default_font;                      /* default font */
 127     vout_font_t *       p_large_font;                          /* large font */
 128
 129     /* Statistics */
 130     count_t             c_loops;
 131     count_t             c_pictures, c_late_pictures;
 132     mtime_t             display_jitter;    /* average deviation from the PTS */
 133     count_t             c_jitter_samples;  /* number of samples used for the *
 134                                             * calculation of the jitter      */
 135
 136     /* Mouse */
 137     int                 i_mouse_x, i_mouse_y, i_mouse_button;
 138
 139     /* Filter chain */
 140     char *psz_filter_chain;
 141 };
 142
 143 #define I_OUTPUTPICTURES p_vout->output.i_pictures
 144 #define PP_OUTPUTPICTURE p_vout->output.pp_picture
 145 #define I_RENDERPICTURES p_vout->render.i_pictures
 146 #define PP_RENDERPICTURE p_vout->render.pp_picture
 147
 148 /* Flags for changes - these flags are set in the i_changes field when another
 149  * thread changed a variable */
 150 #define VOUT_INFO_CHANGE        0x0001                     /* b_info changed */
 151 #define VOUT_GRAYSCALE_CHANGE   0x0002                /* b_grayscale changed */
 152 #define VOUT_INTF_CHANGE        0x0004                /* b_interface changed */
 153 #define VOUT_SCALE_CHANGE       0x0008                    /* b_scale changed */
 154 #define VOUT_GAMMA_CHANGE       0x0010                      /* gamma changed */
 155 #define VOUT_CURSOR_CHANGE      0x0020                   /* b_cursor changed */
 156 #define VOUT_FULLSCREEN_CHANGE  0x0040               /* b_fullscreen changed */
 157 #define VOUT_SIZE_CHANGE        0x0200                       /* size changed */
 158 #define VOUT_DEPTH_CHANGE       0x0400                      /* depth changed */
 159 #define VOUT_CHROMA_CHANGE      0x0800               /* change chroma tables */
 160
 161 /* Disabled for thread deadlocks issues --Meuuh */
 162 //#define VOUT_NODISPLAY_CHANGE   0xff00    /* changes which forbidden display */
 163
 164 #define MAX_JITTER_SAMPLES      20
 165
 166 /*****************************************************************************
 167  * Prototypes
 168  *****************************************************************************/
 169 #define vout_CreateThread(a,b,c,d,e) __vout_CreateThread(VLC_OBJECT(a),b,c,d,e)
 170 VLC_EXPORT( vout_thread_t *, __vout_CreateThread,   ( vlc_object_t *, int, int, u32, int ) );
 171 VLC_EXPORT( void,              vout_DestroyThread,  ( vout_thread_t * ) );
 172
 173 vout_fifo_t *   vout_CreateFifo     ( void );
 174 void            vout_DestroyFifo    ( vout_fifo_t * );
 175 void            vout_FreeFifo       ( vout_fifo_t * );
 176
 177 VLC_EXPORT( int,             vout_ChromaCmp,      ( u32, u32 ) );
 178
 179 VLC_EXPORT( picture_t *,     vout_CreatePicture,  ( vout_thread_t *, vlc_bool_t, vlc_bool_t, vlc_bool_t ) );
 180 VLC_EXPORT( void,            vout_AllocatePicture,( vout_thread_t *, picture_t *, int, int, u32 ) );
 181 VLC_EXPORT( void,            vout_DestroyPicture, ( vout_thread_t *, picture_t * ) );
 182 VLC_EXPORT( void,            vout_DisplayPicture, ( vout_thread_t *, picture_t * ) );
 183 VLC_EXPORT( void,            vout_DatePicture,    ( vout_thread_t *, picture_t *, mtime_t ) );
 184 VLC_EXPORT( void,            vout_LinkPicture,    ( vout_thread_t *, picture_t * ) );
 185 VLC_EXPORT( void,            vout_UnlinkPicture,  ( vout_thread_t *, picture_t * ) );
 186 VLC_EXPORT( void,            vout_PlacePicture,   ( vout_thread_t *, int, int, int *, int *, int *, int * ) );
 187 picture_t *     vout_RenderPicture  ( vout_thread_t *, picture_t *,
 188                                                        subpicture_t * );
 189
 190 VLC_EXPORT( subpicture_t *,  vout_CreateSubPicture,   ( vout_thread_t *, int, int ) );
 191 VLC_EXPORT( void,            vout_DestroySubPicture,  ( vout_thread_t *, subpicture_t * ) );
 192 VLC_EXPORT( void,            vout_DisplaySubPicture,  ( vout_thread_t *, subpicture_t * ) );
 193
 194 subpicture_t *  vout_SortSubPictures    ( vout_thread_t *, mtime_t );
 195 void            vout_RenderSubPictures  ( vout_thread_t *, picture_t *,
 196                                                            subpicture_t * );