gtk2_ardour/export_dialog.cc

   1 /*
   2     Copyright (C) 2008 Paul Davis
   3     Author: Sakari Bergen
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21
  22 #include <sigc++/signal.h>
  23
  24 #include "pbd/filesystem.h"
  25
  26 #include "ardour/audioregion.h"
  27 #include "ardour/export_status.h"
  28 #include "ardour/export_handler.h"
  29
  30 #include "export_dialog.h"
  31 #include "gui_thread.h"
  32
  33 #include "i18n.h"
  34
  35 using namespace ARDOUR;
  36 using namespace PBD;
  37 using std::string;
  38
  39 ExportDialog::ExportDialog (PublicEditor & editor, std::string title, std::string xml_node_name)
  40   : ArdourDialog (title)
  41   , xml_node_name (xml_node_name)
  42   , editor (editor)
  43
  44   , warn_label ("", Gtk::ALIGN_LEFT)
  45   , list_files_label (_("<span color=\"#ffa755\">Some already existing files will be overwritten.</span>"), Gtk::ALIGN_RIGHT)
  46   , list_files_button (_("List files"))
  47 { }
  48
  49 ExportDialog::~ExportDialog ()
  50 { }
  51
  52 void
  53 ExportDialog::set_session (ARDOUR::Session* s)
  54 {
  55         SessionHandlePtr::set_session (s);
  56
  57         if (!_session) {
  58                 return;
  59         }
  60
  61         /* Init handler and profile manager */
  62
  63         handler = _session->get_export_handler ();
  64         status = _session->get_export_status ();
  65
  66         profile_manager.reset (new ExportProfileManager (*_session, xml_node_name));
  67
  68         /* Possibly init stuff in derived classes */
  69
  70         init ();
  71
  72         /* Rest of _session related initialization */
  73
  74         preset_selector->set_manager (profile_manager);
  75         file_notebook->set_session_and_manager (_session, profile_manager);
  76
  77         /* Hand on selection range to profile manager  */
  78
  79         TimeSelection const & time (editor.get_selection().time);
  80         if (!time.empty()) {
  81                 profile_manager->set_selection_range (time.front().start, time.front().end);
  82         } else {
  83                 profile_manager->set_selection_range ();
  84         }
  85
  86         /* Load states */
  87
  88         profile_manager->load_profile ();
  89         sync_with_manager ();
  90
  91         /* Warnings */
  92
  93         preset_selector->CriticalSelectionChanged.connect (sigc::mem_fun (*this, &ExportDialog::sync_with_manager));
  94         timespan_selector->CriticalSelectionChanged.connect (sigc::mem_fun (*this, &ExportDialog::update_warnings));
  95         channel_selector->CriticalSelectionChanged.connect (sigc::mem_fun (*this, &ExportDialog::update_warnings));
  96         file_notebook->CriticalSelectionChanged.connect (sigc::mem_fun (*this, &ExportDialog::update_warnings));
  97
  98         status->Aborting.connect (abort_connection, invalidator (*this), boost::bind (&ExportDialog::notify_errors, this), gui_context());
  99
 100         update_warnings ();
 101 }
 102
 103 void
 104 ExportDialog::init ()
 105 {
 106         init_components ();
 107         init_gui ();
 108
 109         /* warnings */
 110
 111         warning_widget.pack_start (warn_hbox, true, true, 6);
 112         warning_widget.pack_end (list_files_hbox, false, false, 0);
 113
 114         warn_hbox.pack_start (warn_label, true, true, 16);
 115         warn_label.set_use_markup (true);
 116
 117         list_files_hbox.pack_end (list_files_button, false, false, 6);
 118         list_files_hbox.pack_end (list_files_label, false, false, 6);
 119         list_files_label.set_use_markup (true);
 120
 121         list_files_button.signal_clicked().connect (sigc::mem_fun (*this, &ExportDialog::show_conflicting_files));
 122
 123         /* Progress indicators */
 124
 125         progress_widget.pack_start (progress_bar, false, false, 6);
 126
 127         /* Buttons */
 128
 129         cancel_button = add_button (Gtk::Stock::CANCEL, RESPONSE_CANCEL);
 130         // Realtime export is disabled for now, as it will most probably not work
 131         //rt_export_button = add_button (_("Realtime Export"), RESPONSE_RT);
 132         //fast_export_button = add_button (_("Fast Export"), RESPONSE_FAST);
 133         fast_export_button = add_button (_("Export"), RESPONSE_FAST);
 134         set_default_response (RESPONSE_FAST);
 135
 136         list_files_button.set_name ("PaddedButton");
 137
 138         cancel_button->signal_clicked().connect (sigc::mem_fun (*this, &ExportDialog::close_dialog));
 139         //rt_export_button->signal_clicked().connect (sigc::mem_fun (*this, &ExportDialog::export_rt));
 140         fast_export_button->signal_clicked().connect (sigc::mem_fun (*this, &ExportDialog::export_fw));
 141
 142         /* Done! */
 143
 144         show_all_children ();
 145         progress_widget.hide_all();
 146 }
 147
 148 void
 149 ExportDialog::init_gui ()
 150 {
 151         Gtk::Alignment * preset_align = Gtk::manage (new Gtk::Alignment());
 152         preset_align->add (*preset_selector);
 153         preset_align->set_padding (0, 12, 0, 0);
 154         get_vbox()->pack_start (*preset_align, false, false, 0);
 155
 156         Gtk::VBox* advanced_vbox = Gtk::manage (new Gtk::VBox());
 157         advanced_vbox->set_spacing (12);
 158         advanced_vbox->set_border_width (12);
 159
 160         Gtk::Alignment * timespan_align = Gtk::manage (new Gtk::Alignment());
 161         timespan_label = Gtk::manage (new Gtk::Label (_("Time Span"), Gtk::ALIGN_LEFT));
 162         timespan_align->add (*timespan_selector);
 163         timespan_align->set_padding (0, 12, 18, 0);
 164         advanced_vbox->pack_start (*timespan_label, false, false, 0);
 165         advanced_vbox->pack_start (*timespan_align, true, true, 0);
 166
 167         Gtk::Alignment * channels_align = Gtk::manage (new Gtk::Alignment());
 168         channels_label = Gtk::manage (new Gtk::Label (_("Channels"), Gtk::ALIGN_LEFT));
 169         channels_align->add (*channel_selector);
 170         channels_align->set_padding (0, 12, 18, 0);
 171         advanced_vbox->pack_start (*channels_label, false, false, 0);
 172         advanced_vbox->pack_start (*channels_align, false, false, 0);
 173
 174         get_vbox()->pack_start (*file_notebook, false, false, 0);
 175         get_vbox()->pack_start (warning_widget, false, false, 0);
 176         get_vbox()->pack_start (progress_widget, false, false, 0);
 177
 178         Gtk::Expander* advanced = Gtk::manage (new Gtk::Expander (_("Advanced options")));
 179         advanced->add (*advanced_vbox);
 180
 181         get_vbox()->pack_start (*advanced, true, true);
 182
 183         Pango::AttrList bold;
 184         Pango::Attribute b = Pango::Attribute::create_attr_weight (Pango::WEIGHT_BOLD);
 185         bold.insert (b);
 186
 187         timespan_label->set_attributes (bold);
 188         channels_label->set_attributes (bold);
 189 }
 190
 191 void
 192 ExportDialog::init_components ()
 193 {
 194         preset_selector.reset (new ExportPresetSelector ());
 195         timespan_selector.reset (new ExportTimespanSelectorMultiple (_session, profile_manager));
 196         channel_selector.reset (new PortExportChannelSelector (_session, profile_manager));
 197         file_notebook.reset (new ExportFileNotebook ());
 198 }
 199
 200 void
 201 ExportDialog::notify_errors ()
 202 {
 203         if (status->errors()) {
 204                 std::string txt = _("Export has been aborted due to an error!\nSee the Log for details.");
 205                 Gtk::MessageDialog msg (txt, false, Gtk::MESSAGE_ERROR, Gtk::BUTTONS_OK, true);
 206                 msg.run();
 207         }
 208 }
 209
 210 void
 211 ExportDialog::close_dialog ()
 212 {
 213         if (status->running) {
 214                 status->abort();
 215         }
 216
 217         hide_all ();
 218         set_modal (false);
 219
 220 }
 221
 222 void
 223 ExportDialog::sync_with_manager ()
 224 {
 225         timespan_selector->sync_with_manager();
 226         channel_selector->sync_with_manager();
 227         file_notebook->sync_with_manager ();
 228
 229         update_warnings ();
 230 }
 231
 232 void
 233 ExportDialog::update_warnings ()
 234 {
 235         /* Reset state */
 236
 237         warn_string = "";
 238         warn_label.set_markup (warn_string);
 239
 240         list_files_hbox.hide ();
 241         list_files_string = "";
 242
 243         fast_export_button->set_sensitive (true);
 244         //rt_export_button->set_sensitive (true);
 245
 246         /* Add new warnings */
 247
 248         boost::shared_ptr<ExportProfileManager::Warnings> warnings = profile_manager->get_warnings();
 249
 250         for (std::list<string>::iterator it = warnings->errors.begin(); it != warnings->errors.end(); ++it) {
 251                 add_error (*it);
 252         }
 253
 254         for (std::list<string>::iterator it = warnings->warnings.begin(); it != warnings->warnings.end(); ++it) {
 255                 add_warning (*it);
 256         }
 257
 258         if (!warnings->conflicting_filenames.empty()) {
 259                 list_files_hbox.show ();
 260                 for (std::list<string>::iterator it = warnings->conflicting_filenames.begin(); it != warnings->conflicting_filenames.end(); ++it) {
 261                         string::size_type pos = it->find_last_of ("/");
 262                         list_files_string += it->substr (0, pos + 1) + "<b>" + it->substr (pos + 1) + "</b>\n";
 263                 }
 264         }
 265 }
 266
 267 void
 268 ExportDialog::show_conflicting_files ()
 269 {
 270         ArdourDialog dialog (_("Files that will be overwritten"), true);
 271
 272         Gtk::Label label ("", Gtk::ALIGN_LEFT);
 273         label.set_use_markup (true);
 274         label.set_markup (list_files_string);
 275
 276         dialog.get_vbox()->pack_start (label);
 277         dialog.add_button (Gtk::Stock::OK, 0);
 278         dialog.show_all_children ();
 279
 280         dialog.run();
 281 }
 282
 283 void
 284 ExportDialog::export_rt ()
 285 {
 286         profile_manager->prepare_for_export ();
 287         handler->do_export (true);
 288         show_progress ();
 289 }
 290
 291 void
 292 ExportDialog::export_fw ()
 293 {
 294         profile_manager->prepare_for_export ();
 295         handler->do_export (false);
 296         show_progress ();
 297 }
 298
 299 void
 300 ExportDialog::show_progress ()
 301 {
 302         status->running = true;
 303
 304         cancel_button->set_label (_("Stop Export"));
 305         //rt_export_button->set_sensitive (false);
 306         fast_export_button->set_sensitive (false);
 307
 308         progress_bar.set_fraction (0.0);
 309         warning_widget.hide_all();
 310         progress_widget.show ();
 311         progress_widget.show_all_children ();
 312         progress_connection = Glib::signal_timeout().connect (sigc::mem_fun(*this, &ExportDialog::progress_timeout), 100);
 313
 314         gtk_main_iteration ();
 315         while (status->running) {
 316                 if (gtk_events_pending()) {
 317                         gtk_main_iteration ();
 318                 } else {
 319                         usleep (10000);
 320                 }
 321         }
 322
 323         if (!status->aborted()) {
 324                 status->finish ();
 325         }
 326 }
 327
 328 gint
 329 ExportDialog::progress_timeout ()
 330 {
 331         std::string status_text;
 332         float progress = 0.0;
 333         if (status->normalizing) {
 334                 status_text = string_compose (_("Normalizing timespan %1 of %2"),
 335                                                status->timespan, status->total_timespans);
 336                 progress = ((float) status->current_normalize_cycle) / status->total_normalize_cycles;
 337         } else {
 338                 status_text = string_compose (_("Exporting timespan %1 of %2"),
 339                                               status->timespan, status->total_timespans);
 340                 progress = ((float) status->processed_frames_current_timespan) / status->total_frames_current_timespan;
 341         }
 342         progress_bar.set_text (status_text);
 343
 344         if (progress < previous_progress) {
 345                 // Work around gtk bug
 346                 progress_bar.hide();
 347                 progress_bar.show();
 348         }
 349         previous_progress = progress;
 350
 351         progress_bar.set_fraction (progress);
 352         return TRUE;
 353 }
 354
 355 void
 356 ExportDialog::add_error (string const & text)
 357 {
 358         fast_export_button->set_sensitive (false);
 359         //rt_export_button->set_sensitive (false);
 360
 361         if (warn_string.empty()) {
 362                 warn_string = _("<span color=\"#ffa755\">Error: ") + text + "</span>";
 363         } else {
 364                 warn_string = _("<span color=\"#ffa755\">Error: ") + text + "</span>\n" + warn_string;
 365         }
 366
 367         warn_label.set_markup (warn_string);
 368 }
 369
 370 void
 371 ExportDialog::add_warning (string const & text)
 372 {
 373         if (warn_string.empty()) {
 374                 warn_string = _("<span color=\"#ffa755\">Warning: ") + text + "</span>";
 375         } else {
 376                 warn_string = warn_string + _("\n<span color=\"#ffa755\">Warning: ") + text + "</span>";
 377         }
 378
 379         warn_label.set_markup (warn_string);
 380 }
 381
 382 /*** Dialog specializations ***/
 383
 384 ExportRangeDialog::ExportRangeDialog (PublicEditor & editor, string range_id) :
 385   ExportDialog (editor, _("Export Range"), X_("RangeExportProfile")),
 386   range_id (range_id)
 387 {}
 388
 389 void
 390 ExportRangeDialog::init_components ()
 391 {
 392         preset_selector.reset (new ExportPresetSelector ());
 393         timespan_selector.reset (new ExportTimespanSelectorSingle (_session, profile_manager, range_id));
 394         channel_selector.reset (new PortExportChannelSelector (_session, profile_manager));
 395         file_notebook.reset (new ExportFileNotebook ());
 396 }
 397
 398 ExportSelectionDialog::ExportSelectionDialog (PublicEditor & editor) :
 399   ExportDialog (editor, _("Export Selection"), X_("SelectionExportProfile"))
 400 {}
 401
 402 void
 403 ExportSelectionDialog::init_components ()
 404 {
 405         preset_selector.reset (new ExportPresetSelector ());
 406         timespan_selector.reset (new ExportTimespanSelectorSingle (_session, profile_manager, X_("selection")));
 407         channel_selector.reset (new PortExportChannelSelector (_session, profile_manager));
 408         file_notebook.reset (new ExportFileNotebook ());
 409 }
 410
 411 ExportRegionDialog::ExportRegionDialog (PublicEditor & editor, ARDOUR::AudioRegion const & region, ARDOUR::AudioTrack & track) :
 412   ExportDialog (editor, _("Export Region"), X_("RegionExportProfile")),
 413   region (region),
 414   track (track)
 415 {}
 416
 417 void
 418 ExportRegionDialog::init_gui ()
 419 {
 420         ExportDialog::init_gui ();
 421
 422         channels_label->set_text (_("Source"));
 423 }
 424
 425 void
 426 ExportRegionDialog::init_components ()
 427 {
 428         string loc_id = profile_manager->set_single_range (region.position(), region.position() + region.length(), region.name());
 429
 430         preset_selector.reset (new ExportPresetSelector ());
 431         timespan_selector.reset (new ExportTimespanSelectorSingle (_session, profile_manager, loc_id));
 432         channel_selector.reset (new RegionExportChannelSelector (_session, profile_manager, region, track));
 433         file_notebook.reset (new ExportFileNotebook ());
 434 }
 435
 436 StemExportDialog::StemExportDialog (PublicEditor & editor)
 437   : ExportDialog(editor, _("Stem Export"), X_("StemExportProfile"))
 438 {
 439
 440 }
 441
 442 void
 443 StemExportDialog::init_components ()
 444 {
 445         preset_selector.reset (new ExportPresetSelector ());
 446         timespan_selector.reset (new ExportTimespanSelectorMultiple (_session, profile_manager));
 447         channel_selector.reset (new TrackExportChannelSelector (_session, profile_manager));
 448         file_notebook.reset (new ExportFileNotebook ());
 449 }