* ./AUTHORS : added lool :-p ;
[vlc.git] / 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 opened video output thread.
6  *****************************************************************************
7  * Copyright (C) 1999, 2000 VideoLAN
8  * $Id: video_output.h,v 1.80 2002/07/12 21:57:25 massiot Exp $
9  *
10  * Authors: Vincent Seguin <seguin@via.ecp.fr>
11  *          Samuel Hocevar <sam@via.ecp.fr>
12  *
13  * This program is free software; you can redistribute it and/or modify
14  * it under the terms of the GNU General Public License as published by
15  * the Free Software Foundation; either version 2 of the License, or
16  * (at your option) any later version.
17  * 
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software
25  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
26  *****************************************************************************/
27
28 /*****************************************************************************
29  * vout_chroma_t: Chroma conversion function
30  *****************************************************************************
31  * This is the prototype common to all conversion functions.
32  * Parameters:
33  *      p_source                        source picture
34  *      p_dest                          destination picture
35  * Picture width and source dimensions must be multiples of 16.
36  *****************************************************************************/
37 typedef void (vout_chroma_convert_t)( vout_thread_t *,
38                                       picture_t *, picture_t * );
39
40 typedef struct vout_chroma_s
41 {
42     /* conversion functions */
43     vout_chroma_convert_t *pf_convert;
44
45     /* Private module-dependant data */
46     chroma_sys_t *      p_sys;                               /* private data */
47
48     /* Plugin used and shortcuts to access its capabilities */
49     module_t * p_module;
50     int  ( * pf_init )  ( vout_thread_t * );
51     void ( * pf_end )   ( vout_thread_t * );
52
53 } vout_chroma_t;
54
55 /*****************************************************************************
56  * vout_fifo_t
57  *****************************************************************************/
58 typedef struct vout_fifo_s
59 {
60     /* See the fifo types below */
61     int                 i_type;
62     vlc_bool_t          b_die;
63     int                 i_fifo;      /* Just to keep track of the fifo index */
64
65     vlc_mutex_t         data_lock;
66     vlc_cond_t          data_wait;
67
68 } vout_fifo_t;
69
70 #define VOUT_EMPTY_FIFO         0
71 #define VOUT_YUV_FIFO           1
72 #define VOUT_SPU_FIFO           2
73
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 the following
79  * structure.
80  *****************************************************************************/
81 struct vout_thread_s
82 {
83     VLC_COMMON_MEMBERS
84
85     /* Thread properties and lock */
86     vlc_mutex_t         picture_lock;                   /* picture heap lock */
87     vlc_mutex_t         subpicture_lock;             /* subpicture heap lock */
88     vlc_mutex_t         change_lock;                   /* thread change lock */
89     vout_sys_t *        p_sys;                       /* system output method */
90
91     /* Current display properties */
92     u16                 i_changes;             /* changes made to the thread */
93     float               f_gamma;                                    /* gamma */
94     vlc_bool_t          b_grayscale;           /* color or grayscale display */
95     vlc_bool_t          b_info;              /* print additional information */
96     vlc_bool_t          b_interface;                     /* render interface */
97     vlc_bool_t          b_scale;                    /* allow picture scaling */
98     vlc_bool_t          b_fullscreen;           /* toogle fullscreen display */
99     mtime_t             render_time;             /* last picture render time */
100     int                 i_window_width;                /* video window width */
101     int                 i_window_height;              /* video window height */
102
103     /* Plugin used and shortcuts to access its capabilities */
104     module_t *   p_module;
105     int       ( *pf_create )     ( vout_thread_t * );
106     int       ( *pf_init )       ( vout_thread_t * );
107     void      ( *pf_end )        ( vout_thread_t * );
108     void      ( *pf_destroy )    ( vout_thread_t * );
109     int       ( *pf_manage )     ( vout_thread_t * );
110     void      ( *pf_render )     ( vout_thread_t *, picture_t * );
111     void      ( *pf_display )    ( vout_thread_t *, picture_t * );
112
113     /* Statistics - these numbers are not supposed to be accurate, but are a
114      * good indication of the thread status */
115     count_t             c_fps_samples;                     /* picture counts */
116     mtime_t             p_fps_sample[VOUT_FPS_SAMPLES]; /* FPS samples dates */
117
118     /* Video heap and translation tables */
119     int                 i_heap_size;                            /* heap size */
120     picture_heap_t      render;                         /* rendered pictures */
121     picture_heap_t      output;                            /* direct buffers */
122     vlc_bool_t          b_direct;              /* rendered are like direct ? */
123     vout_chroma_t       chroma;                        /* translation tables */
124
125     /* Picture and subpicture heaps */
126     picture_t           p_picture[2*VOUT_MAX_PICTURES];          /* pictures */
127     subpicture_t        p_subpicture[VOUT_MAX_PICTURES];      /* subpictures */
128
129     /* Bitmap fonts */
130     vout_font_t *       p_default_font;                      /* default font */
131     vout_font_t *       p_large_font;                          /* large font */
132
133     /* Statistics */
134     count_t             c_loops;
135     count_t             c_pictures, c_late_pictures;
136     mtime_t             display_jitter;    /* average deviation from the PTS */
137     count_t             c_jitter_samples;  /* number of samples used for the *
138                                             * calculation of the jitter      */
139
140     /* Mouse */
141     int                 i_mouse_x, i_mouse_y, i_mouse_button;
142
143     /* Filter chain */
144     char *psz_filter_chain;
145 };
146
147 #define I_OUTPUTPICTURES p_vout->output.i_pictures
148 #define PP_OUTPUTPICTURE p_vout->output.pp_picture
149 #define I_RENDERPICTURES p_vout->render.i_pictures
150 #define PP_RENDERPICTURE p_vout->render.pp_picture
151
152 /* Flags for changes - these flags are set in the i_changes field when another
153  * thread changed a variable */
154 #define VOUT_INFO_CHANGE        0x0001                     /* b_info changed */
155 #define VOUT_GRAYSCALE_CHANGE   0x0002                /* b_grayscale changed */
156 #define VOUT_INTF_CHANGE        0x0004                /* b_interface changed */
157 #define VOUT_SCALE_CHANGE       0x0008                    /* b_scale changed */
158 #define VOUT_GAMMA_CHANGE       0x0010                      /* gamma changed */
159 #define VOUT_CURSOR_CHANGE      0x0020                   /* b_cursor changed */
160 #define VOUT_FULLSCREEN_CHANGE  0x0040               /* b_fullscreen changed */
161 #define VOUT_SIZE_CHANGE        0x0200                       /* size changed */
162 #define VOUT_DEPTH_CHANGE       0x0400                      /* depth changed */
163 #define VOUT_CHROMA_CHANGE      0x0800               /* change chroma tables */
164
165 /* Disabled for thread deadlocks issues --Meuuh */
166 //#define VOUT_NODISPLAY_CHANGE   0xff00    /* changes which forbidden display */
167
168 #define MAX_JITTER_SAMPLES      20
169
170 /*****************************************************************************
171  * Prototypes
172  *****************************************************************************/
173 #define vout_CreateThread(a,b,c,d,e) __vout_CreateThread(CAST_TO_VLC_OBJECT(a),b,c,d,e)
174 VLC_EXPORT( vout_thread_t *, __vout_CreateThread,   ( vlc_object_t *, int, int, u32, int ) );
175 VLC_EXPORT( void,              vout_DestroyThread,  ( vout_thread_t * ) );
176
177 vout_fifo_t *   vout_CreateFifo     ( void );
178 void            vout_DestroyFifo    ( vout_fifo_t * );
179 void            vout_FreeFifo       ( vout_fifo_t * );
180
181 VLC_EXPORT( int,             vout_ChromaCmp,      ( u32, u32 ) );
182
183 VLC_EXPORT( picture_t *,     vout_CreatePicture,  ( vout_thread_t *, vlc_bool_t, vlc_bool_t, vlc_bool_t ) );
184 VLC_EXPORT( void,            vout_AllocatePicture,( vout_thread_t *, picture_t *, int, int, u32 ) );
185 VLC_EXPORT( void,            vout_DestroyPicture, ( vout_thread_t *, picture_t * ) );
186 VLC_EXPORT( void,            vout_DisplayPicture, ( vout_thread_t *, picture_t * ) );
187 VLC_EXPORT( void,            vout_DatePicture,    ( vout_thread_t *, picture_t *, mtime_t ) );
188 VLC_EXPORT( void,            vout_LinkPicture,    ( vout_thread_t *, picture_t * ) );
189 VLC_EXPORT( void,            vout_UnlinkPicture,  ( vout_thread_t *, picture_t * ) );
190 VLC_EXPORT( void,            vout_PlacePicture,   ( vout_thread_t *, int, int, int *, int *, int *, int * ) );
191 picture_t *     vout_RenderPicture  ( vout_thread_t *, picture_t *,
192                                                        subpicture_t * );
193
194 VLC_EXPORT( subpicture_t *,  vout_CreateSubPicture,   ( vout_thread_t *, int, int ) );
195 VLC_EXPORT( void,            vout_DestroySubPicture,  ( vout_thread_t *, subpicture_t * ) );
196 VLC_EXPORT( void,            vout_DisplaySubPicture,  ( vout_thread_t *, subpicture_t * ) );
197
198 subpicture_t *  vout_SortSubPictures    ( vout_thread_t *, mtime_t );
199 void            vout_RenderSubPictures  ( vout_thread_t *, picture_t *,
200                                                            subpicture_t * );