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

   1 /*****************************************************************************
   2  * visual.c : Visualisation system
   3  *****************************************************************************
   4  * Copyright (C) 2002-2006 the VideoLAN team
   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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #include <vlc/vlc.h>
  28 #include <vlc_vout.h>
  29 #include <vlc_aout.h>
  30
  31 #include "visual.h"
  32
  33 /*****************************************************************************
  34  * Module descriptor
  35  *****************************************************************************/
  36 #define ELIST_TEXT N_( "Effects list" )
  37 #define ELIST_LONGTEXT N_( \
  38       "A list of visual effect, separated by commas.\n"  \
  39       "Current effects include: dummy, scope, spectrum." )
  40
  41 #define WIDTH_TEXT N_( "Video width" )
  42 #define WIDTH_LONGTEXT N_( \
  43       "The width of the effects video window, in pixels." )
  44
  45 #define HEIGHT_TEXT N_( "Video height" )
  46 #define HEIGHT_LONGTEXT N_( \
  47       "The height of the effects video window, in pixels." )
  48
  49 #define NBBANDS_TEXT N_( "Number of bands" )
  50 #define NBBANDS_LONGTEXT N_( \
  51       "Number of bands used by spectrum analyzer, should be 20 or 80." )
  52 #define SPNBBANDS_LONGTEXT N_( \
  53       "Number of bands used by the spectrometer, from 20 to 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         "Draw \"peaks\" in the spectrum analyzer." )
  66
  67 #define ORIG_TEXT N_( "Enable original graphic spectrum" )
  68 #define ORIG_LONGTEXT N_( \
  69         "Enable the \"flat\" spectrum analyzer in the spectrometer." )
  70
  71 #define BANDS_TEXT N_( "Enable bands" )
  72 #define BANDS_LONGTEXT N_( \
  73         "Draw bands in the spectrometer." )
  74
  75 #define BASE_TEXT N_( "Enable base" )
  76 #define BASE_LONGTEXT N_( \
  77         "Defines whether to draw the base of the bands." )
  78
  79 #define RADIUS_TEXT N_( "Base pixel radius" )
  80 #define RADIUS_LONGTEXT N_( \
  81         "Defines radius size in pixels, of base of bands(beginning)." )
  82
  83 #define SSECT_TEXT N_( "Spectral sections" )
  84 #define SSECT_LONGTEXT N_( \
  85         "Determines how many sections of spectrum will exist." )
  86
  87 #define PEAK_HEIGHT_TEXT N_( "Peak height" )
  88 #define PEAK_HEIGHT_LONGTEXT N_( \
  89         "Total pixel height of the peak items." )
  90
  91 #define PEAK_WIDTH_TEXT N_( "Peak extra width" )
  92 #define PEAK_WIDTH_LONGTEXT N_( \
  93         "Additions or subtractions of pixels on the peak width." )
  94
  95 #define COLOR1_TEXT N_( "V-plane color" )
  96 #define COLOR1_LONGTEXT N_( \
  97         "YUV-Color cube shifting across the V-plane ( 0 - 127 )." )
  98
  99 #define STARS_TEXT N_( "Number of stars" )
 100 #define STARS_LONGTEXT N_( \
 101         "Number of stars to draw with random effect." )
 102
 103 static int  Open         ( vlc_object_t * );
 104 static void Close        ( vlc_object_t * );
 105
 106 vlc_module_begin();
 107     set_shortname( _("Visualizer"));
 108     set_category( CAT_AUDIO );
 109     set_subcategory( SUBCAT_AUDIO_VISUAL );
 110     set_description( _("Visualizer filter") );
 111     set_section( N_( "General") , NULL );
 112     add_string("effect-list", "spectrum", NULL,
 113             ELIST_TEXT, ELIST_LONGTEXT, VLC_TRUE );
 114     add_integer("effect-width",VOUT_WIDTH,NULL,
 115              WIDTH_TEXT, WIDTH_LONGTEXT, VLC_FALSE );
 116     add_integer("effect-height" , VOUT_HEIGHT , NULL,
 117              HEIGHT_TEXT, HEIGHT_LONGTEXT, VLC_FALSE );
 118     set_section( N_("Spectrum analyser") , NULL );
 119     add_integer("visual-nbbands", 80, NULL,
 120              NBBANDS_TEXT, NBBANDS_LONGTEXT, VLC_TRUE );
 121     add_integer("visual-separ", 1, NULL,
 122              SEPAR_TEXT, SEPAR_LONGTEXT, VLC_TRUE );
 123     add_integer("visual-amp", 3, NULL,
 124              AMP_TEXT, AMP_LONGTEXT, VLC_TRUE );
 125     add_bool("visual-peaks", VLC_TRUE, NULL,
 126              PEAKS_TEXT, PEAKS_LONGTEXT, VLC_TRUE );
 127     set_section( N_("Spectrometer") , NULL );
 128     add_bool("spect-show-original", VLC_FALSE, NULL,
 129              ORIG_TEXT, ORIG_LONGTEXT, VLC_TRUE );
 130     add_bool("spect-show-base", VLC_TRUE, NULL,
 131              BASE_TEXT, BASE_LONGTEXT, VLC_TRUE );
 132     add_integer("spect-radius", 42, NULL,
 133              RADIUS_TEXT, RADIUS_LONGTEXT, VLC_TRUE );
 134     add_integer("spect-sections", 3, NULL,
 135              SSECT_TEXT, SSECT_LONGTEXT, VLC_TRUE );
 136     add_integer("spect-color", 80, NULL,
 137              COLOR1_TEXT, COLOR1_LONGTEXT, VLC_TRUE );
 138     add_bool("spect-show-bands", VLC_TRUE, NULL,
 139              BANDS_TEXT, BANDS_LONGTEXT, VLC_TRUE );
 140     add_integer("spect-nbbands", 32, NULL,
 141              NBBANDS_TEXT, SPNBBANDS_LONGTEXT, VLC_TRUE );
 142     add_integer("spect-separ", 1, NULL,
 143              SEPAR_TEXT, SEPAR_LONGTEXT, VLC_TRUE );
 144     add_integer("spect-amp", 8, NULL,
 145              AMP_TEXT, AMP_LONGTEXT, VLC_TRUE );
 146     add_bool("spect-show-peaks", VLC_TRUE, NULL,
 147              PEAKS_TEXT, PEAKS_LONGTEXT, VLC_TRUE );
 148     add_integer("spect-peak-width", 61, NULL,
 149              PEAK_WIDTH_TEXT, PEAK_WIDTH_LONGTEXT, VLC_TRUE );
 150     add_integer("spect-peak-height", 1, NULL,
 151              PEAK_HEIGHT_TEXT, PEAK_HEIGHT_LONGTEXT, VLC_TRUE );
 152     set_capability( "visualization", 0 );
 153     set_callbacks( Open, Close );
 154     add_shortcut( "visualizer");
 155 vlc_module_end();
 156
 157
 158 /*****************************************************************************
 159  * Local prototypes
 160  *****************************************************************************/
 161 static void DoWork( aout_instance_t *, aout_filter_t *,
 162                     aout_buffer_t *, aout_buffer_t * );
 163 static int FilterCallback( vlc_object_t *, char const *,
 164                            vlc_value_t, vlc_value_t, void * );
 165 static struct
 166 {
 167     const char *psz_name;
 168     int  (*pf_run)( visual_effect_t *, aout_instance_t *,
 169                     aout_buffer_t *, picture_t *);
 170 } pf_effect_run[]=
 171 {
 172     { "scope",      scope_Run },
 173     { "spectrum",   spectrum_Run },
 174     { "spectrometer",   spectrometer_Run },
 175     { "dummy",      dummy_Run},
 176     { NULL,         dummy_Run}
 177 };
 178
 179 /*****************************************************************************
 180  * Open: open the visualizer
 181  *****************************************************************************/
 182 static int Open( vlc_object_t *p_this )
 183 {
 184     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
 185     aout_filter_sys_t *p_sys;
 186     vlc_value_t        val;
 187
 188     char *psz_effects, *psz_parser;
 189     video_format_t fmt;
 190
 191
 192     if( ( p_filter->input.i_format != VLC_FOURCC('f','l','3','2') &&
 193           p_filter->input.i_format != VLC_FOURCC('f','i','3','2') ) )
 194     {
 195         return VLC_EGENERIC;
 196     }
 197
 198     p_sys = p_filter->p_sys = malloc( sizeof( aout_filter_sys_t ) );
 199     if( p_sys == NULL )
 200     {
 201         msg_Err( p_filter, "out of memory" );
 202         return VLC_EGENERIC;
 203     }
 204
 205     p_sys->i_height = config_GetInt( p_filter , "effect-height");
 206     p_sys->i_width  = config_GetInt( p_filter , "effect-width");
 207
 208     if( p_sys->i_height < 20 ) p_sys->i_height =  20;
 209     if( p_sys->i_width  < 20 ) p_sys->i_width  =  20;
 210     if( (p_sys->i_height % 2 ) != 0 ) p_sys->i_height--;
 211     if( (p_sys->i_width % 2 )  != 0 ) p_sys->i_width--;
 212
 213     p_sys->i_effect = 0;
 214     p_sys->effect   = NULL;
 215
 216     /* Parse the effect list */
 217     var_Create( p_filter, "effect-list", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 218     var_Get( p_filter, "effect-list", &val);
 219     psz_parser = psz_effects = strdup( val.psz_string );
 220     free( val.psz_string );
 221
 222     var_AddCallback( p_filter, "effect-list", FilterCallback, NULL );
 223
 224     while( psz_parser && *psz_parser != '\0' )
 225     {
 226         visual_effect_t *p_effect;
 227         int  i;
 228
 229         p_effect = malloc( sizeof( visual_effect_t ) );
 230         p_effect->i_width = p_sys->i_width;
 231         p_effect->i_height= p_sys->i_height;
 232         p_effect->i_nb_chans = aout_FormatNbChannels( &p_filter->input);
 233         p_effect->psz_args = NULL;
 234         p_effect->p_data = NULL;
 235
 236         p_effect->pf_run = NULL;
 237         p_effect->psz_name = NULL;
 238
 239         for( i = 0; pf_effect_run[i].psz_name != NULL; i++ )
 240         {
 241             if( !strncasecmp( psz_parser,
 242                               pf_effect_run[i].psz_name,
 243                               strlen( pf_effect_run[i].psz_name ) ) )
 244             {
 245                 p_effect->pf_run = pf_effect_run[i].pf_run;
 246                 p_effect->psz_name = strdup( pf_effect_run[i].psz_name );
 247                 break;
 248             }
 249         }
 250
 251         if( p_effect->psz_name )
 252         {
 253             psz_parser += strlen( p_effect->psz_name );
 254
 255             if( *psz_parser == '{' )
 256             {
 257                 char *psz_eoa;
 258
 259                 psz_parser++;
 260
 261                 if( ( psz_eoa = strchr( psz_parser, '}') ) == NULL )
 262                 {
 263                    msg_Err( p_filter, "unable to parse effect list. Aborting");
 264                    break;
 265                 }
 266                 p_effect->psz_args =
 267                     strndup( psz_parser, psz_eoa - psz_parser);
 268             }
 269             TAB_APPEND( p_sys->i_effect, p_sys->effect, p_effect );
 270         }
 271         else
 272         {
 273             msg_Err( p_filter, "unknown visual effect: %s", psz_parser );
 274             free( p_effect );
 275         }
 276
 277         if( strchr( psz_parser, ',' ) )
 278         {
 279             psz_parser = strchr( psz_parser, ',' ) + 1;
 280         }
 281         else if( strchr( psz_parser, ':' ) )
 282         {
 283             psz_parser = strchr( psz_parser, ':' ) + 1;
 284         }
 285         else
 286         {
 287             break;
 288         }
 289     }
 290
 291     if( psz_effects )
 292     {
 293         free( psz_effects );
 294     }
 295
 296     if( !p_sys->i_effect )
 297     {
 298         msg_Err( p_filter, "no effects found" );
 299         free( p_sys );
 300         return VLC_EGENERIC;
 301     }
 302
 303     /* Open the video output */
 304     memset( &fmt, 0, sizeof(video_format_t) );
 305
 306     fmt.i_width = fmt.i_visible_width = p_sys->i_width;
 307     fmt.i_height = fmt.i_visible_height = p_sys->i_height;
 308     fmt.i_chroma = VLC_FOURCC('I','4','2','0');
 309     fmt.i_aspect = VOUT_ASPECT_FACTOR * p_sys->i_width/p_sys->i_height;
 310     fmt.i_sar_num = fmt.i_sar_den = 1;
 311
 312     p_sys->p_vout = vout_Request( p_filter, NULL, &fmt );
 313     if( p_sys->p_vout == NULL )
 314     {
 315         msg_Err( p_filter, "no suitable vout module" );
 316         free( p_sys );
 317         return VLC_EGENERIC;
 318     }
 319
 320     p_filter->pf_do_work = DoWork;
 321     p_filter->b_in_place= 1;
 322
 323     return VLC_SUCCESS;
 324 }
 325
 326 /*****************************************************************************
 327  * DoWork: convert a buffer
 328  *****************************************************************************
 329  * Audio part pasted from trivial.c
 330  ****************************************************************************/
 331 static void DoWork( aout_instance_t *p_aout, aout_filter_t *p_filter,
 332                     aout_buffer_t *p_in_buf, aout_buffer_t *p_out_buf )
 333 {
 334     aout_filter_sys_t *p_sys = p_filter->p_sys;
 335     picture_t *p_outpic;
 336     int i;
 337
 338     p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
 339     p_out_buf->i_nb_bytes = p_in_buf->i_nb_bytes *
 340                             aout_FormatNbChannels( &p_filter->output ) /
 341                             aout_FormatNbChannels( &p_filter->input );
 342
 343     /* First, get a new picture */
 344     while( ( p_outpic = vout_CreatePicture( p_sys->p_vout, 0, 0, 3 ) ) == NULL)
 345     {
 346         if( p_aout->b_die )
 347         {
 348             return;
 349         }
 350         msleep( VOUT_OUTMEM_SLEEP );
 351     }
 352
 353     /* Blank the picture */
 354     for( i = 0 ; i < p_outpic->i_planes ; i++ )
 355     {
 356         memset( p_outpic->p[i].p_pixels, i > 0 ? 0x80 : 0x00,
 357                 p_outpic->p[i].i_visible_lines * p_outpic->p[i].i_pitch );
 358     }
 359
 360     /* We can now call our visualization effects */
 361     for( i = 0; i < p_sys->i_effect; i++ )
 362     {
 363 #define p_effect p_sys->effect[i]
 364         if( p_effect->pf_run )
 365         {
 366             p_effect->pf_run( p_effect, p_aout, p_out_buf, p_outpic );
 367         }
 368 #undef p_effect
 369     }
 370
 371     vout_DatePicture( p_sys->p_vout, p_outpic,
 372                       ( p_in_buf->start_date + p_in_buf->end_date ) / 2 );
 373
 374     vout_DisplayPicture( p_sys->p_vout, p_outpic );
 375 }
 376
 377 /*****************************************************************************
 378  * Close: close the plugin
 379  *****************************************************************************/
 380 static void Close( vlc_object_t *p_this )
 381 {
 382     aout_filter_t * p_filter = (aout_filter_t *)p_this;
 383     aout_filter_sys_t *p_sys = p_filter->p_sys;
 384
 385     int i;
 386
 387     if( p_filter->p_sys->p_vout )
 388     {
 389         vout_Request( p_filter, p_filter->p_sys->p_vout, 0 );
 390     }
 391
 392     /* Free the list */
 393     for( i = 0; i < p_sys->i_effect; i++ )
 394     {
 395 #define p_effect p_sys->effect[i]
 396         if( p_effect->psz_name )
 397         {
 398             free( p_effect->psz_name );
 399         }
 400         if( p_effect->psz_args )
 401         {
 402             free( p_effect->psz_args );
 403         }
 404         free( p_effect );
 405 #undef p_effect
 406     }
 407
 408     if( p_sys->effect )
 409     {
 410         free( p_sys->effect );
 411     }
 412
 413     free( p_filter->p_sys );
 414 }
 415
 416 /*****************************************************************************
 417  * FilterCallback: called when changing the deinterlace method on the fly.
 418  *****************************************************************************/
 419 static int FilterCallback( vlc_object_t *p_this, char const *psz_cmd,
 420                            vlc_value_t oldval, vlc_value_t newval,
 421                            void *p_data )
 422 {
 423     aout_filter_t     *p_filter = (aout_filter_t *)p_this;
 424     /* restart this baby */
 425     msg_Dbg( p_filter, "we should restart the visual filter" );
 426     return VLC_SUCCESS;
 427 }
 428