1 /*****************************************************************************
2 * visual.c : Visualisation system
3 *****************************************************************************
4 * Copyright (C) 2002 VideoLAN
7 * Authors: Clément Stenac <zorglub@via.ecp.fr>
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 "audio_output.h"
31 #include "aout_internal.h"
35 /*****************************************************************************
37 *****************************************************************************/
38 #define ELIST_TEXT N_( "Effects list" )
39 #define ELIST_LONGTEXT N_( \
40 "A list of visual effect, separated by commas.\n" \
41 "Current effects include: dummy, random, scope, spectrum" )
43 #define WIDTH_TEXT N_( "Video width" )
44 #define WIDTH_LONGTEXT N_( \
45 "The width of the effects video window, in pixels." )
47 #define HEIGHT_TEXT N_( "Video height" )
48 #define HEIGHT_LONGTEXT N_( \
49 "The height of the effects video window, in pixels." )
51 #define NBBANDS_TEXT N_( "Number of bands" )
52 #define NBBANDS_LONGTEXT N_( \
53 "Number of bands used by spectrum analyzer, should be 20 or 80." )
55 #define SEPAR_TEXT N_( "Band separator" )
56 #define SEPAR_LONGTEXT N_( \
57 "Number of blank pixels between bands.")
59 #define AMP_TEXT N_( "Amplification" )
60 #define AMP_LONGTEXT N_( \
61 "This is a coefficient that modifies the height of the bands.")
63 #define PEAKS_TEXT N_( "Enable peaks" )
64 #define PEAKS_LONGTEXT N_( \
65 "Defines whether to draw peaks." )
67 #define STARS_TEXT N_( "Number of stars" )
68 #define STARS_LONGTEXT N_( \
69 "Defines the number of stars to draw with random effect." )
71 static int Open ( vlc_object_t * );
72 static void Close ( vlc_object_t * );
75 set_shortname( _("Visualizer"));
76 set_category( CAT_AUDIO );
77 set_subcategory( SUBCAT_AUDIO_VISUAL );
78 set_description( _("Visualizer filter") );
79 set_section( N_( "General") , NULL );
80 add_string("effect-list", "spectrum", NULL,
81 ELIST_TEXT, ELIST_LONGTEXT, VLC_TRUE );
82 add_integer("effect-width",VOUT_WIDTH,NULL,
83 WIDTH_TEXT, WIDTH_LONGTEXT, VLC_FALSE );
84 add_integer("effect-height" , VOUT_HEIGHT , NULL,
85 HEIGHT_TEXT, HEIGHT_LONGTEXT, VLC_FALSE );
86 set_section( N_("Spectrum analyser") , NULL );
87 add_integer("visual-nbbands", 80, NULL,
88 NBBANDS_TEXT, NBBANDS_LONGTEXT, VLC_FALSE );
89 add_integer("visual-separ", 1, NULL,
90 SEPAR_TEXT, SEPAR_LONGTEXT, VLC_FALSE );
91 add_integer("visual-amp", 3, NULL,
92 AMP_TEXT, AMP_LONGTEXT, VLC_FALSE );
93 add_bool("visual-peaks", VLC_TRUE, NULL,
94 PEAKS_TEXT, PEAKS_LONGTEXT, VLC_FALSE );
95 set_section( N_( "Random effect") , NULL );
96 add_integer("visual-stars", 200, NULL,
97 STARS_TEXT, STARS_LONGTEXT, VLC_FALSE );
98 set_capability( "visualization", 0 );
99 set_callbacks( Open, Close );
100 add_shortcut( "visualizer");
104 /*****************************************************************************
106 *****************************************************************************/
107 static void DoWork( aout_instance_t *, aout_filter_t *,
108 aout_buffer_t *, aout_buffer_t * );
109 static int FilterCallback( vlc_object_t *, char const *,
110 vlc_value_t, vlc_value_t, void * );
114 int (*pf_run)( visual_effect_t *, aout_instance_t *,
115 aout_buffer_t *, picture_t *);
118 { "scope", scope_Run },
119 { "spectrum", spectrum_Run },
120 { "random", random_Run},
121 { "dummy", dummy_Run},
125 /*****************************************************************************
126 * Open: open the visualizer
127 *****************************************************************************/
128 static int Open( vlc_object_t *p_this )
130 aout_filter_t *p_filter = (aout_filter_t *)p_this;
131 aout_filter_sys_t *p_sys;
134 char *psz_effects, *psz_parser;
135 video_format_t fmt = {0};
137 if( ( p_filter->input.i_format != VLC_FOURCC('f','l','3','2') &&
138 p_filter->input.i_format != VLC_FOURCC('f','i','3','2') ) )
143 p_sys = p_filter->p_sys = malloc( sizeof( aout_filter_sys_t ) );
146 msg_Err( p_filter, "out of memory" );
150 p_sys->i_height = config_GetInt( p_filter , "effect-height");
151 p_sys->i_width = config_GetInt( p_filter , "effect-width");
153 if( p_sys->i_height < 20 ) p_sys->i_height = 20;
154 if( p_sys->i_width < 20 ) p_sys->i_width = 20;
155 if( (p_sys->i_height % 2 ) != 0 ) p_sys->i_height--;
156 if( (p_sys->i_width % 2 ) != 0 ) p_sys->i_width--;
159 p_sys->effect = NULL;
161 /* Parse the effect list */
162 var_Create( p_filter, "effect-list", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
163 var_Get( p_filter, "effect-list", &val);
164 psz_parser = psz_effects = strdup( val.psz_string );
165 free( val.psz_string );
166 msg_Dbg( p_filter , "Building list of effects" );
168 var_AddCallback( p_filter, "effect-list", FilterCallback, NULL );
170 while( psz_parser && *psz_parser != '\0' )
172 visual_effect_t *p_effect;
175 p_effect = malloc( sizeof( visual_effect_t ) );
176 p_effect->i_width = p_sys->i_width;
177 p_effect->i_height= p_sys->i_height;
178 p_effect->i_nb_chans = aout_FormatNbChannels( &p_filter->input);
179 p_effect->psz_args = NULL;
180 p_effect->p_data = NULL;
182 p_effect->pf_run = NULL;
183 p_effect->psz_name = NULL;
185 for( i = 0; pf_effect_run[i].psz_name != NULL; i++ )
187 if( !strncasecmp( psz_parser,
188 pf_effect_run[i].psz_name,
189 strlen( pf_effect_run[i].psz_name ) ) )
191 p_effect->pf_run = pf_effect_run[i].pf_run;
192 p_effect->psz_name = strdup( pf_effect_run[i].psz_name );
197 if( p_effect->psz_name )
199 psz_parser += strlen( p_effect->psz_name );
201 if( *psz_parser == '{' )
207 if( ( psz_eoa = strchr( psz_parser, '}') ) == NULL )
209 msg_Err( p_filter, "Unable to parse effect list. Aborting");
213 strndup( psz_parser, psz_eoa - psz_parser);
215 TAB_APPEND( p_sys->i_effect, p_sys->effect, p_effect );
219 msg_Err( p_filter, "unknown visual effect: %s", psz_parser );
223 if( strchr( psz_parser, ',' ) )
225 psz_parser = strchr( psz_parser, ',' ) + 1;
227 else if( strchr( psz_parser, ':' ) )
229 psz_parser = strchr( psz_parser, ':' ) + 1;
242 if( !p_sys->i_effect )
244 msg_Err( p_filter, "no effects found" );
249 /* Open the video output */
250 fmt.i_width = fmt.i_visible_width = p_sys->i_width;
251 fmt.i_height = fmt.i_visible_height = p_sys->i_height;
252 fmt.i_chroma = VLC_FOURCC('I','4','2','0');
253 fmt.i_aspect = VOUT_ASPECT_FACTOR * p_sys->i_width/p_sys->i_height;
254 fmt.i_sar_num = fmt.i_sar_den = 1;
256 p_sys->p_vout = vout_Request( p_filter, NULL, &fmt );
257 if( p_sys->p_vout == NULL )
259 msg_Err( p_filter, "no suitable vout module" );
264 p_filter->pf_do_work = DoWork;
265 p_filter->b_in_place= 1;
267 msg_Dbg( p_filter,"Visualizer initialized");
271 /*****************************************************************************
272 * DoWork: convert a buffer
273 *****************************************************************************
274 * Audio part pasted from trivial.c
275 ****************************************************************************/
276 static void DoWork( aout_instance_t *p_aout, aout_filter_t *p_filter,
277 aout_buffer_t *p_in_buf, aout_buffer_t *p_out_buf )
279 aout_filter_sys_t *p_sys = p_filter->p_sys;
283 p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
284 p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes *
285 aout_FormatNbChannels( &p_filter->output ) /
286 aout_FormatNbChannels( &p_filter->input );
288 /* First, get a new picture */
289 while( ( p_outpic = vout_CreatePicture( p_sys->p_vout, 0, 0, 3 ) ) == NULL)
295 msleep( VOUT_OUTMEM_SLEEP );
298 /* Blank the picture */
299 for( i = 0 ; i < p_outpic->i_planes ; i++ )
301 memset( p_outpic->p[i].p_pixels, i > 0 ? 0x80 : 0x00,
302 p_outpic->p[i].i_visible_lines * p_outpic->p[i].i_pitch );
305 /* We can now call our visualization effects */
306 for( i = 0; i < p_sys->i_effect; i++ )
308 #define p_effect p_sys->effect[i]
309 if( p_effect->pf_run )
311 p_effect->pf_run( p_effect, p_aout, p_out_buf, p_outpic );
316 vout_DatePicture( p_sys->p_vout, p_outpic,
317 ( p_in_buf->start_date + p_in_buf->end_date ) / 2 );
319 vout_DisplayPicture( p_sys->p_vout, p_outpic );
322 /*****************************************************************************
323 * Close: close the plugin
324 *****************************************************************************/
325 static void Close( vlc_object_t *p_this )
327 aout_filter_t * p_filter = (aout_filter_t *)p_this;
328 aout_filter_sys_t *p_sys = p_filter->p_sys;
332 if( p_filter->p_sys->p_vout )
334 vout_Request( p_filter, p_filter->p_sys->p_vout, 0 );
338 for( i = 0; i < p_sys->i_effect; i++ )
340 #define p_effect p_sys->effect[i]
341 if( p_effect->psz_name )
343 free( p_effect->psz_name );
345 if( p_effect->psz_args )
347 free( p_effect->psz_args );
355 free( p_sys->effect );
358 free( p_filter->p_sys );
361 /*****************************************************************************
362 * FilterCallback: called when changing the deinterlace method on the fly.
363 *****************************************************************************/
364 static int FilterCallback( vlc_object_t *p_this, char const *psz_cmd,
365 vlc_value_t oldval, vlc_value_t newval,
368 aout_filter_t *p_filter = (aout_filter_t *)p_this;
369 /* restart this baby */
370 msg_Dbg( p_filter, "We should restart the visual filter" );