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                         _peak_buffer[n] = 0;
 141                 } else {
 142                         _peak_buffer[n] = compute_peak (bufs.get_audio(i).data(), nframes, _peak_buffer[n]);
 143                         _peak_buffer[n] = std::min (_peak_buffer[n], 100.f); // cut off at +40dBFS for falloff.
 144                         _max_peak_signal[n] = std::max(_peak_buffer[n], _max_peak_signal[n]); // todo sync reset
 145                         _combined_peak = std::max(_peak_buffer[n], _combined_peak);
 146                 }
 147
 148                 if (do_reset_max) {
 149                         _max_peak_signal[n] = 0;
 150                 }
 151
 152                 if (do_reset_dpm) {
 153                         _peak_buffer[n] = 0;
 154                         _peak_power[n] = -std::numeric_limits<float>::infinity();
 155                 } else {
 156                         // falloff
 157                         if (_peak_power[n] >  -318.8f) {
 158                                 _peak_power[n] -= falloff_dB;
 159                         } else {
 160                                 _peak_power[n] = -std::numeric_limits<float>::infinity();
 161                         }
 162                         _peak_power[n] = max(_peak_power[n], accurate_coefficient_to_dB(_peak_buffer[n]));
 163                         // integration buffer, retain peaks > 49Hz
 164                         if (_bufcnt > zoh) {
 165                                 _peak_buffer[n] = 0;
 166                         }
 167                 }
 168
 169                 if (_meter_type & (MeterKrms | MeterK20 | MeterK14 | MeterK12)) {
 170                         _kmeter[i]->process(bufs.get_audio(i).data(), nframes);
 171                 }
 172                 if (_meter_type & (MeterIEC1DIN | MeterIEC1NOR)) {
 173                         _iec1meter[i]->process(bufs.get_audio(i).data(), nframes);
 174                 }
 175                 if (_meter_type & (MeterIEC2BBC | MeterIEC2EBU)) {
 176                         _iec2meter[i]->process(bufs.get_audio(i).data(), nframes);
 177                 }
 178                 if (_meter_type & MeterVU) {
 179                         _vumeter[i]->process(bufs.get_audio(i).data(), nframes);
 180                 }
 181         }
 182
 183         // Zero any excess peaks
 184         for (uint32_t i = n; i < _peak_power.size(); ++i) {
 185                 _peak_power[i] = -std::numeric_limits<float>::infinity();
 186                 _max_peak_signal[n] = 0;
 187         }
 188
 189         if (_bufcnt > zoh) {
 190                 _bufcnt = 0;
 191         }
 192
 193         _active = _pending_active;
 194 }
 195
 196 void
 197 PeakMeter::reset ()
 198 {
 199         if (_active || _pending_active) {
 200                 _reset_dpm = true;
 201         } else {
 202                 for (size_t i = 0; i < _peak_power.size(); ++i) {
 203                         _peak_power[i] = -std::numeric_limits<float>::infinity();
 204                         _peak_buffer[i] = 0;
 205                 }
 206         }
 207
 208         // these are handled async just fine.
 209         for (size_t n = 0; n < _kmeter.size(); ++n) {
 210                 _kmeter[n]->reset();
 211                 _iec1meter[n]->reset();
 212                 _iec2meter[n]->reset();
 213                 _vumeter[n]->reset();
 214         }
 215 }
 216
 217 void
 218 PeakMeter::reset_max ()
 219 {
 220         if (_active || _pending_active) {
 221                 _reset_max = true;
 222                 return;
 223         }
 224         for (size_t i = 0; i < _max_peak_signal.size(); ++i) {
 225                 _max_peak_signal[i] = 0;
 226                 _peak_buffer[i] = 0;
 227         }
 228 }
 229
 230 bool
 231 PeakMeter::can_support_io_configuration (const ChanCount& in, ChanCount& out)
 232 {
 233         out = in;
 234         return true;
 235 }
 236
 237 bool
 238 PeakMeter::configure_io (ChanCount in, ChanCount out)
 239 {
 240         bool changed = false;
 241         if (out != in) { // always 1:1
 242                 return false;
 243         }
 244
 245         if (current_meters != in) {
 246                 changed = true;
 247         }
 248
 249         current_meters = in;
 250
 251         set_max_channels (in);
 252
 253         if (changed) {
 254                 reset_max();
 255         }
 256
 257         return Processor::configure_io (in, out);
 258 }
 259
 260 void
 261 PeakMeter::reflect_inputs (const ChanCount& in)
 262 {
 263         reset();
 264         current_meters = in;
 265         reset_max();
 266         // ConfigurationChanged() postponed
 267 }
 268
 269 void
 270 PeakMeter::emit_configuration_changed () {
 271         ConfigurationChanged (current_meters, current_meters); /* EMIT SIGNAL */
 272 }
 273
 274 void
 275 PeakMeter::set_max_channels (const ChanCount& chn)
 276 {
 277         uint32_t const limit = chn.n_total();
 278         const size_t n_audio = chn.n_audio();
 279
 280         while (_peak_power.size() > limit) {
 281                 _peak_buffer.pop_back();
 282                 _peak_power.pop_back();
 283                 _max_peak_signal.pop_back();
 284         }
 285
 286         while (_peak_power.size() < limit) {
 287                 _peak_buffer.push_back(0);
 288                 _peak_power.push_back(-std::numeric_limits<float>::infinity());
 289                 _max_peak_signal.push_back(0);
 290         }
 291
 292         assert(_peak_buffer.size() == limit);
 293         assert(_peak_power.size() == limit);
 294         assert(_max_peak_signal.size() == limit);
 295
 296         /* alloc/free other audio-only meter types. */
 297         while (_kmeter.size() > n_audio) {
 298                 delete (_kmeter.back());
 299                 delete (_iec1meter.back());
 300                 delete (_iec2meter.back());
 301                 delete (_vumeter.back());
 302                 _kmeter.pop_back();
 303                 _iec1meter.pop_back();
 304                 _iec2meter.pop_back();
 305                 _vumeter.pop_back();
 306         }
 307         while (_kmeter.size() < n_audio) {
 308                 _kmeter.push_back(new Kmeterdsp());
 309                 _iec1meter.push_back(new Iec1ppmdsp());
 310                 _iec2meter.push_back(new Iec2ppmdsp());
 311                 _vumeter.push_back(new Vumeterdsp());
 312         }
 313         assert(_kmeter.size() == n_audio);
 314         assert(_iec1meter.size() == n_audio);
 315         assert(_iec2meter.size() == n_audio);
 316         assert(_vumeter.size() == n_audio);
 317
 318         reset();
 319         reset_max();
 320 }
 321
 322 /** To be driven by the Meter signal from IO.
 323  * Caller MUST hold its own processor_lock to prevent reconfiguration
 324  * of meter size during this call.
 325  */
 326
 327 #define CHECKSIZE(MTR) (n < MTR.size() + n_midi && n >= n_midi)
 328
 329 float
 330 PeakMeter::meter_level(uint32_t n, MeterType type) {
 331         float mcptmp;
 332         switch (type) {
 333                 case MeterKrms:
 334                 case MeterK20:
 335                 case MeterK14:
 336                 case MeterK12:
 337                         {
 338                                 const uint32_t n_midi = current_meters.n_midi();
 339                                 if (CHECKSIZE(_kmeter)) {
 340                                         return accurate_coefficient_to_dB (_kmeter[n - n_midi]->read());
 341                                 }
 342                         }
 343                         break;
 344                 case MeterIEC1DIN:
 345                 case MeterIEC1NOR:
 346                         {
 347                                 const uint32_t n_midi = current_meters.n_midi();
 348                                 if (CHECKSIZE(_iec1meter)) {
 349                                         return accurate_coefficient_to_dB (_iec1meter[n - n_midi]->read());
 350                                 }
 351                         }
 352                         break;
 353                 case MeterIEC2BBC:
 354                 case MeterIEC2EBU:
 355                         {
 356                                 const uint32_t n_midi = current_meters.n_midi();
 357                                 if (CHECKSIZE(_iec2meter)) {
 358                                         return accurate_coefficient_to_dB (_iec2meter[n - n_midi]->read());
 359                                 }
 360                         }
 361                         break;
 362                 case MeterVU:
 363                         {
 364                                 const uint32_t n_midi = current_meters.n_midi();
 365                                 if (CHECKSIZE(_vumeter)) {
 366                                         return accurate_coefficient_to_dB (_vumeter[n - n_midi]->read());
 367                                 }
 368                         }
 369                         break;
 370                 case MeterPeak:
 371                 case MeterPeak0dB:
 372                         if (n < _peak_power.size()) {
 373                                 return _peak_power[n];
 374                         }
 375                         break;
 376                 case MeterMCP:
 377                         mcptmp = _combined_peak;
 378                         return accurate_coefficient_to_dB(mcptmp);
 379                 case MeterMaxSignal:
 380                         assert(0);
 381                         break;
 382                 default:
 383                 case MeterMaxPeak:
 384                         if (n < _max_peak_signal.size()) {
 385                                 return accurate_coefficient_to_dB(_max_peak_signal[n]);
 386                         }
 387                         break;
 388         }
 389         return minus_infinity();
 390 }
 391
 392 void
 393 PeakMeter::set_type(MeterType t)
 394 {
 395         if (t == _meter_type) {
 396                 return;
 397         }
 398
 399         _meter_type = t;
 400
 401         if (t & (MeterKrms | MeterK20 | MeterK14 | MeterK12)) {
 402                 const size_t n_audio = current_meters.n_audio();
 403                 for (size_t n = 0; n < n_audio; ++n) {
 404                         _kmeter[n]->reset();
 405                 }
 406         }
 407         if (t & (MeterIEC1DIN | MeterIEC1NOR)) {
 408                 const size_t n_audio = current_meters.n_audio();
 409                 for (size_t n = 0; n < n_audio; ++n) {
 410                         _iec1meter[n]->reset();
 411                 }
 412         }
 413         if (t & (MeterIEC2BBC | MeterIEC2EBU)) {
 414                 const size_t n_audio = current_meters.n_audio();
 415                 for (size_t n = 0; n < n_audio; ++n) {
 416                         _iec2meter[n]->reset();
 417                 }
 418         }
 419         if (t & MeterVU) {
 420                 const size_t n_audio = current_meters.n_audio();
 421                 for (size_t n = 0; n < n_audio; ++n) {
 422                         _vumeter[n]->reset();
 423                 }
 424         }
 425
 426         TypeChanged(t);
 427 }
 428
 429 XMLNode&
 430 PeakMeter::state (bool full_state)
 431 {
 432         XMLNode& node (Processor::state (full_state));
 433         node.add_property("type", "meter");
 434         return node;
 435 }