libs/ardour/ardour/port_insert.h

   1 /*
   2     Copyright (C) 2000,2007 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 */
  19
  20 #ifndef __ardour_port_insert_h__
  21 #define __ardour_port_insert_h__
  22
  23 #include <vector>
  24 #include <string>
  25 #include <exception>
  26
  27 #include "ardour/ardour.h"
  28 #include "ardour/io_processor.h"
  29 #include "ardour/delivery.h"
  30 #include "ardour/libardour_visibility.h"
  31 #include "ardour/types.h"
  32
  33 class XMLNode;
  34 class MTDM;
  35
  36 namespace ARDOUR {
  37
  38 class Session;
  39 class IO;
  40 class Delivery;
  41 class MuteMaster;
  42 class Pannable;
  43
  44 /** Port inserts: send output to a Jack port, pick up input at a Jack port
  45  */
  46 class LIBARDOUR_API PortInsert : public IOProcessor
  47 {
  48 public:
  49         PortInsert (Session&, boost::shared_ptr<Pannable>, boost::shared_ptr<MuteMaster> mm);
  50         ~PortInsert ();
  51
  52         int set_state (const XMLNode&, int version);
  53
  54         void run (BufferSet& bufs, samplepos_t start_sample, samplepos_t end_sample, double speed, pframes_t nframes, bool);
  55
  56         void flush_buffers (samplecnt_t nframes) {
  57                 _out->flush_buffers (nframes);
  58         }
  59
  60         samplecnt_t signal_latency () const;
  61
  62         bool set_name (const std::string& name);
  63
  64         bool can_support_io_configuration (const ChanCount& in, ChanCount& out);
  65         bool configure_io (ChanCount in, ChanCount out);
  66
  67         void activate ();
  68         void deactivate ();
  69
  70         void set_pre_fader (bool);
  71
  72         uint32_t bit_slot() const { return _bitslot; }
  73
  74         void start_latency_detection ();
  75         void stop_latency_detection ();
  76
  77         MTDM* mtdm () const { return _mtdm; }
  78         void set_measured_latency (samplecnt_t);
  79         samplecnt_t latency () const;
  80
  81         static std::string name_and_id_new_insert (Session&, uint32_t&);
  82
  83 protected:
  84         XMLNode& state ();
  85 private:
  86         /* disallow copy construction */
  87         PortInsert (const PortInsert&);
  88
  89         boost::shared_ptr<Delivery> _out;
  90
  91         uint32_t   _bitslot;
  92         MTDM*      _mtdm;
  93         bool       _latency_detect;
  94         samplecnt_t _latency_flush_samples;
  95         samplecnt_t _measured_latency;
  96 };
  97
  98 } // namespace ARDOUR
  99
 100 #endif /* __ardour_port_insert_h__ */