fix crash with a new session
[ardour.git] / libs / panners / vbap / vbap.cc
index fc75ae7183f0a0551a954d1b6ac122f2f0aaa6e2..2f047b23427c321f85e7eeaa11e4407d32d0712d 100644 (file)
@@ -7,16 +7,20 @@
 #include <string>
 
 #include "pbd/cartesian.h"
+#include "pbd/compose.h"
 
-#include "ardour/pannable.h"
-#include "ardour/speakers.h"
+#include "ardour/amp.h"
 #include "ardour/audio_buffer.h"
 #include "ardour/buffer_set.h"
 #include "ardour/pan_controllable.h"
+#include "ardour/pannable.h"
+#include "ardour/speakers.h"
 
 #include "vbap.h"
 #include "vbap_speakers.h"
 
+#include "i18n.h"
+
 using namespace PBD;
 using namespace ARDOUR;
 using namespace std;
@@ -29,13 +33,20 @@ static PanPluginDescriptor _descriptor = {
 
 extern "C" { PanPluginDescriptor* panner_descriptor () { return &_descriptor; } }
 
-VBAPanner::Signal::Signal (Session& session, VBAPanner& p, uint32_t n)
+VBAPanner::Signal::Signal (Session& session, VBAPanner& p, uint32_t n, uint32_t n_speakers)
 {
-        gains[0] = gains[1] = gains[2] = 0;
+        resize_gains (n_speakers);
+
         desired_gains[0] = desired_gains[1] = desired_gains[2] = 0;
         outputs[0] = outputs[1] = outputs[2] = -1;
         desired_outputs[0] = desired_outputs[1] = desired_outputs[2] = -1;
-};
+}
+
+void
+VBAPanner::Signal::Signal::resize_gains (uint32_t n)
+{
+        gains.assign (n, 0.0);
+}        
 
 VBAPanner::VBAPanner (boost::shared_ptr<Pannable> p, boost::shared_ptr<Speakers> s)
        : Panner (p)
@@ -69,7 +80,9 @@ VBAPanner::configure_io (ChanCount in, ChanCount /* ignored - we use Speakers */
         clear_signals ();
 
         for (uint32_t i = 0; i < n; ++i) {
-                _signals.push_back (new Signal (_pannable->session(), *this, i));
+                Signal* s = new Signal (_pannable->session(), *this, i, _speakers->n_speakers());
+                _signals.push_back (s);
+                
         }
 
         update ();
@@ -78,47 +91,75 @@ VBAPanner::configure_io (ChanCount in, ChanCount /* ignored - we use Speakers */
 void
 VBAPanner::update ()
 {
-        /* recompute signal directions based on panner azimuth and width (diffusion) parameters)
+        /* recompute signal directions based on panner azimuth and, if relevant, width (diffusion) parameters)
          */
 
         /* panner azimuth control is [0 .. 1.0] which we interpret as [0 .. 360] degrees
          */
-
         double center = _pannable->pan_azimuth_control->get_value() * 360.0;
 
-        /* panner width control is [-1.0 .. 1.0]; we ignore sign, and map to [0 .. 360] degrees
-           so that a width of 1 corresponds to a signal equally present from all directions, 
-           and a width of zero corresponds to a point source from the "center" (above)
-        */
+        if (_signals.size() > 1) {
+
+                /* panner width control is [-1.0 .. 1.0]; we ignore sign, and map to [0 .. 360] degrees
+                   so that a width of 1 corresponds to a signal equally present from all directions, 
+                   and a width of zero corresponds to a point source from the "center" (above) point
+                   on the perimeter of the speaker array.
+                */
+
+                double w = fabs (_pannable->pan_width_control->get_value()) * 360.0;
+                
+                double min_dir = center - (w/2.0);
+                if (min_dir < 0) {
+                        min_dir = 360.0 + min_dir; // its already negative
+                }
+                min_dir = max (min (min_dir, 360.0), 0.0);
+                
+                double max_dir = center + (w/2.0);
+                if (max_dir > 360.0) {
+                        max_dir = max_dir - 360.0;
+                }
+                max_dir = max (min (max_dir, 360.0), 0.0);
+                
+                if (max_dir < min_dir) {
+                        swap (max_dir, min_dir);
+                }
 
-        double w = fabs (_pannable->pan_width_control->get_value()) * 360.0;
+                double degree_step_per_signal = (max_dir - min_dir) / (_signals.size() - 1);
+                double signal_direction = min_dir;
 
-        double min_dir = center - w;
-        min_dir = max (min (min_dir, 360.0), 0.0);
+                if (w >= 0.0) {
 
-        double max_dir = center + w;
-        max_dir = max (min (max_dir, 360.0), 0.0);
+                        /* positive width - normal order of signal spread */
 
-        double degree_step_per_signal = (max_dir - min_dir) / _signals.size();
-        double signal_direction = min_dir;
+                        for (vector<Signal*>::iterator s = _signals.begin(); s != _signals.end(); ++s) {
+                        
+                                Signal* signal = *s;
+                                
+                                signal->direction = AngularVector (signal_direction, 0.0);
+                                compute_gains (signal->desired_gains, signal->desired_outputs, signal->direction.azi, signal->direction.ele);
+                                signal_direction += degree_step_per_signal;
+                        }
+                } else {
 
-        for (vector<Signal*>::iterator s = _signals.begin(); s != _signals.end(); ++s) {
+                        /* inverted width - reverse order of signal spread */
 
-                Signal* signal = *s;
+                        for (vector<Signal*>::reverse_iterator s = _signals.rbegin(); s != _signals.rend(); ++s) {
+                        
+                                Signal* signal = *s;
+                                
+                                signal->direction = AngularVector (signal_direction, 0.0);
+                                compute_gains (signal->desired_gains, signal->desired_outputs, signal->direction.azi, signal->direction.ele);
+                                signal_direction += degree_step_per_signal;
+                        }
+                }
 
-                signal->direction = AngularVector (signal_direction, 0.0);
+        } else if (_signals.size() == 1) {
 
-                compute_gains (signal->desired_gains, signal->desired_outputs, signal->direction.azi, signal->direction.ele);
-                        cerr << " @ " << signal->direction.azi << " /= " << signal->direction.ele
-                             << " Outputs: "
-                             << signal->desired_outputs[0] + 1 << ' '
-                             << signal->desired_outputs[1] + 1 << ' '
-                             << " Gains "
-                             << signal->desired_gains[0] << ' '
-                             << signal->desired_gains[1] << ' '
-                             << endl;
+                /* width has no role to play if there is only 1 signal: VBAP does not do "diffusion" of a single channel */
 
-                signal_direction += degree_step_per_signal;
+                Signal* s = _signals.front();
+                s->direction = AngularVector (center, 0);
+                compute_gains (s->desired_gains, s->desired_outputs, s->direction.azi, s->direction.ele);
         }
 }
 
@@ -132,7 +173,7 @@ VBAPanner::compute_gains (double gains[3], int speaker_ids[3], int azi, int ele)
        double small_g;
        double big_sm_g, gtmp[3];
 
-       azi_ele_to_cart (azi,ele, cartdir[0], cartdir[1], cartdir[2]);  
+       spherical_to_cartesian (azi, ele, 1.0, cartdir[0], cartdir[1], cartdir[2]);  
        big_sm_g = -100000.0;
 
        gains[0] = gains[1] = gains[2] = 0;
@@ -164,7 +205,7 @@ VBAPanner::compute_gains (double gains[3], int speaker_ids[3], int azi, int ele)
 
                        speaker_ids[0] = _speakers->speaker_for_tuple (i, 0);
                        speaker_ids[1] = _speakers->speaker_for_tuple (i, 1);
-                        
+
                        if (_speakers->dimension() == 3) {
                                gains[2] = gtmp[2];
                                speaker_ids[2] = _speakers->speaker_for_tuple (i, 2);
@@ -198,7 +239,6 @@ VBAPanner::distribute (BufferSet& inbufs, BufferSet& obufs, gain_t gain_coeffici
 
                 distribute_one (inbufs.get_audio (n), obufs, gain_coefficient, nframes, n);
 
-                memcpy (signal->gains, signal->desired_gains, sizeof (signal->gains));
                 memcpy (signal->outputs, signal->desired_outputs, sizeof (signal->outputs));
         }
 }
@@ -207,45 +247,119 @@ void
 VBAPanner::distribute_one (AudioBuffer& srcbuf, BufferSet& obufs, gain_t gain_coefficient, pframes_t nframes, uint32_t which)
 {
        Sample* const src = srcbuf.data();
-       Sample* dst;
-       pan_t pan;
-       uint32_t n_audio = obufs.count().n_audio();
-       bool todo[n_audio];
         Signal* signal (_signals[which]);
 
-       for (uint32_t o = 0; o < n_audio; ++o) {
-               todo[o] = true;
-       }
-        
        /* VBAP may distribute the signal across up to 3 speakers depending on
           the configuration of the speakers.
+
+           But the set of speakers in use "this time" may be different from
+           the set of speakers "the last time". So we have up to 6 speakers
+           involved, and we have to interpolate so that those no longer
+           in use are rapidly faded to silence and those newly in use
+           are rapidly faded to their correct level. This prevents clicks
+           as we change the set of speakers used to put the signal in
+           a given position.
+
+           However, the speakers are represented by output buffers, and other
+           speakers may write to the same buffers, so we cannot use
+           anything here that will simply assign new (sample) values
+           to the output buffers - everything must be done via mixing
+           functions and not assignment/copying.
        */
 
+        vector<double>::size_type sz = signal->gains.size();
+
+        assert (sz == obufs.count().n_audio());
+
+        int8_t outputs[sz]; // on the stack, no malloc
+        
+        /* set initial state of each output "record"
+         */
+
+        for (uint32_t o = 0; o < sz; ++o) {
+                outputs[o] = 0;
+        }
+
+        /* for all outputs used this time and last time,
+           change the output record to show what has
+           happened.
+        */
+
+
+        for (int o = 0; o < 3; ++o) {
+                if (signal->outputs[o] != -1) {
+                        /* used last time */
+                        outputs[signal->outputs[o]] |= 1;
+                } 
+
+                if (signal->desired_outputs[o] != -1) {
+                        /* used this time */
+                        outputs[signal->desired_outputs[o]] |= 1<<1;
+                } 
+        }
+
+        /* at this point, we can test a speaker's status:
+
+           (outputs[o] & 1)      <= in use before
+           (outputs[o] & 2)      <= in use this time
+           (outputs[o] & 3) == 3 <= in use both times
+            outputs[o] == 0      <= not in use either time
+           
+        */
+
        for (int o = 0; o < 3; ++o) {
-               if (signal->desired_outputs[o] != -1) {
-                        
-                       pframes_t n = 0;
+                pan_t pan;
+                int output = signal->desired_outputs[o];
 
-                       /* XXX TODO: interpolate across changes in gain and/or outputs
-                        */
+               if (output == -1) {
+                        continue;
+                }
 
-                       dst = obufs.get_audio (signal->desired_outputs[o]).data();
+                pan = gain_coefficient * signal->desired_gains[o];
 
-                       pan = gain_coefficient * signal->desired_gains[o];
-                       mix_buffers_with_gain (dst+n,src+n,nframes-n,pan);
+                if (pan == 0.0 && signal->gains[output] == 0.0) {
+                        
+                        /* nothing deing delivered to this output */
 
-                       todo[o] = false;
-               }
-       }
-        
-       for (uint32_t o = 0; o < n_audio; ++o) {
-               if (todo[o]) {
-                       /* VBAP decided not to deliver any audio to this output, so we write silence */
-                       dst = obufs.get_audio(o).data();
-                       memset (dst, 0, sizeof (Sample) * nframes);
-               }
+                        signal->gains[output] = 0.0;
+                        
+                } else if (fabs (pan - signal->gains[output]) > 0.00001) {
+                        
+                        /* signal to this output but the gain coefficient has changed, so 
+                           interpolate between them.
+                        */
+
+                        AudioBuffer& buf (obufs.get_audio (output));
+                        buf.accumulate_with_ramped_gain_from (srcbuf.data(), nframes, signal->gains[output], pan, 0);
+                        signal->gains[output] = pan;
+
+                } else {
+                        
+                        /* signal to this output, same gain as before so just copy with gain
+                         */
+                           
+                        mix_buffers_with_gain (obufs.get_audio (output).data(),src,nframes,pan);
+                        signal->gains[output] = pan;
+                }
        }
-        
+
+        /* clean up the outputs that were used last time but not this time
+         */
+
+        for (uint32_t o = 0; o < sz; ++o) {
+                if (outputs[o] == 1) {
+                        /* take signal and deliver with a rapid fade out
+                         */
+                        AudioBuffer& buf (obufs.get_audio (o));
+                        buf.accumulate_with_ramped_gain_from (srcbuf.data(), nframes, signal->gains[o], 0.0, 0);
+                        signal->gains[o] = 0.0;
+                }
+        }
+
+        /* note that the output buffers were all silenced at some point
+           so anything we didn't write to with this signal (or any others)
+           is just as it should be.
+        */
 }
 
 void 
@@ -297,7 +411,9 @@ VBAPanner::what_can_be_automated() const
 {
         set<Evoral::Parameter> s;
         s.insert (Evoral::Parameter (PanAzimuthAutomation));
-        s.insert (Evoral::Parameter (PanWidthAutomation));
+        if (_signals.size() > 1) {
+                s.insert (Evoral::Parameter (PanWidthAutomation));
+        }
         return s;
 }
         
@@ -322,7 +438,7 @@ VBAPanner::value_as_string (boost::shared_ptr<AutomationControl> ac) const
 
         switch (ac->parameter().type()) {
         case PanAzimuthAutomation: /* direction */
-                return string_compose (_("%1"), val * 360.0);
+                return string_compose (_("%1"), int (rint (val * 360.0)));
                 
         case PanWidthAutomation: /* diffusion */
                 return string_compose (_("%1%%"), (int) floor (100.0 * fabs(val)));
@@ -347,3 +463,23 @@ VBAPanner::get_speakers () const
 {
         return _speakers->parent();
 }
+
+void
+VBAPanner::set_position (double p)
+{
+        if (p < 0.0) {
+                p = 1.0 + p;
+        }
+
+        if (p > 1.0) {
+                p = fmod (p, 1.0);
+        } 
+
+        _pannable->pan_azimuth_control->set_value (p);
+}
+
+void
+VBAPanner::set_width (double w)
+{
+        _pannable->pan_width_control->set_value (min (1.0, max (-1.0, w)));
+}