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"
52 #include "ui_config.h"
57 using namespace ARDOUR;
58 using namespace ARDOUR_UI_UTILS;
62 using namespace Editing;
63 using Gtkmm2ext::Keyboard;
71 EditorRegions::EditorRegions (Editor* e)
76 , _show_automatic_regions (true)
77 , ignore_region_list_selection_change (false)
78 , ignore_selected_region_change (false)
79 , _no_redisplay (false)
80 , _sort_type ((Editing::RegionListSortType) 0)
83 _display.set_size_request (100, -1);
84 _display.set_rules_hint (true);
85 _display.set_name ("EditGroupList");
87 /* Try to prevent single mouse presses from initiating edits.
88 This relies on a hack in gtktreeview.c:gtk_treeview_button_press()
90 _display.set_data ("mouse-edits-require-mod1", (gpointer) 0x1);
92 _model = TreeStore::create (_columns);
93 _model->set_sort_func (0, sigc::mem_fun (*this, &EditorRegions::sorter));
94 _model->set_sort_column (0, SORT_ASCENDING);
96 _display.set_model (_model);
98 _display.append_column ("", _columns.name);
99 _display.append_column ("", _columns.position);
100 _display.append_column ("", _columns.end);
101 _display.append_column ("", _columns.length);
102 _display.append_column ("", _columns.sync);
103 _display.append_column ("", _columns.fadein);
104 _display.append_column ("", _columns.fadeout);
105 _display.append_column ("", _columns.locked);
106 _display.append_column ("", _columns.glued);
107 _display.append_column ("", _columns.muted);
108 _display.append_column ("", _columns.opaque);
114 { 0, _("Region"), _("Region name, with number of channels in []'s") },
115 { 1, _("Position"), _("Position of start of region") },
116 { 2, _("End"), _("Position of end of region") },
117 { 3, _("Length"), _("Length of the region") },
118 { 4, _("Sync"), _("Position of region sync point, relative to start of the region") },
119 { 5, _("Fade In"), _("Length of region fade-in (units: secondary clock), () if disabled") },
120 { 6, _("Fade Out"), _("Length of region fade-out (units: secondary clock), () if disabled") },
121 { 7, S_("Lock|L"), _("Region position locked?") },
122 { 8, S_("Gain|G"), _("Region position glued to Bars|Beats time?") },
123 { 9, S_("Mute|M"), _("Region muted?") },
124 { 10, S_("Opaque|O"), _("Region opaque (blocks regions below it from being heard)?") },
128 for (int i = 0; ci[i].index >= 0; ++i) {
129 col = _display.get_column (ci[i].index);
130 l = manage (new Label (ci[i].label));
131 set_tooltip (*l, ci[i].tooltip);
132 col->set_widget (*l);
135 if (ci[i].index > 6) {
136 col->set_expand (false);
137 col->set_alignment (ALIGN_CENTER);
141 _display.set_headers_visible (true);
142 _display.set_rules_hint ();
144 /* show path as the row tooltip */
145 _display.set_tooltip_column (14); /* path */
147 CellRendererText* region_name_cell = dynamic_cast<CellRendererText*>(_display.get_column_cell_renderer (0));
148 region_name_cell->property_editable() = true;
149 region_name_cell->signal_edited().connect (sigc::mem_fun (*this, &EditorRegions::name_edit));
150 region_name_cell->signal_editing_started().connect (sigc::mem_fun (*this, &EditorRegions::name_editing_started));
152 _display.get_selection()->set_select_function (sigc::mem_fun (*this, &EditorRegions::selection_filter));
154 TreeViewColumn* tv_col = _display.get_column(0);
155 CellRendererText* renderer = dynamic_cast<CellRendererText*>(_display.get_column_cell_renderer (0));
156 tv_col->add_attribute(renderer->property_text(), _columns.name);
157 tv_col->add_attribute(renderer->property_foreground_gdk(), _columns.color_);
158 tv_col->set_expand (true);
160 CellRendererToggle* locked_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (7));
161 locked_cell->property_activatable() = true;
162 locked_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::locked_changed));
164 TreeViewColumn* locked_col = _display.get_column (7);
165 locked_col->add_attribute (locked_cell->property_visible(), _columns.property_toggles_visible);
167 CellRendererToggle* glued_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (8));
168 glued_cell->property_activatable() = true;
169 glued_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::glued_changed));
171 TreeViewColumn* glued_col = _display.get_column (8);
172 glued_col->add_attribute (glued_cell->property_visible(), _columns.property_toggles_visible);
174 CellRendererToggle* muted_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (9));
175 muted_cell->property_activatable() = true;
176 muted_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::muted_changed));
178 TreeViewColumn* muted_col = _display.get_column (9);
179 muted_col->add_attribute (muted_cell->property_visible(), _columns.property_toggles_visible);
181 CellRendererToggle* opaque_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (10));
182 opaque_cell->property_activatable() = true;
183 opaque_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::opaque_changed));
185 TreeViewColumn* opaque_col = _display.get_column (10);
186 opaque_col->add_attribute (opaque_cell->property_visible(), _columns.property_toggles_visible);
188 _display.get_selection()->set_mode (SELECTION_MULTIPLE);
189 _display.add_object_drag (_columns.region.index(), "regions");
191 /* setup DnD handling */
193 list<TargetEntry> region_list_target_table;
195 region_list_target_table.push_back (TargetEntry ("text/plain"));
196 region_list_target_table.push_back (TargetEntry ("text/uri-list"));
197 region_list_target_table.push_back (TargetEntry ("application/x-rootwin-drop"));
199 _display.add_drop_targets (region_list_target_table);
200 _display.signal_drag_data_received().connect (sigc::mem_fun(*this, &EditorRegions::drag_data_received));
202 _scroller.add (_display);
203 _scroller.set_policy (POLICY_AUTOMATIC, POLICY_AUTOMATIC);
205 _display.signal_button_press_event().connect (sigc::mem_fun(*this, &EditorRegions::button_press), false);
206 _change_connection = _display.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &EditorRegions::selection_changed));
208 _scroller.signal_key_press_event().connect (sigc::mem_fun(*this, &EditorRegions::key_press), false);
209 _scroller.signal_focus_in_event().connect (sigc::mem_fun (*this, &EditorRegions::focus_in), false);
210 _scroller.signal_focus_out_event().connect (sigc::mem_fun (*this, &EditorRegions::focus_out));
212 _display.signal_enter_notify_event().connect (sigc::mem_fun (*this, &EditorRegions::enter_notify), false);
213 _display.signal_leave_notify_event().connect (sigc::mem_fun (*this, &EditorRegions::leave_notify), false);
215 // _display.signal_popup_menu().connect (sigc::bind (sigc::mem_fun (*this, &Editor::show__display_context_menu), 1, 0));
217 //ARDOUR_UI::instance()->secondary_clock.mode_changed.connect (sigc::mem_fun(*this, &Editor::redisplay_regions));
218 ARDOUR_UI::instance()->secondary_clock->mode_changed.connect (sigc::mem_fun(*this, &EditorRegions::update_all_rows));
219 ARDOUR::Region::RegionPropertyChanged.connect (region_property_connection, MISSING_INVALIDATOR, boost::bind (&EditorRegions::region_changed, this, _1, _2), gui_context());
220 ARDOUR::RegionFactory::CheckNewRegion.connect (check_new_region_connection, MISSING_INVALIDATOR, boost::bind (&EditorRegions::add_region, this, _1), gui_context());
222 e->EditorFreeze.connect (editor_freeze_connection, MISSING_INVALIDATOR, boost::bind (&EditorRegions::freeze_tree_model, this), gui_context());
223 e->EditorThaw.connect (editor_thaw_connection, MISSING_INVALIDATOR, boost::bind (&EditorRegions::thaw_tree_model, this), gui_context());
227 EditorRegions::focus_in (GdkEventFocus*)
229 Window* win = dynamic_cast<Window*> (_scroller.get_toplevel ());
232 old_focus = win->get_focus ();
239 /* try to do nothing on focus in (doesn't work, hence selection_count nonsense) */
244 EditorRegions::focus_out (GdkEventFocus*)
247 old_focus->grab_focus ();
257 EditorRegions::enter_notify (GdkEventCrossing*)
263 /* arm counter so that ::selection_filter() will deny selecting anything for the
264 next two attempts to change selection status.
266 _scroller.grab_focus ();
267 Keyboard::magic_widget_grab_focus ();
272 EditorRegions::leave_notify (GdkEventCrossing*)
275 old_focus->grab_focus ();
279 Keyboard::magic_widget_drop_focus ();
284 EditorRegions::set_session (ARDOUR::Session* s)
286 SessionHandlePtr::set_session (s);
291 EditorRegions::add_region (boost::shared_ptr<Region> region)
293 if (!region || !_session) {
300 bool missing_source = boost::dynamic_pointer_cast<SilentFileSource>(region->source()) != NULL;
302 if (!_show_automatic_regions && region->automatic()) {
306 if (region->hidden()) {
308 TreeModel::iterator iter = _model->get_iter ("0");
309 TreeModel::Row parent;
312 parent = *(_model->append());
313 parent[_columns.name] = _("Hidden");
314 boost::shared_ptr<Region> proxy = parent[_columns.region];
317 string s = (*iter)[_columns.name];
318 if (s != _("Hidden")) {
319 parent = *(_model->insert(iter));
320 parent[_columns.name] = _("Hidden");
321 boost::shared_ptr<Region> proxy = parent[_columns.region];
328 row = *(_model->append (parent.children()));
330 } else if (region->whole_file()) {
332 TreeModel::iterator i;
333 TreeModel::Children rows = _model->children();
335 for (i = rows.begin(); i != rows.end(); ++i) {
336 boost::shared_ptr<Region> rr = (*i)[_columns.region];
338 if (rr && region->region_list_equivalent (rr)) {
343 row = *(_model->append());
345 if (missing_source) {
346 // c.set_rgb(65535,0,0); // FIXME: error color from style
347 set_color_from_rgba (c, UIConfiguration::instance().color ("region list missing source"));
349 } else if (region->automatic()){
350 // c.set_rgb(0,65535,0); // FIXME: error color from style
351 set_color_from_rgba (c, UIConfiguration::instance().color ("region list automatic"));
354 set_color_from_rgba (c, UIConfiguration::instance().color ("region list whole file"));
357 row[_columns.color_] = c;
359 if (region->source()->name()[0] == '/') { // external file
361 if (region->whole_file()) {
363 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(region->source());
367 str = region_name_from_path (afs->path(), region->n_channels() > 1);
369 str += region->source()->name();
373 str = region->name();
377 str = region->name();
380 if (region->n_channels() > 1) {
381 std::stringstream foo;
382 foo << region->n_channels ();
388 row[_columns.name] = str;
389 row[_columns.region] = region;
390 row[_columns.property_toggles_visible] = false;
392 if (missing_source) {
393 row[_columns.path] = _("(MISSING) ") + Glib::Markup::escape_text (region->source()->name());
396 boost::shared_ptr<FileSource> fs = boost::dynamic_pointer_cast<FileSource>(region->source());
398 row[_columns.path] = Glib::Markup::escape_text (fs->path());
400 row[_columns.path] = Glib::Markup::escape_text (region->source()->name());
404 region_row_map.insert(pair<boost::shared_ptr<ARDOUR::Region>, Gtk::TreeModel::RowReference>(region, TreeRowReference(_model, TreePath (row))) );
405 parent_regions_sources_map.insert(pair<string, Gtk::TreeModel::RowReference>(region->source_string(), TreeRowReference(_model, TreePath (row))) );
410 // find parent node, add as new child
411 TreeModel::iterator i;
413 boost::unordered_map<string, Gtk::TreeModel::RowReference>::iterator it;
415 it = parent_regions_sources_map.find (region->source_string());
417 if (it != parent_regions_sources_map.end()){
419 TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
421 TreeModel::iterator ii;
422 TreeModel::Children subrows = (*j).children();
424 /* XXXX: should we be accounting for all regions? */
426 for (ii = subrows.begin(); ii != subrows.end(); ++ii) {
427 boost::shared_ptr<Region> rr = (*ii)[_columns.region];
429 if (region->region_list_equivalent (rr)) {
435 row = *(_model->insert (subrows.end()));
438 row = *(_model->append());
441 row[_columns.property_toggles_visible] = true;
444 row[_columns.region] = region;
446 region_row_map.insert(pair<boost::shared_ptr<ARDOUR::Region>, Gtk::TreeModel::RowReference>(region, TreeRowReference(_model, TreePath (row))) );
448 populate_row(region, (*row));
452 EditorRegions::remove_unused_regions ()
454 vector<string> choices;
461 prompt = _("Do you really want to remove unused regions?"
462 "\n(This is destructive and cannot be undone)");
464 choices.push_back (_("No, do nothing."));
465 choices.push_back (_("Yes, remove."));
467 Gtkmm2ext::Choice prompter (_("Remove unused regions"), prompt, choices);
469 if (prompter.run () == 1) {
470 _no_redisplay = true;
471 _session->cleanup_regions ();
472 _no_redisplay = false;
478 EditorRegions::region_changed (boost::shared_ptr<Region> r, const PropertyChange& what_changed)
480 PropertyChange our_interests;
482 our_interests.add (ARDOUR::Properties::name);
483 our_interests.add (ARDOUR::Properties::position);
484 our_interests.add (ARDOUR::Properties::length);
485 our_interests.add (ARDOUR::Properties::start);
486 our_interests.add (ARDOUR::Properties::locked);
487 our_interests.add (ARDOUR::Properties::position_lock_style);
488 our_interests.add (ARDOUR::Properties::muted);
489 our_interests.add (ARDOUR::Properties::opaque);
490 our_interests.add (ARDOUR::Properties::fade_in);
491 our_interests.add (ARDOUR::Properties::fade_out);
492 our_interests.add (ARDOUR::Properties::fade_in_active);
493 our_interests.add (ARDOUR::Properties::fade_out_active);
495 if (what_changed.contains (our_interests)) {
499 TreeModel::iterator j = _model->get_iter (last_row.get_path());
500 boost::shared_ptr<Region> c = (*j)[_columns.region];
503 populate_row (r, (*j));
505 if (what_changed.contains (ARDOUR::Properties::hidden)) {
513 RegionRowMap::iterator it;
515 it = region_row_map.find (r);
517 if (it != region_row_map.end()){
519 TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
520 boost::shared_ptr<Region> c = (*j)[_columns.region];
523 populate_row (r, (*j));
525 if (what_changed.contains (ARDOUR::Properties::hidden)) {
534 if (what_changed.contains (ARDOUR::Properties::hidden)) {
540 EditorRegions::selection_changed ()
542 if (ignore_region_list_selection_change) {
546 _editor->_region_selection_change_updates_region_list = false;
548 if (_display.get_selection()->count_selected_rows() > 0) {
551 TreeView::Selection::ListHandle_Path rows = _display.get_selection()->get_selected_rows ();
553 _editor->get_selection().clear_regions ();
555 for (TreeView::Selection::ListHandle_Path::iterator i = rows.begin(); i != rows.end(); ++i) {
557 if ((iter = _model->get_iter (*i))) {
559 boost::shared_ptr<Region> region = (*iter)[_columns.region];
561 // they could have clicked on a row that is just a placeholder, like "Hidden"
562 // although that is not allowed by our selection filter. check it anyway
563 // since we need a region ptr.
567 _change_connection.block (true);
568 _editor->set_selected_regionview_from_region_list (region, Selection::Add);
569 _change_connection.block (false);
575 _editor->get_selection().clear_regions ();
578 _editor->_region_selection_change_updates_region_list = true;
582 EditorRegions::set_selected (RegionSelection& regions)
584 for (RegionSelection::iterator i = regions.begin(); i != regions.end(); ++i) {
586 boost::shared_ptr<Region> r ((*i)->region());
588 RegionRowMap::iterator it;
590 it = region_row_map.find (r);
592 if (it != region_row_map.end()){
593 TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
594 _display.get_selection()->select(*j);
600 EditorRegions::redisplay ()
602 if (_no_redisplay || !_session) {
606 bool tree_expanded = false;
608 /* If the list was expanded prior to rebuilding, expand it again afterwards */
609 if (toggle_full_action()->get_active()) {
610 tree_expanded = true;
613 _display.set_model (Glib::RefPtr<Gtk::TreeStore>(0));
615 _model->set_sort_column (-2, SORT_ASCENDING); //Disable sorting to gain performance
618 region_row_map.clear();
619 parent_regions_sources_map.clear();
621 /* now add everything we have, via a temporary list used to help with sorting */
623 const RegionFactory::RegionMap& regions (RegionFactory::regions());
625 for (RegionFactory::RegionMap::const_iterator i = regions.begin(); i != regions.end(); ++i) {
627 if ( i->second->whole_file()) {
628 /* add automatic regions first so that children can find their parents as we add them */
629 add_region (i->second);
633 tmp_region_list.push_front (i->second);
636 for (list<boost::shared_ptr<Region> >::iterator r = tmp_region_list.begin(); r != tmp_region_list.end(); ++r) {
640 _model->set_sort_column (0, SORT_ASCENDING); // renabale sorting
641 _display.set_model (_model);
643 tmp_region_list.clear();
646 _display.expand_all();
651 EditorRegions::update_row (boost::shared_ptr<Region> region)
653 if (!region || !_session) {
657 RegionRowMap::iterator it;
659 it = region_row_map.find (region);
661 if (it != region_row_map.end()){
663 TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
664 populate_row(region, (*j));
669 EditorRegions::update_all_rows ()
675 RegionRowMap::iterator i;
677 for (i = region_row_map.begin(); i != region_row_map.end(); ++i) {
679 TreeModel::iterator j = _model->get_iter ((*i).second.get_path());
681 boost::shared_ptr<Region> region = (*j)[_columns.region];
683 if (!region->automatic()) {
684 populate_row(region, (*j));
690 EditorRegions::format_position (framepos_t pos, char* buf, size_t bufsize, bool onoff)
692 Timecode::BBT_Time bbt;
693 Timecode::Time timecode;
696 error << string_compose (_("EditorRegions::format_position: negative timecode position: %1"), pos) << endmsg;
697 snprintf (buf, bufsize, "invalid");
701 switch (ARDOUR_UI::instance()->secondary_clock->mode ()) {
702 case AudioClock::BBT:
703 _session->tempo_map().bbt_time (pos, bbt);
705 snprintf (buf, bufsize, "%03d|%02d|%04d" , bbt.bars, bbt.beats, bbt.ticks);
707 snprintf (buf, bufsize, "(%03d|%02d|%04d)" , bbt.bars, bbt.beats, bbt.ticks);
711 case AudioClock::MinSec:
718 hrs = (int) floor (left / (_session->frame_rate() * 60.0f * 60.0f));
719 left -= (framecnt_t) floor (hrs * _session->frame_rate() * 60.0f * 60.0f);
720 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
721 left -= (framecnt_t) floor (mins * _session->frame_rate() * 60.0f);
722 secs = left / (float) _session->frame_rate();
724 snprintf (buf, bufsize, "%02d:%02d:%06.3f", hrs, mins, secs);
726 snprintf (buf, bufsize, "(%02d:%02d:%06.3f)", hrs, mins, secs);
730 case AudioClock::Frames:
732 snprintf (buf, bufsize, "%" PRId64, pos);
734 snprintf (buf, bufsize, "(%" PRId64 ")", pos);
738 case AudioClock::Timecode:
740 _session->timecode_time (pos, timecode);
742 snprintf (buf, bufsize, "%02d:%02d:%02d:%02d", timecode.hours, timecode.minutes, timecode.seconds, timecode.frames);
744 snprintf (buf, bufsize, "(%02d:%02d:%02d:%02d)", timecode.hours, timecode.minutes, timecode.seconds, timecode.frames);
751 EditorRegions::populate_row (boost::shared_ptr<Region> region, TreeModel::Row const &row)
753 boost::shared_ptr<AudioRegion> audioregion = boost::dynamic_pointer_cast<AudioRegion>(region);
754 //uint32_t used = _session->playlists->region_use_count (region);
755 /* Presently a region is only used once so let's save on the sequential scan to determine use count */
758 populate_row_position (region, row, used);
759 populate_row_end (region, row, used);
760 populate_row_sync (region, row, used);
761 populate_row_fade_in (region, row, used, audioregion);
762 populate_row_fade_out (region, row, used, audioregion);
763 populate_row_locked (region, row, used);
764 populate_row_glued (region, row, used);
765 populate_row_muted (region, row, used);
766 populate_row_opaque (region, row, used);
767 populate_row_length (region, row);
768 populate_row_source (region, row);
769 populate_row_name (region, row);
770 populate_row_used (region, row, used);
774 if (audioRegion && fades_in_seconds) {
780 left = audioRegion->fade_in()->back()->when;
781 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
782 left -= (framepos_t) floor (mins * _session->frame_rate() * 60.0f);
783 millisecs = (int) floor ((left * 1000.0f) / _session->frame_rate());
785 if (audioRegion->fade_in()->back()->when >= _session->frame_rate()) {
786 sprintf (fadein_str, "%01dM %01dmS", mins, millisecs);
788 sprintf (fadein_str, "%01dmS", millisecs);
791 left = audioRegion->fade_out()->back()->when;
792 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
793 left -= (framepos_t) floor (mins * _session->frame_rate() * 60.0f);
794 millisecs = (int) floor ((left * 1000.0f) / _session->frame_rate());
796 if (audioRegion->fade_out()->back()->when >= _session->frame_rate()) {
797 sprintf (fadeout_str, "%01dM %01dmS", mins, millisecs);
799 sprintf (fadeout_str, "%01dmS", millisecs);
805 EditorRegions::populate_row_used (boost::shared_ptr<Region>, TreeModel::Row const& row, uint32_t used)
808 snprintf (buf, sizeof (buf), "%4d" , used);
809 row[_columns.used] = buf;
813 EditorRegions::populate_row_length (boost::shared_ptr<Region> region, TreeModel::Row const &row)
816 format_position (region->length(), buf, sizeof (buf));
817 row[_columns.length] = buf;
821 EditorRegions::populate_row_end (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
823 if (region->whole_file()) {
824 row[_columns.end] = "";
825 } else if (used > 1) {
826 row[_columns.end] = _("Mult.");
827 } else if (region->last_frame() >= region->first_frame()) {
829 format_position (region->last_frame(), buf, sizeof (buf));
830 row[_columns.end] = buf;
832 row[_columns.end] = "empty";
837 EditorRegions::populate_row_position (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
839 if (region->whole_file()) {
840 row[_columns.position] = "";
841 } else if (used > 1) {
842 row[_columns.position] = _("Mult.");
845 format_position (region->position(), buf, sizeof (buf));
846 row[_columns.position] = buf;
851 EditorRegions::populate_row_sync (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
853 if (region->whole_file()) {
854 row[_columns.sync] = "";
855 } else if (used > 1) {
856 row[_columns.sync] = _("Mult."); /* translators: a short phrase for "multiple" as in "many" */
858 if (region->sync_position() == region->position()) {
859 row[_columns.sync] = _("Start");
860 } else if (region->sync_position() == (region->last_frame())) {
861 row[_columns.sync] = _("End");
864 format_position (region->sync_position(), buf, sizeof (buf));
865 row[_columns.sync] = buf;
871 EditorRegions::populate_row_fade_in (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used, boost::shared_ptr<AudioRegion> audioregion)
873 if (!audioregion || region->whole_file()) {
874 row[_columns.fadein] = "";
877 row[_columns.fadein] = _("Multiple");
880 format_position (audioregion->fade_in()->back()->when, buf, sizeof (buf), audioregion->fade_in_active());
881 row[_columns.fadein] = buf;
887 EditorRegions::populate_row_fade_out (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used, boost::shared_ptr<AudioRegion> audioregion)
889 if (!audioregion || region->whole_file()) {
890 row[_columns.fadeout] = "";
893 row[_columns.fadeout] = _("Multiple");
896 format_position (audioregion->fade_out()->back()->when, buf, sizeof (buf), audioregion->fade_out_active());
897 row[_columns.fadeout] = buf;
903 EditorRegions::populate_row_locked (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
905 if (region->whole_file()) {
906 row[_columns.locked] = false;
907 } else if (used > 1) {
908 row[_columns.locked] = false;
910 row[_columns.locked] = region->locked();
915 EditorRegions::populate_row_glued (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
917 if (region->whole_file() || used > 1) {
918 row[_columns.glued] = false;
920 if (region->position_lock_style() == MusicTime) {
921 row[_columns.glued] = true;
923 row[_columns.glued] = false;
929 EditorRegions::populate_row_muted (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
931 if (region->whole_file() || used > 1) {
932 row[_columns.muted] = false;
934 row[_columns.muted] = region->muted();
939 EditorRegions::populate_row_opaque (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
941 if (region->whole_file() || used > 1) {
942 row[_columns.opaque] = false;
944 row[_columns.opaque] = region->opaque();
949 EditorRegions::populate_row_name (boost::shared_ptr<Region> region, TreeModel::Row const &row)
951 if (region->n_channels() > 1) {
952 row[_columns.name] = string_compose("%1 [%2]", Glib::Markup::escape_text (region->name()), region->n_channels());
954 row[_columns.name] = Glib::Markup::escape_text (region->name());
959 EditorRegions::populate_row_source (boost::shared_ptr<Region> region, TreeModel::Row const &row)
961 if (boost::dynamic_pointer_cast<SilentFileSource>(region->source())) {
962 row[_columns.path] = _("MISSING ") + Glib::Markup::escape_text (region->source()->name());
964 row[_columns.path] = Glib::Markup::escape_text (region->source()->name());
969 EditorRegions::toggle_show_auto_regions ()
971 _show_automatic_regions = toggle_show_auto_regions_action()->get_active();
976 EditorRegions::toggle_full ()
978 set_full (toggle_full_action()->get_active ());
982 EditorRegions::set_full (bool f)
985 _display.expand_all ();
988 _display.collapse_all ();
994 EditorRegions::show_context_menu (int button, int time)
997 _menu = dynamic_cast<Menu*> (ActionManager::get_widget ("/RegionListMenu"));
1000 if (_display.get_selection()->count_selected_rows() > 0) {
1001 ActionManager::set_sensitive (ActionManager::region_list_selection_sensitive_actions, true);
1003 ActionManager::set_sensitive (ActionManager::region_list_selection_sensitive_actions, false);
1006 /* Enable the "Show" option if any selected regions are hidden, and vice versa for "Hide" */
1008 bool have_shown = false;
1009 bool have_hidden = false;
1011 TreeView::Selection::ListHandle_Path rows = _display.get_selection()->get_selected_rows ();
1012 for (TreeView::Selection::ListHandle_Path::iterator i = rows.begin(); i != rows.end(); ++i) {
1013 TreeIter t = _model->get_iter (*i);
1014 boost::shared_ptr<Region> r = (*t)[_columns.region];
1024 hide_action()->set_sensitive (have_shown);
1025 show_action()->set_sensitive (have_hidden);
1027 _menu->popup (button, time);
1031 EditorRegions::key_press (GdkEventKey* ev)
1033 TreeViewColumn *col;
1035 switch (ev->keyval) {
1037 case GDK_ISO_Left_Tab:
1039 if (name_editable) {
1040 name_editable->editing_done ();
1044 col = _display.get_column (0); // select&focus on name column
1046 if (Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)) {
1047 treeview_select_previous (_display, _model, col);
1049 treeview_select_next (_display, _model, col);
1063 EditorRegions::button_press (GdkEventButton *ev)
1065 boost::shared_ptr<Region> region;
1067 TreeModel::Path path;
1068 TreeViewColumn* column;
1072 if (_display.get_path_at_pos ((int)ev->x, (int)ev->y, path, column, cellx, celly)) {
1073 if ((iter = _model->get_iter (path))) {
1074 region = (*iter)[_columns.region];
1078 if (Keyboard::is_context_menu_event (ev)) {
1079 show_context_menu (ev->button, ev->time);
1083 if (region != 0 && Keyboard::is_button2_event (ev)) {
1084 // start/stop audition
1085 if (!Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
1086 _editor->consider_auditioning (region);
1095 EditorRegions::sorter (TreeModel::iterator a, TreeModel::iterator b)
1099 boost::shared_ptr<Region> r1 = (*a)[_columns.region];
1100 boost::shared_ptr<Region> r2 = (*b)[_columns.region];
1102 /* handle rows without regions, like "Hidden" */
1112 boost::shared_ptr<AudioRegion> region1 = boost::dynamic_pointer_cast<AudioRegion> (r1);
1113 boost::shared_ptr<AudioRegion> region2 = boost::dynamic_pointer_cast<AudioRegion> (r2);
1115 if (region1 == 0 || region2 == 0) {
1118 switch (_sort_type) {
1120 s1 = (*a)[_columns.name];
1121 s2 = (*b)[_columns.name];
1122 return (s1.compare (s2));
1128 switch (_sort_type) {
1130 cmp = region1->name().compare(region2->name());
1134 cmp = region1->length() - region2->length();
1138 cmp = region1->position() - region2->position();
1142 cmp = region1->source()->timestamp() - region2->source()->timestamp();
1146 cmp = region1->start() - region2->start();
1150 // cerr << "Compare " << (region1->start() + region1->length()) << " and " << (region2->start() + region2->length()) << endl;
1151 cmp = (region1->start() + region1->length()) - (region2->start() + region2->length());
1154 case BySourceFileName:
1155 cmp = region1->source()->name().compare(region2->source()->name());
1158 case BySourceFileLength:
1159 cmp = region1->source_length(0) - region2->source_length(0);
1162 case BySourceFileCreationDate:
1163 cmp = region1->source()->timestamp() - region2->source()->timestamp();
1166 case BySourceFileFS:
1167 if (region1->source()->name() == region2->source()->name()) {
1168 cmp = region1->name().compare(region2->name());
1170 cmp = region1->source()->name().compare(region2->source()->name());
1175 // cerr << "Comparison on " << enum_2_string (_sort_type) << " gives " << cmp << endl;
1179 } else if (cmp > 0) {
1187 EditorRegions::reset_sort_type (RegionListSortType type, bool force)
1189 if (type != _sort_type || force) {
1191 _model->set_sort_func (0, (sigc::mem_fun (*this, &EditorRegions::sorter)));
1196 EditorRegions::reset_sort_direction (bool up)
1198 _model->set_sort_column (0, up ? SORT_ASCENDING : SORT_DESCENDING);
1202 EditorRegions::selection_mapover (sigc::slot<void,boost::shared_ptr<Region> > sl)
1204 Glib::RefPtr<TreeSelection> selection = _display.get_selection();
1205 TreeView::Selection::ListHandle_Path rows = selection->get_selected_rows ();
1206 TreeView::Selection::ListHandle_Path::iterator i = rows.begin();
1208 if (selection->count_selected_rows() == 0 || _session == 0) {
1212 for (; i != rows.end(); ++i) {
1215 if ((iter = _model->get_iter (*i))) {
1217 /* some rows don't have a region associated with them, but can still be
1218 selected (XXX maybe prevent them from being selected)
1221 boost::shared_ptr<Region> r = (*iter)[_columns.region];
1232 EditorRegions::drag_data_received (const RefPtr<Gdk::DragContext>& context,
1234 const SelectionData& data,
1235 guint info, guint time)
1237 vector<string> paths;
1239 if (data.get_target() == "GTK_TREE_MODEL_ROW") {
1240 /* something is being dragged over the region list */
1241 _editor->_drags->abort ();
1242 _display.on_drag_data_received (context, x, y, data, info, time);
1246 if (_editor->convert_drop_to_paths (paths, context, x, y, data, info, time) == 0) {
1248 bool copy = ((context->get_actions() & (Gdk::ACTION_COPY | Gdk::ACTION_LINK | Gdk::ACTION_MOVE)) == Gdk::ACTION_COPY);
1250 if (Profile->get_sae() || UIConfiguration::instance().get_only_copy_imported_files() || copy) {
1251 _editor->do_import (paths, Editing::ImportDistinctFiles, Editing::ImportAsRegion, SrcBest, pos);
1253 _editor->do_embed (paths, Editing::ImportDistinctFiles, ImportAsRegion, pos);
1255 context->drag_finish (true, false, time);
1260 EditorRegions::selection_filter (const RefPtr<TreeModel>& model, const TreeModel::Path& path, bool already_selected)
1262 /* not possible to select rows that do not represent regions, like "Hidden" */
1264 if (already_selected) {
1265 /* deselecting anything is OK with us */
1269 TreeModel::iterator iter = model->get_iter (path);
1272 boost::shared_ptr<Region> r =(*iter)[_columns.region];
1282 EditorRegions::name_editing_started (CellEditable* ce, const Glib::ustring&)
1286 /* give it a special name */
1288 Gtk::Entry *e = dynamic_cast<Gtk::Entry*> (ce);
1291 e->set_name (X_("RegionNameEditorEntry"));
1296 EditorRegions::name_edit (const std::string& path, const std::string& new_text)
1300 boost::shared_ptr<Region> region;
1303 if ((iter = _model->get_iter (path))) {
1304 region = (*iter)[_columns.region];
1305 (*iter)[_columns.name] = new_text;
1308 /* now mapover everything */
1311 vector<RegionView*> equivalents;
1312 _editor->get_regions_corresponding_to (region, equivalents, false);
1314 for (vector<RegionView*>::iterator i = equivalents.begin(); i != equivalents.end(); ++i) {
1315 if (new_text != (*i)->region()->name()) {
1316 (*i)->region()->set_name (new_text);
1323 /** @return Region that has been dragged out of the list, or 0 */
1324 boost::shared_ptr<Region>
1325 EditorRegions::get_dragged_region ()
1327 list<boost::shared_ptr<Region> > regions;
1329 _display.get_object_drag_data (regions, &source);
1331 if (regions.empty()) {
1332 return boost::shared_ptr<Region> ();
1335 assert (regions.size() == 1);
1336 return regions.front ();
1340 EditorRegions::clear ()
1342 _display.set_model (Glib::RefPtr<Gtk::TreeStore> (0));
1344 _display.set_model (_model);
1346 /* Clean up the maps */
1347 region_row_map.clear();
1348 parent_regions_sources_map.clear();
1351 boost::shared_ptr<Region>
1352 EditorRegions::get_single_selection ()
1354 Glib::RefPtr<TreeSelection> selected = _display.get_selection();
1356 if (selected->count_selected_rows() != 1) {
1357 return boost::shared_ptr<Region> ();
1360 TreeView::Selection::ListHandle_Path rows = selected->get_selected_rows ();
1362 /* only one row selected, so rows.begin() is it */
1364 TreeIter iter = _model->get_iter (*rows.begin());
1367 return boost::shared_ptr<Region> ();
1370 return (*iter)[_columns.region];
1374 EditorRegions::freeze_tree_model (){
1376 _display.set_model (Glib::RefPtr<Gtk::TreeStore>(0));
1377 _model->set_sort_column (-2, SORT_ASCENDING); //Disable sorting to gain performance
1382 EditorRegions::thaw_tree_model (){
1384 _model->set_sort_column (0, SORT_ASCENDING); // renabale sorting
1385 _display.set_model (_model);
1387 if (toggle_full_action()->get_active()) {
1388 _display.expand_all();
1393 EditorRegions::locked_changed (std::string const & path)
1395 TreeIter i = _model->get_iter (path);
1397 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1399 region->set_locked (!(*i)[_columns.locked]);
1405 EditorRegions::glued_changed (std::string const & path)
1407 TreeIter i = _model->get_iter (path);
1409 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1411 /* `glued' means MusicTime, and we're toggling here */
1412 region->set_position_lock_style ((*i)[_columns.glued] ? AudioTime : MusicTime);
1419 EditorRegions::muted_changed (std::string const & path)
1421 TreeIter i = _model->get_iter (path);
1423 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1425 region->set_muted (!(*i)[_columns.muted]);
1432 EditorRegions::opaque_changed (std::string const & path)
1434 TreeIter i = _model->get_iter (path);
1436 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1438 region->set_opaque (!(*i)[_columns.opaque]);
1445 EditorRegions::get_state () const
1447 XMLNode* node = new XMLNode (X_("RegionList"));
1449 node->add_property (X_("sort-type"), enum_2_string (_sort_type));
1451 RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), X_("SortAscending"));
1452 bool const ascending = RefPtr<RadioAction>::cast_dynamic(act)->get_active ();
1453 node->add_property (X_("sort-ascending"), ascending ? "yes" : "no");
1454 node->add_property (X_("show-all"), toggle_full_action()->get_active() ? "yes" : "no");
1455 node->add_property (X_("show-automatic-regions"), _show_automatic_regions ? "yes" : "no");
1461 EditorRegions::set_state (const XMLNode & node)
1463 bool changed = false;
1465 if (node.name() != X_("RegionList")) {
1469 XMLProperty const * p = node.property (X_("sort-type"));
1472 Editing::RegionListSortType const t = static_cast<Editing::RegionListSortType> (string_2_enum (p->value(), _sort_type));
1474 if (_sort_type != t) {
1478 reset_sort_type (t, true);
1479 RefPtr<RadioAction> ract = sort_type_action (t);
1480 ract->set_active ();
1483 p = node.property (X_("sort-ascending"));
1486 bool const yn = string_is_affirmative (p->value ());
1487 SortType old_sort_type;
1488 int old_sort_column;
1490 _model->get_sort_column_id (old_sort_column, old_sort_type);
1492 if (old_sort_type != (yn ? SORT_ASCENDING : SORT_DESCENDING)) {
1496 reset_sort_direction (yn);
1500 act = ActionManager::get_action (X_("RegionList"), X_("SortAscending"));
1502 act = ActionManager::get_action (X_("RegionList"), X_("SortDescending"));
1505 RefPtr<RadioAction>::cast_dynamic(act)->set_active ();
1508 p = node.property (X_("show-all"));
1510 bool const yn = string_is_affirmative (p->value ());
1512 if (expanded != yn) {
1517 toggle_full_action()->set_active (yn);
1520 p = node.property (X_("show-automatic-regions"));
1522 bool const yn = string_is_affirmative (p->value ());
1524 if (yn != _show_automatic_regions) {
1525 _show_automatic_regions = yn;
1526 toggle_show_auto_regions_action()->set_active (yn);
1537 EditorRegions::sort_type_action (Editing::RegionListSortType t) const
1539 const char* action = 0;
1542 case Editing::ByName:
1543 action = X_("SortByRegionName");
1545 case Editing::ByLength:
1546 action = X_("SortByRegionLength");
1548 case Editing::ByPosition:
1549 action = X_("SortByRegionPosition");
1551 case Editing::ByTimestamp:
1552 action = X_("SortByRegionTimestamp");
1554 case Editing::ByStartInFile:
1555 action = X_("SortByRegionStartinFile");
1557 case Editing::ByEndInFile:
1558 action = X_("SortByRegionEndinFile");
1560 case Editing::BySourceFileName:
1561 action = X_("SortBySourceFileName");
1563 case Editing::BySourceFileLength:
1564 action = X_("SortBySourceFileLength");
1566 case Editing::BySourceFileCreationDate:
1567 action = X_("SortBySourceFileCreationDate");
1569 case Editing::BySourceFileFS:
1570 action = X_("SortBySourceFilesystem");
1573 fatal << string_compose (_("programming error: %1: %2"), "EditorRegions: impossible sort type", (int) t) << endmsg;
1574 abort(); /*NOTREACHED*/
1577 RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), action);
1580 return RefPtr<RadioAction>::cast_dynamic (act);
1584 EditorRegions::hide_action () const
1586 return ActionManager::get_action (X_("RegionList"), X_("rlHide"));
1591 EditorRegions::show_action () const
1593 return ActionManager::get_action (X_("RegionList"), X_("rlShow"));
1597 EditorRegions::remove_unused_regions_action () const
1599 return ActionManager::get_action (X_("RegionList"), X_("removeUnusedRegions"));
1602 RefPtr<ToggleAction>
1603 EditorRegions::toggle_full_action () const
1605 Glib::RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), X_("rlShowAll"));
1607 return Glib::RefPtr<ToggleAction>::cast_dynamic (act);
1610 RefPtr<ToggleAction>
1611 EditorRegions::toggle_show_auto_regions_action () const
1613 Glib::RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), X_("rlShowAuto"));
1615 return Glib::RefPtr<ToggleAction>::cast_dynamic (act);