1 /*****************************************************************************
2 * video_output.h : video output thread
4 *****************************************************************************
5 * This module describes the programming interface for video output threads.
6 * It includes functions allowing to open a new thread, send pictures to a
7 * thread, and destroy a previously oppenned video output thread.
8 *****************************************************************************/
10 /*****************************************************************************
11 * vout_yuv_convert_t: YUV convertion function
12 *****************************************************************************
13 * This is the prototype common to all convertion functions. The type of p_pic
14 * will change depending of the screen depth treated.
16 * p_vout video output thread
17 * p_pic picture address
18 * p_y, p_u, p_v Y,U,V samples addresses
19 * i_width, i_height Y samples extension
20 * i_pic_width, i_pic_height picture extension
21 * i_pic_line_width picture total line width
22 * i_matrix_coefficients matrix coefficients
23 * Picture width and source dimensions must be multiples of 16.
24 *****************************************************************************/
25 typedef void (vout_yuv_convert_t)( p_vout_thread_t p_vout, void *p_pic,
26 yuv_data_t *p_y, yuv_data_t *p_u, yuv_data_t *p_v,
27 int i_width, int i_height,
28 int i_pic_width, int i_pic_height, int i_pic_line_width,
29 int i_matrix_coefficients );
31 /*****************************************************************************
32 * vout_yuv_t: pre-calculated YUV convertion tables
33 *****************************************************************************
34 * These tables are used by convertion and scaling functions.
35 *****************************************************************************/
36 typedef struct vout_yuv_s
38 /* Convertion functions */
39 vout_yuv_convert_t * p_Convert420; /* YUV 4:2:0 converter */
40 vout_yuv_convert_t * p_Convert422; /* YUV 4:2:2 converter */
41 vout_yuv_convert_t * p_Convert444; /* YUV 4:4:4 converter */
43 /* Pre-calculated convertion tables */
44 void * p_base; /* base for all conversion tables */
47 u8 * p_gray8; /* gray 8 bits table */
48 u16 * p_gray16; /* gray 16 bits table */
49 u32 * p_gray32; /* gray 32 bits table */
50 u8 * p_rgb8; /* RGB 8 bits table */
51 u16 * p_rgb16; /* RGB 16 bits table */
52 u32 * p_rgb32; /* RGB 32 bits table */
55 /* Temporary convertion buffer and offset array */
56 void * p_buffer; /* convertion buffer */
57 int * p_offset; /* offset array */
60 /*****************************************************************************
61 * vout_buffer_t: rendering buffer
62 *****************************************************************************
63 * This structure store informations about a buffer. Buffers are not completely
64 * cleared between displays, and modified areas need to be stored.
65 *****************************************************************************/
66 typedef struct vout_buffer_s
69 int i_pic_x, i_pic_y; /* picture position */
70 int i_pic_width, i_pic_height; /* picture extension */
72 /* Other areas - only vertical extensions of areas are stored */
73 int i_areas; /* number of areas */
74 int pi_area_begin[VOUT_MAX_AREAS]; /* beginning of area */
75 int pi_area_end[VOUT_MAX_AREAS]; /* end of area */
78 byte_t * p_data; /* memory address */
81 /*****************************************************************************
82 * vout_thread_t: video output thread descriptor
83 *****************************************************************************
84 * Any independant video output device, such as an X11 window or a GGI device,
85 * is represented by a video output thread, and described using the following
87 *****************************************************************************/
88 typedef int (vout_sys_create_t) ( p_vout_thread_t p_vout,
89 char *psz_display, int i_root_window );
90 typedef int (vout_sys_init_t) ( p_vout_thread_t p_vout );
91 typedef void (vout_sys_end_t) ( p_vout_thread_t p_vout );
92 typedef void (vout_sys_destroy_t) ( p_vout_thread_t p_vout );
93 typedef int (vout_sys_manage_t) ( p_vout_thread_t p_vout );
94 typedef void (vout_sys_display_t) ( p_vout_thread_t p_vout );
95 typedef void (vout_set_palette_t) ( p_vout_thread_t p_vout, u16 *red,
96 u16 *green, u16 *blue, u16 *transp );
98 typedef struct vout_thread_s
100 /* Thread properties and lock */
101 boolean_t b_die; /* `die' flag */
102 boolean_t b_error; /* `error' flag */
103 boolean_t b_active; /* `active' flag */
104 vlc_thread_t thread_id; /* id for pthread functions */
105 vlc_mutex_t picture_lock; /* picture heap lock */
106 vlc_mutex_t subpicture_lock; /* subpicture heap lock */
107 vlc_mutex_t change_lock; /* thread change lock */
108 int * pi_status; /* temporary status flag */
109 p_vout_sys_t p_sys; /* system output method */
110 int i_method; /* display method */
112 /* Current display properties */
113 u16 i_changes; /* changes made to the thread */
114 int i_width; /* current output method width */
115 int i_height; /* current output method height */
116 int i_bytes_per_line; /* bytes per line (incl. virtual) */
117 int i_screen_depth; /* significant bpp: 8, 15, 16 or 24 */
118 int i_bytes_per_pixel;/* real screen depth: 1, 2, 3 or 4 */
119 float f_gamma; /* gamma */
121 /* Color masks and shifts in RGB mode - masks are set by system
122 * initialization, shifts are calculated. A pixel color value can be
123 * obtained using the formula ((value >> rshift) << lshift) */
124 u32 i_red_mask; /* red mask */
125 u32 i_green_mask; /* green mask */
126 u32 i_blue_mask; /* blue mask */
127 int i_red_lshift, i_red_rshift; /* red shifts */
128 int i_green_lshift, i_green_rshift; /* green shifts */
129 int i_blue_lshift, i_blue_rshift; /* blue shifts */
131 /* Useful pre-calculated pixel values - these are not supposed to be
132 * accurate values, but rather values looking nice, given their usage. */
133 u32 i_white_pixel; /* white */
134 u32 i_black_pixel; /* black */
135 u32 i_gray_pixel; /* gray */
136 u32 i_blue_pixel; /* blue */
138 /* method-dependant functions */
139 vout_sys_create_t * p_sys_create; /* allocate output method */
140 vout_sys_init_t * p_sys_init; /* initialize output method */
141 vout_sys_end_t * p_sys_end; /* terminate output method */
142 vout_sys_destroy_t * p_sys_destroy; /* destroy output method */
143 vout_sys_manage_t * p_sys_manage; /* handle events */
144 vout_sys_display_t * p_sys_display; /* display rendered image */
145 vout_set_palette_t * p_set_palette; /* sets 8bpp palette */
147 /* Pictures and rendering properties */
148 boolean_t b_grayscale; /* color or grayscale display */
149 boolean_t b_info; /* print additionnal informations */
150 boolean_t b_interface; /* render interface */
151 boolean_t b_scale; /* allow picture scaling */
153 /* Idle screens management */
154 mtime_t last_display_date; /* last non idle display date */
155 mtime_t last_idle_date; /* last idle display date */
158 /* Statistics - these numbers are not supposed to be accurate, but are a
159 * good indication of the thread status */
160 mtime_t render_time; /* last picture render time */
161 count_t c_fps_samples; /* picture counts */
162 mtime_t p_fps_sample[VOUT_FPS_SAMPLES]; /* FPS samples dates */
165 /* Rendering buffers */
166 int i_buffer_index; /* buffer index */
167 vout_buffer_t p_buffer[2]; /* buffers properties */
169 /* Videos heap and translation tables */
170 picture_t p_picture[VOUT_MAX_PICTURES]; /* pictures */
171 subpicture_t p_subpicture[VOUT_MAX_PICTURES]; /* subpictures */
172 int i_pictures; /* current heap size */
173 vout_yuv_t yuv; /* translation tables */
176 p_vout_font_t p_default_font; /* default font */
177 p_vout_font_t p_large_font; /* large font */
179 /* Synchronisation informations - synchro level is updated by the vout
180 * thread and read by decoder threads */
181 int i_synchro_level; /* trashing level */
185 #define VOUT_DUMMY_METHOD 0x0000 /* dummy video output */
186 #define VOUT_X11_METHOD 0x0001 /* X11 */
187 #define VOUT_GGI_METHOD 0x0002 /* General Graphics Interface */
188 #define VOUT_FB_METHOD 0x0003 /* Linux framebuffer */
189 #define VOUT_GLIDE_METHOD 0x0004 /* Voodoo 3dfx */
190 #define VOUT_DGA_METHOD 0x0005 /* X11 DGA extension */
191 #define VOUT_BEOS_METHOD 0x0006 /* BeOS rendering */
193 /* Get the fallback method */
195 #define VOUT_DEFAULT_METHOD "x11"
198 #define VOUT_DEFAULT_METHOD "fb"
201 #define VOUT_DEFAULT_METHOD "ggi"
204 #define VOUT_DEFAULT_METHOD "glide"
207 #define VOUT_DEFAULT_METHOD "dga"
210 #define VOUT_DEFAULT_METHOD "beos"
212 #define VOUT_DEFAULT_METHOD "dummy"
220 /* Flags for changes - these flags are set in the i_changes field when another
221 * thread changed a variable */
222 #define VOUT_INFO_CHANGE 0x0001 /* b_info changed */
223 #define VOUT_GRAYSCALE_CHANGE 0x0002 /* b_grayscale changed */
224 #define VOUT_INTF_CHANGE 0x0004 /* b_interface changed */
225 #define VOUT_SCALE_CHANGE 0x0008 /* b_scale changed */
226 #define VOUT_SIZE_CHANGE 0x0200 /* size changed */
227 #define VOUT_DEPTH_CHANGE 0x0400 /* depth changed */
228 #define VOUT_GAMMA_CHANGE 0x0010 /* gamma changed */
229 #define VOUT_YUV_CHANGE 0x0800 /* change yuv tables */
230 #define VOUT_NODISPLAY_CHANGE 0xff00 /* changes which forbidden display */
232 /*****************************************************************************
234 *****************************************************************************/
236 /* RGB2PIXEL: assemble RGB components to a pixel value, returns a u32 */
237 #define RGB2PIXEL( p_vout, i_red, i_green, i_blue ) \
238 (((((u32)i_red) >> p_vout->i_red_rshift) << p_vout->i_red_lshift) | \
239 ((((u32)i_green) >> p_vout->i_green_rshift) << p_vout->i_green_lshift) | \
240 ((((u32)i_blue) >> p_vout->i_blue_rshift) << p_vout->i_blue_lshift))
243 /*****************************************************************************
245 *****************************************************************************/
246 vout_thread_t * vout_CreateThread ( char *psz_display, int i_root_window,
247 int i_width, int i_height, int *pi_status, int i_method );
248 void vout_DestroyThread ( vout_thread_t *p_vout, int *pi_status );
249 picture_t * vout_CreatePicture ( vout_thread_t *p_vout, int i_type,
250 int i_width, int i_height );
251 void vout_DestroyPicture ( vout_thread_t *p_vout, picture_t *p_pic );
252 void vout_DisplayPicture ( vout_thread_t *p_vout, picture_t *p_pic );
253 void vout_DatePicture ( vout_thread_t *p_vout, picture_t *p_pic, mtime_t date );
254 void vout_LinkPicture ( vout_thread_t *p_vout, picture_t *p_pic );
255 void vout_UnlinkPicture ( vout_thread_t *p_vout, picture_t *p_pic );
256 subpicture_t * vout_CreateSubPicture ( vout_thread_t *p_vout, int i_type, int i_size );
257 void vout_DestroySubPicture ( vout_thread_t *p_vout, subpicture_t *p_subpic );
258 void vout_DisplaySubPicture ( vout_thread_t *p_vout, subpicture_t *p_subpic );
260 void vout_SetBuffers ( vout_thread_t *p_vout, void *p_buf1, void *p_buf2 );