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