X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvideo_output.h;h=64d4aaf0546c5e5e6dfccf14747b79e5c4f62909;hb=3d6ee48d4aacb1fbd5c2741b7b319a62a47009d9;hp=65abd200645d8ec586ed1b088050a1f804857a80;hpb=28115de8beb4e8d07ebcec0fb14d5478c595aacd;p=vlc diff --git a/include/video_output.h b/include/video_output.h index 65abd20064..64d4aaf054 100644 --- a/include/video_output.h +++ b/include/video_output.h @@ -1,176 +1,228 @@ -/******************************************************************************* +/***************************************************************************** * 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 + * Samuel Hocevar + * + * 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_yuv_convert_t: YUV convertion function - ******************************************************************************* - * This is the prototype common to all convertion functions. The type of p_pic - * will change depending of the screen depth treated. - * Parameters: - * p_vout video output thread - * p_pic picture address - * p_y, p_u, p_v Y,U,V samples addresses - * i_width, i_height Y samples extension - * i_skip Y pixels to skip at the end of a line - * i_pic_width, i_pic_height picture extension - * i_pic_skip pixels to skip at the end of a line - * i_matrix_coefficients matrix coefficients - * Conditions: - * i_width % 16 == 0 - *******************************************************************************/ -typedef void (vout_yuv_convert_t)( p_vout_thread_t p_vout, void *p_pic, - yuv_data_t *p_y, yuv_data_t *p_u, yuv_data_t *p_v, - int i_width, int i_height, int i_skip, - int i_pic_width, int i_pic_height, int i_pic_skip, - int i_matrix_coefficients ); - -/******************************************************************************* - * vout_yuv_t: pre-calculated YUV convertion tables - ******************************************************************************* - * These tables are used by convertion and scaling functions. - *******************************************************************************/ -typedef struct vout_yuv_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 { - /* Convertion functions */ - vout_yuv_convert_t * p_Convert420; /* YUV 4:2:0 converter */ - vout_yuv_convert_t * p_Convert422; /* YUV 4:2:2 converter */ - vout_yuv_convert_t * p_Convert444; /* YUV 4:4:4 converter */ - - /* Pre-calculated convertion tables */ - void * p_base; /* base for all translation tables */ - union - { - struct { u16 *p_red, *p_green, *p_blue; } rgb16; /* color 15, 16 bpp */ - struct { u32 *p_red, *p_green, *p_blue; } rgb32; /* color 24, 32 bpp */ - struct { u16 *p_gray; } gray16; /* gray 15, 16 bpp */ - struct { u32 *p_gray; } gray32; /* gray 24, 32 bpp */ - } yuv; - union - { - u16 * p_rgb16; - u32 * p_rgb32; - } yuv2;//?? - - /* Temporary convertion buffer - this buffer may be used by convertion - * functions and should be 2 screen lines width */ - void * p_buffer; /* convertion buffer */ -} vout_yuv_t; - -/******************************************************************************* - * vout_buffer_t: rendering buffer - ******************************************************************************* - * This structure store informations about a buffer. Buffers are not completely - * cleared between displays, and modified areas needs to be stored. - *******************************************************************************/ -typedef struct vout_buffer_s -{ - /* Picture area */ - int i_pic_x, i_pic_y; /* picture position */ - int i_pic_width, i_pic_height; /* picture extension */ - - /* Other areas - only vertical extensions of areas are stored */ - int i_areas; /* number of areas */ - int pi_area_begin[VOUT_MAX_AREAS]; /* beginning of area */ - int pi_area_end[VOUT_MAX_AREAS]; /* end of area */ - - /* Picture data */ - byte_t * p_data; /* memory address */ -} vout_buffer_t; - -/******************************************************************************* - * vout_thread_t: video output thread descriptor - ******************************************************************************* + /** 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 following + * is represented by a video output thread, and described using the following * structure. - *******************************************************************************/ -typedef struct vout_thread_s + */ +struct vout_thread_t { - /* Thread properties and lock */ - boolean_t b_die; /* `die' flag */ - boolean_t b_error; /* `error' flag */ - boolean_t b_active; /* `active' flag */ - vlc_thread_t thread_id; /* id for pthread functions */ - vlc_mutex_t picture_lock; /* picture heap lock */ - vlc_mutex_t subpicture_lock; /* subpicture heap lock */ - vlc_mutex_t change_lock; /* thread change lock */ - int * pi_status; /* temporary status flag */ - p_vout_sys_t p_sys; /* system output method */ - - /* Current display properties */ - u16 i_changes; /* changes made to the thread */ - int i_width; /* current output method width */ - int i_height; /* current output method height */ - int i_bytes_per_line;/* bytes per line (including virtual) */ - int i_screen_depth; /* bits per pixel */ - int i_bytes_per_pixel; /* real screen depth */ - float f_gamma; /* gamma */ - - /* Pictures and rendering properties */ - boolean_t b_grayscale; /* color or grayscale display */ - boolean_t b_info; /* print additionnal informations */ - boolean_t b_interface; /* render interface */ - boolean_t b_scale; /* allow picture scaling */ - - /* Idle screens management */ - mtime_t last_display_date; /* last non idle display date */ - mtime_t last_idle_date; /* last idle display date */ - -#ifdef STATS - /* Statistics - these numbers are not supposed to be accurate, but are a + 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 */ - mtime_t render_time; /* last picture render time */ - count_t c_fps_samples; /* picture counts */ - mtime_t p_fps_sample[ VOUT_FPS_SAMPLES ]; /* FPS samples dates */ -#endif - - /* Rendering buffers */ - int i_buffer_index; /* buffer index */ - vout_buffer_t p_buffer[2]; /* buffers properties */ - - /* Videos heap and translation tables */ - picture_t p_picture[VOUT_MAX_PICTURES]; /* pictures */ - subpicture_t p_subpicture[VOUT_MAX_PICTURES]; /* subpictures */ - vout_yuv_t yuv; /* translation tables */ - - /* Bitmap fonts */ - p_vout_font_t p_default_font; /* default font */ - p_vout_font_t p_large_font; /* large font */ -} vout_thread_t; - -/* 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_SIZE_CHANGE 0x0200 /* size changed */ -#define VOUT_DEPTH_CHANGE 0x0400 /* depth changed */ -#define VOUT_GAMMA_CHANGE 0x0010 /* gamma changed */ -#define VOUT_YUV_CHANGE 0x0800 /* change yuv tables */ -#define VOUT_NODISPLAY_CHANGE 0xff00 /* changes which forbidden display */ - -/******************************************************************************* + /**@{*/ + 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 - *******************************************************************************/ -vout_thread_t * vout_CreateThread ( char *psz_display, int i_root_window, - 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 ); -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_DatePicture ( vout_thread_t *p_vout, picture_t *p_pic, mtime_t date ); -void vout_LinkPicture ( vout_thread_t *p_vout, picture_t *p_pic ); -void vout_UnlinkPicture ( vout_thread_t *p_vout, picture_t *p_pic ); -subpicture_t * vout_CreateSubPicture ( vout_thread_t *p_vout, int i_type, int i_size ); -void vout_DestroySubPicture ( vout_thread_t *p_vout, subpicture_t *p_subpic ); -void vout_DisplaySubPicture ( vout_thread_t *p_vout, subpicture_t *p_subpic ); - -void vout_SetBuffers ( vout_thread_t *p_vout, void *p_buf1, void *p_buf2 ); + *****************************************************************************/ +#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 * ); +/** @}*/ +/** + * @} + */