notably modify the design and logic of the startup dialog, so that we can handle...
[ardour.git] / gtk2_ardour / startup.cc
index 37e62ca04f72d1272d9389c99f55bf639e9bbf14..6fc68ea1e41a03c440d54c4e48e196ed5737fd28 100644 (file)
@@ -29,7 +29,6 @@
 
 #include "pbd/failed_constructor.h"
 #include "pbd/file_utils.h"
-#include "pbd/filesystem.h"
 #include "pbd/replace_all.h"
 #include "pbd/whitespace.h"
 
@@ -38,7 +37,9 @@
 #include "ardour/session.h"
 #include "ardour/session_state_utils.h"
 #include "ardour/template_utils.h"
+#include "ardour/filename_extensions.h"
 
+#include "ardour_ui.h"
 #include "startup.h"
 #include "opts.h"
 #include "engine_dialog.h"
@@ -62,110 +63,112 @@ static string poor_mans_glob (string path)
 }
 
 
-ArdourStartup::ArdourStartup ()
+ArdourStartup::ArdourStartup (bool require_new, const std::string& session_name, const std::string& session_path, const std::string& template_name)
        : _response (RESPONSE_OK)
-       , ic_new_session_button (_("Open a new session"))
+       , config_modified (false)
+       , new_only (require_new)
+       , default_dir_chooser (0)
+       , ic_new_session_button (_("Create a new session"))
        , ic_existing_session_button (_("Open an existing session"))
        , monitor_via_hardware_button (_("Use an external mixer or the hardware mixer of your audio interface.\n\
 Ardour will play NO role in monitoring"))
-       , monitor_via_ardour_button (string_compose (_("Ask %1 to playback material as it is being recorded"), PROGRAM_NAME))
+       , monitor_via_ardour_button (string_compose (_("Ask %1 to play back material as it is being recorded"), PROGRAM_NAME))
+       , engine_dialog (0)
        , new_folder_chooser (FILE_CHOOSER_ACTION_SELECT_FOLDER)
        , more_new_session_options_button (_("I'd like more options for this session"))
        , _output_limit_count_adj (1, 0, 100, 1, 10, 0)
        , _input_limit_count_adj (1, 0, 100, 1, 10, 0)
        , _master_bus_channel_count_adj (2, 0, 100, 1, 10, 0)
+       , audio_page_index (-1)
+       , new_user_page_index (-1)
+       , default_folder_page_index (-1)
+       , monitoring_page_index (-1)
+       , session_page_index (-1)
+       , initial_choice_index (-1)
+       , final_page_index (-1)
+       , session_options_page_index (-1)
        , _existing_session_chooser_used (false)
 {
-       audio_page_index = -1;
-       initial_choice_index = -1;
-       new_user_page_index = -1;
-       default_folder_page_index = -1;
-       monitoring_page_index = -1;
-       session_page_index = -1;
-       final_page_index = -1;
-       session_options_page_index = -1;
-       new_only = false;
-
-       engine_dialog = 0;
-       config_modified = false;
-       default_dir_chooser = 0;
-
-       use_template_button.set_group (session_template_group);
-       use_session_as_template_button.set_group (session_template_group);
-
-       set_keep_above (true);
-       set_resizable (false);
-       set_position (WIN_POS_CENTER);
-       set_border_width (12);
-
-       if ((icon_pixbuf = ::get_icon ("ardour_icon_48px")) == 0) {
-               throw failed_constructor();
-       }
-
-       list<Glib::RefPtr<Gdk::Pixbuf> > window_icons;
-       Glib::RefPtr<Gdk::Pixbuf> icon;
-
-       if ((icon = ::get_icon ("ardour_icon_16px")) != 0) {
-               window_icons.push_back (icon);
-       }
-       if ((icon = ::get_icon ("ardour_icon_22px")) != 0) {
-               window_icons.push_back (icon);
-       }
-       if ((icon = ::get_icon ("ardour_icon_32px")) != 0) {
-               window_icons.push_back (icon);
-       }
-       if ((icon = ::get_icon ("ardour_icon_48px")) != 0) {
-               window_icons.push_back (icon);
-       }
-       if (!window_icons.empty ()) {
-               set_default_icon_list (window_icons);
-       }
-
-       sys::path been_here_before = user_config_directory();
-       been_here_before /= ".a3"; // XXXX use more specific version so we can catch upgrades
-       new_user = !exists (been_here_before);
+       new_user = !Glib::file_test (been_here_before_path(), Glib::FILE_TEST_EXISTS);
+       need_audio_setup = EngineControl::need_setup ();
+       need_session_info = (session_name.empty() || require_new);
 
-       bool need_audio_setup = !EngineControl::engine_running();
+       _provided_session_name = session_name;
+       _provided_session_path = session_path;
+       
+       if (need_audio_setup || need_session_info || new_user) {
 
-        setup_alpha_page ();
-
-       if (new_user) {
-
-               /* Create the config directory so that we have somewhere to put the
-                  been_here_before file.
-               */
-               try {
-                       sys::create_directories (user_config_directory ());
+               use_template_button.set_group (session_template_group);
+               use_session_as_template_button.set_group (session_template_group);
+               
+               set_keep_above (true);
+               set_position (WIN_POS_CENTER);
+               set_border_width (12);
+               
+               if ((icon_pixbuf = ::get_icon ("ardour_icon_48px")) == 0) {
+                       throw failed_constructor();
+               }
+               
+               list<Glib::RefPtr<Gdk::Pixbuf> > window_icons;
+               Glib::RefPtr<Gdk::Pixbuf> icon;
+               
+               if ((icon = ::get_icon ("ardour_icon_16px")) != 0) {
+                       window_icons.push_back (icon);
                }
-               catch (const sys::filesystem_error& ex) {
-                       error << "Could not create user configuration directory" << endmsg;
+               if ((icon = ::get_icon ("ardour_icon_22px")) != 0) {
+                       window_icons.push_back (icon);
                }
+               if ((icon = ::get_icon ("ardour_icon_32px")) != 0) {
+                       window_icons.push_back (icon);
+               }
+               if ((icon = ::get_icon ("ardour_icon_48px")) != 0) {
+                       window_icons.push_back (icon);
+               }
+               if (!window_icons.empty ()) {
+                       set_default_icon_list (window_icons);
+               }
+               
+               // setup_prerelease_page ();
                
-               /* "touch" the file */
-               ofstream fout (been_here_before.to_string().c_str());
-               setup_new_user_page ();
-               setup_first_time_config_page ();
-               setup_monitoring_choice_page ();
-               setup_monitor_section_choice_page ();
-
-               if (need_audio_setup) {
-                       setup_audio_page ();
+               if (new_user) {
+                       
+                       setup_new_user_page ();
+                       setup_first_time_config_page ();
+                       setup_monitoring_choice_page ();
+                       setup_monitor_section_choice_page ();
+                       
+                       if (need_audio_setup) {
+                               setup_audio_page ();
+                       }
+                       
+                       ic_new_session_button.set_active (true); // always create new session on first run
+                       
+               } else {
+                       
+                       if (need_audio_setup) {
+                               setup_audio_page ();
+                       }
+                       
+                       setup_initial_choice_page ();
                }
 
-       } else {
-
-               if (need_audio_setup) {
-                       setup_audio_page ();
+               setup_session_page ();
+               setup_more_options_page ();
+               
+               if (new_user) {
+                       setup_final_page ();
                }
 
-               setup_initial_choice_page ();
-       }
-
-       setup_session_page ();
-       setup_more_options_page ();
+               if (new_only) {
+                       ic_vbox.hide ();
+               } else {
+                       ic_vbox.show ();
+               }
 
-       if (new_user) {
-               setup_final_page ();
+               if (!template_name.empty()) {
+                       use_template_button.set_active (false);
+                       load_template_override = template_name;
+               }
        }
 
        the_startup = this;
@@ -175,13 +178,19 @@ ArdourStartup::~ArdourStartup ()
 {
 }
 
+bool
+ArdourStartup::ready_without_display () const
+{
+       return !new_user && !need_audio_setup && !need_session_info;
+}
+
 void
-ArdourStartup::setup_alpha_page ()
+ArdourStartup::setup_prerelease_page ()
 {
         VBox* vbox = manage (new VBox);
         Label* label = manage (new Label);
-        label->set_markup (_("<b>Welcome to this ALPHA release of Ardour 3.0</b>\n\n\
-There are still many issues and bugs to be worked on,\n\
+        label->set_markup (_("<b>Welcome to this BETA release of Ardour 3.0</b>\n\n\
+There are still several issues and bugs to be worked on,\n\
 as well as general workflow improvements, before this can be considered\n\
 release software. So, a few guidelines:\n\
 \n\
@@ -190,7 +199,7 @@ release software. So, a few guidelines:\n\
 2) Please see http://ardour.org/a3_features for a guide to new features.\n\
 3) <b>Please do NOT use the forums at ardour.org to report issues</b>.\n\
 4) Please <b>DO</b> use the bugtracker at http://tracker.ardour.org/ to report issues\n\
-   making sure to note the product version number as 3.0-alpha.\n\
+   making sure to note the product version number as 3.0-beta.\n\
 5) Please <b>DO</b> use the ardour-users mailing list to discuss ideas and pass on comments.\n\
 6) Please <b>DO</b> join us on IRC for real time discussions about ardour3. You\n\
    can get there directly from Ardour via the Help->Chat menu option.\n\
@@ -206,29 +215,10 @@ Full information on all the above can be found on the support page at\n\
 
         append_page (*vbox);
         set_page_type (*vbox, ASSISTANT_PAGE_CONTENT);
-        set_page_title (*vbox, _("This is an ALPHA RELEASE"));
+        set_page_title (*vbox, _("This is a BETA RELEASE"));
        set_page_complete (*vbox, true);
 }
 
-void
-ArdourStartup::set_new_only (bool yn)
-{
-       new_only = yn;
-
-       if (new_only) {
-               ic_vbox.hide ();
-       } else {
-               ic_vbox.show ();
-       }
-}
-
-void
-ArdourStartup::set_load_template (string load_template)
-{
-       use_template_button.set_active (false);
-       load_template_override = load_template;
-}
-
 bool
 ArdourStartup::use_session_template ()
 {
@@ -247,8 +237,8 @@ std::string
 ArdourStartup::session_template_name ()
 {
        if (!load_template_override.empty()) {
-               string the_path = (ARDOUR::user_template_directory()/ (load_template_override + ".template")).to_string();
-               return the_path;
+               string the_path (ARDOUR::user_template_directory());
+               return Glib::build_filename (the_path, load_template_override + ARDOUR::template_suffix);
        }
 
        if (ic_existing_session_button.get_active()) {
@@ -269,6 +259,10 @@ ArdourStartup::session_template_name ()
 std::string
 ArdourStartup::session_name (bool& should_be_new)
 {
+       if (ready_without_display()) {
+               return _provided_session_name;
+       }
+
        if (ic_new_session_button.get_active()) {
                should_be_new = true;
                string val = new_name_entry.get_text ();
@@ -295,6 +289,10 @@ ArdourStartup::session_name (bool& should_be_new)
 std::string
 ArdourStartup::session_folder ()
 {
+       if (ready_without_display()) {
+               return _provided_session_path;
+       }
+
        if (ic_new_session_button.get_active()) {
                std::string legal_session_folder_name = legalize_for_path (new_name_entry.get_text());
                return Glib::build_filename (new_folder_chooser.get_current_folder(), legal_session_folder_name);
@@ -336,14 +334,16 @@ ArdourStartup::setup_new_user_page ()
        Label* foomatic = manage (new Label);
 
        foomatic->set_markup (string_compose (_("\
-<span size=\"larger\">%1 is a digital audio workstation. You can use it to\n\
-record, edit and mix multi-track audio. You can produce your\n\
-own CDs, mix video soundtracks, or just experiment with new\n\
-ideas about music and sound.\n\
-\n\
-There are a few things that need to configured before you start\n\
-using the program.</span>\
+<span size=\"larger\">%1 is a digital audio workstation. You can use it to \
+record, edit and mix multi-track audio. You can produce your \
+own CDs, mix video soundtracks, or experiment with new \
+ideas about music and sound. \
+\n\n\
+There are a few things that need to be configured before you start \
+using the program.</span> \
 "), PROGRAM_NAME));
+       foomatic->set_justify (JUSTIFY_FILL);
+       foomatic->set_line_wrap ();
 
        HBox* hbox = manage (new HBox);
        HBox* vbox = manage (new HBox);
@@ -368,6 +368,8 @@ void
 ArdourStartup::default_dir_changed ()
 {
        Config->set_default_session_parent_dir (default_dir_chooser->get_filename());
+       // make new session folder chooser point to the new default
+       new_folder_chooser.set_current_folder (Config->get_default_session_parent_dir());       
        config_changed ();
 }
 
@@ -434,7 +436,8 @@ signal as well as record it. This is called \"monitoring\". There are\n\
 different ways to do this depending on the equipment you have and the\n\
 configuration of that equipment. The two most common are presented here.\n\
 Please choose whichever one is right for your setup.\n\n\
-<i>(You can change this preference at any time, via the Preferences dialog)</i>"));
+<i>(You can change this preference at any time, via the Preferences dialog)</i>\n\n\
+<i>If you do not understand what this is about, just accept the default.</i>"));
        monitor_label.set_alignment (0.0, 0.0);
 
        vbox->set_spacing (6);
@@ -473,8 +476,7 @@ ArdourStartup::setup_monitor_section_choice_page ()
 
        no_monitor_section_button.set_label (_("Use a Master bus directly"));
        l->set_alignment (0.0, 1.0);
-       l->set_markup(_("Connect the Master bus directly to your hardware outputs.\n\
-<i>Preferable for simple use</i>."));
+       l->set_markup(_("Connect the Master bus directly to your hardware outputs. This is preferable for simple usage."));
 
        vbox = manage (new VBox);
        vbox->set_spacing (6);
@@ -508,7 +510,8 @@ greater control in monitoring without affecting the mix."));
        use_monitor_section_button.signal_toggled().connect (sigc::mem_fun (*this, &ArdourStartup::config_changed));
        no_monitor_section_button.signal_toggled().connect (sigc::mem_fun (*this, &ArdourStartup::config_changed));
 
-       monitor_section_label.set_markup(_("<i><small>(You can change this preference at any time, via the Preferences dialog)</small></i>"));
+       monitor_section_label.set_markup(_("<i>You can change this preference at any time via the Preferences dialog.\nYou can also add or remove the monitor section to/from any session.</i>\n\n\
+<i>If you do not understand what this is about, just accept the default.</i>"));
        monitor_section_label.set_alignment (0.0, 0.0);
 
        hbox->pack_start (*main_vbox, true, true, 8);
@@ -545,10 +548,10 @@ ArdourStartup::setup_initial_choice_page ()
        centering_vbox->pack_start (ic_new_session_button, false, true);
        centering_vbox->pack_start (ic_existing_session_button, false, true);
 
-       ic_new_session_button.signal_button_press_event().connect(sigc::mem_fun(*this, &ArdourStartup::initial_button_press), false);
+       ic_new_session_button.signal_button_press_event().connect(sigc::mem_fun(*this, &ArdourStartup::initial_button_clicked), false);
        ic_new_session_button.signal_activate().connect(sigc::mem_fun(*this, &ArdourStartup::initial_button_activated), false);
 
-       ic_existing_session_button.signal_button_press_event().connect(sigc::mem_fun(*this, &ArdourStartup::initial_button_press), false);
+       ic_existing_session_button.signal_button_press_event().connect(sigc::mem_fun(*this, &ArdourStartup::initial_button_clicked), false);
        ic_existing_session_button.signal_activate().connect(sigc::mem_fun(*this, &ArdourStartup::initial_button_activated), false);
 
        centering_hbox->pack_start (*centering_vbox, true, true);
@@ -569,20 +572,21 @@ ArdourStartup::setup_initial_choice_page ()
 }
 
 bool
-ArdourStartup::initial_button_press (GdkEventButton *event)
+ArdourStartup::initial_button_clicked (GdkEventButton* ev)
 {
-       if (event && event->type == GDK_2BUTTON_PRESS && session_page_index != -1) {
+       if (ev->type == GDK_2BUTTON_PRESS && session_page_index != -1) {
                set_current_page(session_page_index);
-               return true;
-       } else {
-               return false;
        }
+
+       return false;
 }
 
 void
 ArdourStartup::initial_button_activated ()
 {
-       set_current_page(session_page_index);
+       if (session_page_index != -1) {
+               set_current_page(session_page_index);
+       }
 }
 
 void
@@ -628,7 +632,10 @@ void
 ArdourStartup::on_apply ()
 {
        if (engine_dialog) {
-               engine_dialog->setup_engine ();
+               if (engine_dialog->setup_engine ()) {
+                        set_current_page (audio_page_index);
+                        return;
+                }
        }
 
        if (config_modified) {
@@ -645,6 +652,9 @@ ArdourStartup::on_apply ()
 
                Config->set_use_monitor_bus (use_monitor_section_button.get_active());
 
+               /* "touch" the been-here-before path now that we're about to save Config */
+               ofstream fout (been_here_before_path().c_str());
+               
                Config->save_state ();
        }
 
@@ -709,7 +719,7 @@ ArdourStartup::populate_session_templates ()
 static bool
 lost_name_entry_focus (GdkEventFocus*)
 {
-       cerr << "lost focus\n";
+       // cerr << "lost focus\n";
        return false;
 }
 
@@ -760,6 +770,13 @@ ArdourStartup::setup_new_session_page ()
 
                if (!ARDOUR_COMMAND_LINE::session_name.empty()) {
                        new_folder_chooser.set_current_folder (poor_mans_glob (Glib::path_get_dirname (ARDOUR_COMMAND_LINE::session_name)));
+               } else if (ARDOUR_UI::instance()->session_loaded) {
+                       // point the new session file chooser at the parent directory of the current session
+                       string session_parent_dir = Glib::path_get_dirname(ARDOUR_UI::instance()->the_session()->path());
+                       string::size_type last_dir_sep = session_parent_dir.rfind(G_DIR_SEPARATOR);
+                       session_parent_dir = session_parent_dir.substr(0, last_dir_sep);
+                       new_folder_chooser.set_current_folder (session_parent_dir);
+                       new_folder_chooser.add_shortcut_folder (poor_mans_glob (Config->get_default_session_parent_dir()));
                } else {
                        new_folder_chooser.set_current_folder (poor_mans_glob (Config->get_default_session_parent_dir()));
                }
@@ -878,7 +895,7 @@ ArdourStartup::setup_new_session_page ()
 void
 ArdourStartup::new_name_mapped ()
 {
-       cerr << "Grab new name focus\n";
+       // cerr << "Grab new name focus\n";
        new_name_entry.grab_focus ();
 }
 
@@ -895,7 +912,7 @@ ArdourStartup::new_name_changed ()
 int
 ArdourStartup::redisplay_recent_sessions ()
 {
-       std::vector<sys::path> session_directories;
+       std::vector<std::string> session_directories;
        RecentSessionsSorter cmp;
 
        recent_session_display.set_model (Glib::RefPtr<TreeModel>(0));
@@ -915,10 +932,12 @@ ArdourStartup::redisplay_recent_sessions ()
        for (ARDOUR::RecentSessions::iterator i = rs.begin(); i != rs.end(); ++i) {
                session_directories.push_back ((*i).second);
        }
+       
+       int session_snapshot_count = 0;
 
-       for (vector<sys::path>::const_iterator i = session_directories.begin(); i != session_directories.end(); ++i)
+       for (vector<std::string>::const_iterator i = session_directories.begin(); i != session_directories.end(); ++i)
        {
-               std::vector<sys::path> state_file_paths;
+               std::vector<std::string> state_file_paths;
 
                // now get available states for this session
 
@@ -926,7 +945,7 @@ ArdourStartup::redisplay_recent_sessions ()
 
                vector<string*>* states;
                vector<const gchar*> item;
-               string fullpath = (*i).to_string();
+               string fullpath = *i;
 
                /* remove any trailing / */
 
@@ -953,6 +972,8 @@ ArdourStartup::redisplay_recent_sessions ()
 
                row[recent_session_columns.visible_name] = Glib::path_get_basename (fullpath);
                row[recent_session_columns.fullpath] = fullpath;
+               
+               ++session_snapshot_count;
 
                if (state_file_names.size() > 1) {
 
@@ -966,12 +987,15 @@ ArdourStartup::redisplay_recent_sessions ()
 
                                child_row[recent_session_columns.visible_name] = *i2;
                                child_row[recent_session_columns.fullpath] = fullpath;
+                               ++session_snapshot_count;
                        }
                }
        }
 
+       recent_session_display.set_tooltip_column(1); // recent_session_columns.fullpath 
        recent_session_display.set_model (recent_session_model);
-       return rs.size();
+       return session_snapshot_count;
+       // return rs.size();
 }
 
 void
@@ -1022,7 +1046,14 @@ ArdourStartup::setup_existing_session_page ()
 
                existing_session_chooser.set_title (_("Select session file"));
                existing_session_chooser.signal_file_set().connect (sigc::mem_fun (*this, &ArdourStartup::existing_session_selected));
+               existing_session_chooser.set_current_folder(poor_mans_glob (Config->get_default_session_parent_dir()));
 
+               FileFilter session_filter;
+               session_filter.add_pattern ("*.ardour");
+               session_filter.set_name (string_compose (_("%1 sessions"), PROGRAM_NAME));
+               existing_session_chooser.add_filter (session_filter);
+               existing_session_chooser.set_filter (session_filter);
+               
 #ifdef GTKOSX
                existing_session_chooser.add_shortcut_folder ("/Volumes");
 #endif
@@ -1100,7 +1131,7 @@ ArdourStartup::setup_more_options_page ()
        advanced_table.set_row_spacings(0);
        advanced_table.set_col_spacings(0);
 
-       _connect_inputs.set_label (_("Automatically connect to physical_inputs"));
+       _connect_inputs.set_label (_("Automatically connect to physical inputs"));
        _connect_inputs.set_flags(Gtk::CAN_FOCUS);
        _connect_inputs.set_relief(Gtk::RELIEF_NORMAL);
        _connect_inputs.set_mode(true);
@@ -1235,10 +1266,11 @@ ArdourStartup::setup_more_options_page ()
        _limit_output_ports.signal_clicked().connect (sigc::mem_fun (*this, &ArdourStartup::limit_outputs_clicked));
        _create_master_bus.signal_clicked().connect (sigc::mem_fun (*this, &ArdourStartup::master_bus_button_clicked));
 
-       /* note that more_options_vbox is NOT visible by
-        * default. this is entirely by design - this page
-        * should be skipped unless explicitly requested.
+       /* note that more_options_vbox is "visible" by default even
+        * though it may not be displayed to the user, this is so the dialog
+        * doesn't resize.
         */
+       more_options_vbox.show_all ();
 
        session_options_page_index = append_page (more_options_vbox);
        set_page_title (more_options_vbox, _("Advanced Session Options"));
@@ -1320,9 +1352,12 @@ ArdourStartup::connect_inputs_clicked ()
 void
 ArdourStartup::connect_outputs_clicked ()
 {
-       _limit_output_ports.set_sensitive(_connect_outputs.get_active());
+       bool const co = _connect_outputs.get_active ();
+       _limit_output_ports.set_sensitive(co);
+       _connect_outputs_to_master.set_sensitive(co);
+       _connect_outputs_to_physical.set_sensitive(co);
 
-       if (_connect_outputs.get_active() && _limit_output_ports.get_active()) {
+       if (co && _limit_output_ports.get_active()) {
                _output_limit_count.set_sensitive(true);
        } else {
                _output_limit_count.set_sensitive(false);
@@ -1344,9 +1379,10 @@ ArdourStartup::limit_outputs_clicked ()
 void
 ArdourStartup::master_bus_button_clicked ()
 {
-       bool yn = _create_master_bus.get_active();
+       bool const yn = _create_master_bus.get_active();
 
        _master_bus_channel_count.set_sensitive(yn);
+       _connect_outputs_to_master.set_sensitive(yn);
 }
 
 void
@@ -1378,3 +1414,10 @@ ArdourStartup::existing_session_selected ()
        set_page_complete (session_vbox, true);
        move_along_now ();
 }
+
+std::string
+ArdourStartup::been_here_before_path () const
+{
+       // XXXX use more specific version so we can catch upgrades
+       return Glib::build_filename (user_config_directory (), ".a3");
+}