libs/ardour/ardour/meter.h

   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 #ifndef __ardour_meter_h__
  20 #define __ardour_meter_h__
  21
  22 #include <vector>
  23 #include "ardour/types.h"
  24 #include "ardour/processor.h"
  25 #include "pbd/fastlog.h"
  26
  27 namespace ARDOUR {
  28
  29 class BufferSet;
  30 class ChanCount;
  31 class Session;
  32
  33 class Metering {
  34   public:
  35         static void               update_meters ();
  36         static PBD::Signal0<void> Meter;
  37
  38   private:
  39         /* this object is not meant to be instantiated */
  40         Metering();
  41 };
  42
  43 /** Meters peaks on the input and stores them for access.
  44  */
  45 class PeakMeter : public Processor {
  46 public:
  47         PeakMeter(Session& s) : Processor(s, "Meter") {}
  48
  49         void meter();
  50         void reset ();
  51         void reset_max ();
  52
  53         bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const;
  54         bool configure_io (ChanCount in, ChanCount out);
  55
  56         /* special method for meter, to ensure that it can always handle the maximum
  57            number of streams in the route, no matter where we put it.
  58         */
  59
  60         void reset_max_channels (const ChanCount&);
  61
  62         /* tell the meter than no matter how many channels it can handle,
  63            `in' is the number it is actually going be handling from
  64            now on.
  65         */
  66
  67         void reflect_inputs (const ChanCount& in);
  68
  69         /** Compute peaks */
  70         void run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool);
  71
  72         ChanCount input_streams () const { return current_meters; }
  73         ChanCount output_streams () const { return current_meters; }
  74
  75         float peak_power (uint32_t n) {
  76                 if (n < _visible_peak_power.size()) {
  77                         return _visible_peak_power[n];
  78                 } else {
  79                         return minus_infinity();
  80                 }
  81         }
  82
  83         float max_peak_power (uint32_t n) {
  84                 if (n < _max_peak_power.size()) {
  85                         return _max_peak_power[n];
  86                 } else {
  87                         return minus_infinity();
  88                 }
  89         }
  90
  91         XMLNode& state (bool full);
  92
  93 private:
  94         friend class IO;
  95
  96         /** The number of meters that we are currently handling;
  97          *  may be different to _configured_input and _configured_output
  98          *  as it can be altered outside a ::configure_io by ::reflect_inputs.
  99          */
 100         ChanCount current_meters;
 101
 102         std::vector<float> _peak_power;
 103         std::vector<float> _visible_peak_power;
 104         std::vector<float> _max_peak_power;
 105 };
 106
 107
 108 } // namespace ARDOUR
 109
 110 #endif // __ardour_meter_h__