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 }
  44
  45 PeakMeter::~PeakMeter ()
  46 {
  47         while (_kmeter.size() > 0) {
  48                 delete (_kmeter.back());
  49                 _kmeter.pop_back();
  50         }
  51 }
  52
  53
  54 /** Get peaks from @a bufs
  55  * Input acceptance is lenient - the first n buffers from @a bufs will
  56  * be metered, where n was set by the last call to setup(), excess meters will
  57  * be set to 0.
  58  *
  59  * (runs in jack realtime context)
  60  */
  61 void
  62 PeakMeter::run (BufferSet& bufs, framepos_t /*start_frame*/, framepos_t /*end_frame*/, pframes_t nframes, bool)
  63 {
  64         if (!_active && !_pending_active) {
  65                 return;
  66         }
  67
  68         // cerr << "meter " << name() << " runs with " << bufs.available() << " inputs\n";
  69
  70         const uint32_t n_audio = min (current_meters.n_audio(), bufs.count().n_audio());
  71         const uint32_t n_midi  = min (current_meters.n_midi(), bufs.count().n_midi());
  72
  73         uint32_t n = 0;
  74
  75         // Meter MIDI in to the first n_midi peaks
  76         for (uint32_t i = 0; i < n_midi; ++i, ++n) {
  77                 float val = 0.0f;
  78                 MidiBuffer& buf (bufs.get_midi(i));
  79
  80                 for (MidiBuffer::iterator e = buf.begin(); e != buf.end(); ++e) {
  81                         const Evoral::MIDIEvent<framepos_t> ev(*e, false);
  82                         if (ev.is_note_on()) {
  83                                 const float this_vel = ev.buffer()[2] / 127.0;
  84                                 if (this_vel > val) {
  85                                         val = this_vel;
  86                                 }
  87                         } else {
  88                                 val += 1.0 / bufs.get_midi(n).capacity();
  89                                 if (val > 1.0) {
  90                                         val = 1.0;
  91                                 }
  92                         }
  93                 }
  94                 _peak_signal[n] = max (val, _peak_signal[n]);
  95         }
  96
  97         // Meter audio in to the rest of the peaks
  98         for (uint32_t i = 0; i < n_audio; ++i, ++n) {
  99                 _peak_signal[n] = compute_peak (bufs.get_audio(i).data(), nframes, _peak_signal[n]);
 100                 if (_meter_type & MeterKrms) {
 101                         _kmeter[i]->process(bufs.get_audio(i).data(), nframes);
 102                 }
 103         }
 104
 105         // Zero any excess peaks
 106         for (uint32_t i = n; i < _peak_signal.size(); ++i) {
 107                 _peak_signal[i] = 0.0f;
 108         }
 109
 110         _active = _pending_active;
 111 }
 112
 113 void
 114 PeakMeter::reset ()
 115 {
 116         for (size_t i = 0; i < _peak_signal.size(); ++i) {
 117                 _peak_signal[i] = 0.0f;
 118         }
 119
 120         for (size_t n = 0; n < _kmeter.size(); ++n) {
 121                 _kmeter[n]->reset();
 122         }
 123 }
 124
 125 void
 126 PeakMeter::reset_max ()
 127 {
 128         for (size_t i = 0; i < _max_peak_power.size(); ++i) {
 129                 _max_peak_power[i] = -INFINITY;
 130                 _max_peak_signal[i] = 0;
 131         }
 132
 133         const size_t n_midi  = min (_peak_signal.size(), (size_t) current_meters.n_midi());
 134
 135         for (size_t n = 0; n < _peak_signal.size(); ++n) {
 136                 if (n < n_midi) {
 137                         _visible_peak_power[n] = 0;
 138                 } else {
 139                         _visible_peak_power[n] = -INFINITY;
 140                 }
 141         }
 142 }
 143
 144 bool
 145 PeakMeter::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
 146 {
 147         out = in;
 148         return true;
 149 }
 150
 151 bool
 152 PeakMeter::configure_io (ChanCount in, ChanCount out)
 153 {
 154         if (out != in) { // always 1:1
 155                 return false;
 156         }
 157
 158         current_meters = in;
 159
 160         reset_max_channels (in);
 161
 162         return Processor::configure_io (in, out);
 163 }
 164
 165 void
 166 PeakMeter::reflect_inputs (const ChanCount& in)
 167 {
 168         current_meters = in;
 169
 170         const size_t limit = min (_peak_signal.size(), (size_t) current_meters.n_total ());
 171         const size_t n_midi  = min (_peak_signal.size(), (size_t) current_meters.n_midi());
 172
 173         for (size_t n = 0; n < limit; ++n) {
 174                 if (n < n_midi) {
 175                         _visible_peak_power[n] = 0;
 176                 } else {
 177                         _visible_peak_power[n] = -INFINITY;
 178                 }
 179         }
 180
 181         reset();
 182         reset_max();
 183
 184         ConfigurationChanged (in, in); /* EMIT SIGNAL */
 185 }
 186
 187 void
 188 PeakMeter::reset_max_channels (const ChanCount& chn)
 189 {
 190         uint32_t const limit = chn.n_total();
 191         const size_t n_audio = chn.n_audio();
 192
 193         while (_peak_signal.size() > limit) {
 194                 _peak_signal.pop_back();
 195                 _visible_peak_power.pop_back();
 196                 _max_peak_signal.pop_back();
 197                 _max_peak_power.pop_back();
 198         }
 199
 200         while (_peak_signal.size() < limit) {
 201                 _peak_signal.push_back(0);
 202                 _visible_peak_power.push_back(minus_infinity());
 203                 _max_peak_signal.push_back(0);
 204                 _max_peak_power.push_back(minus_infinity());
 205         }
 206
 207         assert(_peak_signal.size() == limit);
 208         assert(_visible_peak_power.size() == limit);
 209         assert(_max_peak_signal.size() == limit);
 210         assert(_max_peak_power.size() == limit);
 211
 212         /* alloc/free other audio-only meter types. */
 213         while (_kmeter.size() > n_audio) {
 214                 delete (_kmeter.back());
 215                 _kmeter.pop_back();
 216         }
 217         while (_kmeter.size() < n_audio) {
 218                 _kmeter.push_back(new Kmeterdsp());
 219         }
 220         assert(_kmeter.size() == n_audio);
 221
 222         reset();
 223         reset_max();
 224 }
 225
 226 /** To be driven by the Meter signal from IO.
 227  * Caller MUST hold its own processor_lock to prevent reconfiguration
 228  * of meter size during this call.
 229  */
 230
 231 void
 232 PeakMeter::meter ()
 233 {
 234         if (!_active) {
 235                 return;
 236         }
 237
 238         assert(_visible_peak_power.size() == _peak_signal.size());
 239
 240         const size_t limit = min (_peak_signal.size(), (size_t) current_meters.n_total ());
 241         const size_t n_midi  = min (_peak_signal.size(), (size_t) current_meters.n_midi());
 242
 243         for (size_t n = 0; n < limit; ++n) {
 244
 245                 /* grab peak since last read */
 246
 247                 float new_peak = _peak_signal[n]; /* XXX we should use atomic exchange from here ... */
 248                 _peak_signal[n] = 0;              /* ... to here */
 249
 250                 if (n < n_midi) {
 251                         _max_peak_power[n] = -INFINITY; // std::max (new_peak, _max_peak_power[n]); // XXX
 252                         _max_peak_signal[n] = 0;
 253                         if (Config->get_meter_falloff() == 0.0f || new_peak > _visible_peak_power[n]) {
 254                                 ;
 255                         } else {
 256                                 /* empirical WRT to falloff times , 0.01f ^= 100 Hz update rate */
 257                                 new_peak = _visible_peak_power[n] - sqrt(_visible_peak_power[n] * Config->get_meter_falloff() * 0.01f * 0.0002f);
 258                                 if (new_peak < (1.0 / 512.0)) new_peak = 0;
 259                         }
 260                         _visible_peak_power[n] = new_peak;
 261                         continue;
 262                 }
 263
 264                 /* AUDIO */
 265
 266                 /* compute new visible value using falloff */
 267
 268                 _max_peak_signal[n] = std::max(new_peak, _max_peak_signal[n]);
 269
 270                 if (new_peak > 0.0) {
 271                         new_peak = accurate_coefficient_to_dB (new_peak);
 272                 } else {
 273                         new_peak = minus_infinity();
 274                 }
 275
 276                 /* update max peak */
 277
 278                 _max_peak_power[n] = std::max (new_peak, _max_peak_power[n]);
 279
 280                 if (Config->get_meter_falloff() == 0.0f || new_peak > _visible_peak_power[n]) {
 281                         _visible_peak_power[n] = new_peak;
 282                 } else {
 283                         // do falloff
 284                         new_peak = _visible_peak_power[n] - (Config->get_meter_falloff() * 0.01f);
 285                         _visible_peak_power[n] = std::max (new_peak, -INFINITY);
 286                 }
 287         }
 288 }
 289
 290 float
 291 PeakMeter::meter_level(uint32_t n, MeterType type) {
 292         switch (type) {
 293                 case MeterKrms:
 294                         {
 295                                 const uint32_t n_midi  = current_meters.n_midi();
 296                                 if ((n - n_midi) < _kmeter.size() && (n - n_midi) >= 0) {
 297 #if 0
 298                                         return fast_coefficient_to_dB (_kmeter[n-n_midi]->read());
 299 #else
 300                                         return accurate_coefficient_to_dB (_kmeter[n-n_midi]->read());
 301 #endif
 302                                 }
 303                                 return minus_infinity();
 304                         }
 305                 case MeterPeak:
 306                         return peak_power(n);
 307                 case MeterMaxSignal:
 308                         if (n < _max_peak_signal.size()) {
 309                                 return _max_peak_signal[n];
 310                         } else {
 311                                 return minus_infinity();
 312                         }
 313                 default:
 314                 case MeterMaxPeak:
 315                         if (n < _max_peak_power.size()) {
 316                                 return _max_peak_power[n];
 317                         } else {
 318                                 return minus_infinity();
 319                         }
 320         }
 321 }
 322
 323 void
 324 PeakMeter::set_type(MeterType t)
 325 {
 326         if (t == _meter_type) {
 327                 return;
 328         }
 329
 330         _meter_type = t;
 331
 332         if (t & MeterKrms) {
 333                 const size_t n_audio = current_meters.n_audio();
 334                 for (size_t n = 0; n < n_audio; ++n) {
 335                         _kmeter[n]->reset();
 336                 }
 337         }
 338         TypeChanged(t);
 339 }
 340
 341 XMLNode&
 342 PeakMeter::state (bool full_state)
 343 {
 344         XMLNode& node (Processor::state (full_state));
 345         node.add_property("type", "meter");
 346         return node;
 347 }