X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_subpicture.h;h=6bfede171002b78b80c7635e87fdd51ea7d15ea4;hb=c2c113e3922242765c747a8db93833575e5284f8;hp=26f0cf6caf8f3257ea4e9b8b35a8709eecc312e4;hpb=78d87996ccb92d1dc91c9987685f976ed3be08a6;p=vlc diff --git a/include/vlc_subpicture.h b/include/vlc_subpicture.h index 26f0cf6caf..6bfede1710 100644 --- a/include/vlc_subpicture.h +++ b/include/vlc_subpicture.h @@ -1,26 +1,26 @@ /***************************************************************************** * vlc_subpicture.h: subpicture definitions ***************************************************************************** - * Copyright (C) 1999 - 2009 the VideoLAN team + * Copyright (C) 1999 - 2009 VLC authors and VideoLAN * $Id$ * * Authors: Vincent Seguin * Samuel Hocevar * Olivier Aubert * - * 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 + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation; either version 2.1 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. + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser 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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. + * You should have received a copy of the GNU Lesser 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. *****************************************************************************/ #ifndef VLC_SUBPICTURE_H @@ -32,6 +32,7 @@ */ #include +#include /** * \defgroup subpicture Video Subpictures @@ -66,6 +67,7 @@ struct subpicture_region_t 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 */ + bool b_renderbg; /**< render black background under text */ subpicture_region_t *p_next; /**< next region in the list */ subpicture_region_private_t *p_private; /**< Private data for spu_t *only* */ @@ -76,15 +78,16 @@ struct subpicture_region_t #define SUBPICTURE_ALIGN_RIGHT 0x2 #define SUBPICTURE_ALIGN_TOP 0x4 #define SUBPICTURE_ALIGN_BOTTOM 0x8 +#define SUBPICTURE_ALIGN_LEAVETEXT 0x10 /**< Align the subpicture, but not the text inside */ #define SUBPICTURE_ALIGN_MASK ( SUBPICTURE_ALIGN_LEFT|SUBPICTURE_ALIGN_RIGHT| \ - SUBPICTURE_ALIGN_TOP |SUBPICTURE_ALIGN_BOTTOM ) - + SUBPICTURE_ALIGN_TOP |SUBPICTURE_ALIGN_BOTTOM| \ + SUBPICTURE_ALIGN_LEAVETEXT ) /** * This function will create a new subpicture region. * * You must use subpicture_region_Delete to destroy it. */ -VLC_EXPORT( subpicture_region_t *, subpicture_region_New, ( const video_format_t *p_fmt ) ); +VLC_API subpicture_region_t * subpicture_region_New( const video_format_t *p_fmt ); /** * This function will destroy a subpicture region allocated by @@ -92,7 +95,7 @@ VLC_EXPORT( subpicture_region_t *, subpicture_region_New, ( const video_format_t * * You may give it NULL. */ -VLC_EXPORT( void, subpicture_region_Delete, ( subpicture_region_t *p_region ) ); +VLC_API void subpicture_region_Delete( subpicture_region_t *p_region ); /** * This function will destroy a list of subpicture regions allocated by @@ -100,7 +103,27 @@ VLC_EXPORT( void, subpicture_region_Delete, ( subpicture_region_t *p_region ) ); * * Provided for convenience. */ -VLC_EXPORT( void, subpicture_region_ChainDelete, ( subpicture_region_t *p_head ) ); +VLC_API void subpicture_region_ChainDelete( subpicture_region_t *p_head ); + +/** + * + */ +typedef struct subpicture_updater_sys_t subpicture_updater_sys_t; +typedef struct +{ + int (*pf_validate)( subpicture_t *, + bool has_src_changed, const video_format_t *p_fmt_src, + bool has_dst_changed, const video_format_t *p_fmt_dst, + mtime_t); + void (*pf_update) ( subpicture_t *, + const video_format_t *p_fmt_src, + const video_format_t *p_fmt_dst, + mtime_t ); + void (*pf_destroy) ( subpicture_t * ); + subpicture_updater_sys_t *p_sys; +} subpicture_updater_t; + +typedef struct subpicture_private_t subpicture_private_t; /** * Video subtitle @@ -124,6 +147,8 @@ struct subpicture_t subpicture_t * p_next; /**< next subtitle to be displayed */ /**@}*/ + subpicture_region_t *p_region; /**< region list composing this subtitle */ + /** \name Date properties */ /**@{*/ mtime_t i_start; /**< beginning of display date */ @@ -133,48 +158,50 @@ struct subpicture_t bool b_fade; /**< enable fading */ /**@}*/ - subpicture_region_t *p_region; /**< region list composing this subtitle */ - /** \name Display properties * These properties are only indicative and may be * changed by the video output thread, or simply ignored depending of the * subtitle type. */ /**@{*/ - int i_original_picture_width; /**< original width of the movie */ - int i_original_picture_height;/**< original height of the movie */ bool b_subtitle; /**< the picture is a movie subtitle */ bool b_absolute; /**< position is absolute */ + int i_original_picture_width; /**< original width of the movie */ + int i_original_picture_height;/**< original height of the movie */ int i_alpha; /**< transparency */ /**@}*/ - /** Pointer to function that renders this subtitle in a picture */ - void ( *pf_render ) ( vout_thread_t *, picture_t *, const subpicture_t * ); - /** Pointer to function that cleans up the private data of this subtitle */ - void ( *pf_destroy ) ( subpicture_t * ); - - /** Pointer to functions for region management */ - void (*pf_pre_render) ( spu_t *, subpicture_t *, const video_format_t * ); - void (*pf_update_regions)( spu_t *, - subpicture_t *, const video_format_t *, mtime_t ); + subpicture_updater_t updater; - /** Private data - the subtitle plugin might want to put stuff here to - * keep track of the subpicture */ - subpicture_sys_t *p_sys; /* subpicture data */ + subpicture_private_t *p_private; /* Reserved to the core */ }; - /** * This function create a new empty subpicture. * * You must use subpicture_Delete to destroy it. */ -VLC_EXPORT( subpicture_t *, subpicture_New, ( void ) ); +VLC_API subpicture_t * subpicture_New( const subpicture_updater_t * ); /** * This function delete a subpicture created by subpicture_New. * You may give it NULL. */ -VLC_EXPORT( void, subpicture_Delete, ( subpicture_t *p_subpic ) ); +VLC_API void subpicture_Delete( subpicture_t *p_subpic ); + +/** + * This function will create a subpicture having one region in the requested + * chroma showing the given picture. + * + * The picture_t given is not released nor used inside the + * returned subpicture_t. + */ +VLC_API subpicture_t * subpicture_NewFromPicture( vlc_object_t *, picture_t *, vlc_fourcc_t i_chroma ); + +/** + * This function will update the content of a subpicture created with + * a non NULL subpicture_updater_t. + */ +VLC_API void subpicture_Update( subpicture_t *, const video_format_t *src, const video_format_t *, mtime_t ); /**@}*/