Revert "Revert new meter types (postponed until after 3.3 release)"
[ardour.git] / libs / ardour / meter.cc
index a7a287e9c15f26e36c16d028bb3bbbe326cad9e4..3ca19afe7637bd0ca57a228ac57b63139337d32f 100644 (file)
 /*
-    Copyright (C) 2006 Paul Davis 
-    
+    Copyright (C) 2006 Paul Davis
+
     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.,
     675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
-#include <ardour/meter.h>
 #include <algorithm>
 #include <cmath>
-#include <ardour/buffer_set.h>
-#include <ardour/peak.h>
-#include <ardour/dB.h>
-#include <ardour/session.h>
-#include <ardour/midi_events.h>
 
-namespace ARDOUR {
+#include "pbd/compose.h"
+
+#include "ardour/audio_buffer.h"
+#include "ardour/buffer_set.h"
+#include "ardour/dB.h"
+#include "ardour/meter.h"
+#include "ardour/midi_buffer.h"
+#include "ardour/session.h"
+#include "ardour/rc_configuration.h"
+#include "ardour/runtime_functions.h"
+
+using namespace std;
+
+using namespace ARDOUR;
+
+PBD::Signal0<void> Metering::Meter;
+
+PeakMeter::PeakMeter (Session& s, const std::string& name)
+    : Processor (s, string_compose ("meter-%1", name))
+{
+       Kmeterdsp::init(s.nominal_frame_rate());
+       Iec1ppmdsp::init(s.nominal_frame_rate());
+       Iec2ppmdsp::init(s.nominal_frame_rate());
+       Vumeterdsp::init(s.nominal_frame_rate());
+}
+
+PeakMeter::~PeakMeter ()
+{
+       while (_kmeter.size() > 0) {
+               delete (_kmeter.back());
+               delete (_iec1meter.back());
+               delete (_iec2meter.back());
+               delete (_vumeter.back());
+               _kmeter.pop_back();
+               _iec1meter.pop_back();
+               _iec2meter.pop_back();
+               _vumeter.pop_back();
+       }
+}
 
 
 /** Get peaks from @a bufs
  * Input acceptance is lenient - the first n buffers from @a bufs will
  * be metered, where n was set by the last call to setup(), excess meters will
  * be set to 0.
+ *
+ * (runs in jack realtime context)
  */
 void
-PeakMeter::run (BufferSet& bufs, nframes_t start_frame, nframes_t end_frame, nframes_t nframes, nframes_t offset)
+PeakMeter::run (BufferSet& bufs, framepos_t /*start_frame*/, framepos_t /*end_frame*/, pframes_t nframes, bool)
 {
-       size_t meterable = std::min(bufs.count().n_total(), _peak_power.size());
+       if (!_active && !_pending_active) {
+               return;
+       }
 
-       size_t n = 0;
+       // cerr << "meter " << name() << " runs with " << bufs.available() << " inputs\n";
 
-       // Meter what we have (midi)
-       for ( ; n < meterable && n < bufs.count().n_midi(); ++n) {
-               
-               float val = 0;
+       const uint32_t n_audio = min (current_meters.n_audio(), bufs.count().n_audio());
+       const uint32_t n_midi  = min (current_meters.n_midi(), bufs.count().n_midi());
+
+       uint32_t n = 0;
+
+       // Meter MIDI in to the first n_midi peaks
+       for (uint32_t i = 0; i < n_midi; ++i, ++n) {
+               float val = 0.0f;
+               MidiBuffer& buf (bufs.get_midi(i));
                
-               // GUI needs a better MIDI meter, not much information can be
-               // expressed through peaks alone
-               const unsigned n_events = bufs.get_midi(n).size();
-               for (size_t i=0; i < n_events; ++i) {
-                       const MidiEvent& ev = bufs.get_midi(n)[i];
-                       if ((ev.buffer[0] & 0xF0) == MIDI_CMD_NOTE_ON) {
-                               const float this_vel = log(ev.buffer[2] / 127.0 * (M_E*M_E-M_E) + M_E) - 1.0;
-                               //printf("V %d -> %f\n", (int)((Byte)ev.buffer[2]), this_vel);
-                               if (this_vel > val)
+               for (MidiBuffer::iterator e = buf.begin(); e != buf.end(); ++e) {
+                       const Evoral::MIDIEvent<framepos_t> ev(*e, false);
+                       if (ev.is_note_on()) {
+                               const float this_vel = ev.buffer()[2] / 127.0;
+                               if (this_vel > val) {
                                        val = this_vel;
+                               }
                        } else {
                                val += 1.0 / bufs.get_midi(n).capacity();
-                               if (val > 1.0)
+                               if (val > 1.0) {
                                        val = 1.0;
+                               }
                        }
                }
-                       
-               _peak_power[n] = val;
-
+               _peak_signal[n] = max (val, _peak_signal[n]);
        }
-       
-       // Meter what we have (audio)
-       for ( ; n < meterable && n < bufs.count().n_audio(); ++n) {
-               _peak_power[n] = compute_peak (bufs.get_audio(n).data(nframes, offset), nframes, _peak_power[n]); 
+
+       // Meter audio in to the rest of the peaks
+       for (uint32_t i = 0; i < n_audio; ++i, ++n) {
+               _peak_signal[n] = compute_peak (bufs.get_audio(i).data(), nframes, _peak_signal[n]);
+               if (_meter_type & MeterKrms) {
+                       _kmeter[i]->process(bufs.get_audio(i).data(), nframes);
+               }
+               if (_meter_type & MeterIEC1) {
+                       _iec1meter[i]->process(bufs.get_audio(i).data(), nframes);
+               }
+               if (_meter_type & MeterIEC2) {
+                       _iec2meter[i]->process(bufs.get_audio(i).data(), nframes);
+               }
+               if (_meter_type & MeterVU) {
+                       _vumeter[i]->process(bufs.get_audio(i).data(), nframes);
+               }
        }
 
        // Zero any excess peaks
-       for (size_t n = meterable; n < _peak_power.size(); ++n) {
-               _peak_power[n] = 0;
+       for (uint32_t i = n; i < _peak_signal.size(); ++i) {
+               _peak_signal[i] = 0.0f;
        }
+
+       _active = _pending_active;
 }
 
 void
 PeakMeter::reset ()
 {
-       for (size_t i = 0; i < _peak_power.size(); ++i) {
-               _peak_power[i] = 0;
+       for (size_t i = 0; i < _peak_signal.size(); ++i) {
+               _peak_signal[i] = 0.0f;
+       }
+
+       for (size_t n = 0; n < _kmeter.size(); ++n) {
+               _kmeter[n]->reset();
+               _iec1meter[n]->reset();
+               _iec2meter[n]->reset();
+               _vumeter[n]->reset();
        }
 }
 
@@ -90,70 +148,168 @@ PeakMeter::reset_max ()
 {
        for (size_t i = 0; i < _max_peak_power.size(); ++i) {
                _max_peak_power[i] = -INFINITY;
+               _max_peak_signal[i] = 0;
+       }
+
+       const size_t n_midi  = min (_peak_signal.size(), (size_t) current_meters.n_midi());
+
+       for (size_t n = 0; n < _peak_signal.size(); ++n) {
+               if (n < n_midi) {
+                       _visible_peak_power[n] = 0;
+               } else {
+                       _visible_peak_power[n] = -INFINITY;
+               }
        }
 }
 
+bool
+PeakMeter::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
+{
+       out = in;
+       return true;
+}
+
 bool
 PeakMeter::configure_io (ChanCount in, ChanCount out)
 {
-       /* we're transparent no matter what.  fight the power. */
-       if (out != in)
+       if (out != in) { // always 1:1
                return false;
+       }
+
+       current_meters = in;
+
+       reset_max_channels (in);
 
-       uint32_t limit = in.n_total();
+       return Processor::configure_io (in, out);
+}
+
+void
+PeakMeter::reflect_inputs (const ChanCount& in)
+{
+       current_meters = in;
+
+       const size_t limit = min (_peak_signal.size(), (size_t) current_meters.n_total ());
+       const size_t n_midi  = min (_peak_signal.size(), (size_t) current_meters.n_midi());
+
+       for (size_t n = 0; n < limit; ++n) {
+               if (n < n_midi) {
+                       _visible_peak_power[n] = 0;
+               } else {
+                       _visible_peak_power[n] = -INFINITY;
+               }
+       }
+
+       reset();
+       reset_max();
+
+       ConfigurationChanged (in, in); /* EMIT SIGNAL */
+}
 
-       while (_peak_power.size() > limit) {
-               _peak_power.pop_back();
+void
+PeakMeter::reset_max_channels (const ChanCount& chn)
+{
+       uint32_t const limit = chn.n_total();
+       const size_t n_audio = chn.n_audio();
+
+       while (_peak_signal.size() > limit) {
+               _peak_signal.pop_back();
                _visible_peak_power.pop_back();
+               _max_peak_signal.pop_back();
                _max_peak_power.pop_back();
        }
 
-       while (_peak_power.size() < limit) {
-               _peak_power.push_back(0);
+       while (_peak_signal.size() < limit) {
+               _peak_signal.push_back(0);
                _visible_peak_power.push_back(minus_infinity());
+               _max_peak_signal.push_back(0);
                _max_peak_power.push_back(minus_infinity());
        }
 
-       assert(_peak_power.size() == limit);
+       assert(_peak_signal.size() == limit);
        assert(_visible_peak_power.size() == limit);
+       assert(_max_peak_signal.size() == limit);
        assert(_max_peak_power.size() == limit);
 
-       Insert::configure_io(in, out);
+       /* alloc/free other audio-only meter types. */
+       while (_kmeter.size() > n_audio) {
+               delete (_kmeter.back());
+               delete (_iec1meter.back());
+               delete (_iec2meter.back());
+               delete (_vumeter.back());
+               _kmeter.pop_back();
+               _iec1meter.pop_back();
+               _iec2meter.pop_back();
+               _vumeter.pop_back();
+       }
+       while (_kmeter.size() < n_audio) {
+               _kmeter.push_back(new Kmeterdsp());
+               _iec1meter.push_back(new Iec1ppmdsp());
+               _iec2meter.push_back(new Iec2ppmdsp());
+               _vumeter.push_back(new Vumeterdsp());
+       }
+       assert(_kmeter.size() == n_audio);
+       assert(_iec1meter.size() == n_audio);
+       assert(_iec2meter.size() == n_audio);
+       assert(_vumeter.size() == n_audio);
 
-       return true;
+       reset();
+       reset_max();
 }
 
 /** To be driven by the Meter signal from IO.
- * Caller MUST hold io_lock!
+ * Caller MUST hold its own processor_lock to prevent reconfiguration
+ * of meter size during this call.
  */
+
 void
 PeakMeter::meter ()
 {
-       assert(_visible_peak_power.size() == _peak_power.size());
+       if (!_active) {
+               return;
+       }
 
-       const size_t limit = _peak_power.size();
+       assert(_visible_peak_power.size() == _peak_signal.size());
 
-       for (size_t n = 0; n < limit; ++n) {
+       const size_t limit = min (_peak_signal.size(), (size_t) current_meters.n_total ());
+       const size_t n_midi  = min (_peak_signal.size(), (size_t) current_meters.n_midi());
 
-               /* XXX we should use atomic exchange here */
+       for (size_t n = 0; n < limit; ++n) {
 
                /* grab peak since last read */
 
-               float new_peak = _peak_power[n];
-               _peak_power[n] = 0;
-               
+               float new_peak = _peak_signal[n]; /* XXX we should use atomic exchange from here ... */
+               _peak_signal[n] = 0;              /* ... to here */
+
+               if (n < n_midi) {
+                       _max_peak_power[n] = -INFINITY; // std::max (new_peak, _max_peak_power[n]); // XXX
+                       _max_peak_signal[n] = 0;
+                       if (Config->get_meter_falloff() == 0.0f || new_peak > _visible_peak_power[n]) {
+                               ;
+                       } else {
+                               /* empirical WRT to falloff times , 0.01f ^= 100 Hz update rate */
+                               new_peak = _visible_peak_power[n] - sqrt(_visible_peak_power[n] * Config->get_meter_falloff() * 0.01f * 0.0002f);
+                               if (new_peak < (1.0 / 512.0)) new_peak = 0;
+                       }
+                       _visible_peak_power[n] = new_peak;
+                       continue;
+               }
+
+               /* AUDIO */
+
                /* compute new visible value using falloff */
 
+               _max_peak_signal[n] = std::max(new_peak, _max_peak_signal[n]);
+
                if (new_peak > 0.0) {
-                       new_peak = coefficient_to_dB (new_peak);
+                       new_peak = accurate_coefficient_to_dB (new_peak);
                } else {
                        new_peak = minus_infinity();
                }
-               
+
                /* update max peak */
-               
+
                _max_peak_power[n] = std::max (new_peak, _max_peak_power[n]);
-               
+
                if (Config->get_meter_falloff() == 0.0f || new_peak > _visible_peak_power[n]) {
                        _visible_peak_power[n] = new_peak;
                } else {
@@ -164,4 +320,99 @@ PeakMeter::meter ()
        }
 }
 
-} // namespace ARDOUR
+float
+PeakMeter::meter_level(uint32_t n, MeterType type) {
+       switch (type) {
+               case MeterKrms:
+                       {
+                               const uint32_t n_midi = current_meters.n_midi();
+                               if ((n - n_midi) < _kmeter.size() && (n - n_midi) >= 0) {
+                                       return accurate_coefficient_to_dB (_kmeter[n - n_midi]->read());
+                               }
+                       }
+                       break;
+               case MeterIEC1:
+                       {
+                               const uint32_t n_midi = current_meters.n_midi();
+                               if ((n - n_midi) < _iec1meter.size() && (n - n_midi) >= 0) {
+                                       return accurate_coefficient_to_dB (_iec1meter[n - n_midi]->read());
+                               }
+                       }
+                       break;
+               case MeterIEC2:
+                       {
+                               const uint32_t n_midi = current_meters.n_midi();
+                               if ((n - n_midi) < _iec2meter.size() && (n - n_midi) >= 0) {
+                                       return accurate_coefficient_to_dB (_iec2meter[n - n_midi]->read());
+                               }
+                       }
+                       break;
+               case MeterVU:
+                       {
+                               const uint32_t n_midi = current_meters.n_midi();
+                               if ((n - n_midi) < _vumeter.size() && (n - n_midi) >= 0) {
+                                       return accurate_coefficient_to_dB (_vumeter[n - n_midi]->read());
+                               }
+                       }
+                       break;
+               case MeterPeak:
+                       return peak_power(n);
+               case MeterMaxSignal:
+                       if (n < _max_peak_signal.size()) {
+                               return _max_peak_signal[n];
+                       }
+                       break;
+               default:
+               case MeterMaxPeak:
+                       if (n < _max_peak_power.size()) {
+                               return _max_peak_power[n];
+                       }
+                       break;
+       }
+       return minus_infinity();
+}
+
+void
+PeakMeter::set_type(MeterType t)
+{
+       if (t == _meter_type) {
+               return;
+       }
+
+       _meter_type = t;
+
+       if (t & MeterKrms) {
+               const size_t n_audio = current_meters.n_audio();
+               for (size_t n = 0; n < n_audio; ++n) {
+                       _kmeter[n]->reset();
+               }
+       }
+       if (t & MeterIEC1) {
+               const size_t n_audio = current_meters.n_audio();
+               for (size_t n = 0; n < n_audio; ++n) {
+                       _iec1meter[n]->reset();
+               }
+       }
+       if (t & MeterIEC2) {
+               const size_t n_audio = current_meters.n_audio();
+               for (size_t n = 0; n < n_audio; ++n) {
+                       _iec2meter[n]->reset();
+               }
+       }
+       if (t & MeterVU) {
+               const size_t n_audio = current_meters.n_audio();
+               for (size_t n = 0; n < n_audio; ++n) {
+                       _vumeter[n]->reset();
+               }
+       }
+
+       TypeChanged(t);
+}
+
+XMLNode&
+PeakMeter::state (bool full_state)
+{
+       XMLNode& node (Processor::state (full_state));
+       node.add_property("type", "meter");
+       return node;
+}