gtk2_ardour/session_dialog.cc

   1 /*
   2   Copyright (C) 2013 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 #ifdef WAF_BUILD
  21 #include "gtk2ardour-config.h"
  22 #endif
  23
  24 #include <algorithm>
  25
  26 #include <glib.h>
  27 #include "pbd/gstdio_compat.h"
  28
  29 #include <glibmm.h>
  30 #include <glibmm/datetime.h>
  31
  32 #include <gtkmm/filechooser.h>
  33 #include <gtkmm/stock.h>
  34
  35 #include "pbd/basename.h"
  36 #include "pbd/failed_constructor.h"
  37 #include "pbd/file_utils.h"
  38 #include "pbd/replace_all.h"
  39 #include "pbd/whitespace.h"
  40 #include "pbd/stacktrace.h"
  41 #include "pbd/stl_delete.h"
  42 #include "pbd/openuri.h"
  43
  44 #include "gtkmm2ext/utils.h"
  45 #include "gtkmm2ext/keyboard.h"
  46
  47 #include "widgets/tooltips.h"
  48
  49 #include "ardour/audioengine.h"
  50 #include "ardour/filesystem_paths.h"
  51 #include "ardour/luascripting.h"
  52 #include "ardour/recent_sessions.h"
  53 #include "ardour/session.h"
  54 #include "ardour/session_state_utils.h"
  55 #include "ardour/template_utils.h"
  56 #include "ardour/filename_extensions.h"
  57
  58 #include "LuaBridge/LuaBridge.h"
  59
  60 #include "ardour_ui.h"
  61 #include "session_dialog.h"
  62 #include "opts.h"
  63 #include "engine_dialog.h"
  64 #include "pbd/i18n.h"
  65 #include "ui_config.h"
  66 #include "utils.h"
  67
  68 using namespace std;
  69 using namespace Gtk;
  70 using namespace Gdk;
  71 using namespace Glib;
  72 using namespace PBD;
  73 using namespace ARDOUR;
  74 using namespace ArdourWidgets;
  75 using namespace ARDOUR_UI_UTILS;
  76
  77 SessionDialog::SessionDialog (bool require_new, const std::string& session_name, const std::string& session_path, const std::string& template_name, bool cancel_not_quit)
  78         : ArdourDialog (_("Session Setup"), true, true)
  79         , new_only (require_new)
  80         , _provided_session_name (session_name)
  81         , _provided_session_path (session_path)
  82         , new_folder_chooser (FILE_CHOOSER_ACTION_SELECT_FOLDER)
  83         , _existing_session_chooser_used (false)
  84 {
  85         set_position (WIN_POS_CENTER);
  86         get_vbox()->set_spacing (6);
  87
  88         cancel_button = add_button ((cancel_not_quit ? Stock::CANCEL : Stock::QUIT), RESPONSE_CANCEL);
  89         back_button = add_button (Stock::GO_BACK, RESPONSE_NO);
  90         open_button = add_button (Stock::OPEN, RESPONSE_ACCEPT);
  91
  92         back_button->signal_button_press_event().connect (sigc::mem_fun (*this, &SessionDialog::back_button_pressed), false);
  93         open_button->signal_button_press_event().connect (sigc::mem_fun (*this, &SessionDialog::open_button_pressed), false);
  94
  95         open_button->set_sensitive (false);
  96         back_button->set_sensitive (false);
  97
  98         /* this is where announcements will be displayed, but it may be empty
  99          * and invisible most of the time.
 100          */
 101
 102         info_frame.set_shadow_type(SHADOW_ETCHED_OUT);
 103         info_frame.set_no_show_all (true);
 104         info_frame.set_border_width (12);
 105         get_vbox()->pack_start (info_frame, false, false);
 106
 107         setup_new_session_page ();
 108
 109         if (!new_only) {
 110                 setup_initial_choice_box ();
 111                 get_vbox()->pack_start (ic_vbox, true, true);
 112         } else {
 113                 get_vbox()->pack_start (session_new_vbox, true, true);
 114         }
 115
 116         if (!template_name.empty()) {
 117                 load_template_override = template_name;
 118         }
 119
 120         get_vbox()->show_all ();
 121
 122         /* fill data models and show/hide accordingly */
 123
 124         populate_session_templates ();
 125
 126         if (recent_session_model) {
 127                 int cnt = redisplay_recent_sessions ();
 128                 if (cnt > 0) {
 129                         recent_scroller.show();
 130                         recent_label.show ();
 131
 132                         if (cnt > 4) {
 133                                 recent_scroller.set_size_request (-1, 300);
 134                         } else {
 135                                 recent_scroller.set_size_request (-1, 80);
 136                         }
 137                 } else {
 138                         recent_scroller.hide();
 139                         recent_label.hide ();
 140                 }
 141         }
 142
 143         /* possibly get out of here immediately if everything is ready to go.
 144            We still need to set up the whole dialog because of the way
 145            ARDOUR_UI::get_session_parameters() might skip it on a first
 146            pass then require it for a second pass (e.g. when there
 147            is an error with session loading and we have to ask the user
 148            what to do next).
 149         */
 150
 151         if (!session_name.empty() && !require_new) {
 152                 response (RESPONSE_OK);
 153                 return;
 154         }
 155 }
 156
 157 SessionDialog::SessionDialog ()
 158         : ArdourDialog (_("Recent Sessions"), true, true)
 159         , new_only (false)
 160         , _provided_session_name ("")
 161         , _provided_session_path ("")
 162         , _existing_session_chooser_used (false) // caller must check should_be_new
 163 {
 164         get_vbox()->set_spacing (6);
 165
 166         cancel_button = add_button (Stock::CANCEL, RESPONSE_CANCEL);
 167         open_button = add_button (Stock::OPEN, RESPONSE_ACCEPT);
 168         open_button->set_sensitive (false);
 169
 170         setup_recent_sessions ();
 171
 172         get_vbox()->pack_start (recent_scroller, true, true);
 173         get_vbox()->show_all ();
 174
 175         recent_scroller.show();
 176
 177         int cnt = redisplay_recent_sessions ();
 178         if (cnt > 4) {
 179                 recent_scroller.set_size_request (-1, 300);
 180         } else {
 181                 recent_scroller.set_size_request (-1, 80);
 182         }
 183
 184 }
 185
 186
 187
 188 SessionDialog::~SessionDialog()
 189 {
 190 }
 191
 192 void
 193 SessionDialog::clear_given ()
 194 {
 195         _provided_session_path = "";
 196         _provided_session_name = "";
 197 }
 198
 199 uint32_t
 200 SessionDialog::meta_master_bus_profile (std::string script_path) const
 201 {
 202         if (!Glib::file_test (script_path, Glib::FILE_TEST_EXISTS | Glib::FILE_TEST_IS_REGULAR)) {
 203                 return UINT32_MAX;
 204         }
 205
 206         LuaState lua;
 207         lua.sandbox (true);
 208         lua_State* L = lua.getState();
 209
 210         lua.do_command (
 211                         "ardourluainfo = {}"
 212                         "function ardour (entry)"
 213                         "  ardourluainfo['type'] = assert(entry['type'])"
 214                         "  ardourluainfo['master_bus'] = entry['master_bus'] or 2"
 215                         " end"
 216                         );
 217
 218         int err = -1;
 219
 220         try {
 221                 err = lua.do_file (script_path);
 222         } catch (luabridge::LuaException const& e) {
 223                 err = -1;
 224         }  catch (...) {
 225                 err = -1;
 226         }
 227
 228
 229         if (err) {
 230                 return UINT32_MAX;
 231         }
 232
 233         luabridge::LuaRef nfo = luabridge::getGlobal (L, "ardourluainfo");
 234         if (nfo.type() != LUA_TTABLE) {
 235                 return UINT32_MAX;
 236         }
 237
 238         if (nfo["master_bus"].type() != LUA_TNUMBER || nfo["type"].type() != LUA_TSTRING) {
 239                 return UINT32_MAX;
 240         }
 241
 242         LuaScriptInfo::ScriptType type = LuaScriptInfo::str2type (nfo["type"].cast<std::string>());
 243         if (type != LuaScriptInfo::SessionInit) {
 244                 return UINT32_MAX;
 245         }
 246
 247         return nfo["master_bus"].cast<uint32_t>();
 248 }
 249
 250 uint32_t
 251 SessionDialog::master_channel_count ()
 252 {
 253         if (use_session_template ()) {
 254                 std::string tn = session_template_name();
 255                 if (tn.substr (0, 11) == "urn:ardour:") {
 256                         uint32_t mc = meta_master_bus_profile (tn.substr (11));
 257                         if (mc != UINT32_MAX) {
 258                                 return mc;
 259                         }
 260                 }
 261         }
 262         return 2;
 263 }
 264
 265 bool
 266 SessionDialog::use_session_template () const
 267 {
 268         if (!back_button->sensitive () && !new_only) {
 269                 /* open session -- not create a new one */
 270                 return false;
 271         }
 272
 273         if (!load_template_override.empty()) {
 274                 return true;
 275         }
 276
 277         if (template_chooser.get_selection()->count_selected_rows() > 0) {
 278                 return true;
 279         }
 280
 281         return false;
 282 }
 283
 284 std::string
 285 SessionDialog::session_template_name ()
 286 {
 287         if (!load_template_override.empty()) {
 288                 string the_path (ARDOUR::user_template_directory());
 289                 return Glib::build_filename (the_path, load_template_override + ARDOUR::template_suffix);
 290         }
 291
 292         if (template_chooser.get_selection()->count_selected_rows() > 0) {
 293
 294                 TreeIter const iter = template_chooser.get_selection()->get_selected();
 295
 296                 if (iter) {
 297                         string s = (*iter)[session_template_columns.path];
 298                         return s;
 299                 }
 300         }
 301
 302         return string();
 303 }
 304
 305 std::string
 306 SessionDialog::session_name (bool& should_be_new)
 307 {
 308         if (!_provided_session_name.empty() && !new_only) {
 309                 should_be_new = false;
 310                 return _provided_session_name;
 311         }
 312
 313         /* Try recent session selection */
 314
 315         TreeIter iter = recent_session_display.get_selection()->get_selected();
 316
 317         if (iter) {
 318                 should_be_new = false;
 319                 string s = (*iter)[recent_session_columns.fullpath];
 320                 if (Glib::file_test (s, Glib::FILE_TEST_IS_REGULAR)) {
 321                         return PBD::basename_nosuffix (s);
 322                 }
 323                 return (*iter)[recent_session_columns.visible_name];
 324         }
 325
 326         if (_existing_session_chooser_used) {
 327                 /* existing session chosen from file chooser */
 328                 should_be_new = false;
 329                 return existing_session_chooser.get_filename ();
 330         } else {
 331                 should_be_new = true;
 332                 string val = new_name_entry.get_text ();
 333                 strip_whitespace_edges (val);
 334                 return val;
 335         }
 336 }
 337
 338 std::string
 339 SessionDialog::session_folder ()
 340 {
 341         if (!_provided_session_path.empty() && !new_only) {
 342                 return _provided_session_path;
 343         }
 344
 345         /* Try recent session selection */
 346
 347         TreeIter iter = recent_session_display.get_selection()->get_selected();
 348
 349         if (iter) {
 350                 string s = (*iter)[recent_session_columns.fullpath];
 351                 if (Glib::file_test (s, Glib::FILE_TEST_IS_REGULAR)) {
 352                         return Glib::path_get_dirname (s);
 353                 }
 354                 return s;
 355         }
 356
 357         if (_existing_session_chooser_used) {
 358                 /* existing session chosen from file chooser */
 359                 return Glib::path_get_dirname (existing_session_chooser.get_current_folder ());
 360         } else {
 361                 std::string val = new_name_entry.get_text();
 362                 strip_whitespace_edges (val);
 363                 std::string legal_session_folder_name = legalize_for_path (val);
 364                 return Glib::build_filename (new_folder_chooser.get_filename (), legal_session_folder_name);
 365         }
 366 }
 367
 368 void
 369 SessionDialog::setup_recent_sessions ()
 370 {
 371         recent_session_model = TreeStore::create (recent_session_columns);
 372         recent_session_model->signal_sort_column_changed().connect (sigc::mem_fun (*this, &SessionDialog::recent_session_sort_changed));
 373
 374         recent_session_display.set_model (recent_session_model);
 375         recent_session_display.append_column (_("Session Name"), recent_session_columns.visible_name);
 376         recent_session_display.append_column (_("Sample Rate"), recent_session_columns.sample_rate);
 377 #ifdef MIXBUS
 378         recent_session_display.append_column (_("Modified With"), recent_session_columns.modified_with);
 379 #else
 380         recent_session_display.append_column (_("File Resolution"), recent_session_columns.disk_format);
 381 #endif
 382         recent_session_display.append_column (_("Last Modified"), recent_session_columns.time_formatted);
 383         recent_session_display.set_headers_visible (true);
 384         recent_session_display.get_selection()->set_mode (SELECTION_SINGLE);
 385
 386         recent_session_display.get_selection()->signal_changed().connect (sigc::mem_fun (*this, &SessionDialog::recent_session_row_selected));
 387
 388         recent_scroller.add (recent_session_display);
 389         recent_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
 390         recent_scroller.set_shadow_type (Gtk::SHADOW_IN);
 391
 392         recent_session_display.show();
 393         recent_session_display.signal_row_activated().connect (sigc::mem_fun (*this, &SessionDialog::recent_row_activated));
 394         recent_session_display.signal_button_press_event().connect (sigc::mem_fun (*this, &SessionDialog::recent_button_press), false);
 395 }
 396
 397 void
 398 SessionDialog::setup_initial_choice_box ()
 399 {
 400         ic_vbox.set_spacing (6);
 401
 402         HBox* centering_hbox = manage (new HBox);
 403         VBox* centering_vbox = manage (new VBox);
 404
 405         centering_vbox->set_spacing (6);
 406
 407         Label* new_label = manage (new Label);
 408         new_label->set_markup (string_compose ("<span weight=\"bold\" size=\"large\">%1</span>", _("New Session")));
 409         new_label->set_justify (JUSTIFY_CENTER);
 410
 411         ic_new_session_button.add (*new_label);
 412         ic_new_session_button.signal_clicked().connect (sigc::mem_fun (*this, &SessionDialog::new_session_button_clicked));
 413
 414         Gtk::HBox* hbox = manage (new HBox);
 415         Gtk::VBox* vbox = manage (new VBox);
 416         hbox->set_spacing (12);
 417         vbox->set_spacing (12);
 418
 419         string image_path;
 420
 421         Searchpath rc (ARDOUR::ardour_data_search_path());
 422         rc.add_subdirectory_to_paths ("resources");
 423
 424         if (find_file (rc, PROGRAM_NAME "-small-splash.png", image_path)) {
 425                 Gtk::Image* image;
 426                 if ((image = manage (new Gtk::Image (image_path))) != 0) {
 427                         hbox->pack_start (*image, false, false);
 428                 }
 429         }
 430
 431         vbox->pack_start (ic_new_session_button, true, true, 20);
 432         hbox->pack_start (*vbox, true, true, 20);
 433
 434         centering_vbox->pack_start (*hbox, false, false);
 435
 436         /* Possible update message */
 437
 438         if (ARDOUR_UI::instance()->announce_string() != "" ) {
 439
 440                 Box *info_box = manage (new VBox);
 441                 info_box->set_border_width (12);
 442                 info_box->set_spacing (6);
 443
 444                 info_box->pack_start (info_scroller_label, false, false);
 445
 446                 info_scroller_count = 0;
 447                 info_scroller_connection = Glib::signal_timeout().connect (mem_fun(*this, &SessionDialog::info_scroller_update), 50);
 448
 449                 Gtk::Button *updates_button = manage (new Gtk::Button (_("Check the website for more...")));
 450
 451                 updates_button->signal_clicked().connect (mem_fun(*this, &SessionDialog::updates_button_clicked) );
 452                 set_tooltip (*updates_button, _("Click to open the program website in your web browser"));
 453
 454                 info_box->pack_start (*updates_button, false, false);
 455
 456                 info_frame.add (*info_box);
 457                 info_box->show_all ();
 458                 info_frame.show ();
 459         }
 460
 461         /* recent session scroller */
 462         setup_recent_sessions ();
 463
 464         recent_label.set_no_show_all (true);
 465         recent_scroller.set_no_show_all (true);
 466
 467         recent_label.set_markup (string_compose ("<span weight=\"bold\" size=\"large\">%1</span>", _("Recent Sessions")));
 468
 469         centering_vbox->pack_start (recent_label, false, false, 12);
 470         centering_vbox->pack_start (recent_scroller, true, true);
 471
 472         /* Browse button */
 473
 474         existing_session_chooser.set_title (_("Select session file"));
 475         existing_session_chooser.signal_file_set().connect (sigc::mem_fun (*this, &SessionDialog::existing_session_selected));
 476         existing_session_chooser.set_current_folder(poor_mans_glob (Config->get_default_session_parent_dir()));
 477
 478         FileFilter session_filter;
 479         session_filter.add_pattern (string_compose(X_("*%1"), ARDOUR::statefile_suffix));
 480         session_filter.set_name (string_compose (_("%1 sessions"), PROGRAM_NAME));
 481         existing_session_chooser.add_filter (session_filter);
 482
 483         FileFilter archive_filter;
 484         archive_filter.add_pattern (string_compose(X_("*%1"), ARDOUR::session_archive_suffix));
 485         archive_filter.set_name (_("Session Archives"));
 486         existing_session_chooser.add_filter (archive_filter);
 487
 488         existing_session_chooser.set_filter (session_filter);
 489
 490         Gtkmm2ext::add_volume_shortcuts (existing_session_chooser);
 491
 492         Label* browse_label = manage (new Label);
 493         browse_label->set_markup (string_compose ("<span weight=\"bold\" size=\"large\">%1</span>", _("Other Sessions")));
 494
 495         centering_vbox->pack_start (*browse_label, false, false, 12);
 496         centering_vbox->pack_start (existing_session_chooser, false, false);
 497
 498         /* --disable plugins UI */
 499
 500         _disable_plugins.set_label (_("Safe Mode: Disable all Plugins"));
 501         _disable_plugins.set_flags (Gtk::CAN_FOCUS);
 502         _disable_plugins.set_relief (Gtk::RELIEF_NORMAL);
 503         _disable_plugins.set_mode (true);
 504         _disable_plugins.set_active (ARDOUR::Session::get_disable_all_loaded_plugins());
 505         _disable_plugins.set_border_width(0);
 506         _disable_plugins.signal_clicked().connect (sigc::mem_fun (*this, &SessionDialog::disable_plugins_clicked));
 507         centering_vbox->pack_start (_disable_plugins, false, false);
 508
 509         /* pack it all up */
 510
 511         centering_hbox->pack_start (*centering_vbox, true, true);
 512         ic_vbox.pack_start (*centering_hbox, true, true);
 513         ic_vbox.show_all ();
 514 }
 515
 516 void
 517 SessionDialog::session_selected ()
 518 {
 519         /* HACK HACK HACK ... change the "Apply" button label
 520            to say "Open"
 521         */
 522
 523         Gtk::Widget* tl = ic_vbox.get_toplevel();
 524         Gtk::Window* win;
 525         if ((win = dynamic_cast<Gtk::Window*>(tl)) != 0) {
 526                 /* ::get_default_widget() is not wrapped in gtkmm */
 527                 Gtk::Widget* def = wrap (gtk_window_get_default_widget (win->gobj()));
 528                 Gtk::Button* button;
 529                 if ((button = dynamic_cast<Gtk::Button*>(def)) != 0) {
 530                         button->set_label (_("Open"));
 531                 }
 532         }
 533 }
 534
 535 void
 536 SessionDialog::new_session_button_clicked ()
 537 {
 538         _existing_session_chooser_used = false;
 539         recent_session_display.get_selection()->unselect_all ();
 540
 541         get_vbox()->remove (ic_vbox);
 542         get_vbox()->pack_start (session_new_vbox, true, true);
 543         back_button->set_sensitive (true);
 544         new_name_entry.grab_focus ();
 545 }
 546
 547 bool
 548 SessionDialog::back_button_pressed (GdkEventButton*)
 549 {
 550         get_vbox()->remove (session_new_vbox);
 551         back_button->set_sensitive (false);
 552         get_vbox()->pack_start (ic_vbox);
 553
 554         return true;
 555 }
 556
 557 bool
 558 SessionDialog::open_button_pressed (GdkEventButton* ev)
 559 {
 560         if (Gtkmm2ext::Keyboard::modifier_state_equals (ev->state, Gtkmm2ext::Keyboard::PrimaryModifier)) {
 561                 _disable_plugins.set_active();
 562         }
 563         response (RESPONSE_ACCEPT);
 564         return true;
 565 }
 566
 567 struct LuaScriptListSorter
 568 {
 569         bool operator() (LuaScriptInfoPtr const a, LuaScriptInfoPtr const b) const {
 570                 return ARDOUR::cmp_nocase_utf8 (a->name, b->name) < 0;
 571         }
 572 };
 573
 574
 575 void
 576 SessionDialog::populate_session_templates ()
 577 {
 578         vector<TemplateInfo> templates;
 579
 580         find_session_templates (templates, true);
 581
 582         template_model->clear ();
 583
 584         /* Get Lua Scripts dedicated to session-setup */
 585         LuaScriptList scripts (LuaScripting::instance ().scripts (LuaScriptInfo::SessionInit));
 586
 587         /* Add Lua Action Scripts which can also be used for session-setup */
 588         LuaScriptList& as (LuaScripting::instance ().scripts (LuaScriptInfo::EditorAction));
 589         for (LuaScriptList::const_iterator s = as.begin(); s != as.end(); ++s) {
 590                 if ((*s)->subtype & LuaScriptInfo::SessionSetup) {
 591                         scripts.push_back (*s);
 592                 }
 593         }
 594
 595         LuaScriptListSorter cmp;
 596         std::sort (scripts.begin(), scripts.end(), cmp);
 597
 598         for (LuaScriptList::const_iterator s = scripts.begin(); s != scripts.end(); ++s) {
 599                 TreeModel::Row row = *(template_model->append ());
 600                 row[session_template_columns.name] = (*s)->name;
 601                 row[session_template_columns.path] = "urn:ardour:" + (*s)->path;
 602                 row[session_template_columns.description] = (*s)->description;
 603                 row[session_template_columns.modified_with_short] = _("{Factory Template}");
 604                 row[session_template_columns.modified_with_long] = _("{Factory Template}");
 605         }
 606
 607         //Add any "template sessions" found in the user's preferences folder
 608         for (vector<TemplateInfo>::iterator x = templates.begin(); x != templates.end(); ++x) {
 609                 TreeModel::Row row;
 610
 611                 row = *(template_model->append ());
 612
 613                 row[session_template_columns.name] = (*x).name;
 614                 row[session_template_columns.path] = (*x).path;
 615                 row[session_template_columns.description] = (*x).description;
 616                 row[session_template_columns.modified_with_long] = (*x).modified_with;
 617                 row[session_template_columns.modified_with_short] = (*x).modified_with.substr(0, (*x).modified_with.find(" "));
 618         }
 619
 620         //Add an explicit 'Empty Template' item
 621         TreeModel::Row row = *template_model->prepend ();
 622         row[session_template_columns.name] = (_("Empty Template"));
 623         row[session_template_columns.path] = string();
 624         row[session_template_columns.description] = _("An empty session with factory default settings.");
 625         row[session_template_columns.modified_with_short] = _("");
 626         row[session_template_columns.modified_with_long] = _("");
 627
 628         //auto-select the first item in the list
 629         Gtk::TreeModel::Row first = template_model->children()[0];
 630         if(first) {
 631                 template_chooser.get_selection()->select(first);
 632         }
 633 }
 634
 635 void
 636 SessionDialog::setup_new_session_page ()
 637 {
 638         session_new_vbox.set_border_width (8);
 639         session_new_vbox.set_spacing (8);
 640
 641         Label* name_label = manage (new Label);
 642         name_label->set_text (_("Session name:"));
 643
 644         HBox* name_hbox = manage (new HBox);
 645         name_hbox->set_spacing (8);
 646         name_hbox->pack_start (*name_label, false, true);
 647         name_hbox->pack_start (new_name_entry, true, true);
 648
 649         //check to see if a session name was provided on command line
 650         if (!ARDOUR_COMMAND_LINE::session_name.empty()) {
 651                 new_name_entry.set_text  (Glib::path_get_basename (ARDOUR_COMMAND_LINE::session_name));
 652                 open_button->set_sensitive (true);
 653         }
 654
 655         new_name_entry.signal_changed().connect (sigc::mem_fun (*this, &SessionDialog::new_name_changed));
 656         new_name_entry.signal_activate().connect (sigc::mem_fun (*this, &SessionDialog::new_name_activated));
 657
 658         //Folder location for the new session
 659         Label* new_folder_label = manage (new Label);
 660         new_folder_label->set_text (_("Create session folder in:"));
 661         HBox* folder_box = manage (new HBox);
 662         folder_box->set_spacing (8);
 663         folder_box->pack_start (*new_folder_label, false, false);
 664         folder_box->pack_start (new_folder_chooser, true, true);
 665
 666         //determine the text in the new folder selector
 667         if (!ARDOUR_COMMAND_LINE::session_name.empty()) {
 668                 new_folder_chooser.set_current_folder (poor_mans_glob (Glib::path_get_dirname (ARDOUR_COMMAND_LINE::session_name)));
 669         } else if (ARDOUR_UI::instance()->session_loaded) {
 670                 // point the new session file chooser at the parent directory of the current session
 671                 string session_parent_dir = Glib::path_get_dirname(ARDOUR_UI::instance()->the_session()->path());
 672                 new_folder_chooser.set_current_folder (session_parent_dir);
 673                 string default_session_folder = poor_mans_glob (Config->get_default_session_parent_dir());
 674
 675                 try {
 676                         /* add_shortcut_folder throws an exception if the folder being added already has a shortcut */
 677                         new_folder_chooser.add_shortcut_folder (default_session_folder);
 678                 }
 679                 catch (Glib::Error & e) {
 680                         std::cerr << "new_folder_chooser.add_shortcut_folder (" << default_session_folder << ") threw Glib::Error " << e.what() << std::endl;
 681                 }
 682         } else {
 683                 new_folder_chooser.set_current_folder (poor_mans_glob (Config->get_default_session_parent_dir()));
 684         }
 685         new_folder_chooser.show ();
 686         new_folder_chooser.set_title (_("Select folder for session"));
 687         Gtkmm2ext::add_volume_shortcuts (new_folder_chooser);
 688
 689         //Template & Template Description area
 690         HBox* template_hbox = manage (new HBox);
 691
 692         //if the "template override" is provided, don't give the user any template selections   (?)
 693         if ( load_template_override.empty() ) {
 694                 template_hbox->set_spacing (8);
 695
 696                 Gtk::ScrolledWindow *template_scroller = manage (new Gtk::ScrolledWindow());
 697                 template_scroller->set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
 698                 template_scroller->add (template_chooser);
 699
 700                 Gtk::ScrolledWindow *desc_scroller = manage (new Gtk::ScrolledWindow());
 701                 desc_scroller->set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
 702                 desc_scroller->add (template_desc);
 703
 704                 template_hbox->pack_start (*template_scroller, true, true);
 705
 706                 template_desc_frame.set_name (X_("TextHighlightFrame"));
 707                 template_desc_frame.add (*desc_scroller);
 708                 template_hbox->pack_start (template_desc_frame, true, true);
 709         }
 710
 711         //template_desc is the textview that displays the currently selected template's description
 712         template_desc.set_editable (false);
 713         template_desc.set_wrap_mode (Gtk::WRAP_WORD);
 714         template_desc.set_size_request (300,400);
 715         template_desc.set_name (X_("TextOnBackground"));
 716         template_desc.set_border_width (6);
 717
 718         //template_chooser is the treeview showing available templates
 719         template_model = TreeStore::create (session_template_columns);
 720         template_chooser.set_model (template_model);
 721         template_chooser.append_column (_("Template"), session_template_columns.name);
 722 #ifdef MIXBUS
 723         template_chooser.append_column (_("Modified With"), session_template_columns.modified_with_short);
 724 #endif
 725         template_chooser.set_tooltip_column(4); // modified_with_long
 726         template_chooser.set_headers_visible (true);
 727         template_chooser.get_selection()->set_mode (SELECTION_SINGLE);
 728         template_chooser.get_selection()->signal_changed().connect (sigc::mem_fun (*this, &SessionDialog::template_row_selected));
 729         template_chooser.set_sensitive (true);
 730
 731         session_new_vbox.pack_start (*template_hbox, true, true);
 732         session_new_vbox.pack_start (*folder_box, false, true);
 733         session_new_vbox.pack_start (*name_hbox, false, true);
 734         session_new_vbox.show_all ();
 735 }
 736
 737 void
 738 SessionDialog::new_name_changed ()
 739 {
 740         if (!new_name_entry.get_text().empty()) {
 741                 session_selected ();
 742                 open_button->set_sensitive (true);
 743         } else {
 744                 open_button->set_sensitive (false);
 745         }
 746 }
 747
 748 void
 749 SessionDialog::new_name_activated ()
 750 {
 751         response (RESPONSE_ACCEPT);
 752 }
 753
 754 int
 755 SessionDialog::redisplay_recent_sessions ()
 756 {
 757         std::vector<std::string> session_directories;
 758         RecentSessionsSorter cmp;
 759
 760         recent_session_display.set_model (Glib::RefPtr<TreeModel>(0));
 761         recent_session_model->clear ();
 762
 763         ARDOUR::RecentSessions rs;
 764         ARDOUR::read_recent_sessions (rs);
 765
 766         if (rs.empty()) {
 767                 recent_session_display.set_model (recent_session_model);
 768                 return 0;
 769         }
 770
 771         // sort them alphabetically
 772         sort (rs.begin(), rs.end(), cmp);
 773
 774         for (ARDOUR::RecentSessions::iterator i = rs.begin(); i != rs.end(); ++i) {
 775                 session_directories.push_back ((*i).second);
 776         }
 777
 778         int session_snapshot_count = 0;
 779
 780         for (vector<std::string>::const_iterator i = session_directories.begin(); i != session_directories.end(); ++i)
 781         {
 782                 std::vector<std::string> state_file_paths;
 783
 784                 // now get available states for this session
 785
 786                 get_state_files_in_directory (*i, state_file_paths);
 787
 788                 vector<string> states;
 789                 vector<const gchar*> item;
 790                 string dirname = *i;
 791
 792                 /* remove any trailing / */
 793
 794                 if (dirname[dirname.length()-1] == '/') {
 795                         dirname = dirname.substr (0, dirname.length()-1);
 796                 }
 797
 798                 /* check whether session still exists */
 799                 if (!Glib::file_test(dirname.c_str(), Glib::FILE_TEST_EXISTS)) {
 800                         /* session doesn't exist */
 801                         continue;
 802                 }
 803
 804                 /* now get available states for this session */
 805
 806                 states = Session::possible_states (dirname);
 807
 808                 if (states.empty()) {
 809                         /* no state file? */
 810                         continue;
 811                 }
 812
 813                 std::vector<string> state_file_names(get_file_names_no_extension (state_file_paths));
 814
 815                 if (state_file_names.empty()) {
 816                         continue;
 817                 }
 818
 819                 float sr;
 820                 SampleFormat sf;
 821                 std::string program_version;
 822
 823                 std::string state_file_basename;
 824
 825                 if (state_file_names.size() > 1) {
 826                         state_file_basename = Session::get_snapshot_from_instant (dirname);
 827                         std::string s = Glib::build_filename (dirname, state_file_basename + statefile_suffix);
 828                         if (!Glib::file_test (s, Glib::FILE_TEST_IS_REGULAR)) {
 829                                 state_file_basename = "";
 830                         }
 831                 }
 832
 833                 if (state_file_basename.empty()) {
 834                         state_file_basename = state_file_names.front();
 835                 }
 836
 837                 std::string s = Glib::build_filename (dirname, state_file_basename + statefile_suffix);
 838
 839                 int err = Session::get_info_from_path (s, sr, sf, program_version);
 840                 if (err < 0) {
 841                         // XML cannot be parsed, or unsuppored version
 842                         continue;
 843                 }
 844
 845                 GStatBuf gsb;
 846                 g_stat (s.c_str(), &gsb);
 847
 848                 Gtk::TreeModel::Row row = *(recent_session_model->append());
 849                 row[recent_session_columns.fullpath] = s;
 850                 row[recent_session_columns.time_modified] = gsb.st_mtime;
 851
 852
 853                 if (err == 0) {
 854                         row[recent_session_columns.sample_rate] = rate_as_string (sr);
 855                         switch (sf) {
 856                         case FormatFloat:
 857                                 row[recent_session_columns.disk_format] = _("32-bit float");
 858                                 break;
 859                         case FormatInt24:
 860                                 row[recent_session_columns.disk_format] = _("24-bit");
 861                                 break;
 862                         case FormatInt16:
 863                                 row[recent_session_columns.disk_format] = _("16-bit");
 864                                 break;
 865                         }
 866                 } else {
 867                         row[recent_session_columns.sample_rate] = "??";
 868                         row[recent_session_columns.disk_format] = "--";
 869                 }
 870
 871                 if (program_version.empty()) {
 872                         row[recent_session_columns.tip] = Gtkmm2ext::markup_escape_text (dirname);
 873                 } else {
 874                         row[recent_session_columns.tip] = Gtkmm2ext::markup_escape_text (dirname + "\n" + string_compose (_("Last modified with: %1"), program_version));
 875                         row[recent_session_columns.modified_with] = program_version;
 876                 }
 877
 878                 ++session_snapshot_count;
 879
 880                 if (state_file_names.size() > 1) {
 881                         // multiple session files in the session directory - show the directory name.
 882                         // if there's not a session file with the same name as the session directory,
 883                         // opening the parent item will fail, but expanding it will show the session
 884                         // files that actually exist, and the right one can then be opened.
 885                         row[recent_session_columns.visible_name] = Glib::path_get_basename (dirname);
 886                         int64_t most_recent = 0;
 887
 888                         // add the children
 889                         int kidcount = 0;
 890                         for (std::vector<std::string>::iterator i2 = state_file_names.begin(); i2 != state_file_names.end(); ++i2) {
 891
 892                                 s = Glib::build_filename (dirname, *i2 + statefile_suffix);
 893                                 Gtk::TreeModel::Row child_row = *(recent_session_model->append (row.children()));
 894
 895                                 child_row[recent_session_columns.visible_name] = *i2;
 896                                 child_row[recent_session_columns.fullpath] = s;
 897                                 child_row[recent_session_columns.tip] = Gtkmm2ext::markup_escape_text (dirname);
 898                                 g_stat (s.c_str(), &gsb);
 899                                 child_row[recent_session_columns.time_modified] = gsb.st_mtime;
 900
 901                                 Glib::DateTime gdt(Glib::DateTime::create_now_local (gsb.st_mtime));
 902                                 child_row[recent_session_columns.time_formatted] = gdt.format ("%F %H:%M");
 903
 904                                 if (gsb.st_mtime > most_recent) {
 905                                         most_recent = gsb.st_mtime;
 906                                 }
 907
 908                                 if (++kidcount < 5) {
 909                                         // parse "modified with" for the first 5 snapshots
 910                                         if (Session::get_info_from_path (s, sr, sf, program_version) == 0) {
 911 #if 0
 912                                                 child_row[recent_session_columns.sample_rate] = rate_as_string (sr);
 913                                                 switch (sf) {
 914                                                 case FormatFloat:
 915                                                         child_row[recent_session_columns.disk_format] = _("32-bit float");
 916                                                         break;
 917                                                 case FormatInt24:
 918                                                         child_row[recent_session_columns.disk_format] = _("24-bit");
 919                                                         break;
 920                                                 case FormatInt16:
 921                                                         child_row[recent_session_columns.disk_format] = _("16-bit");
 922                                                         break;
 923                                                 }
 924 #else
 925                                                 child_row[recent_session_columns.sample_rate] = "";
 926                                                 child_row[recent_session_columns.disk_format] = "";
 927 #endif
 928                                         } else {
 929                                                 child_row[recent_session_columns.sample_rate] = "??";
 930                                                 child_row[recent_session_columns.disk_format] = "--";
 931                                         }
 932                                         if (!program_version.empty()) {
 933                                                 child_row[recent_session_columns.tip] = Gtkmm2ext::markup_escape_text (string_compose (_("Last modified with: %1"), program_version));
 934                                         }
 935                                 } else {
 936                                         child_row[recent_session_columns.sample_rate] = "";
 937                                         child_row[recent_session_columns.disk_format] = "";
 938                                 }
 939
 940                                 ++session_snapshot_count;
 941                         }
 942
 943                         assert (most_recent >= row[recent_session_columns.time_modified]);
 944                         row[recent_session_columns.time_modified] = most_recent;
 945
 946                 } else {
 947                         // only a single session file in the directory - show its actual name.
 948                         row[recent_session_columns.visible_name] = state_file_basename;
 949                 }
 950
 951                 Glib::DateTime gdt(Glib::DateTime::create_now_local (row[recent_session_columns.time_modified]));
 952                 row[recent_session_columns.time_formatted] = gdt.format ("%F %H:%M");
 953         }
 954
 955         recent_session_display.set_tooltip_column(1); // recent_session_columns.tip
 956         recent_session_display.set_model (recent_session_model);
 957
 958         // custom sort
 959         Gtk::TreeView::Column* pColumn;
 960         if ((pColumn = recent_session_display.get_column (0))) { // name
 961                 pColumn->set_sort_column (recent_session_columns.visible_name);
 962         }
 963         if ((pColumn = recent_session_display.get_column (3))) { // date
 964                 pColumn->set_sort_column (recent_session_columns.time_modified); // unixtime
 965         }
 966
 967         int32_t sort = UIConfiguration::instance().get_recent_session_sort();
 968         if (abs(sort) != 1 + recent_session_columns.visible_name.index () &&
 969             abs(sort) != 1 + recent_session_columns.time_modified.index ()) {
 970                 sort = 1 + recent_session_columns.visible_name.index();
 971         }
 972         recent_session_model->set_sort_column (abs (sort) -1, sort < 0 ? Gtk::SORT_DESCENDING : Gtk::SORT_ASCENDING);
 973
 974         return session_snapshot_count;
 975 }
 976
 977 void
 978 SessionDialog::recent_session_sort_changed ()
 979 {
 980         int column;
 981         SortType order;
 982         if (recent_session_model->get_sort_column_id (column, order)) {
 983                 int32_t sort = (column + 1) * (order == Gtk::SORT_DESCENDING ? -1 : 1);
 984                 if (sort != UIConfiguration::instance().get_recent_session_sort()) {
 985                         UIConfiguration::instance().set_recent_session_sort(sort);
 986                 }
 987         }
 988 }
 989
 990 void
 991 SessionDialog::recent_session_row_selected ()
 992 {
 993         if (recent_session_display.get_selection()->count_selected_rows() > 0) {
 994                 open_button->set_sensitive (true);
 995                 session_selected ();
 996         } else {
 997                 open_button->set_sensitive (false);
 998         }
 999 }
1000
1001 void
1002 SessionDialog::template_row_selected ()
1003 {
1004         if (template_chooser.get_selection()->count_selected_rows() > 0) {
1005                 TreeIter iter = template_chooser.get_selection()->get_selected();
1006
1007                 if (iter) {
1008                         string s = (*iter)[session_template_columns.description];
1009                         template_desc.get_buffer()->set_text (s);
1010                 }
1011         }
1012 }
1013
1014 void
1015 SessionDialog::recent_row_activated (const Gtk::TreePath&, Gtk::TreeViewColumn*)
1016 {
1017         response (RESPONSE_ACCEPT);
1018 }
1019
1020 bool
1021 SessionDialog::recent_button_press (GdkEventButton* ev)
1022 {
1023         if ((ev->type == GDK_BUTTON_PRESS) && (ev->button == 3) ) {
1024
1025                 TreeModel::Path path;
1026                 TreeViewColumn* column;
1027                 int cellx, celly;
1028                 if (recent_session_display.get_path_at_pos ((int)ev->x, (int)ev->y, path, column, cellx, celly)) {
1029                         Glib::RefPtr<Gtk::TreeView::Selection> selection = recent_session_display.get_selection();
1030                         if (selection) {
1031                                 selection->unselect_all();
1032                                 selection->select(path);
1033                         }
1034                 }
1035
1036                 if (recent_session_display.get_selection()->count_selected_rows() > 0) {
1037                         recent_context_mennu (ev);
1038                 }
1039         }
1040         return false;
1041 }
1042
1043 void
1044 SessionDialog::recent_context_mennu (GdkEventButton *ev)
1045 {
1046         using namespace Gtk::Menu_Helpers;
1047
1048         TreeIter iter = recent_session_display.get_selection()->get_selected();
1049         assert (iter);
1050         string s = (*iter)[recent_session_columns.fullpath];
1051         if (Glib::file_test (s, Glib::FILE_TEST_IS_REGULAR)) {
1052                 s = Glib::path_get_dirname (s);
1053         }
1054         if (!Glib::file_test (s, Glib::FILE_TEST_IS_DIR)) {
1055                 return;
1056         }
1057
1058         Gtk::TreeModel::Path tpath = recent_session_model->get_path(iter);
1059         const bool is_child = tpath.up () && tpath.up ();
1060
1061         Gtk::Menu* m = manage (new Menu);
1062         MenuList& items = m->items ();
1063         items.push_back (MenuElem (s, sigc::bind (sigc::hide_return (sigc::ptr_fun (&PBD::open_folder)), s)));
1064         if (!is_child) {
1065                 items.push_back (SeparatorElem());
1066                 items.push_back (MenuElem (_("Remove session from recent list"), sigc::mem_fun (*this, &SessionDialog::recent_remove_selected)));
1067         }
1068         m->popup (ev->button, ev->time);
1069 }
1070
1071 void
1072 SessionDialog::recent_remove_selected ()
1073 {
1074         TreeIter iter = recent_session_display.get_selection()->get_selected();
1075         assert (iter);
1076         string s = (*iter)[recent_session_columns.fullpath];
1077         if (Glib::file_test (s, Glib::FILE_TEST_IS_REGULAR)) {
1078                 s = Glib::path_get_dirname (s);
1079         }
1080         ARDOUR::remove_recent_sessions (s);
1081         redisplay_recent_sessions ();
1082 }
1083
1084 void
1085 SessionDialog::disable_plugins_clicked ()
1086 {
1087         ARDOUR::Session::set_disable_all_loaded_plugins (_disable_plugins.get_active());
1088 }
1089
1090 void
1091 SessionDialog::existing_session_selected ()
1092 {
1093         _existing_session_chooser_used = true;
1094         recent_session_display.get_selection()->unselect_all();
1095         /* mark this sensitive in case we come back here after a failed open
1096          * attempt and the user has hacked up the fix. sigh.
1097          */
1098         open_button->set_sensitive (true);
1099         response (RESPONSE_ACCEPT);
1100 }
1101
1102 void
1103 SessionDialog::updates_button_clicked ()
1104 {
1105         //now open a browser window so user can see more
1106         PBD::open_uri (Config->get_updates_url());
1107 }
1108
1109 bool
1110 SessionDialog::info_scroller_update()
1111 {
1112         info_scroller_count++;
1113
1114         char buf[512];
1115         snprintf (buf, std::min(info_scroller_count,sizeof(buf)-1), "%s", ARDOUR_UI::instance()->announce_string().c_str() );
1116         buf[info_scroller_count] = 0;
1117         info_scroller_label.set_text (buf);
1118         info_scroller_label.show();
1119
1120         if (info_scroller_count > ARDOUR_UI::instance()->announce_string().length()) {
1121                 info_scroller_connection.disconnect();
1122         }
1123
1124         return true;
1125 }
1126
1127 bool
1128 SessionDialog::on_delete_event (GdkEventAny* ev)
1129 {
1130         response (RESPONSE_CANCEL);
1131         return ArdourDialog::on_delete_event (ev);
1132 }