libs/ardour/ardour/audio_port.h

   1 /*
   2     Copyright (C) 2002 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18     $Id: port.h 712 2006-07-28 01:08:57Z drobilla $
  19 */
  20
  21 #ifndef __ardour_audio_port_h__
  22 #define __ardour_audio_port_h__
  23
  24 #include <sigc++/signal.h>
  25 #include <pbd/failed_constructor.h>
  26 #include <ardour/ardour.h>
  27 #include <ardour/port.h>
  28 #include <ardour/audio_buffer.h>
  29
  30 namespace ARDOUR {
  31
  32 class AudioEngine;
  33
  34 class AudioPort : public virtual Port {
  35    public:
  36         DataType type() const { return DataType::AUDIO; }
  37
  38         virtual Buffer& get_buffer () {
  39                 return _buffer;
  40         }
  41
  42         virtual AudioBuffer& get_audio_buffer() {
  43                 return _buffer;
  44         }
  45
  46         void reset_overs () {
  47                 _short_overs = 0;
  48                 _long_overs = 0;
  49                 _overlen = 0;
  50         }
  51
  52         void reset_peak_meter () {
  53                 _peak = 0;
  54         }
  55
  56         void reset_meters () {
  57                 reset_peak_meter ();
  58                 reset_overs ();
  59         }
  60
  61         float  peak_db() const { return _peak_db; }
  62         Sample peak()    const { return _peak; }
  63
  64         uint32_t short_overs () const { return _short_overs; }
  65         uint32_t long_overs ()  const { return _long_overs; }
  66
  67         static void set_short_over_length (nframes_t);
  68         static void set_long_over_length (nframes_t);
  69
  70   protected:
  71         friend class AudioEngine;
  72
  73         AudioPort ();          // data buffer comes from elsewhere (e.g. JACK)
  74         AudioPort (nframes_t); // data buffer owned by ardour
  75         void reset ();
  76
  77         /* engine isn't supposed to access below here */
  78
  79         AudioBuffer _buffer;
  80
  81         nframes_t _overlen;
  82         Sample    _peak;
  83         float     _peak_db;
  84         uint32_t  _short_overs;
  85         uint32_t  _long_overs;
  86
  87         static nframes_t _long_over_length;
  88         static nframes_t _short_over_length;
  89 };
  90
  91 } // namespace ARDOUR
  92
  93 #endif /* __ardour_audio_port_h__ */