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