-/*******************************************************************************
+/*****************************************************************************
* video_output.h : video output thread
- * (c)1999 VideoLAN
- *******************************************************************************
+ *****************************************************************************
+ * Copyright (C) 1999, 2000 VideoLAN
+ * $Id: video_output.h,v 1.103 2003/12/04 16:49:43 sam Exp $
+ *
+ * Authors: Vincent Seguin <seguin@via.ecp.fr>
+ * Samuel Hocevar <sam@via.ecp.fr>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
+ *****************************************************************************/
+
+/**
+ * \defgroup video_output Video Output
* This module describes the programming interface for video output threads.
* It includes functions allowing to open a new thread, send pictures to a
- * thread, and destroy a previously oppenned video output thread.
- *******************************************************************************/
-
-/*******************************************************************************
- * vout_thread_t: video output thread descriptor
- *******************************************************************************
- * Any independant video output device, such as an X11 window or a GGI device,
- * is represented by a video output thread, and described using following
- * structure.
- *******************************************************************************/
-typedef struct vout_thread_s
+ * thread, and destroy a previously opened video output thread.
+ * @{
+ */
+
+/**
+ * Chroma conversion function
+ *
+ * This is the prototype common to all conversion functions.
+ * \param p_vout video output thread
+ * \param p_source source picture
+ * \param p_dest destination picture
+ * Picture width and source dimensions must be multiples of 16.
+ */
+typedef void (vout_chroma_convert_t)( vout_thread_t *,
+ picture_t *, picture_t * );
+
+typedef struct vout_chroma_t
{
- /* Thread properties and locks */
- boolean_t b_die; /* `die' flag */
- boolean_t b_error; /* `error' flag */
- boolean_t b_active; /* `active' flag */
- pthread_t thread_id; /* id for pthread functions */
- pthread_mutex_t lock; /* thread lock */
- int * pi_status; /* temporary status flag */
-
- /* Common display properties */
- int i_width; /* current output method width */
- int i_height; /* current output method height */
- int i_screen_depth; /* bits per pixel */
- int i_bytes_per_pixel; /* real screen depth */
- float f_x_ratio; /* horizontal display ratio */
- float f_y_ratio; /* vertical display ratio */
-
-#ifdef STATS
- /* Statistics */
- count_t c_loops; /* number of loops */
- count_t c_idle_loops; /* number of idle loops */
- count_t c_pictures; /* number of pictures added to heap */
-#endif
-
- /* Output method */
- p_vout_sys_t p_sys; /* system output method */
-
- /* Video heap */
- int i_pictures; /* current heap size */
- picture_t p_picture[VOUT_MAX_PICTURES]; /* pictures */
-
- /* YUV translation tables, for 15,16 and 24/32 bpp displays. 16 bits and 32
- * bits pointers points on the same data.
- * CAUTION: these tables are translated: their origin is -384 */
- u16 * pi_trans16_red;
- u16 * pi_trans16_green;
- u16 * pi_trans16_blue;
- u32 * pi_trans32_red;
- u32 * pi_trans32_green;
- u32 * pi_trans32_blue;
-} vout_thread_t;
-
-/*******************************************************************************
- * Prototypes
- *******************************************************************************/
-vout_thread_t * vout_CreateThread (
-#ifdef VIDEO_X11
- char *psz_display, Window root_window,
-#endif
- int i_width, int i_height, int *pi_status
- );
-
-void vout_DestroyThread ( vout_thread_t *p_vout, int *pi_status );
-
-picture_t * vout_CreatePicture ( vout_thread_t *p_vout, int i_type,
- int i_width, int i_height, int i_bytes_per_line );
-void vout_DestroyPicture ( vout_thread_t *p_vout, picture_t *p_pic );
-void vout_DisplayPicture ( vout_thread_t *p_vout, picture_t *p_pic );
-void vout_LinkPicture ( vout_thread_t *p_vout, picture_t *p_pic );
-void vout_UnlinkPicture ( vout_thread_t *p_vout, picture_t *p_pic );
-
-
-
-
-
-
-
-
-
-
-
-
+ /** conversion functions */
+ vout_chroma_convert_t *pf_convert;
+ /** Private module-dependant data */
+ chroma_sys_t * p_sys; /* private data */
+ /** Plugin used and shortcuts to access its capabilities */
+ module_t * p_module;
+} vout_chroma_t;
+/**
+ * Video output thread descriptor
+ *
+ * Any independant video output device, such as an X11 window or a GGI device,
+ * is represented by a video output thread, and described using the following
+ * structure.
+ */
+struct vout_thread_t
+{
+ VLC_COMMON_MEMBERS
+
+ /** \name Thread properties and locks */
+ /**@{*/
+ vlc_mutex_t picture_lock; /**< picture heap lock */
+ vlc_mutex_t subpicture_lock; /**< subpicture heap lock */
+ vlc_mutex_t change_lock; /**< thread change lock */
+ vout_sys_t * p_sys; /**< system output method */
+ /**@}*/
+
+ /** \name Current display properties */
+ /**@{*/
+ uint16_t i_changes; /**< changes made to the thread.
+ \see \ref vout_changes */
+ float f_gamma; /**< gamma */
+ vlc_bool_t b_grayscale; /**< color or grayscale display */
+ vlc_bool_t b_info; /**< print additional information */
+ vlc_bool_t b_interface; /**< render interface */
+ vlc_bool_t b_scale; /**< allow picture scaling */
+ vlc_bool_t b_fullscreen; /**< toogle fullscreen display */
+ vlc_bool_t b_override_aspect; /**< aspect ratio overriden */
+ uint32_t render_time; /**< last picture render time */
+ unsigned int i_window_width; /**< video window width */
+ unsigned int i_window_height; /**< video window height */
+ unsigned int i_alignment; /**< video alignment in window */
+ /**@}*/
+
+ /** \name Plugin used and shortcuts to access its capabilities */
+ /**@{*/
+ module_t * p_module;
+ int ( *pf_init ) ( vout_thread_t * );
+ void ( *pf_end ) ( vout_thread_t * );
+ int ( *pf_manage ) ( vout_thread_t * );
+ void ( *pf_render ) ( vout_thread_t *, picture_t * );
+ void ( *pf_display ) ( vout_thread_t *, picture_t * );
+ /**@}*/
+
+ /** \name Statistics
+ * These numbers are not supposed to be accurate, but are a
+ * good indication of the thread status */
+ /**@{*/
+ count_t c_fps_samples; /**< picture counts */
+ mtime_t p_fps_sample[VOUT_FPS_SAMPLES]; /**< FPS samples dates */
+ /**@}*/
+
+ /** \name Video heap and translation tables */
+ /**@{*/
+ int i_heap_size; /**< heap size */
+ picture_heap_t render; /**< rendered pictures */
+ picture_heap_t output; /**< direct buffers */
+ vlc_bool_t b_direct; /**< rendered are like direct ? */
+ vout_chroma_t chroma; /**< translation tables */
+ /**@}*/
+
+ /* Picture and subpicture heaps */
+ picture_t p_picture[2*VOUT_MAX_PICTURES]; /**< pictures */
+ subpicture_t p_subpicture[VOUT_MAX_PICTURES]; /**< subpictures */
+ /* Statistics */
+ count_t c_loops;
+ count_t c_pictures, c_late_pictures;
+ mtime_t display_jitter; /**< average deviation from the PTS */
+ count_t c_jitter_samples; /**< number of samples used
+ for the calculation of the
+ jitter */
+ /** delay created by internal caching */
+ int i_pts_delay;
+
+ /* Filter chain */
+ char *psz_filter_chain;
+ vlc_bool_t b_filter_change;
+
+ /* text renderer data */
+ text_renderer_sys_t * p_text_renderer_data; /**< private data for
+ the text renderer */
+ module_t * p_text_renderer_module; /**< text renderer module */
+ /** callback used when a new string needs to be shown on the vout */
+ int ( *pf_add_string ) ( vout_thread_t *, byte_t *, text_style_t *, int,
+ int, int, mtime_t, mtime_t );
+};
+
+#define I_OUTPUTPICTURES p_vout->output.i_pictures
+#define PP_OUTPUTPICTURE p_vout->output.pp_picture
+#define I_RENDERPICTURES p_vout->render.i_pictures
+#define PP_RENDERPICTURE p_vout->render.pp_picture
+
+/** \defgroup vout_changes Flags for changes
+ * These flags are set in the vout_thread_t::i_changes field when another
+ * thread changed a variable
+ * @{
+ */
+/** b_info changed */
+#define VOUT_INFO_CHANGE 0x0001
+/** b_grayscale changed */
+#define VOUT_GRAYSCALE_CHANGE 0x0002
+/** b_interface changed */
+#define VOUT_INTF_CHANGE 0x0004
+/** b_scale changed */
+#define VOUT_SCALE_CHANGE 0x0008
+/** gamma changed */
+#define VOUT_GAMMA_CHANGE 0x0010
+/** b_cursor changed */
+#define VOUT_CURSOR_CHANGE 0x0020
+/** b_fullscreen changed */
+#define VOUT_FULLSCREEN_CHANGE 0x0040
+/** size changed */
+#define VOUT_SIZE_CHANGE 0x0200
+/** depth changed */
+#define VOUT_DEPTH_CHANGE 0x0400
+/** change chroma tables */
+#define VOUT_CHROMA_CHANGE 0x0800
+/**@}*/
+
+/* Alignment flags */
+#define VOUT_ALIGN_LEFT 0x0001
+#define VOUT_ALIGN_RIGHT 0x0002
+#define VOUT_ALIGN_HMASK 0x0003
+#define VOUT_ALIGN_TOP 0x0004
+#define VOUT_ALIGN_BOTTOM 0x0008
+#define VOUT_ALIGN_VMASK 0x000C
+
+#define MAX_JITTER_SAMPLES 20
+
+/*****************************************************************************
+ * Prototypes
+ *****************************************************************************/
+#define vout_Request(a,b,c,d,e,f) __vout_Request(VLC_OBJECT(a),b,c,d,e,f)
+VLC_EXPORT( vout_thread_t *, __vout_Request, ( vlc_object_t *, vout_thread_t *, unsigned int, unsigned int, uint32_t, unsigned int ) );
+#define vout_Create(a,b,c,d,e) __vout_Create(VLC_OBJECT(a),b,c,d,e)
+VLC_EXPORT( vout_thread_t *, __vout_Create, ( vlc_object_t *, unsigned int, unsigned int, uint32_t, unsigned int ) );
+VLC_EXPORT( void, vout_Destroy, ( vout_thread_t * ) );
+VLC_EXPORT( int, vout_VarCallback, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
+
+VLC_EXPORT( int, vout_ChromaCmp, ( uint32_t, uint32_t ) );
+
+VLC_EXPORT( picture_t *, vout_CreatePicture, ( vout_thread_t *, vlc_bool_t, vlc_bool_t, unsigned int ) );
+VLC_EXPORT( void, vout_InitFormat, ( video_frame_format_t *, uint32_t, int, int, int ) );
+VLC_EXPORT( void, vout_InitPicture, ( vlc_object_t *, picture_t *, uint32_t, int, int, int ) );
+VLC_EXPORT( void, vout_AllocatePicture,( vout_thread_t *, picture_t *, uint32_t, int, int, int ) );
+VLC_EXPORT( void, vout_DestroyPicture, ( vout_thread_t *, picture_t * ) );
+VLC_EXPORT( void, vout_DisplayPicture, ( vout_thread_t *, picture_t * ) );
+VLC_EXPORT( void, vout_DatePicture, ( vout_thread_t *, picture_t *, mtime_t ) );
+VLC_EXPORT( void, vout_LinkPicture, ( vout_thread_t *, picture_t * ) );
+VLC_EXPORT( void, vout_UnlinkPicture, ( vout_thread_t *, picture_t * ) );
+VLC_EXPORT( void, vout_PlacePicture, ( vout_thread_t *, unsigned int, unsigned int, unsigned int *, unsigned int *, unsigned int *, unsigned int * ) );
+picture_t * vout_RenderPicture ( vout_thread_t *, picture_t *,
+ subpicture_t * );
+/**
+ * \addtogroup subpicture
+ * @{
+ */
+VLC_EXPORT( subpicture_t *, vout_CreateSubPicture, ( vout_thread_t *, int ) );
+VLC_EXPORT( void, vout_DestroySubPicture, ( vout_thread_t *, subpicture_t * ) );
+VLC_EXPORT( void, vout_DisplaySubPicture, ( vout_thread_t *, subpicture_t * ) );
+
+subpicture_t * vout_SortSubPictures ( vout_thread_t *, mtime_t );
+void vout_RenderSubPictures ( vout_thread_t *, picture_t *,
+ subpicture_t * );
+/** @}*/
+/**
+ * @}
+ */
projects / vlc / blobdiff