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 the VideoLAN team
   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
  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., 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
  38 #define ALPHAMASK_HELP N_( \
  39     "Use an image's alpha channel as a transparency mask." )
  40
  41 #define MASK_TEXT N_("Transparency mask")
  42 #define MASK_LONGTEXT N_( \
  43     "Alpha blending transparency mask. Uses a png alpha channel.")
  44
  45 #define CFG_PREFIX "alphamask-"
  46
  47 /*****************************************************************************
  48  * Local prototypes
  49  *****************************************************************************/
  50 static int  Create      ( vlc_object_t * );
  51 static void Destroy     ( vlc_object_t * );
  52
  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 * );
  57
  58 /*****************************************************************************
  59  * Module descriptor
  60  *****************************************************************************/
  61 vlc_module_begin ()
  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 )
  71
  72     add_string( CFG_PREFIX "mask", NULL, 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 = NULL;
  91
  92     if( p_filter->fmt_in.video.i_chroma != VLC_CODEC_YUVA )
  93     {
  94         msg_Err( p_filter,
  95                  "Unsupported input chroma \"%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     p_sys->p_mask = NULL;
 111 #if 0 /* This appears to be dead code. Where is psz_string initialized? */
 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     free( psz_string );
 120 #endif
 121
 122     vlc_mutex_init( &p_sys->mask_lock );
 123     psz_string =
 124         var_CreateGetStringCommand( p_filter, CFG_PREFIX "mask" );
 125     var_AddCallback( p_filter, CFG_PREFIX "mask", MaskCallback,
 126                      p_filter );
 127     p_filter->pf_video_filter = Filter;
 128
 129     return VLC_SUCCESS;
 130 }
 131
 132 static void Destroy( vlc_object_t *p_this )
 133 {
 134     filter_t *p_filter = (filter_t *)p_this;
 135     filter_sys_t *p_sys = p_filter->p_sys;
 136
 137     var_DelCallback( p_filter, CFG_PREFIX "mask", MaskCallback,
 138                      p_filter );
 139
 140     vlc_mutex_destroy( &p_sys->mask_lock );
 141     if( p_sys->p_mask )
 142         picture_Release( p_sys->p_mask );
 143
 144     free( p_sys );
 145 }
 146
 147 static picture_t *Filter( filter_t *p_filter, picture_t *p_pic )
 148 {
 149     filter_sys_t *p_sys = p_filter->p_sys;
 150
 151     vlc_mutex_lock( &p_sys->mask_lock );
 152     plane_t *p_mask = p_sys->p_mask->p+A_PLANE;
 153     plane_t *p_apic = p_pic->p+A_PLANE;
 154     if(    p_mask->i_visible_pitch
 155         != p_apic->i_visible_pitch
 156         || p_mask->i_visible_lines
 157         != p_apic->i_visible_lines )
 158     {
 159         msg_Err( p_filter,
 160                   "Mask size (%d x %d) and image size (%d x %d) "
 161                   "don't match. The mask will not be applied.",
 162                   p_mask->i_visible_pitch,
 163                   p_mask->i_visible_lines,
 164                   p_apic->i_visible_pitch,
 165                   p_apic->i_visible_lines );
 166     }
 167     else
 168     {
 169         plane_CopyPixels( p_apic, p_mask );
 170     }
 171     vlc_mutex_unlock( &p_sys->mask_lock );
 172     return p_pic;
 173 }
 174
 175 /* copied from video_filters/erase.c . Gruik ? */
 176 static void LoadMask( filter_t *p_filter, const char *psz_filename )
 177 {
 178     image_handler_t *p_image;
 179     video_format_t fmt_in, fmt_out;
 180     memset( &fmt_in, 0, sizeof( video_format_t ) );
 181     memset( &fmt_out, 0, sizeof( video_format_t ) );
 182     fmt_out.i_chroma = VLC_CODEC_YUVA;
 183     if( p_filter->p_sys->p_mask )
 184         picture_Release( p_filter->p_sys->p_mask );
 185     p_image = image_HandlerCreate( p_filter );
 186     p_filter->p_sys->p_mask =
 187         image_ReadUrl( p_image, psz_filename, &fmt_in, &fmt_out );
 188     image_HandlerDelete( p_image );
 189 }
 190
 191 /*****************************************************************************
 192 * Callback to update params on the fly
 193 *****************************************************************************/
 194 static int MaskCallback( vlc_object_t *p_this, char const *psz_var,
 195                          vlc_value_t oldval, vlc_value_t newval,
 196                          void *p_data )
 197 {
 198     VLC_UNUSED(p_this); VLC_UNUSED(oldval);
 199     filter_t *p_filter = (filter_t *)p_data;
 200     filter_sys_t *p_sys = p_filter->p_sys;
 201     int i_ret = VLC_SUCCESS;
 202
 203 #define VAR_IS( a ) !strcmp( psz_var, CFG_PREFIX a )
 204     if( VAR_IS( "mask" ) )
 205     {
 206         vlc_mutex_lock( &p_sys->mask_lock );
 207         if( newval.psz_string && *newval.psz_string )
 208         {
 209             LoadMask( p_filter, newval.psz_string );
 210             if( !p_sys->p_mask )
 211             {
 212                 msg_Err( p_filter, "Error while loading mask (%s).",
 213                          newval.psz_string );
 214                 i_ret = VLC_EGENERIC;
 215             }
 216         }
 217         else if( p_sys->p_mask )
 218         {
 219             picture_Release( p_sys->p_mask );
 220             p_sys->p_mask = NULL;
 221         }
 222         vlc_mutex_unlock( &p_sys->mask_lock );
 223     }
 224 #undef VAR_IS
 225
 226     return i_ret;
 227 }