* ALL: separation of the SPU engine from the VOUT.
[vlc.git] / include / vlc_spu.h
1 /*****************************************************************************
2  * vlc_spu.h : subpicture unit
3  *****************************************************************************
4  * Copyright (C) 1999, 2000 VideoLAN
5  * $Id$
6  *
7  * Authors: Gildas Bazin <gbazin@videolan.org>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24 /**
25  * \defgroup spu Subpicture Unit
26  * This module describes the programming interface for the subpicture unit.
27  * It includes functions allowing to create/destroy an spu, create/destroy
28  * subpictures and render them.
29  * @{
30  */
31
32 /**
33  * Subpicture unit descriptor
34  */
35 struct spu_t
36 {
37     VLC_COMMON_MEMBERS
38
39     vlc_mutex_t  subpicture_lock;                  /**< subpicture heap lock */
40     subpicture_t p_subpicture[VOUT_MAX_PICTURES];           /**< subpictures */
41     int i_channel;             /**< number of subpicture channels registered */
42
43     filter_t *p_blend;                            /**< alpha blending module */
44     filter_t *p_text;                              /**< text renderer module */
45     filter_t *p_scale;                                   /**< scaling module */
46
47     vlc_bool_t b_force_crop;               /**< force cropping of subpicture */
48     int i_crop_x, i_crop_y, i_crop_width, i_crop_height;       /**< cropping */
49
50     int i_margin;                        /**< force position of a subpicture */
51     vlc_bool_t b_force_alpha;         /**< force alpha palette of subpicture */
52     uint8_t pi_alpha[4];                           /**< forced alpha palette */
53
54     int ( *pf_control ) ( spu_t *, int, va_list );
55 };
56
57 static inline int spu_vaControl( spu_t *p_spu, int i_query, va_list args )
58 {
59     if( p_spu->pf_control )
60         return p_spu->pf_control( p_spu, i_query, args );
61     else
62         return VLC_EGENERIC;
63 }
64
65 static inline int spu_Control( spu_t *p_spu, int i_query, ... )
66 {
67     va_list args;
68     int i_result;
69
70     va_start( args, i_query );
71     i_result = spu_vaControl( p_spu, i_query, args );
72     va_end( args );
73     return i_result;
74 }
75
76 enum spu_query_e
77 {
78     SPU_CHANNEL_REGISTER,         /* arg1= int *   res=    */
79     SPU_CHANNEL_CLEAR             /* arg1= int     res=    */
80 };
81
82 /**
83  * \addtogroup subpicture
84  * @{
85  */
86 #define spu_Init(a) __spu_Init(VLC_OBJECT(a))
87 VLC_EXPORT( spu_t *, __spu_Init, ( vlc_object_t * ) );
88 VLC_EXPORT( void, spu_Destroy, ( spu_t * ) );
89 void spu_Attach( spu_t *, vlc_object_t *, vlc_bool_t );
90
91 VLC_EXPORT( subpicture_t *, spu_CreateSubpicture, ( spu_t * ) );
92 VLC_EXPORT( void, spu_DestroySubpicture, ( spu_t *, subpicture_t * ) );
93 VLC_EXPORT( void, spu_DisplaySubpicture, ( spu_t *, subpicture_t * ) );
94
95 #define spu_CreateRegion(a,b) __spu_CreateRegion(VLC_OBJECT(a),b)
96 VLC_EXPORT( subpicture_region_t *,__spu_CreateRegion, ( vlc_object_t *, video_format_t * ) );
97 #define spu_DestroyRegion(a,b) __spu_DestroyRegion(VLC_OBJECT(a),b)
98 VLC_EXPORT( void, __spu_DestroyRegion, ( vlc_object_t *, subpicture_region_t * ) );
99
100 VLC_EXPORT( subpicture_t *, spu_SortSubpictures, ( spu_t *, mtime_t ) );
101 VLC_EXPORT( void, spu_RenderSubpictures, ( spu_t *,  video_format_t *, picture_t *, picture_t *, subpicture_t *, int, int ) );
102
103 /** @}*/
104 /**
105  * @}
106  */