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 oppenned video output thread.
6 *****************************************************************************
7 * Copyright (C) 1999, 2000 VideoLAN
9 * Authors: Vincent Seguin <seguin@via.ecp.fr>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
24 *****************************************************************************/
26 /*****************************************************************************
27 * vout_yuv_convert_t: YUV conversion function
28 *****************************************************************************
29 * This is the prototype common to all conversion functions. The type of p_pic
30 * will change depending on the processed screen depth.
32 * p_vout video output thread
33 * p_pic picture address
34 * p_y, p_u, p_v Y,U,V samples addresses
35 * i_width, i_height Y samples extension
36 * i_pic_width, i_pic_height picture extension
37 * i_pic_line_width picture total line width
38 * i_matrix_coefficients matrix coefficients
39 * Picture width and source dimensions must be multiples of 16.
40 *****************************************************************************/
41 typedef void (vout_yuv_convert_t)( p_vout_thread_t p_vout, void *p_pic,
42 yuv_data_t *p_y, yuv_data_t *p_u, yuv_data_t *p_v,
43 int i_width, int i_height,
44 int i_pic_width, int i_pic_height, int i_pic_line_width,
45 int i_matrix_coefficients );
47 /*****************************************************************************
48 * vout_yuv_t: pre-calculated YUV conversion tables
49 *****************************************************************************
50 * These tables are used by conversion and scaling functions.
51 *****************************************************************************/
52 typedef struct vout_yuv_s
54 /* conversion functions */
55 vout_yuv_convert_t * p_Convert420; /* YUV 4:2:0 converter */
56 vout_yuv_convert_t * p_Convert422; /* YUV 4:2:2 converter */
57 vout_yuv_convert_t * p_Convert444; /* YUV 4:4:4 converter */
59 /* Pre-calculated conversion tables */
60 void * p_base; /* base for all conversion tables */
63 u8 * p_gray8; /* gray 8 bits table */
64 u16 * p_gray16; /* gray 16 bits table */
65 u32 * p_gray32; /* gray 32 bits table */
66 u8 * p_rgb8; /* RGB 8 bits table */
67 u16 * p_rgb16; /* RGB 16 bits table */
68 u32 * p_rgb32; /* RGB 32 bits table */
71 /* Temporary conversion buffer and offset array */
72 void * p_buffer; /* conversion buffer */
73 int * p_offset; /* offset array */
76 /*****************************************************************************
77 * vout_buffer_t: rendering buffer
78 *****************************************************************************
79 * This structure stores information about a buffer. Buffers are not completely
80 * cleared between displays, and modified areas need to be stored.
81 *****************************************************************************/
82 typedef struct vout_buffer_s
85 int i_pic_x, i_pic_y; /* picture position */
86 int i_pic_width, i_pic_height; /* picture size */
88 /* Other areas - only vertical extensions of areas are stored */
89 int i_areas; /* number of areas */
90 int pi_area_begin[VOUT_MAX_AREAS]; /* beginning of area */
91 int pi_area_end[VOUT_MAX_AREAS]; /* end of area */
94 byte_t * p_data; /* memory address */
97 /*****************************************************************************
98 * vout_thread_t: video output thread descriptor
99 *****************************************************************************
100 * Any independant video output device, such as an X11 window or a GGI device,
101 * is represented by a video output thread, and described using the following
103 *****************************************************************************/
104 typedef int (vout_sys_create_t) ( p_vout_thread_t p_vout,
106 int i_root_window, void *p_data );
107 typedef int (vout_sys_init_t) ( p_vout_thread_t p_vout );
108 typedef void (vout_sys_end_t) ( p_vout_thread_t p_vout );
109 typedef void (vout_sys_destroy_t) ( p_vout_thread_t p_vout );
110 typedef int (vout_sys_manage_t) ( p_vout_thread_t p_vout );
111 typedef void (vout_sys_display_t) ( p_vout_thread_t p_vout );
113 typedef void (vout_set_palette_t) ( p_vout_thread_t p_vout, u16 *red,
114 u16 *green, u16 *blue, u16 *transp );
116 typedef int (yuv_sys_init_t) ( p_vout_thread_t p_vout );
117 typedef int (yuv_sys_reset_t) ( p_vout_thread_t p_vout );
118 typedef void (yuv_sys_end_t) ( p_vout_thread_t p_vout );
120 typedef struct vout_thread_s
122 /* Thread properties and lock */
123 boolean_t b_die; /* `die' flag */
124 boolean_t b_error; /* `error' flag */
125 boolean_t b_active; /* `active' flag */
126 vlc_thread_t thread_id; /* id for pthread functions */
127 vlc_mutex_t picture_lock; /* picture heap lock */
128 vlc_mutex_t subpicture_lock; /* subpicture heap lock */
129 vlc_mutex_t change_lock; /* thread change lock */
130 int * pi_status; /* temporary status flag */
131 p_vout_sys_t p_sys; /* system output method */
133 /* Current display properties */
134 u16 i_changes; /* changes made to the thread */
135 int i_width; /* current output method width */
136 int i_height; /* current output method height */
137 int i_bytes_per_line; /* bytes per line (incl. virtual) */
138 int i_screen_depth; /* significant bpp: 8, 15, 16 or 24 */
139 int i_bytes_per_pixel;/* real screen depth: 1, 2, 3 or 4 */
140 float f_gamma; /* gamma */
141 boolean_t b_need_render; /* does the output method need a YUV
144 /* Color masks and shifts in RGB mode - masks are set by system
145 * initialization, shifts are calculated. A pixel color value can be
146 * obtained using the formula ((value >> rshift) << lshift) */
147 u32 i_red_mask; /* red mask */
148 u32 i_green_mask; /* green mask */
149 u32 i_blue_mask; /* blue mask */
150 int i_red_lshift, i_red_rshift; /* red shifts */
151 int i_green_lshift, i_green_rshift; /* green shifts */
152 int i_blue_lshift, i_blue_rshift; /* blue shifts */
154 /* Useful pre-calculated pixel values - these are not supposed to be
155 * accurate values, but rather values looking nice, given their usage. */
156 u32 i_white_pixel; /* white */
157 u32 i_black_pixel; /* black */
158 u32 i_gray_pixel; /* gray */
159 u32 i_blue_pixel; /* blue */
162 vout_sys_create_t * p_sys_create; /* allocate output method */
163 vout_sys_init_t * p_sys_init; /* initialize output method */
164 vout_sys_end_t * p_sys_end; /* terminate output method */
165 vout_sys_destroy_t * p_sys_destroy; /* destroy output method */
166 vout_sys_manage_t * p_sys_manage; /* handle events */
167 vout_sys_display_t * p_sys_display; /* display rendered image */
169 vout_set_palette_t * p_set_palette; /* set 8bpp palette */
171 yuv_sys_init_t * p_yuv_init; /* initialize YUV tables */
172 yuv_sys_reset_t * p_yuv_reset; /* reset YUV tables */
173 yuv_sys_end_t * p_yuv_end; /* free YUV tables */
175 /* Pictures and rendering properties */
176 boolean_t b_grayscale; /* color or grayscale display */
177 boolean_t b_info; /* print additional information */
178 boolean_t b_interface; /* render interface */
179 boolean_t b_scale; /* allow picture scaling */
180 mtime_t render_time; /* last picture render time */
183 /* Idle screens management */
184 mtime_t last_display_date; /* last non idle display date */
185 mtime_t last_idle_date; /* last idle display date */
186 mtime_t init_display_date;
188 /* Statistics - these numbers are not supposed to be accurate, but are a
189 * good indication of the thread status */
190 count_t c_fps_samples; /* picture counts */
191 mtime_t p_fps_sample[VOUT_FPS_SAMPLES]; /* FPS samples dates */
193 /* Rendering buffers */
194 int i_buffer_index; /* buffer index */
195 vout_buffer_t p_buffer[2]; /* buffers properties */
197 /* Video heap and translation tables */
198 picture_t p_picture[VOUT_MAX_PICTURES]; /* pictures */
199 subpicture_t p_subpicture[VOUT_MAX_PICTURES]; /* subpictures */
200 int i_pictures; /* current heap size */
201 vout_yuv_t yuv; /* translation tables */
202 picture_t * p_rendered_pic; /* picture currently being rendered */
205 p_vout_font_t p_default_font; /* default font */
206 p_vout_font_t p_large_font; /* large font */
213 /* Flags for changes - these flags are set in the i_changes field when another
214 * thread changed a variable */
215 #define VOUT_INFO_CHANGE 0x0001 /* b_info changed */
216 #define VOUT_GRAYSCALE_CHANGE 0x0002 /* b_grayscale changed */
217 #define VOUT_INTF_CHANGE 0x0004 /* b_interface changed */
218 #define VOUT_SCALE_CHANGE 0x0008 /* b_scale changed */
219 #define VOUT_SIZE_CHANGE 0x0200 /* size changed */
220 #define VOUT_DEPTH_CHANGE 0x0400 /* depth changed */
221 #define VOUT_GAMMA_CHANGE 0x0010 /* gamma changed */
222 #define VOUT_YUV_CHANGE 0x0800 /* change yuv tables */
224 /* Disabled for thread deadlocks issues --Meuuh */
225 //#define VOUT_NODISPLAY_CHANGE 0xff00 /* changes which forbidden display */
227 /*****************************************************************************
229 *****************************************************************************/
231 /* RGB2PIXEL: assemble RGB components to a pixel value, returns a u32 */
232 #define RGB2PIXEL( p_vout, i_red, i_green, i_blue ) \
233 (((((u32)i_red) >> p_vout->i_red_rshift) << p_vout->i_red_lshift) | \
234 ((((u32)i_green) >> p_vout->i_green_rshift) << p_vout->i_green_lshift) | \
235 ((((u32)i_blue) >> p_vout->i_blue_rshift) << p_vout->i_blue_lshift))
238 /*****************************************************************************
240 *****************************************************************************/
241 vout_thread_t * vout_CreateThread ( char *psz_display, int i_root_window,
242 int i_width, int i_height, int *pi_status,
243 int i_method, void *p_data );
244 void vout_DestroyThread ( vout_thread_t *p_vout, int *pi_status );
245 picture_t * vout_CreatePicture ( vout_thread_t *p_vout, int i_type,
246 int i_width, int i_height );
247 void vout_DestroyPicture ( vout_thread_t *p_vout, picture_t *p_pic );
248 void vout_DisplayPicture ( vout_thread_t *p_vout, picture_t *p_pic );
249 void vout_DatePicture ( vout_thread_t *p_vout, picture_t *p_pic, mtime_t date );
250 void vout_LinkPicture ( vout_thread_t *p_vout, picture_t *p_pic );
251 void vout_UnlinkPicture ( vout_thread_t *p_vout, picture_t *p_pic );
252 subpicture_t * vout_CreateSubPicture ( vout_thread_t *p_vout, int i_type, int i_size );
253 void vout_DestroySubPicture ( vout_thread_t *p_vout, subpicture_t *p_subpic );
254 void vout_DisplaySubPicture ( vout_thread_t *p_vout, subpicture_t *p_subpic );
256 void vout_SetBuffers ( vout_thread_t *p_vout, void *p_buf1, void *p_buf2 );