1 /*****************************************************************************
2 * adjust.c : Contrast/Hue/Saturation/Brightness video plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2000-2006 the VideoLAN team
7 * Authors: Simon Latapie <garf@via.ecp.fr>
8 * Antoine Cellerier <dionoea -at- videolan d0t org>
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.
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.
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 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
35 #include <vlc_common.h>
36 #include <vlc_plugin.h>
39 #include <vlc_filter.h>
40 #include "filter_picture.h"
43 # define M_PI 3.14159265358979323846
46 #define eight_times( x ) x x x x x x x x
48 /*****************************************************************************
50 *****************************************************************************/
51 static int Create ( vlc_object_t * );
52 static void Destroy ( vlc_object_t * );
54 static picture_t *FilterPlanar( filter_t *, picture_t * );
55 static picture_t *FilterPacked( filter_t *, picture_t * );
56 static int AdjustCallback( vlc_object_t *p_this, char const *psz_var,
57 vlc_value_t oldval, vlc_value_t newval,
60 /*****************************************************************************
62 *****************************************************************************/
64 #define THRES_TEXT N_("Brightness threshold")
65 #define THRES_LONGTEXT N_("When this mode is enabled, pixels will be " \
66 "shown as black or white. The threshold value will be the brighness " \
68 #define CONT_TEXT N_("Image contrast (0-2)")
69 #define CONT_LONGTEXT N_("Set the image contrast, between 0 and 2. Defaults to 1.")
70 #define HUE_TEXT N_("Image hue (0-360)")
71 #define HUE_LONGTEXT N_("Set the image hue, between 0 and 360. Defaults to 0.")
72 #define SAT_TEXT N_("Image saturation (0-3)")
73 #define SAT_LONGTEXT N_("Set the image saturation, between 0 and 3. Defaults to 1.")
74 #define LUM_TEXT N_("Image brightness (0-2)")
75 #define LUM_LONGTEXT N_("Set the image brightness, between 0 and 2. Defaults to 1.")
76 #define GAMMA_TEXT N_("Image gamma (0-10)")
77 #define GAMMA_LONGTEXT N_("Set the image gamma, between 0.01 and 10. Defaults to 1.")
80 set_description( N_("Image properties filter") )
81 set_shortname( N_("Image adjust" ))
82 set_category( CAT_VIDEO )
83 set_subcategory( SUBCAT_VIDEO_VFILTER )
84 set_capability( "video filter2", 0 )
86 add_float_with_range( "contrast", 1.0, 0.0, 2.0, NULL,
87 CONT_TEXT, CONT_LONGTEXT, false )
88 add_float_with_range( "brightness", 1.0, 0.0, 2.0, NULL,
89 LUM_TEXT, LUM_LONGTEXT, false )
90 add_integer_with_range( "hue", 0, 0, 360, NULL,
91 HUE_TEXT, HUE_LONGTEXT, false )
92 add_float_with_range( "saturation", 1.0, 0.0, 3.0, NULL,
93 SAT_TEXT, SAT_LONGTEXT, false )
94 add_float_with_range( "gamma", 1.0, 0.01, 10.0, NULL,
95 GAMMA_TEXT, GAMMA_LONGTEXT, false )
97 add_bool( "brightness-threshold", false, NULL,
98 THRES_TEXT, THRES_LONGTEXT, false )
100 add_shortcut( "adjust" )
101 set_callbacks( Create, Destroy )
104 static const char *const ppsz_filter_options[] = {
105 "contrast", "brightness", "hue", "saturation", "gamma",
106 "brightness-threshold", NULL
109 /*****************************************************************************
110 * filter_sys_t: adjust filter method descriptor
111 *****************************************************************************/
120 bool b_brightness_threshold;
123 /*****************************************************************************
124 * Create: allocates adjust video filter
125 *****************************************************************************/
126 static int Create( vlc_object_t *p_this )
128 filter_t *p_filter = (filter_t *)p_this;
131 switch( p_filter->fmt_in.video.i_chroma )
135 p_filter->pf_video_filter = FilterPlanar;
139 /* Packed YUV 4:2:2 */
140 p_filter->pf_video_filter = FilterPacked;
144 msg_Err( p_filter, "Unsupported input chroma (%4.4s)",
145 (char*)&(p_filter->fmt_in.video.i_chroma) );
149 if( p_filter->fmt_in.video.i_chroma != p_filter->fmt_out.video.i_chroma )
151 msg_Err( p_filter, "Input and output chromas don't match" );
155 /* Allocate structure */
156 p_filter->p_sys = malloc( sizeof( filter_sys_t ) );
157 if( p_filter->p_sys == NULL )
159 p_sys = p_filter->p_sys;
161 /* needed to get options passed in transcode using the
162 * adjust{name=value} syntax */
163 config_ChainParse( p_filter, "", ppsz_filter_options,
166 p_sys->f_contrast = var_CreateGetFloatCommand( p_filter, "contrast" );
167 p_sys->f_brightness = var_CreateGetFloatCommand( p_filter, "brightness" );
168 p_sys->i_hue = var_CreateGetIntegerCommand( p_filter, "hue" );
169 p_sys->f_saturation = var_CreateGetFloatCommand( p_filter, "saturation" );
170 p_sys->f_gamma = var_CreateGetFloatCommand( p_filter, "gamma" );
171 p_sys->b_brightness_threshold =
172 var_CreateGetBoolCommand( p_filter, "brightness-threshold" );
174 vlc_mutex_init( &p_sys->lock );
175 var_AddCallback( p_filter, "contrast", AdjustCallback, p_sys );
176 var_AddCallback( p_filter, "brightness", AdjustCallback, p_sys );
177 var_AddCallback( p_filter, "hue", AdjustCallback, p_sys );
178 var_AddCallback( p_filter, "saturation", AdjustCallback, p_sys );
179 var_AddCallback( p_filter, "gamma", AdjustCallback, p_sys );
180 var_AddCallback( p_filter, "brightness-threshold",
181 AdjustCallback, p_sys );
186 /*****************************************************************************
187 * Destroy: destroy adjust video filter
188 *****************************************************************************/
189 static void Destroy( vlc_object_t *p_this )
191 filter_t *p_filter = (filter_t *)p_this;
192 filter_sys_t *p_sys = p_filter->p_sys;
194 var_DelCallback( p_filter, "contrast", AdjustCallback, p_sys );
195 var_DelCallback( p_filter, "brightness", AdjustCallback, p_sys );
196 var_DelCallback( p_filter, "hue", AdjustCallback, p_sys );
197 var_DelCallback( p_filter, "saturation", AdjustCallback, p_sys );
198 var_DelCallback( p_filter, "gamma", AdjustCallback, p_sys );
199 var_DelCallback( p_filter, "brightness-threshold",
200 AdjustCallback, p_sys );
202 vlc_mutex_destroy( &p_sys->lock );
206 /*****************************************************************************
207 * Run the filter on a Planar YUV picture
208 *****************************************************************************/
209 static picture_t *FilterPlanar( filter_t *p_filter, picture_t *p_pic )
215 uint8_t *p_in, *p_in_v, *p_in_end, *p_line_end;
216 uint8_t *p_out, *p_out_v;
221 int32_t i_cont, i_lum;
222 int i_sat, i_sin, i_cos, i_x, i_y;
225 filter_sys_t *p_sys = p_filter->p_sys;
227 if( !p_pic ) return NULL;
229 p_outpic = filter_NewPicture( p_filter );
232 picture_Release( p_pic );
237 vlc_mutex_lock( &p_sys->lock );
238 i_cont = (int)( p_sys->f_contrast * 255 );
239 i_lum = (int)( (p_sys->f_brightness - 1.0)*255 );
240 f_hue = (float)( p_sys->i_hue * M_PI / 180 );
241 i_sat = (int)( p_sys->f_saturation * 256 );
242 f_gamma = 1.0 / p_sys->f_gamma;
243 b_thres = p_sys->b_brightness_threshold;
244 vlc_mutex_unlock( &p_sys->lock );
247 * Threshold mode drops out everything about luma, contrast and gamma.
249 if( b_thres != true )
252 /* Contrast is a fast but kludged function, so I put this gap to be
254 i_lum += 128 - i_cont / 2;
256 /* Fill the gamma lookup table */
257 for( i = 0 ; i < 256 ; i++ )
259 pi_gamma[ i ] = clip_uint8_vlc( pow(i / 255.0, f_gamma) * 255.0);
262 /* Fill the luma lookup table */
263 for( i = 0 ; i < 256 ; i++ )
265 pi_luma[ i ] = pi_gamma[clip_uint8_vlc( i_lum + i_cont * i / 256)];
271 * We get luma as threshold value: the higher it is, the darker is
272 * the image. Should I reverse this?
274 for( i = 0 ; i < 256 ; i++ )
276 pi_luma[ i ] = (i < i_lum) ? 0 : 255;
280 * Desaturates image to avoid that strange yellow halo...
289 p_in = p_pic->p[Y_PLANE].p_pixels;
290 p_in_end = p_in + p_pic->p[Y_PLANE].i_visible_lines
291 * p_pic->p[Y_PLANE].i_pitch - 8;
293 p_out = p_outpic->p[Y_PLANE].p_pixels;
295 for( ; p_in < p_in_end ; )
297 p_line_end = p_in + p_pic->p[Y_PLANE].i_visible_pitch - 8;
299 for( ; p_in < p_line_end ; )
301 /* Do 8 pixels at a time */
302 *p_out++ = pi_luma[ *p_in++ ]; *p_out++ = pi_luma[ *p_in++ ];
303 *p_out++ = pi_luma[ *p_in++ ]; *p_out++ = pi_luma[ *p_in++ ];
304 *p_out++ = pi_luma[ *p_in++ ]; *p_out++ = pi_luma[ *p_in++ ];
305 *p_out++ = pi_luma[ *p_in++ ]; *p_out++ = pi_luma[ *p_in++ ];
310 for( ; p_in < p_line_end ; )
312 *p_out++ = pi_luma[ *p_in++ ];
315 p_in += p_pic->p[Y_PLANE].i_pitch
316 - p_pic->p[Y_PLANE].i_visible_pitch;
317 p_out += p_outpic->p[Y_PLANE].i_pitch
318 - p_outpic->p[Y_PLANE].i_visible_pitch;
322 * Do the U and V planes
325 p_in = p_pic->p[U_PLANE].p_pixels;
326 p_in_v = p_pic->p[V_PLANE].p_pixels;
327 p_in_end = p_in + p_pic->p[U_PLANE].i_visible_lines
328 * p_pic->p[U_PLANE].i_pitch - 8;
330 p_out = p_outpic->p[U_PLANE].p_pixels;
331 p_out_v = p_outpic->p[V_PLANE].p_pixels;
333 i_sin = sin(f_hue) * 256;
334 i_cos = cos(f_hue) * 256;
336 i_x = ( cos(f_hue) + sin(f_hue) ) * 32768;
337 i_y = ( cos(f_hue) - sin(f_hue) ) * 32768;
341 #define WRITE_UV_CLIP() \
342 i_u = *p_in++ ; i_v = *p_in_v++ ; \
343 *p_out++ = clip_uint8_vlc( (( ((i_u * i_cos + i_v * i_sin - i_x) >> 8) \
344 * i_sat) >> 8) + 128); \
345 *p_out_v++ = clip_uint8_vlc( (( ((i_v * i_cos - i_u * i_sin - i_y) >> 8) \
346 * i_sat) >> 8) + 128)
350 for( ; p_in < p_in_end ; )
352 p_line_end = p_in + p_pic->p[U_PLANE].i_visible_pitch - 8;
354 for( ; p_in < p_line_end ; )
356 /* Do 8 pixels at a time */
357 WRITE_UV_CLIP(); WRITE_UV_CLIP();
358 WRITE_UV_CLIP(); WRITE_UV_CLIP();
359 WRITE_UV_CLIP(); WRITE_UV_CLIP();
360 WRITE_UV_CLIP(); WRITE_UV_CLIP();
365 for( ; p_in < p_line_end ; )
370 p_in += p_pic->p[U_PLANE].i_pitch
371 - p_pic->p[U_PLANE].i_visible_pitch;
372 p_in_v += p_pic->p[V_PLANE].i_pitch
373 - p_pic->p[V_PLANE].i_visible_pitch;
374 p_out += p_outpic->p[U_PLANE].i_pitch
375 - p_outpic->p[U_PLANE].i_visible_pitch;
376 p_out_v += p_outpic->p[V_PLANE].i_pitch
377 - p_outpic->p[V_PLANE].i_visible_pitch;
384 i_u = *p_in++ ; i_v = *p_in_v++ ; \
385 *p_out++ = (( ((i_u * i_cos + i_v * i_sin - i_x) >> 8) \
386 * i_sat) >> 8) + 128; \
387 *p_out_v++ = (( ((i_v * i_cos - i_u * i_sin - i_y) >> 8) \
392 for( ; p_in < p_in_end ; )
394 p_line_end = p_in + p_pic->p[U_PLANE].i_visible_pitch - 8;
396 for( ; p_in < p_line_end ; )
398 /* Do 8 pixels at a time */
399 WRITE_UV(); WRITE_UV(); WRITE_UV(); WRITE_UV();
400 WRITE_UV(); WRITE_UV(); WRITE_UV(); WRITE_UV();
405 for( ; p_in < p_line_end ; )
410 p_in += p_pic->p[U_PLANE].i_pitch
411 - p_pic->p[U_PLANE].i_visible_pitch;
412 p_in_v += p_pic->p[V_PLANE].i_pitch
413 - p_pic->p[V_PLANE].i_visible_pitch;
414 p_out += p_outpic->p[U_PLANE].i_pitch
415 - p_outpic->p[U_PLANE].i_visible_pitch;
416 p_out_v += p_outpic->p[V_PLANE].i_pitch
417 - p_outpic->p[V_PLANE].i_visible_pitch;
422 return CopyInfoAndRelease( p_outpic, p_pic );
425 /*****************************************************************************
426 * Run the filter on a Packed YUV picture
427 *****************************************************************************/
428 static picture_t *FilterPacked( filter_t *p_filter, picture_t *p_pic )
434 uint8_t *p_in, *p_in_v, *p_in_end, *p_line_end;
435 uint8_t *p_out, *p_out_v;
436 int i_y_offset, i_u_offset, i_v_offset;
438 int i_lines, i_visible_lines, i_pitch, i_visible_pitch;
443 int32_t i_cont, i_lum;
444 int i_sat, i_sin, i_cos, i_x, i_y;
447 filter_sys_t *p_sys = p_filter->p_sys;
449 if( !p_pic ) return NULL;
451 i_lines = p_pic->p->i_lines;
452 i_visible_lines = p_pic->p->i_visible_lines;
453 i_pitch = p_pic->p->i_pitch;
454 i_visible_pitch = p_pic->p->i_visible_pitch;
456 if( GetPackedYuvOffsets( p_pic->format.i_chroma, &i_y_offset,
457 &i_u_offset, &i_v_offset ) != VLC_SUCCESS )
459 msg_Warn( p_filter, "Unsupported input chroma (%4.4s)",
460 (char*)&(p_pic->format.i_chroma) );
462 picture_Release( p_pic );
466 p_outpic = filter_NewPicture( p_filter );
469 msg_Warn( p_filter, "can't get output picture" );
471 picture_Release( p_pic );
476 vlc_mutex_lock( &p_sys->lock );
477 i_cont = (int)( p_sys->f_contrast * 255 );
478 i_lum = (int)( (p_sys->f_brightness - 1.0)*255 );
479 f_hue = (float)( p_sys->i_hue * M_PI / 180 );
480 i_sat = (int)( p_sys->f_saturation * 256 );
481 f_gamma = 1.0 / p_sys->f_gamma;
482 b_thres = p_sys->b_brightness_threshold;
483 vlc_mutex_unlock( &p_sys->lock );
486 * Threshold mode drops out everything about luma, contrast and gamma.
488 if( b_thres != true )
491 /* Contrast is a fast but kludged function, so I put this gap to be
493 i_lum += 128 - i_cont / 2;
495 /* Fill the gamma lookup table */
496 for( i = 0 ; i < 256 ; i++ )
498 pi_gamma[ i ] = clip_uint8_vlc( pow(i / 255.0, f_gamma) * 255.0);
501 /* Fill the luma lookup table */
502 for( i = 0 ; i < 256 ; i++ )
504 pi_luma[ i ] = pi_gamma[clip_uint8_vlc( i_lum + i_cont * i / 256)];
510 * We get luma as threshold value: the higher it is, the darker is
511 * the image. Should I reverse this?
513 for( i = 0 ; i < 256 ; i++ )
515 pi_luma[ i ] = (i < i_lum) ? 0 : 255;
519 * Desaturates image to avoid that strange yellow halo...
528 p_in = p_pic->p->p_pixels + i_y_offset;
529 p_in_end = p_in + p_pic->p->i_visible_lines * p_pic->p->i_pitch - 8 * 4;
531 p_out = p_outpic->p->p_pixels + i_y_offset;
533 for( ; p_in < p_in_end ; )
535 p_line_end = p_in + i_visible_pitch - 8 * 4;
537 for( ; p_in < p_line_end ; )
539 /* Do 8 pixels at a time */
540 *p_out = pi_luma[ *p_in ]; p_in += 2; p_out += 2;
541 *p_out = pi_luma[ *p_in ]; p_in += 2; p_out += 2;
542 *p_out = pi_luma[ *p_in ]; p_in += 2; p_out += 2;
543 *p_out = pi_luma[ *p_in ]; p_in += 2; p_out += 2;
544 *p_out = pi_luma[ *p_in ]; p_in += 2; p_out += 2;
545 *p_out = pi_luma[ *p_in ]; p_in += 2; p_out += 2;
546 *p_out = pi_luma[ *p_in ]; p_in += 2; p_out += 2;
547 *p_out = pi_luma[ *p_in ]; p_in += 2; p_out += 2;
552 for( ; p_in < p_line_end ; )
554 *p_out = pi_luma[ *p_in ]; p_in += 2; p_out += 2;
557 p_in += i_pitch - p_pic->p->i_visible_pitch;
558 p_out += i_pitch - p_outpic->p->i_visible_pitch;
562 * Do the U and V planes
565 p_in = p_pic->p->p_pixels + i_u_offset;
566 p_in_v = p_pic->p->p_pixels + i_v_offset;
567 p_in_end = p_in + i_visible_lines * i_pitch - 8 * 4;
569 p_out = p_outpic->p->p_pixels + i_u_offset;
570 p_out_v = p_outpic->p->p_pixels + i_v_offset;
572 i_sin = sin(f_hue) * 256;
573 i_cos = cos(f_hue) * 256;
575 i_x = ( cos(f_hue) + sin(f_hue) ) * 32768;
576 i_y = ( cos(f_hue) - sin(f_hue) ) * 32768;
580 #define WRITE_UV_CLIP() \
581 i_u = *p_in; p_in += 4; i_v = *p_in_v; p_in_v += 4; \
582 *p_out = clip_uint8_vlc( (( ((i_u * i_cos + i_v * i_sin - i_x) >> 8) \
583 * i_sat) >> 8) + 128); \
585 *p_out_v = clip_uint8_vlc( (( ((i_v * i_cos - i_u * i_sin - i_y) >> 8) \
586 * i_sat) >> 8) + 128); \
591 for( ; p_in < p_in_end ; )
593 p_line_end = p_in + i_visible_pitch - 8 * 4;
595 for( ; p_in < p_line_end ; )
597 /* Do 8 pixels at a time */
598 WRITE_UV_CLIP(); WRITE_UV_CLIP();
599 WRITE_UV_CLIP(); WRITE_UV_CLIP();
600 WRITE_UV_CLIP(); WRITE_UV_CLIP();
601 WRITE_UV_CLIP(); WRITE_UV_CLIP();
606 for( ; p_in < p_line_end ; )
611 p_in += i_pitch - i_visible_pitch;
612 p_in_v += i_pitch - i_visible_pitch;
613 p_out += i_pitch - i_visible_pitch;
614 p_out_v += i_pitch - i_visible_pitch;
621 i_u = *p_in; p_in += 4; i_v = *p_in_v; p_in_v += 4; \
622 *p_out = (( ((i_u * i_cos + i_v * i_sin - i_x) >> 8) \
623 * i_sat) >> 8) + 128; \
625 *p_out_v = (( ((i_v * i_cos - i_u * i_sin - i_y) >> 8) \
626 * i_sat) >> 8) + 128; \
631 for( ; p_in < p_in_end ; )
633 p_line_end = p_in + i_visible_pitch - 8 * 4;
635 for( ; p_in < p_line_end ; )
637 /* Do 8 pixels at a time */
638 WRITE_UV(); WRITE_UV(); WRITE_UV(); WRITE_UV();
639 WRITE_UV(); WRITE_UV(); WRITE_UV(); WRITE_UV();
644 for( ; p_in < p_line_end ; )
649 p_in += i_pitch - i_visible_pitch;
650 p_in_v += i_pitch - i_visible_pitch;
651 p_out += i_pitch - i_visible_pitch;
652 p_out_v += i_pitch - i_visible_pitch;
657 return CopyInfoAndRelease( p_outpic, p_pic );
660 static int AdjustCallback( vlc_object_t *p_this, char const *psz_var,
661 vlc_value_t oldval, vlc_value_t newval,
664 VLC_UNUSED(p_this); VLC_UNUSED(oldval);
665 filter_sys_t *p_sys = (filter_sys_t *)p_data;
667 vlc_mutex_lock( &p_sys->lock );
668 if( !strcmp( psz_var, "contrast" ) )
669 p_sys->f_contrast = newval.f_float;
670 else if( !strcmp( psz_var, "brightness" ) )
671 p_sys->f_brightness = newval.f_float;
672 else if( !strcmp( psz_var, "hue" ) )
673 p_sys->i_hue = newval.i_int;
674 else if( !strcmp( psz_var, "saturation" ) )
675 p_sys->f_saturation = newval.f_float;
676 else if( !strcmp( psz_var, "gamma" ) )
677 p_sys->f_gamma = newval.f_float;
678 else if( !strcmp( psz_var, "brightness-threshold" ) )
679 p_sys->b_brightness_threshold = newval.b_bool;
680 vlc_mutex_unlock( &p_sys->lock );