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         virtual Buffer& get_buffer () {
  37                 return _buffer;
  38         }
  39
  40         virtual AudioBuffer& get_audio_buffer() {
  41                 return _buffer;
  42         }
  43
  44         void reset_overs () {
  45                 _short_overs = 0;
  46                 _long_overs = 0;
  47                 _overlen = 0;
  48         }
  49
  50         void reset_peak_meter () {
  51                 _peak = 0;
  52         }
  53
  54         void reset_meters () {
  55                 reset_peak_meter ();
  56                 reset_overs ();
  57         }
  58
  59         float  peak_db() const { return _peak_db; }
  60         Sample peak()    const { return _peak; }
  61
  62         uint32_t short_overs () const { return _short_overs; }
  63         uint32_t long_overs ()  const { return _long_overs; }
  64
  65         static void set_short_over_length (nframes_t);
  66         static void set_long_over_length (nframes_t);
  67
  68   protected:
  69         friend class AudioEngine;
  70
  71         AudioPort (Flags);            // data buffer comes from elsewhere (e.g. JACK)
  72         AudioPort (Flags, nframes_t); // data buffer owned by ardour
  73         void reset ();
  74
  75         /* engine isn't supposed to access below here */
  76
  77         AudioBuffer _buffer;
  78
  79         nframes_t _overlen;
  80         Sample    _peak;
  81         float     _peak_db;
  82         uint32_t  _short_overs;
  83         uint32_t  _long_overs;
  84
  85         static nframes_t _long_over_length;
  86         static nframes_t _short_over_length;
  87 };
  88
  89 } // namespace ARDOUR
  90
  91 #endif /* __ardour_audio_port_h__ */