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 *****************************************************************************/
36 #include <vlc_plugin.h>
40 #include "vlc_filter.h"
41 #include "filter_picture.h"
44 # define M_PI 3.14159265358979323846
47 #define eight_times( x ) x x x x x x x x
49 /*****************************************************************************
51 *****************************************************************************/
52 static int Create ( vlc_object_t * );
53 static void Destroy ( vlc_object_t * );
55 static picture_t *FilterPlanar( filter_t *, picture_t * );
56 static picture_t *FilterPacked( filter_t *, picture_t * );
57 static int AdjustCallback( vlc_object_t *p_this, char const *psz_var,
58 vlc_value_t oldval, vlc_value_t newval,
61 /*****************************************************************************
63 *****************************************************************************/
65 #define THRES_TEXT N_("Brightness threshold")
66 #define THRES_LONGTEXT N_("When this mode is enabled, pixels will be " \
67 "shown as black or white. The threshold value will be the brighness " \
69 #define CONT_TEXT N_("Image contrast (0-2)")
70 #define CONT_LONGTEXT N_("Set the image contrast, between 0 and 2. Defaults to 1.")
71 #define HUE_TEXT N_("Image hue (0-360)")
72 #define HUE_LONGTEXT N_("Set the image hue, between 0 and 360. Defaults to 0.")
73 #define SAT_TEXT N_("Image saturation (0-3)")
74 #define SAT_LONGTEXT N_("Set the image saturation, between 0 and 3. Defaults to 1.")
75 #define LUM_TEXT N_("Image brightness (0-2)")
76 #define LUM_LONGTEXT N_("Set the image brightness, between 0 and 2. Defaults to 1.")
77 #define GAMMA_TEXT N_("Image gamma (0-10)")
78 #define GAMMA_LONGTEXT N_("Set the image gamma, between 0.01 and 10. Defaults to 1.")
81 set_description( N_("Image properties filter") );
82 set_shortname( N_("Image adjust" ));
83 set_category( CAT_VIDEO );
84 set_subcategory( SUBCAT_VIDEO_VFILTER );
85 set_capability( "video filter2", 0 );
87 add_float_with_range( "contrast", 1.0, 0.0, 2.0, NULL,
88 CONT_TEXT, CONT_LONGTEXT, false );
89 add_float_with_range( "brightness", 1.0, 0.0, 2.0, NULL,
90 LUM_TEXT, LUM_LONGTEXT, false );
91 add_integer_with_range( "hue", 0, 0, 360, NULL,
92 HUE_TEXT, HUE_LONGTEXT, false );
93 add_float_with_range( "saturation", 1.0, 0.0, 3.0, NULL,
94 SAT_TEXT, SAT_LONGTEXT, false );
95 add_float_with_range( "gamma", 1.0, 0.01, 10.0, NULL,
96 GAMMA_TEXT, GAMMA_LONGTEXT, false );
98 add_bool( "brightness-threshold", 0, NULL,
99 THRES_TEXT, THRES_LONGTEXT, false );
101 add_shortcut( "adjust" );
102 set_callbacks( Create, Destroy );
105 static const char *ppsz_filter_options[] = {
106 "contrast", "brightness", "hue", "saturation", "gamma",
107 "brightness-threshold", NULL
110 /*****************************************************************************
111 * filter_sys_t: adjust filter method descriptor
112 *****************************************************************************/
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 (%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 msg_Err( p_filter, "out of memory" );
162 p_sys = p_filter->p_sys;
164 /* needed to get options passed in transcode using the
165 * adjust{name=value} syntax */
166 config_ChainParse( p_filter, "", ppsz_filter_options,
169 p_sys->f_contrast = var_CreateGetFloatCommand( p_filter, "contrast" );
170 p_sys->f_brightness = var_CreateGetFloatCommand( p_filter, "brightness" );
171 p_sys->i_hue = var_CreateGetIntegerCommand( p_filter, "hue" );
172 p_sys->f_saturation = var_CreateGetFloatCommand( p_filter, "saturation" );
173 p_sys->f_gamma = var_CreateGetFloatCommand( p_filter, "gamma" );
174 p_sys->b_brightness_threshold =
175 var_CreateGetBoolCommand( p_filter, "brightness-threshold" );
177 var_AddCallback( p_filter, "contrast", AdjustCallback, p_sys );
178 var_AddCallback( p_filter, "brightness", AdjustCallback, p_sys );
179 var_AddCallback( p_filter, "hue", AdjustCallback, p_sys );
180 var_AddCallback( p_filter, "saturation", AdjustCallback, p_sys );
181 var_AddCallback( p_filter, "gamma", AdjustCallback, p_sys );
182 var_AddCallback( p_filter, "brightness-threshold",
183 AdjustCallback, p_sys );
188 /*****************************************************************************
189 * Destroy: destroy adjust video filter
190 *****************************************************************************/
191 static void Destroy( vlc_object_t *p_this )
193 filter_t *p_filter = (filter_t *)p_this;
194 free( p_filter->p_sys );
197 /*****************************************************************************
198 * Run the filter on a Planar YUV picture
199 *****************************************************************************/
200 static picture_t *FilterPlanar( filter_t *p_filter, picture_t *p_pic )
206 uint8_t *p_in, *p_in_v, *p_in_end, *p_line_end;
207 uint8_t *p_out, *p_out_v;
212 int32_t i_cont, i_lum;
213 int i_sat, i_sin, i_cos, i_x, i_y;
216 filter_sys_t *p_sys = p_filter->p_sys;
218 if( !p_pic ) return NULL;
220 p_outpic = p_filter->pf_vout_buffer_new( p_filter );
223 msg_Warn( p_filter, "can't get output picture" );
224 if( p_pic->pf_release )
225 p_pic->pf_release( p_pic );
230 i_cont = (int)( p_sys->f_contrast * 255 );
231 i_lum = (int)( (p_sys->f_brightness - 1.0)*255 );
232 f_hue = (float)( p_sys->i_hue * M_PI / 180 );
233 i_sat = (int)( p_sys->f_saturation * 256 );
234 f_gamma = 1.0 / p_sys->f_gamma;
235 b_thres = p_sys->b_brightness_threshold;
238 * Threshold mode drops out everything about luma, contrast and gamma.
240 if( b_thres != true )
243 /* Contrast is a fast but kludged function, so I put this gap to be
245 i_lum += 128 - i_cont / 2;
247 /* Fill the gamma lookup table */
248 for( i = 0 ; i < 256 ; i++ )
250 pi_gamma[ i ] = clip_uint8_vlc( pow(i / 255.0, f_gamma) * 255.0);
253 /* Fill the luma lookup table */
254 for( i = 0 ; i < 256 ; i++ )
256 pi_luma[ i ] = pi_gamma[clip_uint8_vlc( i_lum + i_cont * i / 256)];
262 * We get luma as threshold value: the higher it is, the darker is
263 * the image. Should I reverse this?
265 for( i = 0 ; i < 256 ; i++ )
267 pi_luma[ i ] = (i < i_lum) ? 0 : 255;
271 * Desaturates image to avoid that strange yellow halo...
280 p_in = p_pic->p[Y_PLANE].p_pixels;
281 p_in_end = p_in + p_pic->p[Y_PLANE].i_visible_lines
282 * p_pic->p[Y_PLANE].i_pitch - 8;
284 p_out = p_outpic->p[Y_PLANE].p_pixels;
286 for( ; p_in < p_in_end ; )
288 p_line_end = p_in + p_pic->p[Y_PLANE].i_visible_pitch - 8;
290 for( ; p_in < p_line_end ; )
292 /* Do 8 pixels at a time */
293 *p_out++ = pi_luma[ *p_in++ ]; *p_out++ = pi_luma[ *p_in++ ];
294 *p_out++ = pi_luma[ *p_in++ ]; *p_out++ = pi_luma[ *p_in++ ];
295 *p_out++ = pi_luma[ *p_in++ ]; *p_out++ = pi_luma[ *p_in++ ];
296 *p_out++ = pi_luma[ *p_in++ ]; *p_out++ = pi_luma[ *p_in++ ];
301 for( ; p_in < p_line_end ; )
303 *p_out++ = pi_luma[ *p_in++ ];
306 p_in += p_pic->p[Y_PLANE].i_pitch
307 - p_pic->p[Y_PLANE].i_visible_pitch;
308 p_out += p_outpic->p[Y_PLANE].i_pitch
309 - p_outpic->p[Y_PLANE].i_visible_pitch;
313 * Do the U and V planes
316 p_in = p_pic->p[U_PLANE].p_pixels;
317 p_in_v = p_pic->p[V_PLANE].p_pixels;
318 p_in_end = p_in + p_pic->p[U_PLANE].i_visible_lines
319 * p_pic->p[U_PLANE].i_pitch - 8;
321 p_out = p_outpic->p[U_PLANE].p_pixels;
322 p_out_v = p_outpic->p[V_PLANE].p_pixels;
324 i_sin = sin(f_hue) * 256;
325 i_cos = cos(f_hue) * 256;
327 i_x = ( cos(f_hue) + sin(f_hue) ) * 32768;
328 i_y = ( cos(f_hue) - sin(f_hue) ) * 32768;
332 #define WRITE_UV_CLIP() \
333 i_u = *p_in++ ; i_v = *p_in_v++ ; \
334 *p_out++ = clip_uint8_vlc( (( ((i_u * i_cos + i_v * i_sin - i_x) >> 8) \
335 * i_sat) >> 8) + 128); \
336 *p_out_v++ = clip_uint8_vlc( (( ((i_v * i_cos - i_u * i_sin - i_y) >> 8) \
337 * i_sat) >> 8) + 128)
341 for( ; p_in < p_in_end ; )
343 p_line_end = p_in + p_pic->p[U_PLANE].i_visible_pitch - 8;
345 for( ; p_in < p_line_end ; )
347 /* Do 8 pixels at a time */
348 WRITE_UV_CLIP(); WRITE_UV_CLIP();
349 WRITE_UV_CLIP(); WRITE_UV_CLIP();
350 WRITE_UV_CLIP(); WRITE_UV_CLIP();
351 WRITE_UV_CLIP(); WRITE_UV_CLIP();
356 for( ; p_in < p_line_end ; )
361 p_in += p_pic->p[U_PLANE].i_pitch
362 - p_pic->p[U_PLANE].i_visible_pitch;
363 p_in_v += p_pic->p[V_PLANE].i_pitch
364 - p_pic->p[V_PLANE].i_visible_pitch;
365 p_out += p_outpic->p[U_PLANE].i_pitch
366 - p_outpic->p[U_PLANE].i_visible_pitch;
367 p_out_v += p_outpic->p[V_PLANE].i_pitch
368 - p_outpic->p[V_PLANE].i_visible_pitch;
375 i_u = *p_in++ ; i_v = *p_in_v++ ; \
376 *p_out++ = (( ((i_u * i_cos + i_v * i_sin - i_x) >> 8) \
377 * i_sat) >> 8) + 128; \
378 *p_out_v++ = (( ((i_v * i_cos - i_u * i_sin - i_y) >> 8) \
383 for( ; p_in < p_in_end ; )
385 p_line_end = p_in + p_pic->p[U_PLANE].i_visible_pitch - 8;
387 for( ; p_in < p_line_end ; )
389 /* Do 8 pixels at a time */
390 WRITE_UV(); WRITE_UV(); WRITE_UV(); WRITE_UV();
391 WRITE_UV(); WRITE_UV(); WRITE_UV(); WRITE_UV();
396 for( ; p_in < p_line_end ; )
401 p_in += p_pic->p[U_PLANE].i_pitch
402 - p_pic->p[U_PLANE].i_visible_pitch;
403 p_in_v += p_pic->p[V_PLANE].i_pitch
404 - p_pic->p[V_PLANE].i_visible_pitch;
405 p_out += p_outpic->p[U_PLANE].i_pitch
406 - p_outpic->p[U_PLANE].i_visible_pitch;
407 p_out_v += p_outpic->p[V_PLANE].i_pitch
408 - p_outpic->p[V_PLANE].i_visible_pitch;
413 p_outpic->date = p_pic->date;
414 p_outpic->b_force = p_pic->b_force;
415 p_outpic->i_nb_fields = p_pic->i_nb_fields;
416 p_outpic->b_progressive = p_pic->b_progressive;
417 p_outpic->b_top_field_first = p_pic->b_top_field_first;
419 if( p_pic->pf_release )
420 p_pic->pf_release( 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 (%4s)",
460 (char*)&(p_pic->format.i_chroma) );
461 if( p_pic->pf_release )
462 p_pic->pf_release( p_pic );
466 p_outpic = p_filter->pf_vout_buffer_new( p_filter );
469 msg_Warn( p_filter, "can't get output picture" );
470 if( p_pic->pf_release )
471 p_pic->pf_release( p_pic );
476 i_cont = (int)( p_sys->f_contrast * 255 );
477 i_lum = (int)( (p_sys->f_brightness - 1.0)*255 );
478 f_hue = (float)( p_sys->i_hue * M_PI / 180 );
479 i_sat = (int)( p_sys->f_saturation * 256 );
480 f_gamma = 1.0 / p_sys->f_gamma;
481 b_thres = p_sys->b_brightness_threshold;
484 * Threshold mode drops out everything about luma, contrast and gamma.
486 if( b_thres != true )
489 /* Contrast is a fast but kludged function, so I put this gap to be
491 i_lum += 128 - i_cont / 2;
493 /* Fill the gamma lookup table */
494 for( i = 0 ; i < 256 ; i++ )
496 pi_gamma[ i ] = clip_uint8_vlc( pow(i / 255.0, f_gamma) * 255.0);
499 /* Fill the luma lookup table */
500 for( i = 0 ; i < 256 ; i++ )
502 pi_luma[ i ] = pi_gamma[clip_uint8_vlc( i_lum + i_cont * i / 256)];
508 * We get luma as threshold value: the higher it is, the darker is
509 * the image. Should I reverse this?
511 for( i = 0 ; i < 256 ; i++ )
513 pi_luma[ i ] = (i < i_lum) ? 0 : 255;
517 * Desaturates image to avoid that strange yellow halo...
526 p_in = p_pic->p->p_pixels + i_y_offset;
527 p_in_end = p_in + p_pic->p->i_visible_lines * p_pic->p->i_pitch - 8 * 4;
529 p_out = p_outpic->p->p_pixels + i_y_offset;
531 for( ; p_in < p_in_end ; )
533 p_line_end = p_in + i_visible_pitch - 8 * 4;
535 for( ; p_in < p_line_end ; )
537 /* Do 8 pixels at a time */
538 *p_out = pi_luma[ *p_in ]; p_in += 2; p_out += 2;
539 *p_out = pi_luma[ *p_in ]; p_in += 2; p_out += 2;
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;
550 for( ; p_in < p_line_end ; )
552 *p_out = pi_luma[ *p_in ]; p_in += 2; p_out += 2;
555 p_in += i_pitch - p_pic->p->i_visible_pitch;
556 p_out += i_pitch - p_outpic->p->i_visible_pitch;
560 * Do the U and V planes
563 p_in = p_pic->p->p_pixels + i_u_offset;
564 p_in_v = p_pic->p->p_pixels + i_v_offset;
565 p_in_end = p_in + i_visible_lines * i_pitch - 8 * 4;
567 p_out = p_outpic->p->p_pixels + i_u_offset;
568 p_out_v = p_outpic->p->p_pixels + i_v_offset;
570 i_sin = sin(f_hue) * 256;
571 i_cos = cos(f_hue) * 256;
573 i_x = ( cos(f_hue) + sin(f_hue) ) * 32768;
574 i_y = ( cos(f_hue) - sin(f_hue) ) * 32768;
578 #define WRITE_UV_CLIP() \
579 i_u = *p_in; p_in += 4; i_v = *p_in_v; p_in_v += 4; \
580 *p_out = clip_uint8_vlc( (( ((i_u * i_cos + i_v * i_sin - i_x) >> 8) \
581 * i_sat) >> 8) + 128); \
583 *p_out_v = clip_uint8_vlc( (( ((i_v * i_cos - i_u * i_sin - i_y) >> 8) \
584 * i_sat) >> 8) + 128); \
589 for( ; p_in < p_in_end ; )
591 p_line_end = p_in + i_visible_pitch - 8 * 4;
593 for( ; p_in < p_line_end ; )
595 /* Do 8 pixels at a time */
596 WRITE_UV_CLIP(); WRITE_UV_CLIP();
597 WRITE_UV_CLIP(); WRITE_UV_CLIP();
598 WRITE_UV_CLIP(); WRITE_UV_CLIP();
599 WRITE_UV_CLIP(); WRITE_UV_CLIP();
604 for( ; p_in < p_line_end ; )
609 p_in += i_pitch - i_visible_pitch;
610 p_in_v += i_pitch - i_visible_pitch;
611 p_out += i_pitch - i_visible_pitch;
612 p_out_v += i_pitch - i_visible_pitch;
619 i_u = *p_in; p_in += 4; i_v = *p_in_v; p_in_v += 4; \
620 *p_out = (( ((i_u * i_cos + i_v * i_sin - i_x) >> 8) \
621 * i_sat) >> 8) + 128; \
623 *p_out_v = (( ((i_v * i_cos - i_u * i_sin - i_y) >> 8) \
624 * i_sat) >> 8) + 128; \
629 for( ; p_in < p_in_end ; )
631 p_line_end = p_in + i_visible_pitch - 8 * 4;
633 for( ; p_in < p_line_end ; )
635 /* Do 8 pixels at a time */
636 WRITE_UV(); WRITE_UV(); WRITE_UV(); WRITE_UV();
637 WRITE_UV(); WRITE_UV(); WRITE_UV(); WRITE_UV();
642 for( ; p_in < p_line_end ; )
647 p_in += i_pitch - i_visible_pitch;
648 p_in_v += i_pitch - i_visible_pitch;
649 p_out += i_pitch - i_visible_pitch;
650 p_out_v += i_pitch - i_visible_pitch;
655 p_outpic->date = p_pic->date;
656 p_outpic->b_force = p_pic->b_force;
657 p_outpic->i_nb_fields = p_pic->i_nb_fields;
658 p_outpic->b_progressive = p_pic->b_progressive;
659 p_outpic->b_top_field_first = p_pic->b_top_field_first;
661 if( p_pic->pf_release )
662 p_pic->pf_release( p_pic );
667 static int AdjustCallback( vlc_object_t *p_this, char const *psz_var,
668 vlc_value_t oldval, vlc_value_t newval,
671 VLC_UNUSED(p_this); VLC_UNUSED(oldval);
672 filter_sys_t *p_sys = (filter_sys_t *)p_data;
674 if( !strcmp( psz_var, "contrast" ) )
675 p_sys->f_contrast = newval.f_float;
676 else if( !strcmp( psz_var, "brightness" ) )
677 p_sys->f_brightness = newval.f_float;
678 else if( !strcmp( psz_var, "hue" ) )
679 p_sys->i_hue = newval.i_int;
680 else if( !strcmp( psz_var, "saturation" ) )
681 p_sys->f_saturation = newval.f_float;
682 else if( !strcmp( psz_var, "gamma" ) )
683 p_sys->f_gamma = newval.f_float;
684 else if( !strcmp( psz_var, "brightness-threshold" ) )
685 p_sys->b_brightness_threshold = newval.b_bool;