5dcdc2e3eb5b76880c4359202c6218ac9296690a
[vlc.git] / modules / video_filter / postproc.c
1 /*****************************************************************************
2  * postproc.c: video postprocessing using libpostproc
3  *****************************************************************************
4  * Copyright (C) 1999-2008 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_vout.h>
33
34 #include "filter_picture.h"
35
36 #ifdef HAVE_POSTPROC_POSTPROCESS_H
37 #   include <postproc/postprocess.h>
38 #else
39 #   include <libpostproc/postprocess.h>
40 #endif
41
42 #ifndef PP_CPU_CAPS_ALTIVEC
43 #   define PP_CPU_CAPS_ALTIVEC 0
44 #endif
45
46 /*****************************************************************************
47  * Local prototypes
48  *****************************************************************************/
49 static int OpenPostproc( vlc_object_t * );
50 static void ClosePostproc( vlc_object_t * );
51
52 static picture_t *PostprocPict( filter_t *, picture_t * );
53
54 static int PPQCallback( vlc_object_t *, char const *,
55                         vlc_value_t, vlc_value_t, void * );
56 static int PPNameCallback( vlc_object_t *, char const *,
57                            vlc_value_t, vlc_value_t, void * );
58
59 #define Q_TEXT N_("Post processing quality")
60 #define Q_LONGTEXT N_( \
61     "Quality of post processing. Valid range is 0 to 6\n" \
62     "Higher levels require considerable more CPU power, but produce " \
63     "better looking pictures." )
64
65 #define NAME_TEXT N_("FFmpeg post processing filter chains")
66 /* defined by libpostproc */
67 #define NAME_LONGTEXT pp_help
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" ) /* name is "postproc" */
78     add_shortcut( "pp" )
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, NULL, Q_TEXT, Q_LONGTEXT, false )
88         add_deprecated_alias( "ffmpeg-pp-q" )
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     pp_context_t *pp_context; /* Never changes after init */
104     pp_mode_t    *pp_mode; /* Set to NULL if post processing is disabled */
105
106     bool b_had_matrix; /* Set to true if previous pic had a quant matrix (used to prevent spamming warning messages */
107
108     vlc_mutex_t lock; /* Lock when using or changing pp_mode */
109 };
110
111
112 /*****************************************************************************
113  * OpenPostproc: probe and open the postproc
114  *****************************************************************************/
115 static int OpenPostproc( vlc_object_t *p_this )
116 {
117     filter_t *p_filter = (filter_t *)p_this;
118     filter_sys_t *p_sys;
119     vlc_value_t val, val_orig, text;
120     unsigned i_cpu = vlc_CPU();
121     int i_flags = 0;
122
123     if( p_filter->fmt_in.video.i_chroma != p_filter->fmt_out.video.i_chroma ||
124         p_filter->fmt_in.video.i_height != p_filter->fmt_out.video.i_height ||
125         p_filter->fmt_in.video.i_width != p_filter->fmt_out.video.i_width )
126     {
127         msg_Err( p_filter, "Filter input and output formats must be identical" );
128         return VLC_EGENERIC;
129     }
130
131     /* Set CPU capabilities */
132     if( i_cpu & CPU_CAPABILITY_MMX )
133         i_flags |= PP_CPU_CAPS_MMX;
134     if( i_cpu & CPU_CAPABILITY_MMXEXT )
135         i_flags |= PP_CPU_CAPS_MMX2;
136     if( i_cpu & CPU_CAPABILITY_3DNOW )
137         i_flags |= PP_CPU_CAPS_3DNOW;
138     if( i_cpu & CPU_CAPABILITY_ALTIVEC )
139         i_flags |= PP_CPU_CAPS_ALTIVEC;
140
141     switch( p_filter->fmt_in.video.i_chroma )
142     {
143         case VLC_FOURCC('I','4','4','4'):
144         case VLC_FOURCC('J','4','4','4'):
145         /* case VLC_FOURCC('Y','U','V','A'): FIXME Should work but alpha plane needs to be copied manually and I'm kind of feeling too lazy to write the code to do that ATM (i_pitch vs i_visible_pitch...). */
146             i_flags |= PP_FORMAT_444;
147             break;
148         case VLC_FOURCC('I','4','2','2'):
149         case VLC_FOURCC('J','4','2','2'):
150             i_flags |= PP_FORMAT_422;
151             break;
152         case VLC_FOURCC('I','4','1','1'):
153             i_flags |= PP_FORMAT_411;
154             break;
155         case VLC_FOURCC('I','4','2','0'):
156         case VLC_FOURCC('I','Y','U','V'):
157         case VLC_FOURCC('J','4','2','0'):
158         case VLC_FOURCC('Y','V','1','2'):
159             i_flags |= PP_FORMAT_420;
160             break;
161         default:
162             msg_Err( p_filter, "Unsupported input chroma (%4s)",
163                       (char*)&p_filter->fmt_in.video.i_chroma );
164             return VLC_EGENERIC;
165     }
166
167     p_sys = malloc( sizeof( filter_sys_t ) );
168     if( !p_sys ) return VLC_ENOMEM;
169     p_filter->p_sys = p_sys;
170
171     p_sys->pp_context = pp_get_context( p_filter->fmt_in.video.i_width,
172                                         p_filter->fmt_in.video.i_height,
173                                         i_flags );
174     if( !p_sys->pp_context )
175     {
176         msg_Err( p_filter, "Error while creating post processing context." );
177         free( p_sys );
178         return VLC_EGENERIC;
179     }
180
181     config_ChainParse( p_filter, FILTER_PREFIX, ppsz_filter_options,
182                        p_filter->p_cfg );
183
184     var_Create( p_filter, FILTER_PREFIX "q",
185                 VLC_VAR_INTEGER | VLC_VAR_HASCHOICE | VLC_VAR_DOINHERIT |
186                 VLC_VAR_ISCOMMAND );
187     var_Change( p_filter, FILTER_PREFIX "q", VLC_VAR_SETISCOMMAND, NULL, NULL ); /* For some obscure reason the VLC_VAR_ISCOMMAND isn't taken into account in during var_Create */
188     var_AddCallback( p_filter, FILTER_PREFIX "q", PPQCallback, NULL );
189     text.psz_string = _("Post processing");
190     var_Change( p_filter, FILTER_PREFIX "q", VLC_VAR_SETTEXT, &text, NULL );
191
192     var_Get( p_filter, FILTER_PREFIX "q", &val_orig );
193     var_Change( p_filter, FILTER_PREFIX "q", VLC_VAR_DELCHOICE, &val_orig, NULL );
194
195     val.psz_string = var_CreateGetNonEmptyStringCommand(
196                                             p_filter, FILTER_PREFIX "name" );
197     var_AddCallback( p_filter, FILTER_PREFIX "name", PPNameCallback, NULL );
198     if( val_orig.i_int )
199     {
200         p_sys->pp_mode = pp_get_mode_by_name_and_quality( val.psz_string?:
201                                                           "default",
202                                                           val_orig.i_int );
203
204         if( !p_sys->pp_mode )
205         {
206             msg_Err( p_filter, "Error while creating post processing mode." );
207             free( val.psz_string );
208             var_Destroy( p_filter, FILTER_PREFIX "q" );
209             pp_free_context( p_sys->pp_context );
210             free( p_sys );
211             return VLC_EGENERIC;
212         }
213     }
214     else
215     {
216         p_sys->pp_mode = NULL;
217     }
218     free( val.psz_string );
219
220     for( val.i_int = 0; val.i_int <= PP_QUALITY_MAX; val.i_int++ )
221     {
222         switch( val.i_int )
223         {
224             case 0:
225                 text.psz_string = _("Disable");
226                 break;
227             case 1:
228                 text.psz_string = _("Lowest");
229                 break;
230             case PP_QUALITY_MAX:
231                 text.psz_string = _("Highest");
232                 break;
233             default:
234                 text.psz_string = NULL;
235                 break;
236         }
237         var_Change( p_filter, FILTER_PREFIX "q", VLC_VAR_ADDCHOICE,
238                     &val, text.psz_string?&text:NULL );
239     }
240
241     vlc_mutex_init( &p_sys->lock );
242
243     p_filter->pf_video_filter = PostprocPict;
244     p_sys->b_had_matrix = true;
245
246     return VLC_SUCCESS;
247 }
248
249 /*****************************************************************************
250  * ClosePostproc
251  *****************************************************************************/
252 static void ClosePostproc( vlc_object_t *p_this )
253 {
254     filter_t *p_filter = (filter_t *)p_this;
255     filter_sys_t *p_sys = p_filter->p_sys;
256     vlc_mutex_destroy( &p_sys->lock );
257     pp_free_context( p_sys->pp_context );
258     if( p_sys->pp_mode ) pp_free_mode( p_sys->pp_mode );
259     free( p_sys );
260 }
261
262 /*****************************************************************************
263  * PostprocPict
264  *****************************************************************************/
265 static picture_t *PostprocPict( filter_t *p_filter, picture_t *p_pic )
266 {
267     filter_sys_t *p_sys = p_filter->p_sys;
268
269     const uint8_t *src[3];
270     uint8_t *dst[3];
271     int i_plane;
272     int i_src_stride[3], i_dst_stride[3];
273
274     vlc_mutex_lock( &p_sys->lock ); /* Lock to prevent issues if pp_mode is changed */
275     if( !p_sys->pp_mode )
276     {
277         vlc_mutex_unlock( &p_sys->lock );
278         return p_pic;
279     }
280
281     picture_t *p_outpic = filter_NewPicture( p_filter );
282     if( !p_outpic )
283     {
284         picture_Release( p_pic );
285         vlc_mutex_unlock( &p_sys->lock );
286         return NULL;
287     }
288
289     for( i_plane = 0; i_plane < p_pic->i_planes; i_plane++ )
290     {
291         src[i_plane] = p_pic->p[i_plane].p_pixels;
292         dst[i_plane] = p_outpic->p[i_plane].p_pixels;
293
294         /* I'm not sure what happens if i_pitch != i_visible_pitch ...
295          * at least it shouldn't crash. */
296         i_src_stride[i_plane] = p_pic->p[i_plane].i_pitch;
297         i_dst_stride[i_plane] = p_outpic->p[i_plane].i_pitch;
298     }
299
300     if( !p_pic->p_q && p_sys->b_had_matrix )
301     {
302         msg_Warn( p_filter, "Quantification table was not set by video decoder. Postprocessing won't look good." );
303         p_sys->b_had_matrix = false;
304     }
305     else if( p_pic->p_q )
306     {
307         p_sys->b_had_matrix = true;
308     }
309
310     pp_postprocess( src, i_src_stride, dst, i_dst_stride,
311                     p_filter->fmt_in.video.i_width,
312                     p_filter->fmt_in.video.i_height,
313                     p_pic->p_q, p_pic->i_qstride,
314                     p_sys->pp_mode, p_sys->pp_context,
315                     p_pic->i_qtype == QTYPE_MPEG2 ? PP_PICT_TYPE_QP2 : 0 );
316     vlc_mutex_unlock( &p_sys->lock );
317
318     return CopyInfoAndRelease( p_outpic, p_pic );
319 }
320
321 /*****************************************************************************
322  *
323  *****************************************************************************/
324 static void PPChangeMode( filter_t *p_filter, const char *psz_name,
325                           int i_quality )
326 {
327     filter_sys_t *p_sys = p_filter->p_sys;
328     vlc_mutex_lock( &p_sys->lock );
329     if( i_quality > 0 )
330     {
331         pp_mode_t *pp_mode = pp_get_mode_by_name_and_quality( psz_name?:
332                                                               "default",
333                                                               i_quality );
334         if( pp_mode )
335         {
336             pp_free_mode( p_sys->pp_mode );
337             p_sys->pp_mode = pp_mode;
338         }
339         else
340             msg_Warn( p_filter, "Error while changing post processing mode. "
341                       "Keeping previous mode." );
342     }
343     else
344     {
345         pp_free_mode( p_sys->pp_mode );
346         p_sys->pp_mode = NULL;
347     }
348     vlc_mutex_unlock( &p_sys->lock );
349 }
350
351 static int PPQCallback( vlc_object_t *p_this, const char *psz_var,
352                         vlc_value_t oldval, vlc_value_t newval, void *p_data )
353 {
354     VLC_UNUSED(psz_var); VLC_UNUSED(oldval); VLC_UNUSED(p_data);
355     filter_t *p_filter = (filter_t *)p_this;
356
357     char *psz_name = var_GetNonEmptyString( p_filter, FILTER_PREFIX "name" );
358     PPChangeMode( p_filter, psz_name, newval.i_int );
359     free( psz_name );
360     return VLC_SUCCESS;
361 }
362
363 static int PPNameCallback( vlc_object_t *p_this, const char *psz_var,
364                            vlc_value_t oldval, vlc_value_t newval, void *p_data )
365 {
366     VLC_UNUSED(psz_var); VLC_UNUSED(oldval); VLC_UNUSED(p_data);
367     filter_t *p_filter = (filter_t *)p_this;
368
369     int i_quality = var_GetInteger( p_filter, FILTER_PREFIX "q" );
370     PPChangeMode( p_filter, *newval.psz_string?newval.psz_string:NULL, i_quality );
371     return VLC_SUCCESS;
372 }