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

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