VCA/Control Masters have no signal, so output i/o options are irrelevant when adding...
[ardour.git] / gtk2_ardour / add_route_dialog.cc
1 /*
2   Copyright (C) 2003 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 <cstdio>
21 #include <cmath>
22
23 #include <sigc++/bind.h>
24 #include <gtkmm/stock.h>
25 #include <gtkmm/messagedialog.h>
26 #include <gtkmm/separator.h>
27 #include <gtkmm/table.h>
28
29 #include "pbd/error.h"
30 #include "pbd/convert.h"
31
32 #include "gtkmm2ext/utils.h"
33 #include "gtkmm2ext/doi.h"
34
35 #include "ardour/plugin_manager.h"
36 #include "ardour/profile.h"
37 #include "ardour/template_utils.h"
38 #include "ardour/route_group.h"
39 #include "ardour/session.h"
40 #include "ardour/vca.h"
41
42 #include "utils.h"
43 #include "add_route_dialog.h"
44 #include "route_group_dialog.h"
45 #include "tooltips.h"
46 #include "i18n.h"
47
48 using namespace Gtk;
49 using namespace Gtkmm2ext;
50 using namespace std;
51 using namespace PBD;
52 using namespace ARDOUR;
53 using namespace ARDOUR_UI_UTILS;
54
55 std::vector<std::string> AddRouteDialog::channel_combo_strings;
56
57 AddRouteDialog::AddRouteDialog ()
58         : ArdourDialog (_("Add Track/Bus/VCA"))
59         , routes_adjustment (1, 1, 128, 1, 4)
60         , routes_spinner (routes_adjustment)
61         , configuration_label (_("Configuration:"))
62         , mode_label (_("Record Mode:"))
63         , instrument_label (_("Instrument:"))
64 {
65         set_name ("AddRouteDialog");
66         set_skip_taskbar_hint (true);
67         set_resizable (false);
68         set_position (WIN_POS_MOUSE);
69
70         name_template_entry.set_name (X_("AddRouteDialogNameTemplateEntry"));
71         // routes_spinner.set_name (X_("AddRouteDialogSpinner"));
72         channel_combo.set_name (X_("ChannelCountSelector"));
73         mode_combo.set_name (X_("ChannelCountSelector"));
74
75         refill_track_modes ();
76
77         track_bus_combo.append_text (_("Audio Tracks"));
78         track_bus_combo.append_text (_("MIDI Tracks"));
79         track_bus_combo.append_text (_("Audio+MIDI Tracks"));
80         track_bus_combo.append_text (_("Audio Busses"));
81         track_bus_combo.append_text (_("MIDI Busses"));
82         track_bus_combo.append_text (_("VCA Masters"));
83         track_bus_combo.set_active (0);
84
85         insert_at_combo.append_text (_("First"));
86         insert_at_combo.append_text (_("Before Selection"));
87         insert_at_combo.append_text (_("After Selection"));
88         insert_at_combo.append_text (_("Last"));
89         insert_at_combo.set_active (3);
90
91         strict_io_combo.append_text (_("Flexible-I/O"));
92         strict_io_combo.append_text (_("Strict-I/O"));
93         strict_io_combo.set_active (Config->get_strict_io () ? 1 : 0);
94
95         VBox* vbox = manage (new VBox);
96         Gtk::Label* l;
97
98         get_vbox()->set_spacing (4);
99
100         vbox->set_spacing (18);
101         vbox->set_border_width (5);
102
103         HBox *type_hbox = manage (new HBox);
104         type_hbox->set_spacing (6);
105
106         /* track/bus choice */
107
108         type_hbox->pack_start (*manage (new Label (_("Add:"))));
109         type_hbox->pack_start (routes_spinner);
110         type_hbox->pack_start (track_bus_combo);
111
112         vbox->pack_start (*type_hbox, false, true);
113
114         VBox* options_box = manage (new VBox);
115         Table *table2 = manage (new Table (3, 3, false));
116
117         options_box->set_spacing (6);
118         table2->set_row_spacings (6);
119         table2->set_col_spacing (1, 6);
120
121         l = manage (new Label (_("<b>Options</b>"), Gtk::ALIGN_LEFT, Gtk::ALIGN_CENTER, false));
122         l->set_use_markup ();
123         options_box->pack_start (*l, false, true);
124
125         l = manage (new Label ("", Gtk::ALIGN_LEFT, Gtk::ALIGN_CENTER, false));
126         l->set_padding (8, 0);
127         table2->attach (*l, 0, 1, 0, 3, Gtk::FILL, Gtk::FILL, 0, 0);
128
129         int n = 0;
130
131         l = manage (new Label (_("Name:"), Gtk::ALIGN_LEFT, Gtk::ALIGN_CENTER, false));
132         table2->attach (*l, 1, 2, n, n + 1, Gtk::FILL, Gtk::EXPAND, 0, 0);
133         table2->attach (name_template_entry, 2, 3, n, n + 1, Gtk::FILL, Gtk::EXPAND | Gtk::FILL, 0, 0);
134         ++n;
135
136         /* Route configuration */
137
138         configuration_label.set_alignment (Gtk::ALIGN_LEFT, Gtk::ALIGN_CENTER);
139         table2->attach (configuration_label, 1, 2, n, n + 1, Gtk::FILL, Gtk::EXPAND, 0, 0);
140         table2->attach (channel_combo, 2, 3, n, n + 1, Gtk::FILL, Gtk::EXPAND | Gtk::FILL, 0, 0);
141         ++n;
142
143         mode_label.set_alignment (Gtk::ALIGN_LEFT, Gtk::ALIGN_CENTER);
144         table2->attach (mode_label, 1, 2, n, n + 1, Gtk::FILL, Gtk::EXPAND, 0, 0);
145         table2->attach (mode_combo, 2, 3, n, n + 1, Gtk::FILL, Gtk::EXPAND | Gtk::FILL, 0, 0);
146         ++n;
147
148         instrument_label.set_alignment (Gtk::ALIGN_LEFT, Gtk::ALIGN_CENTER);
149         table2->attach (instrument_label, 1, 2, n, n + 1, Gtk::FILL, Gtk::EXPAND, 0, 0);
150         table2->attach (instrument_combo, 2, 3, n, n + 1, Gtk::FILL, Gtk::EXPAND | Gtk::FILL, 0, 0);
151         ++n;
152
153         /* Group choice */
154
155         l = manage (new Label (_("Group:"), Gtk::ALIGN_LEFT, Gtk::ALIGN_CENTER, false));
156         table2->attach (*l, 1, 2, n, n + 1, Gtk::FILL, Gtk::EXPAND, 0, 0);
157         table2->attach (route_group_combo, 2, 3, n, n + 1, Gtk::FILL, Gtk::EXPAND | Gtk::FILL, 0, 0);
158         ++n;
159
160         /* New route will be inserted at.. */
161         l = manage (new Label (_("Insert:"), Gtk::ALIGN_LEFT, Gtk::ALIGN_CENTER, false));
162         table2->attach (*l, 1, 2, n, n + 1, Gtk::FILL, Gtk::EXPAND, 0, 0);
163         table2->attach (insert_at_combo, 2, 3, n, n + 1, Gtk::FILL, Gtk::EXPAND | Gtk::FILL, 0, 0);
164         ++n;
165
166         /* New Route's Routing is.. */
167
168         if (Profile->get_mixbus ()) {
169                 strict_io_combo.set_active (1);
170         } else {
171                 l = manage (new Label (_("Output Ports:"), Gtk::ALIGN_LEFT, Gtk::ALIGN_CENTER, false));
172                 table2->attach (*l, 1, 2, n, n + 1, Gtk::FILL, Gtk::EXPAND, 0, 0);
173                 table2->attach (strict_io_combo, 2, 3, n, n + 1, Gtk::FILL, Gtk::EXPAND | Gtk::FILL, 0, 0);
174
175                 ARDOUR_UI_UTILS::set_tooltip (strict_io_combo,
176                                 _("With strict-i/o enabled, Effect Processors will not modify the number of channels on a track. The number of output channels will always match the number of input channels."));
177                 ++n;
178         }
179
180         options_box->pack_start (*table2, false, true);
181         vbox->pack_start (*options_box, false, true);
182
183         get_vbox()->pack_start (*vbox, false, false);
184
185         track_bus_combo.signal_changed().connect (sigc::mem_fun (*this, &AddRouteDialog::track_type_chosen));
186         channel_combo.signal_changed().connect (sigc::mem_fun (*this, &AddRouteDialog::channel_combo_changed));
187         channel_combo.set_row_separator_func (sigc::mem_fun (*this, &AddRouteDialog::channel_separator));
188         route_group_combo.set_row_separator_func (sigc::mem_fun (*this, &AddRouteDialog::route_separator));
189         route_group_combo.signal_changed ().connect (sigc::mem_fun (*this, &AddRouteDialog::group_changed));
190
191         show_all_children ();
192
193         /* track template info will be managed whenever
194            this dialog is shown, via ::on_show()
195         */
196
197         add_button (Stock::CANCEL, RESPONSE_CANCEL);
198         add_button (Stock::ADD, RESPONSE_ACCEPT);
199         set_response_sensitive (RESPONSE_ACCEPT, true);
200         set_default_response (RESPONSE_ACCEPT);
201
202         track_type_chosen ();
203 }
204
205 AddRouteDialog::~AddRouteDialog ()
206 {
207 }
208
209 void
210 AddRouteDialog::channel_combo_changed ()
211 {
212         maybe_update_name_template_entry ();
213         refill_track_modes ();
214 }
215
216 AddRouteDialog::TypeWanted
217 AddRouteDialog::type_wanted() const
218 {
219         std::string str = track_bus_combo.get_active_text();
220         if (str == _("Audio Busses")) {
221                 return AudioBus;
222         } else if (str == _("MIDI Busses")){
223                 return MidiBus;
224         } else if (str == _("MIDI Tracks")){
225                 return MidiTrack;
226         } else if (str == _("Audio+MIDI Tracks")) {
227                 return MixedTrack;
228         } else if (str == _("Audio Tracks")) {
229                 return AudioTrack;
230         } else {
231                 return VCAMaster;
232         }
233 }
234
235 void
236 AddRouteDialog::maybe_update_name_template_entry ()
237 {
238         switch (type_wanted()) {
239         case AudioTrack:
240                 name_template_entry.set_text (_("Audio"));
241                 break;
242         case MidiTrack:
243                 name_template_entry.set_text (_("MIDI"));
244                 break;
245         case MixedTrack:
246                 name_template_entry.set_text (_("Audio+MIDI"));
247                 break;
248         case AudioBus:
249         case MidiBus:
250                 name_template_entry.set_text (_("Bus"));
251                 break;
252         case VCAMaster:
253                 name_template_entry.set_text (VCA::default_name_template());
254                 break;
255         }
256 }
257
258 void
259 AddRouteDialog::track_type_chosen ()
260 {
261         switch (type_wanted()) {
262         case AudioTrack:
263                 mode_combo.set_sensitive (true);
264                 channel_combo.set_sensitive (true);
265                 instrument_combo.set_sensitive (false);
266                 configuration_label.set_sensitive (true);
267                 mode_label.set_sensitive (true);
268                 instrument_label.set_sensitive (false);
269                 route_group_combo.set_sensitive (true);
270                 strict_io_combo.set_sensitive (true);
271                 break;
272         case MidiTrack:
273                 channel_combo.set_sensitive (false);
274                 mode_combo.set_sensitive (false);
275                 instrument_combo.set_sensitive (true);
276                 configuration_label.set_sensitive (false);
277                 mode_label.set_sensitive (false);
278                 instrument_label.set_sensitive (true);
279                 route_group_combo.set_sensitive (true);
280                 strict_io_combo.set_sensitive (true);
281                 break;
282         case MixedTrack:
283                 {
284                         MessageDialog msg (_("Audio+MIDI tracks are intended for use <b>ONLY</b> with plugins that use both audio and MIDI input data\n\n"
285                                              "If you do not plan to use such a plugin, then use a normal audio or MIDI track instead."),
286                                            true, MESSAGE_INFO, BUTTONS_OK, true);
287                         msg.set_position (WIN_POS_MOUSE);
288                         msg.run ();
289                 }
290                 channel_combo.set_sensitive (true);
291                 mode_combo.set_sensitive (true);
292                 instrument_combo.set_sensitive (true);
293                 configuration_label.set_sensitive (true);
294                 mode_label.set_sensitive (true);
295                 instrument_label.set_sensitive (true);
296                 route_group_combo.set_sensitive (true);
297                 strict_io_combo.set_sensitive (true);
298                 break;
299         case AudioBus:
300                 mode_combo.set_sensitive (false);
301                 channel_combo.set_sensitive (true);
302                 instrument_combo.set_sensitive (false);
303                 configuration_label.set_sensitive (true);
304                 mode_label.set_sensitive (true);
305                 instrument_label.set_sensitive (false);
306                 route_group_combo.set_sensitive (true);
307                 strict_io_combo.set_sensitive (true);
308                 break;
309         case VCAMaster:
310                 mode_combo.set_sensitive (false);
311                 channel_combo.set_sensitive (false);
312                 instrument_combo.set_sensitive (false);
313                 configuration_label.set_sensitive (false);
314                 mode_label.set_sensitive (false);
315                 instrument_label.set_sensitive (false);
316                 route_group_combo.set_sensitive (false);
317                 strict_io_combo.set_sensitive (false);
318                 break;
319         case MidiBus:
320                 mode_combo.set_sensitive (false);
321                 channel_combo.set_sensitive (false);
322                 instrument_combo.set_sensitive (true);
323                 configuration_label.set_sensitive (false);
324                 mode_label.set_sensitive (true);
325                 instrument_label.set_sensitive (true);
326                 strict_io_combo.set_sensitive (true);
327                 break;
328         }
329
330         maybe_update_name_template_entry ();
331 }
332
333
334 string
335 AddRouteDialog::name_template () const
336 {
337         return name_template_entry.get_text ();
338 }
339
340 bool
341 AddRouteDialog::name_template_is_default() const
342 {
343         string n = name_template();
344
345         if (n == _("Audio") ||
346             n == _("MIDI") ||
347             n == _("Audio+MIDI") ||
348             n == _("Bus") ||
349             n == VCA::default_name_template()) {
350                 return true;
351         }
352
353         return false;
354 }
355
356 int
357 AddRouteDialog::count ()
358 {
359         return (int) floor (routes_adjustment.get_value ());
360 }
361
362 void
363 AddRouteDialog::refill_track_modes ()
364 {
365         vector<string> s;
366
367         s.push_back (_("Normal"));
368         s.push_back (_("Non Layered"));
369         s.push_back (_("Tape"));
370
371         set_popdown_strings (mode_combo, s);
372         mode_combo.set_active_text (s.front());
373 }
374
375 ARDOUR::TrackMode
376 AddRouteDialog::mode ()
377 {
378         std::string str = mode_combo.get_active_text();
379         if (str == _("Normal")) {
380                 return ARDOUR::Normal;
381         } else if (str == _("Non Layered")){
382                 return ARDOUR::NonLayered;
383         } else if (str == _("Tape")) {
384                 return ARDOUR::Destructive;
385         } else {
386                 fatal << string_compose (X_("programming error: unknown track mode in add route dialog combo = %1"), str)
387                       << endmsg;
388                 abort(); /*NOTREACHED*/
389         }
390         /* keep gcc happy */
391         return ARDOUR::Normal;
392 }
393
394 ChanCount
395 AddRouteDialog::channels ()
396 {
397         ChanCount ret;
398         string str;
399         switch (type_wanted()) {
400         case AudioTrack:
401         case AudioBus:
402                 str = channel_combo.get_active_text();
403                 for (ChannelSetups::iterator i = channel_setups.begin(); i != channel_setups.end(); ++i) {
404                         if (str == (*i).name) {
405                                 ret.set (DataType::AUDIO, (*i).channels);
406                                 break;
407                         }
408                 }
409                 ret.set (DataType::MIDI, 0);
410                 break;
411
412         case MidiBus:
413         case MidiTrack:
414                 ret.set (DataType::AUDIO, 0);
415                 ret.set (DataType::MIDI, 1);
416                 break;
417
418         case MixedTrack:
419                 str = channel_combo.get_active_text();
420                 for (ChannelSetups::iterator i = channel_setups.begin(); i != channel_setups.end(); ++i) {
421                         if (str == (*i).name) {
422                                 ret.set (DataType::AUDIO, (*i).channels);
423                                 break;
424                         }
425                 }
426                 ret.set (DataType::MIDI, 1);
427                 break;
428         default:
429                 break;
430         }
431
432         return ret;
433 }
434
435 string
436 AddRouteDialog::track_template ()
437 {
438         string str = channel_combo.get_active_text();
439
440         for (ChannelSetups::iterator i = channel_setups.begin(); i != channel_setups.end(); ++i) {
441                 if (str == (*i).name) {
442                         return (*i).template_path;
443                 }
444         }
445
446         return string();
447 }
448
449 void
450 AddRouteDialog::on_show ()
451 {
452         refill_channel_setups ();
453         refill_route_groups ();
454
455         Dialog::on_show ();
456 }
457
458 void
459 AddRouteDialog::refill_channel_setups ()
460 {
461         ChannelSetup chn;
462
463         route_templates.clear ();
464
465         string channel_current_choice = channel_combo.get_active_text();
466
467         channel_combo_strings.clear ();
468         channel_setups.clear ();
469
470         chn.name = _("Mono");
471         chn.channels = 1;
472         channel_setups.push_back (chn);
473
474         chn.name = _("Stereo");
475         chn.channels = 2;
476         channel_setups.push_back (chn);
477
478         chn.name = "separator";
479         channel_setups.push_back (chn);
480
481         ARDOUR::find_route_templates (route_templates);
482
483         if (!route_templates.empty()) {
484                 vector<string> v;
485                 for (vector<TemplateInfo>::iterator x = route_templates.begin(); x != route_templates.end(); ++x) {
486                         chn.name = x->name;
487                         chn.channels = 0;
488                         chn.template_path = x->path;
489                         channel_setups.push_back (chn);
490                 }
491         }
492
493         /* clear template path for the rest */
494
495         chn.template_path = "";
496
497         chn.name = _("3 Channel");
498         chn.channels = 3;
499         channel_setups.push_back (chn);
500
501         chn.name = _("4 Channel");
502         chn.channels = 4;
503         channel_setups.push_back (chn);
504
505         chn.name = _("5 Channel");
506         chn.channels = 5;
507         channel_setups.push_back (chn);
508
509         chn.name = _("6 Channel");
510         chn.channels = 6;
511         channel_setups.push_back (chn);
512
513         chn.name = _("8 Channel");
514         chn.channels = 8;
515         channel_setups.push_back (chn);
516
517         chn.name = _("12 Channel");
518         chn.channels = 12;
519         channel_setups.push_back (chn);
520
521         chn.name = _("Custom");
522         chn.channels = 0;
523         channel_setups.push_back (chn);
524
525         for (ChannelSetups::iterator i = channel_setups.begin(); i != channel_setups.end(); ++i) {
526                 channel_combo_strings.push_back ((*i).name);
527         }
528
529         set_popdown_strings (channel_combo, channel_combo_strings);
530
531         if (!channel_current_choice.empty()) {
532                 channel_combo.set_active_text (channel_current_choice);
533         } else {
534                 channel_combo.set_active_text (channel_combo_strings.front());
535         }
536 }
537
538 void
539 AddRouteDialog::add_route_group (RouteGroup* g)
540 {
541         route_group_combo.insert_text (3, g->name ());
542 }
543
544 RouteGroup*
545 AddRouteDialog::route_group ()
546 {
547         if (!_session || route_group_combo.get_active_row_number () == 2) {
548                 return 0;
549         }
550
551         return _session->route_group_by_name (route_group_combo.get_active_text());
552 }
553
554 bool
555 AddRouteDialog::use_strict_io() {
556         return strict_io_combo.get_active_row_number () == 1;
557 }
558
559 void
560 AddRouteDialog::refill_route_groups ()
561 {
562         route_group_combo.clear ();
563         route_group_combo.append_text (_("New Group..."));
564
565         route_group_combo.append_text ("separator");
566
567         route_group_combo.append_text (_("No Group"));
568
569         if (_session) {
570                 _session->foreach_route_group (sigc::mem_fun (*this, &AddRouteDialog::add_route_group));
571         }
572
573         route_group_combo.set_active (2);
574 }
575
576 void
577 AddRouteDialog::group_changed ()
578 {
579         if (_session && route_group_combo.get_active_text () == _("New Group...")) {
580                 RouteGroup* g = new RouteGroup (*_session, "");
581                 RouteGroupDialog* d = new RouteGroupDialog (g, true);
582
583                 d->signal_response().connect (sigc::bind (sigc::mem_fun (*this, &AddRouteDialog::new_group_dialog_finished), d));
584                 d->present();
585         }
586 }
587
588 void
589 AddRouteDialog::new_group_dialog_finished (int r, RouteGroupDialog* d)
590 {
591         if (r == RESPONSE_OK) {
592
593                 if (!d->name_check()) {
594                         return;
595                 }
596
597                 if (_session) {
598                         _session->add_route_group (d->group());
599                 }
600
601                 add_route_group (d->group());
602                 route_group_combo.set_active (3);
603         } else {
604                 delete d->group ();
605                 route_group_combo.set_active (2);
606         }
607
608         delete_when_idle (d);
609 }
610
611 AddRouteDialog::InsertAt
612 AddRouteDialog::insert_at ()
613 {
614         std::string str = insert_at_combo.get_active_text();
615
616         if (str == _("First")) {
617                 return First;
618         } else if (str == _("After Selection")) {
619                 return AfterSelection;
620         } else if (str == _("Before Selection")){
621                 return BeforeSelection;
622         }
623         return Last;
624 }
625
626 bool
627 AddRouteDialog::channel_separator (const Glib::RefPtr<Gtk::TreeModel> &, const Gtk::TreeModel::iterator &i)
628 {
629         channel_combo.set_active (i);
630
631         return channel_combo.get_active_text () == "separator";
632 }
633
634 bool
635 AddRouteDialog::route_separator (const Glib::RefPtr<Gtk::TreeModel> &, const Gtk::TreeModel::iterator &i)
636 {
637         route_group_combo.set_active (i);
638
639         return route_group_combo.get_active_text () == "separator";
640 }
641
642 PluginInfoPtr
643 AddRouteDialog::requested_instrument ()
644 {
645         return instrument_combo.selected_instrument();
646 }