Added support for audio visualization: Vovoid VSXu

Signed-off-by: Rémi Denis-Courmont <remi@remlab.net>

configure.ac

@@ -3892,6 +3892,23 @@ AS_IF([test "${enable_projectm}" != "no"],
     ])
   ])
 
+dnl
+dnl Vovoid VSXu visualization plugin
+dnl
+AC_ARG_ENABLE(vsxu,
+  [  --enable-vsxu           Vovoid VSXu visualization plugin (default auto)])
+AS_IF([test "${enable_vsxu}" != "no"],
+  [
+    PKG_CHECK_MODULES(VSXU, libvsxu,
+    [
+      VLC_ADD_PLUGIN([vsxu])
+      VLC_ADD_CXXFLAGS([vsxu],[$VSXU_CFLAGS])
+      VLC_ADD_LIBS([vsxu],[$VSXU_LIBS])
+    ],[
+      AC_MSG_WARN([${VSXU_PKG_ERRORS}.])
+    ])
+  ])
+
 dnl
 dnl  AtmoLight (homemade Philips Ambilight clone)
 dnl

modules/LIST

@@ -368,6 +368,7 @@ $Id$
  * vout_ios: iOS video output
  * vout_macosx: MacOS X OpenGL provider
  * vout_sdl: video output module using the SDL library
+ * vsxu: audio visualization using Vovoid VSXu
  * wall: image wall filter
  * wav: Wav demuxer
  * wave: Wave video effect

modules/visualization/Modules.am

 SUBDIRS = visual
 SOURCES_goom = goom.c
 SOURCES_projectm = projectm.cpp
+SOURCES_vsxu = vsxu.cpp cyclic_buffer.h

modules/visualization/cyclic_buffer.h

+/*****************************************************************************
+ * cyclic_buffer.h cyclic buffer helper class for vlc's audio visualizations
+ *****************************************************************************
+ * Copyright © 2012 Vovoid Media Technologies
+ *
+ * Authors: Jonatan "jaw" Wallmander
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ *****************************************************************************/
+
+#ifndef CYCLIC_BUFFER_H
+#define CYCLIC_BUFFER_H
+
+
+class block_holder
+{
+public:
+    float data[512]; // data holder
+    mtime_t pts; // machine time when this is to be played
+    block_holder()
+    {
+        pts = 0; // max_int 64-bit
+    }
+};
+
+#define CYCLIC_BUFFER_SIZE 128
+class cyclic_block_queue
+{
+    block_holder cycl_buffer[CYCLIC_BUFFER_SIZE];
+    size_t consumer_pos;
+    size_t insertion_pos;
+public:
+    cyclic_block_queue()
+    {
+        consumer_pos = 0;
+        insertion_pos = 0;
+    }
+
+    block_holder* consume()
+    {
+        mtime_t cur_machine_time = mdate();
+        size_t steps = 0;
+        while (
+               (cycl_buffer[consumer_pos].pts < cur_machine_time)
+               &&
+               (steps++ < CYCLIC_BUFFER_SIZE)
+              )
+        {
+            consumer_pos++;
+            if (consumer_pos == CYCLIC_BUFFER_SIZE)
+            {
+                consumer_pos = 0;
+            }
+        }
+        return &cycl_buffer[consumer_pos];
+    }
+
+  block_holder* get_insertion_object()
+  {
+      insertion_pos++;
+      if ( insertion_pos == CYCLIC_BUFFER_SIZE )
+      {
+          insertion_pos = 0;
+      }
+      return &cycl_buffer[insertion_pos];
+  }
+
+  void reset()
+  {
+      for (size_t i = 0; i < CYCLIC_BUFFER_SIZE; i++)
+      {
+          cycl_buffer[i].pts = 0;
+          consumer_pos = 0;
+          insertion_pos = 0;
+      }
+  }
+};
+#undef CYCLIC_BUFFER_SIZE
+
+#endif // CYCLIC_BUFFER_H

modules/visualization/vsxu.cpp

+/*****************************************************************************
+ * vsxu.cpp: visualization module wrapper for Vovoid VSXu
+ *****************************************************************************
+ * Copyright © 2009-2012 the VideoLAN team, Vovoid Media Technologies
+ * $Id$
+ *
+ * Authors: Rémi Duraffort <ivoire@videolan.org>
+ *          Laurent Aimar
+ *          Jonatan "jaw" Wallmander
+ *
+ * Used the projectM implementation as reference for this file.
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation; either version 2 of the License, or (at your option)
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program; if not, write to the Free Software Foundation, Inc., 51
+ * Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ *****************************************************************************/
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+#ifndef __STDC_CONSTANT_MACROS
+# define __STDC_CONSTANT_MACROS
+#endif
+
+#include <vlc_common.h>
+#include <vlc_plugin.h>
+#include <vlc_aout.h>
+#include <vlc_vout.h>
+#include <vlc_vout_wrapper.h>
+#include <vlc_opengl.h>
+
+// vsxu manager include
+#include <vsx_manager.h>
+#include <logo_intro.h>
+
+// class to handle cyclic buffer
+#include "cyclic_buffer.h"
+
+/*****************************************************************************
+ * Module descriptor
+ *****************************************************************************/
+static int  Open         ( vlc_object_t * );
+static void Close        ( vlc_object_t * );
+
+#define WIDTH_TEXT N_("Video width")
+#define WIDTH_LONGTEXT N_("The width of the video window, in pixels.")
+
+#define HEIGHT_TEXT N_("Video height")
+#define HEIGHT_LONGTEXT N_("The height of the video window, in pixels.")
+
+vlc_module_begin ()
+    set_shortname( N_("vsxu"))
+    set_description( N_("vsxu") )
+    set_capability( "visualization2", 0 )
+    set_category( CAT_AUDIO )
+    set_subcategory( SUBCAT_AUDIO_VISUAL )
+    add_integer( "vsxu-width", 1280, WIDTH_TEXT, WIDTH_LONGTEXT,
+                 false )
+    add_integer( "vsxu-height", 800, HEIGHT_TEXT, HEIGHT_LONGTEXT,
+                 false )
+    add_shortcut( "vsxu" )
+    set_callbacks( Open, Close )
+vlc_module_end ()
+
+
+/*****************************************************************************
+ * Local prototypes
+ *****************************************************************************/
+
+struct filter_sys_t
+{
+    vlc_thread_t thread;
+
+    vlc_sem_t    ready;
+
+    vlc_mutex_t lock;
+
+    // mutex around the cyclic block
+    vlc_mutex_t cyclic_block_mutex;
+
+    // cyclic buffer to cache sound frames in
+    cyclic_block_queue* vsxu_cyclic_buffer;
+
+    int i_width;
+    int i_height;
+    int i_channels;
+
+    bool b_error;
+    bool b_quit;
+};
+
+static block_t *DoWork( filter_t *, block_t * );
+static void *Thread( void * );
+
+/**
+ * Open the module
+ * @param p_this: the filter object
+ * @return VLC_SUCCESS or vlc error codes
+ */
+static int Open( vlc_object_t * p_this )
+{
+    filter_t     *p_filter = (filter_t *)p_this;
+    filter_sys_t *p_sys;
+
+    /* Test the audio format */
+    if( p_filter->fmt_in.audio.i_format != VLC_CODEC_FL32 ||
+        p_filter->fmt_out.audio.i_format != VLC_CODEC_FL32 )
+    {
+        msg_Warn( p_filter, "bad input or output format" );
+        return VLC_EGENERIC;
+    }
+    if( !AOUT_FMTS_SIMILAR( &p_filter->fmt_in.audio, &p_filter->fmt_out.audio ) )
+    {
+        msg_Warn( p_filter, "input and outut are not similar" );
+        return VLC_EGENERIC;
+    }
+
+    p_sys = p_filter->p_sys = (filter_sys_t*)malloc( sizeof( *p_sys ) );
+    if( unlikely( !p_sys ) )
+    {
+        return VLC_ENOMEM;
+    }
+
+    /* Create the object for the thread */
+    vlc_sem_init( &p_sys->ready, 0 );
+    p_sys->b_error       = false;
+    p_sys->b_quit        = false;
+    p_sys->i_width       = var_InheritInteger( p_filter, "vsxu-width" );
+    p_sys->i_height      = var_InheritInteger( p_filter, "vsxu-height" );
+    p_sys->i_channels    = aout_FormatNbChannels( &p_filter->fmt_in.audio );
+    vlc_mutex_init( &p_sys->lock );
+    vlc_mutex_init( &p_sys->cyclic_block_mutex );
+    p_sys->vsxu_cyclic_buffer = new cyclic_block_queue();
+
+
+    /* Create the thread */
+    if( vlc_clone( &p_sys->thread, Thread, p_filter, VLC_THREAD_PRIORITY_LOW ) )
+        goto error;
+
+
+    vlc_sem_wait( &p_sys->ready );
+    if( p_sys->b_error )
+    {
+        vlc_join( p_sys->thread, NULL );
+        goto error;
+    }
+
+    p_filter->pf_audio_filter = DoWork;
+
+    return VLC_SUCCESS;
+
+error:
+    vlc_sem_destroy( &p_sys->ready );
+    free (p_sys );
+    return VLC_EGENERIC;
+}
+
+/**
+ * Close the module
+ * @param p_this: the filter object
+ */
+static void Close( vlc_object_t *p_this )
+{
+    filter_t  *p_filter = (filter_t *)p_this;
+    filter_sys_t *p_sys = p_filter->p_sys;
+
+    vlc_mutex_lock( &p_sys->lock );
+    p_sys->b_quit = true;
+    vlc_mutex_unlock( &p_sys->lock );
+
+    vlc_join( p_sys->thread, NULL );
+
+    /* Free the ressources */
+    vlc_sem_destroy( &p_sys->ready );
+    vlc_mutex_destroy( &p_sys->lock );
+    delete p_sys->vsxu_cyclic_buffer;
+    free( p_sys );
+}
+
+/**
+ * Do the actual work with the new sample
+ * @param p_filter: filter object
+ * @param p_in_buf: input buffer
+ */
+static block_t *DoWork( filter_t *p_filter, block_t *p_in_buf )
+{
+    filter_sys_t *p_sys = p_filter->p_sys;
+
+    vlc_mutex_lock( &p_sys->lock );
+    vlc_mutex_lock( &p_sys->cyclic_block_mutex );
+
+    unsigned i_nb_samples = __MIN( 1024,
+                                 p_in_buf->i_nb_samples );
+
+    const float *p_src = (float*)p_in_buf->p_buffer;
+    // iterate block holder
+    size_t i_bh_data_iter = 0;
+
+    // calc 512-byte-aligned sample count to grab, we don't need more
+    unsigned i_num_samples = i_nb_samples - i_nb_samples % 512;
+
+    // muls are cheaper than divs
+    float f_onedivchannels = 1.0f / (float)p_sys->i_channels;
+
+    block_holder* p_block_holder = p_sys->vsxu_cyclic_buffer->get_insertion_object();
+    p_block_holder->pts = p_in_buf->i_pts;
+    for( unsigned i = 0; i < i_num_samples; i++ )
+    {
+        float f_v = 0;
+        for( int j = 0; j < p_sys->i_channels; j++ )
+        {
+            f_v += p_src[p_sys->i_channels * i + j];
+        }
+
+        // insert into our little cyclic buffer
+        p_block_holder->data[i_bh_data_iter] = f_v * f_onedivchannels;
+        i_bh_data_iter++;
+        if (i_bh_data_iter == 512 && i < i_num_samples-256)
+        {
+            p_block_holder = p_sys->vsxu_cyclic_buffer->get_insertion_object();
+            p_block_holder->pts = p_in_buf->i_pts + 11609;
+
+            i_bh_data_iter = 0;
+        }
+    }
+
+    vlc_mutex_unlock( &p_sys->cyclic_block_mutex );
+    vlc_mutex_unlock( &p_sys->lock );
+    return p_in_buf;
+}
+
+/**
+ * Variable callback for the dummy vout
+ */
+static int VoutCallback( vlc_object_t *p_vout, char const *psz_name,
+                         vlc_value_t oldv, vlc_value_t newv, void *p_data )
+{
+    VLC_UNUSED( p_vout ); VLC_UNUSED( oldv );
+    vout_display_t *p_vd = (vout_display_t*)p_data;
+
+    if( !strcmp(psz_name, "fullscreen") )
+    {
+        vout_SetDisplayFullscreen( p_vd, newv.b_bool );
+    }
+    return VLC_SUCCESS;
+}
+
+/**
+ * VSXu update thread which do the rendering
+ * @param p_this: the p_thread object
+ */
+static void *Thread( void *p_data )
+{
+    filter_t  *p_filter = (filter_t*)p_data;
+    filter_sys_t *p_sys = p_filter->p_sys;
+
+    // our abstract manager holder
+    vsx_manager_abs* manager = 0;
+
+    // temp audio buffer for sending to vsxu through manager
+    float f_sample_buf[512];
+
+    // vsxu logo intro
+    vsx_logo_intro* intro = 0;
+
+    vout_display_t *p_vd;
+
+    video_format_t fmt;
+    vlc_gl_t *gl;
+
+    unsigned int i_last_width  = 0;
+    unsigned int i_last_height = 0;
+    bool first = true;
+    bool run = true;
+
+    /* Create the openGL provider */
+    vout_thread_t  *p_vout;
+
+    p_vout = (vout_thread_t *)vlc_object_create( p_filter, sizeof(vout_thread_t) );
+    if( !p_vout )
+        goto error;
+
+    video_format_Init( &fmt, 0 );
+    video_format_Setup( &fmt, VLC_CODEC_RGB32,
+                        p_sys->i_width, p_sys->i_height, 0, 1 );
+    fmt.i_sar_num = 1;
+    fmt.i_sar_den = 1;
+
+    vout_display_state_t state;
+    memset( &state, 0, sizeof(state) );
+    state.cfg.display.sar.num = 1;
+    state.cfg.display.sar.den = 1;
+    state.cfg.is_display_filled = true;
+    state.cfg.zoom.num = 1;
+    state.cfg.zoom.den = 1;
+    state.sar.num = 1;
+    state.sar.den = 1;
+
+    p_vd = vout_NewDisplay( p_vout, &fmt, &state, "opengl", 300000, 1000000 );
+    if( !p_vd )
+    {
+        vlc_object_release( p_vout );
+        goto error;
+    }
+    var_Create( p_vout, "fullscreen", VLC_VAR_BOOL );
+    var_AddCallback( p_vout, "fullscreen", VoutCallback, p_vd );
+
+    gl = vout_GetDisplayOpengl( p_vd );
+    if( !gl )
+    {
+        var_DelCallback( p_vout, "fullscreen", VoutCallback, p_vd );
+        vout_DeleteDisplay( p_vd, NULL );
+        vlc_object_release( p_vout );
+        goto error;
+    }
+
+    // tell main thread we are ready
+    vlc_sem_post( &p_sys->ready );
+
+    while ( run )
+    {
+        /* Manage the events */
+        vout_ManageDisplay( p_vd, true );
+        if( p_vd->cfg->display.width  != i_last_width ||
+            p_vd->cfg->display.height != i_last_height )
+        {
+            /* FIXME it is not perfect as we will have black bands */
+            vout_display_place_t place;
+            vout_display_PlacePicture( &place, &p_vd->source, p_vd->cfg, false );
+
+            i_last_width  = p_vd->cfg->display.width;
+            i_last_height = p_vd->cfg->display.height;
+        }
+
+        // look for control commands from outside the thread
+        vlc_mutex_lock( &p_sys->lock );
+            if( p_sys->b_quit )
+            {
+                run = false;
+            }
+        vlc_mutex_unlock( &p_sys->lock );
+
+        if (first)
+        {
+            // only run this once
+            first = false;
+
+            // create a new manager
+            manager = manager_factory();
+
+            // init manager with the shared path and sound input type.
+            manager->init( 0, "media_player" );
+
+            // only show logo once
+            // keep track of iterations
+            static int i_iterations = 0;
+            if ( i_iterations++ < 1 )
+            {
+                intro = new vsx_logo_intro();
+                intro->set_destroy_textures( false );
+            }
+        }
+
+        // lock cyclic buffer mutex and copy floats
+        vlc_mutex_lock( &p_sys->cyclic_block_mutex );
+            block_holder* bh = p_sys->vsxu_cyclic_buffer->consume();
+            memcpy( &f_sample_buf[0], (void*)(&bh->data[0]), sizeof(float) * 512 );
+        vlc_mutex_unlock( &p_sys->cyclic_block_mutex );
+
+        // send sound pointer to vsxu
+        manager->set_sound_wave( &f_sample_buf[0] );
+
+        // render vsxu engine
+        if (manager) manager->render();
+
+        // render intro
+        if (intro) intro->draw();
+
+        // swap buffers etc.
+        if( !vlc_gl_Lock(gl) )
+        {
+            vlc_gl_Swap( gl );
+            vlc_gl_Unlock( gl );
+        }
+    }
+
+    // stop vsxu nicely (unloads textures and frees memory)
+    if (manager) manager->stop();
+
+    // call manager factory to destruct our manager object
+    if (manager) manager_destroy( manager );
+
+    // delete the intro (if ever allocated)
+    if (intro) delete intro;
+
+    var_DelCallback( p_vout, "fullscreen", VoutCallback, p_vd );
+
+    // clean out vlc opengl stuff
+    vout_DeleteDisplay( p_vd, NULL );
+    vlc_object_release( p_vout );
+
+    // clean up the cyclic buffer
+    vlc_mutex_lock( &p_sys->cyclic_block_mutex );
+        p_sys->vsxu_cyclic_buffer->reset();
+    vlc_mutex_unlock( &p_sys->cyclic_block_mutex );
+
+    // die
+    return NULL;
+
+error:
+    p_sys->b_error = true;
+    vlc_sem_post( &p_sys->ready );
+    return NULL;
+}
+

src/audio_output/common.c

@@ -110,6 +110,13 @@ audio_output_t *aout_New( vlc_object_t * p_parent )
         text.psz_string = (char*)"projectM";
         var_Change (aout, "visual", VLC_VAR_ADDCHOICE, &val, &text);
     }
+    /* Look for VSXu plugin */
+    if (module_exists ("vsxu"))
+    {
+        val.psz_string = (char *)"vsxu";
+        text.psz_string = (char*)"Vovoid VSXu";
+        var_Change (aout, "visual", VLC_VAR_ADDCHOICE, &val, &text);
+    }
     str = var_GetNonEmptyString (aout, "effect-list");
     if (str != NULL)
     {

src/audio_output/input.c

@@ -615,18 +615,28 @@ static int VisualizationCallback (vlc_object_t *obj, char const *var,
         ChangeFiltersString (obj, "audio-visual", "goom", false);
         ChangeFiltersString (obj, "audio-visual", "visual", false);
         ChangeFiltersString (obj, "audio-visual", "projectm", false);
+        ChangeFiltersString (obj, "audio-visual", "vsxu", false);
     }
     else if (!strcmp ("goom", mode))
     {
         ChangeFiltersString (obj, "audio-visual", "visual", false );
         ChangeFiltersString (obj, "audio-visual", "goom", true );
         ChangeFiltersString (obj, "audio-visual", "projectm", false );
+        ChangeFiltersString (obj, "audio-visual", "vsxu", false);
     }
     else if (!strcmp ("projectm", mode))
     {
         ChangeFiltersString (obj, "audio-visual", "visual", false);
         ChangeFiltersString (obj, "audio-visual", "goom", false);
         ChangeFiltersString (obj, "audio-visual", "projectm", true);
+        ChangeFiltersString (obj, "audio-visual", "vsxu", false);
+    }
+    else if (!strcmp ("vsxu", mode))
+    {
+        ChangeFiltersString (obj, "audio-visual", "visual", false);
+        ChangeFiltersString (obj, "audio-visual", "goom", false);
+        ChangeFiltersString (obj, "audio-visual", "projectm", false);
+        ChangeFiltersString (obj, "audio-visual", "vsxu", true);
     }
     else
     {