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