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