libs/ardour/ardour/port_manager.h

   1 /*
   2     Copyright (C) 2013 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 __libardour_port_manager_h__
  21 #define __libardour_port_manager_h__
  22
  23 #include <vector>
  24 #include <string>
  25 #include <exception>
  26 #include <map>
  27
  28 #include <stdint.h>
  29
  30 #include <boost/shared_ptr.hpp>
  31
  32 #include "pbd/rcu.h"
  33
  34 #include "ardour/chan_count.h"
  35 #include "ardour/midiport_manager.h"
  36 #include "ardour/port.h"
  37
  38 namespace ARDOUR {
  39
  40 class PortEngine;
  41 class AudioBackend;
  42
  43 class LIBARDOUR_API PortManager
  44 {
  45   public:
  46     typedef std::map<std::string,boost::shared_ptr<Port> > Ports;
  47     typedef std::list<boost::shared_ptr<Port> > PortList;
  48
  49     PortManager ();
  50     virtual ~PortManager() {}
  51
  52     PortEngine& port_engine();
  53
  54     uint32_t port_name_size() const;
  55     std::string my_name() const;
  56
  57     /* Port registration */
  58
  59     boost::shared_ptr<Port> register_input_port (DataType, const std::string& portname, bool async = false);
  60     boost::shared_ptr<Port> register_output_port (DataType, const std::string& portname, bool async = false);
  61     int unregister_port (boost::shared_ptr<Port>);
  62
  63     /* Port connectivity */
  64
  65     int  connect (const std::string& source, const std::string& destination);
  66     int  disconnect (const std::string& source, const std::string& destination);
  67     int  disconnect (boost::shared_ptr<Port>);
  68     int  reestablish_ports ();
  69     int  reconnect_ports ();
  70
  71     bool  connected (const std::string&);
  72     bool  connected_to (const std::string&, const std::string&);
  73     bool  physically_connected (const std::string&);
  74     int   get_connections (const std::string&, std::vector<std::string>&);
  75
  76     /* Naming */
  77
  78     boost::shared_ptr<Port> get_port_by_name (const std::string &);
  79     void                    port_renamed (const std::string&, const std::string&);
  80     std::string             make_port_name_relative (const std::string& name) const;
  81     std::string             make_port_name_non_relative (const std::string& name) const;
  82     bool                    port_is_mine (const std::string& fullname) const;
  83
  84     /* other Port management */
  85
  86     bool      port_is_physical (const std::string&) const;
  87     void      get_physical_outputs (DataType type, std::vector<std::string>&);
  88     void      get_physical_inputs (DataType type, std::vector<std::string>&);
  89     ChanCount n_physical_outputs () const;
  90     ChanCount n_physical_inputs () const;
  91
  92     int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&);
  93     int get_ports (DataType, PortList&);
  94
  95     void remove_all_ports ();
  96
  97     /* per-Port monitoring */
  98
  99     bool can_request_input_monitoring () const;
 100     void request_input_monitoring (const std::string&, bool) const;
 101     void ensure_input_monitoring (const std::string&, bool) const;
 102
 103     class PortRegistrationFailure : public std::exception {
 104       public:
 105         PortRegistrationFailure (std::string const & why = "")
 106                 : reason (why) {}
 107
 108         ~PortRegistrationFailure () throw () {}
 109
 110         const char *what() const throw () { return reason.c_str(); }
 111
 112       private:
 113         std::string reason;
 114     };
 115
 116     /* the port engine will invoke these callbacks when the time is right */
 117
 118     void registration_callback ();
 119     int graph_order_callback ();
 120     void connect_callback (const std::string&, const std::string&, bool connection);
 121
 122     bool port_remove_in_progress() const { return _port_remove_in_progress; }
 123
 124     /** Emitted if the backend notifies us of a graph order event */
 125     PBD::Signal0<void> GraphReordered;
 126
 127     /** Emitted if a Port is registered or unregistered */
 128     PBD::Signal0<void> PortRegisteredOrUnregistered;
 129
 130     /** Emitted if a Port is connected or disconnected.
 131      *  The Port parameters are the ports being connected / disconnected, or 0 if they are not known to Ardour.
 132      *  The std::string parameters are the (long) port names.
 133      *  The bool parameter is true if ports were connected, or false for disconnected.
 134      */
 135     PBD::Signal5<void, boost::weak_ptr<Port>, std::string, boost::weak_ptr<Port>, std::string, bool> PortConnectedOrDisconnected;
 136
 137   protected:
 138     boost::shared_ptr<AudioBackend> _backend;
 139     SerializedRCUManager<Ports> ports;
 140     bool _port_remove_in_progress;
 141
 142     boost::shared_ptr<Port> register_port (DataType type, const std::string& portname, bool input, bool async = false);
 143     void port_registration_failure (const std::string& portname);
 144
 145     /** List of ports to be used between ::cycle_start() and ::cycle_end()
 146      */
 147     boost::shared_ptr<Ports> _cycle_ports;
 148
 149     void fade_out (gain_t, gain_t, pframes_t);
 150     void silence (pframes_t nframes);
 151     void check_monitoring ();
 152     /** Signal the start of an audio cycle.
 153      * This MUST be called before any reading/writing for this cycle.
 154      * Realtime safe.
 155      */
 156     void cycle_start (pframes_t nframes);
 157
 158     /** Signal the end of an audio cycle.
 159      * This signifies that the cycle began with @ref cycle_start has ended.
 160      * This MUST be called at the end of each cycle.
 161      * Realtime safe.
 162      */
 163     void cycle_end (pframes_t nframes);
 164 };
 165
 166
 167
 168 } // namespace
 169
 170 #endif /* __libardour_port_manager_h__ */