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/types.h"
  30
  31 class XMLNode;
  32 class MTDM;
  33
  34 namespace ARDOUR {
  35
  36 class Session;
  37 class IO;
  38 class Delivery;
  39 class MuteMaster;
  40 class Pannable;
  41
  42 /** Port inserts: send output to a Jack port, pick up input at a Jack port
  43  */
  44 class PortInsert : public IOProcessor
  45 {
  46   public:
  47         PortInsert (Session&, boost::shared_ptr<Pannable>, boost::shared_ptr<MuteMaster> mm);
  48         PortInsert (Session&, const std::string&, uint32_t bitslot,
  49                     boost::shared_ptr<Pannable>, boost::shared_ptr<MuteMaster> mm);
  50         ~PortInsert ();
  51
  52         XMLNode& state(bool full);
  53         XMLNode& get_state(void);
  54         int set_state (const XMLNode&, int version);
  55
  56         void run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool);
  57
  58         framecnt_t signal_latency () const;
  59
  60         bool set_name (const std::string& name);
  61
  62         bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const;
  63         bool configure_io (ChanCount in, ChanCount out);
  64
  65         void activate ();
  66         void deactivate ();
  67
  68         uint32_t bit_slot() const { return _bitslot; }
  69
  70         void start_latency_detection ();
  71         void stop_latency_detection ();
  72
  73         MTDM* mtdm () const { return _mtdm; }
  74         void set_measured_latency (framecnt_t);
  75         framecnt_t latency () const;
  76
  77         static void make_unique (XMLNode &);
  78         static std::string name_and_id_new_insert (Session&, uint32_t&);
  79
  80   private:
  81         /* disallow copy construction */
  82         PortInsert (const PortInsert&);
  83
  84         boost::shared_ptr<Delivery> _out;
  85
  86         uint32_t   _bitslot;
  87         MTDM*      _mtdm;
  88         bool       _latency_detect;
  89         framecnt_t _latency_flush_frames;
  90         framecnt_t _measured_latency;
  91 };
  92
  93 } // namespace ARDOUR
  94
  95 #endif /* __ardour_port_insert_h__ */