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_tables_t: pre-calculated convertion tables
12 *******************************************************************************
13 * These tables are used by convertion and scaling functions.
14 *******************************************************************************/
15 typedef struct vout_tables_s
17 void * p_base; /* base for all translation tables */
20 struct { u16 *p_red, *p_green, *p_blue; } rgb16; /* color 15, 16 bpp */
21 struct { u32 *p_red, *p_green, *p_blue; } rgb32; /* color 24, 32 bpp */
22 struct { u16 *p_gray; } gray16; /* gray 15, 16 bpp */
23 struct { u32 *p_gray; } gray32; /* gray 24, 32 bpp */
27 /*******************************************************************************
28 * vout_convert_t: 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 (start address in picture)
35 * p_y, p_u, p_v Y,U,V samples addresses
36 * i_width Y samples width
37 * i_height Y samples height
38 * i_eol number of Y samples to reach the next line
39 * i_pic_eol number or pixels to reach the next line
40 * i_scale if non 0, vertical scaling is 1 - 1/i_scale
41 * i_matrix_coefficients matrix coefficients
43 * start x + i_width < picture width
44 * start y + i_height * (scaling factor) < picture height
46 *******************************************************************************/
47 typedef void (vout_convert_t)( p_vout_thread_t p_vout, void *p_pic,
48 yuv_data_t *p_y, yuv_data_t *p_u, yuv_data_t *p_v,
49 int i_width, int i_height, int i_eol, int i_pic_eol,
50 int i_scale, int i_matrix_coefficients );
52 /*******************************************************************************
53 * vout_scale_t: horizontal scaling function
54 *******************************************************************************
55 * The convertion function only perform a vertical scaling. Horizontal scaling
56 * is done later using this function.
58 * p_vout video output thread
59 * p_src source address (start address in picture)
60 * p_dst destination address (start address in picture)
61 * i_width source width
62 * i_height source height
63 * i_line_width source total pixels per line
64 * i_dst_line_width destination total pixels per line
65 * i_scale if non 0, horizontal scaling is 1 - 1/i_scale
68 * i_scale < 0 if p_src == p_dst
69 *******************************************************************************/
70 typedef void (vout_scale_t)( p_vout_thread_t p_vout, void *p_src, void *p_dst,
71 int i_width, int i_height, int i_line_width,
72 int i_dst_line_width, int i_scale );
74 /*******************************************************************************
75 * vout_thread_t: video output thread descriptor
76 *******************************************************************************
77 * Any independant video output device, such as an X11 window or a GGI device,
78 * is represented by a video output thread, and described using following
80 *******************************************************************************/
81 typedef struct vout_thread_s
83 /* Thread properties and lock */
84 boolean_t b_die; /* `die' flag */
85 boolean_t b_error; /* `error' flag */
86 boolean_t b_active; /* `active' flag */
87 vlc_thread_t thread_id; /* id for pthread functions */
88 vlc_mutex_t picture_lock; /* picture heap lock */
89 vlc_mutex_t subtitle_lock; /* subtitle heap lock */
90 vlc_mutex_t change_lock; /* thread change lock */
91 int * pi_status; /* temporary status flag */
92 p_vout_sys_t p_sys; /* system output method */
94 /* Current display properties */
95 boolean_t b_info; /* print additionnal informations */
96 boolean_t b_grayscale; /* color or grayscale display */
97 int i_width; /* current output method width */
98 int i_height; /* current output method height */
99 int i_bytes_per_line;/* bytes per line (including virtual) */
100 int i_screen_depth; /* bits per pixel */
101 int i_bytes_per_pixel; /* real screen depth */
102 int i_horizontal_scale; /* horizontal display scale */
103 int i_vertical_scale; /* vertical display scale */
104 float f_gamma; /* gamma */
107 /* Statistics - these numbers are not supposed to be accurate, but are a
108 * good indication of the thread status */
109 mtime_t render_time; /* last picture render time */
110 count_t c_fps_samples; /* picture counts */
111 mtime_t fps_sample[ VOUT_FPS_SAMPLES ]; /* FPS samples dates */
114 /* Running properties */
115 u16 i_changes; /* changes made to the thread */
116 mtime_t last_picture_date; /* last picture display date */
117 mtime_t last_display_date; /* last screen display date */
119 /* Videos heap and translation tables */
120 picture_t p_picture[VOUT_MAX_PICTURES]; /* pictures */
121 subtitle_t p_subtitle[VOUT_MAX_PICTURES]; /* subtitles */
122 vout_tables_t tables; /* translation tables */
123 vout_convert_t * p_ConvertYUV420; /* YUV 4:2:0 converter */
124 vout_convert_t * p_ConvertYUV422; /* YUV 4:2:2 converter */
125 vout_convert_t * p_ConvertYUV444; /* YUV 4:4:4 converter */
126 vout_scale_t * p_Scale; /* scaler */
129 /* Flags for changes - these flags are set in the i_changes field when another
130 * thread changed a variable */
131 #define VOUT_INFO_CHANGE 0x0001 /* b_info changed */
132 #define VOUT_GRAYSCALE_CHANGE 0x0002 /* b_grayscale changed */
133 #define VOUT_SIZE_CHANGE 0x0004 /* size changed */
134 #define VOUT_DEPTH_CHANGE 0x0008 /* depth changed */
135 #define VOUT_RATIO_CHANGE 0x0010 /* display ratio changed */
136 #define VOUT_GAMMA_CHANGE 0x0020 /* gamma changed */
137 #define VOUT_NODISPLAY_CHANGE 0xffdc /* changes which forbiden the display */
139 /*******************************************************************************
141 *******************************************************************************/
142 vout_thread_t * vout_CreateThread ( char *psz_display, int i_root_window,
143 int i_width, int i_height, int *pi_status );
144 void vout_DestroyThread ( vout_thread_t *p_vout, int *pi_status );
145 picture_t * vout_CreatePicture ( vout_thread_t *p_vout, int i_type,
146 int i_width, int i_height );
147 void vout_DestroyPicture ( vout_thread_t *p_vout, picture_t *p_pic );
148 void vout_DisplayPicture ( vout_thread_t *p_vout, picture_t *p_pic );
149 void vout_DatePicture ( vout_thread_t *p_vout, picture_t *p_pic, mtime_t date );
150 void vout_LinkPicture ( vout_thread_t *p_vout, picture_t *p_pic );
151 void vout_UnlinkPicture ( vout_thread_t *p_vout, picture_t *p_pic );
152 subtitle_t * vout_CreateSubtitle ( vout_thread_t *p_vout, int i_type, int i_size );
153 void vout_DestroySubtitle ( vout_thread_t *p_vout, subtitle_t *p_sub );
154 void vout_DisplaySubtitle ( vout_thread_t *p_vout, subtitle_t *p_sub );