git.sesse.net Git - vlc/blob - src/video_output/vout_internal.h

   1 /*****************************************************************************
   2  * vout_internal.h : Internal vout definitions
   3  *****************************************************************************
   4  * Copyright (C) 2008 the VideoLAN team
   5  * Copyright (C) 2008 Laurent Aimar
   6  * $Id$
   7  *
   8  * Authors: Laurent Aimar < fenrir _AT_ videolan _DOT_ org >
   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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25
  26 #if defined(__PLUGIN__) || defined(__BUILTIN__) || !defined(__LIBVLC__)
  27 # error This header file can only be included from LibVLC.
  28 #endif
  29
  30 #ifndef _VOUT_INTERNAL_H
  31 #define _VOUT_INTERNAL_H 1
  32
  33 #include "vout_control.h"
  34 #include "snapshot.h"
  35 #include "statistic.h"
  36
  37 /* Number of pictures required to computes the FPS rate */
  38 #define VOUT_FPS_SAMPLES                20
  39
  40 /* */
  41 typedef struct vout_sys_t vout_sys_t;
  42
  43 /* */
  44 struct vout_thread_sys_t
  45 {
  46     /* module */
  47     char       *psz_module_name;
  48
  49     /* Video output configuration */
  50     config_chain_t *p_cfg;
  51
  52     /* Place holder for the vout_wrapper code */
  53     vout_sys_t      *p_sys;
  54
  55     /* Thread & synchronization */
  56     vlc_thread_t    thread;
  57     vlc_cond_t      change_wait;
  58     bool            b_ready;
  59     bool            b_done;
  60     bool            b_error;
  61
  62     /* */
  63     bool            b_picture_displayed;
  64     bool            b_picture_empty;
  65     mtime_t         i_picture_displayed_date;
  66     picture_t       *p_picture_displayed;
  67     int             i_picture_qtype;
  68     bool            b_picture_interlaced;
  69     vlc_cond_t      picture_wait;
  70
  71     /* */
  72     vlc_mutex_t     vfilter_lock;         /**< video filter2 lock */
  73
  74     /* */
  75     uint32_t        render_time;           /**< last picture render time */
  76     unsigned int    i_par_num;           /**< monitor pixel aspect-ratio */
  77     unsigned int    i_par_den;           /**< monitor pixel aspect-ratio */
  78
  79     /**
  80      * These numbers are not supposed to be accurate, but are a
  81      * good indication of the thread status */
  82     count_t         c_fps_samples;                         /**< picture counts */
  83     mtime_t         p_fps_sample[VOUT_FPS_SAMPLES];     /**< FPS samples dates */
  84
  85     /* Statistics */
  86     vout_statistic_t statistic;
  87
  88     /* Pause */
  89     bool            b_paused;
  90     mtime_t         i_pause_date;
  91
  92     /* Filter chain */
  93     bool           b_first_vout;  /* True if it is the first vout of the filter chain */
  94     char           *psz_filter_chain;
  95     bool            b_filter_change;
  96
  97     /* Video filter2 chain */
  98     filter_chain_t *p_vf2_chain;
  99     char           *psz_vf2;
 100
 101     /* Snapshot interface */
 102     vout_snapshot_t snapshot;
 103
 104     /* Show media title on videoutput */
 105     bool            b_title_show;
 106     mtime_t         i_title_timeout;
 107     int             i_title_position;
 108
 109     char            *psz_title;
 110
 111     /* Subpicture unit */
 112     spu_t          *p_spu;
 113
 114     /* */
 115     vlc_mouse_t     mouse;
 116
 117     /* */
 118     vlc_mutex_t         picture_lock;                 /**< picture heap lock */
 119     vlc_mutex_t         change_lock;                 /**< thread change lock */
 120
 121     uint16_t            i_changes;          /**< changes made to the thread.
 122                                                       \see \ref vout_changes */
 123     unsigned            b_fullscreen:1;       /**< toogle fullscreen display */
 124     unsigned            b_on_top:1; /**< stay always on top of other windows */
 125
 126     picture_heap_t      render;                       /**< rendered pictures */
 127     picture_heap_t      output;                          /**< direct buffers */
 128
 129     picture_t           p_picture[2*VOUT_MAX_PICTURES+1];      /**< pictures */
 130 };
 131
 132 #define I_OUTPUTPICTURES p_vout->p->output.i_pictures
 133 #define PP_OUTPUTPICTURE p_vout->p->output.pp_picture
 134 #define I_RENDERPICTURES p_vout->p->render.i_pictures
 135 #define PP_RENDERPICTURE p_vout->p->render.pp_picture
 136
 137 /** \defgroup vout_changes Flags for changes
 138  * These flags are set in the vout_thread_t::i_changes field when another
 139  * thread changed a variable
 140  * @{
 141  */
 142 /** b_autoscale changed */
 143 #define VOUT_SCALE_CHANGE       0x0008
 144 /** b_on_top changed */
 145 #define VOUT_ON_TOP_CHANGE      0x0010
 146 /** b_fullscreen changed */
 147 #define VOUT_FULLSCREEN_CHANGE  0x0040
 148 /** i_zoom changed */
 149 #define VOUT_ZOOM_CHANGE        0x0080
 150 /** cropping parameters changed */
 151 #define VOUT_CROP_CHANGE        0x1000
 152 /** aspect ratio changed */
 153 #define VOUT_ASPECT_CHANGE      0x2000
 154 /** change/recreate picture buffers */
 155 #define VOUT_PICTURE_BUFFERS_CHANGE 0x4000
 156 /**@}*/
 157
 158
 159 /* */
 160 int vout_AllocatePicture( vlc_object_t *, picture_t *, uint32_t i_chroma, int i_width, int i_height, int i_sar_num, int i_sar_den );
 161 #define vout_AllocatePicture(a,b,c,d,e,f,g) \
 162         vout_AllocatePicture(VLC_OBJECT(a),b,c,d,e,f,g)
 163
 164 /* DO NOT use vout_RenderPicture/vout_IntfInit unless you are in src/video_ouput */
 165 picture_t *vout_RenderPicture( vout_thread_t *, picture_t *,
 166                                subpicture_t *,
 167                                mtime_t render_date );
 168 void vout_IntfInit( vout_thread_t * );
 169
 170 /* DO NOT use vout_UsePictureLocked unless you are in src/video_ouput
 171  *
 172  * This function supposes that you call it with picture_lock taken.
 173  */
 174 void vout_UsePictureLocked( vout_thread_t *p_vout, picture_t *p_pic  );
 175
 176 /* */
 177 int  vout_OpenWrapper (vout_thread_t *, const char *);
 178 void vout_CloseWrapper(vout_thread_t *);
 179 int  vout_InitWrapper(vout_thread_t *);
 180 void vout_EndWrapper(vout_thread_t *);
 181 int  vout_ManageWrapper(vout_thread_t *);
 182 void vout_RenderWrapper(vout_thread_t *, picture_t *);
 183 void vout_DisplayWrapper(vout_thread_t *, picture_t *);
 184
 185 #endif
 186