2 Copyright (C) 2018 Paul Davis
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.
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.
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.
19 #include <gtkmm/stock.h>
21 #include "pbd/enumwriter.h"
24 #include "temporal/time.h"
26 #include "ardour/audioengine.h"
27 #include "ardour/session.h"
28 #include "ardour/transport_master.h"
29 #include "ardour/transport_master_manager.h"
31 #include "widgets/tooltips.h"
33 #include "gtkmm2ext/utils.h"
34 #include "gtkmm2ext/gui_thread.h"
36 #include "ardour_ui.h"
37 #include "floating_text_entry.h"
38 #include "transport_masters_dialog.h"
43 using namespace Gtkmm2ext;
44 using namespace ARDOUR;
46 using namespace ArdourWidgets;
48 TransportMastersWidget::TransportMastersWidget ()
50 , add_button (_("Add a new Transport Master"))
52 pack_start (table, PACK_EXPAND_WIDGET, 12);
53 pack_start (add_button, FALSE, FALSE);
55 add_button.signal_clicked ().connect (sigc::mem_fun (*this, &TransportMastersWidget::add_master));
57 col_title[0].set_markup (string_compose ("<span weight=\"bold\">%1</span>", _("Use")));
58 col_title[1].set_markup (string_compose ("<span weight=\"bold\">%1</span>", _("Name")));
59 col_title[2].set_markup (string_compose ("<span weight=\"bold\">%1</span>", _("Type")));
60 col_title[3].set_markup (string_compose ("<span weight=\"bold\">%1</span>", _("Format/\nBPM")));
61 col_title[4].set_markup (string_compose ("<span weight=\"bold\">%1</span>", _("Current")));
62 col_title[5].set_markup (string_compose ("<span weight=\"bold\">%1</span>", _("Last")));
63 col_title[6].set_markup (string_compose ("<span weight=\"bold\">%1</span>", _("Timestamp")));
64 col_title[7].set_markup (string_compose ("<span weight=\"bold\">%1</span>", _("Delta")));
65 col_title[8].set_markup (string_compose ("<span weight=\"bold\">%1</span>", _("Collect")));
66 col_title[9].set_markup (string_compose ("<span weight=\"bold\">%1</span>", _("Data Source")));
67 col_title[10].set_markup (string_compose ("<span weight=\"bold\">%1</span>", _("Active\nCommands")));
68 col_title[11].set_markup (string_compose ("<span weight=\"bold\">%1</span>", _("Clock\nSynced")));
69 col_title[12].set_markup (string_compose ("<span weight=\"bold\">%1</span>", _("29.97/\n30")));
70 col_title[13].set_markup (string_compose ("<span weight=\"bold\">%1</span>", _("Remove")));
72 set_tooltip (col_title[12], _("<b>When enabled</b> the external timecode source is assumed to use 29.97 fps instead of 30000/1001.\n"
73 "SMPTE 12M-1999 specifies 29.97df as 30000/1001. The spec further mentions that "
74 "drop-sample timecode has an accumulated error of -86ms over a 24-hour period.\n"
75 "Drop-sample timecode would compensate exactly for a NTSC color frame rate of 30 * 0.9990 (ie 29.970000). "
76 "That is not the actual rate. However, some vendors use that rate - despite it being against the specs - "
77 "because the variant of using exactly 29.97 fps has zero timecode drift.\n"
80 set_tooltip (col_title[11], string_compose (_("<b>When enabled</b> the external timecode source is assumed to be sample-clock synced to the audio interface\n"
81 "being used by %1."), PROGRAM_NAME));
83 table.set_spacings (6);
85 TransportMasterManager::instance().CurrentChanged.connect (current_connection, invalidator (*this), boost::bind (&TransportMastersWidget::current_changed, this, _1, _2), gui_context());
86 TransportMasterManager::instance().Added.connect (add_connection, invalidator (*this), boost::bind (&TransportMastersWidget::rebuild, this), gui_context());
87 TransportMasterManager::instance().Removed.connect (remove_connection, invalidator (*this), boost::bind (&TransportMastersWidget::rebuild, this), gui_context());
92 TransportMastersWidget::~TransportMastersWidget ()
94 for (vector<Row*>::iterator r = rows.begin(); r != rows.end(); ++r) {
100 TransportMastersWidget::set_transport_master (boost::shared_ptr<TransportMaster> tm)
102 _session->request_sync_source (tm);
106 TransportMastersWidget::current_changed (boost::shared_ptr<TransportMaster> old_master, boost::shared_ptr<TransportMaster> new_master)
108 for (vector<Row*>::iterator r = rows.begin(); r != rows.end(); ++r) {
109 if ((*r)->tm == new_master) {
110 (*r)->use_button.set_active (true);
111 break; /* there can only be one */
117 TransportMastersWidget::add_master ()
119 AddTransportMasterDialog d;
124 while (name.empty()) {
129 case RESPONSE_ACCEPT:
139 if (TransportMasterManager::instance().add (d.get_type(), name)) {
140 MessageDialog msg (_("New transport master not added - check error log for details"));
146 TransportMastersWidget::rebuild ()
148 TransportMasterManager::TransportMasters const & masters (TransportMasterManager::instance().transport_masters());
150 container_clear (table);
152 for (vector<Row*>::iterator r = rows.begin(); r != rows.end(); ++r) {
157 table.resize (masters.size()+1, 14);
159 for (size_t col = 0; col < sizeof (col_title) / sizeof (col_title[0]); ++col) {
160 table.attach (col_title[col], col, col+1, 0, 1);
165 Gtk::RadioButtonGroup use_button_group;
167 for (TransportMasterManager::TransportMasters::const_iterator m = masters.begin(); m != masters.end(); ++m, ++n) {
169 Row* r = new Row (*this);
173 r->label.set_text ((*m)->name());
174 r->type.set_text (enum_2_string ((*m)->type()));
176 r->use_button.set_group (use_button_group);
178 if (TransportMasterManager::instance().current() == r->tm) {
179 r->use_button.set_active (true);
184 r->label_box.add (r->label);
186 table.attach (r->use_button, col, col+1, n, n+1); ++col;
187 table.attach (r->label_box, col, col+1, n, n+1); ++col;
188 table.attach (r->type, col, col+1, n, n+1); ++col;
189 table.attach (r->format, col, col+1, n, n+1); ++col;
190 table.attach (r->current, col, col+1, n, n+1); ++col;
191 table.attach (r->last, col, col+1, n, n+1); ++col;
192 table.attach (r->timestamp, col, col+1, n, n+1); ++col;
193 table.attach (r->delta, col, col+1, n, n+1); ++col;
194 table.attach (r->collect_button, col, col+1, n, n+1); ++col;
195 table.attach (r->port_combo, col, col+1, n, n+1); ++col;
196 table.attach (r->request_options, col, col+1, n, n+1); ++col;
198 boost::shared_ptr<TimecodeTransportMaster> ttm (boost::dynamic_pointer_cast<TimecodeTransportMaster> (r->tm));
201 table.attach (r->sclock_synced_button, col, col+1, n, n+1); ++col;
202 table.attach (r->fr2997_button, col, col+1, n, n+1); ++col;
203 r->fr2997_button.signal_toggled().connect (sigc::mem_fun (*r, &TransportMastersWidget::Row::fr2997_button_toggled));
208 if (r->tm->removeable()) {
209 table.attach (r->remove_button, col, col+1, n, n+1); ++col;
216 r->label_box.signal_button_press_event().connect (sigc::mem_fun (*r, &TransportMastersWidget::Row::name_press));
217 r->port_combo.signal_changed().connect (sigc::mem_fun (*r, &TransportMastersWidget::Row::port_choice_changed));
218 r->use_button.signal_toggled().connect (sigc::mem_fun (*r, &TransportMastersWidget::Row::use_button_toggled));
219 r->collect_button.signal_toggled().connect (sigc::mem_fun (*r, &TransportMastersWidget::Row::collect_button_toggled));
220 r->request_options.signal_button_press_event().connect (sigc::mem_fun (*r, &TransportMastersWidget::Row::request_option_press), false);
221 r->remove_button.signal_clicked().connect (sigc::mem_fun (*r, &TransportMastersWidget::Row::remove_clicked));
224 r->sclock_synced_button.signal_toggled().connect (sigc::mem_fun (*r, &TransportMastersWidget::Row::sync_button_toggled));
227 r->tm->PropertyChanged.connect (r->property_change_connection, invalidator (*this), boost::bind (&TransportMastersWidget::Row::prop_change, r, _1), gui_context());
229 PropertyChange all_change;
230 all_change.add (Properties::locked);
231 all_change.add (Properties::collect);
232 all_change.add (Properties::connected);
235 all_change.add (Properties::fr2997);
236 all_change.add (Properties::sclock_synced);
239 r->prop_change (all_change);
243 TransportMastersWidget::Row::Row (TransportMastersWidget& p)
245 , request_option_menu (0)
246 , remove_button (X_("x"))
249 , ignore_active_change (false)
254 TransportMastersWidget::Row::name_press (GdkEventButton* ev)
256 if (ev->type == GDK_2BUTTON_PRESS && ev->button == 1) {
257 Gtk::Window* toplevel = dynamic_cast<Gtk::Window*> (label.get_toplevel());
261 name_editor = new FloatingTextEntry (toplevel, tm->name());
262 name_editor->use_text.connect (sigc::mem_fun (*this, &TransportMastersWidget::Row::name_edited));
263 name_editor->show ();
270 TransportMastersWidget::idle_remove (TransportMastersWidget::Row* row)
272 TransportMasterManager::instance().remove (row->tm->name());
277 TransportMastersWidget::Row::remove_clicked ()
279 /* have to do this via an idle callback, because it will destroy the
280 widget from which this callback was initiated.
282 Glib::signal_idle().connect (sigc::bind (sigc::mem_fun (parent, &TransportMastersWidget::idle_remove), this));
286 TransportMastersWidget::Row::name_edited (string str, int ignored)
289 /* floating text entry deletes itself */
294 TransportMastersWidget::Row::prop_change (PropertyChange what_changed)
296 if (what_changed.contains (Properties::locked)) {
299 if (what_changed.contains (Properties::fr2997)) {
300 fr2997_button.set_active (boost::dynamic_pointer_cast<TimecodeTransportMaster> (tm)->fr2997());
303 if (what_changed.contains (Properties::sclock_synced)) {
304 sclock_synced_button.set_active (boost::dynamic_pointer_cast<TimecodeTransportMaster> (tm)->sample_clock_synced());
307 if (what_changed.contains (Properties::collect)) {
308 collect_button.set_active (tm->collect());
311 if (what_changed.contains (Properties::connected)) {
312 populate_port_combo ();
315 if (what_changed.contains (Properties::name)) {
316 label.set_text (tm->name());
321 TransportMastersWidget::Row::use_button_toggled ()
323 if (use_button.get_active()) {
324 parent.set_transport_master (tm);
329 TransportMastersWidget::Row::fr2997_button_toggled ()
331 boost::dynamic_pointer_cast<TimecodeTransportMaster>(tm)->set_fr2997 (fr2997_button.get_active());
335 TransportMastersWidget::Row::collect_button_toggled ()
337 tm->set_collect (collect_button.get_active());
341 TransportMastersWidget::Row::sync_button_toggled ()
343 tm->set_sample_clock_synced (sclock_synced_button.get_active());
347 TransportMastersWidget::Row::request_option_press (GdkEventButton* ev)
349 if (ev->button == 1) {
350 if (!request_option_menu) {
351 build_request_options ();
353 request_option_menu->popup (1, ev->time);
360 TransportMastersWidget::Row::build_request_options ()
362 using namespace Gtk::Menu_Helpers;
364 request_option_menu = manage (new Menu);
366 MenuList& items (request_option_menu->items());
368 items.push_back (CheckMenuElem (_("Accept speed-changing commands (start/stop)")));
369 Gtk::CheckMenuItem* i = dynamic_cast<Gtk::CheckMenuItem *> (&items.back ());
370 i->set_active (tm->request_mask() & TR_Speed);
371 items.push_back (CheckMenuElem (_("Accept locate commands")));
372 i = dynamic_cast<Gtk::CheckMenuItem *> (&items.back ());
373 i->set_active (tm->request_mask() & TR_Locate);
376 Glib::RefPtr<Gtk::ListStore>
377 TransportMastersWidget::Row::build_port_list (vector<string> const & ports)
379 Glib::RefPtr<Gtk::ListStore> store = ListStore::create (port_columns);
382 row = *store->append ();
383 row[port_columns.full_name] = string();
384 row[port_columns.short_name] = _("Disconnected");
386 for (vector<string>::const_iterator p = ports.begin(); p != ports.end(); ++p) {
388 if (AudioEngine::instance()->port_is_mine (*p)) {
392 row = *store->append ();
393 row[port_columns.full_name] = *p;
395 std::string pn = ARDOUR::AudioEngine::instance()->get_pretty_name_by_name (*p);
397 pn = (*p).substr ((*p).find (':') + 1);
399 row[port_columns.short_name] = pn;
406 TransportMastersWidget::Row::populate_port_combo ()
415 vector<string> inputs;
417 if (tm->port()->type() == DataType::MIDI) {
418 ARDOUR::AudioEngine::instance()->get_ports ("", ARDOUR::DataType::MIDI, ARDOUR::PortFlags (ARDOUR::IsOutput), inputs);
420 ARDOUR::AudioEngine::instance()->get_ports ("", ARDOUR::DataType::AUDIO, ARDOUR::PortFlags (ARDOUR::IsOutput), inputs);
423 Glib::RefPtr<Gtk::ListStore> input = build_port_list (inputs);
424 bool input_found = false;
427 port_combo.set_model (input);
429 Gtk::TreeModel::Children children = input->children();
430 Gtk::TreeModel::Children::iterator i;
431 i = children.begin();
432 ++i; /* skip "Disconnected" */
435 for (n = 1; i != children.end(); ++i, ++n) {
436 string port_name = (*i)[port_columns.full_name];
437 if (tm->port()->connected_to (port_name)) {
438 port_combo.set_active (n);
445 port_combo.set_active (0); /* disconnected */
450 TransportMastersWidget::Row::port_choice_changed ()
452 if (ignore_active_change) {
456 TreeModel::iterator active = port_combo.get_active ();
457 string new_port = (*active)[port_columns.full_name];
459 if (new_port.empty()) {
460 tm->port()->disconnect_all ();
464 if (!tm->port()->connected_to (new_port)) {
465 tm->port()->disconnect_all ();
466 tm->port()->connect (new_port);
471 TransportMastersWidget::Row::update (Session* s, samplepos_t now)
473 using namespace Timecode;
477 samplepos_t most_recent;
482 boost::shared_ptr<TimecodeTransportMaster> ttm;
483 boost::shared_ptr<MIDIClock_TransportMaster> mtm;
487 if (tm->speed_and_position (speed, pos, most_recent, when, now)) {
489 sample_to_timecode (pos, t, false, false, 25, false, AudioEngine::instance()->sample_rate(), 100, false, 0);
490 sample_to_timecode (most_recent, l, false, false, 25, false, AudioEngine::instance()->sample_rate(), 100, false, 0);
492 if ((ttm = boost::dynamic_pointer_cast<TimecodeTransportMaster> (tm))) {
493 format.set_text (timecode_format_name (ttm->apparent_timecode_format()));
494 last.set_text (Timecode::timecode_format_time (l));
495 } else if ((mtm = boost::dynamic_pointer_cast<MIDIClock_TransportMaster> (tm))) {
497 snprintf (buf, sizeof (buf), "%.1f", mtm->bpm());
498 format.set_text (buf);
501 format.set_text ("");
504 current.set_text (Timecode::timecode_format_time (t));
505 delta.set_markup (tm->delta_string ());
508 const float seconds = (when - now) / (float) AudioEngine::instance()->sample_rate();
509 if (abs (seconds) < 1.0) {
510 snprintf (gap, sizeof (gap), "%.3fs", seconds);
511 } else if (abs (seconds) < 4.0) {
512 snprintf (gap, sizeof (gap), "%ds", (int) floor (seconds));
514 snprintf (gap, sizeof (gap), "%s", _(">4s ago"));
516 timestamp.set_text (gap);
524 const float seconds = (when - now) / (float) AudioEngine::instance()->sample_rate();
525 if (abs (seconds) < 1.0) {
526 snprintf (gap, sizeof (gap), "%.3fs", seconds);
527 } else if (abs (seconds) < 4.0) {
528 snprintf (gap, sizeof (gap), "%ds", (int) floor (seconds));
530 snprintf (gap, sizeof (gap), "%s", _(">4s ago"));
532 timestamp.set_text (gap);
536 current.set_text ("");
542 TransportMastersWidget::update (samplepos_t /* audible */)
544 samplepos_t now = AudioEngine::instance()->sample_time ();
546 for (vector<Row*>::iterator r = rows.begin(); r != rows.end(); ++r) {
547 (*r)->update (_session, now);
552 TransportMastersWidget::on_map ()
554 update_connection = ARDOUR_UI::Clock.connect (sigc::mem_fun (*this, &TransportMastersWidget::update));
555 Gtk::VBox::on_map ();
559 TransportMastersWidget::on_unmap ()
561 update_connection.disconnect ();
562 Gtk::VBox::on_unmap ();
565 TransportMastersWindow::TransportMastersWindow ()
566 : ArdourWindow (_("Transport Masters"))
573 TransportMastersWindow::on_realize ()
575 ArdourWindow::on_realize ();
576 /* (try to) ensure that resizing is possible and the window can be moved (and closed) */
577 get_window()->set_decorations (Gdk::DECOR_BORDER | Gdk::DECOR_RESIZEH | Gdk::DECOR_TITLE | Gdk::DECOR_MENU);
583 TransportMastersWindow::set_session (ARDOUR::Session* s)
585 ArdourWindow::set_session (s);
589 TransportMastersWidget::AddTransportMasterDialog::AddTransportMasterDialog ()
590 : ArdourDialog (_("Add Transport Master"), true, false)
591 , name_label (_("Name"))
592 , type_label (_("Type"))
594 name_hbox.set_spacing (6);
595 name_hbox.pack_start (name_label, false, false);
596 name_hbox.pack_start (name_entry, true, true);
598 type_hbox.set_spacing (6);
599 type_hbox.pack_start (type_label, false, false);
600 type_hbox.pack_start (type_combo, true, true);
604 s.push_back (X_("MTC"));
605 s.push_back (X_("LTC"));
606 s.push_back (X_("MIDI Clock"));
608 set_popdown_strings (type_combo, s);
609 type_combo.set_active_text (X_("LTC"));
611 get_vbox()->pack_start (name_hbox, false, false);
612 get_vbox()->pack_start (type_hbox, false, false);
614 add_button (_("Cancel"), RESPONSE_CANCEL);
615 add_button (_("Add"), RESPONSE_ACCEPT);
624 name_entry.signal_activate().connect (sigc::bind (sigc::mem_fun (*this, &Gtk::Dialog::response), Gtk::RESPONSE_ACCEPT));
628 TransportMastersWidget::AddTransportMasterDialog::get_name () const
630 return name_entry.get_text ();
634 TransportMastersWidget::AddTransportMasterDialog::get_type() const
636 string t = type_combo.get_active_text ();
638 if (t == X_("MTC")) {
640 } else if (t == X_("MIDI Clock")) {