1 /*****************************************************************************
2 * distort.c : Misc video effects plugin for vlc
3 *****************************************************************************
4 * Copyright (C) 2000, 2001 VideoLAN
5 * $Id: distort.c,v 1.2 2002/08/26 09:12:46 sam 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 *****************************************************************************/
28 #include <stdlib.h> /* malloc(), free() */
31 #include <math.h> /* sin(), cos() */
36 #include "filter_common.h"
38 #define DISTORT_MODE_WAVE 1
39 #define DISTORT_MODE_RIPPLE 2
41 /*****************************************************************************
43 *****************************************************************************/
44 static int Create ( vlc_object_t * );
45 static void Destroy ( vlc_object_t * );
47 static int Init ( vout_thread_t * );
48 static void End ( vout_thread_t * );
49 static void Render ( vout_thread_t *, picture_t * );
51 static void DistortWave ( vout_thread_t *, picture_t *, picture_t * );
52 static void DistortRipple ( vout_thread_t *, picture_t *, picture_t * );
54 /*****************************************************************************
56 *****************************************************************************/
57 #define MODE_TEXT N_("distort mode")
58 #define MODE_LONGTEXT N_("Distort mode, one of \"wave\" and \"ripple\"")
60 static char *mode_list[] = { "wave", "ripple", NULL };
63 add_category_hint( N_("Miscellaneous"), NULL );
64 add_string_from_list( "distort-mode", "wave", mode_list, NULL,
65 MODE_TEXT, MODE_LONGTEXT );
66 set_description( _("miscellaneous video effects module") );
67 set_capability( "video filter", 0 );
68 add_shortcut( "distort" );
69 set_callbacks( Create, Destroy );
72 /*****************************************************************************
73 * vout_sys_t: Distort video output method descriptor
74 *****************************************************************************
75 * This structure is part of the video output thread descriptor.
76 * It describes the Distort specific properties of an output thread.
77 *****************************************************************************/
81 vout_thread_t *p_vout;
83 /* For the wave mode */
88 /*****************************************************************************
89 * Create: allocates Distort video thread output method
90 *****************************************************************************
91 * This function allocates and initializes a Distort vout method.
92 *****************************************************************************/
93 static int Create( vlc_object_t *p_this )
95 vout_thread_t *p_vout = (vout_thread_t *)p_this;
96 char *psz_method, *psz_method_tmp;
98 /* Allocate structure */
99 p_vout->p_sys = malloc( sizeof( vout_sys_t ) );
100 if( p_vout->p_sys == NULL )
102 msg_Err( p_vout, "out of memory" );
106 p_vout->pf_init = Init;
107 p_vout->pf_end = End;
108 p_vout->pf_manage = NULL;
109 p_vout->pf_render = Render;
110 p_vout->pf_display = NULL;
112 p_vout->p_sys->i_mode = 0;
113 /* Look what method was requested from command line*/
114 if( !(psz_method = psz_method_tmp = config_GetPsz( p_vout, "filter" )) )
116 msg_Err( p_vout, "configuration variable %s empty", "filter" );
119 while( *psz_method && *psz_method != ':' )
124 if( !strcmp( psz_method, ":wave" ) )
126 p_vout->p_sys->i_mode = DISTORT_MODE_WAVE;
128 else if( !strcmp( psz_method, ":ripple" ) )
130 p_vout->p_sys->i_mode = DISTORT_MODE_RIPPLE;
132 free( psz_method_tmp );
133 if( !p_vout->p_sys->i_mode )
135 /* No method given in commandline. Look what method was
136 requested in configuration system */
137 if( !(psz_method = psz_method_tmp
138 = config_GetPsz( p_vout, "distort-mode" )) )
140 msg_Err( p_vout, "configuration variable %s empty, using 'wave'",
142 p_vout->p_sys->i_mode = DISTORT_MODE_WAVE;
146 if( !strcmp( psz_method, "wave" ) )
148 p_vout->p_sys->i_mode = DISTORT_MODE_WAVE;
150 else if( !strcmp( psz_method, "ripple" ) )
152 p_vout->p_sys->i_mode = DISTORT_MODE_RIPPLE;
157 msg_Err( p_vout, "no valid distort mode provided, "
159 p_vout->p_sys->i_mode = DISTORT_MODE_WAVE;
163 free( psz_method_tmp );
168 /*****************************************************************************
169 * Init: initialize Distort video thread output method
170 *****************************************************************************/
171 static int Init( vout_thread_t *p_vout )
176 I_OUTPUTPICTURES = 0;
178 /* Initialize the output structure */
179 p_vout->output.i_chroma = p_vout->render.i_chroma;
180 p_vout->output.i_width = p_vout->render.i_width;
181 p_vout->output.i_height = p_vout->render.i_height;
182 p_vout->output.i_aspect = p_vout->render.i_aspect;
184 /* Try to open the real video output */
185 msg_Dbg( p_vout, "spawning the real video output" );
187 p_vout->p_sys->p_vout =
188 vout_CreateThread( 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 p_vout->p_sys->f_angle = 0.0;
203 p_vout->p_sys->last_date = 0;
208 /*****************************************************************************
209 * End: terminate Distort video thread output method
210 *****************************************************************************/
211 static void End( vout_thread_t *p_vout )
215 /* Free the fake output buffers we allocated */
216 for( i_index = I_OUTPUTPICTURES ; i_index ; )
219 free( PP_OUTPUTPICTURE[ i_index ]->p_data_orig );
223 /*****************************************************************************
224 * Destroy: destroy Distort video thread output method
225 *****************************************************************************
226 * Terminate an output method created by DistortCreateOutputMethod
227 *****************************************************************************/
228 static void Destroy( vlc_object_t *p_this )
230 vout_thread_t *p_vout = (vout_thread_t *)p_this;
232 vout_DestroyThread( p_vout->p_sys->p_vout );
234 free( p_vout->p_sys );
237 /*****************************************************************************
238 * Render: displays previously rendered output
239 *****************************************************************************
240 * This function send the currently rendered image to Distort image, waits
241 * until it is displayed and switch the two rendering buffers, preparing next
243 *****************************************************************************/
244 static void Render( vout_thread_t *p_vout, picture_t *p_pic )
248 /* This is a new frame. Get a structure from the video_output. */
249 while( ( p_outpic = vout_CreatePicture( p_vout->p_sys->p_vout, 0, 0, 0 ) )
252 if( p_vout->b_die || p_vout->b_error )
256 msleep( VOUT_OUTMEM_SLEEP );
259 vout_DatePicture( p_vout->p_sys->p_vout, p_outpic, p_pic->date );
261 switch( p_vout->p_sys->i_mode )
263 case DISTORT_MODE_WAVE:
264 DistortWave( p_vout, p_pic, p_outpic );
267 case DISTORT_MODE_RIPPLE:
268 DistortRipple( p_vout, p_pic, p_outpic );
275 vout_DisplayPicture( p_vout->p_sys->p_vout, p_outpic );
278 /*****************************************************************************
279 * DistortWave: draw a wave effect on the picture
280 *****************************************************************************/
281 static void DistortWave( vout_thread_t *p_vout, picture_t *p_inpic,
282 picture_t *p_outpic )
286 mtime_t new_date = mdate();
288 p_vout->p_sys->f_angle += (new_date - p_vout->p_sys->last_date) / 200000.0;
289 p_vout->p_sys->last_date = new_date;
290 f_angle = p_vout->p_sys->f_angle;
292 for( i_index = 0 ; i_index < p_inpic->i_planes ; i_index++ )
294 int i_line, i_num_lines, i_offset;
298 p_in = p_inpic->p[i_index].p_pixels;
299 p_out = p_outpic->p[i_index].p_pixels;
301 i_num_lines = p_inpic->p[i_index].i_lines;
303 black_pixel = ( i_index == Y_PLANE ) ? 0x00 : 0x80;
305 /* Ok, we do 3 times the sin() calculation for each line. So what ? */
306 for( i_line = 0 ; i_line < i_num_lines ; i_line++ )
308 /* Calculate today's offset, don't go above 1/20th of the screen */
309 i_offset = (double)(p_inpic->p[i_index].i_pitch)
310 * sin( f_angle + 10.0 * (double)i_line
311 / (double)i_num_lines )
318 p_vout->p_vlc->pf_memcpy( p_out, p_in - i_offset,
319 p_inpic->p[i_index].i_pitch + i_offset );
320 p_in += p_inpic->p[i_index].i_pitch;
321 p_out += p_outpic->p[i_index].i_pitch;
322 memset( p_out + i_offset, black_pixel, -i_offset );
326 p_vout->p_vlc->pf_memcpy( p_out + i_offset, p_in,
327 p_inpic->p[i_index].i_pitch - i_offset );
328 memset( p_out, black_pixel, i_offset );
329 p_in += p_inpic->p[i_index].i_pitch;
330 p_out += p_outpic->p[i_index].i_pitch;
335 p_vout->p_vlc->pf_memcpy( p_out, p_in,
336 p_inpic->p[i_index].i_pitch );
337 p_in += p_inpic->p[i_index].i_pitch;
338 p_out += p_outpic->p[i_index].i_pitch;
345 /*****************************************************************************
346 * DistortRipple: draw a ripple effect at the bottom of the picture
347 *****************************************************************************/
348 static void DistortRipple( vout_thread_t *p_vout, picture_t *p_inpic,
349 picture_t *p_outpic )
353 mtime_t new_date = mdate();
355 p_vout->p_sys->f_angle -= (p_vout->p_sys->last_date - new_date) / 100000.0;
356 p_vout->p_sys->last_date = new_date;
357 f_angle = p_vout->p_sys->f_angle;
359 for( i_index = 0 ; i_index < p_inpic->i_planes ; i_index++ )
361 int i_line, i_first_line, i_num_lines, i_offset;
365 black_pixel = ( i_index == Y_PLANE ) ? 0x00 : 0x80;
367 i_num_lines = p_inpic->p[i_index].i_lines;
369 i_first_line = i_num_lines * 4 / 5;
371 p_in = p_inpic->p[i_index].p_pixels;
372 p_out = p_outpic->p[i_index].p_pixels;
374 p_vout->p_vlc->pf_memcpy( p_out, p_in,
375 i_first_line * p_inpic->p[i_index].i_pitch );
377 p_in += i_first_line * p_inpic->p[i_index].i_pitch;
378 p_out += i_first_line * p_outpic->p[i_index].i_pitch;
380 /* Ok, we do 3 times the sin() calculation for each line. So what ? */
381 for( i_line = i_first_line ; i_line < i_num_lines ; i_line++ )
383 /* Calculate today's offset, don't go above 1/20th of the screen */
384 i_offset = (double)(p_inpic->p[i_index].i_pitch)
385 * sin( f_angle + 2.0 * (double)i_line
386 / (double)( 1 + i_line
388 * (double)(i_line - i_first_line)
389 / (double)i_num_lines
396 p_vout->p_vlc->pf_memcpy( p_out, p_in - i_offset,
397 p_inpic->p[i_index].i_pitch + i_offset );
398 p_in -= p_inpic->p[i_index].i_pitch;
399 p_out += p_outpic->p[i_index].i_pitch;
400 memset( p_out + i_offset, black_pixel, -i_offset );
404 p_vout->p_vlc->pf_memcpy( p_out + i_offset, p_in,
405 p_inpic->p[i_index].i_pitch - i_offset );
406 memset( p_out, black_pixel, i_offset );
407 p_in -= p_inpic->p[i_index].i_pitch;
408 p_out += p_outpic->p[i_index].i_pitch;
413 p_vout->p_vlc->pf_memcpy( p_out, p_in,
414 p_inpic->p[i_index].i_pitch );
415 p_in -= p_inpic->p[i_index].i_pitch;
416 p_out += p_outpic->p[i_index].i_pitch;