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