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 */
47 picture_t* pp_picture[VOUT_MAX_PICTURES]; /**< pictures */
48 int i_last_used_pic; /**< last used pic in heap */
51 /*****************************************************************************
53 *****************************************************************************/
56 * \defgroup video_output Video Output
57 * This module describes the programming interface for video output threads.
58 * It includes functions allowing to open a new thread, send pictures to a
59 * thread, and destroy a previously opened video output thread.
64 * Video ouput thread private structure
66 typedef struct vout_thread_sys_t vout_thread_sys_t;
69 * Video output thread descriptor
71 * Any independent video output device, such as an X11 window or a GGI device,
72 * is represented by a video output thread, and described using the following
79 /** \name Thread properties and locks */
81 vlc_mutex_t picture_lock; /**< picture heap lock */
82 vlc_mutex_t change_lock; /**< thread change lock */
85 /** \name Current display properties */
87 uint16_t i_changes; /**< changes made to the thread.
88 \see \ref vout_changes */
89 unsigned b_fullscreen:1; /**< toogle fullscreen display */
90 unsigned b_on_top:1; /**< stay always on top of other windows */
94 /** \name Video heap and translation tables */
96 picture_heap_t render; /**< rendered pictures */
97 picture_heap_t output; /**< direct buffers */
99 video_format_t fmt_render; /* render format (from the decoder) */
100 video_format_t fmt_in; /* input (modified render) format */
101 video_format_t fmt_out; /* output format (for the video output) */
105 picture_t p_picture[2*VOUT_MAX_PICTURES+1]; /**< pictures */
107 /* Private vout_thread data */
108 vout_thread_sys_t *p;
111 #define I_OUTPUTPICTURES p_vout->output.i_pictures
112 #define PP_OUTPUTPICTURE p_vout->output.pp_picture
113 #define I_RENDERPICTURES p_vout->render.i_pictures
114 #define PP_RENDERPICTURE p_vout->render.pp_picture
116 /** \defgroup vout_changes Flags for changes
117 * These flags are set in the vout_thread_t::i_changes field when another
118 * thread changed a variable
121 /** b_autoscale changed */
122 #define VOUT_SCALE_CHANGE 0x0008
123 /** b_on_top changed */
124 #define VOUT_ON_TOP_CHANGE 0x0010
125 /** b_fullscreen changed */
126 #define VOUT_FULLSCREEN_CHANGE 0x0040
127 /** i_zoom changed */
128 #define VOUT_ZOOM_CHANGE 0x0080
129 /** cropping parameters changed */
130 #define VOUT_CROP_CHANGE 0x1000
131 /** aspect ratio changed */
132 #define VOUT_ASPECT_CHANGE 0x2000
133 /** change/recreate picture buffers */
134 #define VOUT_PICTURE_BUFFERS_CHANGE 0x4000
137 /* Alignment flags */
138 #define VOUT_ALIGN_LEFT 0x0001
139 #define VOUT_ALIGN_RIGHT 0x0002
140 #define VOUT_ALIGN_HMASK 0x0003
141 #define VOUT_ALIGN_TOP 0x0004
142 #define VOUT_ALIGN_BOTTOM 0x0008
143 #define VOUT_ALIGN_VMASK 0x000C
145 /* scaling factor (applied to i_zoom in vout_thread_t) */
146 #define ZOOM_FP_FACTOR 1000
148 /*****************************************************************************
150 *****************************************************************************/
154 * - returns a suitable vout (if requested by a non NULL p_fmt)
155 * - recycles an old vout (if given) by either destroying it or by saving it
158 * The purpose of this function is to avoid unnecessary creation/destruction of
159 * vout (and to allow optional vout reusing).
161 * You can call vout_Request on a vout created by vout_Create or by a previous
162 * call to vout_Request.
163 * You can release the returned value either by vout_Request or vout_Close()
164 * followed by a vlc_object_release() or shorter vout_CloseAndRelease()
166 * \param p_this a vlc object
167 * \param p_vout a vout candidate
168 * \param p_fmt the video format requested or NULL
169 * \return a vout if p_fmt is non NULL and the request is successfull, NULL
172 VLC_EXPORT( vout_thread_t *, vout_Request, ( vlc_object_t *p_this, vout_thread_t *p_vout, video_format_t *p_fmt ) );
173 #define vout_Request(a,b,c) vout_Request(VLC_OBJECT(a),b,c)
176 * This function will create a suitable vout for a given p_fmt. It will never
177 * reuse an already existing unused vout.
179 * You have to call either vout_Close or vout_Request on the returned value
180 * \param p_this a vlc object to which the returned vout will be attached
181 * \param p_fmt the video format requested
182 * \return a vout if the request is successfull, NULL otherwise
184 VLC_EXPORT( vout_thread_t *, vout_Create, ( vlc_object_t *p_this, video_format_t *p_fmt ) );
185 #define vout_Create(a,b) vout_Create(VLC_OBJECT(a),b)
188 * This function will close a vout created by vout_Create or vout_Request.
189 * The associated vout module is closed.
190 * Note: It is not released yet, you'll have to call vlc_object_release()
191 * or use the convenient vout_CloseAndRelease().
193 * \param p_vout the vout to close
195 VLC_EXPORT( void, vout_Close, ( vout_thread_t *p_vout ) );
198 * This function will close a vout created by vout_Create
199 * and then release it.
201 * \param p_vout the vout to close and release
203 static inline void vout_CloseAndRelease( vout_thread_t *p_vout )
205 vout_Close( p_vout );
206 vlc_object_release( p_vout );
210 * This function will handle a snapshot request.
212 * pp_image, pp_picture and p_fmt can be NULL otherwise they will be
213 * set with returned value in case of success.
215 * pp_image will hold an encoded picture in psz_format format.
217 * i_timeout specifies the time the function will wait for a snapshot to be
221 VLC_EXPORT( int, vout_GetSnapshot, ( vout_thread_t *p_vout,
222 block_t **pp_image, picture_t **pp_picture,
223 video_format_t *p_fmt,
224 const char *psz_format, mtime_t i_timeout ) );
227 VLC_EXPORT( picture_t *, vout_CreatePicture, ( vout_thread_t *, bool, bool, unsigned int ) );
228 VLC_EXPORT( void, vout_DestroyPicture, ( vout_thread_t *, picture_t * ) );
229 VLC_EXPORT( void, vout_DisplayPicture, ( vout_thread_t *, picture_t * ) );
230 VLC_EXPORT( void, vout_LinkPicture, ( vout_thread_t *, picture_t * ) );
231 VLC_EXPORT( void, vout_UnlinkPicture, ( vout_thread_t *, picture_t * ) );
234 * Return the spu_t object associated to a vout_thread_t.
236 * The return object is valid only as long as the vout is. You must not
237 * release the spu_t object returned.
238 * It cannot return NULL so no need to check.
240 VLC_EXPORT( spu_t *, vout_GetSpu, ( vout_thread_t * ) );
242 VLC_EXPORT( void, vout_EnableFilter, ( vout_thread_t *, const char *,bool , bool ) );
246 #endif /* _VLC_VIDEO_H */