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*/, 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
  91         // cerr << "meter " << name() << " runs with " << bufs.available() << " inputs\n";
  92
  93         const uint32_t n_audio = min (current_meters.n_audio(), bufs.count().n_audio());
  94         const uint32_t n_midi  = min (current_meters.n_midi(), bufs.count().n_midi());
  95
  96         uint32_t n = 0;
  97
  98         const float falloff_dB = Config->get_meter_falloff() * nframes / _session.nominal_frame_rate();
  99         const uint32_t zoh = _session.nominal_frame_rate() * .021;
 100         _bufcnt += nframes;
 101
 102         // Meter MIDI in to the first n_midi peaks
 103         for (uint32_t i = 0; i < n_midi; ++i, ++n) {
 104                 float val = 0.0f;
 105                 const MidiBuffer& buf (bufs.get_midi(i));
 106
 107                 for (MidiBuffer::const_iterator e = buf.begin(); e != buf.end(); ++e) {
 108                         const Evoral::MIDIEvent<framepos_t> ev(*e, false);
 109                         if (ev.is_note_on()) {
 110                                 const float this_vel = ev.buffer()[2] / 127.0;
 111                                 if (this_vel > val) {
 112                                         val = this_vel;
 113                                 }
 114                                 if (val > 0.01) {
 115                                         if (_combined_peak < 0.01) {
 116                                                 _combined_peak = 0.01;
 117                                         }
 118                                 }
 119                         } else {
 120                                 val += 1.0 / bufs.get_midi(n).capacity();
 121                                 if (val > 1.0) {
 122                                         val = 1.0;
 123                                 }
 124                         }
 125                 }
 126                 if (_peak_power[n] < (1.0 / 512.0)) {
 127                         _peak_power[n] = 0;
 128                 } else {
 129                         /* empirical algorithm WRT to audio falloff times */
 130                         _peak_power[n] -= sqrtf (_peak_power[n]) * falloff_dB * 0.045f;
 131                 }
 132                 _peak_power[n] = max(_peak_power[n], val);
 133                 _max_peak_signal[n] = 0;
 134         }
 135
 136         // Meter audio in to the rest of the peaks
 137         for (uint32_t i = 0; i < n_audio; ++i, ++n) {
 138                 if (bufs.get_audio(i).silent()) {
 139                         ;
 140                 } else {
 141                         _peak_buffer[n] = compute_peak (bufs.get_audio(i).data(), nframes, _peak_buffer[n]);
 142                         _max_peak_signal[n] = std::max(_peak_buffer[n], _max_peak_signal[n]); // todo sync reset
 143                         _combined_peak =std::max(_peak_buffer[n], _combined_peak);
 144                 }
 145
 146                 if (do_reset_max) {
 147                         _max_peak_signal[n] = 0;
 148                 }
 149
 150                 if (do_reset_dpm) {
 151                         _peak_buffer[n] = 0;
 152                         _peak_power[n] = -std::numeric_limits<float>::infinity();
 153                 } else {
 154                         // falloff
 155                         if (_peak_power[n] >  -318.8f) {
 156                                 _peak_power[n] -= falloff_dB;
 157                         } else {
 158                                 _peak_power[n] = -std::numeric_limits<float>::infinity();
 159                         }
 160                         _peak_power[n] = max(_peak_power[n], accurate_coefficient_to_dB(_peak_buffer[n]));
 161                         // integration buffer, retain peaks > 49Hz
 162                         if (_bufcnt > zoh) {
 163                                 _peak_buffer[n] = 0;
 164                         }
 165                 }
 166
 167                 if (_meter_type & (MeterKrms | MeterK20 | MeterK14 | MeterK12)) {
 168                         _kmeter[i]->process(bufs.get_audio(i).data(), nframes);
 169                 }
 170                 if (_meter_type & (MeterIEC1DIN | MeterIEC1NOR)) {
 171                         _iec1meter[i]->process(bufs.get_audio(i).data(), nframes);
 172                 }
 173                 if (_meter_type & (MeterIEC2BBC | MeterIEC2EBU)) {
 174                         _iec2meter[i]->process(bufs.get_audio(i).data(), nframes);
 175                 }
 176                 if (_meter_type & MeterVU) {
 177                         _vumeter[i]->process(bufs.get_audio(i).data(), nframes);
 178                 }
 179         }
 180
 181         // Zero any excess peaks
 182         for (uint32_t i = n; i < _peak_power.size(); ++i) {
 183                 _peak_power[i] = -std::numeric_limits<float>::infinity();
 184                 _max_peak_signal[n] = 0;
 185         }
 186
 187         if (_bufcnt > zoh) {
 188                 _bufcnt = 0;
 189         }
 190
 191         _active = _pending_active;
 192 }
 193
 194 void
 195 PeakMeter::reset ()
 196 {
 197         if (_active || _pending_active) {
 198                 _reset_dpm = true;
 199         } else {
 200                 for (size_t i = 0; i < _peak_power.size(); ++i) {
 201                         _peak_power[i] = -std::numeric_limits<float>::infinity();
 202                         _peak_buffer[i] = 0;
 203                 }
 204         }
 205
 206         // these are handled async just fine.
 207         for (size_t n = 0; n < _kmeter.size(); ++n) {
 208                 _kmeter[n]->reset();
 209                 _iec1meter[n]->reset();
 210                 _iec2meter[n]->reset();
 211                 _vumeter[n]->reset();
 212         }
 213 }
 214
 215 void
 216 PeakMeter::reset_max ()
 217 {
 218         if (_active || _pending_active) {
 219                 _reset_max = true;
 220                 return;
 221         }
 222         for (size_t i = 0; i < _max_peak_signal.size(); ++i) {
 223                 _max_peak_signal[i] = 0;
 224                 _peak_buffer[i] = 0;
 225         }
 226 }
 227
 228 bool
 229 PeakMeter::can_support_io_configuration (const ChanCount& in, ChanCount& out)
 230 {
 231         out = in;
 232         return true;
 233 }
 234
 235 bool
 236 PeakMeter::configure_io (ChanCount in, ChanCount out)
 237 {
 238         if (out != in) { // always 1:1
 239                 return false;
 240         }
 241
 242         current_meters = in;
 243
 244         set_max_channels (in);
 245
 246         return Processor::configure_io (in, out);
 247 }
 248
 249 void
 250 PeakMeter::reflect_inputs (const ChanCount& in)
 251 {
 252         reset();
 253         current_meters = in;
 254         reset_max();
 255         // ConfigurationChanged() postponed
 256 }
 257
 258 void
 259 PeakMeter::emit_configuration_changed () {
 260         ConfigurationChanged (current_meters, current_meters); /* EMIT SIGNAL */
 261 }
 262
 263 void
 264 PeakMeter::set_max_channels (const ChanCount& chn)
 265 {
 266         uint32_t const limit = chn.n_total();
 267         const size_t n_audio = chn.n_audio();
 268
 269         while (_peak_power.size() > limit) {
 270                 _peak_buffer.pop_back();
 271                 _peak_power.pop_back();
 272                 _max_peak_signal.pop_back();
 273         }
 274
 275         while (_peak_power.size() < limit) {
 276                 _peak_buffer.push_back(0);
 277                 _peak_power.push_back(-std::numeric_limits<float>::infinity());
 278                 _max_peak_signal.push_back(0);
 279         }
 280
 281         assert(_peak_buffer.size() == limit);
 282         assert(_peak_power.size() == limit);
 283         assert(_max_peak_signal.size() == limit);
 284
 285         /* alloc/free other audio-only meter types. */
 286         while (_kmeter.size() > n_audio) {
 287                 delete (_kmeter.back());
 288                 delete (_iec1meter.back());
 289                 delete (_iec2meter.back());
 290                 delete (_vumeter.back());
 291                 _kmeter.pop_back();
 292                 _iec1meter.pop_back();
 293                 _iec2meter.pop_back();
 294                 _vumeter.pop_back();
 295         }
 296         while (_kmeter.size() < n_audio) {
 297                 _kmeter.push_back(new Kmeterdsp());
 298                 _iec1meter.push_back(new Iec1ppmdsp());
 299                 _iec2meter.push_back(new Iec2ppmdsp());
 300                 _vumeter.push_back(new Vumeterdsp());
 301         }
 302         assert(_kmeter.size() == n_audio);
 303         assert(_iec1meter.size() == n_audio);
 304         assert(_iec2meter.size() == n_audio);
 305         assert(_vumeter.size() == n_audio);
 306
 307         reset();
 308         reset_max();
 309 }
 310
 311 /** To be driven by the Meter signal from IO.
 312  * Caller MUST hold its own processor_lock to prevent reconfiguration
 313  * of meter size during this call.
 314  */
 315
 316 #define CHECKSIZE(MTR) (n < MTR.size() + n_midi && n >= n_midi)
 317
 318 float
 319 PeakMeter::meter_level(uint32_t n, MeterType type) {
 320         float mcptmp;
 321         switch (type) {
 322                 case MeterKrms:
 323                 case MeterK20:
 324                 case MeterK14:
 325                 case MeterK12:
 326                         {
 327                                 const uint32_t n_midi = current_meters.n_midi();
 328                                 if (CHECKSIZE(_kmeter)) {
 329                                         return accurate_coefficient_to_dB (_kmeter[n - n_midi]->read());
 330                                 }
 331                         }
 332                         break;
 333                 case MeterIEC1DIN:
 334                 case MeterIEC1NOR:
 335                         {
 336                                 const uint32_t n_midi = current_meters.n_midi();
 337                                 if (CHECKSIZE(_iec1meter)) {
 338                                         return accurate_coefficient_to_dB (_iec1meter[n - n_midi]->read());
 339                                 }
 340                         }
 341                         break;
 342                 case MeterIEC2BBC:
 343                 case MeterIEC2EBU:
 344                         {
 345                                 const uint32_t n_midi = current_meters.n_midi();
 346                                 if (CHECKSIZE(_iec2meter)) {
 347                                         return accurate_coefficient_to_dB (_iec2meter[n - n_midi]->read());
 348                                 }
 349                         }
 350                         break;
 351                 case MeterVU:
 352                         {
 353                                 const uint32_t n_midi = current_meters.n_midi();
 354                                 if (CHECKSIZE(_vumeter)) {
 355                                         return accurate_coefficient_to_dB (_vumeter[n - n_midi]->read());
 356                                 }
 357                         }
 358                         break;
 359                 case MeterPeak:
 360                 case MeterPeak0dB:
 361                         if (n < _peak_power.size()) {
 362                                 return _peak_power[n];
 363                         }
 364                         break;
 365                 case MeterMCP:
 366                         mcptmp = _combined_peak;
 367                         _combined_peak = 0;
 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 }