2 Copyright (C) 2000-2005 Paul Davis
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.
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.
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.
26 #include "pbd/basename.h"
27 #include "pbd/enumwriter.h"
29 #include "ardour/audioregion.h"
30 #include "ardour/audiofilesource.h"
31 #include "ardour/silentfilesource.h"
32 #include "ardour/region_factory.h"
33 #include "ardour/session.h"
34 #include "ardour/profile.h"
36 #include "gtkmm2ext/choice.h"
37 #include "gtkmm2ext/treeutils.h"
39 #include "audio_clock.h"
43 #include "ardour_ui.h"
44 #include "gui_thread.h"
46 #include "region_view.h"
48 #include "editor_regions.h"
49 #include "editor_drag.h"
50 #include "main_clock.h"
55 using namespace ARDOUR;
56 using namespace ARDOUR_UI_UTILS;
60 using namespace Editing;
61 using Gtkmm2ext::Keyboard;
69 EditorRegions::EditorRegions (Editor* e)
74 , _show_automatic_regions (true)
75 , ignore_region_list_selection_change (false)
76 , ignore_selected_region_change (false)
77 , _no_redisplay (false)
78 , _sort_type ((Editing::RegionListSortType) 0)
81 _display.set_size_request (100, -1);
82 _display.set_rules_hint (true);
83 _display.set_name ("EditGroupList");
85 /* Try to prevent single mouse presses from initiating edits.
86 This relies on a hack in gtktreeview.c:gtk_treeview_button_press()
88 _display.set_data ("mouse-edits-require-mod1", (gpointer) 0x1);
90 _model = TreeStore::create (_columns);
91 _model->set_sort_func (0, sigc::mem_fun (*this, &EditorRegions::sorter));
92 _model->set_sort_column (0, SORT_ASCENDING);
94 _display.set_model (_model);
96 _display.append_column ("", _columns.name);
97 _display.append_column ("", _columns.position);
98 _display.append_column ("", _columns.end);
99 _display.append_column ("", _columns.length);
100 _display.append_column ("", _columns.sync);
101 _display.append_column ("", _columns.fadein);
102 _display.append_column ("", _columns.fadeout);
103 _display.append_column ("", _columns.locked);
104 _display.append_column ("", _columns.glued);
105 _display.append_column ("", _columns.muted);
106 _display.append_column ("", _columns.opaque);
112 { 0, _("Region"), _("Region name, with number of channels in []'s") },
113 { 1, _("Position"), _("Position of start of region") },
114 { 2, _("End"), _("Position of end of region") },
115 { 3, _("Length"), _("Length of the region") },
116 { 4, _("Sync"), _("Position of region sync point, relative to start of the region") },
117 { 5, _("Fade In"), _("Length of region fade-in (units: secondary clock), () if disabled") },
118 { 6, _("Fade Out"), _("Length of region fade-out (units: secondary clock), () if disabled") },
119 { 7, S_("Lock|L"), _("Region position locked?") },
120 { 8, S_("Gain|G"), _("Region position glued to Bars|Beats time?") },
121 { 9, S_("Mute|M"), _("Region muted?") },
122 { 10, S_("Opaque|O"), _("Region opaque (blocks regions below it from being heard)?") },
126 for (int i = 0; ci[i].index >= 0; ++i) {
127 col = _display.get_column (ci[i].index);
128 l = manage (new Label (ci[i].label));
129 ARDOUR_UI::instance()->set_tip (*l, ci[i].tooltip);
130 col->set_widget (*l);
133 if (ci[i].index > 6) {
134 col->set_expand (false);
135 col->set_alignment (ALIGN_CENTER);
139 _display.set_headers_visible (true);
140 _display.set_rules_hint ();
142 /* show path as the row tooltip */
143 _display.set_tooltip_column (14); /* path */
145 CellRendererText* region_name_cell = dynamic_cast<CellRendererText*>(_display.get_column_cell_renderer (0));
146 region_name_cell->property_editable() = true;
147 region_name_cell->signal_edited().connect (sigc::mem_fun (*this, &EditorRegions::name_edit));
148 region_name_cell->signal_editing_started().connect (sigc::mem_fun (*this, &EditorRegions::name_editing_started));
150 _display.get_selection()->set_select_function (sigc::mem_fun (*this, &EditorRegions::selection_filter));
152 TreeViewColumn* tv_col = _display.get_column(0);
153 CellRendererText* renderer = dynamic_cast<CellRendererText*>(_display.get_column_cell_renderer (0));
154 tv_col->add_attribute(renderer->property_text(), _columns.name);
155 tv_col->add_attribute(renderer->property_foreground_gdk(), _columns.color_);
156 tv_col->set_expand (true);
158 CellRendererToggle* locked_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (7));
159 locked_cell->property_activatable() = true;
160 locked_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::locked_changed));
162 TreeViewColumn* locked_col = _display.get_column (7);
163 locked_col->add_attribute (locked_cell->property_visible(), _columns.property_toggles_visible);
165 CellRendererToggle* glued_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (8));
166 glued_cell->property_activatable() = true;
167 glued_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::glued_changed));
169 TreeViewColumn* glued_col = _display.get_column (8);
170 glued_col->add_attribute (glued_cell->property_visible(), _columns.property_toggles_visible);
172 CellRendererToggle* muted_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (9));
173 muted_cell->property_activatable() = true;
174 muted_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::muted_changed));
176 TreeViewColumn* muted_col = _display.get_column (9);
177 muted_col->add_attribute (muted_cell->property_visible(), _columns.property_toggles_visible);
179 CellRendererToggle* opaque_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (10));
180 opaque_cell->property_activatable() = true;
181 opaque_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::opaque_changed));
183 TreeViewColumn* opaque_col = _display.get_column (10);
184 opaque_col->add_attribute (opaque_cell->property_visible(), _columns.property_toggles_visible);
186 _display.get_selection()->set_mode (SELECTION_MULTIPLE);
187 _display.add_object_drag (_columns.region.index(), "regions");
189 /* setup DnD handling */
191 list<TargetEntry> region_list_target_table;
193 region_list_target_table.push_back (TargetEntry ("text/plain"));
194 region_list_target_table.push_back (TargetEntry ("text/uri-list"));
195 region_list_target_table.push_back (TargetEntry ("application/x-rootwin-drop"));
197 _display.add_drop_targets (region_list_target_table);
198 _display.signal_drag_data_received().connect (sigc::mem_fun(*this, &EditorRegions::drag_data_received));
200 _scroller.add (_display);
201 _scroller.set_policy (POLICY_AUTOMATIC, POLICY_AUTOMATIC);
203 _display.signal_button_press_event().connect (sigc::mem_fun(*this, &EditorRegions::button_press), false);
204 _change_connection = _display.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &EditorRegions::selection_changed));
206 _scroller.signal_key_press_event().connect (sigc::mem_fun(*this, &EditorRegions::key_press), false);
207 _scroller.signal_focus_in_event().connect (sigc::mem_fun (*this, &EditorRegions::focus_in), false);
208 _scroller.signal_focus_out_event().connect (sigc::mem_fun (*this, &EditorRegions::focus_out));
210 _display.signal_enter_notify_event().connect (sigc::mem_fun (*this, &EditorRegions::enter_notify), false);
211 _display.signal_leave_notify_event().connect (sigc::mem_fun (*this, &EditorRegions::leave_notify), false);
213 // _display.signal_popup_menu().connect (sigc::bind (sigc::mem_fun (*this, &Editor::show__display_context_menu), 1, 0));
215 //ARDOUR_UI::instance()->secondary_clock.mode_changed.connect (sigc::mem_fun(*this, &Editor::redisplay_regions));
216 ARDOUR_UI::instance()->secondary_clock->mode_changed.connect (sigc::mem_fun(*this, &EditorRegions::update_all_rows));
217 ARDOUR::Region::RegionPropertyChanged.connect (region_property_connection, MISSING_INVALIDATOR, boost::bind (&EditorRegions::region_changed, this, _1, _2), gui_context());
218 ARDOUR::RegionFactory::CheckNewRegion.connect (check_new_region_connection, MISSING_INVALIDATOR, boost::bind (&EditorRegions::add_region, this, _1), gui_context());
220 e->EditorFreeze.connect (editor_freeze_connection, MISSING_INVALIDATOR, boost::bind (&EditorRegions::freeze_tree_model, this), gui_context());
221 e->EditorThaw.connect (editor_thaw_connection, MISSING_INVALIDATOR, boost::bind (&EditorRegions::thaw_tree_model, this), gui_context());
225 EditorRegions::focus_in (GdkEventFocus*)
227 Window* win = dynamic_cast<Window*> (_scroller.get_toplevel ());
230 old_focus = win->get_focus ();
237 /* try to do nothing on focus in (doesn't work, hence selection_count nonsense) */
242 EditorRegions::focus_out (GdkEventFocus*)
245 old_focus->grab_focus ();
255 EditorRegions::enter_notify (GdkEventCrossing*)
261 /* arm counter so that ::selection_filter() will deny selecting anything for the
262 next two attempts to change selection status.
264 _scroller.grab_focus ();
265 Keyboard::magic_widget_grab_focus ();
270 EditorRegions::leave_notify (GdkEventCrossing*)
273 old_focus->grab_focus ();
277 Keyboard::magic_widget_drop_focus ();
282 EditorRegions::set_session (ARDOUR::Session* s)
284 SessionHandlePtr::set_session (s);
289 EditorRegions::add_region (boost::shared_ptr<Region> region)
291 if (!region || !_session) {
298 bool missing_source = boost::dynamic_pointer_cast<SilentFileSource>(region->source()) != NULL;
300 if (!_show_automatic_regions && region->automatic()) {
304 if (region->hidden()) {
306 TreeModel::iterator iter = _model->get_iter ("0");
307 TreeModel::Row parent;
310 parent = *(_model->append());
311 parent[_columns.name] = _("Hidden");
312 boost::shared_ptr<Region> proxy = parent[_columns.region];
315 string s = (*iter)[_columns.name];
316 if (s != _("Hidden")) {
317 parent = *(_model->insert(iter));
318 parent[_columns.name] = _("Hidden");
319 boost::shared_ptr<Region> proxy = parent[_columns.region];
326 row = *(_model->append (parent.children()));
328 } else if (region->whole_file()) {
330 TreeModel::iterator i;
331 TreeModel::Children rows = _model->children();
333 for (i = rows.begin(); i != rows.end(); ++i) {
334 boost::shared_ptr<Region> rr = (*i)[_columns.region];
336 if (rr && region->region_list_equivalent (rr)) {
341 row = *(_model->append());
343 if (missing_source) {
344 // c.set_rgb(65535,0,0); // FIXME: error color from style
345 set_color_from_rgba (c, ARDOUR_UI::config()->color ("region list missing source"));
347 } else if (region->automatic()){
348 // c.set_rgb(0,65535,0); // FIXME: error color from style
349 set_color_from_rgba (c, ARDOUR_UI::config()->color ("region list automatic"));
352 set_color_from_rgba (c, ARDOUR_UI::config()->color ("region list whole file"));
355 row[_columns.color_] = c;
357 if (region->source()->name()[0] == '/') { // external file
359 if (region->whole_file()) {
361 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(region->source());
365 str = region_name_from_path (afs->path(), region->n_channels() > 1);
367 str += region->source()->name();
371 str = region->name();
375 str = region->name();
378 if (region->n_channels() > 1) {
379 std::stringstream foo;
380 foo << region->n_channels ();
386 row[_columns.name] = str;
387 row[_columns.region] = region;
388 row[_columns.property_toggles_visible] = false;
390 if (missing_source) {
391 row[_columns.path] = _("(MISSING) ") + region->source()->name();
394 boost::shared_ptr<FileSource> fs = boost::dynamic_pointer_cast<FileSource>(region->source());
396 row[_columns.path] = fs->path();
398 row[_columns.path] = region->source()->name();
402 region_row_map.insert(pair<boost::shared_ptr<ARDOUR::Region>, Gtk::TreeModel::RowReference>(region, TreeRowReference(_model, TreePath (row))) );
403 parent_regions_sources_map.insert(pair<string, Gtk::TreeModel::RowReference>(region->source_string(), TreeRowReference(_model, TreePath (row))) );
408 // find parent node, add as new child
409 TreeModel::iterator i;
411 boost::unordered_map<string, Gtk::TreeModel::RowReference>::iterator it;
413 it = parent_regions_sources_map.find (region->source_string());
415 if (it != parent_regions_sources_map.end()){
417 TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
419 TreeModel::iterator ii;
420 TreeModel::Children subrows = (*j).children();
422 /* XXXX: should we be accounting for all regions? */
424 for (ii = subrows.begin(); ii != subrows.end(); ++ii) {
425 boost::shared_ptr<Region> rr = (*ii)[_columns.region];
427 if (region->region_list_equivalent (rr)) {
433 row = *(_model->insert (subrows.end()));
436 row = *(_model->append());
439 row[_columns.property_toggles_visible] = true;
442 row[_columns.region] = region;
444 region_row_map.insert(pair<boost::shared_ptr<ARDOUR::Region>, Gtk::TreeModel::RowReference>(region, TreeRowReference(_model, TreePath (row))) );
446 populate_row(region, (*row));
450 EditorRegions::remove_unused_regions ()
452 vector<string> choices;
459 prompt = _("Do you really want to remove unused regions?"
460 "\n(This is destructive and cannot be undone)");
462 choices.push_back (_("No, do nothing."));
463 choices.push_back (_("Yes, remove."));
465 Gtkmm2ext::Choice prompter (_("Remove unused regions"), prompt, choices);
467 if (prompter.run () == 1) {
468 _no_redisplay = true;
469 _session->cleanup_regions ();
470 _no_redisplay = false;
476 EditorRegions::region_changed (boost::shared_ptr<Region> r, const PropertyChange& what_changed)
478 PropertyChange our_interests;
480 our_interests.add (ARDOUR::Properties::name);
481 our_interests.add (ARDOUR::Properties::position);
482 our_interests.add (ARDOUR::Properties::length);
483 our_interests.add (ARDOUR::Properties::start);
484 our_interests.add (ARDOUR::Properties::locked);
485 our_interests.add (ARDOUR::Properties::position_lock_style);
486 our_interests.add (ARDOUR::Properties::muted);
487 our_interests.add (ARDOUR::Properties::opaque);
488 our_interests.add (ARDOUR::Properties::fade_in);
489 our_interests.add (ARDOUR::Properties::fade_out);
490 our_interests.add (ARDOUR::Properties::fade_in_active);
491 our_interests.add (ARDOUR::Properties::fade_out_active);
493 if (what_changed.contains (our_interests)) {
497 TreeModel::iterator j = _model->get_iter (last_row.get_path());
498 boost::shared_ptr<Region> c = (*j)[_columns.region];
501 populate_row (r, (*j));
503 if (what_changed.contains (ARDOUR::Properties::hidden)) {
511 RegionRowMap::iterator it;
513 it = region_row_map.find (r);
515 if (it != region_row_map.end()){
517 TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
518 boost::shared_ptr<Region> c = (*j)[_columns.region];
521 populate_row (r, (*j));
523 if (what_changed.contains (ARDOUR::Properties::hidden)) {
532 if (what_changed.contains (ARDOUR::Properties::hidden)) {
538 EditorRegions::selection_changed ()
540 if (ignore_region_list_selection_change) {
544 _editor->_region_selection_change_updates_region_list = false;
546 if (_display.get_selection()->count_selected_rows() > 0) {
549 TreeView::Selection::ListHandle_Path rows = _display.get_selection()->get_selected_rows ();
551 _editor->get_selection().clear_regions ();
553 for (TreeView::Selection::ListHandle_Path::iterator i = rows.begin(); i != rows.end(); ++i) {
555 if ((iter = _model->get_iter (*i))) {
557 boost::shared_ptr<Region> region = (*iter)[_columns.region];
559 // they could have clicked on a row that is just a placeholder, like "Hidden"
560 // although that is not allowed by our selection filter. check it anyway
561 // since we need a region ptr.
565 _change_connection.block (true);
566 _editor->set_selected_regionview_from_region_list (region, Selection::Add);
567 _change_connection.block (false);
573 _editor->get_selection().clear_regions ();
576 _editor->_region_selection_change_updates_region_list = true;
580 EditorRegions::set_selected (RegionSelection& regions)
582 for (RegionSelection::iterator i = regions.begin(); i != regions.end(); ++i) {
584 boost::shared_ptr<Region> r ((*i)->region());
586 RegionRowMap::iterator it;
588 it = region_row_map.find (r);
590 if (it != region_row_map.end()){
591 TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
592 _display.get_selection()->select(*j);
598 EditorRegions::redisplay ()
600 if (_no_redisplay || !_session) {
604 bool tree_expanded = false;
606 /* If the list was expanded prior to rebuilding, expand it again afterwards */
607 if (toggle_full_action()->get_active()) {
608 tree_expanded = true;
611 _display.set_model (Glib::RefPtr<Gtk::TreeStore>(0));
613 _model->set_sort_column (-2, SORT_ASCENDING); //Disable sorting to gain performance
616 region_row_map.clear();
617 parent_regions_sources_map.clear();
619 /* now add everything we have, via a temporary list used to help with sorting */
621 const RegionFactory::RegionMap& regions (RegionFactory::regions());
623 for (RegionFactory::RegionMap::const_iterator i = regions.begin(); i != regions.end(); ++i) {
625 if ( i->second->whole_file()) {
626 /* add automatic regions first so that children can find their parents as we add them */
627 add_region (i->second);
631 tmp_region_list.push_front (i->second);
634 for (list<boost::shared_ptr<Region> >::iterator r = tmp_region_list.begin(); r != tmp_region_list.end(); ++r) {
638 _model->set_sort_column (0, SORT_ASCENDING); // renabale sorting
639 _display.set_model (_model);
641 tmp_region_list.clear();
644 _display.expand_all();
649 EditorRegions::update_row (boost::shared_ptr<Region> region)
651 if (!region || !_session) {
655 RegionRowMap::iterator it;
657 it = region_row_map.find (region);
659 if (it != region_row_map.end()){
661 TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
662 populate_row(region, (*j));
667 EditorRegions::update_all_rows ()
673 RegionRowMap::iterator i;
675 for (i = region_row_map.begin(); i != region_row_map.end(); ++i) {
677 TreeModel::iterator j = _model->get_iter ((*i).second.get_path());
679 boost::shared_ptr<Region> region = (*j)[_columns.region];
681 if (!region->automatic()) {
682 populate_row(region, (*j));
688 EditorRegions::format_position (framepos_t pos, char* buf, size_t bufsize, bool onoff)
690 Timecode::BBT_Time bbt;
691 Timecode::Time timecode;
694 error << string_compose (_("EditorRegions::format_position: negative timecode position: %1"), pos) << endmsg;
695 snprintf (buf, bufsize, "invalid");
699 switch (ARDOUR_UI::instance()->secondary_clock->mode ()) {
700 case AudioClock::BBT:
701 _session->tempo_map().bbt_time (pos, bbt);
703 snprintf (buf, bufsize, "%03d|%02d|%04d" , bbt.bars, bbt.beats, bbt.ticks);
705 snprintf (buf, bufsize, "(%03d|%02d|%04d)" , bbt.bars, bbt.beats, bbt.ticks);
709 case AudioClock::MinSec:
716 hrs = (int) floor (left / (_session->frame_rate() * 60.0f * 60.0f));
717 left -= (framecnt_t) floor (hrs * _session->frame_rate() * 60.0f * 60.0f);
718 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
719 left -= (framecnt_t) floor (mins * _session->frame_rate() * 60.0f);
720 secs = left / (float) _session->frame_rate();
722 snprintf (buf, bufsize, "%02d:%02d:%06.3f", hrs, mins, secs);
724 snprintf (buf, bufsize, "(%02d:%02d:%06.3f)", hrs, mins, secs);
728 case AudioClock::Frames:
730 snprintf (buf, bufsize, "%" PRId64, pos);
732 snprintf (buf, bufsize, "(%" PRId64 ")", pos);
736 case AudioClock::Timecode:
738 _session->timecode_time (pos, timecode);
740 snprintf (buf, bufsize, "%02d:%02d:%02d:%02d", timecode.hours, timecode.minutes, timecode.seconds, timecode.frames);
742 snprintf (buf, bufsize, "(%02d:%02d:%02d:%02d)", timecode.hours, timecode.minutes, timecode.seconds, timecode.frames);
749 EditorRegions::populate_row (boost::shared_ptr<Region> region, TreeModel::Row const &row)
751 boost::shared_ptr<AudioRegion> audioregion = boost::dynamic_pointer_cast<AudioRegion>(region);
752 //uint32_t used = _session->playlists->region_use_count (region);
753 /* Presently a region is only used once so let's save on the sequential scan to determine use count */
756 populate_row_position (region, row, used);
757 populate_row_end (region, row, used);
758 populate_row_sync (region, row, used);
759 populate_row_fade_in (region, row, used, audioregion);
760 populate_row_fade_out (region, row, used, audioregion);
761 populate_row_locked (region, row, used);
762 populate_row_glued (region, row, used);
763 populate_row_muted (region, row, used);
764 populate_row_opaque (region, row, used);
765 populate_row_length (region, row);
766 populate_row_source (region, row);
767 populate_row_name (region, row);
768 populate_row_used (region, row, used);
772 if (audioRegion && fades_in_seconds) {
778 left = audioRegion->fade_in()->back()->when;
779 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
780 left -= (framepos_t) floor (mins * _session->frame_rate() * 60.0f);
781 millisecs = (int) floor ((left * 1000.0f) / _session->frame_rate());
783 if (audioRegion->fade_in()->back()->when >= _session->frame_rate()) {
784 sprintf (fadein_str, "%01dM %01dmS", mins, millisecs);
786 sprintf (fadein_str, "%01dmS", millisecs);
789 left = audioRegion->fade_out()->back()->when;
790 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
791 left -= (framepos_t) floor (mins * _session->frame_rate() * 60.0f);
792 millisecs = (int) floor ((left * 1000.0f) / _session->frame_rate());
794 if (audioRegion->fade_out()->back()->when >= _session->frame_rate()) {
795 sprintf (fadeout_str, "%01dM %01dmS", mins, millisecs);
797 sprintf (fadeout_str, "%01dmS", millisecs);
803 EditorRegions::populate_row_used (boost::shared_ptr<Region>, TreeModel::Row const& row, uint32_t used)
806 snprintf (buf, sizeof (buf), "%4d" , used);
807 row[_columns.used] = buf;
811 EditorRegions::populate_row_length (boost::shared_ptr<Region> region, TreeModel::Row const &row)
814 format_position (region->length(), buf, sizeof (buf));
815 row[_columns.length] = buf;
819 EditorRegions::populate_row_end (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
821 if (region->whole_file()) {
822 row[_columns.end] = "";
823 } else if (used > 1) {
824 row[_columns.end] = _("Mult.");
825 } else if (region->last_frame() >= region->first_frame()) {
827 format_position (region->last_frame(), buf, sizeof (buf));
828 row[_columns.end] = buf;
830 row[_columns.end] = "empty";
835 EditorRegions::populate_row_position (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
837 if (region->whole_file()) {
838 row[_columns.position] = "";
839 } else if (used > 1) {
840 row[_columns.position] = _("Mult.");
843 format_position (region->position(), buf, sizeof (buf));
844 row[_columns.position] = buf;
849 EditorRegions::populate_row_sync (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
851 if (region->whole_file()) {
852 row[_columns.sync] = "";
853 } else if (used > 1) {
854 row[_columns.sync] = _("Mult."); /* translators: a short phrase for "multiple" as in "many" */
856 if (region->sync_position() == region->position()) {
857 row[_columns.sync] = _("Start");
858 } else if (region->sync_position() == (region->last_frame())) {
859 row[_columns.sync] = _("End");
862 format_position (region->sync_position(), buf, sizeof (buf));
863 row[_columns.sync] = buf;
869 EditorRegions::populate_row_fade_in (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used, boost::shared_ptr<AudioRegion> audioregion)
871 if (!audioregion || region->whole_file()) {
872 row[_columns.fadein] = "";
875 row[_columns.fadein] = _("Multiple");
878 format_position (audioregion->fade_in()->back()->when, buf, sizeof (buf), audioregion->fade_in_active());
879 row[_columns.fadein] = buf;
885 EditorRegions::populate_row_fade_out (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used, boost::shared_ptr<AudioRegion> audioregion)
887 if (!audioregion || region->whole_file()) {
888 row[_columns.fadeout] = "";
891 row[_columns.fadeout] = _("Multiple");
894 format_position (audioregion->fade_out()->back()->when, buf, sizeof (buf), audioregion->fade_out_active());
895 row[_columns.fadeout] = buf;
901 EditorRegions::populate_row_locked (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
903 if (region->whole_file()) {
904 row[_columns.locked] = false;
905 } else if (used > 1) {
906 row[_columns.locked] = false;
908 row[_columns.locked] = region->locked();
913 EditorRegions::populate_row_glued (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
915 if (region->whole_file() || used > 1) {
916 row[_columns.glued] = false;
918 if (region->position_lock_style() == MusicTime) {
919 row[_columns.glued] = true;
921 row[_columns.glued] = false;
927 EditorRegions::populate_row_muted (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
929 if (region->whole_file() || used > 1) {
930 row[_columns.muted] = false;
932 row[_columns.muted] = region->muted();
937 EditorRegions::populate_row_opaque (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
939 if (region->whole_file() || used > 1) {
940 row[_columns.opaque] = false;
942 row[_columns.opaque] = region->opaque();
947 EditorRegions::populate_row_name (boost::shared_ptr<Region> region, TreeModel::Row const &row)
949 if (region->n_channels() > 1) {
950 row[_columns.name] = string_compose("%1 [%2]", region->name(), region->n_channels());
952 row[_columns.name] = region->name();
957 EditorRegions::populate_row_source (boost::shared_ptr<Region> region, TreeModel::Row const &row)
959 if (boost::dynamic_pointer_cast<SilentFileSource>(region->source())) {
960 row[_columns.path] = _("MISSING ") + region->source()->name();
962 row[_columns.path] = region->source()->name();
967 EditorRegions::toggle_show_auto_regions ()
969 _show_automatic_regions = toggle_show_auto_regions_action()->get_active();
974 EditorRegions::toggle_full ()
976 set_full (toggle_full_action()->get_active ());
980 EditorRegions::set_full (bool f)
983 _display.expand_all ();
986 _display.collapse_all ();
992 EditorRegions::show_context_menu (int button, int time)
995 _menu = dynamic_cast<Menu*> (ActionManager::get_widget ("/RegionListMenu"));
998 if (_display.get_selection()->count_selected_rows() > 0) {
999 ActionManager::set_sensitive (ActionManager::region_list_selection_sensitive_actions, true);
1001 ActionManager::set_sensitive (ActionManager::region_list_selection_sensitive_actions, false);
1004 /* Enable the "Show" option if any selected regions are hidden, and vice versa for "Hide" */
1006 bool have_shown = false;
1007 bool have_hidden = false;
1009 TreeView::Selection::ListHandle_Path rows = _display.get_selection()->get_selected_rows ();
1010 for (TreeView::Selection::ListHandle_Path::iterator i = rows.begin(); i != rows.end(); ++i) {
1011 TreeIter t = _model->get_iter (*i);
1012 boost::shared_ptr<Region> r = (*t)[_columns.region];
1022 hide_action()->set_sensitive (have_shown);
1023 show_action()->set_sensitive (have_hidden);
1025 _menu->popup (button, time);
1029 EditorRegions::key_press (GdkEventKey* ev)
1031 TreeViewColumn *col;
1033 switch (ev->keyval) {
1035 case GDK_ISO_Left_Tab:
1037 if (name_editable) {
1038 name_editable->editing_done ();
1042 col = _display.get_column (0); // select&focus on name column
1044 if (Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)) {
1045 treeview_select_previous (_display, _model, col);
1047 treeview_select_next (_display, _model, col);
1061 EditorRegions::button_press (GdkEventButton *ev)
1063 boost::shared_ptr<Region> region;
1065 TreeModel::Path path;
1066 TreeViewColumn* column;
1070 if (_display.get_path_at_pos ((int)ev->x, (int)ev->y, path, column, cellx, celly)) {
1071 if ((iter = _model->get_iter (path))) {
1072 region = (*iter)[_columns.region];
1076 if (Keyboard::is_context_menu_event (ev)) {
1077 show_context_menu (ev->button, ev->time);
1081 if (region != 0 && Keyboard::is_button2_event (ev)) {
1082 // start/stop audition
1083 if (!Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
1084 _editor->consider_auditioning (region);
1093 EditorRegions::sorter (TreeModel::iterator a, TreeModel::iterator b)
1097 boost::shared_ptr<Region> r1 = (*a)[_columns.region];
1098 boost::shared_ptr<Region> r2 = (*b)[_columns.region];
1100 /* handle rows without regions, like "Hidden" */
1110 boost::shared_ptr<AudioRegion> region1 = boost::dynamic_pointer_cast<AudioRegion> (r1);
1111 boost::shared_ptr<AudioRegion> region2 = boost::dynamic_pointer_cast<AudioRegion> (r2);
1113 if (region1 == 0 || region2 == 0) {
1116 switch (_sort_type) {
1118 s1 = (*a)[_columns.name];
1119 s2 = (*b)[_columns.name];
1120 return (s1.compare (s2));
1126 switch (_sort_type) {
1128 cmp = region1->name().compare(region2->name());
1132 cmp = region1->length() - region2->length();
1136 cmp = region1->position() - region2->position();
1140 cmp = region1->source()->timestamp() - region2->source()->timestamp();
1144 cmp = region1->start() - region2->start();
1148 // cerr << "Compare " << (region1->start() + region1->length()) << " and " << (region2->start() + region2->length()) << endl;
1149 cmp = (region1->start() + region1->length()) - (region2->start() + region2->length());
1152 case BySourceFileName:
1153 cmp = region1->source()->name().compare(region2->source()->name());
1156 case BySourceFileLength:
1157 cmp = region1->source_length(0) - region2->source_length(0);
1160 case BySourceFileCreationDate:
1161 cmp = region1->source()->timestamp() - region2->source()->timestamp();
1164 case BySourceFileFS:
1165 if (region1->source()->name() == region2->source()->name()) {
1166 cmp = region1->name().compare(region2->name());
1168 cmp = region1->source()->name().compare(region2->source()->name());
1173 // cerr << "Comparison on " << enum_2_string (_sort_type) << " gives " << cmp << endl;
1177 } else if (cmp > 0) {
1185 EditorRegions::reset_sort_type (RegionListSortType type, bool force)
1187 if (type != _sort_type || force) {
1189 _model->set_sort_func (0, (sigc::mem_fun (*this, &EditorRegions::sorter)));
1194 EditorRegions::reset_sort_direction (bool up)
1196 _model->set_sort_column (0, up ? SORT_ASCENDING : SORT_DESCENDING);
1200 EditorRegions::selection_mapover (sigc::slot<void,boost::shared_ptr<Region> > sl)
1202 Glib::RefPtr<TreeSelection> selection = _display.get_selection();
1203 TreeView::Selection::ListHandle_Path rows = selection->get_selected_rows ();
1204 TreeView::Selection::ListHandle_Path::iterator i = rows.begin();
1206 if (selection->count_selected_rows() == 0 || _session == 0) {
1210 for (; i != rows.end(); ++i) {
1213 if ((iter = _model->get_iter (*i))) {
1215 /* some rows don't have a region associated with them, but can still be
1216 selected (XXX maybe prevent them from being selected)
1219 boost::shared_ptr<Region> r = (*iter)[_columns.region];
1230 EditorRegions::drag_data_received (const RefPtr<Gdk::DragContext>& context,
1232 const SelectionData& data,
1233 guint info, guint time)
1235 vector<string> paths;
1237 if (data.get_target() == "GTK_TREE_MODEL_ROW") {
1238 /* something is being dragged over the region list */
1239 _editor->_drags->abort ();
1240 _display.on_drag_data_received (context, x, y, data, info, time);
1244 if (_editor->convert_drop_to_paths (paths, context, x, y, data, info, time) == 0) {
1246 bool copy = ((context->get_actions() & (Gdk::ACTION_COPY | Gdk::ACTION_LINK | Gdk::ACTION_MOVE)) == Gdk::ACTION_COPY);
1248 if (Profile->get_sae() || ARDOUR_UI::config()->get_only_copy_imported_files() || copy) {
1249 _editor->do_import (paths, Editing::ImportDistinctFiles, Editing::ImportAsRegion, SrcBest, pos);
1251 _editor->do_embed (paths, Editing::ImportDistinctFiles, ImportAsRegion, pos);
1253 context->drag_finish (true, false, time);
1258 EditorRegions::selection_filter (const RefPtr<TreeModel>& model, const TreeModel::Path& path, bool already_selected)
1260 /* not possible to select rows that do not represent regions, like "Hidden" */
1262 if (already_selected) {
1263 /* deselecting anything is OK with us */
1267 TreeModel::iterator iter = model->get_iter (path);
1270 boost::shared_ptr<Region> r =(*iter)[_columns.region];
1280 EditorRegions::name_editing_started (CellEditable* ce, const Glib::ustring&)
1284 /* give it a special name */
1286 Gtk::Entry *e = dynamic_cast<Gtk::Entry*> (ce);
1289 e->set_name (X_("RegionNameEditorEntry"));
1294 EditorRegions::name_edit (const std::string& path, const std::string& new_text)
1298 boost::shared_ptr<Region> region;
1301 if ((iter = _model->get_iter (path))) {
1302 region = (*iter)[_columns.region];
1303 (*iter)[_columns.name] = new_text;
1306 /* now mapover everything */
1309 vector<RegionView*> equivalents;
1310 _editor->get_regions_corresponding_to (region, equivalents, false);
1312 for (vector<RegionView*>::iterator i = equivalents.begin(); i != equivalents.end(); ++i) {
1313 if (new_text != (*i)->region()->name()) {
1314 (*i)->region()->set_name (new_text);
1321 /** @return Region that has been dragged out of the list, or 0 */
1322 boost::shared_ptr<Region>
1323 EditorRegions::get_dragged_region ()
1325 list<boost::shared_ptr<Region> > regions;
1327 _display.get_object_drag_data (regions, &source);
1329 if (regions.empty()) {
1330 return boost::shared_ptr<Region> ();
1333 assert (regions.size() == 1);
1334 return regions.front ();
1338 EditorRegions::clear ()
1340 _display.set_model (Glib::RefPtr<Gtk::TreeStore> (0));
1342 _display.set_model (_model);
1344 /* Clean up the maps */
1345 region_row_map.clear();
1346 parent_regions_sources_map.clear();
1349 boost::shared_ptr<Region>
1350 EditorRegions::get_single_selection ()
1352 Glib::RefPtr<TreeSelection> selected = _display.get_selection();
1354 if (selected->count_selected_rows() != 1) {
1355 return boost::shared_ptr<Region> ();
1358 TreeView::Selection::ListHandle_Path rows = selected->get_selected_rows ();
1360 /* only one row selected, so rows.begin() is it */
1362 TreeIter iter = _model->get_iter (*rows.begin());
1365 return boost::shared_ptr<Region> ();
1368 return (*iter)[_columns.region];
1372 EditorRegions::freeze_tree_model (){
1374 _display.set_model (Glib::RefPtr<Gtk::TreeStore>(0));
1375 _model->set_sort_column (-2, SORT_ASCENDING); //Disable sorting to gain performance
1380 EditorRegions::thaw_tree_model (){
1382 _model->set_sort_column (0, SORT_ASCENDING); // renabale sorting
1383 _display.set_model (_model);
1385 if (toggle_full_action()->get_active()) {
1386 _display.expand_all();
1391 EditorRegions::locked_changed (std::string const & path)
1393 TreeIter i = _model->get_iter (path);
1395 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1397 region->set_locked (!(*i)[_columns.locked]);
1403 EditorRegions::glued_changed (std::string const & path)
1405 TreeIter i = _model->get_iter (path);
1407 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1409 /* `glued' means MusicTime, and we're toggling here */
1410 region->set_position_lock_style ((*i)[_columns.glued] ? AudioTime : MusicTime);
1417 EditorRegions::muted_changed (std::string const & path)
1419 TreeIter i = _model->get_iter (path);
1421 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1423 region->set_muted (!(*i)[_columns.muted]);
1430 EditorRegions::opaque_changed (std::string const & path)
1432 TreeIter i = _model->get_iter (path);
1434 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1436 region->set_opaque (!(*i)[_columns.opaque]);
1443 EditorRegions::get_state () const
1445 XMLNode* node = new XMLNode (X_("RegionList"));
1447 node->add_property (X_("sort-type"), enum_2_string (_sort_type));
1449 RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), X_("SortAscending"));
1450 bool const ascending = RefPtr<RadioAction>::cast_dynamic(act)->get_active ();
1451 node->add_property (X_("sort-ascending"), ascending ? "yes" : "no");
1452 node->add_property (X_("show-all"), toggle_full_action()->get_active() ? "yes" : "no");
1453 node->add_property (X_("show-automatic-regions"), _show_automatic_regions ? "yes" : "no");
1459 EditorRegions::set_state (const XMLNode & node)
1461 bool changed = false;
1463 if (node.name() != X_("RegionList")) {
1467 XMLProperty const * p = node.property (X_("sort-type"));
1470 Editing::RegionListSortType const t = static_cast<Editing::RegionListSortType> (string_2_enum (p->value(), _sort_type));
1472 if (_sort_type != t) {
1476 reset_sort_type (t, true);
1477 RefPtr<RadioAction> ract = sort_type_action (t);
1478 ract->set_active ();
1481 p = node.property (X_("sort-ascending"));
1484 bool const yn = string_is_affirmative (p->value ());
1485 SortType old_sort_type;
1486 int old_sort_column;
1488 _model->get_sort_column_id (old_sort_column, old_sort_type);
1490 if (old_sort_type != (yn ? SORT_ASCENDING : SORT_DESCENDING)) {
1494 reset_sort_direction (yn);
1498 act = ActionManager::get_action (X_("RegionList"), X_("SortAscending"));
1500 act = ActionManager::get_action (X_("RegionList"), X_("SortDescending"));
1503 RefPtr<RadioAction>::cast_dynamic(act)->set_active ();
1506 p = node.property (X_("show-all"));
1508 bool const yn = string_is_affirmative (p->value ());
1510 if (expanded != yn) {
1515 toggle_full_action()->set_active (yn);
1518 p = node.property (X_("show-automatic-regions"));
1520 bool const yn = string_is_affirmative (p->value ());
1522 if (yn != _show_automatic_regions) {
1523 _show_automatic_regions = yn;
1524 toggle_show_auto_regions_action()->set_active (yn);
1535 EditorRegions::sort_type_action (Editing::RegionListSortType t) const
1537 const char* action = 0;
1540 case Editing::ByName:
1541 action = X_("SortByRegionName");
1543 case Editing::ByLength:
1544 action = X_("SortByRegionLength");
1546 case Editing::ByPosition:
1547 action = X_("SortByRegionPosition");
1549 case Editing::ByTimestamp:
1550 action = X_("SortByRegionTimestamp");
1552 case Editing::ByStartInFile:
1553 action = X_("SortByRegionStartinFile");
1555 case Editing::ByEndInFile:
1556 action = X_("SortByRegionEndinFile");
1558 case Editing::BySourceFileName:
1559 action = X_("SortBySourceFileName");
1561 case Editing::BySourceFileLength:
1562 action = X_("SortBySourceFileLength");
1564 case Editing::BySourceFileCreationDate:
1565 action = X_("SortBySourceFileCreationDate");
1567 case Editing::BySourceFileFS:
1568 action = X_("SortBySourceFilesystem");
1571 fatal << string_compose (_("programming error: %1: %2"), "EditorRegions: impossible sort type", (int) t) << endmsg;
1572 abort(); /*NOTREACHED*/
1575 RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), action);
1578 return RefPtr<RadioAction>::cast_dynamic (act);
1582 EditorRegions::hide_action () const
1584 return ActionManager::get_action (X_("RegionList"), X_("rlHide"));
1589 EditorRegions::show_action () const
1591 return ActionManager::get_action (X_("RegionList"), X_("rlShow"));
1595 EditorRegions::remove_unused_regions_action () const
1597 return ActionManager::get_action (X_("RegionList"), X_("removeUnusedRegions"));
1600 RefPtr<ToggleAction>
1601 EditorRegions::toggle_full_action () const
1603 Glib::RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), X_("rlShowAll"));
1605 return Glib::RefPtr<ToggleAction>::cast_dynamic (act);
1608 RefPtr<ToggleAction>
1609 EditorRegions::toggle_show_auto_regions_action () const
1611 Glib::RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), X_("rlShowAuto"));
1613 return Glib::RefPtr<ToggleAction>::cast_dynamic (act);