git.sesse.net Git - vlc/blob - modules/visualization/visual/visual.c

   1 /*****************************************************************************
   2  * visual.c : Visualisation system
   3  *****************************************************************************
   4  * Copyright (C) 2002 VideoLAN
   5  * $Id$
   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     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");
 101 vlc_module_end();
 102
 103
 104 /*****************************************************************************
 105  * Local prototypes
 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 * );
 111 static struct
 112 {
 113     char *psz_name;
 114     int  (*pf_run)( visual_effect_t *, aout_instance_t *,
 115                     aout_buffer_t *, picture_t *);
 116 } pf_effect_run[]=
 117 {
 118     { "scope",      scope_Run },
 119     { "spectrum",   spectrum_Run },
 120     { "random",     random_Run},
 121     { "dummy",      dummy_Run},
 122     { NULL,         dummy_Run}
 123 };
 124
 125 /*****************************************************************************
 126  * Open: open the visualizer
 127  *****************************************************************************/
 128 static int Open( vlc_object_t *p_this )
 129 {
 130     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
 131     aout_filter_sys_t *p_sys;
 132     vlc_value_t        val;
 133
 134     char *psz_effects, *psz_parser;
 135
 136     if( ( p_filter->input.i_format != VLC_FOURCC('f','l','3','2') &&
 137           p_filter->input.i_format != VLC_FOURCC('f','i','3','2') ) )
 138     {
 139         return VLC_EGENERIC;
 140     }
 141
 142     p_sys = p_filter->p_sys = malloc( sizeof( aout_filter_sys_t ) );
 143     if( p_sys == NULL )
 144     {
 145         msg_Err( p_filter, "out of memory" );
 146         return VLC_EGENERIC;
 147     }
 148
 149     p_sys->i_height = config_GetInt( p_filter , "effect-height");
 150     p_sys->i_width  = config_GetInt( p_filter , "effect-width");
 151
 152     if( p_sys->i_height < 20 ) p_sys->i_height =  20;
 153     if( p_sys->i_width  < 20 ) p_sys->i_width  =  20;
 154     if( (p_sys->i_height % 2 ) != 0 ) p_sys->i_height--;
 155     if( (p_sys->i_width % 2 )  != 0 ) p_sys->i_width--;
 156
 157     p_sys->i_effect = 0;
 158     p_sys->effect   = NULL;
 159
 160     /* Parse the effect list */
 161     var_Create( p_filter, "effect-list", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 162     var_Get( p_filter, "effect-list", &val);
 163     psz_parser = psz_effects = strdup( val.psz_string );
 164     free( val.psz_string );
 165     msg_Dbg( p_filter , "Building list of effects" );
 166
 167     var_AddCallback( p_filter, "effect-list", FilterCallback, NULL );
 168
 169     while( psz_parser && *psz_parser != '\0' )
 170     {
 171         visual_effect_t *p_effect;
 172         int  i;
 173
 174         p_effect = malloc( sizeof( visual_effect_t ) );
 175         p_effect->i_width = p_sys->i_width;
 176         p_effect->i_height= p_sys->i_height;
 177         p_effect->i_nb_chans = aout_FormatNbChannels( &p_filter->input);
 178         p_effect->psz_args = NULL;
 179         p_effect->p_data = NULL;
 180
 181         p_effect->pf_run = NULL;
 182         p_effect->psz_name = NULL;
 183
 184         for( i = 0; pf_effect_run[i].psz_name != NULL; i++ )
 185         {
 186             if( !strncasecmp( psz_parser,
 187                               pf_effect_run[i].psz_name,
 188                               strlen( pf_effect_run[i].psz_name ) ) )
 189             {
 190                 p_effect->pf_run = pf_effect_run[i].pf_run;
 191                 p_effect->psz_name = strdup( pf_effect_run[i].psz_name );
 192                 break;
 193             }
 194         }
 195
 196         if( p_effect->psz_name )
 197         {
 198             psz_parser += strlen( p_effect->psz_name );
 199
 200             if( *psz_parser == '{' )
 201             {
 202                 char *psz_eoa;
 203
 204                 psz_parser++;
 205
 206                 if( ( psz_eoa = strchr( psz_parser, '}') ) == NULL )
 207                 {
 208                    msg_Err( p_filter, "Unable to parse effect list. Aborting");
 209                    break;
 210                 }
 211                 p_effect->psz_args =
 212                     strndup( psz_parser, psz_eoa - psz_parser);
 213             }
 214             TAB_APPEND( p_sys->i_effect, p_sys->effect, p_effect );
 215         }
 216         else
 217         {
 218             msg_Err( p_filter, "unknown visual effect: %s", psz_parser );
 219             free( p_effect );
 220         }
 221
 222         if( strchr( psz_parser, ',' ) )
 223         {
 224             psz_parser = strchr( psz_parser, ',' ) + 1;
 225         }
 226         else if( strchr( psz_parser, ':' ) )
 227         {
 228             psz_parser = strchr( psz_parser, ':' ) + 1;
 229         }
 230         else
 231         {
 232             break;
 233         }
 234     }
 235
 236     if( psz_effects )
 237     {
 238         free( psz_effects );
 239     }
 240
 241     if( !p_sys->i_effect )
 242     {
 243         msg_Err( p_filter, "no effects found" );
 244         free( p_sys );
 245         return VLC_EGENERIC;
 246     }
 247
 248     /* Open the video output */
 249     p_sys->p_vout =
 250          vout_Request( p_filter, NULL,
 251                        p_sys->i_width, p_sys->i_height,
 252                        VLC_FOURCC('I','4','2','0'),
 253                        VOUT_ASPECT_FACTOR * p_sys->i_width/p_sys->i_height );
 254
 255     if( p_sys->p_vout == NULL )
 256     {
 257         msg_Err( p_filter, "no suitable vout module" );
 258         free( p_sys );
 259         return VLC_EGENERIC;
 260     }
 261
 262     p_filter->pf_do_work = DoWork;
 263     p_filter->b_in_place= 1;
 264
 265     msg_Dbg( p_filter,"Visualizer initialized");
 266     return VLC_SUCCESS;
 267 }
 268
 269 /*****************************************************************************
 270  * DoWork: convert a buffer
 271  *****************************************************************************
 272  * Audio part pasted from trivial.c
 273  ****************************************************************************/
 274 static void DoWork( aout_instance_t *p_aout, aout_filter_t *p_filter,
 275                     aout_buffer_t *p_in_buf, aout_buffer_t *p_out_buf )
 276 {
 277     aout_filter_sys_t *p_sys = p_filter->p_sys;
 278     picture_t *p_outpic;
 279     int i;
 280
 281     p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
 282     p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes *
 283                             aout_FormatNbChannels( &p_filter->output ) /
 284                             aout_FormatNbChannels( &p_filter->input );
 285
 286     /* First, get a new picture */
 287     while( ( p_outpic = vout_CreatePicture( p_sys->p_vout, 0, 0, 3 ) ) == NULL)
 288     {
 289         if( p_aout->b_die )
 290         {
 291             return;
 292         }
 293         msleep( VOUT_OUTMEM_SLEEP );
 294     }
 295
 296     /* Blank the picture */
 297     for( i = 0 ; i < p_outpic->i_planes ; i++ )
 298     {
 299         memset( p_outpic->p[i].p_pixels, i > 0 ? 0x80 : 0x00,
 300                 p_outpic->p[i].i_visible_lines * p_outpic->p[i].i_pitch );
 301     }
 302
 303     /* We can now call our visualization effects */
 304     for( i = 0; i < p_sys->i_effect; i++ )
 305     {
 306 #define p_effect p_sys->effect[i]
 307         if( p_effect->pf_run )
 308         {
 309             p_effect->pf_run( p_effect, p_aout, p_out_buf, p_outpic );
 310         }
 311 #undef p_effect
 312     }
 313
 314     vout_DatePicture( p_sys->p_vout, p_outpic,
 315                       ( p_in_buf->start_date + p_in_buf->end_date ) / 2 );
 316
 317     vout_DisplayPicture( p_sys->p_vout, p_outpic );
 318 }
 319
 320 /*****************************************************************************
 321  * Close: close the plugin
 322  *****************************************************************************/
 323 static void Close( vlc_object_t *p_this )
 324 {
 325     aout_filter_t * p_filter = (aout_filter_t *)p_this;
 326     aout_filter_sys_t *p_sys = p_filter->p_sys;
 327
 328     int i;
 329
 330     if( p_filter->p_sys->p_vout )
 331     {
 332         vout_Request( p_filter, p_filter->p_sys->p_vout, 0, 0, 0, 0 );
 333     }
 334
 335     /* Free the list */
 336     for( i = 0; i < p_sys->i_effect; i++ )
 337     {
 338 #define p_effect p_sys->effect[i]
 339         if( p_effect->psz_name )
 340         {
 341             free( p_effect->psz_name );
 342         }
 343         if( p_effect->psz_args )
 344         {
 345             free( p_effect->psz_args );
 346         }
 347         free( p_effect );
 348 #undef p_effect
 349     }
 350
 351     if( p_sys->effect )
 352     {
 353         free( p_sys->effect );
 354     }
 355
 356     free( p_filter->p_sys );
 357 }
 358
 359 /*****************************************************************************
 360  * FilterCallback: called when changing the deinterlace method on the fly.
 361  *****************************************************************************/
 362 static int FilterCallback( vlc_object_t *p_this, char const *psz_cmd,
 363                            vlc_value_t oldval, vlc_value_t newval,
 364                            void *p_data )
 365 {
 366     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
 367     /* restart this baby */
 368     msg_Dbg( p_filter, "We should restart the visual filter" );
 369     return VLC_SUCCESS;
 370 }
 371