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 oppenned video output thread.
   6  *****************************************************************************
   7  * Copyright (C) 1999, 2000 VideoLAN
   8  * $Id: video_output.h,v 1.65 2001/12/13 12:47:17 sam Exp $
   9  *
  10  * Authors: Vincent Seguin <seguin@via.ecp.fr>
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  25  *****************************************************************************/
  26
  27 /*****************************************************************************
  28  * vout_bank_t, p_vout_bank (global variable)
  29  *****************************************************************************
  30  * This global variable is accessed by any function using the video output.
  31  *****************************************************************************/
  32 typedef struct vout_bank_s
  33 {
  34     /* Array to all the video outputs */
  35     struct vout_thread_s *pp_vout[ VOUT_MAX_THREADS ];
  36
  37     int                   i_count;
  38     vlc_mutex_t           lock;                               /* Global lock */
  39
  40 } vout_bank_t;
  41
  42 extern vout_bank_t *p_vout_bank;
  43
  44 /*****************************************************************************
  45  * vout_chroma_t: Chroma conversion function
  46  *****************************************************************************
  47  * This is the prototype common to all conversion functions.
  48  * Parameters:
  49  *      p_source                        source picture
  50  *      p_dest                          destination picture
  51  * Picture width and source dimensions must be multiples of 16.
  52  *****************************************************************************/
  53 typedef void (vout_chroma_convert_t)( picture_t *p_source, picture_t *p_dest );
  54
  55 typedef struct vout_chroma_s
  56 {
  57     /* conversion functions */
  58     vout_chroma_convert_t *pf_convert;
  59
  60     /* Private module-dependant data */
  61     p_chroma_sys_t      p_sys;                               /* private data */
  62
  63     /* Plugin used and shortcuts to access its capabilities */
  64     struct module_s *   p_module;
  65     int  ( * pf_init )  ( struct vout_thread_s * );
  66     int  ( * pf_reset ) ( struct vout_thread_s * );
  67     void ( * pf_end )   ( struct vout_thread_s * );
  68
  69 } vout_chroma_t;
  70
  71 /*****************************************************************************
  72  * vout_fifo_t
  73  *****************************************************************************/
  74 typedef struct vout_fifo_s
  75 {
  76     /* See the fifo types below */
  77     int                 i_type;
  78     boolean_t           b_die;
  79     int                 i_fifo;      /* Just to keep track of the fifo index */
  80
  81     vlc_mutex_t         data_lock;
  82     vlc_cond_t          data_wait;
  83
  84 } vout_fifo_t;
  85
  86 #define VOUT_EMPTY_FIFO         0
  87 #define VOUT_YUV_FIFO           1
  88 #define VOUT_SPU_FIFO           2
  89
  90 /*****************************************************************************
  91  * vout_thread_t: video output thread descriptor
  92  *****************************************************************************
  93  * Any independant video output device, such as an X11 window or a GGI device,
  94  * is represented by a video output thread, and described using the following
  95  * structure.
  96  *****************************************************************************/
  97 typedef struct vout_thread_s
  98 {
  99     /* Thread properties and lock */
 100     boolean_t           b_die;                                 /* `die' flag */
 101     boolean_t           b_error;                             /* `error' flag */
 102     boolean_t           b_active;                           /* `active' flag */
 103     vlc_thread_t        thread_id;               /* id for pthread functions */
 104     vlc_mutex_t         picture_lock;                   /* picture heap lock */
 105     vlc_mutex_t         subpicture_lock;             /* subpicture heap lock */
 106     vlc_mutex_t         change_lock;                   /* thread change lock */
 107     int *               pi_status;                  /* temporary status flag */
 108     p_vout_sys_t        p_sys;                       /* system output method */
 109
 110     /* Current display properties */
 111     u16                 i_changes;             /* changes made to the thread */
 112     float               f_gamma;                                    /* gamma */
 113     boolean_t           b_grayscale;           /* color or grayscale display */
 114     boolean_t           b_info;              /* print additional information */
 115     boolean_t           b_interface;                     /* render interface */
 116     boolean_t           b_scale;                    /* allow picture scaling */
 117     boolean_t           b_fullscreen;           /* toogle fullscreen display */
 118     mtime_t             render_time;             /* last picture render time */
 119
 120     /* Plugin used and shortcuts to access its capabilities */
 121     struct module_s *   p_module;
 122     int              ( *pf_create )     ( struct vout_thread_s * );
 123     int              ( *pf_init )       ( struct vout_thread_s * );
 124     void             ( *pf_end )        ( struct vout_thread_s * );
 125     void             ( *pf_destroy )    ( struct vout_thread_s * );
 126     int              ( *pf_manage )     ( struct vout_thread_s * );
 127     void             ( *pf_display )    ( struct vout_thread_s *,
 128                                           struct picture_s * );
 129     void             ( *pf_setpalette ) ( struct vout_thread_s *,
 130                                           u16 *, u16 *, u16 * );
 131
 132     /* Statistics - these numbers are not supposed to be accurate, but are a
 133      * good indication of the thread status */
 134     count_t             c_fps_samples;                     /* picture counts */
 135     mtime_t             p_fps_sample[VOUT_FPS_SAMPLES]; /* FPS samples dates */
 136
 137     /* Video heap and translation tables */
 138     int                 i_heap_size;                            /* heap size */
 139     picture_heap_t      render;                         /* rendered pictures */
 140     picture_heap_t      output;                            /* direct buffers */
 141     boolean_t           b_direct;              /* rendered are like direct ? */
 142     vout_chroma_t       chroma;                        /* translation tables */
 143
 144     /* Picture and subpicture heaps */
 145     picture_t           p_picture[VOUT_MAX_PICTURES];            /* pictures */
 146     subpicture_t        p_subpicture[VOUT_MAX_PICTURES];      /* subpictures */
 147
 148     /* Bitmap fonts */
 149     p_vout_font_t       p_default_font;                      /* default font */
 150     p_vout_font_t       p_large_font;                          /* large font */
 151
 152     /* Statistics */
 153     count_t             c_loops;
 154     count_t             c_pictures, c_late_pictures;
 155     mtime_t             display_jitter;    /* average deviation from the PTS */
 156     count_t             c_jitter_samples;  /* number of samples used for the *
 157                                             * calculation of the jitter      */
 158 } vout_thread_t;
 159
 160 #define I_OUTPUTPICTURES p_vout->output.i_pictures
 161 #define PP_OUTPUTPICTURE p_vout->output.pp_picture
 162 #define I_RENDERPICTURES p_vout->render.i_pictures
 163 #define PP_RENDERPICTURE p_vout->render.pp_picture
 164
 165 /* Flags for changes - these flags are set in the i_changes field when another
 166  * thread changed a variable */
 167 #define VOUT_INFO_CHANGE        0x0001                     /* b_info changed */
 168 #define VOUT_GRAYSCALE_CHANGE   0x0002                /* b_grayscale changed */
 169 #define VOUT_INTF_CHANGE        0x0004                /* b_interface changed */
 170 #define VOUT_SCALE_CHANGE       0x0008                    /* b_scale changed */
 171 #define VOUT_GAMMA_CHANGE       0x0010                      /* gamma changed */
 172 #define VOUT_CURSOR_CHANGE      0x0020                   /* b_cursor changed */
 173 #define VOUT_FULLSCREEN_CHANGE  0x0040               /* b_fullscreen changed */
 174 #define VOUT_SIZE_CHANGE        0x0200                       /* size changed */
 175 #define VOUT_DEPTH_CHANGE       0x0400                      /* depth changed */
 176 #define VOUT_CHROMA_CHANGE      0x0800               /* change chroma tables */
 177
 178 /* Disabled for thread deadlocks issues --Meuuh */
 179 //#define VOUT_NODISPLAY_CHANGE   0xff00    /* changes which forbidden display */
 180
 181 #define MAX_JITTER_SAMPLES      20
 182
 183 /*****************************************************************************
 184  * Prototypes
 185  *****************************************************************************/
 186 void            vout_InitBank       ( void );
 187 void            vout_EndBank        ( void );
 188
 189 vout_thread_t * vout_CreateThread   ( int *pi_status, int, int, int, int );
 190 void            vout_DestroyThread  ( vout_thread_t *, int *pi_status );
 191
 192 vout_fifo_t *   vout_CreateFifo     ( void );
 193 void            vout_DestroyFifo    ( vout_fifo_t * );
 194 void            vout_FreeFifo       ( vout_fifo_t * );
 195
 196 picture_t *     vout_CreatePicture  ( vout_thread_t * );
 197 void            vout_DestroyPicture ( vout_thread_t *, picture_t * );
 198 void            vout_DisplayPicture ( vout_thread_t *, picture_t * );
 199 void            vout_DatePicture    ( vout_thread_t *, picture_t *, mtime_t );
 200 void            vout_LinkPicture    ( vout_thread_t *, picture_t * );
 201 void            vout_UnlinkPicture  ( vout_thread_t *, picture_t * );
 202 picture_t *     vout_RenderPicture  ( vout_thread_t *, picture_t *,
 203                                                        subpicture_t * );
 204 void            vout_PlacePicture   ( vout_thread_t *, int, int,
 205                                       int *, int *, int *, int * );
 206
 207 subpicture_t *  vout_CreateSubPicture   ( vout_thread_t *, int, int );
 208 void            vout_DestroySubPicture  ( vout_thread_t *, subpicture_t * );
 209 void            vout_DisplaySubPicture  ( vout_thread_t *, subpicture_t * );
 210 subpicture_t *  vout_SortSubPictures    ( vout_thread_t *, mtime_t );
 211 void            vout_RenderSubPictures  ( vout_thread_t *, picture_t *,
 212                                                            subpicture_t * );
 213