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