1 /*****************************************************************************
2 * video_output.h : video output thread
3 * This module describes the programming interface for video output threads.
4 * It includes functions allowing to open a new thread, send pictures to a
5 * thread, and destroy a previously opened video output thread.
6 *****************************************************************************
7 * Copyright (C) 1999, 2000 VideoLAN
8 * $Id: video_output.h,v 1.89 2002/12/07 23:50:30 massiot Exp $
10 * Authors: Vincent Seguin <seguin@via.ecp.fr>
11 * Samuel Hocevar <sam@via.ecp.fr>
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
26 *****************************************************************************/
28 /*****************************************************************************
29 * vout_chroma_t: Chroma conversion function
30 *****************************************************************************
31 * This is the prototype common to all conversion functions.
33 * p_source source picture
34 * p_dest destination picture
35 * Picture width and source dimensions must be multiples of 16.
36 *****************************************************************************/
37 typedef void (vout_chroma_convert_t)( vout_thread_t *,
38 picture_t *, picture_t * );
40 typedef struct vout_chroma_t
42 /* conversion functions */
43 vout_chroma_convert_t *pf_convert;
45 /* Private module-dependant data */
46 chroma_sys_t * p_sys; /* private data */
48 /* Plugin used and shortcuts to access its capabilities */
53 /*****************************************************************************
54 * vout_thread_t: video output thread descriptor
55 *****************************************************************************
56 * Any independant video output device, such as an X11 window or a GGI device,
57 * is represented by a video output thread, and described using the following
59 *****************************************************************************/
64 /* Thread properties and lock */
65 vlc_mutex_t picture_lock; /* picture heap lock */
66 vlc_mutex_t subpicture_lock; /* subpicture heap lock */
67 vlc_mutex_t change_lock; /* thread change lock */
68 vout_sys_t * p_sys; /* system output method */
70 /* Current display properties */
71 uint16_t i_changes; /* changes made to the thread */
72 float f_gamma; /* gamma */
73 vlc_bool_t b_grayscale; /* color or grayscale display */
74 vlc_bool_t b_info; /* print additional information */
75 vlc_bool_t b_interface; /* render interface */
76 vlc_bool_t b_scale; /* allow picture scaling */
77 vlc_bool_t b_fullscreen; /* toogle fullscreen display */
78 mtime_t render_time; /* last picture render time */
79 int i_window_width; /* video window width */
80 int i_window_height; /* video window height */
82 /* Plugin used and shortcuts to access its capabilities */
84 int ( *pf_init ) ( vout_thread_t * );
85 void ( *pf_end ) ( vout_thread_t * );
86 int ( *pf_manage ) ( vout_thread_t * );
87 void ( *pf_render ) ( vout_thread_t *, picture_t * );
88 void ( *pf_display ) ( vout_thread_t *, picture_t * );
90 /* Statistics - these numbers are not supposed to be accurate, but are a
91 * good indication of the thread status */
92 count_t c_fps_samples; /* picture counts */
93 mtime_t p_fps_sample[VOUT_FPS_SAMPLES]; /* FPS samples dates */
95 /* Video heap and translation tables */
96 int i_heap_size; /* heap size */
97 picture_heap_t render; /* rendered pictures */
98 picture_heap_t output; /* direct buffers */
99 vlc_bool_t b_direct; /* rendered are like direct ? */
100 vout_chroma_t chroma; /* translation tables */
102 /* Picture and subpicture heaps */
103 picture_t p_picture[2*VOUT_MAX_PICTURES]; /* pictures */
104 subpicture_t p_subpicture[VOUT_MAX_PICTURES]; /* subpictures */
107 vout_font_t * p_default_font; /* default font */
108 vout_font_t * p_large_font; /* large font */
112 count_t c_pictures, c_late_pictures;
113 mtime_t display_jitter; /* average deviation from the PTS */
114 count_t c_jitter_samples; /* number of samples used for the *
115 * calculation of the jitter */
118 char *psz_filter_chain;
121 #define I_OUTPUTPICTURES p_vout->output.i_pictures
122 #define PP_OUTPUTPICTURE p_vout->output.pp_picture
123 #define I_RENDERPICTURES p_vout->render.i_pictures
124 #define PP_RENDERPICTURE p_vout->render.pp_picture
126 /* Flags for changes - these flags are set in the i_changes field when another
127 * thread changed a variable */
128 #define VOUT_INFO_CHANGE 0x0001 /* b_info changed */
129 #define VOUT_GRAYSCALE_CHANGE 0x0002 /* b_grayscale changed */
130 #define VOUT_INTF_CHANGE 0x0004 /* b_interface changed */
131 #define VOUT_SCALE_CHANGE 0x0008 /* b_scale changed */
132 #define VOUT_GAMMA_CHANGE 0x0010 /* gamma changed */
133 #define VOUT_CURSOR_CHANGE 0x0020 /* b_cursor changed */
134 #define VOUT_FULLSCREEN_CHANGE 0x0040 /* b_fullscreen changed */
135 #define VOUT_SIZE_CHANGE 0x0200 /* size changed */
136 #define VOUT_DEPTH_CHANGE 0x0400 /* depth changed */
137 #define VOUT_CHROMA_CHANGE 0x0800 /* change chroma tables */
139 #define MAX_JITTER_SAMPLES 20
141 /*****************************************************************************
143 *****************************************************************************/
144 #define vout_Request(a,b,c,d,e,f) __vout_Request(VLC_OBJECT(a),b,c,d,e,f)
145 VLC_EXPORT( vout_thread_t *, __vout_Request, ( vlc_object_t *, vout_thread_t *, unsigned int, unsigned int, uint32_t, unsigned int ) );
146 #define vout_Create(a,b,c,d,e) __vout_Create(VLC_OBJECT(a),b,c,d,e)
147 VLC_EXPORT( vout_thread_t *, __vout_Create, ( vlc_object_t *, unsigned int, unsigned int, uint32_t, unsigned int ) );
148 VLC_EXPORT( void, vout_Destroy, ( vout_thread_t * ) );
149 VLC_EXPORT( int, vout_VarCallback, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
151 VLC_EXPORT( int, vout_ChromaCmp, ( uint32_t, uint32_t ) );
153 VLC_EXPORT( picture_t *, vout_CreatePicture, ( vout_thread_t *, vlc_bool_t, vlc_bool_t, vlc_bool_t ) );
154 VLC_EXPORT( void, vout_AllocatePicture,( vout_thread_t *, picture_t *, int, int, uint32_t ) );
155 VLC_EXPORT( void, vout_DestroyPicture, ( vout_thread_t *, picture_t * ) );
156 VLC_EXPORT( void, vout_DisplayPicture, ( vout_thread_t *, picture_t * ) );
157 VLC_EXPORT( void, vout_DatePicture, ( vout_thread_t *, picture_t *, mtime_t ) );
158 VLC_EXPORT( void, vout_LinkPicture, ( vout_thread_t *, picture_t * ) );
159 VLC_EXPORT( void, vout_UnlinkPicture, ( vout_thread_t *, picture_t * ) );
160 VLC_EXPORT( void, vout_PlacePicture, ( vout_thread_t *, unsigned int, unsigned int, unsigned int *, unsigned int *, unsigned int *, unsigned int * ) );
161 picture_t * vout_RenderPicture ( vout_thread_t *, picture_t *,
164 VLC_EXPORT( subpicture_t *, vout_CreateSubPicture, ( vout_thread_t *, int ) );
165 VLC_EXPORT( void, vout_DestroySubPicture, ( vout_thread_t *, subpicture_t * ) );
166 VLC_EXPORT( void, vout_DisplaySubPicture, ( vout_thread_t *, subpicture_t * ) );
168 subpicture_t * vout_SortSubPictures ( vout_thread_t *, mtime_t );
169 void vout_RenderSubPictures ( vout_thread_t *, picture_t *,