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 convertion 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 needs 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 following
87 *******************************************************************************/
88 typedef struct vout_thread_s
90 /* Thread properties and lock */
91 boolean_t b_die; /* `die' flag */
92 boolean_t b_error; /* `error' flag */
93 boolean_t b_active; /* `active' flag */
94 vlc_thread_t thread_id; /* id for pthread functions */
95 vlc_mutex_t picture_lock; /* picture heap lock */
96 vlc_mutex_t subpicture_lock; /* subpicture heap lock */
97 vlc_mutex_t change_lock; /* thread change lock */
98 int * pi_status; /* temporary status flag */
99 p_vout_sys_t p_sys; /* system output method */
101 /* Current display properties */
102 u16 i_changes; /* changes made to the thread */
103 int i_width; /* current output method width */
104 int i_height; /* current output method height */
105 int i_bytes_per_line; /* bytes per line (incl. virtual) */
106 int i_screen_depth; /* significant bpp: 8, 15, 16 or 24 */
107 int i_bytes_per_pixel; /* real screen depth: 1, 2, 3 or 4 */
108 float f_gamma; /* gamma */
110 /* Color masks and shifts in RGB mode - masks are set by system
111 * initialization, shifts are calculated. A pixel color value can be
112 * obtained using the formula ((value >> rshift) << lshift) */
113 u32 i_red_mask; /* red mask */
114 u32 i_green_mask; /* green mask */
115 u32 i_blue_mask; /* blue mask */
116 int i_red_lshift, i_red_rshift; /* red shifts */
117 int i_green_lshift, i_green_rshift; /* green shifts */
118 int i_blue_lshift, i_blue_rshift; /* blue shifts */
120 /* Useful pre-calculated pixel values - these are not supposed to be
121 * accurate values, but rather values looking nice, given their usage. */
122 u32 i_white_pixel; /* white */
123 u32 i_black_pixel; /* black */
124 u32 i_gray_pixel; /* gray */
125 u32 i_blue_pixel; /* blue */
128 u8 lookup[2176]; /* lookup table for 8 bpp palette */
130 /* Pictures and rendering properties */
131 boolean_t b_grayscale; /* color or grayscale display */
132 boolean_t b_info; /* print additionnal informations */
133 boolean_t b_interface; /* render interface */
134 boolean_t b_scale; /* allow picture scaling */
136 /* Idle screens management */
137 mtime_t last_display_date; /* last non idle display date */
138 mtime_t last_idle_date; /* last idle display date */
141 /* Statistics - these numbers are not supposed to be accurate, but are a
142 * good indication of the thread status */
143 mtime_t render_time; /* last picture render time */
144 count_t c_fps_samples; /* picture counts */
145 mtime_t p_fps_sample[ VOUT_FPS_SAMPLES ];/* FPS samples dates */
148 /* Rendering buffers */
149 int i_buffer_index; /* buffer index */
150 vout_buffer_t p_buffer[2]; /* buffers properties */
152 /* Videos heap and translation tables */
153 picture_t p_picture[VOUT_MAX_PICTURES]; /* pictures */
154 subpicture_t p_subpicture[VOUT_MAX_PICTURES]; /* subpictures */
155 vout_yuv_t yuv; /* translation tables */
158 p_vout_font_t p_default_font; /* default font */
159 p_vout_font_t p_large_font; /* large font */
162 /* Flags for changes - these flags are set in the i_changes field when another
163 * thread changed a variable */
164 #define VOUT_INFO_CHANGE 0x0001 /* b_info changed */
165 #define VOUT_GRAYSCALE_CHANGE 0x0002 /* b_grayscale changed */
166 #define VOUT_INTF_CHANGE 0x0004 /* b_interface changed */
167 #define VOUT_SCALE_CHANGE 0x0008 /* b_scale changed */
168 #define VOUT_SIZE_CHANGE 0x0200 /* size changed */
169 #define VOUT_DEPTH_CHANGE 0x0400 /* depth changed */
170 #define VOUT_GAMMA_CHANGE 0x0010 /* gamma changed */
171 #define VOUT_YUV_CHANGE 0x0800 /* change yuv tables */
172 #define VOUT_NODISPLAY_CHANGE 0xff00 /* changes which forbidden display */
174 /*******************************************************************************
176 *******************************************************************************/
178 /* RGB2PIXEL: assemble RGB components to a pixel value, returns a u32 */
179 #define RGB2PIXEL( p_vout, i_red, i_green, i_blue ) \
180 (((((u32)i_red) >> p_vout->i_red_rshift) << p_vout->i_red_lshift) | \
181 ((((u32)i_green) >> p_vout->i_green_rshift) << p_vout->i_green_lshift) | \
182 ((((u32)i_blue) >> p_vout->i_blue_rshift) << p_vout->i_blue_lshift))
185 /*******************************************************************************
187 *******************************************************************************/
188 vout_thread_t * vout_CreateThread ( char *psz_display, int i_root_window,
189 int i_width, int i_height, int *pi_status );
190 void vout_DestroyThread ( vout_thread_t *p_vout, int *pi_status );
191 picture_t * vout_CreatePicture ( vout_thread_t *p_vout, int i_type,
192 int i_width, int i_height );
193 void vout_DestroyPicture ( vout_thread_t *p_vout, picture_t *p_pic );
194 void vout_DisplayPicture ( vout_thread_t *p_vout, picture_t *p_pic );
195 void vout_DatePicture ( vout_thread_t *p_vout, picture_t *p_pic, mtime_t date );
196 void vout_LinkPicture ( vout_thread_t *p_vout, picture_t *p_pic );
197 void vout_UnlinkPicture ( vout_thread_t *p_vout, picture_t *p_pic );
198 subpicture_t * vout_CreateSubPicture ( vout_thread_t *p_vout, int i_type, int i_size );
199 void vout_DestroySubPicture ( vout_thread_t *p_vout, subpicture_t *p_subpic );
200 void vout_DisplaySubPicture ( vout_thread_t *p_vout, subpicture_t *p_subpic );
202 void vout_SetBuffers ( vout_thread_t *p_vout, void *p_buf1, void *p_buf2 );