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>
38 /*****************************************************************************
40 *****************************************************************************/
43 * \defgroup video_output Video Output
44 * This module describes the programming interface for video output threads.
45 * It includes functions allowing to open a new thread, send pictures to a
46 * thread, and destroy a previously opened video output thread.
51 * Video ouput thread private structure
53 typedef struct vout_thread_sys_t vout_thread_sys_t;
56 * Video output thread descriptor
58 * Any independent video output device, such as an X11 window or a GGI device,
59 * is represented by a video output thread, and described using the following
66 /* Private vout_thread data */
71 #define VOUT_ALIGN_LEFT 0x0001
72 #define VOUT_ALIGN_RIGHT 0x0002
73 #define VOUT_ALIGN_HMASK 0x0003
74 #define VOUT_ALIGN_TOP 0x0004
75 #define VOUT_ALIGN_BOTTOM 0x0008
76 #define VOUT_ALIGN_VMASK 0x000C
78 /* scaling factor (applied to i_zoom in vout_thread_t) */
79 #define ZOOM_FP_FACTOR 1000
81 /*****************************************************************************
83 *****************************************************************************/
87 * - returns a suitable vout (if requested by a non NULL p_fmt)
88 * - recycles an old vout (if given) by either destroying it or by saving it
91 * The purpose of this function is to avoid unnecessary creation/destruction of
92 * vout (and to allow optional vout reusing).
94 * You can call vout_Request on a vout created by vout_Create or by a previous
95 * call to vout_Request.
96 * You can release the returned value either by vout_Request or vout_Close()
97 * followed by a vlc_object_release() or shorter vout_CloseAndRelease()
99 * \param p_this a vlc object
100 * \param p_vout a vout candidate
101 * \param p_fmt the video format requested or NULL
102 * \return a vout if p_fmt is non NULL and the request is successfull, NULL
105 VLC_EXPORT( vout_thread_t *, vout_Request, ( vlc_object_t *p_this, vout_thread_t *p_vout, video_format_t *p_fmt ) );
106 #define vout_Request(a,b,c) vout_Request(VLC_OBJECT(a),b,c)
109 * This function will create a suitable vout for a given p_fmt. It will never
110 * reuse an already existing unused vout.
112 * You have to call either vout_Close or vout_Request on the returned value
113 * \param p_this a vlc object to which the returned vout will be attached
114 * \param p_fmt the video format requested
115 * \return a vout if the request is successfull, NULL otherwise
117 VLC_EXPORT( vout_thread_t *, vout_Create, ( vlc_object_t *p_this, video_format_t *p_fmt ) );
118 #define vout_Create(a,b) vout_Create(VLC_OBJECT(a),b)
121 * This function will close a vout created by vout_Create or vout_Request.
122 * The associated vout module is closed.
123 * Note: It is not released yet, you'll have to call vlc_object_release()
124 * or use the convenient vout_CloseAndRelease().
126 * \param p_vout the vout to close
128 VLC_EXPORT( void, vout_Close, ( vout_thread_t *p_vout ) );
131 * This function will close a vout created by vout_Create
132 * and then release it.
134 * \param p_vout the vout to close and release
136 static inline void vout_CloseAndRelease( vout_thread_t *p_vout )
138 vout_Close( p_vout );
139 vlc_object_release( p_vout );
143 * This function will handle a snapshot request.
145 * pp_image, pp_picture and p_fmt can be NULL otherwise they will be
146 * set with returned value in case of success.
148 * pp_image will hold an encoded picture in psz_format format.
150 * i_timeout specifies the time the function will wait for a snapshot to be
154 VLC_EXPORT( int, vout_GetSnapshot, ( vout_thread_t *p_vout,
155 block_t **pp_image, picture_t **pp_picture,
156 video_format_t *p_fmt,
157 const char *psz_format, mtime_t i_timeout ) );
160 VLC_EXPORT( picture_t *, vout_GetPicture, ( vout_thread_t * ) );
161 VLC_EXPORT( void, vout_PutPicture, ( vout_thread_t *, picture_t * ) );
163 VLC_EXPORT( void, vout_HoldPicture, ( vout_thread_t *, picture_t * ) );
164 VLC_EXPORT( void, vout_ReleasePicture, ( vout_thread_t *, picture_t * ) );
167 * Return the spu_t object associated to a vout_thread_t.
169 * The return object is valid only as long as the vout is. You must not
170 * release the spu_t object returned.
171 * It cannot return NULL so no need to check.
173 VLC_EXPORT( spu_t *, vout_GetSpu, ( vout_thread_t * ) );
175 VLC_EXPORT( void, vout_EnableFilter, ( vout_thread_t *, const char *,bool , bool ) );
179 #endif /* _VLC_VIDEO_H */