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
 134 bool
 135 PeakMeter::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
 136 {
 137         out = in;
 138         return true;
 139 }
 140
 141 bool
 142 PeakMeter::configure_io (ChanCount in, ChanCount out)
 143 {
 144         if (out != in) { // always 1:1
 145                 return false;
 146         }
 147
 148         current_meters = in;
 149
 150         reset_max_channels (in);
 151
 152         return Processor::configure_io (in, out);
 153 }
 154
 155 void
 156 PeakMeter::reflect_inputs (const ChanCount& in)
 157 {
 158         current_meters = in;
 159
 160         const size_t limit = min (_peak_signal.size(), (size_t) current_meters.n_total ());
 161         const size_t n_midi  = min (_peak_signal.size(), (size_t) current_meters.n_midi());
 162         const size_t n_audio = current_meters.n_audio();
 163
 164         for (size_t n = 0; n < limit; ++n) {
 165                 if (n < n_midi) {
 166                         _visible_peak_power[n] = 0;
 167                 } else {
 168                         _visible_peak_power[n] = -INFINITY;
 169                 }
 170         }
 171
 172         for (size_t n = 0; n < n_audio; ++n) {
 173                 _kmeter[n]->reset();
 174         }
 175
 176         reset_max();
 177
 178         ConfigurationChanged (in, in); /* EMIT SIGNAL */
 179 }
 180
 181 void
 182 PeakMeter::reset_max_channels (const ChanCount& chn)
 183 {
 184         uint32_t const limit = chn.n_total();
 185         const size_t n_audio = chn.n_audio();
 186
 187         while (_peak_signal.size() > limit) {
 188                 _peak_signal.pop_back();
 189                 _visible_peak_power.pop_back();
 190                 _max_peak_signal.pop_back();
 191                 _max_peak_power.pop_back();
 192         }
 193
 194         while (_peak_signal.size() < limit) {
 195                 _peak_signal.push_back(0);
 196                 _visible_peak_power.push_back(minus_infinity());
 197                 _max_peak_signal.push_back(0);
 198                 _max_peak_power.push_back(minus_infinity());
 199         }
 200
 201         assert(_peak_signal.size() == limit);
 202         assert(_visible_peak_power.size() == limit);
 203         assert(_max_peak_signal.size() == limit);
 204         assert(_max_peak_power.size() == limit);
 205
 206         /* alloc/free other audio-only meter types. */
 207         while (_kmeter.size() > n_audio) {
 208                 delete (_kmeter.back());
 209                 _kmeter.pop_back();
 210         }
 211         while (_kmeter.size() < n_audio) {
 212                 _kmeter.push_back(new Kmeterdsp());
 213         }
 214         assert(_kmeter.size() == n_audio);
 215 }
 216
 217 /** To be driven by the Meter signal from IO.
 218  * Caller MUST hold its own processor_lock to prevent reconfiguration
 219  * of meter size during this call.
 220  */
 221
 222 void
 223 PeakMeter::meter ()
 224 {
 225         if (!_active) {
 226                 return;
 227         }
 228
 229         assert(_visible_peak_power.size() == _peak_signal.size());
 230
 231         const size_t limit = min (_peak_signal.size(), (size_t) current_meters.n_total ());
 232         const size_t n_midi  = min (_peak_signal.size(), (size_t) current_meters.n_midi());
 233
 234         for (size_t n = 0; n < limit; ++n) {
 235
 236                 /* grab peak since last read */
 237
 238                 float new_peak = _peak_signal[n]; /* XXX we should use atomic exchange from here ... */
 239                 _peak_signal[n] = 0;              /* ... to here */
 240
 241                 if (n < n_midi) {
 242                         _max_peak_power[n] = -INFINITY; // std::max (new_peak, _max_peak_power[n]); // XXX
 243                         _max_peak_signal[n] = 0;
 244                         if (Config->get_meter_falloff() == 0.0f || new_peak > _visible_peak_power[n]) {
 245                                 ;
 246                         } else {
 247                                 /* empirical WRT to falloff times , 0.01f ^= 100 Hz update rate */
 248                                 new_peak = _visible_peak_power[n] - sqrt(_visible_peak_power[n] * Config->get_meter_falloff() * 0.01f * 0.0002f);
 249                                 if (new_peak < (1.0 / 512.0)) new_peak = 0;
 250                         }
 251                         _visible_peak_power[n] = new_peak;
 252                         continue;
 253                 }
 254
 255                 /* AUDIO */
 256
 257                 /* compute new visible value using falloff */
 258
 259                 _max_peak_signal[n] = std::max(new_peak, _max_peak_signal[n]);
 260
 261                 if (new_peak > 0.0) {
 262                         new_peak = accurate_coefficient_to_dB (new_peak);
 263                 } else {
 264                         new_peak = minus_infinity();
 265                 }
 266
 267                 /* update max peak */
 268
 269                 _max_peak_power[n] = std::max (new_peak, _max_peak_power[n]);
 270
 271                 if (Config->get_meter_falloff() == 0.0f || new_peak > _visible_peak_power[n]) {
 272                         _visible_peak_power[n] = new_peak;
 273                 } else {
 274                         // do falloff
 275                         new_peak = _visible_peak_power[n] - (Config->get_meter_falloff() * 0.01f);
 276                         _visible_peak_power[n] = std::max (new_peak, -INFINITY);
 277                 }
 278         }
 279 }
 280
 281 float
 282 PeakMeter::meter_level(uint32_t n, MeterType type) {
 283         switch (type) {
 284                 case MeterKrms:
 285                         {
 286                                 const uint32_t n_midi  = current_meters.n_midi();
 287                                 if ((n - n_midi) < _kmeter.size() && (n - n_midi) >= 0) {
 288 #if 0
 289                                         return fast_coefficient_to_dB (_kmeter[n-n_midi]->read());
 290 #else
 291                                         return accurate_coefficient_to_dB (_kmeter[n-n_midi]->read());
 292 #endif
 293                                 }
 294                                 return minus_infinity();
 295                         }
 296                 case MeterPeak:
 297                         return peak_power(n);
 298                 case MeterMaxSignal:
 299                         if (n < _max_peak_signal.size()) {
 300                                 return _max_peak_signal[n];
 301                         } else {
 302                                 return minus_infinity();
 303                         }
 304                 default:
 305                 case MeterMaxPeak:
 306                         if (n < _max_peak_power.size()) {
 307                                 return _max_peak_power[n];
 308                         } else {
 309                                 return minus_infinity();
 310                         }
 311         }
 312 }
 313
 314 void
 315 PeakMeter::set_type(MeterType t)
 316 {
 317         if (t == _meter_type) {
 318                 return;
 319         }
 320
 321         _meter_type = t;
 322
 323         if (t & MeterKrms) {
 324                 const size_t n_audio = current_meters.n_audio();
 325                 for (size_t n = 0; n < n_audio; ++n) {
 326                         _kmeter[n]->reset();
 327                 }
 328         }
 329         TypeChanged(t);
 330 }
 331
 332 XMLNode&
 333 PeakMeter::state (bool full_state)
 334 {
 335         XMLNode& node (Processor::state (full_state));
 336         node.add_property("type", "meter");
 337         return node;
 338 }