]> git.sesse.net Git - vlc/blob - include/video_output.h
. Fixed a FIXME in SDL: p_vout->p_sys is no more used in intf_sdl.c
[vlc] / include / video_output.h
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
8  *
9  * Authors: Vincent Seguin <seguin@via.ecp.fr>
10  *
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.
15  * 
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
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
24  *****************************************************************************/
25
26 /*****************************************************************************
27  * vout_yuv_convert_t: YUV conversion function
28  *****************************************************************************
29  * This is the prototype common to all conversion functions. The type of p_pic
30  * will change depending on the processed screen depth.
31  * Parameters:
32  *      p_vout                          video output thread
33  *      p_pic                           picture address
34  *      p_y, p_u, p_v                   Y,U,V samples addresses
35  *      i_width, i_height               Y samples extension
36  *      i_pic_width, i_pic_height       picture extension
37  *      i_pic_line_width                picture total line width
38  *      i_matrix_coefficients           matrix coefficients
39  * Picture width and source dimensions must be multiples of 16.
40  *****************************************************************************/
41 typedef void (vout_yuv_convert_t)( p_vout_thread_t p_vout, void *p_pic,
42                                    yuv_data_t *p_y, yuv_data_t *p_u, yuv_data_t *p_v,
43                                    int i_width, int i_height,
44                                    int i_pic_width, int i_pic_height, int i_pic_line_width,
45                                    int i_matrix_coefficients );
46
47 /*****************************************************************************
48  * vout_yuv_t: pre-calculated YUV conversion tables
49  *****************************************************************************
50  * These tables are used by conversion and scaling functions.
51  *****************************************************************************/
52 typedef int  (yuv_init_t)           ( p_vout_thread_t p_vout );
53 typedef int  (yuv_reset_t)          ( p_vout_thread_t p_vout );
54 typedef void (yuv_end_t)            ( p_vout_thread_t p_vout );
55
56 typedef struct vout_yuv_s
57 {
58     /* conversion functions */
59     vout_yuv_convert_t *        p_Convert420;         /* YUV 4:2:0 converter */
60     vout_yuv_convert_t *        p_Convert422;         /* YUV 4:2:2 converter */
61     vout_yuv_convert_t *        p_Convert444;         /* YUV 4:4:4 converter */
62
63     /* Pre-calculated conversion tables */
64     void *              p_base;            /* base for all conversion tables */
65     union
66     {
67         u8 *            p_gray8;                        /* gray 8 bits table */
68         u16 *           p_gray16;                      /* gray 16 bits table */
69         u32 *           p_gray32;                      /* gray 32 bits table */
70         u8 *            p_rgb8;                          /* RGB 8 bits table */
71         u16 *           p_rgb16;                        /* RGB 16 bits table */
72         u32 *           p_rgb32;                        /* RGB 32 bits table */
73     } yuv;
74
75     /* Temporary conversion buffer and offset array */
76     void *              p_buffer;                       /* conversion buffer */
77     int *               p_offset;                            /* offset array */
78
79     /* Plugin used and shortcuts to access its capabilities */
80     struct module_s *   p_module;
81     yuv_init_t *        pf_init;                    /* initialize YUV tables */
82     yuv_reset_t *       pf_reset;                        /* reset YUV tables */
83     yuv_end_t *         pf_end;                           /* free YUV tables */
84
85 } vout_yuv_t;
86
87 /*****************************************************************************
88  * vout_buffer_t: rendering buffer
89  *****************************************************************************
90  * This structure stores information about a buffer. Buffers are not completely
91  * cleared between displays, and modified areas need to be stored.
92  *****************************************************************************/
93 typedef struct vout_buffer_s
94 {
95     /* Picture area */
96     int         i_pic_x, i_pic_y;                       /* picture position  */
97     int         i_pic_width, i_pic_height;                   /* picture size */
98
99     /* Other areas - only vertical extensions of areas are stored */
100     int         i_areas;                                  /* number of areas */
101     int         pi_area_begin[VOUT_MAX_AREAS];          /* beginning of area */
102     int         pi_area_end[VOUT_MAX_AREAS];                  /* end of area */
103
104     /* Picture data */
105     byte_t *    p_data;                                    /* memory address */
106 } vout_buffer_t;
107
108 /*****************************************************************************
109  * vout_thread_t: video output thread descriptor
110  *****************************************************************************
111  * Any independant video output device, such as an X11 window or a GGI device,
112  * is represented by a video output thread, and described using the following
113  * structure.
114  *****************************************************************************/
115 typedef int  (vout_sys_create_t)    ( p_vout_thread_t p_vout,
116                                       char *psz_display,
117                                       int i_root_window, void *p_data );
118 typedef int  (vout_sys_init_t)      ( p_vout_thread_t p_vout );
119 typedef void (vout_sys_end_t)       ( p_vout_thread_t p_vout );
120 typedef void (vout_sys_destroy_t)   ( p_vout_thread_t p_vout );
121 typedef int  (vout_sys_manage_t)    ( p_vout_thread_t p_vout );
122 typedef void (vout_sys_display_t)   ( p_vout_thread_t p_vout );
123
124 typedef void (vout_set_palette_t)   ( p_vout_thread_t p_vout, u16 *red,
125                                       u16 *green, u16 *blue, u16 *transp );
126
127 typedef struct vout_thread_s
128 {
129     /* Thread properties and lock */
130     boolean_t           b_die;                                 /* `die' flag */
131     boolean_t           b_error;                             /* `error' flag */
132     boolean_t           b_active;                           /* `active' flag */
133     vlc_thread_t        thread_id;               /* id for pthread functions */
134     vlc_mutex_t         picture_lock;                   /* picture heap lock */
135     vlc_mutex_t         subpicture_lock;             /* subpicture heap lock */
136     vlc_mutex_t         change_lock;                   /* thread change lock */
137     int *               pi_status;                  /* temporary status flag */
138     p_vout_sys_t        p_sys;                       /* system output method */
139                                                                    
140     /* Current display properties */
141     u16                 i_changes;             /* changes made to the thread */
142     int                 i_width;              /* current output method width */
143     int                 i_height;            /* current output method height */
144     int                 i_bytes_per_line;  /* bytes per line (incl. virtual) */
145     int                 i_screen_depth;  /* significant bpp: 8, 15, 16 or 24 */
146     int                 i_bytes_per_pixel;/* real screen depth: 1, 2, 3 or 4 */
147     float               f_gamma;                                    /* gamma */
148     boolean_t           b_need_render;  /* does the output method need a YUV 
149                                          * conversion ?                      */
150
151     /* Color masks and shifts in RGB mode - masks are set by system
152      * initialization, shifts are calculated. A pixel color value can be
153      * obtained using the formula ((value >> rshift) << lshift) */
154     u32                 i_red_mask;                              /* red mask */
155     u32                 i_green_mask;                          /* green mask */
156     u32                 i_blue_mask;                            /* blue mask */
157     int                 i_red_lshift, i_red_rshift;            /* red shifts */
158     int                 i_green_lshift, i_green_rshift;      /* green shifts */
159     int                 i_blue_lshift, i_blue_rshift;         /* blue shifts */
160
161     /* Useful pre-calculated pixel values - these are not supposed to be
162      * accurate values, but rather values looking nice, given their usage. */
163     u32                 i_white_pixel;                              /* white */
164     u32                 i_black_pixel;                              /* black */
165     u32                 i_gray_pixel;                                /* gray */
166     u32                 i_blue_pixel;                                /* blue */
167
168     /* Plugins */
169     vout_sys_create_t *     p_sys_create;          /* allocate output method */
170     vout_sys_init_t *       p_sys_init;          /* initialize output method */
171     vout_sys_end_t *        p_sys_end;            /* terminate output method */
172     vout_sys_destroy_t *    p_sys_destroy;          /* destroy output method */
173     vout_sys_manage_t *     p_sys_manage;                   /* handle events */
174     vout_sys_display_t *    p_sys_display;         /* display rendered image */
175
176     vout_set_palette_t *    p_set_palette;               /* set 8bpp palette */
177
178     /* Pictures and rendering properties */
179     boolean_t           b_grayscale;           /* color or grayscale display */
180     boolean_t           b_info;              /* print additional information */
181     boolean_t           b_interface;                     /* render interface */
182     boolean_t           b_scale;                    /* allow picture scaling */
183     mtime_t             render_time;             /* last picture render time */
184
185
186     /* Idle screens management */
187     mtime_t             last_display_date;     /* last non idle display date */
188     mtime_t             last_idle_date;            /* last idle display date */
189     mtime_t             init_display_date;
190
191     /* Statistics - these numbers are not supposed to be accurate, but are a
192      * good indication of the thread status */
193     count_t             c_fps_samples;                     /* picture counts */
194     mtime_t             p_fps_sample[VOUT_FPS_SAMPLES]; /* FPS samples dates */
195
196     /* Rendering buffers */
197     int                 i_buffer_index;                      /* buffer index */
198     vout_buffer_t       p_buffer[2];                   /* buffers properties */
199
200     /* Video heap and translation tables */
201     picture_t           p_picture[VOUT_MAX_PICTURES];            /* pictures */
202     subpicture_t        p_subpicture[VOUT_MAX_PICTURES];      /* subpictures */
203     int                 i_pictures;                     /* current heap size */
204     vout_yuv_t          yuv;                           /* translation tables */
205     picture_t *         p_rendered_pic;  /* picture currently being rendered */
206
207     /* Bitmap fonts */
208     p_vout_font_t       p_default_font;                      /* default font */
209     p_vout_font_t       p_large_font;                          /* large font */
210
211 #ifdef STATS
212     count_t             c_loops;
213 #endif
214 } vout_thread_t;
215
216 /* Flags for changes - these flags are set in the i_changes field when another
217  * thread changed a variable */
218 #define VOUT_INFO_CHANGE        0x0001                     /* b_info changed */
219 #define VOUT_GRAYSCALE_CHANGE   0x0002                /* b_grayscale changed */
220 #define VOUT_INTF_CHANGE        0x0004                /* b_interface changed */
221 #define VOUT_SCALE_CHANGE       0x0008                    /* b_scale changed */
222 #define VOUT_GAMMA_CHANGE       0x0010                      /* gamma changed */
223 #define VOUT_CURSOR_CHANGE      0x0020                   /* b_cursor changed */
224 #define VOUT_FULLSCREEN_CHANGE  0x0040               /* b_fullscreen changed */
225 #define VOUT_SIZE_CHANGE        0x0200                       /* size changed */
226 #define VOUT_DEPTH_CHANGE       0x0400                      /* depth changed */
227 #define VOUT_YUV_CHANGE         0x0800                  /* change yuv tables */
228
229 /* Disabled for thread deadlocks issues --Meuuh */
230 //#define VOUT_NODISPLAY_CHANGE   0xff00    /* changes which forbidden display */
231
232 /*****************************************************************************
233  * Macros
234  *****************************************************************************/
235
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))
241
242
243 /*****************************************************************************
244  * Prototypes
245  *****************************************************************************/
246 vout_thread_t * vout_CreateThread       ( char *psz_display, int i_root_window,
247                                           int i_width, int i_height, int *pi_status,
248                                           int i_method, void *p_data );
249 void            vout_DestroyThread      ( vout_thread_t *p_vout, int *pi_status );
250 picture_t *     vout_CreatePicture      ( vout_thread_t *p_vout, int i_type,
251                                           int i_width, int i_height );
252 void            vout_DestroyPicture     ( vout_thread_t *p_vout, picture_t *p_pic );
253 void            vout_DisplayPicture     ( vout_thread_t *p_vout, picture_t *p_pic );
254 void            vout_DatePicture        ( vout_thread_t *p_vout, picture_t *p_pic, mtime_t date );
255 void            vout_LinkPicture        ( vout_thread_t *p_vout, picture_t *p_pic );
256 void            vout_UnlinkPicture      ( vout_thread_t *p_vout, picture_t *p_pic );
257 subpicture_t *  vout_CreateSubPicture   ( vout_thread_t *p_vout, int i_type, int i_size );
258 void            vout_DestroySubPicture  ( vout_thread_t *p_vout, subpicture_t *p_subpic );
259 void            vout_DisplaySubPicture  ( vout_thread_t *p_vout, subpicture_t *p_subpic );
260
261 void            vout_SetBuffers         ( vout_thread_t *p_vout, void *p_buf1, void *p_buf2 );
262