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 VideoLAN
   5  * $Id: adjust.c,v 1.17 2004/01/25 20:05:28 hartman Exp $
   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., 59 Temple Place - Suite 330, Boston, MA  02111, 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 CONT_TEXT N_("Image contrast (0-2)")
  61 #define CONT_LONGTEXT N_("Set the image contrast, between 0 and 2. Defaults to 1")
  62 #define HUE_TEXT N_("Image hue (0-360)")
  63 #define HUE_LONGTEXT N_("Set the image hue, between 0 and 360. Defaults to 0")
  64 #define SAT_TEXT N_("Image saturation (0-3)")
  65 #define SAT_LONGTEXT N_("Set the image saturation, between 0 and 3. Defaults to 1")
  66 #define LUM_TEXT N_("Image brightness (0-2)")
  67 #define LUM_LONGTEXT N_("Set the image brightness, between 0 and 2. Defaults to 1")
  68 #define GAMMA_TEXT N_("Image gamma (0-10)")
  69 #define GAMMA_LONGTEXT N_("Set the image gamma, between 0.01 and 10. Defaults to 1")
  70
  71
  72 vlc_module_begin();
  73     set_description( _("Image properties filter") );
  74     set_capability( "video filter", 0 );
  75
  76     add_float_with_range( "contrast", 1.0, 0.0, 2.0, NULL, CONT_TEXT, CONT_LONGTEXT, VLC_FALSE );
  77     add_float_with_range( "brightness", 1.0, 0.0, 2.0, NULL, LUM_TEXT, LUM_LONGTEXT, VLC_FALSE );
  78     add_integer_with_range( "hue", 0, 0, 360, NULL, HUE_TEXT, HUE_LONGTEXT, VLC_FALSE );
  79     add_float_with_range( "saturation", 1.0, 0.0, 3.0, NULL, SAT_TEXT, SAT_LONGTEXT, VLC_FALSE );
  80     add_float_with_range( "gamma", 1.0, 0.01, 10.0, NULL, GAMMA_TEXT, GAMMA_LONGTEXT, VLC_FALSE );
  81
  82     add_shortcut( "adjust" );
  83     set_callbacks( Create, Destroy );
  84 vlc_module_end();
  85
  86 /*****************************************************************************
  87  * vout_sys_t: adjust video output method descriptor
  88  *****************************************************************************
  89  * This structure is part of the video output thread descriptor.
  90  * It describes the adjust specific properties of an output thread.
  91  *****************************************************************************/
  92 struct vout_sys_t
  93 {
  94     vout_thread_t *p_vout;
  95 };
  96
  97 inline static int32_t clip( int32_t a )
  98 {
  99     return (a > 255) ? 255 : (a < 0) ? 0 : a;
 100 }
 101
 102 /*****************************************************************************
 103  * Create: allocates adjust video thread output method
 104  *****************************************************************************
 105  * This function allocates and initializes a adjust vout method.
 106  *****************************************************************************/
 107 static int Create( vlc_object_t *p_this )
 108 {
 109     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 110
 111     /* Allocate structure */
 112     p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
 113     if( p_vout->p_sys == NULL )
 114     {
 115         msg_Err( p_vout, "out of memory" );
 116         return VLC_ENOMEM;
 117     }
 118
 119     p_vout->pf_init = Init;
 120     p_vout->pf_end = End;
 121     p_vout->pf_manage = NULL;
 122     p_vout->pf_render = Render;
 123     p_vout->pf_display = NULL;
 124
 125     var_Create( p_vout, "contrast", VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
 126     var_Create( p_vout, "brightness", VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
 127     var_Create( p_vout, "hue", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 128     var_Create( p_vout, "saturation", VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
 129     var_Create( p_vout, "gamma", VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
 130
 131     return VLC_SUCCESS;
 132 }
 133
 134 /*****************************************************************************
 135  * Init: initialize adjust video thread output method
 136  *****************************************************************************/
 137 static int Init( vout_thread_t *p_vout )
 138 {
 139     int i_index;
 140     picture_t *p_pic;
 141
 142     I_OUTPUTPICTURES = 0;
 143
 144     /* Initialize the output structure */
 145     p_vout->output.i_chroma = p_vout->render.i_chroma;
 146     p_vout->output.i_width  = p_vout->render.i_width;
 147     p_vout->output.i_height = p_vout->render.i_height;
 148     p_vout->output.i_aspect = p_vout->render.i_aspect;
 149
 150     /* Try to open the real video output */
 151     msg_Dbg( p_vout, "spawning the real video output" );
 152
 153     p_vout->p_sys->p_vout = vout_Create( p_vout,
 154                      p_vout->render.i_width, p_vout->render.i_height,
 155                      p_vout->render.i_chroma, p_vout->render.i_aspect );
 156
 157     /* Everything failed */
 158     if( p_vout->p_sys->p_vout == NULL )
 159     {
 160         msg_Err( p_vout, "can't open vout, aborting" );
 161
 162         return VLC_EGENERIC;
 163     }
 164
 165     ALLOCATE_DIRECTBUFFERS( VOUT_MAX_PICTURES );
 166
 167     ADD_CALLBACKS( p_vout->p_sys->p_vout, SendEvents );
 168
 169     ADD_PARENT_CALLBACKS( SendEventsToChild );
 170
 171     return VLC_SUCCESS;
 172 }
 173
 174 /*****************************************************************************
 175  * End: terminate adjust video thread output method
 176  *****************************************************************************/
 177 static void End( vout_thread_t *p_vout )
 178 {
 179     int i_index;
 180
 181     /* Free the fake output buffers we allocated */
 182     for( i_index = I_OUTPUTPICTURES ; i_index ; )
 183     {
 184         i_index--;
 185         free( PP_OUTPUTPICTURE[ i_index ]->p_data_orig );
 186     }
 187 }
 188
 189 /*****************************************************************************
 190  * Destroy: destroy adjust video thread output method
 191  *****************************************************************************
 192  * Terminate an output method created by adjustCreateOutputMethod
 193  *****************************************************************************/
 194 static void Destroy( vlc_object_t *p_this )
 195 {
 196     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 197
 198     DEL_CALLBACKS( p_vout->p_sys->p_vout, SendEvents );
 199     vlc_object_detach( p_vout->p_sys->p_vout );
 200     vout_Destroy( p_vout->p_sys->p_vout );
 201
 202     DEL_PARENT_CALLBACKS( SendEventsToChild );
 203
 204     free( p_vout->p_sys );
 205 }
 206
 207 /*****************************************************************************
 208  * Render: displays previously rendered output
 209  *****************************************************************************
 210  * This function send the currently rendered image to adjust modified image,
 211  * waits until it is displayed and switch the two rendering buffers, preparing
 212  * next frame.
 213  *****************************************************************************/
 214 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
 215 {
 216     int pi_luma[256];
 217     int pi_gamma[256];
 218
 219     picture_t *p_outpic;
 220     uint8_t *p_in, *p_in_v, *p_in_end, *p_line_end;
 221     uint8_t *p_out, *p_out_v;
 222
 223     double  f_hue;
 224     double  f_gamma;
 225     int32_t i_cont, i_lum;
 226     int i_sat, i_sin, i_cos, i_x, i_y;
 227     int i;
 228     vlc_value_t val;
 229
 230     /* This is a new frame. Get a structure from the video_output. */
 231     while( ( p_outpic = vout_CreatePicture( p_vout->p_sys->p_vout, 0, 0, 0 ) )
 232               == NULL )
 233     {
 234         if( p_vout->b_die || p_vout->b_error )
 235         {
 236             return;
 237         }
 238         msleep( VOUT_OUTMEM_SLEEP );
 239     }
 240
 241     vout_DatePicture( p_vout->p_sys->p_vout, p_outpic, p_pic->date );
 242     vout_LinkPicture( p_vout->p_sys->p_vout, p_outpic );
 243
 244     /* Getvariables */
 245     var_Get( p_vout, "contrast", &val );
 246     i_cont = (int) ( val.f_float * 255 );
 247     var_Get( p_vout, "brightness", &val );
 248     i_lum = (int) (( val.f_float - 1.0 ) * 255 );
 249     var_Get( p_vout, "hue", &val );
 250     f_hue = (float) ( val.i_int * M_PI / 180 );
 251     var_Get( p_vout, "saturation", &val );
 252     i_sat = (int) (val.f_float * 256 );
 253     var_Get( p_vout, "gamma", &val );
 254     f_gamma = 1.0 / val.f_float;
 255
 256     /* Contrast is a fast but kludged function, so I put this gap to be
 257      * cleaner :) */
 258     i_lum += 128 - i_cont / 2;
 259
 260     /* Fill the gamma lookup table */
 261     for( i = 0 ; i < 256 ; i++ )
 262     {
 263       pi_gamma[ i ] = clip( pow(i / 255.0, f_gamma) * 255.0);
 264     }
 265
 266     /* Fill the luma lookup table */
 267     for( i = 0 ; i < 256 ; i++ )
 268     {
 269         pi_luma[ i ] = pi_gamma[clip( i_lum + i_cont * i / 256)];
 270     }
 271
 272     /*
 273      * Do the Y plane
 274      */
 275
 276     p_in = p_pic->p[0].p_pixels;
 277     p_in_end = p_in + p_pic->p[0].i_lines * p_pic->p[0].i_pitch - 8;
 278
 279     p_out = p_outpic->p[0].p_pixels;
 280
 281     for( ; p_in < p_in_end ; )
 282     {
 283         p_line_end = p_in + p_pic->p[0].i_visible_pitch - 8;
 284
 285         for( ; p_in < p_line_end ; )
 286         {
 287             /* Do 8 pixels at a time */
 288             *p_out++ = pi_luma[ *p_in++ ]; *p_out++ = pi_luma[ *p_in++ ];
 289             *p_out++ = pi_luma[ *p_in++ ]; *p_out++ = pi_luma[ *p_in++ ];
 290             *p_out++ = pi_luma[ *p_in++ ]; *p_out++ = pi_luma[ *p_in++ ];
 291             *p_out++ = pi_luma[ *p_in++ ]; *p_out++ = pi_luma[ *p_in++ ];
 292         }
 293
 294         p_line_end += 8;
 295
 296         for( ; p_in < p_line_end ; )
 297         {
 298             *p_out++ = pi_luma[ *p_in++ ];
 299         }
 300
 301         p_in += p_pic->p[0].i_pitch - p_pic->p[0].i_visible_pitch;
 302         p_out += p_outpic->p[0].i_pitch - p_outpic->p[0].i_visible_pitch;
 303     }
 304
 305     /*
 306      * Do the U and V planes
 307      */
 308
 309     p_in = p_pic->p[1].p_pixels;
 310     p_in_v = p_pic->p[2].p_pixels;
 311     p_in_end = p_in + p_pic->p[1].i_lines * p_pic->p[1].i_pitch - 8;
 312
 313     p_out = p_outpic->p[1].p_pixels;
 314     p_out_v = p_outpic->p[2].p_pixels;
 315
 316     i_sin = sin(f_hue) * 256;
 317     i_cos = cos(f_hue) * 256;
 318
 319     i_x = ( cos(f_hue) + sin(f_hue) ) * 32768;
 320     i_y = ( cos(f_hue) - sin(f_hue) ) * 32768;
 321
 322     if ( i_sat > 256 )
 323     {
 324 #define WRITE_UV_CLIP() \
 325     i_u = *p_in++ ; i_v = *p_in_v++ ; \
 326     *p_out++ = clip( (( ((i_u * i_cos + i_v * i_sin - i_x) >> 8) \
 327                            * i_sat) >> 8) + 128); \
 328     *p_out_v++ = clip( (( ((i_v * i_cos - i_u * i_sin - i_y) >> 8) \
 329                            * i_sat) >> 8) + 128)
 330
 331         uint8_t i_u, i_v;
 332
 333         for( ; p_in < p_in_end ; )
 334         {
 335             p_line_end = p_in + p_pic->p[1].i_visible_pitch - 8;
 336
 337             for( ; p_in < p_line_end ; )
 338             {
 339                 /* Do 8 pixels at a time */
 340                 WRITE_UV_CLIP(); WRITE_UV_CLIP();
 341                 WRITE_UV_CLIP(); WRITE_UV_CLIP();
 342                 WRITE_UV_CLIP(); WRITE_UV_CLIP();
 343                 WRITE_UV_CLIP(); WRITE_UV_CLIP();
 344             }
 345
 346             p_line_end += 8;
 347
 348             for( ; p_in < p_line_end ; )
 349             {
 350                 WRITE_UV_CLIP();
 351             }
 352
 353             p_in += p_pic->p[1].i_pitch - p_pic->p[1].i_visible_pitch;
 354             p_in_v += p_pic->p[2].i_pitch - p_pic->p[2].i_visible_pitch;
 355             p_out += p_outpic->p[1].i_pitch - p_outpic->p[1].i_visible_pitch;
 356             p_out_v += p_outpic->p[2].i_pitch - p_outpic->p[2].i_visible_pitch;
 357         }
 358     }
 359     else
 360     {
 361 #define WRITE_UV() \
 362     i_u = *p_in++ ; i_v = *p_in_v++ ; \
 363     *p_out++ = (( ((i_u * i_cos + i_v * i_sin - i_x) >> 8) \
 364                        * i_sat) >> 8) + 128; \
 365     *p_out_v++ = (( ((i_v * i_cos - i_u * i_sin - i_y) >> 8) \
 366                        * i_sat) >> 8) + 128
 367
 368         uint8_t i_u, i_v;
 369
 370         for( ; p_in < p_in_end ; )
 371         {
 372             p_line_end = p_in + p_pic->p[1].i_visible_pitch - 8;
 373
 374             for( ; p_in < p_line_end ; )
 375             {
 376                 /* Do 8 pixels at a time */
 377                 WRITE_UV(); WRITE_UV(); WRITE_UV(); WRITE_UV();
 378                 WRITE_UV(); WRITE_UV(); WRITE_UV(); WRITE_UV();
 379             }
 380
 381             p_line_end += 8;
 382
 383             for( ; p_in < p_line_end ; )
 384             {
 385                 WRITE_UV();
 386             }
 387
 388             p_in += p_pic->p[1].i_pitch - p_pic->p[1].i_visible_pitch;
 389             p_in_v += p_pic->p[2].i_pitch - p_pic->p[2].i_visible_pitch;
 390             p_out += p_outpic->p[1].i_pitch - p_outpic->p[1].i_visible_pitch;
 391             p_out_v += p_outpic->p[2].i_pitch - p_outpic->p[2].i_visible_pitch;
 392         }
 393     }
 394
 395     vout_UnlinkPicture( p_vout->p_sys->p_vout, p_outpic );
 396
 397     vout_DisplayPicture( p_vout->p_sys->p_vout, p_outpic );
 398 }
 399
 400 /*****************************************************************************
 401  * SendEvents: forward mouse and keyboard events to the parent p_vout
 402  *****************************************************************************/
 403 static int SendEvents( vlc_object_t *p_this, char const *psz_var,
 404                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
 405 {
 406     var_Set( (vlc_object_t *)p_data, psz_var, newval );
 407
 408     return VLC_SUCCESS;
 409 }
 410
 411 /*****************************************************************************
 412  * SendEventsToChild: forward events to the child/children vout
 413  *****************************************************************************/
 414 static int SendEventsToChild( vlc_object_t *p_this, char const *psz_var,
 415                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
 416 {
 417     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 418     var_Set( p_vout->p_sys->p_vout, psz_var, newval );
 419     return VLC_SUCCESS;
 420 }