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

   1 /*****************************************************************************
   2  * distort.c : Misc video effects plugin for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2000, 2001, 2002, 2003 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   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 <stdlib.h>                                      /* malloc(), free() */
  28 #include <string.h>
  29
  30 #include <math.h>                                            /* sin(), cos() */
  31
  32 #include <vlc/vlc.h>
  33 #include <vlc/vout.h>
  34
  35 #include "filter_common.h"
  36
  37 #define DISTORT_MODE_WAVE    1
  38 #define DISTORT_MODE_RIPPLE  2
  39
  40 /*****************************************************************************
  41  * Local prototypes
  42  *****************************************************************************/
  43 static int  Create    ( vlc_object_t * );
  44 static void Destroy   ( vlc_object_t * );
  45
  46 static int  Init      ( vout_thread_t * );
  47 static void End       ( vout_thread_t * );
  48 static void Render    ( vout_thread_t *, picture_t * );
  49
  50 static void DistortWave    ( vout_thread_t *, picture_t *, picture_t * );
  51 static void DistortRipple  ( vout_thread_t *, picture_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 #define MODE_TEXT N_("Distort mode")
  60 #define MODE_LONGTEXT N_("Distort mode, one of \"wave\" and \"ripple\"")
  61
  62 static char *mode_list[] = { "wave", "ripple" };
  63 static char *mode_list_text[] = { N_("Wave"), N_("Ripple") };
  64
  65 vlc_module_begin();
  66     set_description( _("Distort video filter") );
  67     set_shortname( N_( "Distortion" ));
  68     set_capability( "video filter", 0 );
  69     set_category( CAT_VIDEO );
  70     set_subcategory( SUBCAT_VIDEO_VFILTER );
  71
  72     add_string( "distort-mode", "wave", NULL, MODE_TEXT, MODE_LONGTEXT,
  73                 VLC_FALSE );
  74         change_string_list( mode_list, mode_list_text, 0 );
  75
  76     add_shortcut( "distort" );
  77     set_callbacks( Create, Destroy );
  78 vlc_module_end();
  79
  80 /*****************************************************************************
  81  * vout_sys_t: Distort video output method descriptor
  82  *****************************************************************************
  83  * This structure is part of the video output thread descriptor.
  84  * It describes the Distort specific properties of an output thread.
  85  *****************************************************************************/
  86 struct vout_sys_t
  87 {
  88     int i_mode;
  89     vout_thread_t *p_vout;
  90
  91     /* For the wave mode */
  92     double  f_angle;
  93     mtime_t last_date;
  94 };
  95
  96 /*****************************************************************************
  97  * Control: control facility for the vout (forwards to child vout)
  98  *****************************************************************************/
  99 static int Control( vout_thread_t *p_vout, int i_query, va_list args )
 100 {
 101     return vout_vaControl( p_vout->p_sys->p_vout, i_query, args );
 102 }
 103
 104 /*****************************************************************************
 105  * Create: allocates Distort video thread output method
 106  *****************************************************************************
 107  * This function allocates and initializes a Distort vout method.
 108  *****************************************************************************/
 109 static int Create( vlc_object_t *p_this )
 110 {
 111     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 112     char *psz_method, *psz_method_tmp;
 113
 114     /* Allocate structure */
 115     p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
 116     if( p_vout->p_sys == NULL )
 117     {
 118         msg_Err( p_vout, "out of memory" );
 119         return VLC_ENOMEM;
 120     }
 121
 122     p_vout->pf_init = Init;
 123     p_vout->pf_end = End;
 124     p_vout->pf_manage = NULL;
 125     p_vout->pf_render = Render;
 126     p_vout->pf_display = NULL;
 127     p_vout->pf_control = Control;
 128
 129     p_vout->p_sys->i_mode = 0;
 130
 131     if( !(psz_method = psz_method_tmp
 132           = config_GetPsz( p_vout, "distort-mode" )) )
 133     {
 134         msg_Err( p_vout, "configuration variable %s empty, using 'wave'",
 135                          "distort-mode" );
 136         p_vout->p_sys->i_mode = DISTORT_MODE_WAVE;
 137     }
 138     else
 139     {
 140
 141         if( !strcmp( psz_method, "wave" ) )
 142         {
 143             p_vout->p_sys->i_mode = DISTORT_MODE_WAVE;
 144         }
 145         else if( !strcmp( psz_method, "ripple" ) )
 146         {
 147             p_vout->p_sys->i_mode = DISTORT_MODE_RIPPLE;
 148         }
 149         else
 150         {
 151             msg_Err( p_vout, "no valid distort mode provided, "
 152                              "using wave" );
 153             p_vout->p_sys->i_mode = DISTORT_MODE_WAVE;
 154         }
 155     }
 156     free( psz_method_tmp );
 157
 158     return VLC_SUCCESS;
 159 }
 160
 161 /*****************************************************************************
 162  * Init: initialize Distort video thread output method
 163  *****************************************************************************/
 164 static int Init( vout_thread_t *p_vout )
 165 {
 166     int i_index;
 167     picture_t *p_pic;
 168     video_format_t fmt = {0};
 169
 170     I_OUTPUTPICTURES = 0;
 171
 172     /* Initialize the output structure */
 173     p_vout->output.i_chroma = p_vout->render.i_chroma;
 174     p_vout->output.i_width  = p_vout->render.i_width;
 175     p_vout->output.i_height = p_vout->render.i_height;
 176     p_vout->output.i_aspect = p_vout->render.i_aspect;
 177     p_vout->fmt_out = p_vout->fmt_in;
 178     fmt = p_vout->fmt_out;
 179
 180     /* Try to open the real video output */
 181     msg_Dbg( p_vout, "spawning the real video output" );
 182
 183     p_vout->p_sys->p_vout = vout_Create( p_vout, &fmt );
 184
 185     /* Everything failed */
 186     if( p_vout->p_sys->p_vout == NULL )
 187     {
 188         msg_Err( p_vout, "cannot open vout, aborting" );
 189         return VLC_EGENERIC;
 190     }
 191
 192     ALLOCATE_DIRECTBUFFERS( VOUT_MAX_PICTURES );
 193
 194     ADD_CALLBACKS( p_vout->p_sys->p_vout, SendEvents );
 195
 196     ADD_PARENT_CALLBACKS( SendEventsToChild );
 197
 198     p_vout->p_sys->f_angle = 0.0;
 199     p_vout->p_sys->last_date = 0;
 200
 201     return VLC_SUCCESS;
 202 }
 203
 204 /*****************************************************************************
 205  * End: terminate Distort 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 Distort video thread output method
 221  *****************************************************************************
 222  * Terminate an output method created by DistortCreateOutputMethod
 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 Distort image, waits
 244  * until it is displayed and switch the two rendering buffers, preparing next
 245  * frame.
 246  *****************************************************************************/
 247 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
 248 {
 249     picture_t *p_outpic;
 250
 251     /* This is a new frame. Get a structure from the video_output. */
 252     while( ( p_outpic = vout_CreatePicture( p_vout->p_sys->p_vout, 0, 0, 0 ) )
 253               == NULL )
 254     {
 255         if( p_vout->b_die || p_vout->b_error )
 256         {
 257             return;
 258         }
 259         msleep( VOUT_OUTMEM_SLEEP );
 260     }
 261
 262     vout_DatePicture( p_vout->p_sys->p_vout, p_outpic, p_pic->date );
 263
 264     switch( p_vout->p_sys->i_mode )
 265     {
 266         case DISTORT_MODE_WAVE:
 267             DistortWave( p_vout, p_pic, p_outpic );
 268             break;
 269
 270         case DISTORT_MODE_RIPPLE:
 271             DistortRipple( p_vout, p_pic, p_outpic );
 272             break;
 273
 274         default:
 275             break;
 276     }
 277
 278     vout_DisplayPicture( p_vout->p_sys->p_vout, p_outpic );
 279 }
 280
 281 /*****************************************************************************
 282  * DistortWave: draw a wave effect on the picture
 283  *****************************************************************************/
 284 static void DistortWave( vout_thread_t *p_vout, picture_t *p_inpic,
 285                                                 picture_t *p_outpic )
 286 {
 287     int i_index;
 288     double f_angle;
 289     mtime_t new_date = mdate();
 290
 291     p_vout->p_sys->f_angle += (new_date - p_vout->p_sys->last_date) / 200000.0;
 292     p_vout->p_sys->last_date = new_date;
 293     f_angle = p_vout->p_sys->f_angle;
 294
 295     for( i_index = 0 ; i_index < p_inpic->i_planes ; i_index++ )
 296     {
 297         int i_line, i_num_lines, i_offset;
 298         uint8_t black_pixel;
 299         uint8_t *p_in, *p_out;
 300
 301         p_in = p_inpic->p[i_index].p_pixels;
 302         p_out = p_outpic->p[i_index].p_pixels;
 303
 304         i_num_lines = p_inpic->p[i_index].i_visible_lines;
 305
 306         black_pixel = ( i_index == Y_PLANE ) ? 0x00 : 0x80;
 307
 308         /* Ok, we do 3 times the sin() calculation for each line. So what ? */
 309         for( i_line = 0 ; i_line < i_num_lines ; i_line++ )
 310         {
 311             /* Calculate today's offset, don't go above 1/20th of the screen */
 312             i_offset = (int)( (double)(p_inpic->p[i_index].i_visible_pitch)
 313                          * sin( f_angle + 10.0 * (double)i_line
 314                                                / (double)i_num_lines )
 315                          / 20.0 );
 316
 317             if( i_offset )
 318             {
 319                 if( i_offset < 0 )
 320                 {
 321                     p_vout->p_vlc->pf_memcpy( p_out, p_in - i_offset,
 322                              p_inpic->p[i_index].i_visible_pitch + i_offset );
 323                     p_in += p_inpic->p[i_index].i_pitch;
 324                     p_out += p_outpic->p[i_index].i_pitch;
 325                     memset( p_out + i_offset, black_pixel, -i_offset );
 326                 }
 327                 else
 328                 {
 329                     p_vout->p_vlc->pf_memcpy( p_out + i_offset, p_in,
 330                              p_inpic->p[i_index].i_visible_pitch - i_offset );
 331                     memset( p_out, black_pixel, i_offset );
 332                     p_in += p_inpic->p[i_index].i_pitch;
 333                     p_out += p_outpic->p[i_index].i_pitch;
 334                 }
 335             }
 336             else
 337             {
 338                 p_vout->p_vlc->pf_memcpy( p_out, p_in,
 339                                           p_inpic->p[i_index].i_visible_pitch );
 340                 p_in += p_inpic->p[i_index].i_pitch;
 341                 p_out += p_outpic->p[i_index].i_pitch;
 342             }
 343
 344         }
 345     }
 346 }
 347
 348 /*****************************************************************************
 349  * DistortRipple: draw a ripple effect at the bottom of the picture
 350  *****************************************************************************/
 351 static void DistortRipple( vout_thread_t *p_vout, picture_t *p_inpic,
 352                                                   picture_t *p_outpic )
 353 {
 354     int i_index;
 355     double f_angle;
 356     mtime_t new_date = mdate();
 357
 358     p_vout->p_sys->f_angle -= (p_vout->p_sys->last_date - new_date) / 100000.0;
 359     p_vout->p_sys->last_date = new_date;
 360     f_angle = p_vout->p_sys->f_angle;
 361
 362     for( i_index = 0 ; i_index < p_inpic->i_planes ; i_index++ )
 363     {
 364         int i_line, i_first_line, i_num_lines, i_offset;
 365         uint8_t black_pixel;
 366         uint8_t *p_in, *p_out;
 367
 368         black_pixel = ( i_index == Y_PLANE ) ? 0x00 : 0x80;
 369
 370         i_num_lines = p_inpic->p[i_index].i_visible_lines;
 371
 372         i_first_line = i_num_lines * 4 / 5;
 373
 374         p_in = p_inpic->p[i_index].p_pixels;
 375         p_out = p_outpic->p[i_index].p_pixels;
 376
 377         for( i_line = 0 ; i_line < i_first_line ; i_line++ )
 378         {
 379             p_vout->p_vlc->pf_memcpy( p_out, p_in,
 380                                       p_inpic->p[i_index].i_visible_pitch );
 381             p_in += p_inpic->p[i_index].i_pitch;
 382             p_out += p_outpic->p[i_index].i_pitch;
 383         }
 384
 385         /* Ok, we do 3 times the sin() calculation for each line. So what ? */
 386         for( i_line = i_first_line ; i_line < i_num_lines ; i_line++ )
 387         {
 388             /* Calculate today's offset, don't go above 1/20th of the screen */
 389             i_offset = (int)( (double)(p_inpic->p[i_index].i_pitch)
 390                          * sin( f_angle + 2.0 * (double)i_line
 391                                               / (double)( 1 + i_line
 392                                                             - i_first_line) )
 393                          * (double)(i_line - i_first_line)
 394                          / (double)i_num_lines
 395                          / 8.0 );
 396
 397             if( i_offset )
 398             {
 399                 if( i_offset < 0 )
 400                 {
 401                     p_vout->p_vlc->pf_memcpy( p_out, p_in - i_offset,
 402                              p_inpic->p[i_index].i_visible_pitch + i_offset );
 403                     p_in -= p_inpic->p[i_index].i_pitch;
 404                     p_out += p_outpic->p[i_index].i_pitch;
 405                     memset( p_out + i_offset, black_pixel, -i_offset );
 406                 }
 407                 else
 408                 {
 409                     p_vout->p_vlc->pf_memcpy( p_out + i_offset, p_in,
 410                              p_inpic->p[i_index].i_visible_pitch - i_offset );
 411                     memset( p_out, black_pixel, i_offset );
 412                     p_in -= p_inpic->p[i_index].i_pitch;
 413                     p_out += p_outpic->p[i_index].i_pitch;
 414                 }
 415             }
 416             else
 417             {
 418                 p_vout->p_vlc->pf_memcpy( p_out, p_in,
 419                                           p_inpic->p[i_index].i_visible_pitch );
 420                 p_in -= p_inpic->p[i_index].i_pitch;
 421                 p_out += p_outpic->p[i_index].i_pitch;
 422             }
 423
 424         }
 425     }
 426 }
 427
 428 /*****************************************************************************
 429  * SendEvents: forward mouse and keyboard events to the parent p_vout
 430  *****************************************************************************/
 431 static int SendEvents( vlc_object_t *p_this, char const *psz_var,
 432                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
 433 {
 434     var_Set( (vlc_object_t *)p_data, psz_var, newval );
 435
 436     return VLC_SUCCESS;
 437 }
 438
 439 /*****************************************************************************
 440  * SendEventsToChild: forward events to the child/children vout
 441  *****************************************************************************/
 442 static int SendEventsToChild( vlc_object_t *p_this, char const *psz_var,
 443                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
 444 {
 445     vout_thread_t *p_vout = (vout_thread_t *)p_this;
 446     var_Set( p_vout->p_sys->p_vout, psz_var, newval );
 447     return VLC_SUCCESS;
 448 }