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/libardour_visibility.h"
  24 #include "ardour/types.h"
  25 #include "ardour/processor.h"
  26 #include "pbd/fastlog.h"
  27
  28 #include "ardour/kmeterdsp.h"
  29 #include "ardour/iec1ppmdsp.h"
  30 #include "ardour/iec2ppmdsp.h"
  31 #include "ardour/vumeterdsp.h"
  32
  33 namespace ARDOUR {
  34
  35 class BufferSet;
  36 class ChanCount;
  37 class Session;
  38
  39 /** Meters peaks on the input and stores them for access.
  40  */
  41 class LIBARDOUR_API PeakMeter : public Processor {
  42 public:
  43         PeakMeter(Session& s, const std::string& name);
  44         ~PeakMeter();
  45
  46         void reset ();
  47         void reset_max ();
  48
  49         bool can_support_io_configuration (const ChanCount& in, ChanCount& out);
  50         bool configure_io (ChanCount in, ChanCount out);
  51
  52         /* special method for meter, to ensure that it can always handle the maximum
  53            number of streams in the route, no matter where we put it.
  54         */
  55
  56         void set_max_channels (const ChanCount&);
  57
  58         /* tell the meter than no matter how many channels it can handle,
  59            `in' is the number it is actually going be handling from
  60            now on.
  61         */
  62
  63         void reflect_inputs (const ChanCount& in);
  64         void emit_configuration_changed ();
  65
  66         /** Compute peaks */
  67         void run (BufferSet& bufs, samplepos_t start_sample, samplepos_t end_sample, double speed, pframes_t nframes, bool);
  68
  69         void activate ()   { }
  70         void deactivate () { }
  71
  72         ChanCount input_streams () const { return current_meters; }
  73         ChanCount output_streams () const { return current_meters; }
  74
  75         float meter_level (uint32_t n, MeterType type);
  76
  77         void set_type(MeterType t);
  78         MeterType get_type() { return _meter_type; }
  79
  80
  81         PBD::Signal1<void, MeterType> TypeChanged;
  82
  83 protected:
  84         XMLNode& state ();
  85
  86 private:
  87         friend class IO;
  88
  89         /** The number of meters that we are currently handling;
  90          *  may be different to _configured_input and _configured_output
  91          *  as it can be altered outside a ::configure_io by ::reflect_inputs.
  92          */
  93         ChanCount current_meters;
  94
  95         bool               _reset_dpm;
  96         bool               _reset_max;
  97
  98         uint32_t           _bufcnt;
  99         std::vector<float> _peak_buffer; // internal, integrate
 100         std::vector<float> _peak_power;  // includes accurate falloff, hence dB
 101         std::vector<float> _max_peak_signal; // dB calculation is done on demand
 102         float _combined_peak; // Mackie surfaces expect the highest peak of all track channels
 103
 104         std::vector<Kmeterdsp *> _kmeter;
 105         std::vector<Iec1ppmdsp *> _iec1meter;
 106         std::vector<Iec2ppmdsp *> _iec2meter;
 107         std::vector<Vumeterdsp *> _vumeter;
 108
 109         MeterType _meter_type;
 110 };
 111
 112 } // namespace ARDOUR
 113
 114 #endif // __ardour_meter_h__