git.sesse.net Git - vlc/blob - modules/video_filter/alphamask.c

   1 /*****************************************************************************
   2  * alphamask.c : Alpha layer mask video filter for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2007 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Antoine Cellerier <dionoea at videolan tod org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <vlc_common.h>
  33 #include <vlc_plugin.h>
  34
  35 #include <vlc_image.h>
  36 #include <vlc_filter.h>
  37 #include <vlc_url.h>
  38
  39 #define ALPHAMASK_HELP N_( \
  40     "Use an image's alpha channel as a transparency mask." )
  41
  42 #define MASK_TEXT N_("Transparency mask")
  43 #define MASK_LONGTEXT N_( \
  44     "Alpha blending transparency mask. Uses a png alpha channel.")
  45
  46 #define CFG_PREFIX "alphamask-"
  47
  48 /*****************************************************************************
  49  * Local prototypes
  50  *****************************************************************************/
  51 static int  Create      ( vlc_object_t * );
  52 static void Destroy     ( vlc_object_t * );
  53
  54 static picture_t *Filter( filter_t *, picture_t * );
  55 static void LoadMask( filter_t *, const char * );
  56 static int MaskCallback( vlc_object_t *, char const *,
  57                          vlc_value_t, vlc_value_t, void * );
  58
  59 /*****************************************************************************
  60  * Module descriptor
  61  *****************************************************************************/
  62 vlc_module_begin ()
  63     set_description( N_("Alpha mask video filter") )
  64     set_shortname( N_("Alpha mask" ))
  65     set_help( ALPHAMASK_HELP )
  66     set_category( CAT_VIDEO )
  67     set_subcategory( SUBCAT_VIDEO_VFILTER )
  68     set_capability( "video filter2", 0 )
  69     add_shortcut( "alphamask", "mask" )
  70     set_callbacks( Create, Destroy )
  71
  72     add_loadfile( CFG_PREFIX "mask", NULL, MASK_TEXT,
  73                 MASK_LONGTEXT, false )
  74 vlc_module_end ()
  75
  76 static const char *const ppsz_filter_options[] = {
  77     "mask", NULL
  78 };
  79
  80 struct filter_sys_t
  81 {
  82     picture_t *p_mask;
  83     vlc_mutex_t mask_lock;
  84 };
  85
  86 static int Create( vlc_object_t *p_this )
  87 {
  88     filter_t *p_filter = (filter_t *)p_this;
  89     filter_sys_t *p_sys;
  90     char *psz_string;
  91
  92     if( p_filter->fmt_in.video.i_chroma != VLC_CODEC_YUVA )
  93     {
  94         msg_Err( p_filter,
  95                  "Unsupported input chroma \"%4.4s\". "
  96                  "Alphamask can only use \"YUVA\".",
  97                  (char*)&p_filter->fmt_in.video.i_chroma );
  98         return VLC_EGENERIC;
  99     }
 100
 101     /* Allocate structure */
 102     p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
 103     if( p_filter->p_sys == NULL )
 104         return VLC_ENOMEM;
 105     p_sys = p_filter->p_sys;
 106
 107     config_ChainParse( p_filter, CFG_PREFIX, ppsz_filter_options,
 108                        p_filter->p_cfg );
 109
 110     psz_string =
 111         var_CreateGetStringCommand( p_filter, CFG_PREFIX "mask" );
 112     if( psz_string && *psz_string )
 113     {
 114         LoadMask( p_filter, psz_string );
 115         if( !p_sys->p_mask )
 116             msg_Err( p_filter, "Error while loading mask (%s).",
 117                      psz_string );
 118     }
 119     else
 120        p_sys->p_mask = NULL;
 121     free( psz_string );
 122
 123     vlc_mutex_init( &p_sys->mask_lock );
 124     var_AddCallback( p_filter, CFG_PREFIX "mask", MaskCallback,
 125                      p_filter );
 126     p_filter->pf_video_filter = Filter;
 127
 128     return VLC_SUCCESS;
 129 }
 130
 131 static void Destroy( vlc_object_t *p_this )
 132 {
 133     filter_t *p_filter = (filter_t *)p_this;
 134     filter_sys_t *p_sys = p_filter->p_sys;
 135
 136     var_DelCallback( p_filter, CFG_PREFIX "mask", MaskCallback,
 137                      p_filter );
 138
 139     vlc_mutex_destroy( &p_sys->mask_lock );
 140     if( p_sys->p_mask )
 141         picture_Release( p_sys->p_mask );
 142
 143     free( p_sys );
 144 }
 145
 146 static picture_t *Filter( filter_t *p_filter, picture_t *p_pic )
 147 {
 148     filter_sys_t *p_sys = p_filter->p_sys;
 149
 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 )
 157     {
 158         msg_Err( p_filter,
 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 );
 165     }
 166     else
 167     {
 168         plane_CopyPixels( p_apic, p_mask );
 169     }
 170     vlc_mutex_unlock( &p_sys->mask_lock );
 171     return p_pic;
 172 }
 173
 174 /* copied from video_filters/erase.c . Gruik ? */
 175 static void LoadMask( filter_t *p_filter, const char *psz_filename )
 176 {
 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     char *psz_url = vlc_path2uri( psz_filename, NULL );
 186     p_filter->p_sys->p_mask =
 187         image_ReadUrl( p_image, psz_url, &fmt_in, &fmt_out );
 188     free( psz_url );
 189     image_HandlerDelete( p_image );
 190 }
 191
 192 /*****************************************************************************
 193 * Callback to update params on the fly
 194 *****************************************************************************/
 195 static int MaskCallback( vlc_object_t *p_this, char const *psz_var,
 196                          vlc_value_t oldval, vlc_value_t newval,
 197                          void *p_data )
 198 {
 199     VLC_UNUSED(p_this); VLC_UNUSED(oldval);
 200     filter_t *p_filter = (filter_t *)p_data;
 201     filter_sys_t *p_sys = p_filter->p_sys;
 202     int i_ret = VLC_SUCCESS;
 203
 204 #define VAR_IS( a ) !strcmp( psz_var, CFG_PREFIX a )
 205     if( VAR_IS( "mask" ) )
 206     {
 207         vlc_mutex_lock( &p_sys->mask_lock );
 208         if( newval.psz_string && *newval.psz_string )
 209         {
 210             LoadMask( p_filter, newval.psz_string );
 211             if( !p_sys->p_mask )
 212             {
 213                 msg_Err( p_filter, "Error while loading mask (%s).",
 214                          newval.psz_string );
 215                 i_ret = VLC_EGENERIC;
 216             }
 217         }
 218         else if( p_sys->p_mask )
 219         {
 220             picture_Release( p_sys->p_mask );
 221             p_sys->p_mask = NULL;
 222         }
 223         vlc_mutex_unlock( &p_sys->mask_lock );
 224     }
 225 #undef VAR_IS
 226
 227     return i_ret;
 228 }