1 /*****************************************************************************
2 * vlc_video.h: common video definitions
3 *****************************************************************************
4 * Copyright (C) 1999 - 2008 the VideoLAN team
7 * Authors: Vincent Seguin <seguin@via.ecp.fr>
8 * Samuel Hocevar <sam@via.ecp.fr>
9 * Olivier Aubert <oaubert 47 videolan d07 org>
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.
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.
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
31 * This file defines common video output structures and functions in vlc
34 #include <vlc_picture.h>
35 #include <vlc_filter.h>
36 #include <vlc_subpicture.h>
39 * Video picture heap, either render (to store pictures used
40 * by the decoder) or output (to store pictures displayed by the vout plugin)
44 int i_pictures; /**< current heap size */
46 /* \name Picture static properties
47 * Those properties are fixed at initialization and should NOT be modified
50 unsigned int i_width; /**< picture width */
51 unsigned int i_height; /**< picture height */
52 vlc_fourcc_t i_chroma; /**< picture chroma */
53 unsigned int i_aspect; /**< aspect ratio */
57 picture_t* pp_picture[VOUT_MAX_PICTURES]; /**< pictures */
58 int i_last_used_pic; /**< last used pic in heap */
59 bool b_allow_modify_pics;
61 /* Stuff used for truecolor RGB planes */
62 uint32_t i_rmask; int i_rrshift, i_lrshift;
63 uint32_t i_gmask; int i_rgshift, i_lgshift;
64 uint32_t i_bmask; int i_rbshift, i_lbshift;
66 /** Stuff used for palettized RGB planes */
67 void (* pf_setpalette) ( vout_thread_t *, uint16_t *, uint16_t *, uint16_t * );
70 /*****************************************************************************
72 *****************************************************************************/
75 * Initialise different fields of a picture_t and allocates the picture buffer.
76 * \param p_this a vlc object
77 * \param p_pic pointer to the picture structure.
78 * \param i_chroma the wanted chroma for the picture.
79 * \param i_width the wanted width for the picture.
80 * \param i_height the wanted height for the picture.
81 * \param i_aspect the wanted aspect ratio for the picture.
83 VLC_EXPORT( int, vout_AllocatePicture,( vlc_object_t *p_this, picture_t *p_pic, uint32_t i_chroma, int i_width, int i_height, int i_sar_num, int i_sar_den ) );
84 #define vout_AllocatePicture(a,b,c,d,e,f,g) \
85 vout_AllocatePicture(VLC_OBJECT(a),b,c,d,e,f,g)
88 * \defgroup video_output Video Output
89 * This module describes the programming interface for video output threads.
90 * It includes functions allowing to open a new thread, send pictures to a
91 * thread, and destroy a previously opened video output thread.
96 * Video ouput thread private structure
98 typedef struct vout_thread_sys_t vout_thread_sys_t;
101 * Video output thread descriptor
103 * Any independent video output device, such as an X11 window or a GGI device,
104 * is represented by a video output thread, and described using the following
112 /** \name Thread properties and locks */
114 vlc_mutex_t picture_lock; /**< picture heap lock */
115 vlc_mutex_t change_lock; /**< thread change lock */
116 vout_sys_t * p_sys; /**< system output method */
119 /** \name Current display properties */
121 uint16_t i_changes; /**< changes made to the thread.
122 \see \ref vout_changes */
123 unsigned b_fullscreen:1; /**< toogle fullscreen display */
124 unsigned b_autoscale:1; /**< auto scaling picture or not */
125 unsigned b_on_top:1; /**< stay always on top of other windows */
126 int i_zoom; /**< scaling factor if no auto */
127 unsigned int i_window_width; /**< video window width */
128 unsigned int i_window_height; /**< video window height */
129 unsigned int i_alignment; /**< video alignment in window */
133 /** \name Plugin used and shortcuts to access its capabilities */
135 int ( *pf_init ) ( vout_thread_t * );
136 void ( *pf_end ) ( vout_thread_t * );
137 int ( *pf_manage ) ( vout_thread_t * );
138 void ( *pf_render ) ( vout_thread_t *, picture_t * );
139 void ( *pf_display ) ( vout_thread_t *, picture_t * );
142 /** \name 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 */
148 video_format_t fmt_render; /* render format (from the decoder) */
149 video_format_t fmt_in; /* input (modified render) format */
150 video_format_t fmt_out; /* output format (for the video output) */
154 picture_t p_picture[2*VOUT_MAX_PICTURES+1]; /**< pictures */
156 /* Subpicture unit */
159 /* Video output configuration */
160 config_chain_t *p_cfg;
162 /* Private vout_thread data */
163 vout_thread_sys_t *p;
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 /** \defgroup vout_changes Flags for changes
172 * These flags are set in the vout_thread_t::i_changes field when another
173 * thread changed a variable
176 /** b_info changed */
177 #define VOUT_INFO_CHANGE 0x0001
178 /** b_interface changed */
179 #define VOUT_INTF_CHANGE 0x0004
180 /** b_autoscale changed */
181 #define VOUT_SCALE_CHANGE 0x0008
182 /** b_on_top changed */
183 #define VOUT_ON_TOP_CHANGE 0x0010
184 /** b_cursor changed */
185 #define VOUT_CURSOR_CHANGE 0x0020
186 /** b_fullscreen changed */
187 #define VOUT_FULLSCREEN_CHANGE 0x0040
188 /** i_zoom changed */
189 #define VOUT_ZOOM_CHANGE 0x0080
191 #define VOUT_SIZE_CHANGE 0x0200
193 #define VOUT_DEPTH_CHANGE 0x0400
194 /** change chroma tables */
195 #define VOUT_CHROMA_CHANGE 0x0800
196 /** cropping parameters changed */
197 #define VOUT_CROP_CHANGE 0x1000
198 /** aspect ratio changed */
199 #define VOUT_ASPECT_CHANGE 0x2000
200 /** change/recreate picture buffers */
201 #define VOUT_PICTURE_BUFFERS_CHANGE 0x4000
204 /* Alignment flags */
205 #define VOUT_ALIGN_LEFT 0x0001
206 #define VOUT_ALIGN_RIGHT 0x0002
207 #define VOUT_ALIGN_HMASK 0x0003
208 #define VOUT_ALIGN_TOP 0x0004
209 #define VOUT_ALIGN_BOTTOM 0x0008
210 #define VOUT_ALIGN_VMASK 0x000C
212 #define MAX_JITTER_SAMPLES 20
214 /* scaling factor (applied to i_zoom in vout_thread_t) */
215 #define ZOOM_FP_FACTOR 1000
217 /*****************************************************************************
219 *****************************************************************************/
223 * - returns a suitable vout (if requested by a non NULL p_fmt)
224 * - recycles an old vout (if given) by either destroying it or by saving it
227 * The purpose of this function is to avoid unnecessary creation/destruction of
228 * vout (and to allow optional vout reusing).
230 * You can call vout_Request on a vout created by vout_Create or by a previous
231 * call to vout_Request.
232 * You can release the returned value either by vout_Request or vout_Close()
233 * followed by a vlc_object_release() or shorter vout_CloseAndRelease()
235 * \param p_this a vlc object
236 * \param p_vout a vout candidate
237 * \param p_fmt the video format requested or NULL
238 * \return a vout if p_fmt is non NULL and the request is successfull, NULL
241 VLC_EXPORT( vout_thread_t *, vout_Request, ( vlc_object_t *p_this, vout_thread_t *p_vout, video_format_t *p_fmt ) );
242 #define vout_Request(a,b,c) vout_Request(VLC_OBJECT(a),b,c)
245 * This function will create a suitable vout for a given p_fmt. It will never
246 * reuse an already existing unused vout.
248 * You have to call either vout_Close or vout_Request on the returned value
249 * \param p_this a vlc object to which the returned vout will be attached
250 * \param p_fmt the video format requested
251 * \return a vout if the request is successfull, NULL otherwise
253 VLC_EXPORT( vout_thread_t *, vout_Create, ( vlc_object_t *p_this, video_format_t *p_fmt ) );
254 #define vout_Create(a,b) vout_Create(VLC_OBJECT(a),b)
257 * This function will close a vout created by vout_Create or vout_Request.
258 * The associated vout module is closed.
259 * Note: It is not released yet, you'll have to call vlc_object_release()
260 * or use the convenient vout_CloseAndRelease().
262 * \param p_vout the vout to close
264 VLC_EXPORT( void, vout_Close, ( vout_thread_t *p_vout ) );
267 * This function will close a vout created by vout_Create
268 * and then release it.
270 * \param p_vout the vout to close and release
272 static inline void vout_CloseAndRelease( vout_thread_t *p_vout )
274 vout_Close( p_vout );
275 vlc_object_release( p_vout );
279 * This function will handle a snapshot request.
281 * pp_image, pp_picture and p_fmt can be NULL otherwise they will be
282 * set with returned value in case of success.
284 * pp_image will hold an encoded picture in psz_format format.
286 * i_timeout specifies the time the function will wait for a snapshot to be
290 VLC_EXPORT( int, vout_GetSnapshot, ( vout_thread_t *p_vout,
291 block_t **pp_image, picture_t **pp_picture,
292 video_format_t *p_fmt,
293 const char *psz_format, mtime_t i_timeout ) );
296 VLC_EXPORT( int, vout_ChromaCmp, ( uint32_t, uint32_t ) );
298 VLC_EXPORT( picture_t *, vout_CreatePicture, ( vout_thread_t *, bool, bool, unsigned int ) );
299 VLC_EXPORT( void, vout_DestroyPicture, ( vout_thread_t *, picture_t * ) );
300 VLC_EXPORT( void, vout_DisplayPicture, ( vout_thread_t *, picture_t * ) );
301 VLC_EXPORT( void, vout_LinkPicture, ( vout_thread_t *, picture_t * ) );
302 VLC_EXPORT( void, vout_UnlinkPicture, ( vout_thread_t *, picture_t * ) );
303 VLC_EXPORT( void, vout_PlacePicture, ( const vout_thread_t *, unsigned int, unsigned int, unsigned int *, unsigned int *, unsigned int *, unsigned int * ) );
306 * Return the spu_t object associated to a vout_thread_t.
308 * The return object is valid only as long as the vout is. You must not
309 * release the spu_t object returned.
310 * It cannot return NULL so no need to check.
312 VLC_EXPORT( spu_t *, vout_GetSpu, ( vout_thread_t * ) );
314 void vout_IntfInit( vout_thread_t * );
315 VLC_EXPORT( void, vout_EnableFilter, ( vout_thread_t *, const char *,bool , bool ) );
319 #endif /* _VLC_VIDEO_H */