libs/ardour/transport_master.cc

   1 /*
   2     Copyright (C) 2002 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18  */
  19
  20 #include <vector>
  21
  22 #include "pbd/boost_debug.h"
  23 #include "pbd/debug.h"
  24 #include "pbd/i18n.h"
  25
  26 #include "ardour/audioengine.h"
  27 #include "ardour/debug.h"
  28 #include "ardour/midi_port.h"
  29 #include "ardour/session.h"
  30 #include "ardour/transport_master.h"
  31 #include "ardour/transport_master_manager.h"
  32 #include "ardour/types_convert.h"
  33 #include "ardour/utils.h"
  34
  35
  36 namespace ARDOUR {
  37         namespace Properties {
  38                 PBD::PropertyDescriptor<bool> fr2997;
  39                 PBD::PropertyDescriptor<bool> sclock_synced;
  40                 PBD::PropertyDescriptor<bool> collect;
  41                 PBD::PropertyDescriptor<bool> connected;
  42                 PBD::PropertyDescriptor<TransportRequestType> allowed_transport_requests;
  43         }
  44 }
  45
  46 using namespace ARDOUR;
  47 using namespace PBD;
  48
  49 void
  50 TransportMaster::make_property_quarks ()
  51 {
  52         Properties::fr2997.property_id = g_quark_from_static_string (X_("fr2997"));
  53         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for fr2997 = %1\n", Properties::fr2997.property_id));
  54         Properties::sclock_synced.property_id = g_quark_from_static_string (X_("sclock_synced"));
  55         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for sclock_synced = %1\n", Properties::sclock_synced.property_id));
  56         Properties::collect.property_id = g_quark_from_static_string (X_("collect"));
  57         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for collect = %1\n", Properties::collect.property_id));
  58         Properties::connected.property_id = g_quark_from_static_string (X_("connected"));
  59         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for connected = %1\n", Properties::connected.property_id));
  60         Properties::allowed_transport_requests.property_id = g_quark_from_static_string (X_("allowed_transport_requests"));
  61         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for allowed_transport_requests = %1\n", Properties::allowed_transport_requests.property_id));
  62 }
  63
  64 const std::string TransportMaster::state_node_name = X_("TransportMaster");
  65
  66 TransportMaster::TransportMaster (SyncSource t, std::string const & name)
  67         : _type (t)
  68         , _name (Properties::name, name)
  69         , _session (0)
  70         , _current_delta (0)
  71         , _pending_collect (true)
  72         , _removeable (false)
  73         , _request_mask (Properties::allowed_transport_requests, TransportRequestType (0))
  74         , _locked (Properties::locked, false)
  75         , _sclock_synced (Properties::sclock_synced, false)
  76         , _collect (Properties::collect, true)
  77         , _connected (Properties::connected, false)
  78 {
  79         register_properties ();
  80
  81         ARDOUR::AudioEngine::instance()->PortConnectedOrDisconnected.connect_same_thread (port_connection, boost::bind (&TransportMaster::connection_handler, this, _1, _2, _3, _4, _5));
  82         ARDOUR::AudioEngine::instance()->Running.connect_same_thread (backend_connection, boost::bind (&TransportMaster::check_backend, this));
  83 }
  84
  85 TransportMaster::~TransportMaster()
  86 {
  87         DEBUG_TRACE (DEBUG::Destruction, string_compose ("destroying transport master \"%1\" along with port %2\n", name(), (_port ? _port->name() : std::string ("no port"))));
  88
  89         unregister_port ();
  90 }
  91
  92 bool
  93 TransportMaster::speed_and_position (double& speed, samplepos_t& pos, samplepos_t& lp, samplepos_t& when, samplepos_t now)
  94 {
  95         if (!_collect) {
  96                 return false;
  97         }
  98
  99         SafeTime last;
 100         current.safe_read (last);
 101
 102         if (last.timestamp == 0) {
 103                 return false;
 104         }
 105
 106         if (last.timestamp && now > last.timestamp && now - last.timestamp > (2.0 * update_interval())) {
 107                 /* no timecode for two cycles - conclude that it's stopped */
 108
 109                 if (!Config->get_transport_masters_just_roll_when_sync_lost()) {
 110                         speed = 0;
 111                         pos = last.position;
 112                         lp = last.position;
 113                         when = last.timestamp;
 114                         _current_delta = 0;
 115                         DEBUG_TRACE (DEBUG::Slave, string_compose ("%1 not seen since %2 vs %3 (%4) with seekahead = %5 reset pending, pos = %6\n", name(), last.timestamp, now, (now - last.timestamp), update_interval(), pos));
 116                         return false;
 117                 }
 118         }
 119
 120         lp = last.position;
 121         when = last.timestamp;
 122         speed = last.speed;
 123         pos   = last.position + (now - last.timestamp) * last.speed;
 124
 125         DEBUG_TRACE (DEBUG::Slave, string_compose ("%1: speed_and_position tme: %2 pos: %3 spd: %4\n", name(), last.timestamp, last.position, last.speed));
 126
 127         lp = last.position;
 128         when = last.timestamp;
 129         speed = last.speed;
 130
 131         /* provide a .1% deadzone to lock the speed */
 132         if (fabs (speed - 1.0) <= 0.001) {
 133                 speed = 1.0;
 134         }
 135
 136         pos = last.position + (now - last.timestamp) * speed;
 137
 138         DEBUG_TRACE (DEBUG::Slave, string_compose ("%1 sync spd: %2 pos: %3 | last-pos: %4 | elapsed: %5\n",
 139                                                    name(), speed, pos, last.position, (now - last.timestamp)));
 140
 141         return true;
 142 }
 143
 144 void
 145 TransportMaster::register_properties ()
 146 {
 147         _xml_node_name = state_node_name;
 148
 149         add_property (_name);
 150         add_property (_locked);
 151         add_property (_collect);
 152         add_property (_sclock_synced);
 153         add_property (_request_mask);
 154
 155         /* we omit _connected since it is derived from port state, and merely
 156          * used for signalling
 157          */
 158 }
 159
 160 void
 161 TransportMaster::set_name (std::string const & str)
 162 {
 163         if (_name != str) {
 164                 _name = str;
 165                 PropertyChanged (Properties::name);
 166         }
 167 }
 168
 169 bool
 170 TransportMaster::connection_handler (boost::weak_ptr<ARDOUR::Port>, std::string name1, boost::weak_ptr<ARDOUR::Port>, std::string name2, bool yn)
 171 {
 172         if (!_port) {
 173                 return false;
 174         }
 175
 176         const std::string fqn = ARDOUR::AudioEngine::instance()->make_port_name_non_relative (_port->name());
 177
 178         if (fqn == name1 || fqn == name2) {
 179
 180                 /* it's about us */
 181
 182                 /* XXX technically .. if the user makes an N->1 connection to
 183                  * this transport master's port, this simple minded logic is
 184                  * not sufficient. But the user shouldn't do that ...
 185                  */
 186
 187                 if (yn) {
 188                         _connected = true;
 189                 } else {
 190                         _connected = false;
 191                 }
 192
 193                 PropertyChanged (Properties::connected);
 194
 195                 return true;
 196         }
 197
 198         return false;
 199 }
 200
 201 bool
 202 TransportMaster::check_collect()
 203 {
 204         if (!_connected) {
 205                 return false;
 206         }
 207
 208         /* XXX should probably use boost::atomic something or other here */
 209
 210         if (_pending_collect != _collect) {
 211                 if (_pending_collect) {
 212                         init ();
 213                 } else {
 214                         if (TransportMasterManager::instance().current().get() == this) {
 215                                 if (_session) {
 216                                         _session->config.set_external_sync (false);
 217                                 }
 218                         }
 219                 }
 220                 _collect = _pending_collect;
 221                 PropertyChanged (Properties::collect);
 222         }
 223
 224         return _collect;
 225 }
 226
 227 void
 228 TransportMaster::set_collect (bool yn)
 229 {
 230         /* theoretical race condition */
 231
 232         if (_connected) {
 233                 _pending_collect = yn;
 234         } else {
 235                 if (_collect != yn) {
 236                         _pending_collect = _collect = yn;
 237                         PropertyChanged (Properties::collect);
 238                 }
 239         }
 240 }
 241
 242 void
 243 TransportMaster::set_sample_clock_synced (bool yn)
 244 {
 245         if (yn != _sclock_synced) {
 246                 _sclock_synced = yn;
 247                 PropertyChanged (Properties::sclock_synced);
 248         }
 249 }
 250
 251 void
 252 TransportMaster::set_session (Session* s)
 253 {
 254         _session = s;
 255 }
 256
 257 int
 258 TransportMaster::set_state (XMLNode const & node, int /* version */)
 259 {
 260         PropertyChange what_changed;
 261
 262         what_changed = set_values (node);
 263
 264         XMLNode* pnode = node.child (X_("Port"));
 265
 266         if (pnode) {
 267                 XMLNodeList const & children = pnode->children();
 268                 for (XMLNodeList::const_iterator ci = children.begin(); ci != children.end(); ++ci) {
 269
 270                         XMLProperty const *prop;
 271
 272                         if ((*ci)->name() == X_("Connection")) {
 273                                 if ((prop = (*ci)->property (X_("other"))) == 0) {
 274                                         continue;
 275                                 }
 276                                 _port->connect (prop->value());
 277                         }
 278                 }
 279         }
 280
 281         PropertyChanged (what_changed);
 282
 283         return 0;
 284 }
 285
 286 XMLNode&
 287 TransportMaster::get_state ()
 288 {
 289         XMLNode* node = new XMLNode (state_node_name);
 290         node->set_property (X_("type"), _type);
 291         node->set_property (X_("removeable"), _removeable);
 292
 293         add_properties (*node);
 294
 295         if (_port) {
 296                 std::vector<std::string> connections;
 297
 298                 XMLNode* pnode = new XMLNode (X_("Port"));
 299
 300                 if (_port->get_connections (connections)) {
 301
 302                         std::vector<std::string>::const_iterator ci;
 303                         std::sort (connections.begin(), connections.end());
 304
 305                         for (ci = connections.begin(); ci != connections.end(); ++ci) {
 306
 307                                 /* if its a connection to our own port,
 308                                    return only the port name, not the
 309                                    whole thing. this allows connections
 310                                    to be re-established even when our
 311                                    client name is different.
 312                                 */
 313
 314                                 XMLNode* cnode = new XMLNode (X_("Connection"));
 315
 316                                 cnode->set_property (X_("other"), AudioEngine::instance()->make_port_name_relative (*ci));
 317                                 pnode->add_child_nocopy (*cnode);
 318                         }
 319                 }
 320
 321                 node->add_child_nocopy (*pnode);
 322         }
 323
 324         return *node;
 325 }
 326
 327 boost::shared_ptr<TransportMaster>
 328 TransportMaster::factory (XMLNode const & node)
 329 {
 330         if (node.name() != TransportMaster::state_node_name) {
 331                 return boost::shared_ptr<TransportMaster>();
 332         }
 333
 334         SyncSource type;
 335         std::string name;
 336         bool removeable;
 337
 338         if (!node.get_property (X_("type"), type)) {
 339                 return boost::shared_ptr<TransportMaster>();
 340         }
 341
 342         if (!node.get_property (X_("name"), name)) {
 343                 return boost::shared_ptr<TransportMaster>();
 344         }
 345
 346         if (!node.get_property (X_("removeable"), removeable)) {
 347                 /* development versions of 6.0 didn't have this property for a
 348                    while. Any TM listed in XML at that time was non-removeable
 349                 */
 350                 removeable = false;
 351         }
 352
 353         DEBUG_TRACE (DEBUG::Slave, string_compose ("xml-construct %1 name %2 removeable %3\n", enum_2_string (type), name, removeable));
 354
 355         return factory (type, name, removeable);
 356 }
 357
 358 boost::shared_ptr<TransportMaster>
 359 TransportMaster::factory (SyncSource type, std::string const& name, bool removeable)
 360 {
 361         /* XXX need to count existing sources of a given type */
 362
 363         boost::shared_ptr<TransportMaster> tm;
 364
 365         DEBUG_TRACE (DEBUG::Slave, string_compose ("factory-construct %1 name %2 removeable %3\n", enum_2_string (type), name, removeable));
 366
 367         switch (type) {
 368         case MTC:
 369                 tm.reset (new MTC_TransportMaster (name));
 370                 break;
 371         case LTC:
 372                 tm.reset (new LTC_TransportMaster (name));
 373                 break;
 374         case MIDIClock:
 375                 tm.reset (new MIDIClock_TransportMaster (name));
 376                 break;
 377         case Engine:
 378                 tm.reset (new Engine_TransportMaster (*AudioEngine::instance()));
 379                 break;
 380         default:
 381                 break;
 382         }
 383
 384         if (tm) {
 385                 tm->set_removeable (removeable);
 386         }
 387
 388         return tm;
 389 }
 390
 391 /** @param sh Return a short version of the string */
 392 std::string
 393 TransportMaster::display_name (bool sh) const
 394 {
 395
 396         switch (_type) {
 397         case Engine:
 398                 /* no other backends offer sync for now ... deal with this if we
 399                  * ever have to.
 400                  */
 401                 return S_("SyncSource|JACK");
 402
 403         case MTC:
 404                 if (sh) {
 405                         if (name().length() <= 4) {
 406                                 return name();
 407                         }
 408                         return S_("SyncSource|MTC");
 409                 } else {
 410                         return name();
 411                 }
 412
 413         case MIDIClock:
 414                 if (sh) {
 415                         if (name().length() <= 4) {
 416                                 return name();
 417                         }
 418                         return S_("SyncSource|M-Clk");
 419                 } else {
 420                         return name();
 421                 }
 422
 423         case LTC:
 424                 if (sh) {
 425                         if (name().length() <= 4) {
 426                                 return name();
 427                         }
 428                         return S_("SyncSource|LTC");
 429                 } else {
 430                         return name();
 431                 }
 432         }
 433         /* GRRRR .... stupid, stupid gcc - you can't get here from there, all enum values are handled */
 434         return S_("SyncSource|JACK");
 435 }
 436
 437 void
 438 TransportMaster::unregister_port ()
 439 {
 440         if (_port) {
 441                 AudioEngine::instance()->unregister_port (_port);
 442                 _port.reset ();
 443         }
 444 }
 445
 446 boost::shared_ptr<Port>
 447 TransportMasterViaMIDI::create_midi_port (std::string const & port_name)
 448 {
 449         boost::shared_ptr<Port> p;
 450
 451         if ((p = AudioEngine::instance()->register_input_port (DataType::MIDI, port_name)) == 0) {
 452                 return boost::shared_ptr<Port> ();
 453         }
 454
 455         _midi_port = boost::dynamic_pointer_cast<MidiPort> (p);
 456
 457         return p;
 458 }
 459
 460 bool
 461 TransportMaster::allow_request (TransportRequestSource src, TransportRequestType type) const
 462 {
 463         return _request_mask & type;
 464 }
 465
 466 void
 467 TransportMaster::set_request_mask (TransportRequestType t)
 468 {
 469         if (_request_mask != t) {
 470                 _request_mask = t;
 471                 PropertyChanged (Properties::allowed_transport_requests);
 472         }
 473 }
 474
 475 TimecodeTransportMaster::TimecodeTransportMaster (std::string const & name, SyncSource type)
 476         : TransportMaster (type, name)
 477         , _fr2997 (Properties::fr2997, false)
 478 {
 479         register_properties ();
 480 }
 481
 482 void
 483 TimecodeTransportMaster::register_properties ()
 484 {
 485         TransportMaster::register_properties ();
 486         add_property (_fr2997);
 487 }
 488
 489 void
 490 TimecodeTransportMaster::set_fr2997 (bool yn)
 491 {
 492         if (yn != _fr2997) {
 493                 _fr2997 = yn;
 494                 PropertyChanged (Properties::fr2997);
 495         }
 496 }
 497