Rename all sout_Cfg* stuff to config_Chain* (as it isn't really sout specific)
[vlc.git] / include / video_output.h
1 /*****************************************************************************
2  * video_output.h : video output thread
3  *****************************************************************************
4  * Copyright (C) 1999, 2000 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Vincent Seguin <seguin@via.ecp.fr>
8  *          Samuel Hocevar <sam@via.ecp.fr>
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  * \defgroup video_output Video Output
27  * This module describes the programming interface for video output threads.
28  * It includes functions allowing to open a new thread, send pictures to a
29  * thread, and destroy a previously opened video output thread.
30  * @{
31  */
32
33 /**
34  * Chroma conversion function
35  *
36  * This is the prototype common to all conversion functions.
37  * \param p_vout video output thread
38  * \param p_source source picture
39  * \param p_dest destination picture
40  * Picture width and source dimensions must be multiples of 16.
41  */
42 typedef void (vout_chroma_convert_t)( vout_thread_t *,
43                                       picture_t *, picture_t * );
44
45 typedef struct vout_chroma_t
46 {
47     /** conversion functions */
48     vout_chroma_convert_t *pf_convert;
49
50     /** Private module-dependant data */
51     chroma_sys_t *      p_sys;                               /* private data */
52
53     /** Plugin used and shortcuts to access its capabilities */
54     module_t * p_module;
55
56 } vout_chroma_t;
57
58 /** Maximum numbers of video filters2 that can be attached to a vout */
59 #define MAX_VFILTERS 10
60
61 /**
62  * Video output thread descriptor
63  *
64  * Any independant video output device, such as an X11 window or a GGI device,
65  * is represented by a video output thread, and described using the following
66  * structure.
67  */
68 struct vout_thread_t
69 {
70     VLC_COMMON_MEMBERS
71
72     /** \name Thread properties and locks */
73     /**@{*/
74     vlc_mutex_t         picture_lock;                 /**< picture heap lock */
75     vlc_mutex_t         subpicture_lock;           /**< subpicture heap lock */
76     vlc_mutex_t         change_lock;                 /**< thread change lock */
77     vout_sys_t *        p_sys;                     /**< system output method */
78     /**@}*/
79
80     /** \name Current display properties */
81     /**@{*/
82     uint16_t            i_changes;          /**< changes made to the thread.
83                                                       \see \ref vout_changes */
84     float               f_gamma;                                  /**< gamma */
85     vlc_bool_t          b_grayscale;         /**< color or grayscale display */
86     vlc_bool_t          b_info;            /**< print additional information */
87     vlc_bool_t          b_interface;                   /**< render interface */
88     vlc_bool_t          b_scale;                  /**< allow picture scaling */
89     vlc_bool_t          b_fullscreen;         /**< toogle fullscreen display */
90     uint32_t            render_time;           /**< last picture render time */
91     unsigned int        i_window_width;              /**< video window width */
92     unsigned int        i_window_height;            /**< video window height */
93     unsigned int        i_alignment;          /**< video alignment in window */
94     unsigned int        i_par_num;           /**< monitor pixel aspect-ratio */
95     unsigned int        i_par_den;           /**< monitor pixel aspect-ratio */
96
97     intf_thread_t       *p_parent_intf;   /**< parent interface for embedded
98                                                                vout (if any) */
99     /**@}*/
100
101     /** \name Plugin used and shortcuts to access its capabilities */
102     /**@{*/
103     module_t *   p_module;
104     int       ( *pf_init )       ( vout_thread_t * );
105     void      ( *pf_end )        ( vout_thread_t * );
106     int       ( *pf_manage )     ( vout_thread_t * );
107     void      ( *pf_render )     ( vout_thread_t *, picture_t * );
108     void      ( *pf_display )    ( vout_thread_t *, picture_t * );
109     void      ( *pf_swap )       ( vout_thread_t * );         /* OpenGL only */
110     int       ( *pf_lock )       ( vout_thread_t * );         /* OpenGL only */
111     void      ( *pf_unlock )     ( vout_thread_t * );         /* OpenGL only */
112     int       ( *pf_control )    ( vout_thread_t *, int, va_list );
113     /**@}*/
114
115     /** \name Statistics
116      * These numbers are not supposed to be accurate, but are a
117      * good indication of the thread status */
118     /**@{*/
119     count_t       c_fps_samples;                         /**< picture counts */
120     mtime_t       p_fps_sample[VOUT_FPS_SAMPLES];     /**< FPS samples dates */
121     /**@}*/
122
123     /** \name Video heap and translation tables */
124     /**@{*/
125     int                 i_heap_size;                          /**< heap size */
126     picture_heap_t      render;                       /**< rendered pictures */
127     picture_heap_t      output;                          /**< direct buffers */
128     vlc_bool_t          b_direct;            /**< rendered are like direct ? */
129     vout_chroma_t       chroma;                      /**< translation tables */
130
131     video_format_t      fmt_render;      /* render format (from the decoder) */
132     video_format_t      fmt_in;            /* input (modified render) format */
133     video_format_t      fmt_out;     /* output format (for the video output) */
134     /**@}*/
135
136     /* Picture heap */
137     picture_t           p_picture[2*VOUT_MAX_PICTURES+1];      /**< pictures */
138
139     /* Subpicture unit */
140     spu_t            *p_spu;
141
142     /* Statistics */
143     count_t          c_loops;
144     count_t          c_pictures, c_late_pictures;
145     mtime_t          display_jitter;    /**< average deviation from the PTS */
146     count_t          c_jitter_samples;  /**< number of samples used
147                                            for the calculation of the
148                                            jitter  */
149     /** delay created by internal caching */
150     int                 i_pts_delay;
151
152     /* Filter chain */
153     char *psz_filter_chain;
154     vlc_bool_t b_filter_change;
155
156     /* Video filter2 chain
157      * these are handled like in transcode.c
158      * XXX: we might need to merge the two chains (v1 and v2 filters) */
159     char       *psz_vfilters[MAX_VFILTERS];
160     config_chain_t *p_vfilters_cfg[MAX_VFILTERS];
161     int         i_vfilters_cfg;
162
163     filter_t   *pp_vfilters[MAX_VFILTERS];
164     int         i_vfilters;
165
166     vlc_bool_t b_vfilter_change;
167
168     /* Misc */
169     vlc_bool_t       b_snapshot;     /**< take one snapshot on the next loop */
170 };
171
172 #define I_OUTPUTPICTURES p_vout->output.i_pictures
173 #define PP_OUTPUTPICTURE p_vout->output.pp_picture
174 #define I_RENDERPICTURES p_vout->render.i_pictures
175 #define PP_RENDERPICTURE p_vout->render.pp_picture
176
177 /** \defgroup vout_changes Flags for changes
178  * These flags are set in the vout_thread_t::i_changes field when another
179  * thread changed a variable
180  * @{
181  */
182 /** b_info changed */
183 #define VOUT_INFO_CHANGE        0x0001
184 /** b_grayscale changed */
185 #define VOUT_GRAYSCALE_CHANGE   0x0002
186 /** b_interface changed */
187 #define VOUT_INTF_CHANGE        0x0004
188 /** b_scale changed */
189 #define VOUT_SCALE_CHANGE       0x0008
190 /** gamma changed */
191 #define VOUT_GAMMA_CHANGE       0x0010
192 /** b_cursor changed */
193 #define VOUT_CURSOR_CHANGE      0x0020
194 /** b_fullscreen changed */
195 #define VOUT_FULLSCREEN_CHANGE  0x0040
196 /** size changed */
197 #define VOUT_SIZE_CHANGE        0x0200
198 /** depth changed */
199 #define VOUT_DEPTH_CHANGE       0x0400
200 /** change chroma tables */
201 #define VOUT_CHROMA_CHANGE      0x0800
202 /** cropping parameters changed */
203 #define VOUT_CROP_CHANGE        0x1000
204 /** aspect ratio changed */
205 #define VOUT_ASPECT_CHANGE      0x2000
206 /** change/recreate picture buffers */
207 #define VOUT_PICTURE_BUFFERS_CHANGE 0x4000
208 /**@}*/
209
210 /* Alignment flags */
211 #define VOUT_ALIGN_LEFT         0x0001
212 #define VOUT_ALIGN_RIGHT        0x0002
213 #define VOUT_ALIGN_HMASK        0x0003
214 #define VOUT_ALIGN_TOP          0x0004
215 #define VOUT_ALIGN_BOTTOM       0x0008
216 #define VOUT_ALIGN_VMASK        0x000C
217
218 #define MAX_JITTER_SAMPLES      20
219
220 /*****************************************************************************
221  * Prototypes
222  *****************************************************************************/
223 #define vout_Request(a,b,c) __vout_Request(VLC_OBJECT(a),b,c)
224 VLC_EXPORT( vout_thread_t *, __vout_Request,    ( vlc_object_t *, vout_thread_t *, video_format_t * ) );
225 #define vout_Create(a,b) __vout_Create(VLC_OBJECT(a),b)
226 VLC_EXPORT( vout_thread_t *, __vout_Create,       ( vlc_object_t *, video_format_t * ) );
227 VLC_EXPORT( void,            vout_Destroy,        ( vout_thread_t * ) );
228 VLC_EXPORT( int, vout_VarCallback, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
229
230 VLC_EXPORT( int,             vout_ChromaCmp,      ( uint32_t, uint32_t ) );
231
232 VLC_EXPORT( picture_t *,     vout_CreatePicture,  ( vout_thread_t *, vlc_bool_t, vlc_bool_t, unsigned int ) );
233 VLC_EXPORT( void,            vout_InitFormat,     ( video_frame_format_t *, uint32_t, int, int, int ) );
234 VLC_EXPORT( void,            vout_DestroyPicture, ( vout_thread_t *, picture_t * ) );
235 VLC_EXPORT( void,            vout_DisplayPicture, ( vout_thread_t *, picture_t * ) );
236 VLC_EXPORT( void,            vout_DatePicture,    ( vout_thread_t *, picture_t *, mtime_t ) );
237 VLC_EXPORT( void,            vout_LinkPicture,    ( vout_thread_t *, picture_t * ) );
238 VLC_EXPORT( void,            vout_UnlinkPicture,  ( vout_thread_t *, picture_t * ) );
239 VLC_EXPORT( void,            vout_PlacePicture,   ( vout_thread_t *, unsigned int, unsigned int, unsigned int *, unsigned int *, unsigned int *, unsigned int * ) );
240 picture_t *     vout_RenderPicture  ( vout_thread_t *, picture_t *,
241                                                        subpicture_t * );
242
243 VLC_EXPORT( int, vout_vaControlDefault, ( vout_thread_t *, int, va_list ) );
244 VLC_EXPORT( void *, vout_RequestWindow, ( vout_thread_t *, int *, int *, unsigned int *, unsigned int * ) );
245 VLC_EXPORT( void,   vout_ReleaseWindow, ( vout_thread_t *, void * ) );
246 VLC_EXPORT( int, vout_ControlWindow, ( vout_thread_t *, void *, int, va_list ) );
247 void vout_IntfInit( vout_thread_t * );
248
249 VLC_EXPORT( void, vout_EnableFilter, ( vout_thread_t *, char *,vlc_bool_t , vlc_bool_t  ) );
250
251
252 static inline int vout_vaControl( vout_thread_t *p_vout, int i_query,
253                                   va_list args )
254 {
255     if( p_vout->pf_control )
256         return p_vout->pf_control( p_vout, i_query, args );
257     else
258         return VLC_EGENERIC;
259 }
260
261 static inline int vout_Control( vout_thread_t *p_vout, int i_query, ... )
262 {
263     va_list args;
264     int i_result;
265
266     va_start( args, i_query );
267     i_result = vout_vaControl( p_vout, i_query, args );
268     va_end( args );
269     return i_result;
270 }
271
272 enum output_query_e
273 {
274     VOUT_GET_SIZE,         /* arg1= unsigned int*, arg2= unsigned int*, res= */
275     VOUT_SET_SIZE,         /* arg1= unsigned int, arg2= unsigned int, res= */
276     VOUT_SET_STAY_ON_TOP,  /* arg1= vlc_bool_t       res=    */
277     VOUT_REPARENT,
278     VOUT_SNAPSHOT,
279     VOUT_CLOSE,
280     VOUT_SET_FOCUS,         /* arg1= vlc_bool_t       res=    */
281     VOUT_SET_VIEWPORT       /* arg1= view rect, arg2=clip rect, res= */
282 };
283
284 /**
285  * @}
286  */