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 opened video output thread.
6 *****************************************************************************
7 * Copyright (C) 1999, 2000 VideoLAN
8 * $Id: video_output.h,v 1.75 2002/04/25 21:52:42 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_bank_t, p_vout_bank (global variable)
29 *****************************************************************************
30 * This global variable is accessed by any function using the video output.
31 *****************************************************************************/
32 typedef struct vout_bank_s
34 /* Array to all the video outputs */
35 struct vout_thread_s *pp_vout[ VOUT_MAX_THREADS ];
38 vlc_mutex_t lock; /* Global lock */
43 extern vout_bank_t *p_vout_bank;
45 # define p_vout_bank (p_symbols->p_vout_bank)
48 /*****************************************************************************
49 * vout_chroma_t: Chroma conversion function
50 *****************************************************************************
51 * This is the prototype common to all conversion functions.
53 * p_source source picture
54 * p_dest destination picture
55 * Picture width and source dimensions must be multiples of 16.
56 *****************************************************************************/
57 typedef void (vout_chroma_convert_t)( struct vout_thread_s *,
58 picture_t *, picture_t * );
60 typedef struct vout_chroma_s
62 /* conversion functions */
63 vout_chroma_convert_t *pf_convert;
65 /* Private module-dependant data */
66 p_chroma_sys_t p_sys; /* private data */
68 /* Plugin used and shortcuts to access its capabilities */
69 struct module_s * p_module;
70 int ( * pf_init ) ( struct vout_thread_s * );
71 void ( * pf_end ) ( struct vout_thread_s * );
75 /*****************************************************************************
77 *****************************************************************************/
78 typedef struct vout_fifo_s
80 /* See the fifo types below */
83 int i_fifo; /* Just to keep track of the fifo index */
85 vlc_mutex_t data_lock;
90 #define VOUT_EMPTY_FIFO 0
91 #define VOUT_YUV_FIFO 1
92 #define VOUT_SPU_FIFO 2
94 /*****************************************************************************
95 * vout_thread_t: video output thread descriptor
96 *****************************************************************************
97 * Any independant video output device, such as an X11 window or a GGI device,
98 * is represented by a video output thread, and described using the following
100 *****************************************************************************/
101 typedef struct vout_thread_s
103 /* Thread properties and lock */
104 boolean_t b_die; /* `die' flag */
105 boolean_t b_error; /* `error' flag */
106 boolean_t b_active; /* `active' flag */
107 vlc_thread_t thread_id; /* id for pthread functions */
108 vlc_mutex_t picture_lock; /* picture heap lock */
109 vlc_mutex_t subpicture_lock; /* subpicture heap lock */
110 vlc_mutex_t change_lock; /* thread change lock */
111 int * pi_status; /* temporary status flag */
112 p_vout_sys_t p_sys; /* system output method */
114 /* Current display properties */
115 u16 i_changes; /* changes made to the thread */
116 float f_gamma; /* gamma */
117 boolean_t b_grayscale; /* color or grayscale display */
118 boolean_t b_info; /* print additional information */
119 boolean_t b_interface; /* render interface */
120 boolean_t b_scale; /* allow picture scaling */
121 boolean_t b_fullscreen; /* toogle fullscreen display */
122 mtime_t render_time; /* last picture render time */
123 int i_window_width; /* video window width */
124 int i_window_height; /* video window height */
126 /* Plugin used and shortcuts to access its capabilities */
127 struct module_s * p_module;
128 int ( *pf_create ) ( struct vout_thread_s * );
129 int ( *pf_init ) ( struct vout_thread_s * );
130 void ( *pf_end ) ( struct vout_thread_s * );
131 void ( *pf_destroy ) ( struct vout_thread_s * );
132 int ( *pf_manage ) ( struct vout_thread_s * );
133 void ( *pf_render ) ( struct vout_thread_s *,
134 struct picture_s * );
135 void ( *pf_display ) ( struct vout_thread_s *,
136 struct picture_s * );
138 /* Statistics - these numbers are not supposed to be accurate, but are a
139 * good indication of the thread status */
140 count_t c_fps_samples; /* picture counts */
141 mtime_t p_fps_sample[VOUT_FPS_SAMPLES]; /* FPS samples dates */
143 /* Video heap and translation tables */
144 int i_heap_size; /* heap size */
145 picture_heap_t render; /* rendered pictures */
146 picture_heap_t output; /* direct buffers */
147 boolean_t b_direct; /* rendered are like direct ? */
148 vout_chroma_t chroma; /* translation tables */
150 /* Picture and subpicture heaps */
151 picture_t p_picture[2*VOUT_MAX_PICTURES]; /* pictures */
152 subpicture_t p_subpicture[VOUT_MAX_PICTURES]; /* subpictures */
155 p_vout_font_t p_default_font; /* default font */
156 p_vout_font_t p_large_font; /* large font */
160 count_t c_pictures, c_late_pictures;
161 mtime_t display_jitter; /* average deviation from the PTS */
162 count_t c_jitter_samples; /* number of samples used for the *
163 * calculation of the jitter */
166 #define I_OUTPUTPICTURES p_vout->output.i_pictures
167 #define PP_OUTPUTPICTURE p_vout->output.pp_picture
168 #define I_RENDERPICTURES p_vout->render.i_pictures
169 #define PP_RENDERPICTURE p_vout->render.pp_picture
171 /* Flags for changes - these flags are set in the i_changes field when another
172 * thread changed a variable */
173 #define VOUT_INFO_CHANGE 0x0001 /* b_info changed */
174 #define VOUT_GRAYSCALE_CHANGE 0x0002 /* b_grayscale changed */
175 #define VOUT_INTF_CHANGE 0x0004 /* b_interface changed */
176 #define VOUT_SCALE_CHANGE 0x0008 /* b_scale changed */
177 #define VOUT_GAMMA_CHANGE 0x0010 /* gamma changed */
178 #define VOUT_CURSOR_CHANGE 0x0020 /* b_cursor changed */
179 #define VOUT_FULLSCREEN_CHANGE 0x0040 /* b_fullscreen changed */
180 #define VOUT_SIZE_CHANGE 0x0200 /* size changed */
181 #define VOUT_DEPTH_CHANGE 0x0400 /* depth changed */
182 #define VOUT_CHROMA_CHANGE 0x0800 /* change chroma tables */
184 /* Disabled for thread deadlocks issues --Meuuh */
185 //#define VOUT_NODISPLAY_CHANGE 0xff00 /* changes which forbidden display */
187 #define MAX_JITTER_SAMPLES 20
189 /*****************************************************************************
191 *****************************************************************************/
193 void vout_InitBank ( void );
194 void vout_EndBank ( void );
196 vout_thread_t * vout_CreateThread ( int *pi_status, int, int, u32, int );
197 void vout_DestroyThread ( vout_thread_t *, int *pi_status );
199 vout_fifo_t * vout_CreateFifo ( void );
200 void vout_DestroyFifo ( vout_fifo_t * );
201 void vout_FreeFifo ( vout_fifo_t * );
203 int vout_ChromaCmp ( u32, u32 );
205 picture_t * vout_CreatePicture ( vout_thread_t *,
206 boolean_t, boolean_t, boolean_t );
207 void vout_AllocatePicture( picture_t *, int, int, u32 );
208 void vout_DestroyPicture ( vout_thread_t *, picture_t * );
209 void vout_DisplayPicture ( vout_thread_t *, picture_t * );
210 void vout_DatePicture ( vout_thread_t *, picture_t *, mtime_t );
211 void vout_LinkPicture ( vout_thread_t *, picture_t * );
212 void vout_UnlinkPicture ( vout_thread_t *, picture_t * );
213 picture_t * vout_RenderPicture ( vout_thread_t *, picture_t *,
215 void vout_PlacePicture ( vout_thread_t *, int, int,
216 int *, int *, int *, int * );
218 subpicture_t * vout_CreateSubPicture ( vout_thread_t *, int, int );
219 void vout_DestroySubPicture ( vout_thread_t *, subpicture_t * );
220 void vout_DisplaySubPicture ( vout_thread_t *, subpicture_t * );
221 subpicture_t * vout_SortSubPictures ( vout_thread_t *, mtime_t );
222 void vout_RenderSubPictures ( vout_thread_t *, picture_t *,
225 # define vout_CreateThread p_symbols->vout_CreateThread
226 # define vout_DestroyThread p_symbols->vout_DestroyThread
227 # define vout_CreateSubPicture p_symbols->vout_CreateSubPicture
228 # define vout_DestroySubPicture p_symbols->vout_DestroySubPicture
229 # define vout_DisplaySubPicture p_symbols->vout_DisplaySubPicture
230 # define vout_CreatePicture p_symbols->vout_CreatePicture
231 # define vout_AllocatePicture p_symbols->vout_AllocatePicture
232 # define vout_DisplayPicture p_symbols->vout_DisplayPicture
233 # define vout_DestroyPicture p_symbols->vout_DestroyPicture
234 # define vout_DatePicture p_symbols->vout_DatePicture
235 # define vout_LinkPicture p_symbols->vout_LinkPicture
236 # define vout_UnlinkPicture p_symbols->vout_UnlinkPicture
237 # define vout_PlacePicture p_symbols->vout_PlacePicture
238 # define vout_ChromaCmp p_symbols->vout_ChromaCmp