* modules/misc/dummy/renderer.c:
[vlc.git] / modules / visualization / visual / visual.c
1 /*****************************************************************************
2  * visual.c : Visualisation system
3  *****************************************************************************
4  * Copyright (C) 2002 VideoLAN
5  * $Id: visual.c,v 1.12 2003/12/04 16:49:43 sam Exp $
6  *
7  * Authors: ClĂ©ment Stenac <zorglub@via.ecp.fr>
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 <vlc/vlc.h>
29 #include <vlc/vout.h>
30 #include "audio_output.h"
31 #include "aout_internal.h"
32
33 #include "visual.h"
34
35 /*****************************************************************************
36  * Module descriptor
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" )
42
43 #define WIDTH_TEXT N_( "Video width" )
44 #define WIDTH_LONGTEXT N_( \
45       "The width of the effects video window, in pixels." )
46
47 #define HEIGHT_TEXT N_( "Video height" )
48 #define HEIGHT_LONGTEXT N_( \
49       "The height of the effects video window, in pixels." )
50
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" )
54
55 #define SEPAR_TEXT N_( "Band separator" )
56 #define SEPAR_LONGTEXT N_( \
57         "Number of blank pixels between bands")
58
59 #define AMP_TEXT N_( "Amplification" )
60 #define AMP_LONGTEXT N_( \
61         "This is a coefficient that modifies the height of the bands")
62
63 #define PEAKS_TEXT N_( "Enable peaks" )
64 #define PEAKS_LONGTEXT N_( \
65         "Defines whether to draw peaks" )
66
67 #define STARS_TEXT N_( "Number of stars" )
68 #define STARS_LONGTEXT N_( \
69         "Defines the number of stars to draw with random effect" )
70
71 static int  Open         ( vlc_object_t * );
72 static void Close        ( vlc_object_t * );
73
74 vlc_module_begin();
75     add_category_hint( N_("visualizer") , NULL , VLC_FALSE);
76     set_description( _("visualizer filter") );
77     add_string("effect-list", "dummy", NULL,
78             ELIST_TEXT, ELIST_LONGTEXT, VLC_TRUE );
79     add_integer("effect-width",VOUT_WIDTH,NULL,
80              WIDTH_TEXT, WIDTH_LONGTEXT, VLC_FALSE );
81     add_integer("effect-height" , VOUT_HEIGHT , NULL,
82              HEIGHT_TEXT, HEIGHT_LONGTEXT, VLC_FALSE );
83     add_integer("visual-nbbands", 80, NULL,
84              NBBANDS_TEXT, NBBANDS_LONGTEXT, VLC_FALSE );
85     add_integer("visual-separ", 1, NULL,
86              SEPAR_TEXT, SEPAR_LONGTEXT, VLC_FALSE );
87     add_integer("visual-amp", 3, NULL,
88              AMP_TEXT, AMP_LONGTEXT, VLC_FALSE );
89     add_bool("visual-peaks", VLC_TRUE, NULL,
90              PEAKS_TEXT, PEAKS_LONGTEXT, VLC_FALSE );
91     add_integer("visual-stars", 200, NULL,
92              STARS_TEXT, STARS_LONGTEXT, VLC_FALSE );
93     set_capability( "audio filter", 0 );
94     set_callbacks( Open, Close );
95     add_shortcut( "visualizer");
96 vlc_module_end();
97
98
99 /*****************************************************************************
100  * Local prototypes
101  *****************************************************************************/
102 static void DoWork( aout_instance_t *, aout_filter_t *,
103                     aout_buffer_t *, aout_buffer_t * );
104 static int FilterCallback( vlc_object_t *, char const *,
105                            vlc_value_t, vlc_value_t, void * );
106 static struct
107 {
108     char *psz_name;
109     int  (*pf_run)( visual_effect_t *, aout_instance_t *,
110                     aout_buffer_t *, picture_t *);
111 } pf_effect_run[]=
112 {
113     { "scope",      scope_Run },
114     { "spectrum",   spectrum_Run },
115     { "random",     random_Run},
116     { "dummy",      dummy_Run},
117     { NULL,         dummy_Run}
118 };
119
120 /*****************************************************************************
121  * Open: open the visualizer
122  *****************************************************************************/
123 static int Open( vlc_object_t *p_this )
124 {
125     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
126     aout_filter_sys_t *p_sys;
127     vlc_value_t        val;
128
129     char *psz_effects, *psz_parser;
130
131     if( ( p_filter->input.i_format != VLC_FOURCC('f','l','3','2') &&
132           p_filter->input.i_format != VLC_FOURCC('f','i','3','2') ) )
133     {
134         return VLC_EGENERIC;
135     }
136
137     p_sys = p_filter->p_sys = malloc( sizeof( aout_filter_sys_t ) );
138     if( p_sys == NULL )
139     {
140         msg_Err( p_filter, "out of memory" );
141         return VLC_EGENERIC;
142     }
143
144     p_sys->i_height = config_GetInt( p_filter , "effect-height");
145     p_sys->i_width  = config_GetInt( p_filter , "effect-width");
146
147     if( p_sys->i_height < 20 ) p_sys->i_height =  20;
148     if( p_sys->i_width  < 20 ) p_sys->i_width  =  20;
149     if( (p_sys->i_height % 2 ) != 0 ) p_sys->i_height--;
150     if( (p_sys->i_width % 2 )  != 0 ) p_sys->i_width--;
151
152     p_sys->i_effect = 0;
153     p_sys->effect   = NULL;
154
155     /* Parse the effect list */
156     var_Create( p_filter, "effect-list", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
157     var_Get( p_filter, "effect-list", &val);
158     psz_parser = psz_effects = strdup( val.psz_string );
159     free( val.psz_string );
160     msg_Dbg( p_filter , "Building list of effects" );
161     
162     var_AddCallback( p_filter, "effect-list", FilterCallback, NULL );
163
164     while( psz_parser && *psz_parser != '\0' )
165     {
166         visual_effect_t *p_effect;
167         int  i;
168
169         p_effect = malloc( sizeof( visual_effect_t ) );
170         p_effect->i_width = p_sys->i_width;
171         p_effect->i_height= p_sys->i_height;
172         p_effect->i_nb_chans = aout_FormatNbChannels( &p_filter->input);
173         p_effect->psz_args = NULL;
174         p_effect->p_data = NULL;
175
176         p_effect->pf_run = NULL;
177         p_effect->psz_name = NULL;
178
179         for( i = 0; pf_effect_run[i].psz_name != NULL; i++ )
180         {
181             if( !strncasecmp( psz_parser,
182                               pf_effect_run[i].psz_name,
183                               strlen( pf_effect_run[i].psz_name ) ) )
184             {
185                 p_effect->pf_run = pf_effect_run[i].pf_run;
186                 p_effect->psz_name = strdup( pf_effect_run[i].psz_name );
187                 break;
188             }
189         }
190
191         if( p_effect->psz_name )
192         {
193             psz_parser += strlen( p_effect->psz_name );
194
195             if( *psz_parser == '{' )
196             {
197                 char *psz_eoa;
198
199                 psz_parser++;
200
201                 if( ( psz_eoa = strchr( psz_parser, '}') ) == NULL )
202                 {
203                    msg_Err( p_filter, "Unable to parse effect list. Aborting");
204                    break;
205                 }
206                 p_effect->psz_args = strndup( psz_parser, psz_eoa - psz_parser);
207             }
208         }
209         else
210         {
211             msg_Err( p_filter, "unknown visual effect" );
212         }
213
214         TAB_APPEND( p_sys->i_effect, p_sys->effect, p_effect );
215
216         if( strchr( psz_parser, ',' ) )
217         {
218             psz_parser = strchr( psz_parser, ',' ) + 1;
219         }
220         else if( strchr( psz_parser, ':' ) )
221         {
222             psz_parser = strchr( psz_parser, ':' ) + 1;
223         }
224         else
225         {
226             break;
227         }
228     }
229
230     if( psz_effects )
231     {
232         free( psz_effects );
233     }
234
235
236     /* Open the video output */
237     p_sys->p_vout =
238          vout_Request( p_filter, NULL,
239                        p_sys->i_width, p_sys->i_height,
240                        VLC_FOURCC('I','4','2','0'),
241                        VOUT_ASPECT_FACTOR * p_sys->i_width/p_sys->i_height );
242
243     if( p_sys->p_vout == NULL )
244     {
245         msg_Err( p_filter, "no suitable vout module" );
246         free( p_sys );
247         return VLC_EGENERIC;
248     }
249
250     p_filter->pf_do_work = DoWork;
251     p_filter->b_in_place= 1;
252
253     msg_Dbg( p_filter,"Visualizer initialized");
254     return VLC_SUCCESS;
255 }
256
257 /*****************************************************************************
258  * DoWork: convert a buffer
259  *****************************************************************************
260  * Audio part pasted from trivial.c
261  ****************************************************************************/
262 static void DoWork( aout_instance_t *p_aout, aout_filter_t *p_filter,
263                     aout_buffer_t *p_in_buf, aout_buffer_t *p_out_buf )
264 {
265     aout_filter_sys_t *p_sys = p_filter->p_sys;
266     picture_t *p_outpic;
267     int i;
268
269     p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
270     p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes *
271                             aout_FormatNbChannels( &p_filter->output ) /
272                             aout_FormatNbChannels( &p_filter->input );
273
274     /* First, get a new picture */
275     while( ( p_outpic = vout_CreatePicture( p_sys->p_vout, 0, 0, 3 ) ) == NULL)
276     {
277         if( p_aout->b_die )
278         {
279             return;
280         }
281         msleep( VOUT_OUTMEM_SLEEP );
282     }
283
284     /* Blank the picture */
285     for( i = 0 ; i < p_outpic->i_planes ; i++ )
286     {
287         memset( p_outpic->p[i].p_pixels, i > 0 ? 0x80 : 0x00,
288                 p_outpic->p[i].i_lines * p_outpic->p[i].i_pitch );
289     }
290
291     /* We can now call our visualization effects */
292     for( i = 0; i < p_sys->i_effect; i++ )
293     {
294 #define p_effect p_sys->effect[i]
295         if( p_effect->pf_run )
296         {
297             p_effect->pf_run( p_effect, p_aout, p_out_buf, p_outpic );
298         }
299 #undef p_effect
300     }
301
302     vout_DatePicture( p_sys->p_vout, p_outpic,
303                       ( p_in_buf->start_date + p_in_buf->end_date ) / 2 );
304
305     vout_DisplayPicture( p_sys->p_vout, p_outpic );
306 }
307
308 /*****************************************************************************
309  * Close: close the plugin
310  *****************************************************************************/
311 static void Close( vlc_object_t *p_this )
312 {
313     aout_filter_t * p_filter = (aout_filter_t *)p_this;
314     aout_filter_sys_t *p_sys = p_filter->p_sys;
315
316     int i;
317
318     if( p_filter->p_sys->p_vout )
319     {
320         vout_Request( p_filter, p_filter->p_sys->p_vout, 0, 0, 0, 0 );
321     }
322
323     /* Free the list */
324     for( i = 0; i < p_sys->i_effect; i++ )
325     {
326 #define p_effect p_sys->effect[i]
327         if( p_effect->psz_name )
328         {
329             free( p_effect->psz_name );
330         }
331         if( p_effect->psz_args )
332         {
333             free( p_effect->psz_args );
334         }
335         free( p_effect );
336 #undef p_effect
337     }
338
339     if( p_sys->effect )
340     {
341         free( p_sys->effect );
342     }
343
344     free( p_filter->p_sys );
345 }
346
347 /*****************************************************************************
348  * FilterCallback: called when changing the deinterlace method on the fly.
349  *****************************************************************************/
350 static int FilterCallback( vlc_object_t *p_this, char const *psz_cmd,
351                            vlc_value_t oldval, vlc_value_t newval,
352                            void *p_data )
353 {
354     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
355     /* restart this baby */
356     msg_Dbg( p_filter, "We should restart the visual filter" );
357     return VLC_SUCCESS;
358 }
359