VKeybd: Set default MIDI port flags
[ardour.git] / libs / ardour / port_manager.cc
index ae0dd5d83878ed33397a9cdbf90b705ffd6a9169..d423ddbd741611634e8fc4c1d385af2f98d9d551 100644 (file)
@@ -1,21 +1,22 @@
 /*
-    Copyright (C) 2013 Paul Davis
-
-    This program is free software; you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation; either version 2 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-*/
+ * Copyright (C) 2013-2019 Paul Davis <paul@linuxaudiosystems.com>
+ * Copyright (C) 2015-2019 Robin Gareus <robin@gareus.org>
+ * Copyright (C) 2017-2018 Ben Loftis <ben@harrisonconsoles.com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
 
 #include <vector>
 
@@ -52,8 +53,6 @@ using namespace PBD;
 using std::string;
 using std::vector;
 
-#define MIDI_PORT_INFO_SEPARATOR_CHAR '!'
-
 PortManager::PortManager ()
        : ports (new Ports)
        , _port_remove_in_progress (false)
@@ -397,7 +396,7 @@ PortManager::register_port (DataType dtype, const string& portname, bool input,
 
        /* limit the possible flags that can be set */
 
-       flags = PortFlags (flags & (Hidden|Shadow|IsTerminal));
+       flags = PortFlags (flags & (Hidden|Shadow|IsTerminal|TransportMasterPort));
 
        try {
                if (dtype == DataType::AUDIO) {
@@ -421,12 +420,13 @@ PortManager::register_port (DataType dtype, const string& portname, bool input,
                        throw PortRegistrationFailure (string_compose ("unable to create port '%1': %2", portname, _("(unknown type)")));
                }
 
+               newport->set_buffer_size (AudioEngine::instance()->samples_per_cycle());
+
                RCUWriter<Ports> writer (ports);
                boost::shared_ptr<Ports> ps = writer.get_copy ();
                ps->insert (make_pair (make_port_name_relative (portname), newport));
 
                /* writer goes out of scope, forces update */
-
        }
 
        catch (PortRegistrationFailure& err) {
@@ -642,14 +642,12 @@ PortManager::reconnect_ports ()
 {
        boost::shared_ptr<Ports> p = ports.reader ();
 
-       if (!Profile->get_trx()) {
-               /* re-establish connections */
+       /* 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;
@@ -658,6 +656,8 @@ PortManager::reconnect_ports ()
 void
 PortManager::connect_callback (const string& a, const string& b, bool conn)
 {
+       DEBUG_TRACE (DEBUG::BackendCallbacks, string_compose (X_("connect callback %1 + %2 connected ? %3\n"), a, b, conn));
+
        boost::shared_ptr<Port> port_a;
        boost::shared_ptr<Port> port_b;
        Ports::iterator x;
@@ -697,6 +697,8 @@ PortManager::connect_callback (const string& a, const string& b, bool conn)
 void
 PortManager::registration_callback ()
 {
+       DEBUG_TRACE (DEBUG::BackendCallbacks, "port registration callback\n");
+
        if (!_port_remove_in_progress) {
 
                {
@@ -769,6 +771,8 @@ PortManager::my_name() const
 int
 PortManager::graph_order_callback ()
 {
+       DEBUG_TRACE (DEBUG::BackendCallbacks, "graph order callback\n");
+
        if (!_port_remove_in_progress) {
                GraphReordered(); /* EMIT SIGNAL */
        }
@@ -806,12 +810,16 @@ PortManager::cycle_start (pframes_t nframes, Session* s)
        if (s && s->rt_tasklist () && fabs (Port::speed_ratio ()) != 1.0) {
                RTTaskList::TaskList tl;
                for (Ports::iterator p = _cycle_ports->begin(); p != _cycle_ports->end(); ++p) {
-                       tl.push_back (boost::bind (&Port::cycle_start, p->second, nframes));
+                       if (!(p->second->flags() & TransportMasterPort)) {
+                               tl.push_back (boost::bind (&Port::cycle_start, p->second, nframes));
+                       }
                }
                s->rt_tasklist()->process (tl);
        } else {
                for (Ports::iterator p = _cycle_ports->begin(); p != _cycle_ports->end(); ++p) {
-                       p->second->cycle_start (nframes);
+                       if (!(p->second->flags() & TransportMasterPort)) {
+                               p->second->cycle_start (nframes);
+                       }
                }
        }
 }
@@ -820,20 +828,26 @@ void
 PortManager::cycle_end (pframes_t nframes, Session* s)
 {
        // see optimzation note in ::cycle_start()
-       if (s && s->rt_tasklist () && fabs (Port::speed_ratio ()) != 1.0) {
+       if (0 && s && s->rt_tasklist () && fabs (Port::speed_ratio ()) != 1.0) {
                RTTaskList::TaskList tl;
                for (Ports::iterator p = _cycle_ports->begin(); p != _cycle_ports->end(); ++p) {
-                       tl.push_back (boost::bind (&Port::cycle_end, p->second, nframes));
+                       if (!(p->second->flags() & TransportMasterPort)) {
+                               tl.push_back (boost::bind (&Port::cycle_end, p->second, nframes));
+                       }
                }
                s->rt_tasklist()->process (tl);
        } else {
                for (Ports::iterator p = _cycle_ports->begin(); p != _cycle_ports->end(); ++p) {
-                       p->second->cycle_end (nframes);
+                       if (!(p->second->flags() & TransportMasterPort)) {
+                               p->second->cycle_end (nframes);
+                       }
                }
        }
 
        for (Ports::iterator p = _cycle_ports->begin(); p != _cycle_ports->end(); ++p) {
-               p->second->flush_buffers (nframes);
+               /* AudioEngine::split_cycle flushes buffers until Port::port_offset.
+                * Now only flush remaining events (after Port::port_offset) */
+               p->second->flush_buffers (nframes - Port::port_offset ());
        }
 
        _cycle_ports.reset ();
@@ -923,15 +937,19 @@ void
 PortManager::cycle_end_fade_out (gain_t base_gain, gain_t gain_step, pframes_t nframes, Session* s)
 {
        // see optimzation note in ::cycle_start()
-       if (s && s->rt_tasklist () && fabs (Port::speed_ratio ()) != 1.0) {
+       if (0 && s && s->rt_tasklist () && fabs (Port::speed_ratio ()) != 1.0) {
                RTTaskList::TaskList tl;
                for (Ports::iterator p = _cycle_ports->begin(); p != _cycle_ports->end(); ++p) {
-                       tl.push_back (boost::bind (&Port::cycle_end, p->second, nframes));
+                       if (!(p->second->flags() & TransportMasterPort)) {
+                               tl.push_back (boost::bind (&Port::cycle_end, p->second, nframes));
+                       }
                }
                s->rt_tasklist()->process (tl);
        } else {
                for (Ports::iterator p = _cycle_ports->begin(); p != _cycle_ports->end(); ++p) {
-                       p->second->cycle_end (nframes);
+                       if (!(p->second->flags() & TransportMasterPort)) {
+                               p->second->cycle_end (nframes);
+                       }
                }
        }
 
@@ -1014,7 +1032,7 @@ PortManager::midi_port_information (std::string const & name)
                return x->second;
        }
 
-       return MidiPortInformation (string(), false, MidiPortFlags(0), false);
+       return MidiPortInformation ();
 }
 
 void
@@ -1046,7 +1064,6 @@ PortManager::get_midi_selection_ports (vector<string>& copy)
 void
 PortManager::set_port_pretty_name (string const & port, string const & pretty)
 {
-       bool emit = false;
        {
                Glib::Threads::Mutex::Lock lm (midi_port_info_mutex);
 
@@ -1057,7 +1074,6 @@ PortManager::set_port_pretty_name (string const & port, string const & pretty)
                        return;
                }
                x->second.pretty_name = pretty;
-               emit = true;
        }
 
        /* push into back end */
@@ -1068,9 +1084,8 @@ PortManager::set_port_pretty_name (string const & port, string const & pretty)
                _backend->set_port_property (ph, "http://jackaudio.org/metadata/pretty-name", pretty, string());
        }
 
-       if (emit) {
-               MidiPortInfoChanged (); /* EMIT SIGNAL*/
-       }
+       save_midi_port_info ();
+       MidiPortInfoChanged (); /* EMIT SIGNAL*/
 }
 
 void
@@ -1084,6 +1099,7 @@ PortManager::add_midi_port_flags (string const & port, MidiPortFlags flags)
                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);
@@ -1116,6 +1132,7 @@ PortManager::remove_midi_port_flags (string const & port, MidiPortFlags flags)
                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);
@@ -1161,7 +1178,8 @@ PortManager::save_midi_port_info ()
                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_("canonical-name"), i->second.canonical_name);
+                       node->set_property (X_("backend"), i->second.backend);
+                       node->set_property (X_("pretty-name"), i->second.pretty_name);
                        node->set_property (X_("input"), i->second.input);
                        node->set_property (X_("properties"), i->second.properties);
                        root->add_child_nocopy (*node);
@@ -1196,19 +1214,23 @@ PortManager::load_midi_port_info ()
 
        for (XMLNodeConstIterator i = tree.root()->children().begin(); i != tree.root()->children().end(); ++i) {
                string name;
-               string canonical;
+               string backend;
+               string pretty;
                bool  input;
                MidiPortFlags properties;
 
 
                if (!(*i)->get_property (X_("name"), name) ||
-                   !(*i)->get_property (X_("canonical-name"), canonical) ||
+                   !(*i)->get_property (X_("backend"), backend) ||
+                   !(*i)->get_property (X_("pretty-name"), pretty) ||
                    !(*i)->get_property (X_("input"), input) ||
                    !(*i)->get_property (X_("properties"), properties)) {
+                       /* should only affect version changes */
+                       error << string_compose (_("MIDI port info file %1 contains invalid information - please remove it."), path) << endmsg;
                        continue;
                }
 
-               MidiPortInformation mpi (canonical, input, properties, false);
+               MidiPortInformation mpi (backend, pretty, input, properties, false);
 
                midi_port_info.insert (make_pair (name, mpi));
        }
@@ -1221,8 +1243,16 @@ PortManager::fill_midi_port_info ()
                Glib::Threads::Mutex::Lock lm (midi_port_info_mutex);
                fill_midi_port_info_locked ();
        }
+}
 
-       save_midi_port_info ();
+string
+PortManager::short_port_name_from_port_name (std::string const & full_name) const
+{
+       string::size_type colon = full_name.find_first_of (':');
+       if (colon == string::npos || colon == full_name.length()) {
+               return full_name;
+       }
+       return full_name.substr (colon+1);
 }
 
 void
@@ -1240,7 +1270,8 @@ PortManager::fill_midi_port_info_locked ()
 
        for (vector<string>::iterator p = ports.begin(); p != ports.end(); ++p) {
 
-               if (port_is_mine (*p)) {
+               /* ugly hack, ideally we'd use a port-flag, or at vkbd_output_port()->name() */
+               if (port_is_mine (*p) && *p != _backend->my_name() + ":" + _("Virtual Keyboard")) {
                        continue;
                }
 
@@ -1250,12 +1281,11 @@ PortManager::fill_midi_port_info_locked ()
 
                        if (port_is_control_only (*p)) {
                                flags = MidiPortControl;
+                       } else if (*p == _backend->my_name() + ":" + _("Virtual Keyboard")) {
+                               flags = MidiPortFlags(MidiPortSelection | MidiPortMusic);
                        }
 
-                       MidiPortInformation mpi (string_compose ("%1%4%2%4%3", _backend->name(), _backend->device_name(), *p, MIDI_PORT_INFO_SEPARATOR_CHAR),
-                                                true,
-                                                flags,
-                                                true);
+                       MidiPortInformation mpi (_backend->name(), *p, true, flags, true);
 
 #ifdef LINUX
                        if ((*p.find (X_("Midi Through")) != string::npos || (*p).find (X_("Midi-Through")) != string::npos)) {
@@ -1282,10 +1312,7 @@ PortManager::fill_midi_port_info_locked ()
                                flags = MidiPortControl;
                        }
 
-                       MidiPortInformation mpi (string_compose ("%1%4%2%4%3", _backend->name(), _backend->device_name(), *p, MIDI_PORT_INFO_SEPARATOR_CHAR),
-                                                false,
-                                                flags,
-                                                true);
+                       MidiPortInformation mpi (_backend->name(), *p, false, flags, true);
 
 #ifdef LINUX
                        if ((*p.find (X_("Midi Through")) != string::npos || (*p).find (X_("Midi-Through")) != string::npos)) {
@@ -1302,22 +1329,17 @@ PortManager::fill_midi_port_info_locked ()
 
        for (MidiPortInfo::iterator x = midi_port_info.begin(); x != midi_port_info.end(); ++x) {
 
-               vector<string> parts;
-
-               /*PBD::*/split (x->second.canonical_name, parts, MIDI_PORT_INFO_SEPARATOR_CHAR);
-               assert (parts.size() == 3);
-
-               if (parts[0] != _backend->name()) {
-                       x->second.exists = false;
-                       continue;
-               }
-
-               if (parts[1] != _backend->device_name()) {
+               if (x->second.backend != _backend->name()) {
+                       /* this port (info) comes from a different
+                        * backend. While there's a reasonable chance that it
+                        * refers to the same physical (or virtual) endpoint, we
+                        * don't allow its use with this backend.
+                       */
                        x->second.exists = false;
                        continue;
                }
 
-               PortEngine::PortHandle ph = _backend->get_port_by_name (parts[2]);
+               PortEngine::PortHandle ph = _backend->get_port_by_name (x->first);
 
                if (!ph) {
                        /* port info saved from some condition where this port
@@ -1328,19 +1350,27 @@ PortManager::fill_midi_port_info_locked ()
 
                } else {
                        x->second.exists = true;
-                       /* check with backend for pre-existing pretty name */
 
-                       string value;
+                       /* check with backend for pre-existing pretty name */
 
-                       value = AudioEngine::instance()->get_pretty_name_by_name (x->first);
+                       string value = AudioEngine::instance()->get_pretty_name_by_name (x->first);
 
                        if (!value.empty()) {
                                x->second.pretty_name = value;
-                       } else {
-                               x->second.pretty_name = parts[2];
                        }
                }
        }
 
        midi_info_dirty = false;
 }
+
+void
+PortManager::set_port_buffer_sizes (pframes_t n)
+{
+
+       boost::shared_ptr<Ports> all = ports.reader();
+
+       for (Ports::iterator p = all->begin(); p != all->end(); ++p) {
+               p->second->set_buffer_size (n);
+       }
+}