OSC: Add /jog/mode/name
[ardour.git] / libs / surfaces / osc / osc.cc
index e5bcb4ed0a804f5a48b125dd0b070c3dfefbf47d..282873053e46808025f6ee7432af6af11f0675f9 100644 (file)
@@ -100,6 +100,7 @@ OSC::OSC (Session& s, uint32_t port)
        , default_gainmode (0)
        , tick (true)
        , bank_dirty (false)
+       , scrub_speed (0)
        , gui (0)
 {
        _instance = this;
@@ -421,6 +422,9 @@ OSC::register_callbacks()
                REGISTER_CALLBACK (serv, "/goto_start", "f", goto_start);
                REGISTER_CALLBACK (serv, "/goto_end", "", goto_end);
                REGISTER_CALLBACK (serv, "/goto_end", "f", goto_end);
+               REGISTER_CALLBACK (serv, "/scrub", "f", scrub);
+               REGISTER_CALLBACK (serv, "/jog", "f", jog);
+               REGISTER_CALLBACK (serv, "/jog/mode", "f", jog_mode);
                REGISTER_CALLBACK (serv, "/rewind", "", rewind);
                REGISTER_CALLBACK (serv, "/rewind", "f", rewind);
                REGISTER_CALLBACK (serv, "/ffwd", "", ffwd);
@@ -702,7 +706,7 @@ OSC::listen_to_route (boost::shared_ptr<Stripable> strip, lo_address addr)
 
        OSCSurface *s = get_surface(addr);
        uint32_t ssid = get_sid (strip, addr);
-       OSCRouteObserver* o = new OSCRouteObserver (strip, addr, ssid, s->gainmode, s->feedback);
+       OSCRouteObserver* o = new OSCRouteObserver (strip, addr, ssid, s);
        route_observers.push_back (o);
 
        strip->DropReferences.connect (*this, MISSING_INVALIDATOR, boost::bind (&OSC::route_lost, this, boost::weak_ptr<Stripable> (strip)), this);
@@ -1231,8 +1235,8 @@ OSC::routes_list (lo_message msg)
                                lo_message_add_int32 (reply, s->rec_enable_control()->get_value());
                        }
 
-                       //Automatically listen to routes listed
-                       listen_to_route(r, get_address (msg));
+                       //Automatically listen to stripables listed
+                       listen_to_route(s, get_address (msg));
 
                        lo_send_message (get_address (msg), "#reply", reply);
                        lo_message_free (reply);
@@ -1282,6 +1286,7 @@ OSC::refresh_surface (lo_message msg)
 {
        if (address_only) {
                // get rid of all surfaces and observers.
+               // needs change to only clear those for this address on all ports
                clear_devices();
        }
        OSCSurface *s = get_surface(get_address (msg));
@@ -1326,6 +1331,16 @@ OSC::clear_devices ()
                        delete so;
                }
        }
+       // delete cue observers
+       for (CueObservers::iterator x = cue_observers.begin(); x != cue_observers.end();) {
+               OSCCueObserver* co;
+               if ((co = dynamic_cast<OSCCueObserver*>(*x)) != 0) {
+                       delete co;
+               } else {
+                       ++x;
+               }
+       }
+
        // clear out surfaces
        _surface.clear();
 }
@@ -1583,7 +1598,7 @@ OSC::_set_bank (uint32_t bank_start, lo_address addr)
                // top bank is always filled if there are enough strips for at least one bank
                bank_start = (uint32_t)((s->nstrips - b_size) + 1);
        }
-       //save bank in case we have had to change it
+       //save bank after bank limit checks
        s->bank = bank_start;
 
        if (s->feedback[0] || s->feedback[1]) {
@@ -1601,8 +1616,7 @@ OSC::_set_bank (uint32_t bank_start, lo_address addr)
                }
        }
        // light bankup or bankdown buttons if it is possible to bank in that direction
-       if (s->feedback[4]) {
-               // these two messages could be bundled
+       if (s->feedback[4] && !s->no_clear) {
                lo_message reply;
                reply = lo_message_new ();
                if ((s->bank > (s->nstrips - s->bank_size)) || (s->nstrips < s->bank_size)) {
@@ -1739,6 +1753,176 @@ OSC::record_enabled (lo_message msg)
        lo_message_free (reply);
 }
 
+int
+OSC::scrub (float delta, lo_message msg)
+{
+       if (!session) return -1;
+
+       scrub_place = session->transport_frame ();
+
+       float speed;
+
+       int64_t now = ARDOUR::get_microseconds ();
+       int64_t diff = now - scrub_time;
+       if (diff > 35000) {
+               // speed 1 (or 0 if jog wheel supports touch)
+               speed = delta;
+       } else if ((diff > 20000) && (fabs(scrub_speed) == 1)) {
+               // add some hysteresis to stop excess speed jumps
+               speed = delta;
+       } else {
+               speed = (int)(delta * 2);
+       }
+       scrub_time = now;
+       if (scrub_speed == speed) {
+               // Already at that speed no change
+               return 0;
+       }
+       scrub_speed = speed;
+
+       if (speed > 0) {
+               if (speed == 1) {
+                       session->request_transport_speed (.5);
+               } else {
+                       session->request_transport_speed (1);
+               }
+       } else if (speed < 0) {
+               if (speed == -1) {
+                       session->request_transport_speed (-.5);
+               } else {
+                       session->request_transport_speed (-1);
+               }
+       } else {
+               session->request_transport_speed (0);
+       }
+
+       return 0;
+}
+
+int
+OSC::jog (float delta, lo_message msg)
+{
+       if (!session) return -1;
+
+       OSCSurface *s = get_surface(get_address (msg));
+
+       string path = "/jog/mode/name";
+       switch(s->jogmode)
+       {
+               case JOG  :
+                       text_message (path, "Jog", get_address (msg));
+                       if (delta) {
+                               jump_by_seconds (delta / 5);
+                       }
+                       break;
+               case SCRUB:
+                       text_message (path, "Scrub", get_address (msg));
+                       scrub (delta, msg);
+                       break;
+               case SHUTTLE:
+                       text_message (path, "Shuttle", get_address (msg));
+                       if (delta) {
+                               double speed = get_transport_speed ();
+                               set_transport_speed (speed + (delta / 8));
+                       } else {
+                               set_transport_speed (0);
+                       }
+                       break;
+               case SCROLL:
+                       text_message (path, "Scroll", get_address (msg));
+                       if (delta > 0) {
+                               access_action ("Editor/scroll-forward");
+                       } else if (delta < 0) {
+                               access_action ("Editor/scroll-backward");
+                       }
+                       break;
+               case TRACK:
+                       text_message (path, "Track", get_address (msg));
+                       if (delta > 0) {
+                               set_bank (s->bank + 1, msg);
+                       } else if (delta < 0) {
+                               set_bank (s->bank - 1, msg);
+                       }
+                       break;
+               case BANK:
+                       text_message (path, "Bank", get_address (msg));
+                       if (delta > 0) {
+                               bank_up (msg);
+                       } else if (delta < 0) {
+                               bank_down (msg);
+                       }
+                       break;
+               case NUDGE:
+                       text_message (path, "Nudge", get_address (msg));
+                       if (delta > 0) {
+                               access_action ("Common/nudge-playhead-forward");
+                       } else if (delta < 0) {
+                               access_action ("Common/nudge-playhead-backward");
+                       }
+                       break;
+               case MARKER:
+                       text_message (path, "Marker", get_address (msg));
+                       if (delta > 0) {
+                               next_marker ();
+                       } else if (delta < 0) {
+                               prev_marker ();
+                       }
+                       break;
+               default:
+                       break;
+
+       }
+       return 0;
+
+}
+
+int
+OSC::jog_mode (float mode, lo_message msg)
+{
+       if (!session) return -1;
+
+       OSCSurface *s = get_surface(get_address (msg));
+
+       switch((uint32_t)mode)
+       {
+               case JOG  :
+                       s->jogmode = JOG;
+                       break;
+               case SCRUB:
+                       s->jogmode = SCRUB;
+                       break;
+               case SHUTTLE:
+                       s->jogmode = SHUTTLE;
+                       break;
+               case SCROLL:
+                       s->jogmode = SCROLL;
+                       break;
+               case TRACK:
+                       s->jogmode = TRACK;
+                       break;
+               case BANK:
+                       s->jogmode = BANK;
+                       break;
+               case NUDGE:
+                       s->jogmode = NUDGE;
+                       break;
+               case MARKER:
+                       s->jogmode = MARKER;
+                       break;
+               default:
+                       PBD::warning << "Jog Mode: " << mode << " is not valid." << endmsg;
+                       break;
+       lo_message reply = lo_message_new ();
+       lo_message_add_int32 (reply, s->jogmode);
+       lo_send_message (get_address(msg), "/jog/mode", reply);
+       lo_message_free (reply);
+
+       }
+       jog (0, msg);
+       return 0;
+
+}
+
 // master and monitor calls
 int
 OSC::master_set_gain (float dB)
@@ -1924,7 +2108,8 @@ OSC::route_get_sends(lo_message msg) {
                        lo_message_add_int32(reply, p->active() ? 1 : 0);
                }
        }
-       // if used dedicated message path to identify this reply in async operation. Naming it #reply wont help the client to identify the content.
+       // if used dedicated message path to identify this reply in async operation.
+       // Naming it #reply wont help the client to identify the content.
        lo_send_message(get_address (msg), "/strip/sends", reply);
 
        lo_message_free(reply);
@@ -1986,7 +2171,8 @@ OSC::route_get_receives(lo_message msg) {
                }
        }
 
-       // I have used a dedicated message path to identify this reply in async operation. Naming it #reply wont help the client to identify the content.
+       // I have used a dedicated message path to identify this reply in async operation.
+       // Naming it #reply wont help the client to identify the content.
        lo_send_message(get_address (msg), "/strip/receives", reply);
        lo_message_free(reply);
        return 0;
@@ -3552,6 +3738,18 @@ OSC::periodic (void)
                }
        }
 
+       if (scrub_speed != 0) {
+               // for those jog wheels that don't have 0 on release (touch), time out.
+               int64_t now = ARDOUR::get_microseconds ();
+               int64_t diff = now - scrub_time;
+               if (diff > 120000) {
+                       scrub_speed = 0;
+                       session->request_transport_speed (0);
+                       // locate to the place PH was at last tick
+                       session->request_locate (scrub_place, false);
+               }
+       }
+
        for (GlobalObservers::iterator x = global_observers.begin(); x != global_observers.end(); x++) {
 
                OSCGlobalObserver* go;
@@ -3662,23 +3860,23 @@ XMLNode&
 OSC::get_state ()
 {
        XMLNode& node (ControlProtocol::get_state());
-       node.add_property("debugmode", (int) _debugmode); // TODO: enum2str
-       node.add_property ("address-only", address_only);
-       node.add_property ("remote-port", remote_port);
-       node.add_property ("banksize", default_banksize);
-       node.add_property ("striptypes", default_strip);
-       node.add_property ("feedback", default_feedback);
-       node.add_property ("gainmode", default_gainmode);
+       node.set_property ("debugmode", (int32_t) _debugmode); // TODO: enum2str
+       node.set_property ("address-only", address_only);
+       node.set_property ("remote-port", remote_port);
+       node.set_property ("banksize", default_banksize);
+       node.set_property ("striptypes", default_strip);
+       node.set_property ("feedback", default_feedback);
+       node.set_property ("gainmode", default_gainmode);
        if (_surface.size()) {
                XMLNode* config = new XMLNode (X_("Configurations"));
                for (uint32_t it = 0; it < _surface.size(); ++it) {
                        OSCSurface* sur = &_surface[it];
                        XMLNode* devnode = new XMLNode (X_("Configuration"));
-                       devnode->add_property (X_("url"), sur->remote_url);
-                       devnode->add_property (X_("bank-size"), sur->bank_size);
-                       devnode->add_property (X_("strip-types"), sur->strip_types.to_ulong());
-                       devnode->add_property (X_("feedback"), sur->feedback.to_ulong());
-                       devnode->add_property (X_("gainmode"), sur->gainmode);
+                       devnode->set_property (X_("url"), sur->remote_url);
+                       devnode->set_property (X_("bank-size"), sur->bank_size);
+                       devnode->set_property (X_("strip-types"), (uint64_t)sur->strip_types.to_ulong());
+                       devnode->set_property (X_("feedback"), (uint64_t)sur->feedback.to_ulong());
+                       devnode->set_property (X_("gainmode"), sur->gainmode);
                        config->add_child_nocopy (*devnode);
                }
                node.add_child_nocopy (*config);
@@ -3692,68 +3890,48 @@ OSC::set_state (const XMLNode& node, int version)
        if (ControlProtocol::set_state (node, version)) {
                return -1;
        }
-       XMLProperty const * p = node.property (X_("debugmode"));
-       if (p) {
-               _debugmode = OSCDebugMode (PBD::atoi(p->value ()));
-       }
-       p = node.property (X_("address-only"));
-       if (p) {
-               address_only = OSCDebugMode (PBD::atoi(p->value ()));
-       }
-       p = node.property (X_("remote-port"));
-       if (p) {
-               remote_port = p->value ();
-       }
-       p = node.property (X_("banksize"));
-       if (p) {
-               default_banksize = OSCDebugMode (PBD::atoi(p->value ()));
-       }
-       p = node.property (X_("striptypes"));
-       if (p) {
-               default_strip = OSCDebugMode (PBD::atoi(p->value ()));
-       }
-       p = node.property (X_("feedback"));
-       if (p) {
-               default_feedback = OSCDebugMode (PBD::atoi(p->value ()));
-       }
-       p = node.property (X_("gainmode"));
-       if (p) {
-               default_gainmode = OSCDebugMode (PBD::atoi(p->value ()));
+       int32_t debugmode;
+       if (node.get_property (X_("debugmode"), debugmode)) {
+               _debugmode = OSCDebugMode (debugmode);
        }
+
+       node.get_property (X_("address-only"), address_only);
+       node.get_property (X_("remote-port"), remote_port);
+       node.get_property (X_("banksize"), default_banksize);
+       node.get_property (X_("striptypes"), default_strip);
+       node.get_property (X_("feedback"), default_feedback);
+       node.get_property (X_("gainmode"), default_gainmode);
+
        XMLNode* cnode = node.child (X_("Configurations"));
 
        if (cnode) {
                XMLNodeList const& devices = cnode->children();
                for (XMLNodeList::const_iterator d = devices.begin(); d != devices.end(); ++d) {
-                       XMLProperty const * prop = (*d)->property (X_("url"));
-                       if (prop) {
-                               OSCSurface s;
-                               bank_dirty = true;
-                               s.remote_url = prop->value();
-                               prop = (*d)->property (X_("bank-size"));
-                               if (prop) {
-                                       s.bank_size = atoi (prop->value().c_str());
-                               }
-                               prop = (*d)->property (X_("strip-types"));
-                               if (prop) {
-                                       s.strip_types = atoi (prop->value().c_str());
-                               }
-                               prop = (*d)->property (X_("feedback"));
-                               if (prop) {
-                                       s.feedback = atoi (prop->value().c_str());
-                               }
-                               prop = (*d)->property (X_("gainmode"));
-                               if (prop) {
-                                       s.gainmode = atoi (prop->value().c_str());
-                               }
-                               s.bank = 1;
-                               s.sel_obs = 0;
-                               s.expand = 0;
-                               s.expand_enable = false;
-                               s.strips = get_sorted_stripables(s.strip_types, s.cue);
-                               s.nstrips = s.strips.size();
-                               _surface.push_back (s);
+                       OSCSurface s;
+                       if (!(*d)->get_property (X_("url"), s.remote_url)) {
+                               continue;
+                       }
+
+                       bank_dirty = true;
+
+                       (*d)->get_property (X_("bank-size"), s.bank_size);
+
+                       uint64_t bits;
+                       if ((*d)->get_property (X_ ("strip-types"), bits)) {
+                               s.strip_types = bits;
+                       }
+                       if ((*d)->get_property (X_("feedback"), bits)) {
+                               s.feedback = bits;
                        }
+                       (*d)->get_property (X_("gainmode"), s.gainmode);
+
+                       s.bank = 1;
+                       s.sel_obs = 0;
+                       s.expand = 0;
+                       s.expand_enable = false;
+                       s.strips = get_sorted_stripables (s.strip_types, s.cue);
+                       s.nstrips = s.strips.size ();
+                       _surface.push_back (s);
                }
        }
        global_init = true;