Insert/Redirect refactoring, towards better MIDI support in mixer strip, and
[ardour.git] / 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
22 #include <glibmm/thread.h>
23 #include <gtkmm2ext/utils.h>
24 #include <gtkmm2ext/stop_signal.h>
25 #include <gtkmm2ext/window_title.h>
26
27 #include <ardour/session.h>
28 #include <ardour/session_route.h>
29 #include <ardour/audio_diskstream.h>
30 #include <ardour/plugin.h>
31 #include <ardour/plugin_manager.h>
32 #include <ardour/ardour.h>
33 #include <ardour/session.h>
34 #include <ardour/route.h>
35 #include <ardour/audio_track.h>
36 #include <ardour/send.h>
37 #include <ardour/plugin_insert.h>
38 #include <ardour/port_insert.h>
39
40 #include "route_params_ui.h"
41 #include "keyboard.h"
42 #include "mixer_strip.h"
43 #include "plugin_selector.h"
44 #include "ardour_ui.h"
45 #include "plugin_ui.h"
46 #include "io_selector.h"
47 #include "send_ui.h"
48 #include "utils.h"
49 #include "gui_thread.h"
50
51 #include "i18n.h"
52
53 using namespace ARDOUR;
54 using namespace PBD;
55 using namespace Gtk;
56 using namespace Gtkmm2ext;
57 using namespace sigc;
58
59 RouteParams_UI::RouteParams_UI ()
60         : ArdourDialog ("track/bus inspector"),
61           track_menu(0)
62 {
63         pre_insert_box = 0;
64         post_insert_box = 0;
65         _input_iosel = 0;
66         _output_iosel = 0;
67         _active_pre_view = 0;
68         _active_post_view = 0;
69         
70         using namespace Notebook_Helpers;
71
72         input_frame.set_shadow_type(Gtk::SHADOW_NONE);
73         output_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/Buses"), 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         route_select_scroller.add(route_display);
93         route_select_scroller.set_policy(Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
94
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 (pre_redir_hpane, _("Pre-fader Redirects")));
105         notebook.pages().push_back (TabElem (post_redir_hpane, _("Post-fader Redirects")));
106
107         notebook.set_name ("InspectorNotebook");
108         
109         title_label.set_name ("RouteParamsTitleLabel");
110         update_title();
111         
112         // changeable area
113         route_param_frame.set_name("RouteParamsBaseFrame");
114         route_param_frame.set_shadow_type (Gtk::SHADOW_IN);
115         
116         
117         route_hpacker.pack_start (notebook, true, true);
118         
119         
120         route_vpacker.pack_start (title_label, false, false);
121         route_vpacker.pack_start (route_hpacker, true, true);
122
123         
124         list_hpane.pack1 (list_vpacker);
125         list_hpane.add2 (route_vpacker);
126
127         list_hpane.set_position(110);
128
129         pre_redir_hpane.set_position(110);
130         post_redir_hpane.set_position(110);
131         
132         //global_vpacker.pack_start (list_hpane, true, true);
133         //get_vbox()->pack_start (global_vpacker);
134         get_vbox()->pack_start (list_hpane);
135         
136         
137         set_name ("RouteParamsWindow");
138         set_default_size (620,370);
139         set_wmclass (X_("ardour_route_parameters"), "Ardour");
140
141         WindowTitle title(Glib::get_application_name());
142         title += _("Track/Bus Inspector"); 
143         set_title (title.get_string());
144
145         // events
146         route_display.get_selection()->signal_changed().connect(mem_fun(*this, &RouteParams_UI::route_selected));
147         route_display.get_column(0)->signal_clicked().connect(mem_fun(*this, &RouteParams_UI::show_track_menu));
148
149         add_events (Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK|Gdk::BUTTON_RELEASE_MASK);
150         
151         _plugin_selector = new PluginSelector (PluginManager::the_manager());
152         _plugin_selector->signal_delete_event().connect (bind (ptr_fun (just_hide_it), 
153                                                      static_cast<Window *> (_plugin_selector)));
154
155
156         signal_delete_event().connect(bind(ptr_fun(just_hide_it), static_cast<Gtk::Window *>(this)));
157 }
158
159 RouteParams_UI::~RouteParams_UI ()
160 {
161 }
162
163 void
164 RouteParams_UI::add_routes (Session::RouteList& routes)
165 {
166         ENSURE_GUI_THREAD(bind (mem_fun(*this, &RouteParams_UI::add_routes), routes));
167         
168         for (Session::RouteList::iterator x = routes.begin(); x != routes.end(); ++x) {
169                 boost::shared_ptr<Route> route = (*x);
170
171                 if (route->hidden()) {
172                         return;
173                 }
174                 
175                 TreeModel::Row row = *(route_display_model->append());
176                 row[route_display_columns.text] = route->name();
177                 row[route_display_columns.route] = route;
178                 
179                 //route_select_list.rows().back().select ();
180                 
181                 route->NameChanged.connect (bind (mem_fun(*this, &RouteParams_UI::route_name_changed), route));
182                 route->GoingAway.connect (bind (mem_fun(*this, &RouteParams_UI::route_removed), route));
183         }
184 }
185
186
187 void
188 RouteParams_UI::route_name_changed (boost::shared_ptr<Route> route)
189 {
190         ENSURE_GUI_THREAD(bind (mem_fun(*this, &RouteParams_UI::route_name_changed), route));
191
192         bool found = false ;
193         TreeModel::Children rows = route_display_model->children();
194         for(TreeModel::Children::iterator iter = rows.begin(); iter != rows.end(); ++iter) {
195                 boost::shared_ptr<Route> r =(*iter)[route_display_columns.route];
196                 if (r == route) {
197                         (*iter)[route_display_columns.text] = route->name() ;
198                         found = true ;
199                         break;
200                 }
201         }
202
203         if(!found) {
204                 error << _("route display list item for renamed route not found!") << endmsg;
205         }
206
207         if (route == _route) {
208                 track_input_label.set_text (route->name());
209                 update_title();
210         }
211 }
212
213 void
214 RouteParams_UI::setup_redirect_boxes()
215 {
216         if (session && _route) {
217
218                 // just in case... shouldn't need this
219                 cleanup_redirect_boxes();
220                 
221                 // construct new redirect boxes
222                 pre_insert_box = new RedirectBox(PreFader, *session, _route, *_plugin_selector, _rr_selection);
223                 post_insert_box = new RedirectBox(PostFader, *session, _route, *_plugin_selector, _rr_selection);
224
225                 pre_redir_hpane.pack1 (*pre_insert_box);
226                 post_redir_hpane.pack1 (*post_insert_box);
227
228                 pre_insert_box->InsertSelected.connect (bind (mem_fun(*this, &RouteParams_UI::redirect_selected), PreFader));
229                 pre_insert_box->InsertUnselected.connect (bind (mem_fun(*this, &RouteParams_UI::redirect_selected), PreFader));
230                 post_insert_box->InsertSelected.connect (bind (mem_fun(*this, &RouteParams_UI::redirect_selected), PostFader));
231                 post_insert_box->InsertUnselected.connect (bind (mem_fun(*this, &RouteParams_UI::redirect_selected), PostFader));
232
233                 pre_redir_hpane.show_all();
234                 post_redir_hpane.show_all();
235         }
236         
237 }
238
239 void
240 RouteParams_UI::cleanup_redirect_boxes()
241 {
242         if (pre_insert_box) {
243                 pre_redir_hpane.remove(*pre_insert_box);
244                 delete pre_insert_box;
245                 pre_insert_box = 0;
246         }
247
248         if (post_insert_box) {
249                 post_redir_hpane.remove(*post_insert_box);
250                 delete post_insert_box;
251                 post_insert_box = 0;
252         }
253 }
254
255 void
256 RouteParams_UI::setup_io_frames()
257 {
258         cleanup_io_frames();
259         
260         // input
261         _input_iosel = new IOSelector (*session, _route, true);
262         _input_iosel->redisplay ();
263         input_frame.add (*_input_iosel);
264         input_frame.show_all();
265         
266         // output
267         _output_iosel = new IOSelector (*session, _route, false);
268         _output_iosel->redisplay ();
269         output_frame.add (*_output_iosel);
270         output_frame.show_all();
271 }
272
273 void
274 RouteParams_UI::cleanup_io_frames()
275 {
276         if (_input_iosel) {
277                 _input_iosel->Finished (IOSelector::Cancelled);
278                 input_frame.remove();
279                 delete _input_iosel;
280                 _input_iosel = 0;
281         }
282
283         if (_output_iosel) {
284                 _output_iosel->Finished (IOSelector::Cancelled);
285
286                 output_frame.remove();
287                 delete _output_iosel;
288                 _output_iosel = 0;
289         }
290 }
291
292 void
293 RouteParams_UI::cleanup_pre_view (bool stopupdate)
294 {
295         if (_active_pre_view) {
296                 LadspaPluginUI *   plugui = 0;
297                 
298                 if (stopupdate && (plugui = dynamic_cast<LadspaPluginUI*>(_active_pre_view)) != 0) {
299                           plugui->stop_updating (0);
300                 }
301
302                 _pre_plugin_conn.disconnect();
303                 pre_redir_hpane.remove(*_active_pre_view);
304                 delete _active_pre_view;
305                 _active_pre_view = 0;
306         }
307 }
308
309 void
310 RouteParams_UI::cleanup_post_view (bool stopupdate)
311 {
312         if (_active_post_view) {
313                 LadspaPluginUI *   plugui = 0;
314                 
315                 if (stopupdate && (plugui = dynamic_cast<LadspaPluginUI*>(_active_post_view)) != 0) {
316                           plugui->stop_updating (0);
317                 }
318                 _post_plugin_conn.disconnect();
319                 post_redir_hpane.remove(*_active_post_view);
320                 delete _active_post_view;
321                 _active_post_view = 0;
322         }
323 }
324
325
326 void
327 RouteParams_UI::route_removed (boost::shared_ptr<Route> route)
328 {
329         ENSURE_GUI_THREAD(bind (mem_fun(*this, &RouteParams_UI::route_removed), route));
330
331         TreeModel::Children rows = route_display_model->children();
332         TreeModel::Children::iterator ri;
333
334         for(TreeModel::Children::iterator iter = rows.begin(); iter != rows.end(); ++iter) {
335                 boost::shared_ptr<Route> r =(*iter)[route_display_columns.route];
336
337                 if (r == route) {
338                         route_display_model->erase(iter);
339                         break;
340                 }
341         }
342
343         if (route == _route) {
344                 cleanup_io_frames();
345                 cleanup_pre_view();
346                 cleanup_post_view();
347                 cleanup_redirect_boxes();
348                 
349                 _route.reset ((Route*) 0);
350                 _pre_insert.reset ((Redirect*) 0);
351                 _post_insert.reset ((Redirect*) 0);
352                 update_title();
353         }
354 }
355
356 void
357 RouteParams_UI::set_session (Session *sess)
358 {
359         ArdourDialog::set_session (sess);
360
361         route_display_model->clear();
362
363         if (session) {
364                 boost::shared_ptr<Session::RouteList> r = session->get_routes();
365                 add_routes (*r);
366                 session->GoingAway.connect (mem_fun(*this, &ArdourDialog::session_gone));
367                 session->RouteAdded.connect (mem_fun(*this, &RouteParams_UI::add_routes));
368                 start_updating ();
369         } else {
370                 stop_updating ();
371         }
372
373         //route_select_list.thaw ();
374
375         _plugin_selector->set_session (session);
376 }       
377
378
379 void
380 RouteParams_UI::session_gone ()
381 {
382         ENSURE_GUI_THREAD(mem_fun(*this, &RouteParams_UI::session_gone));
383
384         route_display_model->clear();
385
386         cleanup_io_frames();
387         cleanup_pre_view();
388         cleanup_post_view();
389         cleanup_redirect_boxes();
390
391         _route.reset ((Route*) 0);
392         _pre_insert.reset ((Redirect*) 0);
393         _post_insert.reset ((Redirect*) 0);
394         update_title();
395
396         ArdourDialog::session_gone();
397
398 }
399
400 void
401 RouteParams_UI::route_selected()
402 {
403         Glib::RefPtr<TreeSelection> selection = route_display.get_selection();
404         TreeModel::iterator iter = selection->get_selected(); // only used with Gtk::SELECTION_SINGLE
405         if(iter) {
406                 //If anything is selected
407                 boost::shared_ptr<Route> route = (*iter)[route_display_columns.route] ;
408
409                 if (_route == route) {
410                         // do nothing
411                         return;
412                 }
413
414                 // remove event binding from previously selected
415                 if (_route) {
416                         _route_conn.disconnect();
417                         _route_ds_conn.disconnect();
418                         cleanup_redirect_boxes();
419                         cleanup_pre_view();
420                         cleanup_post_view();
421                         cleanup_io_frames();
422                 }
423
424                 // update the other panes with the correct info
425                 _route = route;
426                 //update_routeinfo (route);
427
428                 setup_io_frames();
429                 setup_redirect_boxes();
430
431                 // bind to redirects changed event for this route
432                 _route_conn = route->inserts_changed.connect (mem_fun(*this, &RouteParams_UI::inserts_changed));
433
434                 track_input_label.set_text (_route->name());
435
436                 update_title();
437         } else {
438                 // no selection
439                 if (_route) {
440                         _route_conn.disconnect();
441
442                         // remove from view
443                         cleanup_io_frames();
444                         cleanup_pre_view();
445                         cleanup_post_view();
446                         cleanup_redirect_boxes();
447
448                         _route.reset ((Route*) 0);
449                         _pre_insert.reset ((Redirect*) 0);
450                         _post_insert.reset ((Redirect *) 0);
451                         track_input_label.set_text(_("NO TRACK"));
452                         update_title();
453                 }
454         }
455 }
456
457 //void
458 //RouteParams_UI::route_unselected (gint row, gint col, GdkEvent *ev)
459 //{
460 //      if (_route) {
461 //              _route_conn.disconnect();
462
463                 // remove from view
464 //              cleanup_io_frames();
465 //              cleanup_pre_view();
466 //              cleanup_post_view();
467 //              cleanup_redirect_boxes();
468                 
469 //              _route.reset ((Route*)0);
470 //              _pre_insert = 0;
471 //              _post_insert = 0;
472 //              track_input_label.set_text(_("NO TRACK"));
473 //              update_title();
474 //      }
475 //}
476
477 void
478 RouteParams_UI::inserts_changed ()
479
480 {
481         ENSURE_GUI_THREAD(mem_fun(*this, &RouteParams_UI::inserts_changed));
482         
483 //      pre_insert_list.freeze ();
484 //      pre_insert_list.clear ();
485 //      post_insert_list.freeze ();
486 //      post_insert_list.clear ();
487 //      if (_route) {
488 //              _route->foreach_redirect (this, &RouteParams_UI::add_redirect_to_display);
489 //      }
490 //      pre_insert_list.thaw ();
491 //      post_insert_list.thaw ();
492
493         cleanup_pre_view();
494         cleanup_post_view();
495         
496         _pre_insert.reset ((Redirect*) 0);
497         _post_insert.reset ((Redirect*) 0);
498         //update_title();
499 }
500
501
502
503 void
504 RouteParams_UI::show_track_menu()
505 {
506         using namespace Menu_Helpers;
507         
508         if (track_menu == 0) {
509                 track_menu = new Menu;
510                 track_menu->set_name ("ArdourContextMenu");
511                 track_menu->items().push_back 
512                                 (MenuElem (_("Add Track/Bus"), 
513                                            bind (mem_fun (*(ARDOUR_UI::instance()), &ARDOUR_UI::add_route), (Gtk::Window*) 0)));
514         }
515         track_menu->popup (1, gtk_get_current_event_time());
516 }
517
518
519
520 void
521 RouteParams_UI::redirect_selected (boost::shared_ptr<ARDOUR::Insert> insert, ARDOUR::Placement place)
522 {
523         if ((place == PreFader && _pre_insert == insert)
524             || (place == PostFader && _post_insert == insert)){
525                 return;
526         }
527         
528         boost::shared_ptr<Send> send;
529         boost::shared_ptr<PluginInsert> plugin_insert;
530         boost::shared_ptr<PortInsert> port_insert;
531         
532         if ((send = boost::dynamic_pointer_cast<Send> (insert)) != 0) {
533
534                 SendUI *send_ui = new SendUI (send, *session);
535
536                 if (place == PreFader) {
537                         cleanup_pre_view();
538                         _pre_plugin_conn = send->GoingAway.connect (bind (mem_fun(*this, &RouteParams_UI::redirect_going_away), insert));
539                         _active_pre_view = send_ui;
540                         
541                         pre_redir_hpane.add2 (*_active_pre_view);
542                         pre_redir_hpane.show_all();
543                 }
544                 else {
545                         cleanup_post_view();
546                         _post_plugin_conn = send->GoingAway.connect (bind (mem_fun(*this, &RouteParams_UI::redirect_going_away), insert));
547                         _active_post_view = send_ui;
548                         
549                         post_redir_hpane.add2 (*_active_post_view);
550                         post_redir_hpane.show_all();
551                 }
552         } else if ((plugin_insert = boost::dynamic_pointer_cast<PluginInsert> (insert)) != 0) {                         
553
554                 LadspaPluginUI *plugin_ui = new LadspaPluginUI (plugin_insert, true);
555
556                 if (place == PreFader) {
557                         cleanup_pre_view();
558                         _pre_plugin_conn = plugin_insert->plugin()->GoingAway.connect (bind (mem_fun(*this, &RouteParams_UI::plugin_going_away), PreFader));
559                         plugin_ui->start_updating (0);
560                         _active_pre_view = plugin_ui;
561                         pre_redir_hpane.pack2 (*_active_pre_view);
562                         pre_redir_hpane.show_all();
563                 }
564                 else {
565                         cleanup_post_view();
566                         _post_plugin_conn = plugin_insert->plugin()->GoingAway.connect (bind (mem_fun(*this, &RouteParams_UI::plugin_going_away), PostFader));
567                         plugin_ui->start_updating (0);
568                         _active_post_view = plugin_ui;
569                         post_redir_hpane.pack2 (*_active_post_view);
570                         post_redir_hpane.show_all();
571                 }
572
573         } else if ((port_insert = boost::dynamic_pointer_cast<PortInsert> (insert)) != 0) {
574
575                 PortInsertUI *portinsert_ui = new PortInsertUI (*session, port_insert);
576                                 
577                 if (place == PreFader) {
578                         cleanup_pre_view();
579                         _pre_plugin_conn = port_insert->GoingAway.connect (bind (mem_fun(*this, &RouteParams_UI::redirect_going_away), insert));
580                         _active_pre_view = portinsert_ui;
581                         pre_redir_hpane.pack2 (*_active_pre_view);
582                         portinsert_ui->redisplay();
583                         pre_redir_hpane.show_all();
584                 }
585                 else {
586                         cleanup_post_view();
587                         _post_plugin_conn = port_insert->GoingAway.connect (bind (mem_fun(*this, &RouteParams_UI::redirect_going_away), insert));
588                         _active_post_view = portinsert_ui;
589                         post_redir_hpane.pack2 (*_active_post_view);
590                         portinsert_ui->redisplay();
591                         post_redir_hpane.show_all();
592                 }
593         }
594                                 
595         if (place == PreFader) {
596                 _pre_insert = insert;
597         } else {
598                 _post_insert = insert;
599         }
600         
601         update_title();
602                 
603 }
604
605 void
606 RouteParams_UI::plugin_going_away (Placement place)
607 {
608         ENSURE_GUI_THREAD(bind (mem_fun(*this, &RouteParams_UI::plugin_going_away), place));
609         
610         // delete the current view without calling finish
611
612         if (place == PreFader) {
613                 cleanup_pre_view (false);
614                 _pre_insert.reset ((Redirect*) 0);
615         }
616         else {
617                 cleanup_post_view (false);
618                 _post_insert.reset ((Redirect*) 0);
619         }
620 }
621
622 void
623 RouteParams_UI::redirect_going_away (boost::shared_ptr<ARDOUR::Insert> insert)
624
625 {
626         ENSURE_GUI_THREAD(bind (mem_fun(*this, &RouteParams_UI::redirect_going_away), insert));
627         
628         printf ("redirect going away\n");
629         // delete the current view without calling finish
630         if (insert == _pre_insert) {
631                 cleanup_pre_view (false);
632                 _pre_insert.reset ((Redirect*) 0);
633         } else if (insert == _post_insert) {
634                 cleanup_post_view (false);
635                 _post_insert.reset ((Redirect*) 0);
636         }
637 }
638
639
640 void
641 RouteParams_UI::update_title ()
642 {
643         WindowTitle title(Glib::get_application_name());
644         title += _("Track/Bus Inspector");
645
646         if (_route) {
647
648                 //              title += ": ";
649
650                 //              if (_redirect && (_current_view == PLUGIN_CONFIG_VIEW || _current_view == SEND_CONFIG_VIEW)) {
651                 //                      title += _redirect->name();
652                 //              }
653                 //              else if (_current_view == INPUT_CONFIG_VIEW) {
654                 //                      title += _("INPUT");
655                 //              }
656                 //              else if (_current_view == OUTPUT_CONFIG_VIEW) {
657                 //                      title += _("OUTPUT");
658                 //              }
659
660                 title_label.set_text(_route->name());
661                 
662                 title += _route->name();
663
664                 set_title(title.get_string());
665         }
666         else {
667                 title_label.set_text(_("No Route Selected"));
668                 title += _("No Route Selected");
669                 set_title(title.get_string());
670         }       
671 }
672
673
674 void
675 RouteParams_UI::start_updating ()
676 {
677         update_connection = ARDOUR_UI::instance()->RapidScreenUpdate.connect 
678                 (mem_fun(*this, &RouteParams_UI::update_views));
679 }
680
681 void
682 RouteParams_UI::stop_updating ()
683 {
684         update_connection.disconnect();
685 }
686
687 void
688 RouteParams_UI::update_views ()
689 {
690         SendUI *sui;
691         // TODO: only do it if correct tab is showing
692         
693         if ((sui = dynamic_cast<SendUI*> (_active_pre_view)) != 0) {
694                 sui->update ();
695         }
696         if ((sui = dynamic_cast<SendUI*> (_active_post_view)) != 0) {
697                 sui->update ();
698         }
699
700 }