X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvideo_output.h;h=40ff0bd09be361e6d680cfabf248949cba51fb01;hb=2cb472dba008f7d877ffe6bae9c5575253365282;hp=ce917e0c71e405680bc5a71c1c43838e80081024;hpb=ac08ae30411f18fccf735b337927ee7abd04a009;p=vlc diff --git a/include/video_output.h b/include/video_output.h index ce917e0c71..40ff0bd09b 100644 --- a/include/video_output.h +++ b/include/video_output.h @@ -1,12 +1,11 @@ /***************************************************************************** * video_output.h : video output thread - * 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. ***************************************************************************** - * Copyright (C) 1999, 2000 VideoLAN + * Copyright (C) 1999, 2000 the VideoLAN team + * $Id$ * - * Authors: + * 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 @@ -15,228 +14,255 @@ * * 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. + * 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-1307, USA. + * 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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ -/***************************************************************************** - * 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_pic_width, i_pic_height picture extension - * i_pic_line_width picture total line width - * i_matrix_coefficients matrix coefficients +/** + * \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 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_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_pic_width, int i_pic_height, int i_pic_line_width, - int i_matrix_coefficients ); + */ +typedef void (vout_chroma_convert_t)( vout_thread_t *, + picture_t *, picture_t * ); -/***************************************************************************** - * vout_yuv_t: pre-calculated YUV convertion tables - ***************************************************************************** - * These tables are used by convertion and scaling functions. - *****************************************************************************/ -typedef struct vout_yuv_s +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 conversion tables */ - union - { - u8 * p_gray8; /* gray 8 bits table */ - u16 * p_gray16; /* gray 16 bits table */ - u32 * p_gray32; /* gray 32 bits table */ - u8 * p_rgb8; /* RGB 8 bits table */ - u16 * p_rgb16; /* RGB 16 bits table */ - u32 * p_rgb32; /* RGB 32 bits table */ - } yuv; - - /* Temporary convertion buffer and offset array */ - void * p_buffer; /* convertion buffer */ - int * p_offset; /* offset array */ -} vout_yuv_t; + /** conversion functions */ + vout_chroma_convert_t *pf_convert; -/***************************************************************************** - * vout_buffer_t: rendering buffer - ***************************************************************************** - * This structure store informations about a buffer. Buffers are not completely - * cleared between displays, and modified areas need 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 */ + /** Private module-dependant data */ + chroma_sys_t * p_sys; /* private data */ - /* 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 */ + /** Plugin used and shortcuts to access its capabilities */ + module_t * p_module; - /* Picture data */ - byte_t * p_data; /* memory address */ -} vout_buffer_t; +} vout_chroma_t; -/***************************************************************************** - * vout_thread_t: video output thread descriptor - ***************************************************************************** +/** + * 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. - *****************************************************************************/ -typedef int (vout_sys_create_t) ( p_vout_thread_t p_vout, - char *psz_display, int i_root_window ); -typedef int (vout_sys_init_t) ( p_vout_thread_t p_vout ); -typedef void (vout_sys_end_t) ( p_vout_thread_t p_vout ); -typedef void (vout_sys_destroy_t) ( p_vout_thread_t p_vout ); -typedef int (vout_sys_manage_t) ( p_vout_thread_t p_vout ); -typedef void (vout_sys_display_t) ( p_vout_thread_t p_vout ); -typedef void (vout_set_palette_t) ( p_vout_thread_t p_vout, u16 *red, - u16 *green, u16 *blue, u16 *transp ); - -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 (incl. virtual) */ - int i_screen_depth; /* significant bpp: 8, 15, 16 or 24 */ - int i_bytes_per_pixel;/* real screen depth: 1, 2, 3 or 4 */ - float f_gamma; /* gamma */ - - /* Color masks and shifts in RGB mode - masks are set by system - * initialization, shifts are calculated. A pixel color value can be - * obtained using the formula ((value >> rshift) << lshift) */ - u32 i_red_mask; /* red mask */ - u32 i_green_mask; /* green mask */ - u32 i_blue_mask; /* blue mask */ - int i_red_lshift, i_red_rshift; /* red shifts */ - int i_green_lshift, i_green_rshift; /* green shifts */ - int i_blue_lshift, i_blue_rshift; /* blue shifts */ - - /* Useful pre-calculated pixel values - these are not supposed to be - * accurate values, but rather values looking nice, given their usage. */ - u32 i_white_pixel; /* white */ - u32 i_black_pixel; /* black */ - u32 i_gray_pixel; /* gray */ - u32 i_blue_pixel; /* blue */ - - /* Plugins */ - plugin_id_t vout_plugin; /* video output plugin */ - vout_sys_create_t * p_sys_create; /* allocate output method */ - vout_sys_init_t * p_sys_init; /* initialize output method */ - vout_sys_end_t * p_sys_end; /* terminate output method */ - vout_sys_destroy_t * p_sys_destroy; /* destroy output method */ - vout_sys_manage_t * p_sys_manage; /* handle events */ - vout_sys_display_t * p_sys_display; /* display rendered image */ - vout_set_palette_t * p_set_palette; /* sets 8bpp palette */ - - /* 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 */ + 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 */ + unsigned int i_par_num; /**< monitor pixel aspect-ratio */ + unsigned int i_par_den; /**< monitor pixel aspect-ratio */ + + intf_thread_t *p_parent_intf; /**< parent interface for embedded + vout (if any) */ + /**@}*/ + + /** \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 * ); + void ( *pf_swap ) ( vout_thread_t * ); /* OpenGL only */ + int ( *pf_lock ) ( vout_thread_t * ); /* OpenGL only */ + void ( *pf_unlock ) ( vout_thread_t * ); /* OpenGL only */ + int ( *pf_control ) ( vout_thread_t *, int, va_list ); + /**@}*/ + + /** \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 */ - int i_pictures; /* current heap size */ - 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 */ - - /* Synchronisation informations - synchro level is updated by the vout - * thread and read by decoder threads */ - int i_synchro_level; /* trashing level */ -} 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 */ + /**@}*/ -/***************************************************************************** - * Macros - *****************************************************************************/ + /** \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 */ + + video_format_t fmt_render; /* render format (from the decoder) */ + video_format_t fmt_in; /* input (modified render) format */ + video_format_t fmt_out; /* output format (for the video output) */ + /**@}*/ + + /* Picture heap */ + picture_t p_picture[2*VOUT_MAX_PICTURES+1]; /**< pictures */ + + /* Subpicture unit */ + spu_t *p_spu; + + /* 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; + + /* Misc */ + vlc_bool_t b_snapshot; /**< take one snapshot on the next loop */ +}; + +#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 +/** cropping parameters changed */ +#define VOUT_CROP_CHANGE 0x1000 +/** aspect ratio changed */ +#define VOUT_ASPECT_CHANGE 0x2000 +/** change/recreate picture buffers */ +#define VOUT_PICTURE_BUFFERS_CHANGE 0x4000 +/**@}*/ -/* RGB2PIXEL: assemble RGB components to a pixel value, returns a u32 */ -#define RGB2PIXEL( p_vout, i_red, i_green, i_blue ) \ - (((((u32)i_red) >> p_vout->i_red_rshift) << p_vout->i_red_lshift) | \ - ((((u32)i_green) >> p_vout->i_green_rshift) << p_vout->i_green_lshift) | \ - ((((u32)i_blue) >> p_vout->i_blue_rshift) << p_vout->i_blue_lshift)) +/* 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, int i_method ); -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) __vout_Request(VLC_OBJECT(a),b,c) +VLC_EXPORT( vout_thread_t *, __vout_Request, ( vlc_object_t *, vout_thread_t *, video_format_t * ) ); +#define vout_Create(a,b) __vout_Create(VLC_OBJECT(a),b) +VLC_EXPORT( vout_thread_t *, __vout_Create, ( vlc_object_t *, video_format_t * ) ); +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_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 * ); + +VLC_EXPORT( int, vout_vaControlDefault, ( vout_thread_t *, int, va_list ) ); +VLC_EXPORT( void *, vout_RequestWindow, ( vout_thread_t *, int *, int *, unsigned int *, unsigned int * ) ); +VLC_EXPORT( void, vout_ReleaseWindow, ( vout_thread_t *, void * ) ); +VLC_EXPORT( int, vout_ControlWindow, ( vout_thread_t *, void *, int, va_list ) ); +void vout_IntfInit( vout_thread_t * ); + + +static inline int vout_vaControl( vout_thread_t *p_vout, int i_query, + va_list args ) +{ + if( p_vout->pf_control ) + return p_vout->pf_control( p_vout, i_query, args ); + else + return VLC_EGENERIC; +} + +static inline int vout_Control( vout_thread_t *p_vout, int i_query, ... ) +{ + va_list args; + int i_result; + + va_start( args, i_query ); + i_result = vout_vaControl( p_vout, i_query, args ); + va_end( args ); + return i_result; +} + +enum output_query_e +{ + VOUT_GET_SIZE, /* arg1= unsigned int*, arg2= unsigned int*, res= */ + VOUT_SET_SIZE, /* arg1= unsigned int, arg2= unsigned int, res= */ + VOUT_SET_STAY_ON_TOP, /* arg1= vlc_bool_t res= */ + VOUT_REPARENT, + VOUT_SNAPSHOT, + VOUT_CLOSE, + VOUT_SET_FOCUS /* arg1= vlc_bool_t res= */ +}; +/** + * @} + */