1 /*****************************************************************************
2 * distort.c : Misc video effects plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2000, 2001, 2002, 2003 VideoLAN
5 * $Id: distort.c,v 1.8 2003/03/18 23:30:28 gbazin Exp $
7 * Authors: Samuel Hocevar <sam@zoy.org>
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.
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.
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 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
27 #include <stdlib.h> /* malloc(), free() */
30 #include <math.h> /* sin(), cos() */
35 #include "filter_common.h"
37 #define DISTORT_MODE_WAVE 1
38 #define DISTORT_MODE_RIPPLE 2
40 /*****************************************************************************
42 *****************************************************************************/
43 static int Create ( vlc_object_t * );
44 static void Destroy ( vlc_object_t * );
46 static int Init ( vout_thread_t * );
47 static void End ( vout_thread_t * );
48 static void Render ( vout_thread_t *, picture_t * );
50 static void DistortWave ( vout_thread_t *, picture_t *, picture_t * );
51 static void DistortRipple ( vout_thread_t *, picture_t *, picture_t * );
53 static int SendEvents ( vlc_object_t *, char const *,
54 vlc_value_t, vlc_value_t, void * );
56 /*****************************************************************************
58 *****************************************************************************/
59 #define MODE_TEXT N_("distort mode")
60 #define MODE_LONGTEXT N_("Distort mode, one of \"wave\" and \"ripple\"")
62 static char *mode_list[] = { "wave", "ripple", NULL };
65 add_category_hint( N_("Distort"), NULL, VLC_FALSE );
66 add_string_from_list( "distort-mode", "wave", mode_list, NULL,
67 MODE_TEXT, MODE_LONGTEXT, VLC_FALSE );
68 set_description( _("miscellaneous video effects module") );
69 set_capability( "video filter", 0 );
70 add_shortcut( "distort" );
71 set_callbacks( Create, Destroy );
74 /*****************************************************************************
75 * vout_sys_t: Distort video output method descriptor
76 *****************************************************************************
77 * This structure is part of the video output thread descriptor.
78 * It describes the Distort specific properties of an output thread.
79 *****************************************************************************/
83 vout_thread_t *p_vout;
85 /* For the wave mode */
90 /*****************************************************************************
91 * Create: allocates Distort video thread output method
92 *****************************************************************************
93 * This function allocates and initializes a Distort vout method.
94 *****************************************************************************/
95 static int Create( vlc_object_t *p_this )
97 vout_thread_t *p_vout = (vout_thread_t *)p_this;
98 char *psz_method, *psz_method_tmp;
100 /* Allocate structure */
101 p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
102 if( p_vout->p_sys == NULL )
104 msg_Err( p_vout, "out of memory" );
108 p_vout->pf_init = Init;
109 p_vout->pf_end = End;
110 p_vout->pf_manage = NULL;
111 p_vout->pf_render = Render;
112 p_vout->pf_display = NULL;
114 p_vout->p_sys->i_mode = 0;
115 /* Look what method was requested from command line*/
116 if( !(psz_method = psz_method_tmp = config_GetPsz( p_vout, "filter" )) )
118 msg_Err( p_vout, "configuration variable %s empty", "filter" );
121 while( *psz_method && *psz_method != ':' )
126 if( !strcmp( psz_method, ":wave" ) )
128 p_vout->p_sys->i_mode = DISTORT_MODE_WAVE;
130 else if( !strcmp( psz_method, ":ripple" ) )
132 p_vout->p_sys->i_mode = DISTORT_MODE_RIPPLE;
134 free( psz_method_tmp );
135 if( !p_vout->p_sys->i_mode )
137 /* No method given in commandline. Look what method was
138 requested in configuration system */
139 if( !(psz_method = psz_method_tmp
140 = config_GetPsz( p_vout, "distort-mode" )) )
142 msg_Err( p_vout, "configuration variable %s empty, using 'wave'",
144 p_vout->p_sys->i_mode = DISTORT_MODE_WAVE;
148 if( !strcmp( psz_method, "wave" ) )
150 p_vout->p_sys->i_mode = DISTORT_MODE_WAVE;
152 else if( !strcmp( psz_method, "ripple" ) )
154 p_vout->p_sys->i_mode = DISTORT_MODE_RIPPLE;
158 msg_Err( p_vout, "no valid distort mode provided, "
160 p_vout->p_sys->i_mode = DISTORT_MODE_WAVE;
164 free( psz_method_tmp );
169 /*****************************************************************************
170 * Init: initialize Distort video thread output method
171 *****************************************************************************/
172 static int Init( vout_thread_t *p_vout )
177 I_OUTPUTPICTURES = 0;
179 /* Initialize the output structure */
180 p_vout->output.i_chroma = p_vout->render.i_chroma;
181 p_vout->output.i_width = p_vout->render.i_width;
182 p_vout->output.i_height = p_vout->render.i_height;
183 p_vout->output.i_aspect = p_vout->render.i_aspect;
185 /* Try to open the real video output */
186 msg_Dbg( p_vout, "spawning the real video output" );
188 p_vout->p_sys->p_vout = vout_Create( p_vout,
189 p_vout->render.i_width, p_vout->render.i_height,
190 p_vout->render.i_chroma, p_vout->render.i_aspect );
192 /* Everything failed */
193 if( p_vout->p_sys->p_vout == NULL )
195 msg_Err( p_vout, "cannot open vout, aborting" );
200 ALLOCATE_DIRECTBUFFERS( VOUT_MAX_PICTURES );
202 ADD_CALLBACKS( p_vout->p_sys->p_vout, SendEvents );
204 p_vout->p_sys->f_angle = 0.0;
205 p_vout->p_sys->last_date = 0;
210 /*****************************************************************************
211 * End: terminate Distort video thread output method
212 *****************************************************************************/
213 static void End( vout_thread_t *p_vout )
217 /* Free the fake output buffers we allocated */
218 for( i_index = I_OUTPUTPICTURES ; i_index ; )
221 free( PP_OUTPUTPICTURE[ i_index ]->p_data_orig );
225 /*****************************************************************************
226 * Destroy: destroy Distort video thread output method
227 *****************************************************************************
228 * Terminate an output method created by DistortCreateOutputMethod
229 *****************************************************************************/
230 static void Destroy( vlc_object_t *p_this )
232 vout_thread_t *p_vout = (vout_thread_t *)p_this;
234 DEL_CALLBACKS( p_vout->p_sys->p_vout, SendEvents );
235 vlc_object_detach( p_vout->p_sys->p_vout );
236 vout_Destroy( p_vout->p_sys->p_vout );
238 free( p_vout->p_sys );
241 /*****************************************************************************
242 * Render: displays previously rendered output
243 *****************************************************************************
244 * This function send the currently rendered image to Distort image, waits
245 * until it is displayed and switch the two rendering buffers, preparing next
247 *****************************************************************************/
248 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
252 /* This is a new frame. Get a structure from the video_output. */
253 while( ( p_outpic = vout_CreatePicture( p_vout->p_sys->p_vout, 0, 0, 0 ) )
256 if( p_vout->b_die || p_vout->b_error )
260 msleep( VOUT_OUTMEM_SLEEP );
263 vout_DatePicture( p_vout->p_sys->p_vout, p_outpic, p_pic->date );
265 switch( p_vout->p_sys->i_mode )
267 case DISTORT_MODE_WAVE:
268 DistortWave( p_vout, p_pic, p_outpic );
271 case DISTORT_MODE_RIPPLE:
272 DistortRipple( p_vout, p_pic, p_outpic );
279 vout_DisplayPicture( p_vout->p_sys->p_vout, p_outpic );
282 /*****************************************************************************
283 * DistortWave: draw a wave effect on the picture
284 *****************************************************************************/
285 static void DistortWave( vout_thread_t *p_vout, picture_t *p_inpic,
286 picture_t *p_outpic )
290 mtime_t new_date = mdate();
292 p_vout->p_sys->f_angle += (new_date - p_vout->p_sys->last_date) / 200000.0;
293 p_vout->p_sys->last_date = new_date;
294 f_angle = p_vout->p_sys->f_angle;
296 for( i_index = 0 ; i_index < p_inpic->i_planes ; i_index++ )
298 int i_line, i_num_lines, i_offset;
300 uint8_t *p_in, *p_out;
302 p_in = p_inpic->p[i_index].p_pixels;
303 p_out = p_outpic->p[i_index].p_pixels;
305 i_num_lines = p_inpic->p[i_index].i_lines;
307 black_pixel = ( i_index == Y_PLANE ) ? 0x00 : 0x80;
309 /* Ok, we do 3 times the sin() calculation for each line. So what ? */
310 for( i_line = 0 ; i_line < i_num_lines ; i_line++ )
312 /* Calculate today's offset, don't go above 1/20th of the screen */
313 i_offset = (int)( (double)(p_inpic->p[i_index].i_visible_pitch)
314 * sin( f_angle + 10.0 * (double)i_line
315 / (double)i_num_lines )
322 p_vout->p_vlc->pf_memcpy( p_out, p_in - i_offset,
323 p_inpic->p[i_index].i_visible_pitch + i_offset );
324 p_in += p_inpic->p[i_index].i_pitch;
325 p_out += p_outpic->p[i_index].i_pitch;
326 memset( p_out + i_offset, black_pixel, -i_offset );
330 p_vout->p_vlc->pf_memcpy( p_out + i_offset, p_in,
331 p_inpic->p[i_index].i_visible_pitch - i_offset );
332 memset( p_out, black_pixel, i_offset );
333 p_in += p_inpic->p[i_index].i_pitch;
334 p_out += p_outpic->p[i_index].i_pitch;
339 p_vout->p_vlc->pf_memcpy( p_out, p_in,
340 p_inpic->p[i_index].i_visible_pitch );
341 p_in += p_inpic->p[i_index].i_pitch;
342 p_out += p_outpic->p[i_index].i_pitch;
349 /*****************************************************************************
350 * DistortRipple: draw a ripple effect at the bottom of the picture
351 *****************************************************************************/
352 static void DistortRipple( vout_thread_t *p_vout, picture_t *p_inpic,
353 picture_t *p_outpic )
357 mtime_t new_date = mdate();
359 p_vout->p_sys->f_angle -= (p_vout->p_sys->last_date - new_date) / 100000.0;
360 p_vout->p_sys->last_date = new_date;
361 f_angle = p_vout->p_sys->f_angle;
363 for( i_index = 0 ; i_index < p_inpic->i_planes ; i_index++ )
365 int i_line, i_first_line, i_num_lines, i_offset;
367 uint8_t *p_in, *p_out;
369 black_pixel = ( i_index == Y_PLANE ) ? 0x00 : 0x80;
371 i_num_lines = p_inpic->p[i_index].i_lines;
373 i_first_line = i_num_lines * 4 / 5;
375 p_in = p_inpic->p[i_index].p_pixels;
376 p_out = p_outpic->p[i_index].p_pixels;
378 for( i_line = 0 ; i_line < i_first_line ; i_line++ )
380 p_vout->p_vlc->pf_memcpy( p_out, p_in,
381 p_inpic->p[i_index].i_visible_pitch );
382 p_in += p_inpic->p[i_index].i_pitch;
383 p_out += p_outpic->p[i_index].i_pitch;
386 /* Ok, we do 3 times the sin() calculation for each line. So what ? */
387 for( i_line = i_first_line ; i_line < i_num_lines ; i_line++ )
389 /* Calculate today's offset, don't go above 1/20th of the screen */
390 i_offset = (int)( (double)(p_inpic->p[i_index].i_pitch)
391 * sin( f_angle + 2.0 * (double)i_line
392 / (double)( 1 + i_line
394 * (double)(i_line - i_first_line)
395 / (double)i_num_lines
402 p_vout->p_vlc->pf_memcpy( p_out, p_in - i_offset,
403 p_inpic->p[i_index].i_visible_pitch + i_offset );
404 p_in -= p_inpic->p[i_index].i_pitch;
405 p_out += p_outpic->p[i_index].i_pitch;
406 memset( p_out + i_offset, black_pixel, -i_offset );
410 p_vout->p_vlc->pf_memcpy( p_out + i_offset, p_in,
411 p_inpic->p[i_index].i_visible_pitch - i_offset );
412 memset( p_out, black_pixel, i_offset );
413 p_in -= p_inpic->p[i_index].i_pitch;
414 p_out += p_outpic->p[i_index].i_pitch;
419 p_vout->p_vlc->pf_memcpy( p_out, p_in,
420 p_inpic->p[i_index].i_visible_pitch );
421 p_in -= p_inpic->p[i_index].i_pitch;
422 p_out += p_outpic->p[i_index].i_pitch;
429 /*****************************************************************************
430 * SendEvents: forward mouse and keyboard events to the parent p_vout
431 *****************************************************************************/
432 static int SendEvents( vlc_object_t *p_this, char const *psz_var,
433 vlc_value_t oldval, vlc_value_t newval, void *p_data )
435 var_Set( (vlc_object_t *)p_data, psz_var, newval );