First part of consolidating ::roll(), ::no_roll()
[ardour.git] / libs / ardour / port_manager.cc
index f057b2ffa2decaca65d3dde81b2d9a5048d7a675..dfc1c6442107c4aefdf5c59356d0b92813f0a514 100644 (file)
 #include <regex.h>
 #endif
 
-#include "pbd/convert.h"
+#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 "pbd/i18n.h"
 
@@ -48,7 +52,9 @@ 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
@@ -56,6 +62,8 @@ 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;
        }
@@ -181,17 +189,55 @@ 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 ();
@@ -199,6 +245,7 @@ PortManager::get_physical_inputs (DataType type, std::vector<std::string>& s)
        }
 
        _backend->get_physical_inputs (type, s);
+       filter_midi_ports (s, include, exclude);
 }
 
 ChanCount
@@ -406,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);
                }
 
@@ -536,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 ()
 {
@@ -609,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 */
        }
 }
@@ -685,7 +749,7 @@ void
 PortManager::cycle_start (pframes_t nframes)
 {
        Port::set_global_port_buffer_offset (0);
-        Port::set_cycle_framecnt (nframes);
+        Port::set_cycle_samplecnt (nframes);
 
        _cycle_ports = ports.reader ();
 
@@ -832,6 +896,7 @@ PortManager::port_is_control_only (std::string const& name)
                const char * const control_only_ports[] = {
                        X_(".*Ableton Push.*"),
                        X_(".*FaderPort .*"),
+                       X_(".*FaderPort8 .*"),
                };
 
                pattern = "(";
@@ -848,3 +913,316 @@ PortManager::port_is_control_only (std::string const& name)
 
        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;
+}