1 /*****************************************************************************
2 * alphamask.c : Alpha layer mask video filter for vlc
3 *****************************************************************************
4 * Copyright (C) 2007 the VideoLAN team
7 * Authors: Antoine Cellerier <dionoea at videolan tod org>
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.
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.
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
35 #include <vlc_image.h>
36 #include <vlc_filter.h>
38 #define ALPHAMASK_HELP N_( \
39 "Use an image's alpha channel as a transparency mask." )
41 #define MASK_TEXT N_("Transparency mask")
42 #define MASK_LONGTEXT N_( \
43 "Alpha blending transparency mask. Uses a png alpha channel.")
45 #define CFG_PREFIX "alphamask-"
47 /*****************************************************************************
49 *****************************************************************************/
50 static int Create ( vlc_object_t * );
51 static void Destroy ( vlc_object_t * );
53 static picture_t *Filter( filter_t *, picture_t * );
54 static void LoadMask( filter_t *, const char * );
55 static int MaskCallback( vlc_object_t *, char const *,
56 vlc_value_t, vlc_value_t, void * );
58 /*****************************************************************************
60 *****************************************************************************/
62 set_description( N_("Alpha mask video filter") )
63 set_shortname( N_("Alpha mask" ))
64 set_help( ALPHAMASK_HELP )
65 set_category( CAT_VIDEO )
66 set_subcategory( SUBCAT_VIDEO_VFILTER )
67 set_capability( "video filter2", 0 )
68 add_shortcut( "alphamask" )
69 add_shortcut( "mask" )
70 set_callbacks( Create, Destroy )
72 add_string( CFG_PREFIX "mask", NULL, NULL, MASK_TEXT,
73 MASK_LONGTEXT, false )
76 static const char *const ppsz_filter_options[] = {
83 vlc_mutex_t mask_lock;
86 static int Create( vlc_object_t *p_this )
88 filter_t *p_filter = (filter_t *)p_this;
92 if( p_filter->fmt_in.video.i_chroma != VLC_CODEC_YUVA )
95 "Unsupported input chroma \"%4.4s\". "
96 "Alphamask can only use \"YUVA\".",
97 (char*)&p_filter->fmt_in.video.i_chroma );
101 /* Allocate structure */
102 p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
103 if( p_filter->p_sys == NULL )
105 p_sys = p_filter->p_sys;
107 config_ChainParse( p_filter, CFG_PREFIX, ppsz_filter_options,
111 var_CreateGetStringCommand( p_filter, CFG_PREFIX "mask" );
112 if( psz_string && *psz_string )
114 LoadMask( p_filter, psz_string );
116 msg_Err( p_filter, "Error while loading mask (%s).",
120 p_sys->p_mask = NULL;
123 vlc_mutex_init( &p_sys->mask_lock );
124 var_AddCallback( p_filter, CFG_PREFIX "mask", MaskCallback,
126 p_filter->pf_video_filter = Filter;
131 static void Destroy( vlc_object_t *p_this )
133 filter_t *p_filter = (filter_t *)p_this;
134 filter_sys_t *p_sys = p_filter->p_sys;
136 var_DelCallback( p_filter, CFG_PREFIX "mask", MaskCallback,
139 vlc_mutex_destroy( &p_sys->mask_lock );
141 picture_Release( p_sys->p_mask );
146 static picture_t *Filter( filter_t *p_filter, picture_t *p_pic )
148 filter_sys_t *p_sys = p_filter->p_sys;
150 vlc_mutex_lock( &p_sys->mask_lock );
151 plane_t *p_mask = p_sys->p_mask->p+A_PLANE;
152 plane_t *p_apic = p_pic->p+A_PLANE;
153 if( p_mask->i_visible_pitch
154 != p_apic->i_visible_pitch
155 || p_mask->i_visible_lines
156 != p_apic->i_visible_lines )
159 "Mask size (%d x %d) and image size (%d x %d) "
160 "don't match. The mask will not be applied.",
161 p_mask->i_visible_pitch,
162 p_mask->i_visible_lines,
163 p_apic->i_visible_pitch,
164 p_apic->i_visible_lines );
168 plane_CopyPixels( p_apic, p_mask );
170 vlc_mutex_unlock( &p_sys->mask_lock );
174 /* copied from video_filters/erase.c . Gruik ? */
175 static void LoadMask( filter_t *p_filter, const char *psz_filename )
177 image_handler_t *p_image;
178 video_format_t fmt_in, fmt_out;
179 memset( &fmt_in, 0, sizeof( video_format_t ) );
180 memset( &fmt_out, 0, sizeof( video_format_t ) );
181 fmt_out.i_chroma = VLC_CODEC_YUVA;
182 if( p_filter->p_sys->p_mask )
183 picture_Release( p_filter->p_sys->p_mask );
184 p_image = image_HandlerCreate( p_filter );
185 p_filter->p_sys->p_mask =
186 image_ReadUrl( p_image, psz_filename, &fmt_in, &fmt_out );
187 image_HandlerDelete( p_image );
190 /*****************************************************************************
191 * Callback to update params on the fly
192 *****************************************************************************/
193 static int MaskCallback( vlc_object_t *p_this, char const *psz_var,
194 vlc_value_t oldval, vlc_value_t newval,
197 VLC_UNUSED(p_this); VLC_UNUSED(oldval);
198 filter_t *p_filter = (filter_t *)p_data;
199 filter_sys_t *p_sys = p_filter->p_sys;
200 int i_ret = VLC_SUCCESS;
202 #define VAR_IS( a ) !strcmp( psz_var, CFG_PREFIX a )
203 if( VAR_IS( "mask" ) )
205 vlc_mutex_lock( &p_sys->mask_lock );
206 if( newval.psz_string && *newval.psz_string )
208 LoadMask( p_filter, newval.psz_string );
211 msg_Err( p_filter, "Error while loading mask (%s).",
213 i_ret = VLC_EGENERIC;
216 else if( p_sys->p_mask )
218 picture_Release( p_sys->p_mask );
219 p_sys->p_mask = NULL;
221 vlc_mutex_unlock( &p_sys->mask_lock );