1 /*****************************************************************************
2 * visual.c : Visualisation system
3 *****************************************************************************
4 * Copyright (C) 2002-2006 the VideoLAN team
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
31 #include <vlc_common.h>
32 #include <vlc_plugin.h>
38 /*****************************************************************************
40 *****************************************************************************/
41 #define ELIST_TEXT N_( "Effects list" )
42 #define ELIST_LONGTEXT N_( \
43 "A list of visual effect, separated by commas.\n" \
44 "Current effects include: dummy, scope, spectrum." )
46 #define WIDTH_TEXT N_( "Video width" )
47 #define WIDTH_LONGTEXT N_( \
48 "The width of the effects video window, in pixels." )
50 #define HEIGHT_TEXT N_( "Video height" )
51 #define HEIGHT_LONGTEXT N_( \
52 "The height of the effects video window, in pixels." )
54 #define NBBANDS_TEXT N_( "More bands : 80 / 20" )
55 #define NBBANDS_LONGTEXT N_( \
56 "More bands for the spectrum analyzer : 80 if enabled else 20." )
57 #define SPNBBANDS_LONGTEXT N_( \
58 "More bands for the spectrometer : 80 if enabled else 20." )
60 #define SEPAR_TEXT N_( "Band separator" )
61 #define SEPAR_LONGTEXT N_( \
62 "Number of blank pixels between bands.")
64 #define AMP_TEXT N_( "Amplification" )
65 #define AMP_LONGTEXT N_( \
66 "This is a coefficient that modifies the height of the bands.")
68 #define PEAKS_TEXT N_( "Enable peaks" )
69 #define PEAKS_LONGTEXT N_( \
70 "Draw \"peaks\" in the spectrum analyzer." )
72 #define ORIG_TEXT N_( "Enable original graphic spectrum" )
73 #define ORIG_LONGTEXT N_( \
74 "Enable the \"flat\" spectrum analyzer in the spectrometer." )
76 #define BANDS_TEXT N_( "Enable bands" )
77 #define BANDS_LONGTEXT N_( \
78 "Draw bands in the spectrometer." )
80 #define BASE_TEXT N_( "Enable base" )
81 #define BASE_LONGTEXT N_( \
82 "Defines whether to draw the base of the bands." )
84 #define RADIUS_TEXT N_( "Base pixel radius" )
85 #define RADIUS_LONGTEXT N_( \
86 "Defines radius size in pixels, of base of bands(beginning)." )
88 #define SSECT_TEXT N_( "Spectral sections" )
89 #define SSECT_LONGTEXT N_( \
90 "Determines how many sections of spectrum will exist." )
92 #define PEAK_HEIGHT_TEXT N_( "Peak height" )
93 #define PEAK_HEIGHT_LONGTEXT N_( \
94 "Total pixel height of the peak items." )
96 #define PEAK_WIDTH_TEXT N_( "Peak extra width" )
97 #define PEAK_WIDTH_LONGTEXT N_( \
98 "Additions or subtractions of pixels on the peak width." )
100 #define COLOR1_TEXT N_( "V-plane color" )
101 #define COLOR1_LONGTEXT N_( \
102 "YUV-Color cube shifting across the V-plane ( 0 - 127 )." )
104 #define STARS_TEXT N_( "Number of stars" )
105 #define STARS_LONGTEXT N_( \
106 "Number of stars to draw with random effect." )
108 static int Open ( vlc_object_t
* );
109 static void Close ( vlc_object_t
* );
112 set_shortname( N_("Visualizer"))
113 set_category( CAT_AUDIO
)
114 set_subcategory( SUBCAT_AUDIO_VISUAL
)
115 set_description( N_("Visualizer filter") )
116 set_section( N_( "General") , NULL
)
117 add_string("effect-list", "spectrum", NULL
,
118 ELIST_TEXT
, ELIST_LONGTEXT
, true )
119 add_integer("effect-width",VOUT_WIDTH
,NULL
,
120 WIDTH_TEXT
, WIDTH_LONGTEXT
, false )
121 add_integer("effect-height" , VOUT_HEIGHT
, NULL
,
122 HEIGHT_TEXT
, HEIGHT_LONGTEXT
, false )
123 set_section( N_("Spectrum analyser") , NULL
)
124 add_obsolete_integer( "visual-nbbands" ) /* Since 1.0.0 */
125 add_bool("visual-80-bands", 1, NULL
,
126 NBBANDS_TEXT
, NBBANDS_LONGTEXT
, true );
127 add_obsolete_integer( "visual-separ" ) /* Since 1.0.0 */
128 add_obsolete_integer( "visual-amp" ) /* Since 1.0.0 */
129 add_bool("visual-peaks", true, NULL
,
130 PEAKS_TEXT
, PEAKS_LONGTEXT
, true )
131 set_section( N_("Spectrometer") , NULL
)
132 add_bool("spect-show-original", false, NULL
,
133 ORIG_TEXT
, ORIG_LONGTEXT
, true )
134 add_bool("spect-show-base", true, NULL
,
135 BASE_TEXT
, BASE_LONGTEXT
, true )
136 add_integer("spect-radius", 42, NULL
,
137 RADIUS_TEXT
, RADIUS_LONGTEXT
, true )
138 add_integer("spect-sections", 3, NULL
,
139 SSECT_TEXT
, SSECT_LONGTEXT
, true )
140 add_integer("spect-color", 80, NULL
,
141 COLOR1_TEXT
, COLOR1_LONGTEXT
, true )
142 add_bool("spect-show-bands", true, NULL
,
143 BANDS_TEXT
, BANDS_LONGTEXT
, true );
144 add_obsolete_integer( "spect-nbbands" ) /* Since 1.0.0 */
145 add_bool("spect-80-bands", 1, NULL
,
146 NBBANDS_TEXT
, SPNBBANDS_LONGTEXT
, true )
147 add_integer("spect-separ", 1, NULL
,
148 SEPAR_TEXT
, SEPAR_LONGTEXT
, true )
149 add_integer("spect-amp", 8, NULL
,
150 AMP_TEXT
, AMP_LONGTEXT
, true )
151 add_bool("spect-show-peaks", true, NULL
,
152 PEAKS_TEXT
, PEAKS_LONGTEXT
, true )
153 add_integer("spect-peak-width", 61, NULL
,
154 PEAK_WIDTH_TEXT
, PEAK_WIDTH_LONGTEXT
, true )
155 add_integer("spect-peak-height", 1, NULL
,
156 PEAK_HEIGHT_TEXT
, PEAK_HEIGHT_LONGTEXT
, true )
157 set_capability( "visualization", 0 )
158 set_callbacks( Open
, Close
)
159 add_shortcut( "visualizer")
163 /*****************************************************************************
165 *****************************************************************************/
166 static void DoWork( aout_instance_t
*, aout_filter_t
*,
167 aout_buffer_t
*, aout_buffer_t
* );
168 static int FilterCallback( vlc_object_t
*, char const *,
169 vlc_value_t
, vlc_value_t
, void * );
172 const char *psz_name
;
173 int (*pf_run
)( visual_effect_t
*, aout_instance_t
*,
174 aout_buffer_t
*, picture_t
*);
177 { "scope", scope_Run
},
178 { "vuMeter", vuMeter_Run
},
179 { "spectrum", spectrum_Run
},
180 { "spectrometer", spectrometer_Run
},
181 { "dummy", dummy_Run
},
185 /*****************************************************************************
186 * Open: open the visualizer
187 *****************************************************************************/
188 static int Open( vlc_object_t
*p_this
)
190 aout_filter_t
*p_filter
= (aout_filter_t
*)p_this
;
191 aout_filter_sys_t
*p_sys
;
194 char *psz_effects
, *psz_parser
;
198 if( ( p_filter
->input
.i_format
!= VLC_FOURCC('f','l','3','2') &&
199 p_filter
->input
.i_format
!= VLC_FOURCC('f','i','3','2') ) )
204 p_sys
= p_filter
->p_sys
= malloc( sizeof( aout_filter_sys_t
) );
208 p_sys
->i_height
= config_GetInt( p_filter
, "effect-height");
209 p_sys
->i_width
= config_GetInt( p_filter
, "effect-width");
211 if( p_sys
->i_height
< 400 ) p_sys
->i_height
= 400;
212 if( p_sys
->i_width
< 532 ) p_sys
->i_width
= 532;
213 if( (p_sys
->i_height
% 2 ) != 0 ) p_sys
->i_height
--;
214 if( (p_sys
->i_width
% 2 ) != 0 ) p_sys
->i_width
--;
217 p_sys
->effect
= NULL
;
219 /* Parse the effect list */
220 var_Create( p_filter
, "effect-list", VLC_VAR_STRING
| VLC_VAR_DOINHERIT
);
221 var_Get( p_filter
, "effect-list", &val
);
222 psz_parser
= psz_effects
= strdup( val
.psz_string
);
223 free( val
.psz_string
);
225 var_AddCallback( p_filter
, "effect-list", FilterCallback
, NULL
);
227 while( psz_parser
&& *psz_parser
!= '\0' )
229 visual_effect_t
*p_effect
;
232 p_effect
= malloc( sizeof( visual_effect_t
) );
235 p_effect
->i_width
= p_sys
->i_width
;
236 p_effect
->i_height
= p_sys
->i_height
;
237 p_effect
->i_nb_chans
= aout_FormatNbChannels( &p_filter
->input
);
238 p_effect
->psz_args
= NULL
;
239 p_effect
->p_data
= NULL
;
241 p_effect
->pf_run
= NULL
;
242 p_effect
->psz_name
= NULL
;
244 for( i
= 0; pf_effect_run
[i
].psz_name
!= NULL
; i
++ )
246 if( !strncasecmp( psz_parser
,
247 pf_effect_run
[i
].psz_name
,
248 strlen( pf_effect_run
[i
].psz_name
) ) )
250 p_effect
->pf_run
= pf_effect_run
[i
].pf_run
;
251 p_effect
->psz_name
= strdup( pf_effect_run
[i
].psz_name
);
256 if( p_effect
->psz_name
)
258 psz_parser
+= strlen( p_effect
->psz_name
);
260 if( *psz_parser
== '{' )
266 if( ( psz_eoa
= strchr( psz_parser
, '}') ) == NULL
)
268 msg_Err( p_filter
, "unable to parse effect list. Aborting");
272 strndup( psz_parser
, psz_eoa
- psz_parser
);
274 TAB_APPEND( p_sys
->i_effect
, p_sys
->effect
, p_effect
);
278 msg_Err( p_filter
, "unknown visual effect: %s", psz_parser
);
282 if( strchr( psz_parser
, ',' ) )
284 psz_parser
= strchr( psz_parser
, ',' ) + 1;
286 else if( strchr( psz_parser
, ':' ) )
288 psz_parser
= strchr( psz_parser
, ':' ) + 1;
298 if( !p_sys
->i_effect
)
300 msg_Err( p_filter
, "no effects found" );
305 /* Open the video output */
306 memset( &fmt
, 0, sizeof(video_format_t
) );
308 fmt
.i_width
= fmt
.i_visible_width
= p_sys
->i_width
;
309 fmt
.i_height
= fmt
.i_visible_height
= p_sys
->i_height
;
310 fmt
.i_chroma
= VLC_FOURCC('I','4','2','0');
311 fmt
.i_aspect
= VOUT_ASPECT_FACTOR
* p_sys
->i_width
/p_sys
->i_height
;
312 fmt
.i_sar_num
= fmt
.i_sar_den
= 1;
314 p_sys
->p_vout
= aout_filter_RequestVout( p_filter
, NULL
, &fmt
);
315 if( p_sys
->p_vout
== NULL
)
317 msg_Err( p_filter
, "no suitable vout module" );
322 p_filter
->pf_do_work
= DoWork
;
323 p_filter
->b_in_place
= 1;
328 /*****************************************************************************
329 * DoWork: convert a buffer
330 *****************************************************************************
331 * Audio part pasted from trivial.c
332 ****************************************************************************/
333 static void DoWork( aout_instance_t
*p_aout
, aout_filter_t
*p_filter
,
334 aout_buffer_t
*p_in_buf
, aout_buffer_t
*p_out_buf
)
336 aout_filter_sys_t
*p_sys
= p_filter
->p_sys
;
340 p_out_buf
->i_nb_samples
= p_in_buf
->i_nb_samples
;
341 p_out_buf
->i_nb_bytes
= p_in_buf
->i_nb_bytes
*
342 aout_FormatNbChannels( &p_filter
->output
) /
343 aout_FormatNbChannels( &p_filter
->input
);
345 /* First, get a new picture */
346 while( ( p_outpic
= vout_CreatePicture( p_sys
->p_vout
, 0, 0, 3 ) ) == NULL
)
348 if( !vlc_object_alive (p_aout
) )
352 msleep( VOUT_OUTMEM_SLEEP
);
355 /* Blank the picture */
356 for( i
= 0 ; i
< p_outpic
->i_planes
; i
++ )
358 memset( p_outpic
->p
[i
].p_pixels
, i
> 0 ? 0x80 : 0x00,
359 p_outpic
->p
[i
].i_visible_lines
* p_outpic
->p
[i
].i_pitch
);
362 /* We can now call our visualization effects */
363 for( i
= 0; i
< p_sys
->i_effect
; i
++ )
365 #define p_effect p_sys->effect[i]
366 if( p_effect
->pf_run
)
368 p_effect
->pf_run( p_effect
, p_aout
, p_out_buf
, p_outpic
);
373 p_outpic
->date
= ( p_in_buf
->start_date
+ p_in_buf
->end_date
) / 2;
375 vout_DisplayPicture( p_sys
->p_vout
, p_outpic
);
378 /*****************************************************************************
379 * Close: close the plugin
380 *****************************************************************************/
381 static void Close( vlc_object_t
*p_this
)
383 aout_filter_t
* p_filter
= (aout_filter_t
*)p_this
;
384 aout_filter_sys_t
*p_sys
= p_filter
->p_sys
;
388 if( p_filter
->p_sys
->p_vout
)
390 aout_filter_RequestVout( p_filter
, p_filter
->p_sys
->p_vout
, 0 );
394 for( i
= 0; i
< p_sys
->i_effect
; i
++ )
396 #define p_effect p_sys->effect[i]
397 if( !strncmp( p_effect
->psz_name
, "spectrum", strlen( "spectrum" ) ) )
399 free( ( ( spectrum_data
* )p_effect
->p_data
)->peaks
);
400 free( ( ( spectrum_data
* )p_effect
->p_data
)->prev_heights
);
402 free( p_effect
->p_data
);
403 free( p_effect
->psz_name
);
404 free( p_effect
->psz_args
);
409 free( p_sys
->effect
);
410 free( p_filter
->p_sys
);
413 /*****************************************************************************
414 * FilterCallback: called when changing the deinterlace method on the fly.
415 *****************************************************************************/
416 static int FilterCallback( vlc_object_t
*p_this
, char const *psz_cmd
,
417 vlc_value_t oldval
, vlc_value_t newval
,
420 VLC_UNUSED(psz_cmd
); VLC_UNUSED(oldval
);
421 VLC_UNUSED(p_data
); VLC_UNUSED(newval
);
422 aout_filter_t
*p_filter
= (aout_filter_t
*)p_this
;
423 /* restart this baby */
424 msg_Dbg( p_filter
, "we should restart the visual filter" );