gtk2_ardour/export_timespan_selector.cc

   1 /*
   2  * Copyright (C) 2008-2013 Sakari Bergen <sakari.bergen@beatwaves.net>
   3  * Copyright (C) 2008-2017 Paul Davis <paul@linuxaudiosystems.com>
   4  * Copyright (C) 2009-2011 Carl Hetherington <carl@carlh.net>
   5  * Copyright (C) 2009-2012 David Robillard <d@drobilla.net>
   6  * Copyright (C) 2013-2014 Colin Fletcher <colin.m.fletcher@googlemail.com>
   7  * Copyright (C) 2015-2016 Tim Mayberry <mojofunk@gmail.com>
   8  * Copyright (C) 2015-2019 Robin Gareus <robin@gareus.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  23  */
  24
  25 #include <sstream>
  26 #include <iomanip>
  27
  28 #include "pbd/enumwriter.h"
  29 #include "pbd/string_convert.h"
  30
  31 #include "ardour/location.h"
  32 #include "ardour/types.h"
  33 #include "ardour/session.h"
  34 #include "ardour/export_handler.h"
  35 #include "ardour/export_timespan.h"
  36
  37 #include "export_timespan_selector.h"
  38
  39 #include "pbd/i18n.h"
  40
  41 using namespace Glib;
  42 using namespace ARDOUR;
  43 using namespace PBD;
  44 using std::string;
  45
  46 ExportTimespanSelector::ExportTimespanSelector (ARDOUR::Session * session, ProfileManagerPtr manager, bool multi)
  47         : manager (manager)
  48         , _realtime_available (true)
  49         , time_format_label (_("Show Times as:"), Gtk::ALIGN_LEFT)
  50         , realtime_checkbutton (_("Realtime Export"))
  51 {
  52         set_session (session);
  53
  54         option_hbox.pack_start (time_format_label, false, false, 0);
  55         option_hbox.pack_start (time_format_combo, false, false, 6);
  56
  57         if (multi) {
  58                 Gtk::Button* b = Gtk::manage (new Gtk::Button (_("Select All")));
  59                 b->signal_clicked().connect (
  60                                 sigc::bind (
  61                                         sigc::mem_fun (*this, &ExportTimespanSelector::set_selection_state_of_all_timespans), true
  62                                         )
  63                                 );
  64                 option_hbox.pack_start (*b, false, false, 6);
  65
  66                 b = Gtk::manage (new Gtk::Button (_("Deselect All")));
  67                 b->signal_clicked().connect (
  68                                 sigc::bind (
  69                                         sigc::mem_fun (*this, &ExportTimespanSelector::set_selection_state_of_all_timespans), false
  70                                         )
  71                                 );
  72                 option_hbox.pack_start (*b, false, false, 6);
  73         }
  74         option_hbox.pack_start (realtime_checkbutton, false, false, 6);
  75         realtime_checkbutton.set_active (session->config.get_realtime_export ());
  76
  77         realtime_checkbutton.signal_toggled ().connect (
  78                         sigc::mem_fun (*this, &ExportTimespanSelector::toggle_realtime)
  79                         );
  80
  81         range_scroller.add (range_view);
  82
  83         pack_start (option_hbox, false, false, 0);
  84         pack_start (range_scroller, true, true, 6);
  85
  86         /*** Combo boxes ***/
  87
  88         Gtk::TreeModel::iterator iter;
  89         Gtk::TreeModel::Row row;
  90
  91         /* Time format combo */
  92
  93         time_format_list = Gtk::ListStore::create (time_format_cols);
  94         time_format_combo.set_model (time_format_list);
  95
  96         iter = time_format_list->append();
  97         row = *iter;
  98         row[time_format_cols.format] = ExportProfileManager::Timecode;
  99         row[time_format_cols.label] = _("Timecode");
 100
 101         iter = time_format_list->append();
 102         row = *iter;
 103         row[time_format_cols.format] = ExportProfileManager::MinSec;
 104         row[time_format_cols.label] = _("Minutes:Seconds");
 105
 106         iter = time_format_list->append();
 107         row = *iter;
 108         row[time_format_cols.format] = ExportProfileManager::BBT;
 109         row[time_format_cols.label] = _("Bars:Beats");
 110
 111         time_format_combo.pack_start (time_format_cols.label);
 112         time_format_combo.set_active (0);
 113
 114         time_format_combo.signal_changed().connect (sigc::mem_fun (*this, &ExportTimespanSelector::change_time_format));
 115
 116         /* Range view */
 117
 118         range_list = Gtk::ListStore::create (range_cols);
 119         // order by location start times
 120         range_list->set_sort_column(range_cols.location, Gtk::SORT_ASCENDING);
 121         range_list->set_sort_func(range_cols.location, sigc::mem_fun(*this, &ExportTimespanSelector::location_sorter));
 122         range_view.set_model (range_list);
 123         range_view.set_headers_visible (true);
 124 }
 125
 126 ExportTimespanSelector::~ExportTimespanSelector ()
 127 {
 128
 129 }
 130
 131 int
 132 ExportTimespanSelector::location_sorter(Gtk::TreeModel::iterator a, Gtk::TreeModel::iterator b)
 133 {
 134         Location *l1 = (*a)[range_cols.location];
 135         Location *l2 = (*b)[range_cols.location];
 136         const Location *ls = _session->locations()->session_range_location();
 137
 138         // always sort session range first
 139         if (l1 == ls)
 140                 return -1;
 141         if (l2 == ls)
 142                 return +1;
 143
 144         return l1->start() - l2->start();
 145 }
 146
 147 void
 148 ExportTimespanSelector::add_range_to_selection (ARDOUR::Location const * loc, bool rt)
 149 {
 150         ExportTimespanPtr span = _session->get_export_handler()->add_timespan();
 151
 152         std::string id;
 153         if (loc == state->selection_range.get()) {
 154                 id = "selection";
 155         } else {
 156                 id = loc->id().to_s();
 157         }
 158
 159         span->set_range (loc->start(), loc->end());
 160         span->set_name (loc->name());
 161         span->set_range_id (id);
 162         span->set_realtime (rt);
 163         state->timespans->push_back (span);
 164 }
 165
 166 void
 167 ExportTimespanSelector::set_time_format_from_state ()
 168 {
 169         Gtk::TreeModel::Children::iterator tree_it;
 170         for (tree_it = time_format_list->children().begin(); tree_it != time_format_list->children().end(); ++tree_it) {
 171                 if (tree_it->get_value (time_format_cols.format) == state->time_format) {
 172                         time_format_combo.set_active (tree_it);
 173                 }
 174         }
 175 }
 176
 177 void
 178 ExportTimespanSelector::sync_with_manager ()
 179 {
 180         state = manager->get_timespans().front();
 181         fill_range_list ();
 182         CriticalSelectionChanged();
 183 }
 184
 185 void
 186 ExportTimespanSelector::allow_realtime_export (bool yn)
 187 {
 188         if (_realtime_available == yn) {
 189                 return;
 190         }
 191         _realtime_available = yn;
 192         realtime_checkbutton.set_sensitive (_realtime_available);
 193         update_timespans ();
 194 }
 195
 196 void
 197 ExportTimespanSelector::toggle_realtime ()
 198 {
 199         const bool realtime = !_session->config.get_realtime_export ();
 200         _session->config.set_realtime_export (realtime);
 201         realtime_checkbutton.set_inconsistent (false);
 202         realtime_checkbutton.set_active (realtime);
 203
 204         for (Gtk::TreeStore::Children::iterator it = range_list->children().begin(); it != range_list->children().end(); ++it) {
 205                 it->set_value (range_cols.realtime, realtime);
 206         }
 207 }
 208
 209 void
 210 ExportTimespanSelector::change_time_format ()
 211 {
 212         state->time_format = time_format_combo.get_active()->get_value (time_format_cols.format);
 213
 214         for (Gtk::ListStore::Children::iterator it = range_list->children().begin(); it != range_list->children().end(); ++it) {
 215                 Location * location = it->get_value (range_cols.location);
 216                 it->set_value (range_cols.label, construct_label (location));
 217                 it->set_value (range_cols.length, construct_length (location));
 218         }
 219 }
 220
 221 std::string
 222 ExportTimespanSelector::construct_label (ARDOUR::Location const * location) const
 223 {
 224         std::string label;
 225         std::string start;
 226         std::string end;
 227
 228         samplepos_t start_sample = location->start();
 229         samplepos_t end_sample = location->end();
 230
 231         switch (state->time_format) {
 232           case ExportProfileManager::BBT:
 233                 start = bbt_str (start_sample);
 234                 end = bbt_str (end_sample);
 235                 break;
 236
 237           case ExportProfileManager::Timecode:
 238                 start = timecode_str (start_sample);
 239                 end = timecode_str (end_sample);
 240                 break;
 241
 242           case ExportProfileManager::MinSec:
 243                 start = ms_str (start_sample);
 244                 end = ms_str (end_sample);
 245                 break;
 246
 247           case ExportProfileManager::Samples:
 248                 start = to_string (start_sample);
 249                 end = to_string (end_sample);
 250                 break;
 251         }
 252
 253         label += start;
 254         label += _(" to ");
 255         label += end;
 256
 257         return label;
 258 }
 259
 260 std::string
 261 ExportTimespanSelector::construct_length (ARDOUR::Location const * location) const
 262 {
 263         if (location->length() == 0) {
 264                 return "";
 265         }
 266
 267         std::stringstream s;
 268
 269         switch (state->time_format) {
 270         case ExportProfileManager::BBT:
 271                 s << bbt_str (location->length ());
 272                 break;
 273
 274         case ExportProfileManager::Timecode:
 275         {
 276                 Timecode::Time tc;
 277                 _session->timecode_duration (location->length(), tc);
 278                 tc.print (s);
 279                 break;
 280         }
 281
 282         case ExportProfileManager::MinSec:
 283                 s << ms_str (location->length ());
 284                 break;
 285
 286         case ExportProfileManager::Samples:
 287                 s << location->length ();
 288                 break;
 289         }
 290
 291         return s.str ();
 292 }
 293
 294
 295 std::string
 296 ExportTimespanSelector::bbt_str (samplepos_t samples) const
 297 {
 298         if (!_session) {
 299                 return "Error!";
 300         }
 301
 302         std::ostringstream oss;
 303         Timecode::BBT_Time time;
 304         _session->bbt_time (samples, time);
 305
 306         print_padded (oss, time);
 307         return oss.str ();
 308 }
 309
 310 std::string
 311 ExportTimespanSelector::timecode_str (samplecnt_t samples) const
 312 {
 313         if (!_session) {
 314                 return "Error!";
 315         }
 316
 317         std::ostringstream oss;
 318         Timecode::Time time;
 319
 320         _session->timecode_time (samples, time);
 321
 322         oss << std::setfill('0') << std::right <<
 323           std::setw(2) <<
 324           time.hours << ":" <<
 325           std::setw(2) <<
 326           time.minutes << ":" <<
 327           std::setw(2) <<
 328           time.seconds << ":" <<
 329           std::setw(2) <<
 330           time.frames;
 331
 332         return oss.str();
 333 }
 334
 335 std::string
 336 ExportTimespanSelector::ms_str (samplecnt_t samples) const
 337 {
 338         if (!_session) {
 339                 return "Error!";
 340         }
 341
 342         std::ostringstream oss;
 343         samplecnt_t left;
 344         int hrs;
 345         int mins;
 346         int secs;
 347         int sec_promilles;
 348
 349         left = samples;
 350         hrs = (int) floor (left / (_session->sample_rate() * 60.0f * 60.0f));
 351         left -= (samplecnt_t) floor (hrs * _session->sample_rate() * 60.0f * 60.0f);
 352         mins = (int) floor (left / (_session->sample_rate() * 60.0f));
 353         left -= (samplecnt_t) floor (mins * _session->sample_rate() * 60.0f);
 354         secs = (int) floor (left / (float) _session->sample_rate());
 355         left -= (samplecnt_t) floor ((double)(secs * _session->sample_rate()));
 356         sec_promilles = (int) (left * 1000 / (float) _session->sample_rate() + 0.5);
 357
 358         oss << std::setfill('0') << std::right <<
 359           std::setw(2) <<
 360           hrs << ":" <<
 361           std::setw(2) <<
 362           mins << ":" <<
 363           std::setw(2) <<
 364           secs << "." <<
 365           std::setw(3) <<
 366           sec_promilles;
 367
 368         return oss.str();
 369 }
 370
 371 void
 372 ExportTimespanSelector::update_range_name (std::string const & path, std::string const & new_text)
 373 {
 374         Gtk::TreeStore::iterator it = range_list->get_iter (path);
 375         it->get_value (range_cols.location)->set_name (new_text);
 376
 377         CriticalSelectionChanged();
 378 }
 379
 380 void
 381 ExportTimespanSelector::set_selection_state_of_all_timespans (bool s)
 382 {
 383         for (Gtk::ListStore::Children::iterator it = range_list->children().begin(); it != range_list->children().end(); ++it) {
 384                 it->set_value (range_cols.selected, s);
 385         }
 386 }
 387
 388 /*** ExportTimespanSelectorSingle ***/
 389
 390 ExportTimespanSelectorSingle::ExportTimespanSelectorSingle (ARDOUR::Session * session, ProfileManagerPtr manager, std::string range_id) :
 391         ExportTimespanSelector (session, manager, false),
 392         range_id (range_id)
 393 {
 394         range_scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_NEVER);
 395         range_view.append_column_editable (_("RT"), range_cols.realtime); // 0
 396         range_view.append_column_editable (_("Range"), range_cols.name); // 1
 397
 398         if (Gtk::CellRendererToggle * renderer = dynamic_cast<Gtk::CellRendererToggle *> (range_view.get_column_cell_renderer (0))) {
 399                 renderer->signal_toggled().connect (sigc::hide (sigc::mem_fun (*this, &ExportTimespanSelectorSingle::update_timespans)));
 400         }
 401
 402         if (Gtk::CellRendererText * renderer = dynamic_cast<Gtk::CellRendererText *> (range_view.get_column_cell_renderer (1))) {
 403                 renderer->signal_edited().connect (sigc::mem_fun (*this, &ExportTimespanSelectorSingle::update_range_name));
 404         }
 405
 406         Gtk::CellRendererText * label_render = Gtk::manage (new Gtk::CellRendererText());
 407         Gtk::TreeView::Column * label_col = Gtk::manage (new Gtk::TreeView::Column (_("Time Span"), *label_render));
 408         label_col->add_attribute (label_render->property_markup(), range_cols.label);
 409         range_view.append_column (*label_col); // 2
 410
 411         range_view.append_column (_("Length"), range_cols.length); // 3
 412         range_view.append_column (_("Creation Date"), range_cols.date); // 4
 413
 414         Gtk::TreeViewColumn* range_col = range_view.get_column (1); // "Range"
 415         range_col->set_sort_column (range_cols.name);
 416
 417         Gtk::TreeViewColumn* time_span_col = range_view.get_column (2); // "Time Span"
 418         time_span_col->set_sort_column (range_cols.start);
 419
 420         Gtk::TreeViewColumn* length_col = range_view.get_column (3); // "Length"
 421         length_col->set_sort_column (range_cols.length_actual);
 422
 423         Gtk::TreeViewColumn* date_col = range_view.get_column (4); // "Creation Date"
 424         date_col->set_sort_column (range_cols.timestamp);
 425 }
 426
 427 void
 428 ExportTimespanSelectorSingle::allow_realtime_export (bool yn)
 429 {
 430         ExportTimespanSelector::allow_realtime_export (yn);
 431         range_view.get_column (0)->set_visible (_realtime_available);
 432 }
 433
 434 void
 435 ExportTimespanSelectorSingle::fill_range_list ()
 436 {
 437         if (!state) { return; }
 438         const bool realtime = _session->config.get_realtime_export ();
 439
 440         std::string id;
 441         if (!range_id.compare (X_("selection"))) {
 442                 id = state->selection_range->id().to_s();
 443         } else {
 444                 id = range_id;
 445         }
 446
 447         range_list->clear();
 448         state->timespans->clear();
 449
 450         Gtk::TreeModel::iterator iter;
 451         Gtk::TreeModel::Row row;
 452         for (LocationList::const_iterator it = state->ranges->begin(); it != state->ranges->end(); ++it) {
 453
 454                 if (!(*it)->id().to_s().compare (id)) {
 455                         iter = range_list->append();
 456                         row = *iter;
 457
 458                         row[range_cols.location] = *it;
 459                         row[range_cols.selected] = true;
 460                         row[range_cols.realtime] = realtime;
 461                         row[range_cols.name] = (*it)->name();
 462                         row[range_cols.label] = construct_label (*it);
 463                         row[range_cols.length] = construct_length (*it);
 464                         //the actual samplecnt_t for sorting
 465                         row[range_cols.length_actual] = (*it)->length();
 466
 467                         //start samplecnt_t for sorting
 468                         row[range_cols.start] = (*it)->start();
 469
 470                         Glib::DateTime gdt(Glib::DateTime::create_now_local ((*it)->timestamp()));
 471                         row[range_cols.timestamp] = (*it)->timestamp();
 472                         row[range_cols.date] = gdt.format ("%F %H:%M");;
 473
 474
 475                         add_range_to_selection (*it, false);
 476
 477                         break;
 478                 }
 479         }
 480
 481         set_time_format_from_state();
 482 }
 483
 484 void
 485 ExportTimespanSelectorSingle::update_timespans ()
 486 {
 487         state->timespans->clear();
 488         const bool realtime = _session->config.get_realtime_export ();
 489         bool inconsistent = false;
 490
 491         for (Gtk::TreeStore::Children::iterator it = range_list->children().begin(); it != range_list->children().end(); ++it) {
 492                 add_range_to_selection (it->get_value (range_cols.location), it->get_value (range_cols.realtime) && _realtime_available);
 493                 if (it->get_value (range_cols.realtime) != realtime) {
 494                         inconsistent = true;
 495                 }
 496         }
 497         realtime_checkbutton.set_inconsistent (inconsistent);
 498 }
 499
 500 /*** ExportTimespanSelectorMultiple ***/
 501
 502 ExportTimespanSelectorMultiple::ExportTimespanSelectorMultiple (ARDOUR::Session * session, ProfileManagerPtr manager) :
 503   ExportTimespanSelector (session, manager, true)
 504 {
 505         range_scroller.set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
 506         range_view.append_column_editable ("", range_cols.selected);
 507         range_view.append_column_editable (_("RT"), range_cols.realtime);
 508         range_view.append_column_editable (_("Range"), range_cols.name);
 509
 510         if (Gtk::CellRendererToggle * renderer = dynamic_cast<Gtk::CellRendererToggle *> (range_view.get_column_cell_renderer (0))) {
 511                 renderer->signal_toggled().connect (sigc::hide (sigc::mem_fun (*this, &ExportTimespanSelectorMultiple::update_selection)));
 512         }
 513         if (Gtk::CellRendererToggle * renderer = dynamic_cast<Gtk::CellRendererToggle *> (range_view.get_column_cell_renderer (1))) {
 514                 renderer->signal_toggled().connect (sigc::hide (sigc::mem_fun (*this, &ExportTimespanSelectorMultiple::update_selection)));
 515         }
 516         if (Gtk::CellRendererText * renderer = dynamic_cast<Gtk::CellRendererText *> (range_view.get_column_cell_renderer (2))) {
 517                 renderer->signal_edited().connect (sigc::mem_fun (*this, &ExportTimespanSelectorMultiple::update_range_name));
 518         }
 519
 520         Gtk::CellRendererText * label_render = Gtk::manage (new Gtk::CellRendererText());
 521         Gtk::TreeView::Column * label_col = Gtk::manage (new Gtk::TreeView::Column (_("Time Span"), *label_render));
 522         label_col->add_attribute (label_render->property_markup(), range_cols.label);
 523         range_view.append_column (*label_col); // 3
 524
 525         range_view.append_column (_("Length"), range_cols.length); // 4
 526         range_view.append_column (_("Creation Date"), range_cols.date); // 5
 527
 528         Gtk::TreeViewColumn* range_col = range_view.get_column (2); // "Range"
 529         range_col->set_sort_column (range_cols.name);
 530
 531         Gtk::TreeViewColumn* time_span_col = range_view.get_column (3); // "Time Span"
 532         time_span_col->set_sort_column (range_cols.start);
 533
 534         Gtk::TreeViewColumn* length_col = range_view.get_column (4); // "Length"
 535         length_col->set_sort_column (range_cols.length_actual);
 536
 537         Gtk::TreeViewColumn* date_col = range_view.get_column (5); // "Creation Date"
 538         date_col->set_sort_column (range_cols.timestamp);
 539 }
 540
 541 void
 542 ExportTimespanSelectorMultiple::allow_realtime_export (bool yn)
 543 {
 544         ExportTimespanSelector::allow_realtime_export (yn);
 545         range_view.get_column (1)->set_visible (_realtime_available);
 546 }
 547
 548 void
 549 ExportTimespanSelectorMultiple::fill_range_list ()
 550 {
 551         if (!state) { return; }
 552         const bool realtime = _session->config.get_realtime_export ();
 553
 554         range_list->clear();
 555
 556         Gtk::TreeModel::iterator iter;
 557         Gtk::TreeModel::Row row;
 558         for (LocationList::const_iterator it = state->ranges->begin(); it != state->ranges->end(); ++it) {
 559
 560                 iter = range_list->append();
 561                 row = *iter;
 562
 563                 row[range_cols.location] = *it;
 564                 row[range_cols.selected] = false;
 565                 row[range_cols.realtime] = realtime;
 566                 row[range_cols.name] = (*it)->name();
 567                 row[range_cols.label] = construct_label (*it);
 568                 row[range_cols.length] = construct_length (*it);
 569                 //the actual samplecnt_t for sorting
 570                 row[range_cols.length_actual] = (*it)->length();
 571
 572                 //start samplecnt_t for sorting
 573                 row[range_cols.start] = (*it)->start();
 574
 575                 Glib::DateTime gdt(Glib::DateTime::create_now_local ((*it)->timestamp()));
 576                 row[range_cols.timestamp] = (*it)->timestamp();
 577                 row[range_cols.date] = gdt.format ("%F %H:%M");;
 578
 579         }
 580
 581         set_selection_from_state ();
 582 }
 583
 584 void
 585 ExportTimespanSelectorMultiple::set_selection_from_state ()
 586 {
 587         Gtk::TreeModel::Children::iterator tree_it;
 588
 589         for (TimespanList::iterator it = state->timespans->begin(); it != state->timespans->end(); ++it) {
 590                 string id = (*it)->range_id();
 591                 for (tree_it = range_list->children().begin(); tree_it != range_list->children().end(); ++tree_it) {
 592                         Location * loc = tree_it->get_value (range_cols.location);
 593
 594                         if ((id == "selection" && loc == state->selection_range.get()) ||
 595                             (id == loc->id().to_s())) {
 596                                 tree_it->set_value (range_cols.selected, true);
 597                                 tree_it->set_value (range_cols.realtime, (*it)->realtime ());
 598                         }
 599                 }
 600         }
 601
 602         set_time_format_from_state();
 603 }
 604
 605 void
 606 ExportTimespanSelectorMultiple::update_selection ()
 607 {
 608         update_timespans ();
 609         CriticalSelectionChanged ();
 610 }
 611
 612 void
 613 ExportTimespanSelectorMultiple::update_timespans ()
 614 {
 615         state->timespans->clear();
 616         const bool realtime = _session->config.get_realtime_export ();
 617         bool inconsistent = false;
 618
 619         for (Gtk::TreeStore::Children::iterator it = range_list->children().begin(); it != range_list->children().end(); ++it) {
 620                 if (it->get_value (range_cols.selected)) {
 621                         add_range_to_selection (it->get_value (range_cols.location), it->get_value (range_cols.realtime) && _realtime_available);
 622                 }
 623                 if (it->get_value (range_cols.realtime) != realtime) {
 624                         inconsistent = true;
 625                 }
 626         }
 627         realtime_checkbutton.set_inconsistent (inconsistent);
 628 }
 629