2 Copyright (C) 2013 Paul Davis
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.
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.
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.
20 #ifndef __libardour_port_manager_h__
21 #define __libardour_port_manager_h__
30 #include <boost/shared_ptr.hpp>
34 #include "ardour/chan_count.h"
35 #include "ardour/midiport_manager.h"
36 #include "ardour/port.h"
44 class LIBARDOUR_API PortManager
47 typedef std::map<std::string,boost::shared_ptr<Port> > Ports;
48 typedef std::list<boost::shared_ptr<Port> > PortList;
51 virtual ~PortManager() {}
53 PortEngine& port_engine();
55 uint32_t port_name_size() const;
56 std::string my_name() const;
58 /* Port registration */
60 boost::shared_ptr<Port> register_input_port (DataType, const std::string& portname, bool async = false, PortFlags extra_flags = PortFlags (0));
61 boost::shared_ptr<Port> register_output_port (DataType, const std::string& portname, bool async = false, PortFlags extra_flags = PortFlags (0));
62 int unregister_port (boost::shared_ptr<Port>);
64 /* Port connectivity */
66 int connect (const std::string& source, const std::string& destination);
67 int disconnect (const std::string& source, const std::string& destination);
68 int disconnect (boost::shared_ptr<Port>);
69 int reestablish_ports ();
70 int reconnect_ports ();
72 bool connected (const std::string&);
73 bool physically_connected (const std::string&);
74 int get_connections (const std::string&, std::vector<std::string>&);
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 std::string get_pretty_name_by_name (const std::string& portname) const;
83 bool port_is_mine (const std::string& fullname) const;
85 static bool port_is_control_only (std::string const &);
87 /* other Port management */
89 bool port_is_physical (const std::string&) const;
90 void get_physical_outputs (DataType type, std::vector<std::string>&);
91 void get_physical_inputs (DataType type, std::vector<std::string>&);
92 ChanCount n_physical_outputs () const;
93 ChanCount n_physical_inputs () const;
95 int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&);
96 int get_ports (DataType, PortList&);
98 void remove_all_ports ();
100 /* per-Port monitoring */
102 bool can_request_input_monitoring () const;
103 void request_input_monitoring (const std::string&, bool) const;
104 void ensure_input_monitoring (const std::string&, bool) const;
106 class PortRegistrationFailure : public std::exception {
108 PortRegistrationFailure (std::string const & why = "")
111 ~PortRegistrationFailure () throw () {}
113 const char *what() const throw () { return reason.c_str(); }
119 /* the port engine will invoke these callbacks when the time is right */
121 void registration_callback ();
122 int graph_order_callback ();
123 void connect_callback (const std::string&, const std::string&, bool connection);
125 bool port_remove_in_progress() const { return _port_remove_in_progress; }
127 /** Emitted if the backend notifies us of a graph order event */
128 PBD::Signal0<void> GraphReordered;
130 /** Emitted if a Port is registered or unregistered */
131 PBD::Signal0<void> PortRegisteredOrUnregistered;
133 /** Emitted if a Port is connected or disconnected.
134 * The Port parameters are the ports being connected / disconnected, or 0 if they are not known to Ardour.
135 * The std::string parameters are the (long) port names.
136 * The bool parameter is true if ports were connected, or false for disconnected.
138 PBD::Signal5<void, boost::weak_ptr<Port>, std::string, boost::weak_ptr<Port>, std::string, bool> PortConnectedOrDisconnected;
141 boost::shared_ptr<AudioBackend> _backend;
142 SerializedRCUManager<Ports> ports;
143 bool _port_remove_in_progress;
145 boost::shared_ptr<Port> register_port (DataType type, const std::string& portname, bool input, bool async = false, PortFlags extra_flags = PortFlags (0));
146 void port_registration_failure (const std::string& portname);
148 /** List of ports to be used between ::cycle_start() and ::cycle_end()
150 boost::shared_ptr<Ports> _cycle_ports;
152 void fade_out (gain_t, gain_t, pframes_t);
153 void silence (pframes_t nframes, Session *s = 0);
154 void silence_outputs (pframes_t nframes);
155 void check_monitoring ();
156 /** Signal the start of an audio cycle.
157 * This MUST be called before any reading/writing for this cycle.
160 void cycle_start (pframes_t nframes);
162 /** Signal the end of an audio cycle.
163 * This signifies that the cycle began with @ref cycle_start has ended.
164 * This MUST be called at the end of each cycle.
167 void cycle_end (pframes_t nframes);
174 #endif /* __libardour_port_manager_h__ */