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

   1 /*****************************************************************************
   2  * sharpen.c: Sharpen video filter
   3  *****************************************************************************
   4  * Copyright (C) 2003 the VideoLAN team
   5  * $Id: sharpen.c 18062 2006-11-26 14:20:34Z zorglub $
   6  *
   7  * Author: Jérémy DEMEULE <dj_mulder at djduron dot no-ip dot org>
   8  *         Jean-Baptiste Kempf <jb at videolan dot org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /* The sharpen filter. */
  26 /*
  27  * static int filter[] = { -1, -1, -1,
  28  *                         -1,  8, -1,
  29  *                         -1, -1, -1 };
  30  */
  31
  32 /*****************************************************************************
  33  * Preamble
  34  *****************************************************************************/
  35 #include <stdlib.h>                                      /* malloc(), free() */
  36 #include <string.h>
  37
  38 #include <vlc/vlc.h>
  39 #include <vlc_vout.h>
  40
  41 #include "vlc_filter.h"
  42
  43 #define SIG_TEXT N_("Sharpen strength (0-2)")
  44 #define SIG_LONGTEXT N_("Set the Sharpen strength, between 0 and 2. Defaults to 0.05.")
  45
  46 /*****************************************************************************
  47  * Local prototypes
  48  *****************************************************************************/
  49 static int  Create    ( vlc_object_t * );
  50 static void Destroy   ( vlc_object_t * );
  51
  52 static picture_t *Filter( filter_t *, picture_t * );
  53 static int SharpenCallback( vlc_object_t *, char const *,
  54                             vlc_value_t, vlc_value_t, void * );
  55
  56 #define FILTER_PREFIX "sharpen-"
  57
  58 /*****************************************************************************
  59  * Module descriptor
  60  *****************************************************************************/
  61 vlc_module_begin();
  62     set_description( _("Augment contrast between contours.") );
  63     set_shortname( _("Sharpen video filter") );
  64     set_category( CAT_VIDEO );
  65     set_subcategory( SUBCAT_VIDEO_VFILTER );
  66     set_capability( "video filter2", 0 );
  67     add_float_with_range( "sharpen-sigma", 0.05, 0.0, 2.0, NULL,
  68         SIG_TEXT, SIG_LONGTEXT, VLC_FALSE );
  69     add_shortcut( "sharpen" );
  70     set_callbacks( Create, Destroy );
  71 vlc_module_end();
  72
  73 static const char *ppsz_filter_options[] = {
  74     "sigma", NULL
  75 };
  76
  77 /*****************************************************************************
  78  * filter_sys_t: Sharpen video filter descriptor
  79  *****************************************************************************
  80  * This structure is part of the video output thread descriptor.
  81  * It describes the Sharpen specific properties of an output thread.
  82  *****************************************************************************/
  83
  84 struct filter_sys_t
  85 {
  86     float f_sigma;
  87 };
  88
  89 /*****************************************************************************
  90  * clip: avoid negative value and value > 255
  91  *****************************************************************************/
  92 inline static int32_t clip( int32_t a )
  93 {
  94     return (a > 255) ? 255 : (a < 0) ? 0 : a;
  95 }
  96
  97 /*****************************************************************************
  98  * Create: allocates Sharpen video thread output method
  99  *****************************************************************************
 100  * This function allocates and initializes a Sharpen vout method.
 101  *****************************************************************************/
 102 static int Create( vlc_object_t *p_this )
 103 {
 104     filter_t *p_filter = (filter_t *)p_this;
 105
 106     /* Allocate structure */
 107     p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
 108     if( p_filter->p_sys == NULL )
 109     {
 110         msg_Err( p_filter, "out of memory" );
 111         return VLC_ENOMEM;
 112     }
 113
 114     p_filter->pf_video_filter = Filter;
 115
 116     config_ChainParse( p_filter, FILTER_PREFIX, ppsz_filter_options,
 117                    p_filter->p_cfg );
 118
 119     p_filter->p_sys->f_sigma =
 120         var_CreateGetFloatCommand( p_filter, FILTER_PREFIX "sigma" );
 121     var_AddCallback( p_filter, FILTER_PREFIX "sigma",
 122                      SharpenCallback, p_filter->p_sys );
 123
 124     return VLC_SUCCESS;
 125 }
 126
 127
 128 /*****************************************************************************
 129  * Destroy: destroy Sharpen video thread output method
 130  *****************************************************************************
 131  * Terminate an output method created by SharpenCreateOutputMethod
 132  *****************************************************************************/
 133 static void Destroy( vlc_object_t *p_this )
 134 {
 135     filter_t *p_filter = (filter_t *)p_this;
 136     free( p_filter->p_sys );
 137 }
 138
 139 /*****************************************************************************
 140  * Render: displays previously rendered output
 141  *****************************************************************************
 142  * This function send the currently rendered image to Invert image, waits
 143  * until it is displayed and switch the two rendering buffers, preparing next
 144  * frame.
 145  *****************************************************************************/
 146 static picture_t *Filter( filter_t *p_filter, picture_t *p_pic )
 147 {
 148     picture_t *p_outpic;
 149     int i, j;
 150     uint8_t *p_src = NULL;
 151     uint8_t *p_out = NULL;
 152     int i_src_pitch;
 153     int pix;
 154     const int v1 = -1;
 155     const int v2 = 3; /* 2^3 = 8 */
 156
 157     if( !p_pic ) return NULL;
 158     if( !p_filter ) return NULL;
 159     if( !p_filter->p_sys ) return NULL;
 160
 161     p_outpic = p_filter->pf_vout_buffer_new( p_filter );
 162     if( !p_outpic )
 163     {
 164         msg_Warn( p_filter, "can't get output picture" );
 165         if( p_pic->pf_release )
 166             p_pic->pf_release( p_pic );
 167         return NULL;
 168     }
 169
 170     /* process the Y plane */
 171     p_src = p_pic->p[Y_PLANE].p_pixels;
 172     p_out = p_outpic->p[Y_PLANE].p_pixels;
 173     if( !p_src || !p_out )
 174     {
 175         msg_Warn( p_filter, "can't get Y plane" );
 176         if( p_pic->pf_release )
 177             p_pic->pf_release( p_pic );
 178         return NULL;
 179     }
 180
 181     i_src_pitch = p_pic->p[Y_PLANE].i_visible_pitch;
 182
 183     /* perform convolution only on Y plane. Avoid border line. */
 184     for( i = 0; i < p_pic->p[Y_PLANE].i_visible_lines; i++ )
 185     {
 186         if( (i == 0) || (i == p_pic->p[Y_PLANE].i_visible_lines - 1) )
 187         {
 188             for( j = 0; j < p_pic->p[Y_PLANE].i_visible_pitch; j++ )
 189                 p_out[i * i_src_pitch + j] = clip( p_src[i * i_src_pitch + j] );
 190             continue ;
 191         }
 192         for( j = 0; j < p_pic->p[Y_PLANE].i_visible_pitch; j++ )
 193         {
 194             if( (j == 0) || (j == p_pic->p[Y_PLANE].i_visible_pitch - 1) )
 195             {
 196                 p_out[i * i_src_pitch + j] = p_src[i * i_src_pitch + j];
 197                 continue ;
 198             }
 199
 200             pix = (p_src[(i - 1) * i_src_pitch + j - 1] * v1) +
 201                   (p_src[(i - 1) * i_src_pitch + j    ] * v1) +
 202                   (p_src[(i - 1) * i_src_pitch + j + 1] * v1) +
 203                   (p_src[(i    ) * i_src_pitch + j - 1] * v1) +
 204                   (p_src[(i    ) * i_src_pitch + j    ] << v2) +
 205                   (p_src[(i    ) * i_src_pitch + j + 1] * v1) +
 206                   (p_src[(i + 1) * i_src_pitch + j - 1] * v1) +
 207                   (p_src[(i + 1) * i_src_pitch + j    ] * v1) +
 208                   (p_src[(i + 1) * i_src_pitch + j + 1] * v1);
 209
 210             p_out[i * i_src_pitch + j] =  clip( p_src[i * i_src_pitch + j] +
 211                         (p_filter->p_sys->f_sigma * pix) );
 212         }
 213     }
 214
 215
 216     p_filter->p_libvlc->pf_memcpy( p_outpic->p[U_PLANE].p_pixels,
 217             p_pic->p[U_PLANE].p_pixels,
 218             p_outpic->p[U_PLANE].i_lines * p_outpic->p[U_PLANE].i_pitch );
 219
 220     p_filter->p_libvlc->pf_memcpy( p_outpic->p[V_PLANE].p_pixels,
 221             p_pic->p[V_PLANE].p_pixels,
 222             p_outpic->p[V_PLANE].i_lines * p_outpic->p[V_PLANE].i_pitch );
 223
 224
 225     p_outpic->date = p_pic->date;
 226     p_outpic->b_force = p_pic->b_force;
 227     p_outpic->i_nb_fields = p_pic->i_nb_fields;
 228     p_outpic->b_progressive = p_pic->b_progressive;
 229     p_outpic->b_top_field_first = p_pic->b_top_field_first;
 230
 231     if( p_pic->pf_release )
 232         p_pic->pf_release( p_pic );
 233
 234     return p_outpic;
 235 }
 236
 237 static int SharpenCallback( vlc_object_t *p_this, char const *psz_var,
 238                             vlc_value_t oldval, vlc_value_t newval,
 239                             void *p_data )
 240 {
 241     filter_sys_t *p_sys = (filter_sys_t *)p_data;
 242     if( !strcmp( psz_var, FILTER_PREFIX "sigma" ) )
 243         p_sys->f_sigma = __MIN( 2., __MAX( 0., newval.f_float ) );
 244     return VLC_SUCCESS;
 245 }