1 /*****************************************************************************
2 * vlc_spu.h: spu_t definition and functions.
3 *****************************************************************************
4 * Copyright (C) 1999-2010 VLC authors and VideoLAN
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 it
12 * under the terms of the GNU Lesser General Public License as published by
13 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
21 * You should have received a copy of the GNU Lesser General Public License
22 * along with this program; if not, write to the Free Software Foundation,
23 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
29 #include <vlc_subpicture.h>
36 * \defgroup spu Sub-picture channels
37 * \ingroup video_output
42 typedef struct spu_private_t spu_private_t
;
45 * Subpicture unit descriptor
54 VLC_API spu_t
* spu_Create( vlc_object_t
* );
55 #define spu_Create(a) spu_Create(VLC_OBJECT(a))
56 VLC_API
void spu_Destroy( spu_t
* );
59 * This function sends a subpicture to the spu_t core.
61 * You cannot use the provided subpicture anymore. The spu_t core
62 * will destroy it at its convenience.
64 VLC_API
void spu_PutSubpicture( spu_t
*, subpicture_t
* );
67 * This function will return an unique subpicture containing the OSD and
68 * subtitles visibles at the requested date.
70 * \param p_chroma_list is a list of supported chroma for the output (can be NULL)
71 * \param p_fmt_dst is the format of the picture on which the return subpicture will be rendered.
72 * \param p_fmt_src is the format of the original(source) video.
74 * The returned value if non NULL must be released by subpicture_Delete().
76 VLC_API subpicture_t
* spu_Render( spu_t
*, const vlc_fourcc_t
*p_chroma_list
, const video_format_t
*p_fmt_dst
, const video_format_t
*p_fmt_src
, mtime_t render_subtitle_date
, mtime_t render_osd_date
, bool ignore_osd
);
79 * It registers a new SPU channel.
81 VLC_API
int spu_RegisterChannel( spu_t
* );
84 * It clears all subpictures associated to a SPU channel.
86 VLC_API
void spu_ClearChannel( spu_t
*, int );
89 * It changes the sub sources list
91 VLC_API
void spu_ChangeSources( spu_t
*, const char * );
94 * It changes the sub filters list
96 VLC_API
void spu_ChangeFilters( spu_t
*, const char * );
104 #endif /* VLC_SPU_H */