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 <jack/jack.h>
  28 #include <ardour/port.h>
  29 #include <ardour/buffer.h>
  30
  31 namespace ARDOUR {
  32
  33 class AudioEngine;
  34
  35 class AudioPort : public Port {
  36    public:
  37         virtual ~AudioPort() {
  38                 free (_port);
  39         }
  40
  41         void cycle_start(jack_nframes_t nframes);
  42         void cycle_end();
  43
  44         DataType type() const { return DataType(DataType::AUDIO); }
  45
  46         Buffer& get_buffer () {
  47                 return _buffer;
  48         }
  49
  50         AudioBuffer& get_audio_buffer() {
  51                 return _buffer;
  52         }
  53
  54         void reset_overs () {
  55                 _short_overs = 0;
  56                 _long_overs = 0;
  57                 _overlen = 0;
  58         }
  59
  60         void reset_peak_meter () {
  61                 _peak = 0;
  62         }
  63
  64         void reset_meters () {
  65                 reset_peak_meter ();
  66                 reset_overs ();
  67         }
  68
  69         float                       peak_db() const { return _peak_db; }
  70         jack_default_audio_sample_t peak()    const { return _peak; }
  71
  72         uint32_t short_overs () const { return _short_overs; }
  73         uint32_t long_overs ()  const { return _long_overs; }
  74
  75         static void set_short_over_length (jack_nframes_t);
  76         static void set_long_over_length (jack_nframes_t);
  77
  78         /** Assumes that the port is an audio output port */
  79         void silence (jack_nframes_t nframes, jack_nframes_t offset) {
  80                 if (!_silent) {
  81                         _buffer.silence(nframes, offset);
  82                         if (offset == 0 && nframes == _buffer.capacity()) {
  83                                 _silent = true;
  84                         }
  85                 }
  86         }
  87
  88   protected:
  89         friend class AudioEngine;
  90
  91         AudioPort (jack_port_t *port);
  92         void reset ();
  93
  94         /* engine isn't supposed to access below here */
  95
  96         AudioBuffer _buffer;
  97
  98         jack_nframes_t               _overlen;
  99         jack_default_audio_sample_t  _peak;
 100         float                        _peak_db;
 101         uint32_t                     _short_overs;
 102         uint32_t                     _long_overs;
 103
 104         static jack_nframes_t        _long_over_length;
 105         static jack_nframes_t        _short_over_length;
 106 };
 107
 108 } // namespace ARDOUR
 109
 110 #endif /* __ardour_audio_port_h__ */