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