vlc_spu.h 3.04 KB
Newer Older
1 2 3
/*****************************************************************************
 * vlc_spu.h: spu_t definition and functions.
 *****************************************************************************
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
4
 * Copyright (C) 1999-2010 VLC authors and VideoLAN
5 6 7 8 9 10
 * Copyright (C) 2010 Laurent Aimar
 * $Id$
 *
 * Authors: Gildas Bazin <gbazin@videolan.org>
 *          Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
11 12 13
 * 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
14 15 16 17
 * (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
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
18 19
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
20
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
21 22 23
 * 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.
24 25 26 27 28 29 30 31 32 33 34 35
 *****************************************************************************/

#ifndef VLC_SPU_H
#define VLC_SPU_H 1

#include <vlc_subpicture.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
36
 * \defgroup spu Sub-picture channels
37
 * \ingroup video_output
38
 * @{
39
 * \file
40 41 42 43 44 45 46 47 48
 */

typedef struct spu_private_t spu_private_t;

/**
 * Subpicture unit descriptor
 */
struct spu_t
{
49
    struct vlc_common_members obj;
50 51 52 53

    spu_private_t *p;
};

54 55
    VLC_API spu_t * spu_Create( vlc_object_t *, vout_thread_t * );
#define spu_Create(a,b) spu_Create(VLC_OBJECT(a),b)
56
VLC_API void spu_Destroy( spu_t * );
57 58 59 60 61 62 63

/**
 * This function sends a subpicture to the spu_t core.
 * 
 * You cannot use the provided subpicture anymore. The spu_t core
 * will destroy it at its convenience.
 */
64
VLC_API void spu_PutSubpicture( spu_t *, subpicture_t * );
65 66

/**
67 68
 * This function will return an unique subpicture containing the OSD and
 * subtitles visibles at the requested date.
69
 *
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.
73 74
 *
 * The returned value if non NULL must be released by subpicture_Delete().
75
 */
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 );
77

78 79 80
/**
 * It registers a new SPU channel.
 */
81
VLC_API int spu_RegisterChannel( spu_t * );
82 83 84 85

/**
 * It clears all subpictures associated to a SPU channel.
 */
86
VLC_API void spu_ClearChannel( spu_t *, int );
87

88
/**
89
 * It changes the sub sources list
90
 */
91
VLC_API void spu_ChangeSources( spu_t *, const char * );
92

93 94 95
/**
 * It changes the sub filters list
 */
96
VLC_API void spu_ChangeFilters( spu_t *, const char * );
97

98 99 100 101 102 103 104 105
/** @}*/

#ifdef __cplusplus
}
#endif

#endif /* VLC_SPU_H */