libs/ardour/meter.cc

   1 /*
   2     Copyright (C) 2006 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify it
   5     under the terms of the GNU General Public License as published by the Free
   6     Software Foundation; either version 2 of the License, or (at your option)
   7     any later version.
   8
   9     This program is distributed in the hope that it will be useful, but WITHOUT
  10     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12     for more details.
  13
  14     You should have received a copy of the GNU General Public License along
  15     with this program; if not, write to the Free Software Foundation, Inc.,
  16     675 Mass Ave, Cambridge, MA 02139, USA.
  17 */
  18
  19 #include <algorithm>
  20 #include <cmath>
  21
  22 #include "pbd/compose.h"
  23
  24 #include "ardour/audio_buffer.h"
  25 #include "ardour/buffer_set.h"
  26 #include "ardour/dB.h"
  27 #include "ardour/meter.h"
  28 #include "ardour/midi_buffer.h"
  29 #include "ardour/session.h"
  30 #include "ardour/rc_configuration.h"
  31 #include "ardour/runtime_functions.h"
  32
  33 using namespace std;
  34
  35 using namespace ARDOUR;
  36
  37 PBD::Signal0<void> Metering::Meter;
  38
  39 PeakMeter::PeakMeter (Session& s, const std::string& name)
  40     : Processor (s, string_compose ("meter-%1", name))
  41 {
  42         Kmeterdsp::init(s.nominal_frame_rate());
  43 }
  44
  45 PeakMeter::~PeakMeter ()
  46 {
  47         while (_kmeter.size() > 0) {
  48                 delete (_kmeter.back());
  49                 _kmeter.pop_back();
  50         }
  51 }
  52
  53
  54 /** Get peaks from @a bufs
  55  * Input acceptance is lenient - the first n buffers from @a bufs will
  56  * be metered, where n was set by the last call to setup(), excess meters will
  57  * be set to 0.
  58  */
  59 void
  60 PeakMeter::run (BufferSet& bufs, framepos_t /*start_frame*/, framepos_t /*end_frame*/, pframes_t nframes, bool)
  61 {
  62         if (!_active && !_pending_active) {
  63                 return;
  64         }
  65
  66         // cerr << "meter " << name() << " runs with " << bufs.available() << " inputs\n";
  67
  68         const uint32_t n_audio = min (current_meters.n_audio(), bufs.count().n_audio());
  69         const uint32_t n_midi  = min (current_meters.n_midi(), bufs.count().n_midi());
  70
  71         uint32_t n = 0;
  72
  73         // Meter MIDI in to the first n_midi peaks
  74         for (uint32_t i = 0; i < n_midi; ++i, ++n) {
  75                 float val = 0.0f;
  76                 MidiBuffer& buf (bufs.get_midi(i));
  77
  78                 for (MidiBuffer::iterator e = buf.begin(); e != buf.end(); ++e) {
  79                         const Evoral::MIDIEvent<framepos_t> ev(*e, false);
  80                         if (ev.is_note_on()) {
  81                                 const float this_vel = ev.buffer()[2] / 127.0;
  82                                 if (this_vel > val) {
  83                                         val = this_vel;
  84                                 }
  85                         } else {
  86                                 val += 1.0 / bufs.get_midi(n).capacity();
  87                                 if (val > 1.0) {
  88                                         val = 1.0;
  89                                 }
  90                         }
  91                 }
  92                 _peak_signal[n] = max (val, _peak_signal[n]);
  93         }
  94
  95         // Meter audio in to the rest of the peaks
  96         for (uint32_t i = 0; i < n_audio; ++i, ++n) {
  97                 _peak_signal[n] = compute_peak (bufs.get_audio(i).data(), nframes, _peak_signal[n]);
  98                 if (/* TODO use separate bit-flags for mixer,meterbridge,.. */ /* 1 || */  _meter_type & MeterKrms) {
  99                         _kmeter[i]->process(bufs.get_audio(i).data(), nframes);
 100                 }
 101         }
 102
 103         // Zero any excess peaks
 104         for (uint32_t i = n; i < _peak_signal.size(); ++i) {
 105                 _peak_signal[i] = 0.0f;
 106         }
 107
 108         _active = _pending_active;
 109 }
 110
 111 void
 112 PeakMeter::reset ()
 113 {
 114         for (size_t i = 0; i < _peak_signal.size(); ++i) {
 115                 _peak_signal[i] = 0.0f;
 116         }
 117 }
 118
 119 void
 120 PeakMeter::reset_max ()
 121 {
 122         for (size_t i = 0; i < _max_peak_power.size(); ++i) {
 123                 _max_peak_power[i] = -INFINITY;
 124                 _max_peak_signal[i] = 0;
 125         }
 126 }
 127
 128 bool
 129 PeakMeter::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
 130 {
 131         out = in;
 132         return true;
 133 }
 134
 135 bool
 136 PeakMeter::configure_io (ChanCount in, ChanCount out)
 137 {
 138         if (out != in) { // always 1:1
 139                 return false;
 140         }
 141
 142         current_meters = in;
 143
 144         reset_max_channels (in);
 145
 146         return Processor::configure_io (in, out);
 147 }
 148
 149 void
 150 PeakMeter::reflect_inputs (const ChanCount& in)
 151 {
 152         current_meters = in;
 153
 154         const size_t limit = min (_peak_signal.size(), (size_t) current_meters.n_total ());
 155         const size_t n_midi  = min (_peak_signal.size(), (size_t) current_meters.n_midi());
 156         const size_t n_audio = current_meters.n_audio();
 157
 158         for (size_t n = 0; n < limit; ++n) {
 159                 if (n < n_midi) {
 160                         _visible_peak_power[n] = 0;
 161                 } else {
 162                         _visible_peak_power[n] = -INFINITY;
 163                 }
 164         }
 165
 166         for (size_t n = 0; n < n_audio; ++n) {
 167                 _kmeter[n]->reset();
 168         }
 169
 170         reset_max();
 171
 172         ConfigurationChanged (in, in); /* EMIT SIGNAL */
 173 }
 174
 175 void
 176 PeakMeter::reset_max_channels (const ChanCount& chn)
 177 {
 178         uint32_t const limit = chn.n_total();
 179         const size_t n_audio = chn.n_audio();
 180
 181         while (_peak_signal.size() > limit) {
 182                 _peak_signal.pop_back();
 183                 _visible_peak_power.pop_back();
 184                 _max_peak_signal.pop_back();
 185                 _max_peak_power.pop_back();
 186         }
 187
 188         while (_peak_signal.size() < limit) {
 189                 _peak_signal.push_back(0);
 190                 _visible_peak_power.push_back(minus_infinity());
 191                 _max_peak_signal.push_back(0);
 192                 _max_peak_power.push_back(minus_infinity());
 193         }
 194
 195         assert(_peak_signal.size() == limit);
 196         assert(_visible_peak_power.size() == limit);
 197         assert(_max_peak_signal.size() == limit);
 198         assert(_max_peak_power.size() == limit);
 199
 200         /* alloc/free other audio-only meter types. */
 201         while (_kmeter.size() > n_audio) {
 202                 delete (_kmeter.back());
 203                 _kmeter.pop_back();
 204         }
 205         while (_kmeter.size() < n_audio) {
 206                 _kmeter.push_back(new Kmeterdsp());
 207         }
 208         assert(_kmeter.size() == n_audio);
 209 }
 210
 211 /** To be driven by the Meter signal from IO.
 212  * Caller MUST hold its own processor_lock to prevent reconfiguration
 213  * of meter size during this call.
 214  */
 215
 216 void
 217 PeakMeter::meter ()
 218 {
 219         if (!_active) {
 220                 return;
 221         }
 222
 223         assert(_visible_peak_power.size() == _peak_signal.size());
 224
 225         const size_t limit = min (_peak_signal.size(), (size_t) current_meters.n_total ());
 226         const size_t n_midi  = min (_peak_signal.size(), (size_t) current_meters.n_midi());
 227
 228         for (size_t n = 0; n < limit; ++n) {
 229
 230                 /* grab peak since last read */
 231
 232                 float new_peak = _peak_signal[n]; /* XXX we should use atomic exchange from here ... */
 233                 _peak_signal[n] = 0;              /* ... to here */
 234
 235                 if (n < n_midi) {
 236                         _max_peak_power[n] = -INFINITY; // std::max (new_peak, _max_peak_power[n]); // XXX
 237                         _max_peak_signal[n] = 0;
 238                         if (Config->get_meter_falloff() == 0.0f || new_peak > _visible_peak_power[n]) {
 239                                 ;
 240                         } else {
 241                                 /* empirical WRT to falloff times , 0.01f ^= 100 Hz update rate */
 242 #if 1
 243                                 new_peak = _visible_peak_power[n] - _visible_peak_power[n] * Config->get_meter_falloff() * 0.01f * 0.05f;
 244 #else
 245                                 new_peak = _visible_peak_power[n] - sqrt(_visible_peak_power[n] * Config->get_meter_falloff() * 0.01f * 0.0002f);
 246 #endif
 247                                 if (new_peak < (1.0 / 512.0)) new_peak = 0;
 248                         }
 249                         _visible_peak_power[n] = new_peak;
 250                         continue;
 251                 }
 252
 253                 /* AUDIO */
 254
 255                 /* compute new visible value using falloff */
 256
 257                 _max_peak_signal[n] = std::max(new_peak, _max_peak_signal[n]);
 258
 259                 if (new_peak > 0.0) {
 260                         new_peak = fast_coefficient_to_dB (new_peak);
 261                 } else {
 262                         new_peak = minus_infinity();
 263                 }
 264
 265                 /* update max peak */
 266
 267                 _max_peak_power[n] = std::max (new_peak, _max_peak_power[n]);
 268
 269                 if (Config->get_meter_falloff() == 0.0f || new_peak > _visible_peak_power[n]) {
 270                         _visible_peak_power[n] = new_peak;
 271                 } else {
 272                         // do falloff
 273                         new_peak = _visible_peak_power[n] - (Config->get_meter_falloff() * 0.01f);
 274                         _visible_peak_power[n] = std::max (new_peak, -INFINITY);
 275                 }
 276         }
 277 }
 278
 279 float
 280 PeakMeter::meter_level(uint32_t n, MeterType type) {
 281         switch (type) {
 282                 case MeterKrms:
 283                         {
 284                                 const uint32_t n_midi  = current_meters.n_midi();
 285                                 if ((n - n_midi) < _kmeter.size()) {
 286                                         return fast_coefficient_to_dB(_kmeter[n]->read());
 287                                 }
 288                                 return minus_infinity();
 289                         }
 290                 case MeterPeak:
 291                         return peak_power(n);
 292                 case MeterMaxSignal:
 293                         if (n < _max_peak_signal.size()) {
 294                                 return _max_peak_signal[n];
 295                         } else {
 296                                 return minus_infinity();
 297                         }
 298                 default:
 299                 case MeterMaxPeak:
 300                         if (n < _max_peak_power.size()) {
 301                                 return _max_peak_power[n];
 302                         } else {
 303                                 return minus_infinity();
 304                         }
 305         }
 306 }
 307 void
 308 PeakMeter::set_type(MeterType t)
 309 {
 310         if (t == _meter_type) {
 311                 return;
 312         }
 313
 314         _meter_type = t;
 315
 316         if (t & MeterKrms) {
 317                 const size_t n_audio = current_meters.n_audio();
 318                 for (size_t n = 0; n < n_audio; ++n) {
 319                         _kmeter[n]->reset();
 320                 }
 321         }
 322         TypeChanged(t);
 323 }
 324
 325 XMLNode&
 326 PeakMeter::state (bool full_state)
 327 {
 328         XMLNode& node (Processor::state (full_state));
 329         node.add_property("type", "meter");
 330         return node;
 331 }
 332
 333