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>
33 #include "pbd/ringbuffer.h"
35 #include "ardour/chan_count.h"
36 #include "ardour/midiport_manager.h"
37 #include "ardour/port.h"
45 class LIBARDOUR_API PortManager
48 typedef std::map<std::string,boost::shared_ptr<Port> > Ports;
49 typedef std::list<boost::shared_ptr<Port> > PortList;
52 virtual ~PortManager() {}
54 PortEngine& port_engine();
56 uint32_t port_name_size() const;
57 std::string my_name() const;
59 /* Port registration */
61 boost::shared_ptr<Port> register_input_port (DataType, const std::string& portname, bool async = false, PortFlags extra_flags = PortFlags (0));
62 boost::shared_ptr<Port> register_output_port (DataType, const std::string& portname, bool async = false, PortFlags extra_flags = PortFlags (0));
63 int unregister_port (boost::shared_ptr<Port>);
65 /* Port connectivity */
67 int connect (const std::string& source, const std::string& destination);
68 int disconnect (const std::string& source, const std::string& destination);
69 int disconnect (boost::shared_ptr<Port>);
70 int reestablish_ports ();
71 int reconnect_ports ();
73 bool connected (const std::string&);
74 bool physically_connected (const std::string&);
75 int get_connections (const std::string&, std::vector<std::string>&);
79 boost::shared_ptr<Port> get_port_by_name (const std::string &);
80 void port_renamed (const std::string&, const std::string&);
81 std::string make_port_name_relative (const std::string& name) const;
82 std::string make_port_name_non_relative (const std::string& name) const;
83 std::string get_pretty_name_by_name (const std::string& portname) const;
84 bool port_is_mine (const std::string& fullname) const;
86 static bool port_is_control_only (std::string const &);
88 /* other Port management */
90 bool port_is_physical (const std::string&) const;
91 void get_physical_outputs (DataType type, std::vector<std::string>&);
92 void get_physical_inputs (DataType type, std::vector<std::string>&);
93 ChanCount n_physical_outputs () const;
94 ChanCount n_physical_inputs () const;
96 int get_ports (const std::string& port_name_pattern, DataType type, PortFlags flags, std::vector<std::string>&);
97 int get_ports (DataType, PortList&);
99 void remove_all_ports ();
100 void clear_pending_port_deletions ();
101 virtual void add_pending_port_deletion (Port*) = 0;
102 RingBuffer<Port*>& port_deletions_pending () { return _port_deletions_pending; }
104 /* per-Port monitoring */
106 bool can_request_input_monitoring () const;
107 void request_input_monitoring (const std::string&, bool) const;
108 void ensure_input_monitoring (const std::string&, bool) const;
110 class PortRegistrationFailure : public std::exception {
112 PortRegistrationFailure (std::string const & why = "")
115 ~PortRegistrationFailure () throw () {}
117 const char *what() const throw () { return reason.c_str(); }
123 /* the port engine will invoke these callbacks when the time is right */
125 void registration_callback ();
126 int graph_order_callback ();
127 void connect_callback (const std::string&, const std::string&, bool connection);
129 bool port_remove_in_progress() const { return _port_remove_in_progress; }
131 typedef std::vector<std::string> MidiSelectionPorts;
133 void get_midi_selection_ports (MidiSelectionPorts&) const;
134 void add_to_midi_selection_ports (std::string const&);
135 void remove_from_midi_selection_ports (std::string const&);
136 void clear_midi_selection_ports ();
137 bool port_is_for_midi_selection (std::string const&);
139 /** Emitted if the list of ports to be used for MIDI selection tracking changes */
140 PBD::Signal0<void> MidiSelectionPortsChanged;
142 /** Emitted if the backend notifies us of a graph order event */
143 PBD::Signal0<void> GraphReordered;
145 /** Emitted if a Port is registered or unregistered */
146 PBD::Signal0<void> PortRegisteredOrUnregistered;
148 /** Emitted if a Port is connected or disconnected.
149 * The Port parameters are the ports being connected / disconnected, or 0 if they are not known to Ardour.
150 * The std::string parameters are the (long) port names.
151 * The bool parameter is true if ports were connected, or false for disconnected.
153 PBD::Signal5<void, boost::weak_ptr<Port>, std::string, boost::weak_ptr<Port>, std::string, bool> PortConnectedOrDisconnected;
156 boost::shared_ptr<AudioBackend> _backend;
157 SerializedRCUManager<Ports> ports;
158 bool _port_remove_in_progress;
159 RingBuffer<Port*> _port_deletions_pending;
161 boost::shared_ptr<Port> register_port (DataType type, const std::string& portname, bool input, bool async = false, PortFlags extra_flags = PortFlags (0));
162 void port_registration_failure (const std::string& portname);
164 /** List of ports to be used between ::cycle_start() and ::cycle_end()
166 boost::shared_ptr<Ports> _cycle_ports;
168 void fade_out (gain_t, gain_t, pframes_t);
169 void silence (pframes_t nframes, Session *s = 0);
170 void silence_outputs (pframes_t nframes);
171 void check_monitoring ();
172 /** Signal the start of an audio cycle.
173 * This MUST be called before any reading/writing for this cycle.
176 void cycle_start (pframes_t nframes);
178 /** Signal the end of an audio cycle.
179 * This signifies that the cycle began with @ref cycle_start has ended.
180 * This MUST be called at the end of each cycle.
183 void cycle_end (pframes_t nframes);
185 mutable Glib::Threads::Mutex midi_selection_ports_mutex;
186 MidiSelectionPorts _midi_selection_ports;
193 #endif /* __libardour_port_manager_h__ */