debug instrumentation for locate time
[ardour.git] / libs / ardour / port_manager.cc
index e4c066944f4b139d20da98d5cb83d9409dd52be5..9529093edf29ed6925a5e1a2434347702f9b42f2 100644 (file)
 
 */
 
-#include "pbd/convert.h"
+#ifdef COMPILER_MSVC
+#include <io.h> // Microsoft's nearest equivalent to <unistd.h>
+#include <ardourext/misc.h>
+#else
+#include <regex.h>
+#endif
+
+#include <glibmm/fileutils.h>
+#include <glibmm/miscutils.h>
+
 #include "pbd/error.h"
 
 #include "ardour/async_midi_port.h"
 #include "ardour/audio_backend.h"
 #include "ardour/audio_port.h"
 #include "ardour/debug.h"
+#include "ardour/filesystem_paths.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 "ardour/types_convert.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace ARDOUR;
 using namespace PBD;
@@ -39,7 +51,22 @@ using std::vector;
 PortManager::PortManager ()
        : ports (new Ports)
        , _port_remove_in_progress (false)
+       , _port_deletions_pending (8192) /* ick, arbitrary sizing */
+       , midi_info_dirty (true)
 {
+       load_midi_port_info ();
+}
+
+void
+PortManager::clear_pending_port_deletions ()
+{
+       Port* p;
+
+       DEBUG_TRACE (DEBUG::Ports, string_compose ("pending port deletions: %1\n", _port_deletions_pending.read_space()));
+
+       while (_port_deletions_pending.read (&p, 1) == 1) {
+               delete p;
+       }
 }
 
 void
@@ -64,6 +91,13 @@ PortManager::remove_all_ports ()
 
        ports.flush ();
 
+       /* clear out pending port deletion list. we know this is safe because
+        * the auto connect thread in Session is already dead when this is
+        * done. It doesn't use shared_ptr<Port> anyway.
+        */
+
+       _port_deletions_pending.reset ();
+
        _port_remove_in_progress = false;
 }
 
@@ -75,20 +109,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;
@@ -161,22 +189,63 @@ PortManager::port_is_physical (const std::string& portname) const
 }
 
 void
-PortManager::get_physical_outputs (DataType type, std::vector<std::string>& s)
+PortManager::filter_midi_ports (vector<string>& ports, MidiPortFlags include, MidiPortFlags exclude)
+{
+       if (!include && !exclude) {
+               return;
+       }
+
+       for (vector<string>::iterator si = ports.begin(); si != ports.end(); ) {
+
+               PortManager::MidiPortInformation mpi = midi_port_information (*si);
+
+               if (mpi.pretty_name.empty()) {
+                       /* no information !!! */
+                       ++si;
+                       continue;
+               }
+
+               if (include) {
+                       if ((mpi.properties & include) != include) {
+                               /* properties do not include requested ones */
+                               si = ports.erase (si);
+                               continue;
+                       }
+               }
+
+               if (exclude) {
+                       if ((mpi.properties & exclude)) {
+                               /* properties include ones to avoid */
+                               si = ports.erase (si);
+                               continue;
+                       }
+               }
+
+               ++si;
+       }
+}
+
+void
+PortManager::get_physical_outputs (DataType type, std::vector<std::string>& s, MidiPortFlags include, MidiPortFlags exclude)
 {
        if (!_backend) {
+               s.clear ();
                return;
        }
        _backend->get_physical_outputs (type, s);
+       filter_midi_ports (s, include, exclude);
 }
 
 void
-PortManager::get_physical_inputs (DataType type, std::vector<std::string>& s)
+PortManager::get_physical_inputs (DataType type, std::vector<std::string>& s, MidiPortFlags include, MidiPortFlags exclude)
 {
        if (!_backend) {
+               s.clear ();
                return;
        }
 
        _backend->get_physical_inputs (type, s);
+       filter_midi_ports (s, include, exclude);
 }
 
 ChanCount
@@ -198,28 +267,6 @@ PortManager::n_physical_inputs () const
        return _backend->n_physical_inputs ();
 }
 
-bool
-PortManager::port_name_prefix_is_unique (const string& first_part_of_port_name) const
-{
-       if (!_backend) {
-               return boost::shared_ptr<Port>();
-       }
-
-       boost::shared_ptr<const Ports> pr = ports.reader();
-       const string::size_type len = first_part_of_port_name.length();
-
-       for (Ports::const_iterator x = pr->begin(); x != pr->end(); ++x) {
-
-               string prefix = x->first.substr (0, len);
-
-               if (strings_equal_ignore_case (prefix, first_part_of_port_name)) {
-                       return false;
-               }
-       }
-
-       return true;
-}
-
 /** @param name Full or short name of port
  *  @return Corresponding Port or 0.
  */
@@ -318,25 +365,39 @@ PortManager::port_registration_failure (const std::string& portname)
        throw PortRegistrationFailure (string_compose (_("AudioEngine: cannot register port \"%1\": %2"), portname, reason).c_str());
 }
 
+struct PortDeleter
+{
+       void operator() (Port* p) {
+               AudioEngine::instance()->add_pending_port_deletion (p);
+       }
+};
+
 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)),
+                                      PortDeleter());
                } 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)),
+                                              PortDeleter());
                        } 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)),
+                                              PortDeleter());
                        }
                } else {
                        throw PortRegistrationFailure("unable to create port (unknown type)");
@@ -364,20 +425,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 */
 
        {
@@ -386,6 +453,7 @@ PortManager::unregister_port (boost::shared_ptr<Port> port)
                Ports::iterator x = ps->find (make_port_name_relative (port->name()));
 
                if (x != ps->end()) {
+                       DEBUG_TRACE (DEBUG::Ports, string_compose ("removing %1 from port map (uc=%2)\n", port->name(), port.use_count()));
                        ps->erase (x);
                }
 
@@ -413,6 +481,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)
 {
@@ -482,6 +584,16 @@ PortManager::disconnect (boost::shared_ptr<Port> port)
        return port->disconnect_all ();
 }
 
+int
+PortManager::disconnect (std::string const & name)
+{
+       PortEngine::PortHandle ph = _backend->get_port_by_name (name);
+       if (ph) {
+               return _backend->disconnect_all (ph);
+       }
+       return -2;
+}
+
 int
 PortManager::reestablish_ports ()
 {
@@ -555,6 +667,12 @@ void
 PortManager::registration_callback ()
 {
        if (!_port_remove_in_progress) {
+
+               {
+                       Glib::Threads::Mutex::Lock lm (midi_port_info_mutex);
+                       midi_info_dirty = true;
+               }
+
                PortRegisteredOrUnregistered (); /* EMIT SIGNAL */
        }
 }
@@ -657,9 +775,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);
                }
@@ -749,3 +879,350 @@ 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 .*"),
+                       X_(".*FaderPort8 .*"),
+               };
+
+               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;
+}
+
+PortManager::MidiPortInformation
+PortManager::midi_port_information (std::string const & name)
+{
+       Glib::Threads::Mutex::Lock lm (midi_port_info_mutex);
+
+       fill_midi_port_info_locked ();
+
+       MidiPortInfo::iterator x = midi_port_info.find (name);
+
+       if (x != midi_port_info.end()) {
+               return x->second;
+       }
+
+       return MidiPortInformation ();
+}
+
+void
+PortManager::get_known_midi_ports (vector<string>& copy)
+{
+       Glib::Threads::Mutex::Lock lm (midi_port_info_mutex);
+
+       fill_midi_port_info_locked ();
+
+       for (MidiPortInfo::const_iterator x = midi_port_info.begin(); x != midi_port_info.end(); ++x) {
+               copy.push_back (x->first);
+       }
+}
+
+void
+PortManager::get_midi_selection_ports (vector<string>& copy)
+{
+       Glib::Threads::Mutex::Lock lm (midi_port_info_mutex);
+
+       fill_midi_port_info_locked ();
+
+       for (MidiPortInfo::const_iterator x = midi_port_info.begin(); x != midi_port_info.end(); ++x) {
+               if (x->second.properties & MidiPortSelection) {
+                       copy.push_back (x->first);
+               }
+       }
+}
+
+void
+PortManager::set_midi_port_pretty_name (string const & port, string const & pretty)
+{
+       {
+               Glib::Threads::Mutex::Lock lm (midi_port_info_mutex);
+
+               fill_midi_port_info_locked ();
+
+               MidiPortInfo::iterator x = midi_port_info.find (port);
+               if (x == midi_port_info.end()) {
+                       return;
+               }
+               x->second.pretty_name = pretty;
+       }
+
+       /* push into back end */
+
+       PortEngine::PortHandle ph = _backend->get_port_by_name (port);
+
+       if (ph) {
+               _backend->set_port_property (ph, "http://jackaudio.org/metadata/pretty-name", pretty, string());
+       }
+
+       MidiPortInfoChanged (); /* EMIT SIGNAL*/
+}
+
+void
+PortManager::add_midi_port_flags (string const & port, MidiPortFlags flags)
+{
+       bool emit = false;
+
+       {
+               Glib::Threads::Mutex::Lock lm (midi_port_info_mutex);
+
+               fill_midi_port_info_locked ();
+
+               MidiPortInfo::iterator x = midi_port_info.find (port);
+               if (x != midi_port_info.end()) {
+                       if ((x->second.properties & flags) != flags) { // at least one missing
+                               x->second.properties = MidiPortFlags (x->second.properties | flags);
+                               emit = true;
+                       }
+               }
+       }
+
+       if (emit) {
+               if (flags & MidiPortSelection) {
+                       MidiSelectionPortsChanged (); /* EMIT SIGNAL */
+               }
+
+               if (flags != MidiPortSelection) {
+                       MidiPortInfoChanged (); /* EMIT SIGNAL */
+               }
+
+               save_midi_port_info ();
+       }
+}
+
+void
+PortManager::remove_midi_port_flags (string const & port, MidiPortFlags flags)
+{
+       bool emit = false;
+
+       {
+               Glib::Threads::Mutex::Lock lm (midi_port_info_mutex);
+
+               fill_midi_port_info_locked ();
+
+               MidiPortInfo::iterator x = midi_port_info.find (port);
+               if (x != midi_port_info.end()) {
+                       if (x->second.properties & flags) { // at least one is set
+                               x->second.properties = MidiPortFlags (x->second.properties & ~flags);
+                               emit = true;
+                       }
+               }
+       }
+
+       if (emit) {
+               if (flags & MidiPortSelection) {
+                       MidiSelectionPortsChanged (); /* EMIT SIGNAL */
+               }
+
+               if (flags != MidiPortSelection) {
+                       MidiPortInfoChanged (); /* EMIT SIGNAL */
+               }
+
+               save_midi_port_info ();
+       }
+}
+
+string
+PortManager::midi_port_info_file ()
+{
+       return Glib::build_filename (user_config_directory(), X_("midi_port_info"));
+}
+
+void
+PortManager::save_midi_port_info ()
+{
+       string path = midi_port_info_file ();
+
+       XMLNode* root = new XMLNode (X_("MidiPortInfo"));
+
+       {
+               Glib::Threads::Mutex::Lock lm (midi_port_info_mutex);
+
+               if (midi_port_info.empty()) {
+                       delete root;
+                       return;
+               }
+
+               for (MidiPortInfo::iterator i = midi_port_info.begin(); i != midi_port_info.end(); ++i) {
+                       XMLNode* node = new XMLNode (X_("port"));
+                       node->set_property (X_("name"), i->first);
+                       node->set_property (X_("input"), i->second.input);
+                       node->set_property (X_("properties"), i->second.properties);
+                       root->add_child_nocopy (*node);
+               }
+       }
+
+       XMLTree tree;
+
+       tree.set_root (root);
+
+       if (!tree.write (path)) {
+               error << string_compose (_("Could not save MIDI port info to %1"), path) << endmsg;
+       }
+}
+
+void
+PortManager::load_midi_port_info ()
+{
+       string path = midi_port_info_file ();
+       XMLTree tree;
+
+       if (!Glib::file_test (path, Glib::FILE_TEST_EXISTS)) {
+               return;
+       }
+
+       if (!tree.read (path)) {
+               error << string_compose (_("Cannot load MIDI port info from %1"), path) << endmsg;
+               return;
+       }
+
+       midi_port_info.clear ();
+
+       for (XMLNodeConstIterator i = tree.root()->children().begin(); i != tree.root()->children().end(); ++i) {
+               MidiPortInformation mpi;
+               string name;
+
+               if (!(*i)->get_property (X_("name"), name) ||
+                   !(*i)->get_property (X_("input"), mpi.input) ||
+                   !(*i)->get_property (X_("properties"), mpi.properties)) {
+                       continue;
+               }
+
+               midi_port_info.insert (make_pair (name, mpi));
+       }
+}
+
+void
+PortManager::fill_midi_port_info ()
+{
+       Glib::Threads::Mutex::Lock lm (midi_port_info_mutex);
+       fill_midi_port_info_locked ();
+}
+
+void
+PortManager::fill_midi_port_info_locked ()
+{
+       /* MIDI info mutex MUST be held */
+
+       if (!midi_info_dirty) {
+               return;
+       }
+
+       std::vector<string> ports;
+
+       AudioEngine::instance()->get_ports (string(), DataType::MIDI, IsOutput, ports);
+
+       for (vector<string>::iterator p = ports.begin(); p != ports.end(); ++p) {
+
+               if (port_is_mine (*p)) {
+                       continue;
+               }
+
+               if (midi_port_info.find (*p) == midi_port_info.end()) {
+                       MidiPortInformation mpi;
+                       mpi.pretty_name = *p;
+                       mpi.input = true;
+
+                       if (port_is_control_only (*p)) {
+                               mpi.properties = MidiPortFlags (mpi.properties | MidiPortControl);
+                       }
+#ifdef LINUX
+                       if ((*p.find (X_("Midi Through")) != string::npos ||
+                            (*p).find (X_("Midi-Through")) != string::npos))
+                       {
+                               mpi.properties = MidiPortFlags (mpi.properties | MidiPortVirtual);
+                       }
+#endif
+                       midi_port_info.insert (make_pair (*p, mpi));
+               }
+       }
+
+       AudioEngine::instance()->get_ports (string(), DataType::MIDI, IsInput, ports);
+
+       for (vector<string>::iterator p = ports.begin(); p != ports.end(); ++p) {
+
+               if (port_is_mine (*p)) {
+                       continue;
+               }
+
+               if (midi_port_info.find (*p) == midi_port_info.end()) {
+                       MidiPortInformation mpi;
+                       mpi.pretty_name = *p;
+                       mpi.input = false;
+
+                       if (port_is_control_only (*p)) {
+                               mpi.properties = MidiPortFlags (mpi.properties | MidiPortControl);
+                       }
+#ifdef LINUX
+                       if ((*p.find (X_("Midi Through")) != string::npos ||
+                            (*p).find (X_("Midi-Through")) != string::npos))
+                       {
+                               mpi.properties = MidiPortFlags (mpi.properties | MidiPortVirtual);
+                       }
+#endif
+                       midi_port_info.insert (make_pair (*p, mpi));
+               }
+       }
+
+       /* now push/pull pretty name information between backend and the
+        * PortManager
+        */
+
+       // rg: I don't understand what this attempts to solve
+       //
+       // Naming ports should be left to the backend:
+       // Ardour cannot associate numeric IDs with corresponding hardware.
+       // (see also 7dde6c3b)
+
+       for (MidiPortInfo::iterator x = midi_port_info.begin(); x != midi_port_info.end(); ++x) {
+               PortEngine::PortHandle ph = _backend->get_port_by_name (x->first);
+
+               if (!ph) {
+                       /* port info saved from some condition where this port
+                        * existed, but no longer does (i.e. device unplugged
+                        * at present)
+                        */
+                       continue;
+               }
+
+               if (!x->second.pretty_name.empty () && x->second.pretty_name != x->first) {
+                       /* name set in port info ... propagate */
+                       _backend->set_port_property (ph, "http://jackaudio.org/metadata/pretty-name", x->second.pretty_name, string());
+               } else {
+                       /* check with backend for pre-existing pretty name */
+                       string value;
+                       string type;
+                       if (0 == _backend->get_port_property (ph,
+                                                             "http://jackaudio.org/metadata/pretty-name",
+                                                             value, type)) {
+                               x->second.pretty_name = value;
+                       }
+               }
+       }
+
+       midi_info_dirty = false;
+}