modules/video_filter/postproc.c

   1 /*****************************************************************************
   2  * postproc.c: video postprocessing using libpostproc
   3  *****************************************************************************
   4  * Copyright (C) 1999-2009 VLC authors and VideoLAN
   5  *
   6  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   7  *          Gildas Bazin <gbazin@netcourrier.com>
   8  *          Antoine Cellerier <dionoea at videolan dot org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify it
  11  * under the terms of the GNU Lesser General Public License as published by
  12  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this program; if not, write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * NOTA BENE: this module requires the linking against a library which is
  27  * known to require licensing under the GNU General Public License version 2
  28  * (or later). Therefore, the result of compiling this module will normally
  29  * be subject to the terms of that later license.
  30  *****************************************************************************/
  31
  32
  33 #ifdef HAVE_CONFIG_H
  34 # include "config.h"
  35 #endif
  36
  37 #include <vlc_common.h>
  38 #include <vlc_plugin.h>
  39 #include <vlc_filter.h>
  40 #include <vlc_picture.h>
  41 #include <vlc_cpu.h>
  42
  43 #include "filter_picture.h"
  44
  45 #ifdef HAVE_POSTPROC_POSTPROCESS_H
  46 #   include <postproc/postprocess.h>
  47 #else
  48 #   include <libpostproc/postprocess.h>
  49 #endif
  50
  51 #ifndef PP_CPU_CAPS_ALTIVEC
  52 #   define PP_CPU_CAPS_ALTIVEC 0
  53 #endif
  54
  55 /*****************************************************************************
  56  * Local prototypes
  57  *****************************************************************************/
  58 static int OpenPostproc( vlc_object_t * );
  59 static void ClosePostproc( vlc_object_t * );
  60
  61 static picture_t *PostprocPict( filter_t *, picture_t * );
  62
  63 static int PPQCallback( vlc_object_t *, char const *,
  64                         vlc_value_t, vlc_value_t, void * );
  65 static int PPNameCallback( vlc_object_t *, char const *,
  66                            vlc_value_t, vlc_value_t, void * );
  67
  68 #define Q_TEXT N_("Post processing quality")
  69 #define Q_LONGTEXT N_( \
  70     "Quality of post processing. Valid range is 0 (disabled) to 6 (highest)\n"     \
  71     "Higher levels require more CPU power, but produce higher quality pictures.\n" \
  72     "With default filter chain, the values map to the following filters:\n"        \
  73     "1: hb, 2-4: hb+vb, 5-6: hb+vb+dr" )
  74
  75 #define NAME_TEXT N_("FFmpeg post processing filter chains")
  76 #define NAME_LONGTEXT NAME_TEXT
  77
  78 #define FILTER_PREFIX "postproc-"
  79
  80 /*****************************************************************************
  81  * Module descriptor
  82  *****************************************************************************/
  83 vlc_module_begin ()
  84     set_description( N_("Video post processing filter") )
  85     set_shortname( N_("Postproc" ) )
  86     add_shortcut( "postprocess", "pp" ) /* name is "postproc" */
  87     set_category( CAT_VIDEO )
  88     set_subcategory( SUBCAT_VIDEO_VFILTER )
  89
  90     set_capability( "video filter", 0 )
  91
  92     set_callbacks( OpenPostproc, ClosePostproc )
  93
  94     add_integer_with_range( FILTER_PREFIX "q", PP_QUALITY_MAX, 0,
  95                             PP_QUALITY_MAX, Q_TEXT, Q_LONGTEXT, false )
  96         change_safe()
  97     add_string( FILTER_PREFIX "name", "default", NAME_TEXT,
  98                 NAME_LONGTEXT, true )
  99 vlc_module_end ()
 100
 101 static const char *const ppsz_filter_options[] = {
 102     "q", "name", NULL
 103 };
 104
 105 /*****************************************************************************
 106  * filter_sys_t : libpostproc video postprocessing descriptor
 107  *****************************************************************************/
 108 typedef struct
 109 {
 110     /* Never changes after init */
 111     pp_context *pp_context;
 112
 113     /* Set to NULL if post processing is disabled */
 114     pp_mode *pp_mode;
 115
 116     /* Lock when using or changing pp_mode */
 117     vlc_mutex_t lock;
 118 } filter_sys_t;
 119
 120
 121 /*****************************************************************************
 122  * OpenPostproc: probe and open the postproc
 123  *****************************************************************************/
 124 static int OpenPostproc( vlc_object_t *p_this )
 125 {
 126     filter_t *p_filter = (filter_t *)p_this;
 127     filter_sys_t *p_sys;
 128     vlc_value_t val, val_orig;
 129     const char *desc;
 130     int i_flags = 0;
 131
 132     if( p_filter->fmt_in.video.i_chroma != p_filter->fmt_out.video.i_chroma ||
 133         p_filter->fmt_in.video.i_height != p_filter->fmt_out.video.i_height ||
 134         p_filter->fmt_in.video.i_width != p_filter->fmt_out.video.i_width )
 135     {
 136         msg_Err( p_filter, "Filter input and output formats must be identical" );
 137         return VLC_EGENERIC;
 138     }
 139
 140     /* Set CPU capabilities */
 141 #if defined(__i386__) || defined(__x86_64__)
 142     if( vlc_CPU_MMX() )
 143         i_flags |= PP_CPU_CAPS_MMX;
 144     if( vlc_CPU_MMXEXT() )
 145         i_flags |= PP_CPU_CAPS_MMX2;
 146     if( vlc_CPU_3dNOW() )
 147         i_flags |= PP_CPU_CAPS_3DNOW;
 148 #elif defined(__ppc__) || defined(__ppc64__) || defined(__powerpc__)
 149     if( vlc_CPU_ALTIVEC() )
 150         i_flags |= PP_CPU_CAPS_ALTIVEC;
 151 #endif
 152
 153     switch( p_filter->fmt_in.video.i_chroma )
 154     {
 155         case VLC_CODEC_I444:
 156         case VLC_CODEC_J444:
 157         /* case VLC_CODEC_YUVA:
 158            FIXME: Should work but alpha plane needs to be copied manually and
 159                   I'm kind of feeling too lazy to write the code to do that ATM
 160                   (i_pitch vs i_visible_pitch...). */
 161             i_flags |= PP_FORMAT_444;
 162             break;
 163         case VLC_CODEC_I422:
 164         case VLC_CODEC_J422:
 165             i_flags |= PP_FORMAT_422;
 166             break;
 167         case VLC_CODEC_I411:
 168             i_flags |= PP_FORMAT_411;
 169             break;
 170         case VLC_CODEC_I420:
 171         case VLC_CODEC_J420:
 172         case VLC_CODEC_YV12:
 173             i_flags |= PP_FORMAT_420;
 174             break;
 175         default:
 176             msg_Err( p_filter, "Unsupported input chroma (%4.4s)",
 177                       (char*)&p_filter->fmt_in.video.i_chroma );
 178             return VLC_EGENERIC;
 179     }
 180
 181     p_sys = malloc( sizeof( filter_sys_t ) );
 182     if( !p_sys ) return VLC_ENOMEM;
 183     p_filter->p_sys = p_sys;
 184
 185     p_sys->pp_context = pp_get_context( p_filter->fmt_in.video.i_width,
 186                                         p_filter->fmt_in.video.i_height,
 187                                         i_flags );
 188     if( !p_sys->pp_context )
 189     {
 190         msg_Err( p_filter, "Error while creating post processing context." );
 191         free( p_sys );
 192         return VLC_EGENERIC;
 193     }
 194
 195     config_ChainParse( p_filter, FILTER_PREFIX, ppsz_filter_options,
 196                        p_filter->p_cfg );
 197
 198     var_Create( p_filter, FILTER_PREFIX "q", VLC_VAR_INTEGER |
 199                 VLC_VAR_DOINHERIT | VLC_VAR_ISCOMMAND );
 200     var_Change( p_filter, FILTER_PREFIX "q", VLC_VAR_SETTEXT,
 201                 _("Post processing") );
 202
 203     var_Get( p_filter, FILTER_PREFIX "q", &val_orig );
 204     var_Change( p_filter, FILTER_PREFIX "q", VLC_VAR_DELCHOICE, val_orig );
 205
 206     val.psz_string = var_GetNonEmptyString( p_filter, FILTER_PREFIX "name" );
 207     if( val_orig.i_int )
 208     {
 209         p_sys->pp_mode = pp_get_mode_by_name_and_quality( val.psz_string ?
 210                                                           val.psz_string :
 211                                                           "default",
 212                                                           val_orig.i_int );
 213
 214         if( !p_sys->pp_mode )
 215         {
 216             msg_Err( p_filter, "Error while creating post processing mode." );
 217             free( val.psz_string );
 218             pp_free_context( p_sys->pp_context );
 219             free( p_sys );
 220             return VLC_EGENERIC;
 221         }
 222     }
 223     else
 224     {
 225         p_sys->pp_mode = NULL;
 226     }
 227     free( val.psz_string );
 228
 229     for( val.i_int = 0; val.i_int <= PP_QUALITY_MAX; val.i_int++ )
 230     {
 231         switch( val.i_int )
 232         {
 233             case 0:
 234                 desc = _("Disable");
 235                 break;
 236             case 1:
 237                 desc = _("Lowest");
 238                 break;
 239             case PP_QUALITY_MAX:
 240                 desc = _("Highest");
 241                 break;
 242             default:
 243                 desc = NULL;
 244                 break;
 245         }
 246         var_Change( p_filter, FILTER_PREFIX "q", VLC_VAR_ADDCHOICE, val, desc );
 247     }
 248
 249     vlc_mutex_init( &p_sys->lock );
 250
 251     /* Add the callback at the end to prevent crashes */
 252     var_AddCallback( p_filter, FILTER_PREFIX "q", PPQCallback, NULL );
 253     var_AddCallback( p_filter, FILTER_PREFIX "name", PPNameCallback, NULL );
 254
 255     p_filter->pf_video_filter = PostprocPict;
 256
 257     msg_Warn( p_filter, "Quantification table was not set by video decoder. "
 258                         "Postprocessing won't look good." );
 259     return VLC_SUCCESS;
 260 }
 261
 262 /*****************************************************************************
 263  * ClosePostproc
 264  *****************************************************************************/
 265 static void ClosePostproc( vlc_object_t *p_this )
 266 {
 267     filter_t *p_filter = (filter_t *)p_this;
 268     filter_sys_t *p_sys = p_filter->p_sys;
 269
 270     /* delete the callback before destroying the mutex */
 271     var_DelCallback( p_filter, FILTER_PREFIX "q", PPQCallback, NULL );
 272     var_DelCallback( p_filter, FILTER_PREFIX "name", PPNameCallback, NULL );
 273
 274     /* Destroy the resources */
 275     pp_free_context( p_sys->pp_context );
 276     pp_free_mode( p_sys->pp_mode );
 277     free( p_sys );
 278 }
 279
 280 /*****************************************************************************
 281  * PostprocPict
 282  *****************************************************************************/
 283 static picture_t *PostprocPict( filter_t *p_filter, picture_t *p_pic )
 284 {
 285     filter_sys_t *p_sys = p_filter->p_sys;
 286
 287     picture_t *p_outpic = filter_NewPicture( p_filter );
 288     if( !p_outpic )
 289     {
 290         picture_Release( p_pic );
 291         return NULL;
 292     }
 293
 294     /* Lock to prevent issues if pp_mode is changed */
 295     vlc_mutex_lock( &p_sys->lock );
 296     if( p_sys->pp_mode != NULL )
 297     {
 298         const uint8_t *src[3];
 299         uint8_t *dst[3];
 300         int i_src_stride[3], i_dst_stride[3];
 301
 302         for( int i_plane = 0; i_plane < p_pic->i_planes; i_plane++ )
 303         {
 304             src[i_plane] = p_pic->p[i_plane].p_pixels;
 305             dst[i_plane] = p_outpic->p[i_plane].p_pixels;
 306
 307             /* I'm not sure what happens if i_pitch != i_visible_pitch ...
 308              * at least it shouldn't crash. */
 309             i_src_stride[i_plane] = p_pic->p[i_plane].i_pitch;
 310             i_dst_stride[i_plane] = p_outpic->p[i_plane].i_pitch;
 311         }
 312
 313         pp_postprocess( src, i_src_stride, dst, i_dst_stride,
 314                         p_filter->fmt_in.video.i_width,
 315                         p_filter->fmt_in.video.i_height, NULL, 0,
 316                         p_sys->pp_mode, p_sys->pp_context, 0 );
 317     }
 318     else
 319         picture_CopyPixels( p_outpic, p_pic );
 320     vlc_mutex_unlock( &p_sys->lock );
 321
 322     return CopyInfoAndRelease( p_outpic, p_pic );
 323 }
 324
 325 /*****************************************************************************
 326  * PPChangeMode: change the current mode and quality
 327  *****************************************************************************/
 328 static void PPChangeMode( filter_t *p_filter, const char *psz_name,
 329                           int i_quality )
 330 {
 331     filter_sys_t *p_sys = p_filter->p_sys;
 332     pp_mode *newmode = NULL, *oldmode;
 333
 334     if( i_quality > 0 )
 335     {
 336          newmode = pp_get_mode_by_name_and_quality( psz_name ? psz_name :
 337                                                     "default", i_quality );
 338          if( newmode == NULL )
 339          {
 340              msg_Warn( p_filter, "Error while changing post processing mode. "
 341                        "Keeping previous mode." );
 342              return;
 343         }
 344     }
 345
 346     vlc_mutex_lock( &p_sys->lock );
 347     oldmode = p_sys->pp_mode;
 348     p_sys->pp_mode = newmode;
 349     vlc_mutex_unlock( &p_sys->lock );
 350
 351     pp_free_mode( oldmode );
 352 }
 353
 354 static int PPQCallback( vlc_object_t *p_this, const char *psz_var,
 355                         vlc_value_t oldval, vlc_value_t newval, void *p_data )
 356 {
 357     VLC_UNUSED(psz_var); VLC_UNUSED(oldval); VLC_UNUSED(p_data);
 358     filter_t *p_filter = (filter_t *)p_this;
 359
 360     char *psz_name = var_GetNonEmptyString( p_filter, FILTER_PREFIX "name" );
 361     PPChangeMode( p_filter, psz_name, newval.i_int );
 362     free( psz_name );
 363     return VLC_SUCCESS;
 364 }
 365
 366 static int PPNameCallback( vlc_object_t *p_this, const char *psz_var,
 367                            vlc_value_t oldval, vlc_value_t newval, void *p_data )
 368 {
 369     VLC_UNUSED(psz_var); VLC_UNUSED(oldval); VLC_UNUSED(p_data);
 370     filter_t *p_filter = (filter_t *)p_this;
 371
 372     int i_quality = var_GetInteger( p_filter, FILTER_PREFIX "q" );
 373     PPChangeMode( p_filter, *newval.psz_string ? newval.psz_string : NULL,
 374                   i_quality );
 375     return VLC_SUCCESS;
 376 }