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 to 6\n" \
  63     "Higher levels require considerable more CPU power, but produce " \
  64     "better looking pictures." )
  65
  66 #define NAME_TEXT N_("FFmpeg post processing filter chains")
  67 #define NAME_LONGTEXT NAME_TEXT
  68
  69 #define FILTER_PREFIX "postproc-"
  70
  71 /*****************************************************************************
  72  * Module descriptor
  73  *****************************************************************************/
  74 vlc_module_begin ()
  75     set_description( N_("Video post processing filter") )
  76     set_shortname( N_("Postproc" ) )
  77     add_shortcut( "postprocess", "pp" ) /* name is "postproc" */
  78     set_category( CAT_VIDEO )
  79     set_subcategory( SUBCAT_VIDEO_VFILTER )
  80
  81     set_capability( "video filter2", 0 )
  82
  83     set_callbacks( OpenPostproc, ClosePostproc )
  84
  85     add_integer_with_range( FILTER_PREFIX "q", PP_QUALITY_MAX, 0,
  86                             PP_QUALITY_MAX, NULL, Q_TEXT, Q_LONGTEXT, false )
  87         add_deprecated_alias( "ffmpeg-pp-q" )
  88         change_safe()
  89     add_string( FILTER_PREFIX "name", "default", NULL, NAME_TEXT,
  90                 NAME_LONGTEXT, true )
  91         add_deprecated_alias( "ffmpeg-pp-name" )
  92 vlc_module_end ()
  93
  94 static const char *const ppsz_filter_options[] = {
  95     "q", "name", NULL
  96 };
  97
  98 /*****************************************************************************
  99  * filter_sys_t : libpostproc video postprocessing descriptor
 100  *****************************************************************************/
 101 struct filter_sys_t
 102 {
 103     /* Never changes after init */
 104     pp_context_t *pp_context;
 105
 106     /* Set to NULL if post processing is disabled */
 107     pp_mode_t    *pp_mode;
 108
 109     /* Set to true if previous pic had a quant matrix
 110        (used to prevent spamming warning messages) */
 111     bool b_had_matrix;
 112
 113     /* Lock when using or changing pp_mode */
 114     vlc_mutex_t lock;
 115 };
 116
 117
 118 /*****************************************************************************
 119  * OpenPostproc: probe and open the postproc
 120  *****************************************************************************/
 121 static int OpenPostproc( vlc_object_t *p_this )
 122 {
 123     filter_t *p_filter = (filter_t *)p_this;
 124     filter_sys_t *p_sys;
 125     vlc_value_t val, val_orig, text;
 126     unsigned i_cpu = vlc_CPU();
 127     int i_flags = 0;
 128
 129     if( p_filter->fmt_in.video.i_chroma != p_filter->fmt_out.video.i_chroma ||
 130         p_filter->fmt_in.video.i_height != p_filter->fmt_out.video.i_height ||
 131         p_filter->fmt_in.video.i_width != p_filter->fmt_out.video.i_width )
 132     {
 133         msg_Err( p_filter, "Filter input and output formats must be identical" );
 134         return VLC_EGENERIC;
 135     }
 136
 137     /* Set CPU capabilities */
 138     if( i_cpu & CPU_CAPABILITY_MMX )
 139         i_flags |= PP_CPU_CAPS_MMX;
 140     if( i_cpu & CPU_CAPABILITY_MMXEXT )
 141         i_flags |= PP_CPU_CAPS_MMX2;
 142     if( i_cpu & CPU_CAPABILITY_3DNOW )
 143         i_flags |= PP_CPU_CAPS_3DNOW;
 144     if( i_cpu & CPU_CAPABILITY_ALTIVEC )
 145         i_flags |= PP_CPU_CAPS_ALTIVEC;
 146
 147     switch( p_filter->fmt_in.video.i_chroma )
 148     {
 149         case VLC_CODEC_I444:
 150         case VLC_CODEC_J444:
 151         /* case VLC_CODEC_YUVA:
 152            FIXME: Should work but alpha plane needs to be copied manually and
 153                   I'm kind of feeling too lazy to write the code to do that ATM
 154                   (i_pitch vs i_visible_pitch...). */
 155             i_flags |= PP_FORMAT_444;
 156             break;
 157         case VLC_CODEC_I422:
 158         case VLC_CODEC_J422:
 159             i_flags |= PP_FORMAT_422;
 160             break;
 161         case VLC_CODEC_I411:
 162             i_flags |= PP_FORMAT_411;
 163             break;
 164         case VLC_CODEC_I420:
 165         case VLC_CODEC_J420:
 166         case VLC_CODEC_YV12:
 167             i_flags |= PP_FORMAT_420;
 168             break;
 169         default:
 170             msg_Err( p_filter, "Unsupported input chroma (%4.4s)",
 171                       (char*)&p_filter->fmt_in.video.i_chroma );
 172             return VLC_EGENERIC;
 173     }
 174
 175     p_sys = malloc( sizeof( filter_sys_t ) );
 176     if( !p_sys ) return VLC_ENOMEM;
 177     p_filter->p_sys = p_sys;
 178
 179     p_sys->pp_context = pp_get_context( p_filter->fmt_in.video.i_width,
 180                                         p_filter->fmt_in.video.i_height,
 181                                         i_flags );
 182     if( !p_sys->pp_context )
 183     {
 184         msg_Err( p_filter, "Error while creating post processing context." );
 185         free( p_sys );
 186         return VLC_EGENERIC;
 187     }
 188
 189     config_ChainParse( p_filter, FILTER_PREFIX, ppsz_filter_options,
 190                        p_filter->p_cfg );
 191
 192     var_Create( p_filter, FILTER_PREFIX "q", VLC_VAR_INTEGER |
 193                 VLC_VAR_HASCHOICE | VLC_VAR_DOINHERIT | VLC_VAR_ISCOMMAND );
 194
 195     text.psz_string = _("Post processing");
 196     var_Change( p_filter, FILTER_PREFIX "q", VLC_VAR_SETTEXT, &text, NULL );
 197
 198     var_Get( p_filter, FILTER_PREFIX "q", &val_orig );
 199     var_Change( p_filter, FILTER_PREFIX "q", VLC_VAR_DELCHOICE, &val_orig, NULL );
 200
 201     val.psz_string = var_GetNonEmptyString( p_filter, FILTER_PREFIX "name" );
 202     if( val_orig.i_int )
 203     {
 204         p_sys->pp_mode = pp_get_mode_by_name_and_quality( val.psz_string ?
 205                                                           val.psz_string :
 206                                                           "default",
 207                                                           val_orig.i_int );
 208
 209         if( !p_sys->pp_mode )
 210         {
 211             msg_Err( p_filter, "Error while creating post processing mode." );
 212             free( val.psz_string );
 213             pp_free_context( p_sys->pp_context );
 214             free( p_sys );
 215             return VLC_EGENERIC;
 216         }
 217     }
 218     else
 219     {
 220         p_sys->pp_mode = NULL;
 221     }
 222     free( val.psz_string );
 223
 224     for( val.i_int = 0; val.i_int <= PP_QUALITY_MAX; val.i_int++ )
 225     {
 226         switch( val.i_int )
 227         {
 228             case 0:
 229                 text.psz_string = _("Disable");
 230                 break;
 231             case 1:
 232                 text.psz_string = _("Lowest");
 233                 break;
 234             case PP_QUALITY_MAX:
 235                 text.psz_string = _("Highest");
 236                 break;
 237             default:
 238                 text.psz_string = NULL;
 239                 break;
 240         }
 241         var_Change( p_filter, FILTER_PREFIX "q", VLC_VAR_ADDCHOICE,
 242                     &val, text.psz_string?&text:NULL );
 243     }
 244
 245     vlc_mutex_init( &p_sys->lock );
 246
 247     /* Add the callback at the end to prevent crashes */
 248     var_AddCallback( p_filter, FILTER_PREFIX "q", PPQCallback, NULL );
 249     var_AddCallback( p_filter, FILTER_PREFIX "name", PPNameCallback, NULL );
 250
 251     p_filter->pf_video_filter = PostprocPict;
 252     p_sys->b_had_matrix = true;
 253
 254     return VLC_SUCCESS;
 255 }
 256
 257 /*****************************************************************************
 258  * ClosePostproc
 259  *****************************************************************************/
 260 static void ClosePostproc( vlc_object_t *p_this )
 261 {
 262     filter_t *p_filter = (filter_t *)p_this;
 263     filter_sys_t *p_sys = p_filter->p_sys;
 264
 265     /* delete the callback before destroying the mutex */
 266     var_DelCallback( p_filter, FILTER_PREFIX "q", PPQCallback, NULL );
 267     var_DelCallback( p_filter, FILTER_PREFIX "name", PPNameCallback, NULL );
 268
 269     /* Destroy the resources */
 270     vlc_mutex_destroy( &p_sys->lock );
 271     pp_free_context( p_sys->pp_context );
 272     if( p_sys->pp_mode ) pp_free_mode( p_sys->pp_mode );
 273     free( p_sys );
 274 }
 275
 276 /*****************************************************************************
 277  * PostprocPict
 278  *****************************************************************************/
 279 static picture_t *PostprocPict( filter_t *p_filter, picture_t *p_pic )
 280 {
 281     filter_sys_t *p_sys = p_filter->p_sys;
 282
 283     const uint8_t *src[3];
 284     uint8_t *dst[3];
 285     int i_plane;
 286     int i_src_stride[3], i_dst_stride[3];
 287
 288     picture_t *p_outpic = filter_NewPicture( p_filter );
 289     if( !p_outpic )
 290     {
 291         picture_Release( p_pic );
 292         return NULL;
 293     }
 294
 295     /* Lock to prevent issues if pp_mode is changed */
 296     vlc_mutex_lock( &p_sys->lock );
 297     if( !p_sys->pp_mode )
 298     {
 299         vlc_mutex_unlock( &p_sys->lock );
 300         picture_CopyPixels( p_outpic, p_pic );
 301         return CopyInfoAndRelease( p_outpic, p_pic );
 302     }
 303
 304
 305     for( i_plane = 0; i_plane < p_pic->i_planes; i_plane++ )
 306     {
 307         src[i_plane] = p_pic->p[i_plane].p_pixels;
 308         dst[i_plane] = p_outpic->p[i_plane].p_pixels;
 309
 310         /* I'm not sure what happens if i_pitch != i_visible_pitch ...
 311          * at least it shouldn't crash. */
 312         i_src_stride[i_plane] = p_pic->p[i_plane].i_pitch;
 313         i_dst_stride[i_plane] = p_outpic->p[i_plane].i_pitch;
 314     }
 315
 316     if( !p_pic->p_q && p_sys->b_had_matrix )
 317     {
 318         msg_Warn( p_filter, "Quantification table was not set by video decoder. Postprocessing won't look good." );
 319         p_sys->b_had_matrix = false;
 320     }
 321     else if( p_pic->p_q )
 322     {
 323         p_sys->b_had_matrix = true;
 324     }
 325
 326     pp_postprocess( src, i_src_stride, dst, i_dst_stride,
 327                     p_filter->fmt_in.video.i_width,
 328                     p_filter->fmt_in.video.i_height,
 329                     p_pic->p_q, p_pic->i_qstride,
 330                     p_sys->pp_mode, p_sys->pp_context,
 331                     p_pic->i_qtype == QTYPE_MPEG2 ? PP_PICT_TYPE_QP2 : 0 );
 332     vlc_mutex_unlock( &p_sys->lock );
 333
 334     return CopyInfoAndRelease( p_outpic, p_pic );
 335 }
 336
 337 /*****************************************************************************
 338  * PPChangeMode: change the current mode and quality
 339  *****************************************************************************/
 340 static void PPChangeMode( filter_t *p_filter, const char *psz_name,
 341                           int i_quality )
 342 {
 343     filter_sys_t *p_sys = p_filter->p_sys;
 344     vlc_mutex_lock( &p_sys->lock );
 345     if( i_quality > 0 )
 346     {
 347         pp_mode_t *pp_mode = pp_get_mode_by_name_and_quality( psz_name ?
 348                                                               psz_name :
 349                                                               "default",
 350                                                               i_quality );
 351         if( pp_mode )
 352         {
 353             pp_free_mode( p_sys->pp_mode );
 354             p_sys->pp_mode = pp_mode;
 355         }
 356         else
 357             msg_Warn( p_filter, "Error while changing post processing mode. "
 358                       "Keeping previous mode." );
 359     }
 360     else
 361     {
 362         pp_free_mode( p_sys->pp_mode );
 363         p_sys->pp_mode = NULL;
 364     }
 365     vlc_mutex_unlock( &p_sys->lock );
 366 }
 367
 368 static int PPQCallback( vlc_object_t *p_this, const char *psz_var,
 369                         vlc_value_t oldval, vlc_value_t newval, void *p_data )
 370 {
 371     VLC_UNUSED(psz_var); VLC_UNUSED(oldval); VLC_UNUSED(p_data);
 372     filter_t *p_filter = (filter_t *)p_this;
 373
 374     char *psz_name = var_GetNonEmptyString( p_filter, FILTER_PREFIX "name" );
 375     PPChangeMode( p_filter, psz_name, newval.i_int );
 376     free( psz_name );
 377     return VLC_SUCCESS;
 378 }
 379
 380 static int PPNameCallback( vlc_object_t *p_this, const char *psz_var,
 381                            vlc_value_t oldval, vlc_value_t newval, void *p_data )
 382 {
 383     VLC_UNUSED(psz_var); VLC_UNUSED(oldval); VLC_UNUSED(p_data);
 384     filter_t *p_filter = (filter_t *)p_this;
 385
 386     int i_quality = var_GetInteger( p_filter, FILTER_PREFIX "q" );
 387     PPChangeMode( p_filter, *newval.psz_string ? newval.psz_string : NULL,
 388                   i_quality );
 389     return VLC_SUCCESS;
 390 }