send a slightly more useful message if a control protocol's probe() method fails
[ardour.git] / libs / ardour / port_manager.cc
index 1557a6106ced9da14ef9194c22ddf5e058e768b7..408e7804603eb73961284584529f3ee63f08fd7b 100644 (file)
 
 */
 
+#ifdef COMPILER_MSVC
+#include <io.h> // Microsoft's nearest equivalent to <unistd.h>
+#include <ardourext/misc.h>
+#else
+#include <regex.h>
+#endif
+
+#include "pbd/convert.h"
 #include "pbd/error.h"
 
 #include "ardour/async_midi_port.h"
 #include "ardour/midi_port.h"
 #include "ardour/midiport_manager.h"
 #include "ardour/port_manager.h"
+#include "ardour/profile.h"
+#include "ardour/session.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace ARDOUR;
 using namespace PBD;
@@ -73,20 +83,14 @@ PortManager::make_port_name_relative (const string& portname) const
                return portname;
        }
 
-       string::size_type len;
-       string::size_type n;
-       string self = _backend->my_name();
-
-       len = portname.length();
+       string::size_type colon = portname.find (':');
 
-       for (n = 0; n < len; ++n) {
-               if (portname[n] == ':') {
-                       break;
-               }
+       if (colon == string::npos) {
+               return portname;
        }
 
-       if ((n != len) && (portname.substr (0, n) == self)) {
-               return portname.substr (n+1);
+       if (portname.substr (0, colon) == _backend->my_name()) {
+               return portname.substr (colon+1);
        }
 
        return portname;
@@ -162,21 +166,23 @@ void
 PortManager::get_physical_outputs (DataType type, std::vector<std::string>& s)
 {
        if (!_backend) {
+               s.clear ();
                return;
        }
        _backend->get_physical_outputs (type, s);
 }
+
 void
 PortManager::get_physical_inputs (DataType type, std::vector<std::string>& s)
 {
        if (!_backend) {
+               s.clear ();
                return;
        }
 
        _backend->get_physical_inputs (type, s);
 }
+
 ChanCount
 PortManager::n_physical_outputs () const
 {
@@ -186,7 +192,7 @@ PortManager::n_physical_outputs () const
 
        return _backend->n_physical_outputs ();
 }
+
 ChanCount
 PortManager::n_physical_inputs () const
 {
@@ -238,7 +244,7 @@ PortManager::port_renamed (const std::string& old_relative_name, const std::stri
        RCUWriter<Ports> writer (ports);
        boost::shared_ptr<Ports> p = writer.get_copy();
        Ports::iterator x = p->find (old_relative_name);
-       
+
        if (x != p->end()) {
                boost::shared_ptr<Port> port = x->second;
                p->erase (x);
@@ -261,6 +267,8 @@ PortManager::get_ports (DataType type, PortList& pl)
 int
 PortManager::get_ports (const string& port_name_pattern, DataType type, PortFlags flags, vector<string>& s)
 {
+       s.clear();
+
        if (!_backend) {
                return 0;
        }
@@ -293,24 +301,28 @@ PortManager::port_registration_failure (const std::string& portname)
 }
 
 boost::shared_ptr<Port>
-PortManager::register_port (DataType dtype, const string& portname, bool input, bool async)
+PortManager::register_port (DataType dtype, const string& portname, bool input, bool async, PortFlags flags)
 {
        boost::shared_ptr<Port> newport;
 
+       /* limit the possible flags that can be set */
+
+       flags = PortFlags (flags & (Hidden|Shadow|IsTerminal));
+
        try {
                if (dtype == DataType::AUDIO) {
                        DEBUG_TRACE (DEBUG::Ports, string_compose ("registering AUDIO port %1, input %2\n",
                                                                   portname, input));
-                       newport.reset (new AudioPort (portname, (input ? IsInput : IsOutput)));
+                       newport.reset (new AudioPort (portname, PortFlags ((input ? IsInput : IsOutput) | flags)));
                } else if (dtype == DataType::MIDI) {
                        if (async) {
                                DEBUG_TRACE (DEBUG::Ports, string_compose ("registering ASYNC MIDI port %1, input %2\n",
                                                                           portname, input));
-                               newport.reset (new AsyncMIDIPort (portname, (input ? IsInput : IsOutput)));
+                               newport.reset (new AsyncMIDIPort (portname, PortFlags ((input ? IsInput : IsOutput) | flags)));
                        } else {
                                DEBUG_TRACE (DEBUG::Ports, string_compose ("registering MIDI port %1, input %2\n",
                                                                           portname, input));
-                               newport.reset (new MidiPort (portname, (input ? IsInput : IsOutput)));
+                               newport.reset (new MidiPort (portname, PortFlags ((input ? IsInput : IsOutput) | flags)));
                        }
                } else {
                        throw PortRegistrationFailure("unable to create port (unknown type)");
@@ -338,20 +350,26 @@ PortManager::register_port (DataType dtype, const string& portname, bool input,
 }
 
 boost::shared_ptr<Port>
-PortManager::register_input_port (DataType type, const string& portname, bool async)
+PortManager::register_input_port (DataType type, const string& portname, bool async, PortFlags extra_flags)
 {
-       return register_port (type, portname, true, async);
+       return register_port (type, portname, true, async, extra_flags);
 }
 
 boost::shared_ptr<Port>
-PortManager::register_output_port (DataType type, const string& portname, bool async)
+PortManager::register_output_port (DataType type, const string& portname, bool async, PortFlags extra_flags)
 {
-       return register_port (type, portname, false, async);
+       return register_port (type, portname, false, async, extra_flags);
 }
 
 int
 PortManager::unregister_port (boost::shared_ptr<Port> port)
 {
+       /* This is a little subtle. We do not call the backend's port
+        * unregistration code from here. That is left for the Port
+        * destructor. We are trying to drop references to the Port object
+        * here, so that its destructor will run and it will unregister itself.
+        */
+
        /* caller must hold process lock */
 
        {
@@ -387,6 +405,40 @@ PortManager::connected (const string& port_name)
        return _backend->connected (handle);
 }
 
+bool
+PortManager::physically_connected (const string& port_name)
+{
+       if (!_backend) {
+               return false;
+       }
+
+       PortEngine::PortHandle handle = _backend->get_port_by_name (port_name);
+
+       if (!handle) {
+               return false;
+       }
+
+       return _backend->physically_connected (handle);
+}
+
+int
+PortManager::get_connections (const string& port_name, std::vector<std::string>& s)
+{
+       if (!_backend) {
+               s.clear ();
+               return 0;
+       }
+
+       PortEngine::PortHandle handle = _backend->get_port_by_name (port_name);
+
+       if (!handle) {
+               s.clear ();
+               return 0;
+       }
+
+       return _backend->get_connections (handle, s);
+}
+
 int
 PortManager::connect (const string& source, const string& destination)
 {
@@ -487,12 +539,14 @@ PortManager::reconnect_ports ()
 {
        boost::shared_ptr<Ports> p = ports.reader ();
 
-       /* re-establish connections */
+       if (!Profile->get_trx()) {
+               /* re-establish connections */
 
-       DEBUG_TRACE (DEBUG::Ports, string_compose ("reconnect %1 ports\n", p->size()));
+               DEBUG_TRACE (DEBUG::Ports, string_compose ("reconnect %1 ports\n", p->size()));
 
-       for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
-               i->second->reconnect ();
+               for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
+                       i->second->reconnect ();
+               }
        }
 
        return 0;
@@ -521,7 +575,7 @@ PortManager::connect_callback (const string& a, const string& b, bool conn)
                port_b, b,
                conn
                ); /* EMIT SIGNAL */
-}      
+}
 
 void
 PortManager::registration_callback ()
@@ -540,7 +594,7 @@ PortManager::can_request_input_monitoring () const
 
        return _backend->can_monitor_input ();
 }
+
 void
 PortManager::request_input_monitoring (const string& name, bool yn) const
 {
@@ -554,7 +608,7 @@ PortManager::request_input_monitoring (const string& name, bool yn) const
                _backend->request_input_monitoring (ph, yn);
        }
 }
+
 void
 PortManager::ensure_input_monitoring (const string& name, bool yn) const
 {
@@ -575,7 +629,7 @@ PortManager::port_name_size() const
        if (!_backend) {
                return 0;
        }
-       
+
        return _backend->port_name_size ();
 }
 
@@ -585,7 +639,7 @@ PortManager::my_name() const
        if (!_backend) {
                return string();
        }
-       
+
        return _backend->my_name();
 }
 
@@ -629,9 +683,21 @@ PortManager::cycle_end (pframes_t nframes)
 }
 
 void
-PortManager::silence (pframes_t nframes)
+PortManager::silence (pframes_t nframes, Session *s)
 {
        for (Ports::iterator i = _cycle_ports->begin(); i != _cycle_ports->end(); ++i) {
+               if (s && i->second == s->mtc_output_port ()) {
+                       continue;
+               }
+               if (s && i->second == s->midi_clock_output_port ()) {
+                       continue;
+               }
+               if (s && i->second == s->ltc_output_port ()) {
+                       continue;
+               }
+               if (boost::dynamic_pointer_cast<AsyncMIDIPort>(i->second)) {
+                       continue;
+               }
                if (i->second->sends_output()) {
                        i->second->get_buffer(nframes).silence(nframes);
                }
@@ -681,9 +747,9 @@ void
 PortManager::check_monitoring ()
 {
        for (Ports::iterator i = _cycle_ports->begin(); i != _cycle_ports->end(); ++i) {
-               
+
                bool x;
-               
+
                if (i->second->last_monitor() != (x = i->second->monitoring_input ())) {
                        i->second->set_last_monitor (x);
                        /* XXX I think this is dangerous, due to
@@ -698,14 +764,14 @@ void
 PortManager::fade_out (gain_t base_gain, gain_t gain_step, pframes_t nframes)
 {
        for (Ports::iterator i = _cycle_ports->begin(); i != _cycle_ports->end(); ++i) {
-               
+
                if (i->second->sends_output()) {
-                       
+
                        boost::shared_ptr<AudioPort> ap = boost::dynamic_pointer_cast<AudioPort> (i->second);
                        if (ap) {
                                Sample* s = ap->engine_get_whole_audio_buffer ();
                                gain_t g = base_gain;
-                               
+
                                for (pframes_t n = 0; n < nframes; ++n) {
                                        *s++ *= g;
                                        g -= gain_step;
@@ -721,3 +787,36 @@ PortManager::port_engine()
        assert (_backend);
        return *_backend;
 }
+
+bool
+PortManager::port_is_control_only (std::string const& name)
+{
+       static regex_t compiled_pattern;
+       static string pattern;
+
+       if (pattern.empty()) {
+
+               /* This is a list of regular expressions that match ports
+                * related to physical MIDI devices that we do not want to
+                * expose as normal physical ports.
+                */
+
+               const char * const control_only_ports[] = {
+                       X_(".*Ableton Push.*"),
+                       X_(".*FaderPort .*"),
+               };
+
+               pattern = "(";
+               for (size_t n = 0; n < sizeof (control_only_ports)/sizeof (control_only_ports[0]); ++n) {
+                       if (n > 0) {
+                               pattern += '|';
+                       }
+                       pattern += control_only_ports[n];
+               }
+               pattern += ')';
+
+               regcomp (&compiled_pattern, pattern.c_str(), REG_EXTENDED|REG_NOSUB);
+       }
+
+       return regexec (&compiled_pattern, name.c_str(), 0, 0, 0) == 0;
+}