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

   1 /*****************************************************************************
   2  * adjust.c : Contrast/Hue/Saturation/Brightness video plugin for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2000, 2001, 2002, 2003 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Simon Latapie <garf@via.ecp.fr>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #include <errno.h>
  28 #include <stdlib.h>                                      /* malloc(), free() */
  29 #include <string.h>
  30 #include <math.h>
  31
  32 #include <vlc/vlc.h>
  33 #include <vlc/vout.h>
  34
  35 #include "filter_common.h"
  36
  37 #ifndef M_PI
  38 #   define M_PI 3.14159265358979323846
  39 #endif
  40
  41 #define eight_times( x )    x x x x x x x x
  42
  43 /*****************************************************************************
  44  * Local prototypes
  45  *****************************************************************************/
  46 static int  Create    ( vlc_object_t * );
  47 static void Destroy   ( vlc_object_t * );
  48
  49 static int  Init      ( vout_thread_t * );
  50 static void End       ( vout_thread_t * );
  51 static void Render    ( vout_thread_t *, picture_t * );
  52
  53 static int  SendEvents( vlc_object_t *, char const *,
  54                         vlc_value_t, vlc_value_t, void * );
  55
  56 /*****************************************************************************
  57  * Module descriptor
  58  *****************************************************************************/
  59
  60 #define THRES_TEXT N_("Enable brightness threshold")
  61 #define THRES_LONGTEXT N_("Show black and white pixels with brightness as threshold value")
  62 #define CONT_TEXT N_("Image contrast (0-2)")
  63 #define CONT_LONGTEXT N_("Set the image contrast, between 0 and 2. Defaults to 1")
  64 #define HUE_TEXT N_("Image hue (0-360)")
  65 #define HUE_LONGTEXT N_("Set the image hue, between 0 and 360. Defaults to 0")
  66 #define SAT_TEXT N_("Image saturation (0-3)")
  67 #define SAT_LONGTEXT N_("Set the image saturation, between 0 and 3. Defaults to 1")
  68 #define LUM_TEXT N_("Image brightness (0-2)")
  69 #define LUM_LONGTEXT N_("Set the image brightness, between 0 and 2. Defaults to 1")
  70 #define GAMMA_TEXT N_("Image gamma (0-10)")
  71 #define GAMMA_LONGTEXT N_("Set the image gamma, between 0.01 and 10. Defaults to 1")
  72
  73
  74 vlc_module_begin();
  75     set_description( _("Image properties filter") );
  76     set_shortname( N_("Image adjust" ));
  77     set_category( CAT_VIDEO );
  78     set_subcategory( SUBCAT_VIDEO_VFILTER );
  79     set_capability( "video filter", 0 );
  80
  81     add_float_with_range( "contrast", 1.0, 0.0, 2.0, NULL,
  82                           CONT_TEXT, CONT_LONGTEXT, VLC_FALSE );
  83     add_float_with_range( "brightness", 1.0, 0.0, 2.0, NULL,
  84                            LUM_TEXT, LUM_LONGTEXT, VLC_FALSE );
  85     add_integer_with_range( "hue", 0, 0, 360, NULL,
  86                             HUE_TEXT, HUE_LONGTEXT, VLC_FALSE );
  87     add_float_with_range( "saturation", 1.0, 0.0, 3.0, NULL,
  88                           SAT_TEXT, SAT_LONGTEXT, VLC_FALSE );
  89     add_float_with_range( "gamma", 1.0, 0.01, 10.0, NULL,
  90                           GAMMA_TEXT, GAMMA_LONGTEXT, VLC_FALSE );
  91
  92     add_bool( "brightness-threshold", 0, NULL,
  93               THRES_TEXT, THRES_LONGTEXT, VLC_FALSE );
  94
  95     add_shortcut( "adjust" );
  96     set_callbacks( Create, Destroy );
  97 vlc_module_end();
  98
  99 /*****************************************************************************
 100  * vout_sys_t: adjust video output method descriptor
 101  *****************************************************************************
 102  * This structure is part of the video output thread descriptor.
 103  * It describes the adjust specific properties of an output thread.
 104  *****************************************************************************/
 105 struct vout_sys_t
 106 {
 107     vout_thread_t *p_vout;
 108 };
 109
 110 inline static int32_t clip( int32_t a )
 111 {
 112     return (a > 255) ? 255 : (a < 0) ? 0 : a;
 113 }
 114
 115 /*****************************************************************************
 116  * Control: control facility for the vout (forwards to child vout)
 117  *****************************************************************************/
 118 static int Control( vout_thread_t *p_vout, int i_query, va_list args )
 119 {
 120     return vout_vaControl( p_vout->p_sys->p_vout, i_query, args );
 121 }
 122
 123 /*****************************************************************************
 124  * Create: allocates adjust video thread output method
 125  *****************************************************************************
 126  * This function allocates and initializes a adjust vout method.
 127  *****************************************************************************/
 128 static int Create( vlc_object_t *p_this )
 129 {
 130     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 131
 132     /* Allocate structure */
 133     p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
 134     if( p_vout->p_sys == NULL )
 135     {
 136         msg_Err( p_vout, "out of memory" );
 137         return VLC_ENOMEM;
 138     }
 139
 140     p_vout->pf_init = Init;
 141     p_vout->pf_end = End;
 142     p_vout->pf_manage = NULL;
 143     p_vout->pf_render = Render;
 144     p_vout->pf_display = NULL;
 145     p_vout->pf_control = Control;
 146
 147     var_Create( p_vout, "contrast", VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
 148     var_Create( p_vout, "brightness", VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
 149     var_Create( p_vout, "hue", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 150     var_Create( p_vout, "saturation", VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
 151     var_Create( p_vout, "gamma", VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
 152     var_Create( p_vout, "brightness-threshold",
 153                 VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
 154
 155     return VLC_SUCCESS;
 156 }
 157
 158 /*****************************************************************************
 159  * Init: initialize adjust video thread output method
 160  *****************************************************************************/
 161 static int Init( vout_thread_t *p_vout )
 162 {
 163     int i_index;
 164     picture_t *p_pic;
 165     video_format_t fmt = {0};
 166
 167     I_OUTPUTPICTURES = 0;
 168
 169     /* Initialize the output structure */
 170     p_vout->output.i_chroma = p_vout->render.i_chroma;
 171     p_vout->output.i_width  = p_vout->render.i_width;
 172     p_vout->output.i_height = p_vout->render.i_height;
 173     p_vout->output.i_aspect = p_vout->render.i_aspect;
 174
 175     fmt.i_width = fmt.i_visible_width = p_vout->render.i_width;
 176     fmt.i_height = fmt.i_visible_height = p_vout->render.i_height;
 177     fmt.i_x_offset = fmt.i_y_offset = 0;
 178     fmt.i_chroma = p_vout->render.i_chroma;
 179     fmt.i_aspect = p_vout->render.i_aspect;
 180     fmt.i_sar_num = p_vout->render.i_aspect * fmt.i_height / fmt.i_width;
 181     fmt.i_sar_den = VOUT_ASPECT_FACTOR;
 182
 183     /* Try to open the real video output */
 184     msg_Dbg( p_vout, "spawning the real video output" );
 185
 186     p_vout->p_sys->p_vout = vout_Create( p_vout, &fmt );
 187
 188     /* Everything failed */
 189     if( p_vout->p_sys->p_vout == NULL )
 190     {
 191         msg_Err( p_vout, "can't open vout, aborting" );
 192         return VLC_EGENERIC;
 193     }
 194
 195     ALLOCATE_DIRECTBUFFERS( VOUT_MAX_PICTURES );
 196
 197     ADD_CALLBACKS( p_vout->p_sys->p_vout, SendEvents );
 198
 199     ADD_PARENT_CALLBACKS( SendEventsToChild );
 200
 201     return VLC_SUCCESS;
 202 }
 203
 204 /*****************************************************************************
 205  * End: terminate adjust video thread output method
 206  *****************************************************************************/
 207 static void End( vout_thread_t *p_vout )
 208 {
 209     int i_index;
 210
 211     /* Free the fake output buffers we allocated */
 212     for( i_index = I_OUTPUTPICTURES ; i_index ; )
 213     {
 214         i_index--;
 215         free( PP_OUTPUTPICTURE[ i_index ]->p_data_orig );
 216     }
 217 }
 218
 219 /*****************************************************************************
 220  * Destroy: destroy adjust video thread output method
 221  *****************************************************************************
 222  * Terminate an output method created by adjustCreateOutputMethod
 223  *****************************************************************************/
 224 static void Destroy( vlc_object_t *p_this )
 225 {
 226     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 227
 228     if( p_vout->p_sys->p_vout )
 229     {
 230         DEL_CALLBACKS( p_vout->p_sys->p_vout, SendEvents );
 231         vlc_object_detach( p_vout->p_sys->p_vout );
 232         vout_Destroy( p_vout->p_sys->p_vout );
 233     }
 234
 235     DEL_PARENT_CALLBACKS( SendEventsToChild );
 236
 237     free( p_vout->p_sys );
 238 }
 239
 240 /*****************************************************************************
 241  * Render: displays previously rendered output
 242  *****************************************************************************
 243  * This function send the currently rendered image to adjust modified image,
 244  * waits until it is displayed and switch the two rendering buffers, preparing
 245  * next frame.
 246  *****************************************************************************/
 247 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
 248 {
 249     int pi_luma[256];
 250     int pi_gamma[256];
 251
 252     picture_t *p_outpic;
 253     uint8_t *p_in, *p_in_v, *p_in_end, *p_line_end;
 254     uint8_t *p_out, *p_out_v;
 255
 256     vlc_bool_t b_thres;
 257     double  f_hue;
 258     double  f_gamma;
 259     int32_t i_cont, i_lum;
 260     int i_sat, i_sin, i_cos, i_x, i_y;
 261     int i;
 262     vlc_value_t val;
 263
 264     /* This is a new frame. Get a structure from the video_output. */
 265     while( ( p_outpic = vout_CreatePicture( p_vout->p_sys->p_vout, 0, 0, 0 ) )
 266               == NULL )
 267     {
 268         if( p_vout->b_die || p_vout->b_error )
 269         {
 270             return;
 271         }
 272         msleep( VOUT_OUTMEM_SLEEP );
 273     }
 274
 275     vout_DatePicture( p_vout->p_sys->p_vout, p_outpic, p_pic->date );
 276     vout_LinkPicture( p_vout->p_sys->p_vout, p_outpic );
 277
 278     /* Getvariables */
 279     var_Get( p_vout, "contrast", &val );
 280     i_cont = (int) ( val.f_float * 255 );
 281     var_Get( p_vout, "brightness", &val );
 282     i_lum = (int) (( val.f_float - 1.0 ) * 255 );
 283     var_Get( p_vout, "hue", &val );
 284     f_hue = (float) ( val.i_int * M_PI / 180 );
 285     var_Get( p_vout, "saturation", &val );
 286     i_sat = (int) (val.f_float * 256 );
 287     var_Get( p_vout, "gamma", &val );
 288     f_gamma = 1.0 / val.f_float;
 289     var_Get( p_vout, "brightness-threshold", &val );
 290     b_thres = (vlc_bool_t) ( val.b_bool );
 291
 292     /*
 293      * Threshold mode drops out everything about luma, contrast and gamma.
 294      */
 295     if( b_thres != VLC_TRUE )
 296     {
 297
 298         /* Contrast is a fast but kludged function, so I put this gap to be
 299          * cleaner :) */
 300         i_lum += 128 - i_cont / 2;
 301
 302         /* Fill the gamma lookup table */
 303         for( i = 0 ; i < 256 ; i++ )
 304         {
 305           pi_gamma[ i ] = clip( pow(i / 255.0, f_gamma) * 255.0);
 306         }
 307
 308         /* Fill the luma lookup table */
 309         for( i = 0 ; i < 256 ; i++ )
 310         {
 311             pi_luma[ i ] = pi_gamma[clip( i_lum + i_cont * i / 256)];
 312         }
 313     }
 314     else
 315     {
 316         /*
 317          * We get luma as threshold value: the higher it is, the darker is
 318          * the image. Should I reverse this?
 319          */
 320         for( i = 0 ; i < 256 ; i++ )
 321         {
 322             pi_luma[ i ] = (i < i_lum) ? 0 : 255;
 323         }
 324
 325         /*
 326          * Desaturates image to avoid that strange yellow halo...
 327          */
 328         i_sat = 0;
 329     }
 330
 331     /*
 332      * Do the Y plane
 333      */
 334
 335     p_in = p_pic->p[0].p_pixels;
 336     p_in_end = p_in + p_pic->p[0].i_visible_lines * p_pic->p[0].i_pitch - 8;
 337
 338     p_out = p_outpic->p[0].p_pixels;
 339
 340     for( ; p_in < p_in_end ; )
 341     {
 342         p_line_end = p_in + p_pic->p[0].i_visible_pitch - 8;
 343
 344         for( ; p_in < p_line_end ; )
 345         {
 346             /* Do 8 pixels at a time */
 347             *p_out++ = pi_luma[ *p_in++ ]; *p_out++ = pi_luma[ *p_in++ ];
 348             *p_out++ = pi_luma[ *p_in++ ]; *p_out++ = pi_luma[ *p_in++ ];
 349             *p_out++ = pi_luma[ *p_in++ ]; *p_out++ = pi_luma[ *p_in++ ];
 350             *p_out++ = pi_luma[ *p_in++ ]; *p_out++ = pi_luma[ *p_in++ ];
 351         }
 352
 353         p_line_end += 8;
 354
 355         for( ; p_in < p_line_end ; )
 356         {
 357             *p_out++ = pi_luma[ *p_in++ ];
 358         }
 359
 360         p_in += p_pic->p[0].i_pitch - p_pic->p[0].i_visible_pitch;
 361         p_out += p_outpic->p[0].i_pitch - p_outpic->p[0].i_visible_pitch;
 362     }
 363
 364     /*
 365      * Do the U and V planes
 366      */
 367
 368     p_in = p_pic->p[1].p_pixels;
 369     p_in_v = p_pic->p[2].p_pixels;
 370     p_in_end = p_in + p_pic->p[1].i_visible_lines * p_pic->p[1].i_pitch - 8;
 371
 372     p_out = p_outpic->p[1].p_pixels;
 373     p_out_v = p_outpic->p[2].p_pixels;
 374
 375     i_sin = sin(f_hue) * 256;
 376     i_cos = cos(f_hue) * 256;
 377
 378     i_x = ( cos(f_hue) + sin(f_hue) ) * 32768;
 379     i_y = ( cos(f_hue) - sin(f_hue) ) * 32768;
 380
 381     if ( i_sat > 256 )
 382     {
 383 #define WRITE_UV_CLIP() \
 384     i_u = *p_in++ ; i_v = *p_in_v++ ; \
 385     *p_out++ = clip( (( ((i_u * i_cos + i_v * i_sin - i_x) >> 8) \
 386                            * i_sat) >> 8) + 128); \
 387     *p_out_v++ = clip( (( ((i_v * i_cos - i_u * i_sin - i_y) >> 8) \
 388                            * i_sat) >> 8) + 128)
 389
 390         uint8_t i_u, i_v;
 391
 392         for( ; p_in < p_in_end ; )
 393         {
 394             p_line_end = p_in + p_pic->p[1].i_visible_pitch - 8;
 395
 396             for( ; p_in < p_line_end ; )
 397             {
 398                 /* Do 8 pixels at a time */
 399                 WRITE_UV_CLIP(); WRITE_UV_CLIP();
 400                 WRITE_UV_CLIP(); WRITE_UV_CLIP();
 401                 WRITE_UV_CLIP(); WRITE_UV_CLIP();
 402                 WRITE_UV_CLIP(); WRITE_UV_CLIP();
 403             }
 404
 405             p_line_end += 8;
 406
 407             for( ; p_in < p_line_end ; )
 408             {
 409                 WRITE_UV_CLIP();
 410             }
 411
 412             p_in += p_pic->p[1].i_pitch - p_pic->p[1].i_visible_pitch;
 413             p_in_v += p_pic->p[2].i_pitch - p_pic->p[2].i_visible_pitch;
 414             p_out += p_outpic->p[1].i_pitch - p_outpic->p[1].i_visible_pitch;
 415             p_out_v += p_outpic->p[2].i_pitch - p_outpic->p[2].i_visible_pitch;
 416         }
 417     }
 418     else
 419     {
 420 #define WRITE_UV() \
 421     i_u = *p_in++ ; i_v = *p_in_v++ ; \
 422     *p_out++ = (( ((i_u * i_cos + i_v * i_sin - i_x) >> 8) \
 423                        * i_sat) >> 8) + 128; \
 424     *p_out_v++ = (( ((i_v * i_cos - i_u * i_sin - i_y) >> 8) \
 425                        * i_sat) >> 8) + 128
 426
 427         uint8_t i_u, i_v;
 428
 429         for( ; p_in < p_in_end ; )
 430         {
 431             p_line_end = p_in + p_pic->p[1].i_visible_pitch - 8;
 432
 433             for( ; p_in < p_line_end ; )
 434             {
 435                 /* Do 8 pixels at a time */
 436                 WRITE_UV(); WRITE_UV(); WRITE_UV(); WRITE_UV();
 437                 WRITE_UV(); WRITE_UV(); WRITE_UV(); WRITE_UV();
 438             }
 439
 440             p_line_end += 8;
 441
 442             for( ; p_in < p_line_end ; )
 443             {
 444                 WRITE_UV();
 445             }
 446
 447             p_in += p_pic->p[1].i_pitch - p_pic->p[1].i_visible_pitch;
 448             p_in_v += p_pic->p[2].i_pitch - p_pic->p[2].i_visible_pitch;
 449             p_out += p_outpic->p[1].i_pitch - p_outpic->p[1].i_visible_pitch;
 450             p_out_v += p_outpic->p[2].i_pitch - p_outpic->p[2].i_visible_pitch;
 451         }
 452     }
 453
 454     vout_UnlinkPicture( p_vout->p_sys->p_vout, p_outpic );
 455
 456     vout_DisplayPicture( p_vout->p_sys->p_vout, p_outpic );
 457 }
 458
 459 /*****************************************************************************
 460  * SendEvents: forward mouse and keyboard events to the parent p_vout
 461  *****************************************************************************/
 462 static int SendEvents( vlc_object_t *p_this, char const *psz_var,
 463                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
 464 {
 465     var_Set( (vlc_object_t *)p_data, psz_var, newval );
 466
 467     return VLC_SUCCESS;
 468 }
 469
 470 /*****************************************************************************
 471  * SendEventsToChild: forward events to the child/children vout
 472  *****************************************************************************/
 473 static int SendEventsToChild( vlc_object_t *p_this, char const *psz_var,
 474                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
 475 {
 476     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 477     var_Set( p_vout->p_sys->p_vout, psz_var, newval );
 478     return VLC_SUCCESS;
 479 }