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         Iec1ppmdsp::init(s.nominal_frame_rate());
  44         Iec2ppmdsp::init(s.nominal_frame_rate());
  45         Vumeterdsp::init(s.nominal_frame_rate());
  46 }
  47
  48 PeakMeter::~PeakMeter ()
  49 {
  50         while (_kmeter.size() > 0) {
  51                 delete (_kmeter.back());
  52                 delete (_iec1meter.back());
  53                 delete (_iec2meter.back());
  54                 delete (_vumeter.back());
  55                 _kmeter.pop_back();
  56                 _iec1meter.pop_back();
  57                 _iec2meter.pop_back();
  58                 _vumeter.pop_back();
  59         }
  60 }
  61
  62
  63 /** Get peaks from @a bufs
  64  * Input acceptance is lenient - the first n buffers from @a bufs will
  65  * be metered, where n was set by the last call to setup(), excess meters will
  66  * be set to 0.
  67  *
  68  * (runs in jack realtime context)
  69  */
  70 void
  71 PeakMeter::run (BufferSet& bufs, framepos_t /*start_frame*/, framepos_t /*end_frame*/, pframes_t nframes, bool)
  72 {
  73         if (!_active && !_pending_active) {
  74                 return;
  75         }
  76
  77         // cerr << "meter " << name() << " runs with " << bufs.available() << " inputs\n";
  78
  79         const uint32_t n_audio = min (current_meters.n_audio(), bufs.count().n_audio());
  80         const uint32_t n_midi  = min (current_meters.n_midi(), bufs.count().n_midi());
  81
  82         uint32_t n = 0;
  83
  84         // Meter MIDI in to the first n_midi peaks
  85         for (uint32_t i = 0; i < n_midi; ++i, ++n) {
  86                 float val = 0.0f;
  87                 MidiBuffer& buf (bufs.get_midi(i));
  88
  89                 for (MidiBuffer::iterator e = buf.begin(); e != buf.end(); ++e) {
  90                         const Evoral::MIDIEvent<framepos_t> ev(*e, false);
  91                         if (ev.is_note_on()) {
  92                                 const float this_vel = ev.buffer()[2] / 127.0;
  93                                 if (this_vel > val) {
  94                                         val = this_vel;
  95                                 }
  96                         } else {
  97                                 val += 1.0 / bufs.get_midi(n).capacity();
  98                                 if (val > 1.0) {
  99                                         val = 1.0;
 100                                 }
 101                         }
 102                 }
 103                 _peak_signal[n] = max (val, _peak_signal[n]);
 104         }
 105
 106         // Meter audio in to the rest of the peaks
 107         for (uint32_t i = 0; i < n_audio; ++i, ++n) {
 108                 _peak_signal[n] = compute_peak (bufs.get_audio(i).data(), nframes, _peak_signal[n]);
 109                 if (_meter_type & MeterKrms) {
 110                         _kmeter[i]->process(bufs.get_audio(i).data(), nframes);
 111                 }
 112                 if (_meter_type & MeterIEC1) {
 113                         _iec1meter[i]->process(bufs.get_audio(i).data(), nframes);
 114                 }
 115                 if (_meter_type & MeterIEC2) {
 116                         _iec2meter[i]->process(bufs.get_audio(i).data(), nframes);
 117                 }
 118                 if (_meter_type & MeterVU) {
 119                         _vumeter[i]->process(bufs.get_audio(i).data(), nframes);
 120                 }
 121         }
 122
 123         // Zero any excess peaks
 124         for (uint32_t i = n; i < _peak_signal.size(); ++i) {
 125                 _peak_signal[i] = 0.0f;
 126         }
 127
 128         _active = _pending_active;
 129 }
 130
 131 void
 132 PeakMeter::reset ()
 133 {
 134         for (size_t i = 0; i < _peak_signal.size(); ++i) {
 135                 _peak_signal[i] = 0.0f;
 136         }
 137 }
 138
 139 void
 140 PeakMeter::reset_max ()
 141 {
 142         for (size_t i = 0; i < _max_peak_power.size(); ++i) {
 143                 _max_peak_power[i] = -INFINITY;
 144                 _max_peak_signal[i] = 0;
 145         }
 146 }
 147
 148 bool
 149 PeakMeter::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
 150 {
 151         out = in;
 152         return true;
 153 }
 154
 155 bool
 156 PeakMeter::configure_io (ChanCount in, ChanCount out)
 157 {
 158         if (out != in) { // always 1:1
 159                 return false;
 160         }
 161
 162         current_meters = in;
 163
 164         reset_max_channels (in);
 165
 166         return Processor::configure_io (in, out);
 167 }
 168
 169 void
 170 PeakMeter::reflect_inputs (const ChanCount& in)
 171 {
 172         current_meters = in;
 173
 174         const size_t limit = min (_peak_signal.size(), (size_t) current_meters.n_total ());
 175         const size_t n_midi  = min (_peak_signal.size(), (size_t) current_meters.n_midi());
 176         const size_t n_audio = current_meters.n_audio();
 177
 178         for (size_t n = 0; n < limit; ++n) {
 179                 if (n < n_midi) {
 180                         _visible_peak_power[n] = 0;
 181                 } else {
 182                         _visible_peak_power[n] = -INFINITY;
 183                 }
 184         }
 185
 186         for (size_t n = 0; n < n_audio; ++n) {
 187                 _kmeter[n]->reset();
 188                 _iec1meter[n]->reset();
 189                 _iec2meter[n]->reset();
 190                 _vumeter[n]->reset();
 191         }
 192
 193         reset_max();
 194
 195         ConfigurationChanged (in, in); /* EMIT SIGNAL */
 196 }
 197
 198 void
 199 PeakMeter::reset_max_channels (const ChanCount& chn)
 200 {
 201         uint32_t const limit = chn.n_total();
 202         const size_t n_audio = chn.n_audio();
 203
 204         while (_peak_signal.size() > limit) {
 205                 _peak_signal.pop_back();
 206                 _visible_peak_power.pop_back();
 207                 _max_peak_signal.pop_back();
 208                 _max_peak_power.pop_back();
 209         }
 210
 211         while (_peak_signal.size() < limit) {
 212                 _peak_signal.push_back(0);
 213                 _visible_peak_power.push_back(minus_infinity());
 214                 _max_peak_signal.push_back(0);
 215                 _max_peak_power.push_back(minus_infinity());
 216         }
 217
 218         assert(_peak_signal.size() == limit);
 219         assert(_visible_peak_power.size() == limit);
 220         assert(_max_peak_signal.size() == limit);
 221         assert(_max_peak_power.size() == limit);
 222
 223         /* alloc/free other audio-only meter types. */
 224         while (_kmeter.size() > n_audio) {
 225                 delete (_kmeter.back());
 226                 delete (_iec1meter.back());
 227                 delete (_iec2meter.back());
 228                 delete (_vumeter.back());
 229                 _kmeter.pop_back();
 230                 _iec1meter.pop_back();
 231                 _iec2meter.pop_back();
 232                 _vumeter.pop_back();
 233         }
 234         while (_kmeter.size() < n_audio) {
 235                 _kmeter.push_back(new Kmeterdsp());
 236                 _iec1meter.push_back(new Iec1ppmdsp());
 237                 _iec2meter.push_back(new Iec2ppmdsp());
 238                 _vumeter.push_back(new Vumeterdsp());
 239         }
 240         assert(_kmeter.size() == n_audio);
 241         assert(_iec1meter.size() == n_audio);
 242         assert(_iec2meter.size() == n_audio);
 243         assert(_vumeter.size() == n_audio);
 244 }
 245
 246 /** To be driven by the Meter signal from IO.
 247  * Caller MUST hold its own processor_lock to prevent reconfiguration
 248  * of meter size during this call.
 249  */
 250
 251 void
 252 PeakMeter::meter ()
 253 {
 254         if (!_active) {
 255                 return;
 256         }
 257
 258         assert(_visible_peak_power.size() == _peak_signal.size());
 259
 260         const size_t limit = min (_peak_signal.size(), (size_t) current_meters.n_total ());
 261         const size_t n_midi  = min (_peak_signal.size(), (size_t) current_meters.n_midi());
 262
 263         for (size_t n = 0; n < limit; ++n) {
 264
 265                 /* grab peak since last read */
 266
 267                 float new_peak = _peak_signal[n]; /* XXX we should use atomic exchange from here ... */
 268                 _peak_signal[n] = 0;              /* ... to here */
 269
 270                 if (n < n_midi) {
 271                         _max_peak_power[n] = -INFINITY; // std::max (new_peak, _max_peak_power[n]); // XXX
 272                         _max_peak_signal[n] = 0;
 273                         if (Config->get_meter_falloff() == 0.0f || new_peak > _visible_peak_power[n]) {
 274                                 ;
 275                         } else {
 276                                 /* empirical WRT to falloff times , 0.01f ^= 100 Hz update rate */
 277                                 new_peak = _visible_peak_power[n] - sqrt(_visible_peak_power[n] * Config->get_meter_falloff() * 0.01f * 0.0002f);
 278                                 if (new_peak < (1.0 / 512.0)) new_peak = 0;
 279                         }
 280                         _visible_peak_power[n] = new_peak;
 281                         continue;
 282                 }
 283
 284                 /* AUDIO */
 285
 286                 /* compute new visible value using falloff */
 287
 288                 _max_peak_signal[n] = std::max(new_peak, _max_peak_signal[n]);
 289
 290                 if (new_peak > 0.0) {
 291                         new_peak = accurate_coefficient_to_dB (new_peak);
 292                 } else {
 293                         new_peak = minus_infinity();
 294                 }
 295
 296                 /* update max peak */
 297
 298                 _max_peak_power[n] = std::max (new_peak, _max_peak_power[n]);
 299
 300                 if (Config->get_meter_falloff() == 0.0f || new_peak > _visible_peak_power[n]) {
 301                         _visible_peak_power[n] = new_peak;
 302                 } else {
 303                         // do falloff
 304                         new_peak = _visible_peak_power[n] - (Config->get_meter_falloff() * 0.01f);
 305                         _visible_peak_power[n] = std::max (new_peak, -INFINITY);
 306                 }
 307         }
 308 }
 309
 310 float
 311 PeakMeter::meter_level(uint32_t n, MeterType type) {
 312         switch (type) {
 313                 case MeterKrms:
 314                         {
 315                                 const uint32_t n_midi = current_meters.n_midi();
 316                                 if ((n - n_midi) < _kmeter.size() && (n - n_midi) >= 0) {
 317                                         return accurate_coefficient_to_dB (_kmeter[n - n_midi]->read());
 318                                 }
 319                         }
 320                         break;
 321                 case MeterIEC1:
 322                         {
 323                                 const uint32_t n_midi = current_meters.n_midi();
 324                                 if ((n - n_midi) < _iec1meter.size() && (n - n_midi) >= 0) {
 325                                         return accurate_coefficient_to_dB (_iec1meter[n - n_midi]->read());
 326                                 }
 327                         }
 328                         break;
 329                 case MeterIEC2:
 330                         {
 331                                 const uint32_t n_midi = current_meters.n_midi();
 332                                 if ((n - n_midi) < _iec2meter.size() && (n - n_midi) >= 0) {
 333                                         return accurate_coefficient_to_dB (_iec2meter[n - n_midi]->read());
 334                                 }
 335                         }
 336                         break;
 337                 case MeterVU:
 338                         {
 339                                 const uint32_t n_midi = current_meters.n_midi();
 340                                 if ((n - n_midi) < _vumeter.size() && (n - n_midi) >= 0) {
 341                                         return accurate_coefficient_to_dB (_vumeter[n - n_midi]->read());
 342                                 }
 343                         }
 344                         break;
 345                 case MeterPeak:
 346                         return peak_power(n);
 347                 case MeterMaxSignal:
 348                         if (n < _max_peak_signal.size()) {
 349                                 return _max_peak_signal[n];
 350                         }
 351                         break;
 352                 default:
 353                 case MeterMaxPeak:
 354                         if (n < _max_peak_power.size()) {
 355                                 return _max_peak_power[n];
 356                         }
 357                         break;
 358         }
 359         return minus_infinity();
 360 }
 361
 362 void
 363 PeakMeter::set_type(MeterType t)
 364 {
 365         if (t == _meter_type) {
 366                 return;
 367         }
 368
 369         _meter_type = t;
 370
 371         if (t & MeterKrms) {
 372                 const size_t n_audio = current_meters.n_audio();
 373                 for (size_t n = 0; n < n_audio; ++n) {
 374                         _kmeter[n]->reset();
 375                 }
 376         }
 377         if (t & MeterIEC1) {
 378                 const size_t n_audio = current_meters.n_audio();
 379                 for (size_t n = 0; n < n_audio; ++n) {
 380                         _iec1meter[n]->reset();
 381                 }
 382         }
 383         if (t & MeterIEC2) {
 384                 const size_t n_audio = current_meters.n_audio();
 385                 for (size_t n = 0; n < n_audio; ++n) {
 386                         _iec2meter[n]->reset();
 387                 }
 388         }
 389         if (t & MeterVU) {
 390                 const size_t n_audio = current_meters.n_audio();
 391                 for (size_t n = 0; n < n_audio; ++n) {
 392                         _vumeter[n]->reset();
 393                 }
 394         }
 395
 396         TypeChanged(t);
 397 }
 398
 399 XMLNode&
 400 PeakMeter::state (bool full_state)
 401 {
 402         XMLNode& node (Processor::state (full_state));
 403         node.add_property("type", "meter");
 404         return node;
 405 }