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
  50 #include "i18n.h"
  51
  52 using namespace ARDOUR;
  53 using namespace PBD;
  54 using namespace Gtk;
  55 using namespace Gtkmm2ext;
  56
  57 RouteParams_UI::RouteParams_UI ()
  58         : ArdourWindow (_("Tracks and Busses")),
  59           latency_apply_button (Stock::APPLY),
  60           track_menu(0)
  61 {
  62         insert_box = 0;
  63         _input_iosel = 0;
  64         _output_iosel = 0;
  65         _active_view = 0;
  66         latency_widget = 0;
  67
  68         using namespace Notebook_Helpers;
  69
  70         input_frame.set_shadow_type(Gtk::SHADOW_NONE);
  71         output_frame.set_shadow_type(Gtk::SHADOW_NONE);
  72         latency_frame.set_shadow_type (Gtk::SHADOW_NONE);
  73
  74         notebook.set_show_tabs (true);
  75         notebook.set_show_border (true);
  76         notebook.set_name ("RouteParamNotebook");
  77
  78         // create the tree model
  79         route_display_model = ListStore::create(route_display_columns);
  80
  81         // setup the treeview
  82         route_display.set_model(route_display_model);
  83         route_display.append_column(_("Tracks/Busses"), route_display_columns.text);
  84         route_display.set_name(X_("RouteParamsListDisplay"));
  85         route_display.get_selection()->set_mode(Gtk::SELECTION_SINGLE); // default
  86         route_display.set_reorderable(false);
  87         route_display.set_size_request(75, -1);
  88         route_display.set_headers_visible(true);
  89         route_display.set_headers_clickable(true);
  90
  91         dynamic_cast<Gtk::CellRendererText*>(route_display.get_column_cell_renderer(0))->property_ellipsize() = Pango::ELLIPSIZE_START;
  92
  93         route_select_scroller.add(route_display);
  94         route_select_scroller.set_policy(Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
  95
  96         route_select_frame.set_name("RouteSelectBaseFrame");
  97         route_select_frame.set_shadow_type (Gtk::SHADOW_IN);
  98         route_select_frame.add(route_select_scroller);
  99
 100         list_vpacker.pack_start (route_select_frame, true, true);
 101
 102         notebook.pages().push_back (TabElem (input_frame, _("Inputs")));
 103         notebook.pages().push_back (TabElem (output_frame, _("Outputs")));
 104         notebook.pages().push_back (TabElem (redir_hpane, _("Plugins, Inserts & Sends")));
 105         notebook.pages().push_back (TabElem (latency_frame, _("Latency")));
 106
 107         notebook.set_name ("InspectorNotebook");
 108
 109         title_label.set_name ("RouteParamsTitleLabel");
 110         update_title();
 111
 112         latency_packer.set_spacing (18);
 113         latency_button_box.pack_start (latency_apply_button);
 114         delay_label.set_alignment (0, 0.5);
 115
 116         // changeable area
 117         route_param_frame.set_name("RouteParamsBaseFrame");
 118         route_param_frame.set_shadow_type (Gtk::SHADOW_IN);
 119
 120
 121         route_hpacker.pack_start (notebook, true, true);
 122
 123         route_vpacker.pack_start (title_label, false, false);
 124         route_vpacker.pack_start (route_hpacker, true, true);
 125
 126
 127         list_hpane.pack1 (list_vpacker);
 128         list_hpane.add2 (route_vpacker);
 129
 130         list_hpane.set_position(110);
 131
 132         redir_hpane.set_position(110);
 133
 134         //global_vpacker.pack_start (list_hpane, true, true);
 135         //get_vbox()->pack_start (global_vpacker);
 136         add (list_hpane);
 137
 138
 139         set_name ("RouteParamsWindow");
 140         set_default_size (620,370);
 141         set_wmclass (X_("ardour_route_parameters"), PROGRAM_NAME);
 142
 143         // events
 144         route_display.get_selection()->signal_changed().connect(sigc::mem_fun(*this, &RouteParams_UI::route_selected));
 145         route_display.get_column(0)->signal_clicked().connect(sigc::mem_fun(*this, &RouteParams_UI::show_track_menu));
 146
 147         add_events (Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK|Gdk::BUTTON_RELEASE_MASK);
 148
 149         _plugin_selector = new PluginSelector (PluginManager::instance());
 150         show_all();
 151 }
 152
 153 RouteParams_UI::~RouteParams_UI ()
 154 {
 155 }
 156
 157 void
 158 RouteParams_UI::add_routes (RouteList& routes)
 159 {
 160         ENSURE_GUI_THREAD (*this, &RouteParams_UI::add_routes, routes)
 161
 162         for (RouteList::iterator x = routes.begin(); x != routes.end(); ++x) {
 163                 boost::shared_ptr<Route> route = (*x);
 164
 165                 if (route->is_auditioner()) {
 166                         return;
 167                 }
 168
 169                 TreeModel::Row row = *(route_display_model->append());
 170                 row[route_display_columns.text] = route->name();
 171                 row[route_display_columns.route] = route;
 172
 173                 //route_select_list.rows().back().select ();
 174
 175                 route->PropertyChanged.connect (*this, invalidator (*this), boost::bind (&RouteParams_UI::route_property_changed, this, _1, boost::weak_ptr<Route>(route)), gui_context());
 176                 route->DropReferences.connect (*this, invalidator (*this), boost::bind (&RouteParams_UI::route_removed, this, boost::weak_ptr<Route>(route)), gui_context());
 177         }
 178 }
 179
 180
 181 void
 182 RouteParams_UI::route_property_changed (const PropertyChange& what_changed, boost::weak_ptr<Route> wr)
 183 {
 184         if (!what_changed.contains (ARDOUR::Properties::name)) {
 185                 return;
 186         }
 187
 188         boost::shared_ptr<Route> route (wr.lock());
 189
 190         if (!route) {
 191                 return;
 192         }
 193
 194         ENSURE_GUI_THREAD (*this, &RouteParams_UI::route_name_changed, wr)
 195
 196         bool found = false ;
 197         TreeModel::Children rows = route_display_model->children();
 198         for(TreeModel::Children::iterator iter = rows.begin(); iter != rows.end(); ++iter) {
 199                 boost::shared_ptr<Route> r =(*iter)[route_display_columns.route];
 200                 if (r == route) {
 201                         (*iter)[route_display_columns.text] = route->name() ;
 202                         found = true ;
 203                         break;
 204                 }
 205         }
 206
 207         if(!found) {
 208                 error << _("route display list item for renamed route not found!") << endmsg;
 209         }
 210
 211         if (route == _route) {
 212                 track_input_label.set_text (route->name());
 213                 update_title();
 214         }
 215 }
 216
 217 void
 218 RouteParams_UI::map_frozen()
 219 {
 220         ENSURE_GUI_THREAD (*this, &RouteParams_UI::map_frozen)
 221         boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack>(_route);
 222         if (at && insert_box) {
 223                 switch (at->freeze_state()) {
 224                         case AudioTrack::Frozen:
 225                                 insert_box->set_sensitive (false);
 226                                 //hide_redirect_editors (); // TODO hide editor windows
 227                                 break;
 228                         default:
 229                                 insert_box->set_sensitive (true);
 230                                 // XXX need some way, maybe, to retoggle redirect editors
 231                                 break;
 232                 }
 233         }
 234 }
 235
 236 void
 237 RouteParams_UI::setup_processor_boxes()
 238 {
 239         if (_session && _route) {
 240
 241                 // just in case... shouldn't need this
 242                 cleanup_processor_boxes();
 243
 244                 // construct new redirect boxes
 245                 insert_box = new ProcessorBox (_session, boost::bind (&RouteParams_UI::plugin_selector, this), _rr_selection, 0);
 246                 insert_box->set_route (_route);
 247
 248                 boost::shared_ptr<AudioTrack> at = boost::dynamic_pointer_cast<AudioTrack>(_route);
 249                 if (at) {
 250                         at->FreezeChange.connect (route_connections, invalidator (*this), boost::bind (&RouteParams_UI::map_frozen, this), gui_context());
 251                 }
 252                 redir_hpane.pack1 (*insert_box);
 253
 254                 insert_box->ProcessorSelected.connect (sigc::mem_fun(*this, &RouteParams_UI::redirect_selected));
 255                 insert_box->ProcessorUnselected.connect (sigc::mem_fun(*this, &RouteParams_UI::redirect_selected));
 256
 257                 redir_hpane.show_all();
 258         }
 259 }
 260
 261 void
 262 RouteParams_UI::cleanup_processor_boxes()
 263 {
 264         if (insert_box) {
 265                 redir_hpane.remove(*insert_box);
 266                 delete insert_box;
 267                 insert_box = 0;
 268         }
 269 }
 270
 271 void
 272 RouteParams_UI::refresh_latency ()
 273 {
 274         if (latency_widget) {
 275                 latency_widget->refresh();
 276
 277                 char buf[128];
 278                 snprintf (buf, sizeof (buf), _("Playback delay: %" PRId64 " samples"), _route->initial_delay());
 279                 delay_label.set_text (buf);
 280         }
 281 }
 282
 283 void
 284 RouteParams_UI::cleanup_latency_frame ()
 285 {
 286         if (latency_widget) {
 287                 latency_frame.remove ();
 288                 latency_packer.remove (*latency_widget);
 289                 latency_packer.remove (latency_button_box);
 290                 latency_packer.remove (delay_label);
 291                 latency_connections.drop_connections ();
 292                 latency_click_connection.disconnect ();
 293
 294                 delete latency_widget;
 295                 latency_widget = 0;
 296
 297         }
 298 }
 299
 300 void
 301 RouteParams_UI::setup_latency_frame ()
 302 {
 303         latency_widget = new LatencyGUI (*(_route->output()), _session->frame_rate(), AudioEngine::instance()->samples_per_cycle());
 304
 305         char buf[128];
 306         snprintf (buf, sizeof (buf), _("Playback delay: %" PRId64 " samples"), _route->initial_delay());
 307         delay_label.set_text (buf);
 308
 309         latency_packer.pack_start (*latency_widget, false, false);
 310         latency_packer.pack_start (latency_button_box, false, false);
 311         latency_packer.pack_start (delay_label);
 312
 313         latency_click_connection = latency_apply_button.signal_clicked().connect (sigc::mem_fun (*latency_widget, &LatencyGUI::finish));
 314         _route->signal_latency_changed.connect (latency_connections, invalidator (*this), boost::bind (&RouteParams_UI::refresh_latency, this), gui_context());
 315         _route->initial_delay_changed.connect (latency_connections, invalidator (*this), boost::bind (&RouteParams_UI::refresh_latency, this), gui_context());
 316
 317         latency_frame.add (latency_packer);
 318         latency_frame.show_all ();
 319 }
 320
 321 void
 322 RouteParams_UI::setup_io_frames()
 323 {
 324         cleanup_io_frames();
 325
 326         // input
 327         _input_iosel = new IOSelector (this, _session, _route->input());
 328         _input_iosel->setup ();
 329         input_frame.add (*_input_iosel);
 330         input_frame.show_all();
 331
 332         // output
 333         _output_iosel = new IOSelector (this, _session, _route->output());
 334         _output_iosel->setup ();
 335         output_frame.add (*_output_iosel);
 336         output_frame.show_all();
 337 }
 338
 339 void
 340 RouteParams_UI::cleanup_io_frames()
 341 {
 342         if (_input_iosel) {
 343                 _input_iosel->Finished (IOSelector::Cancelled);
 344                 input_frame.remove();
 345                 delete _input_iosel;
 346                 _input_iosel = 0;
 347         }
 348
 349         if (_output_iosel) {
 350                 _output_iosel->Finished (IOSelector::Cancelled);
 351
 352                 output_frame.remove();
 353                 delete _output_iosel;
 354                 _output_iosel = 0;
 355         }
 356 }
 357
 358 void
 359 RouteParams_UI::cleanup_view (bool stopupdate)
 360 {
 361         if (_active_view) {
 362                 GenericPluginUI *   plugui = 0;
 363
 364                 if (stopupdate && (plugui = dynamic_cast<GenericPluginUI*>(_active_view)) != 0) {
 365                           plugui->stop_updating (0);
 366                 }
 367
 368                 _processor_going_away_connection.disconnect ();
 369                 redir_hpane.remove(*_active_view);
 370                 delete _active_view;
 371                 _active_view = 0;
 372         }
 373 }
 374
 375 void
 376 RouteParams_UI::route_removed (boost::weak_ptr<Route> wr)
 377 {
 378         boost::shared_ptr<Route> route (wr.lock());
 379
 380         if (!route) {
 381                 return;
 382         }
 383
 384         ENSURE_GUI_THREAD (*this, invalidator (*this), &RouteParams_UI::route_removed, wr)
 385
 386         TreeModel::Children rows = route_display_model->children();
 387         TreeModel::Children::iterator ri;
 388
 389         for(TreeModel::Children::iterator iter = rows.begin(); iter != rows.end(); ++iter) {
 390                 boost::shared_ptr<Route> r =(*iter)[route_display_columns.route];
 391
 392                 if (r == route) {
 393                         route_display_model->erase(iter);
 394                         break;
 395                 }
 396         }
 397
 398         if (route == _route) {
 399                 cleanup_io_frames();
 400                 cleanup_view();
 401                 cleanup_processor_boxes();
 402
 403                 _route.reset ((Route*) 0);
 404                 _processor.reset ((Processor*) 0);
 405                 update_title();
 406         }
 407 }
 408
 409 void
 410 RouteParams_UI::set_session (Session *sess)
 411 {
 412         ArdourWindow::set_session (sess);
 413
 414         route_display_model->clear();
 415         _plugin_selector->set_session (_session);
 416
 417         if (_session) {
 418                 boost::shared_ptr<RouteList> r = _session->get_routes();
 419                 add_routes (*r);
 420                 _session->RouteAdded.connect (_session_connections, invalidator (*this), boost::bind (&RouteParams_UI::add_routes, this, _1), gui_context());
 421                 start_updating ();
 422         } else {
 423                 stop_updating ();
 424         }
 425 }
 426
 427
 428 void
 429 RouteParams_UI::session_going_away ()
 430 {
 431         ENSURE_GUI_THREAD (*this, &RouteParams_UI::session_going_away);
 432
 433         SessionHandlePtr::session_going_away ();
 434
 435         route_display_model->clear();
 436
 437         cleanup_io_frames();
 438         cleanup_view();
 439         cleanup_processor_boxes();
 440         cleanup_latency_frame ();
 441
 442         _route.reset ((Route*) 0);
 443         _processor.reset ((Processor*) 0);
 444         update_title();
 445 }
 446
 447 void
 448 RouteParams_UI::route_selected()
 449 {
 450         Glib::RefPtr<TreeSelection> selection = route_display.get_selection();
 451         TreeModel::iterator iter = selection->get_selected(); // only used with Gtk::SELECTION_SINGLE
 452
 453         if(iter) {
 454                 //If anything is selected
 455                 boost::shared_ptr<Route> route = (*iter)[route_display_columns.route] ;
 456
 457                 if (_route == route) {
 458                         // do nothing
 459                         return;
 460                 }
 461
 462                 // remove event binding from previously selected
 463                 if (_route) {
 464                         _route_processors_connection.disconnect ();
 465                         cleanup_processor_boxes();
 466                         cleanup_view();
 467                         cleanup_io_frames();
 468                         cleanup_latency_frame ();
 469                 }
 470
 471                 // update the other panes with the correct info
 472                 _route = route;
 473                 //update_routeinfo (route);
 474
 475                 setup_io_frames();
 476                 setup_processor_boxes();
 477                 setup_latency_frame ();
 478
 479                 route->processors_changed.connect (_route_processors_connection, invalidator (*this), boost::bind (&RouteParams_UI::processors_changed, this, _1), gui_context());
 480
 481                 track_input_label.set_text (_route->name());
 482
 483                 update_title();
 484
 485         } else {
 486                 // no selection
 487                 if (_route) {
 488                         _route_processors_connection.disconnect ();
 489
 490                         // remove from view
 491                         cleanup_io_frames();
 492                         cleanup_view();
 493                         cleanup_processor_boxes();
 494                         cleanup_latency_frame ();
 495
 496                         _route.reset ((Route*) 0);
 497                         _processor.reset ((Processor*) 0);
 498                         track_input_label.set_text(_("NO TRACK"));
 499                         update_title();
 500                 }
 501         }
 502 }
 503
 504 void
 505 RouteParams_UI::processors_changed (RouteProcessorChange)
 506 {
 507         cleanup_view();
 508
 509         _processor.reset ((Processor*) 0);
 510
 511         //update_title();
 512 }
 513
 514 void
 515 RouteParams_UI::show_track_menu()
 516 {
 517         using namespace Menu_Helpers;
 518
 519         if (track_menu == 0) {
 520                 track_menu = new Menu;
 521                 track_menu->set_name ("ArdourContextMenu");
 522                 track_menu->items().push_back
 523                                 (MenuElem (_("Add Track or Bus"),
 524                                            sigc::bind (sigc::mem_fun (*(ARDOUR_UI::instance()), &ARDOUR_UI::add_route), (Gtk::Window*) 0)));
 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 = ARDOUR_UI::instance()->RapidScreenUpdate.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 }