X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_vout.h;h=d3382771abdb0de8d41200fec1a56d4b2b50f9c3;hb=23fe953dbb391d1a20a6b75a79d41ff8a2d77f82;hp=30baf2517827185f3b73f55ae10d33f482ed1e96;hpb=bf35f491e383733efc597125f8ea580225db6bc2;p=vlc diff --git a/include/vlc_vout.h b/include/vlc_vout.h index 30baf25178..d3382771ab 100644 --- a/include/vlc_vout.h +++ b/include/vlc_vout.h @@ -1,7 +1,7 @@ /***************************************************************************** * vlc_video.h: common video definitions ***************************************************************************** - * Copyright (C) 1999 - 2005 the VideoLAN team + * Copyright (C) 1999 - 2008 the VideoLAN team * $Id$ * * Authors: Vincent Seguin @@ -23,14 +23,11 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ -#if !defined( __LIBVLC__ ) - #error You are not libvlc or one of its plugins. You cannot include this file -#endif - #ifndef _VLC_VOUT_H_ #define _VLC_VOUT_H_ 1 #include +#include /** Description of a planar graphic field */ typedef struct plane_t @@ -78,7 +75,7 @@ struct picture_t * @{*/ int i_status; /**< picture flags */ int i_type; /**< is picture a direct buffer ? */ - vlc_bool_t b_slow; /**< is picture in slow memory ? */ + bool b_slow; /**< is picture in slow memory ? */ int i_matrix_coefficients; /**< in YUV type, encoding type */ /**@}*/ @@ -88,16 +85,16 @@ struct picture_t /**@{*/ unsigned i_refcount; /**< link reference counter */ mtime_t date; /**< display date */ - vlc_bool_t b_force; + bool b_force; /**@}*/ /** \name Picture dynamic properties * Those properties can be changed by the decoder * @{ */ - vlc_bool_t b_progressive; /**< is it a progressive frame ? */ + bool b_progressive; /**< is it a progressive frame ? */ unsigned int i_nb_fields; /**< # of displayed fields */ - vlc_bool_t b_top_field_first; /**< which field is first */ + bool b_top_field_first; /**< which field is first */ /**@}*/ /** The picture heap we are attached to */ @@ -118,6 +115,75 @@ struct picture_t struct picture_t *p_next; }; +/** + * This function will create a new picture. + * The picture created will implement a default release management compatible + * with picture_Yield and picture_Release. This default management will release + * picture_sys_t *p_sys field if non NULL. + */ +VLC_EXPORT( picture_t *, picture_New, ( vlc_fourcc_t i_chroma, int i_width, int i_height, int i_aspect ) ); + +/** + * This function will force the destruction a picture. + * The value of the picture reference count should be 0 before entering this + * function. + * Unless used for reimplementing pf_release, you should not use this + * function but picture_Release. + */ +VLC_EXPORT( void, picture_Delete, ( picture_t * ) ); + +/** + * This function will increase the picture reference count. + * It will not have any effect on picture obtained from vout + */ +static inline void picture_Yield( picture_t *p_picture ) +{ + if( p_picture->pf_release ) + p_picture->i_refcount++; +} +/** + * This function will release a picture. + * It will not have any effect on picture obtained from vout + */ +static inline void picture_Release( picture_t *p_picture ) +{ + /* FIXME why do we let pf_release handle the i_refcount ? */ + if( p_picture->pf_release ) + p_picture->pf_release( p_picture ); +} + +/** + * This function will copy all picture dynamic properties. + */ +static inline void picture_CopyProperties( picture_t *p_dst, const picture_t *p_src ) +{ + p_dst->date = p_src->date; + p_dst->b_force = p_src->b_force; + + p_dst->b_progressive = p_src->b_progressive; + p_dst->i_nb_fields = p_src->i_nb_fields; + p_dst->b_top_field_first = p_src->b_top_field_first; +} + +/** + * This function will copy the picture pixels. + * You can safely copy between pictures that do not have the same size, + * only the compatible(smaller) part will be copied. + */ +VLC_EXPORT( void, picture_CopyPixels, ( picture_t *p_dst, const picture_t *p_src ) ); + +/** + * This function will copy both picture dynamic properties and pixels. + * You have to notice that sometime a simple picture_Yield may do what + * you want without the copy overhead. + * Provided for convenience. + */ +static inline void picture_Copy( picture_t *p_dst, const picture_t *p_src ) +{ + picture_CopyPixels( p_dst, p_src ); + picture_CopyProperties( p_dst, p_src ); +} + /** * Video picture heap, either render (to store pictures used * by the decoder) or output (to store pictures displayed by the vout plugin) @@ -139,7 +205,7 @@ struct picture_heap_t /* Real pictures */ picture_t* pp_picture[VOUT_MAX_PICTURES]; /**< pictures */ int i_last_used_pic; /**< last used pic in heap */ - vlc_bool_t b_allow_modify_pics; + bool b_allow_modify_pics; /* Stuff used for truecolor RGB planes */ uint32_t i_rmask; int i_rrshift, i_lrshift; @@ -211,10 +277,11 @@ struct subpicture_region_t int i_x; /**< position of region */ int i_y; /**< position of region */ int i_align; /**< alignment within a region */ + int i_alpha; /**< transparency */ char *psz_text; /**< text string comprising this region */ char *psz_html; /**< HTML version of subtitle (NULL = use psz_text) */ - text_style_t *p_style; /* a description of the text style formatting */ + text_style_t *p_style; /**< a description of the text style formatting */ subpicture_region_t *p_next; /**< next region in the list */ subpicture_region_t *p_cache; /**< modified version of this region */ @@ -247,10 +314,10 @@ struct subpicture_t /**@{*/ mtime_t i_start; /**< beginning of display date */ mtime_t i_stop; /**< end of display date */ - vlc_bool_t b_ephemer; /**< If this flag is set to true the subtitle + bool b_ephemer; /**< If this flag is set to true the subtitle will be displayed untill the next one appear */ - vlc_bool_t b_fade; /**< enable fading */ - vlc_bool_t b_pausable; /**< subpicture will be paused if + bool b_fade; /**< enable fading */ + bool b_pausable; /**< subpicture will be paused if stream is paused */ /**@}*/ @@ -268,7 +335,7 @@ struct subpicture_t int i_alpha; /**< transparency */ int i_original_picture_width; /**< original width of the movie */ int i_original_picture_height;/**< original height of the movie */ - vlc_bool_t b_absolute; /**< position is absolute */ + bool b_absolute; /**< position is absolute */ int i_flags; /**< position flags */ /**@}*/ @@ -284,9 +351,9 @@ struct subpicture_t video_format_t *, picture_t * ); void ( *pf_destroy_region ) ( vlc_object_t *, subpicture_region_t * ); - void ( *pf_pre_render ) ( video_format_t *, spu_t *, subpicture_t *, mtime_t ); - subpicture_region_t * ( *pf_update_regions ) ( video_format_t *, spu_t *, - subpicture_t *, mtime_t ); + void ( *pf_pre_render ) ( video_format_t *, spu_t *, subpicture_t * ); + void ( *pf_update_regions ) ( video_format_t *, spu_t *, + subpicture_t *, mtime_t ); /** Private data - the subtitle plugin might want to put stuff here to * keep track of the subpicture */ @@ -364,38 +431,10 @@ VLC_EXPORT( int, __vout_AllocatePicture,( vlc_object_t *p_this, picture_t *p_pic * @{ */ -/** - * 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 -{ - /** 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; - -/** Maximum numbers of video filters2 that can be attached to a vout */ -#define MAX_VFILTERS 10 - /** * Video output thread descriptor * - * Any independant video output device, such as an X11 window or a GGI device, + * Any independent 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. */ @@ -417,11 +456,11 @@ struct vout_thread_t 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 */ + bool b_grayscale; /**< color or grayscale display */ + bool b_info; /**< print additional information */ + bool b_interface; /**< render interface */ + bool b_scale; /**< allow picture scaling */ + bool 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 */ @@ -429,8 +468,7 @@ struct vout_thread_t 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) */ + struct vout_window_t *p_window; /**< window for embedded vout (if any) */ /**@}*/ /** \name Plugin used and shortcuts to access its capabilities */ @@ -460,8 +498,8 @@ struct vout_thread_t 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 */ + bool b_direct; /**< rendered are like direct ? */ + filter_t *p_chroma; /**< translation tables */ video_format_t fmt_render; /* render format (from the decoder) */ video_format_t fmt_in; /* input (modified render) format */ @@ -472,42 +510,34 @@ struct vout_thread_t picture_t p_picture[2*VOUT_MAX_PICTURES+1]; /**< pictures */ /* Subpicture unit */ - spu_t *p_spu; + 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 + 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; + int i_pts_delay; /* Filter chain */ - char *psz_filter_chain; - vlc_bool_t b_filter_change; - - /* Video filter2 chain - * these are handled like in transcode.c - * XXX: we might need to merge the two chains (v1 and v2 filters) */ - char *psz_vfilters[MAX_VFILTERS]; - config_chain_t *p_vfilters_cfg[MAX_VFILTERS]; - int i_vfilters_cfg; + char *psz_filter_chain; + bool b_filter_change; - filter_t *pp_vfilters[MAX_VFILTERS]; - int i_vfilters; - - vlc_bool_t b_vfilter_change; + /* Video filter2 chain */ + filter_chain_t *p_vf2_chain; + char *psz_vf2; /* Misc */ - vlc_bool_t b_snapshot; /**< take one snapshot on the next loop */ + bool b_snapshot; /**< take one snapshot on the next loop */ /* Video output configuration */ config_chain_t *p_cfg; /* Show media title on videoutput */ - vlc_bool_t b_title_show; + bool b_title_show; mtime_t i_title_timeout; int i_title_position; }; @@ -563,16 +593,68 @@ struct vout_thread_t /***************************************************************************** * Prototypes *****************************************************************************/ + +/** + * This function will + * - returns a suitable vout (if requested by a non NULL p_fmt) + * - recycles an old vout (if given) by either destroying it or by saving it + * for latter usage. + * + * The purpose of this function is to avoid unnecessary creation/destruction of + * vout (and to allow optional vout reusing). + * + * You can call vout_Request on a vout created by vout_Create or by a previous + * call to vout_Request. + * You can release the returned value either by vout_Request or vout_Close() + * followed by a vlc_object_release() or shorter vout_CloseAndRelease() + * + * \param p_this a vlc object + * \param p_vout a vout candidate + * \param p_fmt the video format requested or NULL + * \return a vout if p_fmt is non NULL and the request is successfull, NULL + * otherwise + */ #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 * ) ); +VLC_EXPORT( vout_thread_t *, __vout_Request, ( vlc_object_t *p_this, vout_thread_t *p_vout, video_format_t *p_fmt ) ); + +/** + * This function will create a suitable vout for a given p_fmt. It will never + * reuse an already existing unused vout. + * + * You have to call either vout_Close or vout_Request on the returned value + * \param p_this a vlc object to which the returned vout will be attached + * \param p_fmt the video format requested + * \return a vout if the request is successfull, NULL otherwise + */ #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( vout_thread_t *, __vout_Create, ( vlc_object_t *p_this, video_format_t *p_fmt ) ); + +/** + * This function will close a vout created by vout_Create or vout_Request. + * The associated vout module is closed. + * Note: It is not released yet, you'll have to call vlc_object_release() + * or use the convenient vout_CloseAndRelease(). + * + * \param p_vout the vout to close + */ +VLC_EXPORT( void, vout_Close, ( vout_thread_t *p_vout ) ); +/** + * This function will close a vout created by vout_Create + * and then release it. + * + * \param p_vout the vout to close and release + */ +static inline void vout_CloseAndRelease( vout_thread_t *p_vout ) +{ + vout_Close( p_vout ); + vlc_object_release( p_vout ); +} + +/* */ 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( picture_t *, vout_CreatePicture, ( vout_thread_t *, bool, bool, 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 * ) ); @@ -580,16 +662,21 @@ VLC_EXPORT( void, vout_DatePicture, ( vout_thread_t *, picture_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 * ) ); + +/* DO NOT use vout_RenderPicture unless you are in src/video_ouput */ picture_t * vout_RenderPicture ( vout_thread_t *, picture_t *, subpicture_t * ); +/* DO NOT use vout_CountPictureAvailable unless your are in src/input/dec.c (no exception) */ +int vout_CountPictureAvailable( vout_thread_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 * ); VLC_EXPORT( int, vout_Snapshot, ( vout_thread_t *p_vout, picture_t *p_pic ) ); -VLC_EXPORT( void, vout_EnableFilter, ( vout_thread_t *, char *,vlc_bool_t , vlc_bool_t ) ); +VLC_EXPORT( void, vout_EnableFilter, ( vout_thread_t *, char *,bool , bool ) ); static inline int vout_vaControl( vout_thread_t *p_vout, int i_query, @@ -616,11 +703,11 @@ 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_SET_STAY_ON_TOP, /* arg1= bool res= */ VOUT_REPARENT, VOUT_SNAPSHOT, VOUT_CLOSE, - VOUT_SET_FOCUS, /* arg1= vlc_bool_t res= */ + VOUT_SET_FOCUS, /* arg1= bool res= */ VOUT_SET_VIEWPORT, /* arg1= view rect, arg2=clip rect, res= */ VOUT_REDRAW_RECT, /* arg1= area rect, res= */ };