]> git.sesse.net Git - vlc/blob - src/video_output/vout_internal.h
Added API to simplify/clean up vout controls.
[vlc] / 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 "vout_control.h"
37 #include "control.h"
38 #include "snapshot.h"
39 #include "statistic.h"
40 #include "chrono.h"
41
42 /* Number of pictures required to computes the FPS rate */
43 #define VOUT_FPS_SAMPLES                20
44
45 /* */
46 struct vout_thread_sys_t
47 {
48     /* module */
49     char       *psz_module_name;
50
51     /* Video output configuration */
52     config_chain_t *p_cfg;
53
54     /* Thread & synchronization */
55     vlc_thread_t    thread;
56     vlc_cond_t      change_wait;
57     bool            b_ready;
58     bool            b_done;
59     bool            b_error;
60     vout_control_t  control;
61
62     /* */
63     struct {
64         char           *title;
65         vout_display_t *vd;
66         bool           use_dr;
67         picture_t      *filtered;
68     } display;
69
70     bool            b_picture_empty;
71     vlc_cond_t      picture_wait;
72     struct {
73         mtime_t     date;
74         mtime_t     timestamp;
75         int         qtype;
76         bool        is_interlaced;
77         picture_t   *decoded;
78     } displayed;
79
80     struct {
81         bool        is_requested;
82         mtime_t     last;
83         mtime_t     timestamp;
84     } step;
85
86     struct {
87         bool        is_on;
88         mtime_t     date;
89     } pause;
90
91     struct {
92         bool        show;
93         mtime_t     timeout;
94         int         position;
95         char        *value;
96     } title;
97
98     /* */
99     vlc_mutex_t     vfilter_lock;         /**< video filter2 lock */
100
101     /* */
102     unsigned int    i_par_num;           /**< monitor pixel aspect-ratio */
103     unsigned int    i_par_den;           /**< monitor pixel aspect-ratio */
104     bool            is_late_dropped;
105
106     /* Statistics */
107     vout_statistic_t statistic;
108
109     /* Filter chain */
110     char           *psz_filter_chain;
111     bool            b_filter_change;
112
113     /* Video filter2 chain */
114     filter_chain_t *p_vf2_chain;
115     char           *psz_vf2;
116
117     /* Snapshot interface */
118     vout_snapshot_t snapshot;
119
120     /* Subpicture unit */
121     spu_t          *p_spu;
122
123     /* */
124     vlc_mouse_t     mouse;
125
126     /* */
127     vlc_mutex_t         picture_lock;                 /**< picture heap lock */
128     picture_pool_t      *private_pool;
129     picture_pool_t      *display_pool;
130     picture_pool_t      *decoder_pool;
131     picture_fifo_t      *decoder_fifo;
132     bool                is_decoder_pool_slow;
133     vout_chrono_t       render;           /**< picture render time estimator */
134
135     vlc_mutex_t         change_lock;                 /**< thread change lock */
136
137     uint16_t            i_changes;          /**< changes made to the thread.
138                                                       \see \ref vout_changes */
139     unsigned            b_fullscreen:1;       /**< toogle fullscreen display */
140     unsigned            b_on_top:1; /**< stay always on top of other windows */
141 };
142
143 /** \defgroup vout_changes Flags for changes
144  * These flags are set in the vout_thread_t::i_changes field when another
145  * thread changed a variable
146  * @{
147  */
148 /** b_autoscale changed */
149 #define VOUT_SCALE_CHANGE       0x0008
150 /** b_on_top changed */
151 #define VOUT_ON_TOP_CHANGE      0x0010
152 /** b_fullscreen changed */
153 #define VOUT_FULLSCREEN_CHANGE  0x0040
154 /** i_zoom changed */
155 #define VOUT_ZOOM_CHANGE        0x0080
156 /** cropping parameters changed */
157 #define VOUT_CROP_CHANGE        0x1000
158 /** aspect ratio changed */
159 #define VOUT_ASPECT_CHANGE      0x2000
160 /**@}*/
161
162
163 /* */
164 void vout_IntfInit( vout_thread_t * );
165
166 /* */
167 int  vout_OpenWrapper (vout_thread_t *, const char *);
168 void vout_CloseWrapper(vout_thread_t *);
169 int  vout_InitWrapper(vout_thread_t *);
170 void vout_EndWrapper(vout_thread_t *);
171 int  vout_ManageWrapper(vout_thread_t *);
172 void vout_RenderWrapper(vout_thread_t *, picture_t *);
173 void vout_DisplayWrapper(vout_thread_t *, picture_t *);
174
175 #endif
176