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
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 GNU
19 * General Public License for more details.
21 * You should have received a copy of the GNU General Public
22 * License along with this program; if not, write to the
23 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 * Boston, MA 02111-1307, USA.
25 *****************************************************************************/
27 /*****************************************************************************
28 * vout_yuv_convert_t: YUV convertion function
29 *****************************************************************************
30 * This is the prototype common to all convertion functions. The type of p_pic
31 * will change depending of the screen depth treated.
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 convertion tables
50 *****************************************************************************
51 * These tables are used by convertion and scaling functions.
52 *****************************************************************************/
53 typedef struct vout_yuv_s
55 /* Convertion functions */
56 vout_yuv_convert_t * p_Convert420; /* YUV 4:2:0 converter */
57 vout_yuv_convert_t * p_Convert422; /* YUV 4:2:2 converter */
58 vout_yuv_convert_t * p_Convert444; /* YUV 4:4:4 converter */
60 /* Pre-calculated convertion tables */
61 void * p_base; /* base for all conversion tables */
64 u8 * p_gray8; /* gray 8 bits table */
65 u16 * p_gray16; /* gray 16 bits table */
66 u32 * p_gray32; /* gray 32 bits table */
67 u8 * p_rgb8; /* RGB 8 bits table */
68 u16 * p_rgb16; /* RGB 16 bits table */
69 u32 * p_rgb32; /* RGB 32 bits table */
72 /* Temporary convertion buffer and offset array */
73 void * p_buffer; /* convertion buffer */
74 int * p_offset; /* offset array */
77 /*****************************************************************************
78 * vout_buffer_t: rendering buffer
79 *****************************************************************************
80 * This structure store informations about a buffer. Buffers are not completely
81 * cleared between displays, and modified areas need to be stored.
82 *****************************************************************************/
83 typedef struct vout_buffer_s
86 int i_pic_x, i_pic_y; /* picture position */
87 int i_pic_width, i_pic_height; /* picture extension */
89 /* Other areas - only vertical extensions of areas are stored */
90 int i_areas; /* number of areas */
91 int pi_area_begin[VOUT_MAX_AREAS]; /* beginning of area */
92 int pi_area_end[VOUT_MAX_AREAS]; /* end of area */
95 byte_t * p_data; /* memory address */
98 /*****************************************************************************
99 * vout_thread_t: video output thread descriptor
100 *****************************************************************************
101 * Any independant video output device, such as an X11 window or a GGI device,
102 * is represented by a video output thread, and described using the following
104 *****************************************************************************/
105 typedef int (vout_sys_create_t) ( p_vout_thread_t p_vout,
106 char *psz_display, int i_root_window );
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 );
112 typedef void (vout_set_palette_t) ( p_vout_thread_t p_vout, u16 *red,
113 u16 *green, u16 *blue, u16 *transp );
115 typedef struct vout_thread_s
117 /* Thread properties and lock */
118 boolean_t b_die; /* `die' flag */
119 boolean_t b_error; /* `error' flag */
120 boolean_t b_active; /* `active' flag */
121 vlc_thread_t thread_id; /* id for pthread functions */
122 vlc_mutex_t picture_lock; /* picture heap lock */
123 vlc_mutex_t subpicture_lock; /* subpicture heap lock */
124 vlc_mutex_t change_lock; /* thread change lock */
125 int * pi_status; /* temporary status flag */
126 p_vout_sys_t p_sys; /* system output method */
128 /* Current display properties */
129 u16 i_changes; /* changes made to the thread */
130 int i_width; /* current output method width */
131 int i_height; /* current output method height */
132 int i_bytes_per_line; /* bytes per line (incl. virtual) */
133 int i_screen_depth; /* significant bpp: 8, 15, 16 or 24 */
134 int i_bytes_per_pixel;/* real screen depth: 1, 2, 3 or 4 */
135 float f_gamma; /* gamma */
137 /* Color masks and shifts in RGB mode - masks are set by system
138 * initialization, shifts are calculated. A pixel color value can be
139 * obtained using the formula ((value >> rshift) << lshift) */
140 u32 i_red_mask; /* red mask */
141 u32 i_green_mask; /* green mask */
142 u32 i_blue_mask; /* blue mask */
143 int i_red_lshift, i_red_rshift; /* red shifts */
144 int i_green_lshift, i_green_rshift; /* green shifts */
145 int i_blue_lshift, i_blue_rshift; /* blue shifts */
147 /* Useful pre-calculated pixel values - these are not supposed to be
148 * accurate values, but rather values looking nice, given their usage. */
149 u32 i_white_pixel; /* white */
150 u32 i_black_pixel; /* black */
151 u32 i_gray_pixel; /* gray */
152 u32 i_blue_pixel; /* blue */
155 void * p_vout_plugin; /* video output plugin */
156 vout_sys_create_t * p_sys_create; /* allocate output method */
157 vout_sys_init_t * p_sys_init; /* initialize output method */
158 vout_sys_end_t * p_sys_end; /* terminate output method */
159 vout_sys_destroy_t * p_sys_destroy; /* destroy output method */
160 vout_sys_manage_t * p_sys_manage; /* handle events */
161 vout_sys_display_t * p_sys_display; /* display rendered image */
162 vout_set_palette_t * p_set_palette; /* sets 8bpp palette */
164 /* Pictures and rendering properties */
165 boolean_t b_grayscale; /* color or grayscale display */
166 boolean_t b_info; /* print additionnal informations */
167 boolean_t b_interface; /* render interface */
168 boolean_t b_scale; /* allow picture scaling */
170 /* Idle screens management */
171 mtime_t last_display_date; /* last non idle display date */
172 mtime_t last_idle_date; /* last idle display date */
175 /* Statistics - these numbers are not supposed to be accurate, but are a
176 * good indication of the thread status */
177 mtime_t render_time; /* last picture render time */
178 count_t c_fps_samples; /* picture counts */
179 mtime_t p_fps_sample[VOUT_FPS_SAMPLES]; /* FPS samples dates */
182 /* Rendering buffers */
183 int i_buffer_index; /* buffer index */
184 vout_buffer_t p_buffer[2]; /* buffers properties */
186 /* Videos heap and translation tables */
187 picture_t p_picture[VOUT_MAX_PICTURES]; /* pictures */
188 subpicture_t p_subpicture[VOUT_MAX_PICTURES]; /* subpictures */
189 int i_pictures; /* current heap size */
190 vout_yuv_t yuv; /* translation tables */
193 p_vout_font_t p_default_font; /* default font */
194 p_vout_font_t p_large_font; /* large font */
196 /* Synchronisation informations - synchro level is updated by the vout
197 * thread and read by decoder threads */
198 int i_synchro_level; /* trashing level */
201 /* Flags for changes - these flags are set in the i_changes field when another
202 * thread changed a variable */
203 #define VOUT_INFO_CHANGE 0x0001 /* b_info changed */
204 #define VOUT_GRAYSCALE_CHANGE 0x0002 /* b_grayscale changed */
205 #define VOUT_INTF_CHANGE 0x0004 /* b_interface changed */
206 #define VOUT_SCALE_CHANGE 0x0008 /* b_scale changed */
207 #define VOUT_SIZE_CHANGE 0x0200 /* size changed */
208 #define VOUT_DEPTH_CHANGE 0x0400 /* depth changed */
209 #define VOUT_GAMMA_CHANGE 0x0010 /* gamma changed */
210 #define VOUT_YUV_CHANGE 0x0800 /* change yuv tables */
211 #define VOUT_NODISPLAY_CHANGE 0xff00 /* changes which forbidden display */
213 /*****************************************************************************
215 *****************************************************************************/
217 /* RGB2PIXEL: assemble RGB components to a pixel value, returns a u32 */
218 #define RGB2PIXEL( p_vout, i_red, i_green, i_blue ) \
219 (((((u32)i_red) >> p_vout->i_red_rshift) << p_vout->i_red_lshift) | \
220 ((((u32)i_green) >> p_vout->i_green_rshift) << p_vout->i_green_lshift) | \
221 ((((u32)i_blue) >> p_vout->i_blue_rshift) << p_vout->i_blue_lshift))
224 /*****************************************************************************
226 *****************************************************************************/
227 vout_thread_t * vout_CreateThread ( char *psz_display, int i_root_window,
228 int i_width, int i_height, int *pi_status, int i_method );
229 void vout_DestroyThread ( vout_thread_t *p_vout, int *pi_status );
230 picture_t * vout_CreatePicture ( vout_thread_t *p_vout, int i_type,
231 int i_width, int i_height );
232 void vout_DestroyPicture ( vout_thread_t *p_vout, picture_t *p_pic );
233 void vout_DisplayPicture ( vout_thread_t *p_vout, picture_t *p_pic );
234 void vout_DatePicture ( vout_thread_t *p_vout, picture_t *p_pic, mtime_t date );
235 void vout_LinkPicture ( vout_thread_t *p_vout, picture_t *p_pic );
236 void vout_UnlinkPicture ( vout_thread_t *p_vout, picture_t *p_pic );
237 subpicture_t * vout_CreateSubPicture ( vout_thread_t *p_vout, int i_type, int i_size );
238 void vout_DestroySubPicture ( vout_thread_t *p_vout, subpicture_t *p_subpic );
239 void vout_DisplaySubPicture ( vout_thread_t *p_vout, subpicture_t *p_subpic );
241 void vout_SetBuffers ( vout_thread_t *p_vout, void *p_buf1, void *p_buf2 );