libs/ardour/ardour/base_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_base_audio_port_h__
  22 #define __ardour_base_audio_port_h__
  23
  24 #include <string>
  25
  26 #include <sigc++/signal.h>
  27
  28 #include <pbd/failed_constructor.h>
  29
  30 #include <ardour/ardour.h>
  31 #include <ardour/port.h>
  32 #include <ardour/audio_buffer.h>
  33
  34 namespace ARDOUR {
  35
  36 class AudioEngine;
  37
  38 class BaseAudioPort : public virtual Port {
  39   public:
  40         virtual ~BaseAudioPort();
  41
  42         DataType type() const { return DataType::AUDIO; }
  43
  44         virtual Buffer& get_buffer ( nframes_t nframes, nframes_t offset ) {
  45                 return get_audio_buffer( nframes, offset);
  46         }
  47
  48         virtual AudioBuffer& get_audio_buffer (nframes_t nframes, nframes_t offset) = 0;
  49
  50         void reset ();
  51
  52         void reset_overs () {
  53                 /* XXX NOT THREAD SAFE */
  54                 _short_overs = 0;
  55                 _long_overs = 0;
  56                 _overlen = 0;
  57         }
  58
  59         void reset_peak_meter () {
  60                 /* XXX NOT THREAD SAFE */
  61                 _peak = 0;
  62         }
  63
  64         void reset_meters () {
  65                 /* XXX NOT THREAD SAFE */
  66                 reset_peak_meter ();
  67                 reset_overs ();
  68         }
  69
  70         float  peak_db() const { return _peak_db; }
  71         Sample peak()    const { return _peak; }
  72
  73         uint32_t short_overs () const { return _short_overs; }
  74         uint32_t long_overs ()  const { return _long_overs; }
  75
  76         static void set_short_over_length (nframes_t);
  77         static void set_long_over_length (nframes_t);
  78
  79         void set_mixdown_function (void (*func)(const std::set<Port*>&, AudioBuffer*, nframes_t, nframes_t, bool));
  80
  81   protected:
  82         BaseAudioPort (const std::string& name, Flags flags);
  83
  84         AudioBuffer* _buffer;
  85         nframes_t    _overlen;
  86         Sample       _peak;
  87         float        _peak_db;
  88         uint32_t     _short_overs;
  89         uint32_t     _long_overs;
  90         bool         _own_buffer;
  91
  92         void (*_mixdown)(const std::set<Port*>&, AudioBuffer*, nframes_t, nframes_t, bool);
  93
  94         static void default_mixdown (const std::set<Port*>&, AudioBuffer*, nframes_t, nframes_t, bool);
  95
  96         static nframes_t _long_over_length;
  97         static nframes_t _short_over_length;
  98 };
  99
 100 } // namespace ARDOUR
 101
 102 #endif /* __ardour_base_audio_port_h__ */