1 /*****************************************************************************
2 * vlc_spu.h: spu_t definition and functions.
3 *****************************************************************************
4 * Copyright (C) 1999-2010 the VideoLAN team
5 * Copyright (C) 2010 Laurent Aimar
8 * Authors: Gildas Bazin <gbazin@videolan.org>
9 * Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
29 #include <vlc_subpicture.h>
35 /**********************************************************************
37 **********************************************************************/
39 * \defgroup spu Subpicture Unit
40 * This module describes the programming interface for the subpicture unit.
41 * It includes functions allowing to create/destroy an spu, and render
46 typedef struct spu_private_t spu_private_t
;
48 /* Default subpicture channel ID */
49 #define SPU_DEFAULT_CHANNEL (1)
52 * Subpicture unit descriptor
61 VLC_EXPORT( spu_t
*, spu_Create
, ( vlc_object_t
* ) );
62 #define spu_Create(a) spu_Create(VLC_OBJECT(a))
63 VLC_EXPORT( int, spu_Init
, ( spu_t
* ) );
64 VLC_EXPORT( void, spu_Destroy
, ( spu_t
* ) );
65 void spu_Attach( spu_t
*, vlc_object_t
*, bool );
68 * This function sends a subpicture to the spu_t core.
70 * You cannot use the provided subpicture anymore. The spu_t core
71 * will destroy it at its convenience.
73 VLC_EXPORT( void, spu_DisplaySubpicture
, ( spu_t
*, subpicture_t
* ) );
76 * This function asks the spu_t core a list of subpictures to display.
78 * The returned list can only be used by spu_RenderSubpictures.
80 VLC_EXPORT( subpicture_t
*, spu_SortSubpictures
, ( spu_t
*, mtime_t render_subtitle_date
, bool b_subtitle_only
) );
83 * This function renders a list of subpicture_t on the provided picture.
85 * \param p_fmt_dst is the format of the destination picture.
86 * \param p_fmt_src is the format of the original(source) video.
88 VLC_EXPORT( void, spu_RenderSubpictures
, ( spu_t
*, picture_t
*, const video_format_t
*p_fmt_dst
, subpicture_t
*p_list
, const video_format_t
*p_fmt_src
, mtime_t render_subtitle_date
) );
91 * It registers a new SPU channel.
93 VLC_EXPORT( int, spu_RegisterChannel
, ( spu_t
* ) );
96 * It clears all subpictures associated to a SPU channel.
98 VLC_EXPORT( void, spu_ClearChannel
, ( spu_t
*, int ) );
106 #endif /* VLC_SPU_H */