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