]> git.sesse.net Git - vlc/blob - src/video_output/vout_internal.h
Made vout_ShowText* private to the core.
[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     /* */
55     video_format_t  fmt_render;      /* render format (from the decoder) */
56     video_format_t  fmt_in;            /* input (modified render) format */
57     video_format_t  fmt_out;     /* output format (for the video output) */
58
59     /* Thread & synchronization */
60     vlc_thread_t    thread;
61     vlc_cond_t      change_wait;
62     bool            b_ready;
63     bool            b_done;
64     bool            b_error;
65     vout_control_t  control;
66
67     /* */
68     struct {
69         char           *title;
70         vout_display_t *vd;
71         bool           use_dr;
72         picture_t      *filtered;
73     } display;
74
75     struct {
76         mtime_t     date;
77         mtime_t     timestamp;
78         int         qtype;
79         bool        is_interlaced;
80         picture_t   *decoded;
81     } displayed;
82
83     struct {
84         mtime_t     last;
85         mtime_t     timestamp;
86     } step;
87
88     struct {
89         bool        is_on;
90         mtime_t     date;
91     } pause;
92
93     /* OSD title configuration */
94     struct {
95         bool        show;
96         mtime_t     timeout;
97         int         position;
98     } title;
99
100     /* */
101     unsigned int    i_par_num;           /**< monitor pixel aspect-ratio */
102     unsigned int    i_par_den;           /**< monitor pixel aspect-ratio */
103     bool            is_late_dropped;
104
105     /* Statistics */
106     vout_statistic_t statistic;
107
108     /* Filter chain */
109     char           *psz_filter_chain;
110     bool            b_filter_change;
111
112     /* Video filter2 chain */
113     vlc_mutex_t     vfilter_lock;
114     filter_chain_t *p_vf2_chain;
115
116     /* Snapshot interface */
117     vout_snapshot_t snapshot;
118
119     /* Subpicture unit */
120     spu_t          *p_spu;
121
122     /* */
123     vlc_mouse_t     mouse;
124
125     /* */
126     vlc_mutex_t         picture_lock;                 /**< picture heap lock */
127     picture_pool_t      *private_pool;
128     picture_pool_t      *display_pool;
129     picture_pool_t      *decoder_pool;
130     picture_fifo_t      *decoder_fifo;
131     bool                is_decoder_pool_slow;
132     vout_chrono_t       render;           /**< picture render time estimator */
133
134     vlc_mutex_t         change_lock;                 /**< thread change lock */
135
136     uint16_t            i_changes;          /**< changes made to the thread.
137                                                       \see \ref vout_changes */
138 };
139
140 /** \defgroup vout_changes Flags for changes
141  * These flags are set in the vout_thread_t::i_changes field when another
142  * thread changed a variable
143  * @{
144  */
145 /** cropping parameters changed */
146 #define VOUT_CROP_CHANGE        0x1000
147 /** aspect ratio changed */
148 #define VOUT_ASPECT_CHANGE      0x2000
149 /**@}*/
150
151 /* TODO to move them to vlc_vout.h */
152 void vout_ControlChangeFullscreen(vout_thread_t *, bool fullscreen);
153 void vout_ControlChangeOnTop(vout_thread_t *, bool is_on_top);
154 void vout_ControlChangeDisplayFilled(vout_thread_t *, bool is_filled);
155 void vout_ControlChangeZoom(vout_thread_t *, int num, int den);
156
157 /* */
158 void vout_IntfInit( vout_thread_t * );
159
160 /* */
161 int  vout_OpenWrapper (vout_thread_t *, const char *);
162 void vout_CloseWrapper(vout_thread_t *);
163 int  vout_InitWrapper(vout_thread_t *);
164 void vout_EndWrapper(vout_thread_t *);
165 int  vout_ManageWrapper(vout_thread_t *);
166 void vout_RenderWrapper(vout_thread_t *, picture_t *);
167 void vout_DisplayWrapper(vout_thread_t *, picture_t *);
168
169 /* */
170 int spu_ProcessMouse(spu_t *, const vlc_mouse_t *, const video_format_t *);
171
172 /* */
173 int vout_ShowTextRelative( vout_thread_t *, int, char *, const text_style_t *, int, int, int, mtime_t );
174 int vout_ShowTextAbsolute( vout_thread_t *, int, const char *, const text_style_t *, int, int, int, mtime_t, mtime_t );
175
176
177 #endif
178