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/libardour_visibility.h"
  30 #include "ardour/types.h"
  31
  32 class XMLNode;
  33 class MTDM;
  34
  35 namespace ARDOUR {
  36
  37 class Session;
  38 class IO;
  39 class Delivery;
  40 class MuteMaster;
  41 class Pannable;
  42
  43 /** Port inserts: send output to a Jack port, pick up input at a Jack port
  44  */
  45 class LIBARDOUR_API PortInsert : public IOProcessor
  46 {
  47   public:
  48         PortInsert (Session&, boost::shared_ptr<Pannable>, boost::shared_ptr<MuteMaster> mm);
  49         ~PortInsert ();
  50
  51         XMLNode& state(bool full);
  52         XMLNode& get_state(void);
  53         int set_state (const XMLNode&, int version);
  54
  55         void run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, double speed, pframes_t nframes, bool);
  56
  57         framecnt_t signal_latency () const;
  58
  59         bool set_name (const std::string& name);
  60
  61         bool can_support_io_configuration (const ChanCount& in, ChanCount& out);
  62         bool configure_io (ChanCount in, ChanCount out);
  63
  64         void activate ();
  65         void deactivate ();
  66
  67         void set_pre_fader (bool);
  68
  69         uint32_t bit_slot() const { return _bitslot; }
  70
  71         void start_latency_detection ();
  72         void stop_latency_detection ();
  73
  74         MTDM* mtdm () const { return _mtdm; }
  75         void set_measured_latency (framecnt_t);
  76         framecnt_t latency () const;
  77
  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__ */