gtk2_ardour/route_params_ui.cc

   1 /*
   2     Copyright (C) 2000 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 <algorithm>
  21 #include <inttypes.h>
  22
  23 #include <glibmm/threads.h>
  24 #include <gtkmm2ext/utils.h>
  25 #include <gtkmm2ext/window_title.h>
  26
  27 #include "ardour/audioengine.h"
  28 #include "ardour/audio_track.h"
  29 #include "ardour/plugin.h"
  30 #include "ardour/plugin_insert.h"
  31 #include "ardour/plugin_manager.h"
  32 #include "ardour/port_insert.h"
  33 #include "ardour/return.h"
  34 #include "ardour/route.h"
  35 #include "ardour/send.h"
  36 #include "ardour/internal_send.h"
  37
  38 #include "ardour_ui.h"
  39 #include "gui_thread.h"
  40 #include "io_selector.h"
  41 #include "keyboard.h"
  42 #include "mixer_strip.h"
  43 #include "port_insert_ui.h"
  44 #include "plugin_selector.h"
  45 #include "plugin_ui.h"
  46 #include "return_ui.h"
  47 #include "route_params_ui.h"
  48 #include "send_ui.h"
  49 #include "timers.h"
  50
  51 #include "i18n.h"
  52
  53 using namespace ARDOUR;
  54 using namespace PBD;
  55 using namespace Gtk;
  56 using namespace Gtkmm2ext;
  57
  58 RouteParams_UI::RouteParams_UI ()
  59         : ArdourWindow (_("Tracks and Busses")),
  60           latency_apply_button (Stock::APPLY),
  61           track_menu(0)
  62 {
  63         insert_box = 0;
  64         _input_iosel = 0;
  65         _output_iosel = 0;
  66         _active_view = 0;
  67         latency_widget = 0;
  68
  69         using namespace Notebook_Helpers;
  70
  71         input_frame.set_shadow_type(Gtk::SHADOW_NONE);
  72         output_frame.set_shadow_type(Gtk::SHADOW_NONE);
  73         latency_frame.set_shadow_type (Gtk::SHADOW_NONE);
  74
  75         notebook.set_show_tabs (true);
  76         notebook.set_show_border (true);
  77         notebook.set_name ("RouteParamNotebook");
  78
  79         // create the tree model
  80         route_display_model = ListStore::create(route_display_columns);
  81
  82         // setup the treeview
  83         route_display.set_model(route_display_model);
  84         route_display.append_column(_("Tracks/Busses"), route_display_columns.text);
  85         route_display.set_name(X_("RouteParamsListDisplay"));
  86         route_display.get_selection()->set_mode(Gtk::SELECTION_SINGLE); // default
  87         route_display.set_reorderable(false);
  88         route_display.set_size_request(75, -1);
  89         route_display.set_headers_visible(true);
  90         route_display.set_headers_clickable(true);
  91
  92         dynamic_cast<Gtk::CellRendererText*>(route_display.get_column_cell_renderer(0))->property_ellipsize() = Pango::ELLIPSIZE_START;
  93
  94         route_select_scroller.add(route_display);
  95         route_select_scroller.set_policy(Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
  96
  97         route_select_frame.set_name("RouteSelectBaseFrame");
  98         route_select_frame.set_shadow_type (Gtk::SHADOW_IN);
  99         route_select_frame.add(route_select_scroller);
 100
 101         list_vpacker.pack_start (route_select_frame, true, true);
 102
 103         notebook.pages().push_back (TabElem (input_frame, _("Inputs")));
 104         notebook.pages().push_back (TabElem (output_frame, _("Outputs")));
 105         notebook.pages().push_back (TabElem (redir_hpane, _("Plugins, Inserts & Sends")));
 106         notebook.pages().push_back (TabElem (latency_frame, _("Latency")));
 107
 108         notebook.set_name ("InspectorNotebook");
 109
 110         title_label.set_name ("RouteParamsTitleLabel");
 111         update_title();
 112
 113         latency_packer.set_spacing (18);
 114         latency_button_box.pack_start (latency_apply_button);
 115         delay_label.set_alignment (0, 0.5);
 116
 117         // changeable area
 118         route_param_frame.set_name("RouteParamsBaseFrame");
 119         route_param_frame.set_shadow_type (Gtk::SHADOW_IN);
 120
 121
 122         route_hpacker.pack_start (notebook, true, true);
 123
 124         route_vpacker.pack_start (title_label, false, false);
 125         route_vpacker.pack_start (route_hpacker, true, true);
 126
 127
 128         list_hpane.pack1 (list_vpacker);
 129         list_hpane.add2 (route_vpacker);
 130
 131         list_hpane.set_position(110);
 132
 133         redir_hpane.set_position(110);
 134
 135         //global_vpacker.pack_start (list_hpane, true, true);
 136         //get_vbox()->pack_start (global_vpacker);
 137         add (list_hpane);
 138
 139
 140         set_name ("RouteParamsWindow");
 141         set_default_size (620,370);
 142         set_wmclass (X_("ardour_route_parameters"), PROGRAM_NAME);
 143
 144         // events
 145         route_display.get_selection()->signal_changed().connect(sigc::mem_fun(*this, &RouteParams_UI::route_selected));
 146         route_display.get_column(0)->signal_clicked().connect(sigc::mem_fun(*this, &RouteParams_UI::show_track_menu));
 147
 148         add_events (Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK|Gdk::BUTTON_RELEASE_MASK);
 149
 150         _plugin_selector = new PluginSelector (PluginManager::instance());
 151         show_all();
 152 }
 153
 154 RouteParams_UI::~RouteParams_UI ()
 155 {
 156 }
 157
 158 void
 159 RouteParams_UI::add_routes (RouteList& routes)
 160 {
 161         ENSURE_GUI_THREAD (*this, &RouteParams_UI::add_routes, routes)
 162
 163         for (RouteList::iterator x = routes.begin(); x != routes.end(); ++x) {
 164                 boost::shared_ptr<Route> route = (*x);
 165
 166                 if (route->is_auditioner()) {
 167                         return;
 168                 }
 169
 170                 TreeModel::Row row = *(route_display_model->append());
 171                 row[route_display_columns.text] = route->name();
 172                 row[route_display_columns.route] = route;
 173
 174                 //route_select_list.rows().back().select ();
 175
 176                 route->PropertyChanged.connect (*this, invalidator (*this), boost::bind (&RouteParams_UI::route_property_changed, this, _1, boost::weak_ptr<Route>(route)), gui_context());
 177                 route->DropReferences.connect (*this, invalidator (*this), boost::bind (&RouteParams_UI::route_removed, this, boost::weak_ptr<Route>(route)), gui_context());
 178         }
 179 }
 180
 181
 182 void
 183 RouteParams_UI::route_property_changed (const PropertyChange& what_changed, boost::weak_ptr<Route> wr)
 184 {
 185         if (!what_changed.contains (ARDOUR::Properties::name)) {
 186                 return;
 187         }
 188
 189         boost::shared_ptr<Route> route (wr.lock());
 190
 191         if (!route) {
 192                 return;
 193         }
 194
 195         ENSURE_GUI_THREAD (*this, &RouteParams_UI::route_name_changed, wr)
 196
 197         bool found = false ;
 198         TreeModel::Children rows = route_display_model->children();
 199         for(TreeModel::Children::iterator iter = rows.begin(); iter != rows.end(); ++iter) {
 200                 boost::shared_ptr<Route> r =(*iter)[route_display_columns.route];
 201                 if (r == route) {
 202                         (*iter)[route_display_columns.text] = route->name() ;
 203                         found = true ;
 204                         break;
 205                 }
 206         }
 207
 208         if(!found) {
 209                 error << _("route display list item for renamed route not found!") << endmsg;
 210         }
 211
 212         if (route == _route) {
 213                 track_input_label.set_text (route->name());
 214                 update_title();
 215         }
 216 }
 217
 218 void
 219 RouteParams_UI::map_frozen()
 220 {
 221         ENSURE_GUI_THREAD (*this, &RouteParams_UI::map_frozen)
 222         boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack>(_route);
 223         if (at && insert_box) {
 224                 switch (at->freeze_state()) {
 225                         case AudioTrack::Frozen:
 226                                 insert_box->set_sensitive (false);
 227                                 //hide_redirect_editors (); // TODO hide editor windows
 228                                 break;
 229                         default:
 230                                 insert_box->set_sensitive (true);
 231                                 // XXX need some way, maybe, to retoggle redirect editors
 232                                 break;
 233                 }
 234         }
 235 }
 236
 237 void
 238 RouteParams_UI::setup_processor_boxes()
 239 {
 240         if (_session && _route) {
 241
 242                 // just in case... shouldn't need this
 243                 cleanup_processor_boxes();
 244
 245                 // construct new redirect boxes
 246                 insert_box = new ProcessorBox (_session, boost::bind (&RouteParams_UI::plugin_selector, this), _rr_selection, 0);
 247                 insert_box->set_route (_route);
 248
 249                 boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack>(_route);
 250                 if (at) {
 251                         at->FreezeChange.connect (route_connections, invalidator (*this), boost::bind (&RouteParams_UI::map_frozen, this), gui_context());
 252                 }
 253                 redir_hpane.pack1 (*insert_box);
 254
 255                 insert_box->ProcessorSelected.connect (sigc::mem_fun(*this, &RouteParams_UI::redirect_selected));  //note:  this indicates a double-click activation, not just a "selection"
 256                 insert_box->ProcessorUnselected.connect (sigc::mem_fun(*this, &RouteParams_UI::redirect_selected));
 257
 258                 redir_hpane.show_all();
 259         }
 260 }
 261
 262 void
 263 RouteParams_UI::cleanup_processor_boxes()
 264 {
 265         if (insert_box) {
 266                 redir_hpane.remove(*insert_box);
 267                 delete insert_box;
 268                 insert_box = 0;
 269         }
 270 }
 271
 272 void
 273 RouteParams_UI::refresh_latency ()
 274 {
 275         if (latency_widget) {
 276                 latency_widget->refresh();
 277
 278                 char buf[128];
 279                 snprintf (buf, sizeof (buf), _("Playback delay: %" PRId64 " samples"), _route->initial_delay());
 280                 delay_label.set_text (buf);
 281         }
 282 }
 283
 284 void
 285 RouteParams_UI::cleanup_latency_frame ()
 286 {
 287         if (latency_widget) {
 288                 latency_frame.remove ();
 289                 latency_packer.remove (*latency_widget);
 290                 latency_packer.remove (latency_button_box);
 291                 latency_packer.remove (delay_label);
 292                 latency_connections.drop_connections ();
 293                 latency_click_connection.disconnect ();
 294
 295                 delete latency_widget;
 296                 latency_widget = 0;
 297
 298         }
 299 }
 300
 301 void
 302 RouteParams_UI::setup_latency_frame ()
 303 {
 304         latency_widget = new LatencyGUI (*(_route->output()), _session->frame_rate(), AudioEngine::instance()->samples_per_cycle());
 305
 306         char buf[128];
 307         snprintf (buf, sizeof (buf), _("Playback delay: %" PRId64 " samples"), _route->initial_delay());
 308         delay_label.set_text (buf);
 309
 310         latency_packer.pack_start (*latency_widget, false, false);
 311         latency_packer.pack_start (latency_button_box, false, false);
 312         latency_packer.pack_start (delay_label);
 313
 314         latency_click_connection = latency_apply_button.signal_clicked().connect (sigc::mem_fun (*latency_widget, &LatencyGUI::finish));
 315         _route->signal_latency_changed.connect (latency_connections, invalidator (*this), boost::bind (&RouteParams_UI::refresh_latency, this), gui_context());
 316         _route->initial_delay_changed.connect (latency_connections, invalidator (*this), boost::bind (&RouteParams_UI::refresh_latency, this), gui_context());
 317
 318         latency_frame.add (latency_packer);
 319         latency_frame.show_all ();
 320 }
 321
 322 void
 323 RouteParams_UI::setup_io_frames()
 324 {
 325         cleanup_io_frames();
 326
 327         // input
 328         _input_iosel = new IOSelector (this, _session, _route->input());
 329         _input_iosel->setup ();
 330         input_frame.add (*_input_iosel);
 331         input_frame.show_all();
 332
 333         // output
 334         _output_iosel = new IOSelector (this, _session, _route->output());
 335         _output_iosel->setup ();
 336         output_frame.add (*_output_iosel);
 337         output_frame.show_all();
 338 }
 339
 340 void
 341 RouteParams_UI::cleanup_io_frames()
 342 {
 343         if (_input_iosel) {
 344                 _input_iosel->Finished (IOSelector::Cancelled);
 345                 input_frame.remove();
 346                 delete _input_iosel;
 347                 _input_iosel = 0;
 348         }
 349
 350         if (_output_iosel) {
 351                 _output_iosel->Finished (IOSelector::Cancelled);
 352
 353                 output_frame.remove();
 354                 delete _output_iosel;
 355                 _output_iosel = 0;
 356         }
 357 }
 358
 359 void
 360 RouteParams_UI::cleanup_view (bool stopupdate)
 361 {
 362         if (_active_view) {
 363                 GenericPluginUI *   plugui = 0;
 364
 365                 if (stopupdate && (plugui = dynamic_cast<GenericPluginUI*>(_active_view)) != 0) {
 366                           plugui->stop_updating (0);
 367                 }
 368
 369                 _processor_going_away_connection.disconnect ();
 370                 redir_hpane.remove(*_active_view);
 371                 delete _active_view;
 372                 _active_view = 0;
 373         }
 374 }
 375
 376 void
 377 RouteParams_UI::route_removed (boost::weak_ptr<Route> wr)
 378 {
 379         boost::shared_ptr<Route> route (wr.lock());
 380
 381         if (!route) {
 382                 return;
 383         }
 384
 385         ENSURE_GUI_THREAD (*this, invalidator (*this), &RouteParams_UI::route_removed, wr)
 386
 387         TreeModel::Children rows = route_display_model->children();
 388         TreeModel::Children::iterator ri;
 389
 390         for(TreeModel::Children::iterator iter = rows.begin(); iter != rows.end(); ++iter) {
 391                 boost::shared_ptr<Route> r =(*iter)[route_display_columns.route];
 392
 393                 if (r == route) {
 394                         route_display_model->erase(iter);
 395                         break;
 396                 }
 397         }
 398
 399         if (route == _route) {
 400                 cleanup_io_frames();
 401                 cleanup_view();
 402                 cleanup_processor_boxes();
 403
 404                 _route.reset ((Route*) 0);
 405                 _processor.reset ((Processor*) 0);
 406                 update_title();
 407         }
 408 }
 409
 410 void
 411 RouteParams_UI::set_session (Session *sess)
 412 {
 413         ArdourWindow::set_session (sess);
 414
 415         route_display_model->clear();
 416         _plugin_selector->set_session (_session);
 417
 418         if (_session) {
 419                 boost::shared_ptr<RouteList> r = _session->get_routes();
 420                 add_routes (*r);
 421                 _session->RouteAdded.connect (_session_connections, invalidator (*this), boost::bind (&RouteParams_UI::add_routes, this, _1), gui_context());
 422                 start_updating ();
 423         } else {
 424                 stop_updating ();
 425         }
 426 }
 427
 428
 429 void
 430 RouteParams_UI::session_going_away ()
 431 {
 432         ENSURE_GUI_THREAD (*this, &RouteParams_UI::session_going_away);
 433
 434         SessionHandlePtr::session_going_away ();
 435
 436         route_display_model->clear();
 437
 438         cleanup_io_frames();
 439         cleanup_view();
 440         cleanup_processor_boxes();
 441         cleanup_latency_frame ();
 442
 443         _route.reset ((Route*) 0);
 444         _processor.reset ((Processor*) 0);
 445         update_title();
 446 }
 447
 448 void
 449 RouteParams_UI::route_selected()
 450 {
 451         Glib::RefPtr<TreeSelection> selection = route_display.get_selection();
 452         TreeModel::iterator iter = selection->get_selected(); // only used with Gtk::SELECTION_SINGLE
 453
 454         if(iter) {
 455                 //If anything is selected
 456                 boost::shared_ptr<Route> route = (*iter)[route_display_columns.route] ;
 457
 458                 if (_route == route) {
 459                         // do nothing
 460                         return;
 461                 }
 462
 463                 // remove event binding from previously selected
 464                 if (_route) {
 465                         _route_processors_connection.disconnect ();
 466                         cleanup_processor_boxes();
 467                         cleanup_view();
 468                         cleanup_io_frames();
 469                         cleanup_latency_frame ();
 470                 }
 471
 472                 // update the other panes with the correct info
 473                 _route = route;
 474                 //update_routeinfo (route);
 475
 476                 setup_io_frames();
 477                 setup_processor_boxes();
 478                 setup_latency_frame ();
 479
 480                 route->processors_changed.connect (_route_processors_connection, invalidator (*this), boost::bind (&RouteParams_UI::processors_changed, this, _1), gui_context());
 481
 482                 track_input_label.set_text (_route->name());
 483
 484                 update_title();
 485
 486         } else {
 487                 // no selection
 488                 if (_route) {
 489                         _route_processors_connection.disconnect ();
 490
 491                         // remove from view
 492                         cleanup_io_frames();
 493                         cleanup_view();
 494                         cleanup_processor_boxes();
 495                         cleanup_latency_frame ();
 496
 497                         _route.reset ((Route*) 0);
 498                         _processor.reset ((Processor*) 0);
 499                         track_input_label.set_text(_("NO TRACK"));
 500                         update_title();
 501                 }
 502         }
 503 }
 504
 505 void
 506 RouteParams_UI::processors_changed (RouteProcessorChange)
 507 {
 508         cleanup_view();
 509
 510         _processor.reset ((Processor*) 0);
 511
 512         //update_title();
 513 }
 514
 515 void
 516 RouteParams_UI::show_track_menu()
 517 {
 518         using namespace Menu_Helpers;
 519
 520         if (track_menu == 0) {
 521                 track_menu = new Menu;
 522                 track_menu->set_name ("ArdourContextMenu");
 523                 track_menu->items().push_back
 524                                 (MenuElem (_("Add Track or Bus"), sigc::mem_fun (*(ARDOUR_UI::instance()), &ARDOUR_UI::add_route)));
 525         }
 526         track_menu->popup (1, gtk_get_current_event_time());
 527 }
 528
 529 void
 530 RouteParams_UI::redirect_selected (boost::shared_ptr<ARDOUR::Processor> proc)
 531 {
 532         boost::shared_ptr<Send> send;
 533         boost::shared_ptr<Return> retrn;
 534         boost::shared_ptr<PluginInsert> plugin_insert;
 535         boost::shared_ptr<PortInsert> port_insert;
 536
 537         if ((boost::dynamic_pointer_cast<InternalSend> (proc)) != 0) {
 538                 cleanup_view();
 539                 _processor.reset ((Processor*) 0);
 540                 update_title();
 541                 return;
 542         } else if ((send = boost::dynamic_pointer_cast<Send> (proc)) != 0) {
 543
 544                 SendUI *send_ui = new SendUI (this, send, _session);
 545
 546                 cleanup_view();
 547                 send->DropReferences.connect (_processor_going_away_connection, invalidator (*this), boost::bind (&RouteParams_UI::processor_going_away, this, boost::weak_ptr<Processor>(proc)), gui_context());
 548                 _active_view = send_ui;
 549
 550                 redir_hpane.add2 (*_active_view);
 551                 redir_hpane.show_all();
 552
 553         } else if ((retrn = boost::dynamic_pointer_cast<Return> (proc)) != 0) {
 554
 555                 ReturnUI *return_ui = new ReturnUI (this, retrn, _session);
 556
 557                 cleanup_view();
 558                 retrn->DropReferences.connect (_processor_going_away_connection, invalidator (*this), boost::bind (&RouteParams_UI::processor_going_away, this, boost::weak_ptr<Processor>(proc)), gui_context());
 559                 _active_view = return_ui;
 560
 561                 redir_hpane.add2 (*_active_view);
 562                 redir_hpane.show_all();
 563
 564         } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (proc)) != 0) {
 565
 566                 GenericPluginUI *plugin_ui = new GenericPluginUI (plugin_insert, true);
 567
 568                 cleanup_view();
 569                 plugin_insert->plugin()->DropReferences.connect (_processor_going_away_connection, invalidator (*this), boost::bind (&RouteParams_UI::plugin_going_away, this, PreFader), gui_context());
 570                 plugin_ui->start_updating (0);
 571                 _active_view = plugin_ui;
 572
 573                 redir_hpane.pack2 (*_active_view);
 574                 redir_hpane.show_all();
 575
 576         } else if ((port_insert = boost::dynamic_pointer_cast<PortInsert> (proc)) != 0) {
 577
 578                 PortInsertUI *portinsert_ui = new PortInsertUI (this, _session, port_insert);
 579
 580                 cleanup_view();
 581                 port_insert->DropReferences.connect (_processor_going_away_connection, invalidator (*this), boost::bind (&RouteParams_UI::processor_going_away, this, boost::weak_ptr<Processor> (proc)), gui_context());
 582                 _active_view = portinsert_ui;
 583
 584                 redir_hpane.pack2 (*_active_view);
 585                 portinsert_ui->redisplay();
 586                 redir_hpane.show_all();
 587         }
 588
 589         _processor = proc;
 590         update_title();
 591
 592 }
 593
 594 void
 595 RouteParams_UI::plugin_going_away (Placement place)
 596 {
 597         ENSURE_GUI_THREAD (*this, &RouteParams_UI::plugin_going_away, place)
 598
 599         // delete the current view without calling finish
 600
 601         if (place == PreFader) {
 602                 cleanup_view (false);
 603                 _processor.reset ((Processor*) 0);
 604         }
 605 }
 606
 607 void
 608 RouteParams_UI::processor_going_away (boost::weak_ptr<ARDOUR::Processor> wproc)
 609 {
 610         boost::shared_ptr<Processor> proc = (wproc.lock());
 611
 612         if (!proc) {
 613                 return;
 614         }
 615
 616         ENSURE_GUI_THREAD (*this, &RouteParams_UI::processor_going_away, wproc)
 617
 618         printf ("redirect going away\n");
 619         // delete the current view without calling finish
 620         if (proc == _processor) {
 621                 cleanup_view (false);
 622                 _processor.reset ((Processor*) 0);
 623         }
 624 }
 625
 626 void
 627 RouteParams_UI::update_title ()
 628 {
 629         WindowTitle title (_("Tracks and Busses"));
 630
 631         if (_route) {
 632                 title_label.set_text(_route->name());
 633                 title += _route->name();
 634                 set_title(title.get_string());
 635         } else {
 636                 title_label.set_text(_("No Track or Bus Selected"));
 637                 title += _("No Track or Bus Selected");
 638                 set_title(title.get_string());
 639         }
 640 }
 641
 642 void
 643 RouteParams_UI::start_updating ()
 644 {
 645         update_connection = Timers::rapid_connect
 646                 (sigc::mem_fun(*this, &RouteParams_UI::update_views));
 647 }
 648
 649 void
 650 RouteParams_UI::stop_updating ()
 651 {
 652         update_connection.disconnect();
 653 }
 654
 655 void
 656 RouteParams_UI::update_views ()
 657 {
 658         SendUI *sui;
 659         // TODO: only do it if correct tab is showing
 660
 661         if ((sui = dynamic_cast<SendUI*> (_active_view)) != 0) {
 662                 sui->update ();
 663         }
 664 }