-/*******************************************************************************
+/*****************************************************************************
* video_output.h : video output thread
- * (c)1999 VideoLAN
- *******************************************************************************
* 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.
- *******************************************************************************
- * Requires:
- * <pthread.h>
- * "config.h"
- * "common.h"
- * "mtime.h"
- * "video.h"
- *******************************************************************************/
-
-/* ?? this over-complicated API and code should be re-designed, with a simple
- * video-stream associated to a window (each window designed to be openned in
- * a parent one and probably without border), and have an api looking like
- * vout_CreateWindow
- * vout_DestroyWindow
- * vout_AddPicture
- * vout_RemovePicture
- * vout_ReservePicture
- * vout_AddReservedPicture
- * vout_Clear
- * vout_Refresh
+ * thread, and destroy a previously opened video output thread.
+ *****************************************************************************
+ * Copyright (C) 1999, 2000 VideoLAN
+ * $Id: video_output.h,v 1.81 2002/07/20 18:01:41 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.
*
- * the overlay/transparent, permanent and such stuff should disapear.
- */
-
-/*******************************************************************************
- * vout_stream_t: video stream descriptor
- *******************************************************************************
- * Each video stream has a set of properties, stored in this structure. It is
- * part of vout_thread_t and is not supposed to be used anywhere else.
- *******************************************************************************/
-typedef struct
+ * 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.
+ *****************************************************************************/
+
+/*****************************************************************************
+ * vout_chroma_t: Chroma conversion function
+ *****************************************************************************
+ * This is the prototype common to all conversion functions.
+ * Parameters:
+ * p_source source picture
+ * 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
{
- int i_status; /* is stream active ? */
- picture_t * p_next_picture; /* next picture to be displayed */
+ /* conversion functions */
+ vout_chroma_convert_t *pf_convert;
-#ifdef STATS
- /* Statistics */
- count_t c_pictures; /* total number of pictures added */
- count_t c_rendered_pictures; /* number of rendered pictures */
-#endif
-} vout_stream_t;
-
-/* Video stream status */
-#define VOUT_INACTIVE_STREAM 0 /* stream is inactive (empty) */
-#define VOUT_ACTIVE_STREAM 1 /* stream is active */
-#define VOUT_ENDING_STREAM 2 /* stream will be destroyed when empty */
-#define VOUT_DESTROYED_STREAM 3 /* stream must be destroyed */
-
-/*******************************************************************************
- * vout_thread_t: video output thread descriptor
- *******************************************************************************
- * Any independant video output device, such as an X11 window, is represented
- * by a video output thread, and described using following structure.
- *******************************************************************************/
-typedef struct vout_thread_s
-{
- /* 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 streams_lock; /* streams modification lock */
- pthread_mutex_t pictures_lock; /* pictures modification 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 */
-
- /* Output method */
- struct vout_x11_s * p_x11; /* X11 output method */
-
- /* Video heap */
- int i_max_pictures; /* heap maximal size */
- int i_pictures; /* current heap size */
- picture_t * p_picture; /* pictures */
-
- /* Streams data */
- vout_stream_t p_stream[VOUT_MAX_STREAMS]; /* streams data */
-
-#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 */
- count_t c_rendered_pictures; /* number of pictures rendered */
-#endif
-
- /* Rendering functions - these functions are of vout_render_blank_t and
- * vout_render_line_t, but are not declared here using these types since
- * they require vout_thread_t to be defined */
- void (* RenderRGBBlank) ( struct vout_thread_s *p_vout, pixel_t pixel,
- int i_x, int i_y, int i_width, int i_height );
- void (* RenderPixelBlank) ( struct vout_thread_s *p_vout, pixel_t pixel,
- int i_x, int i_y, int i_width, int i_height );
- void (* RenderRGBLine) ( struct vout_thread_s *p_vout, picture_t *p_pic,
- int i_x, int i_y, int i_pic_x, int i_pic_y,
- int i_width, int i_line_width, int i_ratio );
- void (* RenderPixelLine) ( struct vout_thread_s *p_vout, picture_t *p_pic,
- int i_x, int i_y, int i_pic_x, int i_pic_y,
- int i_width, int i_line_width, int i_ratio );
- void (* RenderRGBMaskLine) ( struct vout_thread_s *p_vout, picture_t *p_pic,
- int i_x, int i_y, int i_pic_x, int i_pic_y,
- int i_width, int i_line_width, int i_ratio );
- void (* RenderPixelMaskLine) ( struct vout_thread_s *p_vout, picture_t *p_pic,
- int i_x, int i_y, int i_pic_x, int i_pic_y,
- int i_width, int i_line_width, int i_ratio );
- /* ?? add YUV types */
-} vout_thread_t;
-
-/*******************************************************************************
- * vout_render_blank_t: blank rendering function
- * vout_render_line_t: rectangle rendering functions
- *******************************************************************************
- * All rendering functions should be of these types - for blank pictures
- * (pictures with uniform color), blank rendering functions are called once. For
- * other pictures, each function is called once for each picture line. Note that
- * the part of the picture sent to the rendering functions is in the output
- * window, since the clipping is done before.
- * p_vout is the calling thread
- * pixel is the color or pixel value of the rectange to be drawn
- * p_pic is the picture to be rendered
- * i_x, i_y is the absolute position in output window
- * i_pic_x is the first pixel to be drawn in the picture
- * i_pic_y is the line of the picture to be drawn
- * i_width is the width of the area to be rendered in the picture (not in the
- * output window), except for blank pictures, where it is the absolute size
- * of the area to be rendered
- * i_height is the height og the area to be rendered
- * i_line_width is the number of time the line must be copied
- * i_ratio is the horizontal display ratio
- *******************************************************************************/
-typedef void (vout_render_blank_t)( vout_thread_t *p_vout, pixel_t pixel,
- int i_x, int i_y, int i_width, int i_height );
-typedef void (vout_render_line_t) ( vout_thread_t *p_vout, picture_t *p_pic,
- int i_x, int i_y, int i_pic_x, int i_pic_y,
- int i_width, int i_line_width, int i_ratio );
-
-/*******************************************************************************
- * Prototypes
- *******************************************************************************/
-vout_thread_t * vout_CreateThread ( video_cfg_t *p_cfg, int *pi_status );
-void vout_DestroyThread ( vout_thread_t *p_vout, int *pi_status );
-
-picture_t * vout_DisplayPicture ( vout_thread_t *p_vout, picture_t *p_pic );
-picture_t * vout_DisplayPictureCopy ( vout_thread_t *p_vout, picture_t *p_pic );
-picture_t * vout_DisplayPictureReplicate ( vout_thread_t *p_vout, picture_t *p_pic );
-picture_t * vout_DisplayReservedPicture ( vout_thread_t *p_vout, picture_t *p_pic );
-
-picture_t * vout_CreateReservedPicture ( vout_thread_t *p_vout, video_cfg_t *p_cfg );
-picture_t * vout_ReservePicture ( vout_thread_t *p_vout, picture_t *p_pic );
-picture_t * vout_ReservePictureCopy ( vout_thread_t *p_vout, picture_t *p_pic );
-picture_t * vout_ReservePictureReplicate ( vout_thread_t *p_vout, picture_t *p_pic );
-void vout_RemovePicture ( vout_thread_t *p_vout, picture_t *p_pic );
-
-void vout_RefreshPermanentPicture ( vout_thread_t *p_vout, picture_t *p_pic,
- mtime_t displa_date );
+ /* Private module-dependant data */
+ chroma_sys_t * p_sys; /* private data */
-void vout_LinkPicture ( vout_thread_t *p_vout, picture_t *p_pic );
-void vout_UnlinkPicture ( vout_thread_t *p_vout, picture_t *p_pic );
-
-int vout_CreateStream ( vout_thread_t *p_vout );
-void vout_EndStream ( vout_thread_t *p_vout, int i_stream );
-void vout_DestroyStream ( vout_thread_t *p_vout, int i_stream );
-
-#ifdef DEBUG
-void vout_PrintHeap ( vout_thread_t *p_vout, char *psz_str );
-#endif
+ /* Plugin used and shortcuts to access its capabilities */
+ module_t * p_module;
+ int ( * pf_init ) ( vout_thread_t * );
+ void ( * pf_end ) ( vout_thread_t * );
+} vout_chroma_t;
+/*****************************************************************************
+ * vout_fifo_t
+ *****************************************************************************/
+typedef struct vout_fifo_t
+{
+ /* See the fifo types below */
+ int i_type;
+ vlc_bool_t b_die;
+ int i_fifo; /* Just to keep track of the fifo index */
+ vlc_mutex_t data_lock;
+ vlc_cond_t data_wait;
+} vout_fifo_t;
+#define VOUT_EMPTY_FIFO 0
+#define VOUT_YUV_FIFO 1
+#define VOUT_SPU_FIFO 2
+/*****************************************************************************
+ * 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 the following
+ * structure.
+ *****************************************************************************/
+struct vout_thread_t
+{
+ VLC_COMMON_MEMBERS
+
+ /* Thread properties and lock */
+ 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 */
+
+ /* Current display properties */
+ u16 i_changes; /* changes made to the thread */
+ 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 */
+ mtime_t render_time; /* last picture render time */
+ int i_window_width; /* video window width */
+ int i_window_height; /* video window height */
+
+ /* Plugin used and shortcuts to access its capabilities */
+ module_t * p_module;
+ int ( *pf_create ) ( vout_thread_t * );
+ int ( *pf_init ) ( vout_thread_t * );
+ void ( *pf_end ) ( vout_thread_t * );
+ void ( *pf_destroy ) ( 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 * );
+
+ /* 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 */
+
+ /* 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 */
+
+ /* Bitmap fonts */
+ vout_font_t * p_default_font; /* default font */
+ vout_font_t * p_large_font; /* large font */
+ /* 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 */
+
+ /* Mouse */
+ int i_mouse_x, i_mouse_y, i_mouse_button;
+
+ /* Filter chain */
+ char *psz_filter_chain;
+};
+
+#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
+
+/* Flags for changes - these flags are set in the i_changes field when another
+ * thread changed a variable */
+#define VOUT_INFO_CHANGE 0x0001 /* b_info changed */
+#define VOUT_GRAYSCALE_CHANGE 0x0002 /* b_grayscale changed */
+#define VOUT_INTF_CHANGE 0x0004 /* b_interface changed */
+#define VOUT_SCALE_CHANGE 0x0008 /* b_scale changed */
+#define VOUT_GAMMA_CHANGE 0x0010 /* gamma changed */
+#define VOUT_CURSOR_CHANGE 0x0020 /* b_cursor changed */
+#define VOUT_FULLSCREEN_CHANGE 0x0040 /* b_fullscreen changed */
+#define VOUT_SIZE_CHANGE 0x0200 /* size changed */
+#define VOUT_DEPTH_CHANGE 0x0400 /* depth changed */
+#define VOUT_CHROMA_CHANGE 0x0800 /* change chroma tables */
+
+/* Disabled for thread deadlocks issues --Meuuh */
+//#define VOUT_NODISPLAY_CHANGE 0xff00 /* changes which forbidden display */
+
+#define MAX_JITTER_SAMPLES 20
+
+/*****************************************************************************
+ * Prototypes
+ *****************************************************************************/
+#define vout_CreateThread(a,b,c,d,e) __vout_CreateThread(CAST_TO_VLC_OBJECT(a),b,c,d,e)
+VLC_EXPORT( vout_thread_t *, __vout_CreateThread, ( vlc_object_t *, int, int, u32, int ) );
+VLC_EXPORT( void, vout_DestroyThread, ( vout_thread_t * ) );
+
+vout_fifo_t * vout_CreateFifo ( void );
+void vout_DestroyFifo ( vout_fifo_t * );
+void vout_FreeFifo ( vout_fifo_t * );
+
+VLC_EXPORT( int, vout_ChromaCmp, ( u32, u32 ) );
+
+VLC_EXPORT( picture_t *, vout_CreatePicture, ( vout_thread_t *, vlc_bool_t, vlc_bool_t, vlc_bool_t ) );
+VLC_EXPORT( void, vout_AllocatePicture,( vout_thread_t *, picture_t *, int, int, u32 ) );
+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 *, int, int, int *, int *, int *, int * ) );
+picture_t * vout_RenderPicture ( vout_thread_t *, picture_t *,
+ subpicture_t * );
+
+VLC_EXPORT( subpicture_t *, vout_CreateSubPicture, ( vout_thread_t *, int, 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 * );