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