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
8 * $Id: video_output.h,v 1.58 2001/05/01 04:18:17 sam Exp $
10 * Authors: Vincent Seguin <seguin@via.ecp.fr>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
25 *****************************************************************************/
27 /*****************************************************************************
28 * vout_yuv_convert_t: YUV conversion function
29 *****************************************************************************
30 * This is the prototype common to all conversion functions. The type of p_pic
31 * will change depending on the processed screen depth.
33 * p_vout video output thread
34 * p_pic picture address
35 * p_y, p_u, p_v Y,U,V samples addresses
36 * i_width, i_height Y samples extension
37 * i_pic_width, i_pic_height picture extension
38 * i_pic_line_width picture total line width
39 * i_matrix_coefficients matrix coefficients
40 * Picture width and source dimensions must be multiples of 16.
41 *****************************************************************************/
42 typedef void (vout_yuv_convert_t)( p_vout_thread_t p_vout, void *p_pic,
43 yuv_data_t *p_y, yuv_data_t *p_u, yuv_data_t *p_v,
44 int i_width, int i_height,
45 int i_pic_width, int i_pic_height, int i_pic_line_width,
46 int i_matrix_coefficients );
48 /*****************************************************************************
49 * vout_yuv_t: pre-calculated YUV conversion tables
50 *****************************************************************************
51 * These tables are used by conversion and scaling functions.
52 *****************************************************************************/
53 typedef int (yuv_init_t) ( p_vout_thread_t p_vout );
54 typedef int (yuv_reset_t) ( p_vout_thread_t p_vout );
55 typedef void (yuv_end_t) ( p_vout_thread_t p_vout );
57 typedef struct vout_yuv_s
59 /* conversion functions */
60 vout_yuv_convert_t *pf_yuv420; /* YUV 4:2:0 converter */
61 vout_yuv_convert_t *pf_yuv422; /* YUV 4:2:2 converter */
62 vout_yuv_convert_t *pf_yuv444; /* YUV 4:4:4 converter */
64 /* Pre-calculated conversion tables */
65 void * p_base; /* base for all conversion tables */
68 u8 * p_gray8; /* gray 8 bits table */
69 u16 * p_gray16; /* gray 16 bits table */
70 u32 * p_gray32; /* gray 32 bits table */
71 u8 * p_rgb8; /* RGB 8 bits table */
72 u16 * p_rgb16; /* RGB 16 bits table */
73 u32 * p_rgb32; /* RGB 32 bits table */
76 /* Temporary conversion buffer and offset array */
77 void * p_buffer; /* conversion buffer */
78 int * p_offset; /* offset array */
80 /* Plugin used and shortcuts to access its capabilities */
81 struct module_s * p_module;
82 yuv_init_t * pf_init; /* initialize YUV tables */
83 yuv_reset_t * pf_reset; /* reset YUV tables */
84 yuv_end_t * pf_end; /* free YUV tables */
88 /*****************************************************************************
89 * vout_buffer_t: rendering buffer
90 *****************************************************************************
91 * This structure stores information about a buffer. Buffers are not completely
92 * cleared between displays, and modified areas need to be stored.
93 *****************************************************************************/
94 typedef struct vout_buffer_s
97 int i_pic_x, i_pic_y; /* picture position */
98 int i_pic_width, i_pic_height; /* picture size */
100 /* Other areas - only vertical extensions of areas are stored */
101 int i_areas; /* number of areas */
102 int pi_area_begin[VOUT_MAX_AREAS]; /* beginning of area */
103 int pi_area_end[VOUT_MAX_AREAS]; /* end of area */
106 byte_t * p_data; /* memory address */
109 /*****************************************************************************
111 *****************************************************************************/
112 typedef struct vout_fifo_s
114 /* See the fifo types below */
117 int i_fifo; /* Just to keep track of the fifo index */
122 vlc_mutex_t data_lock;
123 vlc_cond_t data_wait;
127 #define VOUT_EMPTY_FIFO 0
128 #define VOUT_YUV_FIFO 1
129 #define VOUT_SPU_FIFO 2
131 /*****************************************************************************
132 * vout_thread_t: video output thread descriptor
133 *****************************************************************************
134 * Any independant video output device, such as an X11 window or a GGI device,
135 * is represented by a video output thread, and described using the following
137 *****************************************************************************/
138 typedef struct vout_thread_s
140 /* Thread properties and lock */
141 boolean_t b_die; /* `die' flag */
142 boolean_t b_error; /* `error' flag */
143 boolean_t b_active; /* `active' flag */
144 vlc_thread_t thread_id; /* id for pthread functions */
145 vlc_mutex_t picture_lock; /* picture heap lock */
146 vlc_mutex_t subpicture_lock; /* subpicture heap lock */
147 vlc_mutex_t change_lock; /* thread change lock */
148 int * pi_status; /* temporary status flag */
149 p_vout_sys_t p_sys; /* system output method */
151 /* Current display properties */
152 u16 i_changes; /* changes made to the thread */
153 int i_width; /* current output method width */
154 int i_height; /* current output method height */
155 int i_bytes_per_line; /* bytes per line (incl. virtual) */
156 int i_screen_depth; /* significant bpp: 8, 15, 16 or 24 */
157 int i_bytes_per_pixel;/* real screen depth: 1, 2, 3 or 4 */
158 float f_gamma; /* gamma */
159 boolean_t b_need_render; /* does the output method need a YUV
162 /* Color masks and shifts in RGB mode - masks are set by system
163 * initialization, shifts are calculated. A pixel color value can be
164 * obtained using the formula ((value >> rshift) << lshift) */
165 u32 i_red_mask; /* red mask */
166 u32 i_green_mask; /* green mask */
167 u32 i_blue_mask; /* blue mask */
168 int i_red_lshift, i_red_rshift; /* red shifts */
169 int i_green_lshift, i_green_rshift; /* green shifts */
170 int i_blue_lshift, i_blue_rshift; /* blue shifts */
172 /* Useful pre-calculated pixel values - these are not supposed to be
173 * accurate values, but rather values looking nice, given their usage. */
174 u32 i_white_pixel; /* white */
175 u32 i_black_pixel; /* black */
176 u32 i_gray_pixel; /* gray */
177 u32 i_blue_pixel; /* blue */
179 /* Plugin used and shortcuts to access its capabilities */
180 struct module_s * p_module;
181 int ( *pf_create ) ( struct vout_thread_s * );
182 int ( *pf_init ) ( struct vout_thread_s * );
183 void ( *pf_end ) ( struct vout_thread_s * );
184 void ( *pf_destroy ) ( struct vout_thread_s * );
185 int ( *pf_manage ) ( struct vout_thread_s * );
186 void ( *pf_display ) ( struct vout_thread_s * );
187 void ( *pf_setpalette ) ( struct vout_thread_s *, u16 *red,
188 u16 *green, u16 *blue, u16 *transp );
190 /* Pictures and rendering properties */
191 boolean_t b_grayscale; /* color or grayscale display */
192 boolean_t b_YCbr; /* use YUV to YCbr instead of RGB */
193 boolean_t b_info; /* print additional information */
194 boolean_t b_interface; /* render interface */
195 boolean_t b_scale; /* allow picture scaling */
196 mtime_t render_time; /* last picture render time */
199 /* Idle screens management */
200 mtime_t last_display_date; /* last non idle display date */
201 mtime_t last_idle_date; /* last idle display date */
202 mtime_t init_display_date;
204 /* Statistics - these numbers are not supposed to be accurate, but are a
205 * good indication of the thread status */
206 count_t c_fps_samples; /* picture counts */
207 mtime_t p_fps_sample[VOUT_FPS_SAMPLES]; /* FPS samples dates */
209 /* Rendering buffers */
210 int i_buffer_index; /* buffer index */
211 vout_buffer_t p_buffer[2]; /* buffers properties */
213 /* Video heap and translation tables */
214 picture_t p_picture[VOUT_MAX_PICTURES]; /* pictures */
215 subpicture_t p_subpicture[VOUT_MAX_PICTURES]; /* subpictures */
216 int i_pictures; /* current heap size */
217 vout_yuv_t yuv; /* translation tables */
218 picture_t * p_rendered_pic; /* picture currently being rendered */
221 p_vout_font_t p_default_font; /* default font */
222 p_vout_font_t p_large_font; /* large font */
229 /* Flags for changes - these flags are set in the i_changes field when another
230 * thread changed a variable */
231 #define VOUT_INFO_CHANGE 0x0001 /* b_info changed */
232 #define VOUT_GRAYSCALE_CHANGE 0x0002 /* b_grayscale changed */
233 #define VOUT_INTF_CHANGE 0x0004 /* b_interface changed */
234 #define VOUT_SCALE_CHANGE 0x0008 /* b_scale changed */
235 #define VOUT_GAMMA_CHANGE 0x0010 /* gamma changed */
236 #define VOUT_CURSOR_CHANGE 0x0020 /* b_cursor changed */
237 #define VOUT_FULLSCREEN_CHANGE 0x0040 /* b_fullscreen changed */
238 #define VOUT_SIZE_CHANGE 0x0200 /* size changed */
239 #define VOUT_DEPTH_CHANGE 0x0400 /* depth changed */
240 #define VOUT_YUV_CHANGE 0x0800 /* change yuv tables */
242 /* Disabled for thread deadlocks issues --Meuuh */
243 //#define VOUT_NODISPLAY_CHANGE 0xff00 /* changes which forbidden display */
245 /*****************************************************************************
247 *****************************************************************************/
249 /* RGB2PIXEL: assemble RGB components to a pixel value, returns a u32 */
250 #define RGB2PIXEL( p_vout, i_red, i_green, i_blue ) \
251 (((((u32)i_red) >> p_vout->i_red_rshift) << p_vout->i_red_lshift) | \
252 ((((u32)i_green) >> p_vout->i_green_rshift) << p_vout->i_green_lshift) | \
253 ((((u32)i_blue) >> p_vout->i_blue_rshift) << p_vout->i_blue_lshift))
256 /*****************************************************************************
258 *****************************************************************************/
259 vout_thread_t * vout_CreateThread ( int *pi_status );
260 void vout_DestroyThread ( vout_thread_t *p_vout, int *pi_status );
262 vout_fifo_t * vout_CreateFifo ( void );
263 void vout_DestroyFifo ( vout_fifo_t *p_fifo );
264 void vout_FreeFifo ( vout_fifo_t *p_fifo );
266 picture_t * vout_CreatePicture ( vout_thread_t *p_vout, int i_type,
267 int i_width, int i_height );
268 void vout_DestroyPicture ( vout_thread_t *p_vout, picture_t *p_pic );
269 void vout_DisplayPicture ( vout_thread_t *p_vout, picture_t *p_pic );
270 void vout_DatePicture ( vout_thread_t *p_vout, picture_t *p_pic, mtime_t date );
271 void vout_LinkPicture ( vout_thread_t *p_vout, picture_t *p_pic );
272 void vout_UnlinkPicture ( vout_thread_t *p_vout, picture_t *p_pic );
274 subpicture_t * vout_CreateSubPicture ( vout_thread_t *p_vout, int i_type, int i_size );
275 void vout_DestroySubPicture ( vout_thread_t *p_vout, subpicture_t *p_subpic );
276 void vout_DisplaySubPicture ( vout_thread_t *p_vout, subpicture_t *p_subpic );
278 void vout_SetBuffers ( vout_thread_t *p_vout, void *p_buf1, void *p_buf2 );