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 <vlc_picture_fifo.h>
  34 #include <vlc_picture_pool.h>
  35 #include <vlc_vout_display.h>
  36 #include <vlc_vout_wrapper.h>
  37 #include "vout_control.h"
  38 #include "control.h"
  39 #include "snapshot.h"
  40 #include "statistic.h"
  41 #include "chrono.h"
  42
  43 /* It should be high enough to absorbe jitter due to difficult picture(s)
  44  * to decode but not too high as memory is not that cheap.
  45  *
  46  * It can be made lower at compilation time if needed, but performance
  47  * may be degraded.
  48  */
  49 #define VOUT_MAX_PICTURES (20)
  50
  51 /**
  52  * Number of frames used to estimate the maximum filter chain latency.
  53  * For performance, it is best to use a power of 2
  54  */
  55 #define VOUT_FILTER_DELAYS (8)
  56
  57 /* */
  58 struct vout_thread_sys_t
  59 {
  60     /* Splitter module if used */
  61     char            *splitter_name;
  62
  63     /* Input thread for dvd menu interactions */
  64     vlc_object_t    *input;
  65
  66     /* */
  67     video_format_t  original;   /* Original format ie coming from the decoder */
  68     unsigned        dpb_size;
  69
  70     /* Snapshot interface */
  71     vout_snapshot_t snapshot;
  72
  73     /* Statistics */
  74     vout_statistic_t statistic;
  75
  76     /* Subpicture unit */
  77     vlc_mutex_t     spu_lock;
  78     spu_t           *p_spu;
  79
  80     /* Monitor Pixel Aspect Ratio */
  81     unsigned int    i_par_num;
  82     unsigned int    i_par_den;
  83
  84     /* Video output window */
  85     struct {
  86         bool              is_unused;
  87         vout_window_cfg_t cfg;
  88         vout_window_t     *object;
  89     } window;
  90
  91     /* Thread & synchronization */
  92     vlc_thread_t    thread;
  93     bool            dead;
  94     vout_control_t  control;
  95
  96     /* */
  97     struct {
  98         char           *title;
  99         vout_display_t *vd;
 100         bool           use_dr;
 101         picture_t      *filtered;
 102     } display;
 103
 104     struct {
 105         mtime_t     date;
 106         mtime_t     timestamp;
 107         int         qtype;
 108         bool        is_interlaced;
 109         picture_t   *decoded;
 110     } displayed;
 111
 112     struct {
 113         mtime_t     last;
 114         mtime_t     timestamp;
 115     } step;
 116
 117     struct {
 118         bool        is_on;
 119         mtime_t     date;
 120     } pause;
 121
 122     /* OSD title configuration */
 123     struct {
 124         bool        show;
 125         mtime_t     timeout;
 126         int         position;
 127     } title;
 128
 129     /* */
 130     bool            is_late_dropped;
 131
 132     /* Video filter2 chain */
 133     struct {
 134         vlc_mutex_t     lock;
 135         filter_chain_t *chain;
 136         unsigned        delay_index;
 137         mtime_t         delay[VOUT_FILTER_DELAYS];
 138     } filter;
 139
 140     /* */
 141     vlc_mouse_t     mouse;
 142
 143     /* */
 144     vlc_mutex_t     picture_lock;                 /**< picture heap lock */
 145     picture_pool_t  *private_pool;
 146     picture_pool_t  *display_pool;
 147     picture_pool_t  *decoder_pool;
 148     picture_fifo_t  *decoder_fifo;
 149     bool            is_decoder_pool_slow;
 150     vout_chrono_t   render;           /**< picture render time estimator */
 151 };
 152
 153 /* TODO to move them to vlc_vout.h */
 154 void vout_ControlChangeFullscreen(vout_thread_t *, bool fullscreen);
 155 void vout_ControlChangeOnTop(vout_thread_t *, bool is_on_top);
 156 void vout_ControlChangeDisplayFilled(vout_thread_t *, bool is_filled);
 157 void vout_ControlChangeZoom(vout_thread_t *, int num, int den);
 158 void vout_ControlChangeSampleAspectRatio(vout_thread_t *, unsigned num, unsigned den);
 159 void vout_ControlChangeCropRatio(vout_thread_t *, unsigned num, unsigned den);
 160 void vout_ControlChangeCropWindow(vout_thread_t *, int x, int y, int width, int height);
 161 void vout_ControlChangeCropBorder(vout_thread_t *, int left, int top, int right, int bottom);
 162 void vout_ControlChangeFilters(vout_thread_t *, const char *);
 163 void vout_ControlChangeSubFilters(vout_thread_t *, const char *);
 164 void vout_ControlChangeSubMargin(vout_thread_t *, int);
 165
 166 /* */
 167 void vout_IntfInit( vout_thread_t * );
 168
 169 /* */
 170 int  vout_OpenWrapper (vout_thread_t *, const char *, const vout_display_state_t *);
 171 void vout_CloseWrapper(vout_thread_t *, vout_display_state_t *);
 172 int  vout_InitWrapper(vout_thread_t *);
 173 void vout_EndWrapper(vout_thread_t *);
 174 void vout_ManageWrapper(vout_thread_t *);
 175 void vout_RenderWrapper(vout_thread_t *, picture_t *);
 176 void vout_DisplayWrapper(vout_thread_t *, picture_t *);
 177
 178 /* */
 179 int spu_ProcessMouse(spu_t *, const vlc_mouse_t *, const video_format_t *);
 180 void spu_Attach( spu_t *, vlc_object_t *input, bool );
 181 void spu_ChangeMargin(spu_t *, int);
 182
 183 #endif
 184