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"
51 #include "ui_config.h"
56 using namespace ARDOUR;
57 using namespace ARDOUR_UI_UTILS;
61 using namespace Editing;
62 using Gtkmm2ext::Keyboard;
70 EditorRegions::EditorRegions (Editor* e)
75 , _show_automatic_regions (true)
76 , ignore_region_list_selection_change (false)
77 , ignore_selected_region_change (false)
78 , _no_redisplay (false)
79 , _sort_type ((Editing::RegionListSortType) 0)
82 _display.set_size_request (100, -1);
83 _display.set_rules_hint (true);
84 _display.set_name ("EditGroupList");
86 /* Try to prevent single mouse presses from initiating edits.
87 This relies on a hack in gtktreeview.c:gtk_treeview_button_press()
89 _display.set_data ("mouse-edits-require-mod1", (gpointer) 0x1);
91 _model = TreeStore::create (_columns);
92 _model->set_sort_func (0, sigc::mem_fun (*this, &EditorRegions::sorter));
93 _model->set_sort_column (0, SORT_ASCENDING);
95 _display.set_model (_model);
97 _display.append_column ("", _columns.name);
98 _display.append_column ("", _columns.position);
99 _display.append_column ("", _columns.end);
100 _display.append_column ("", _columns.length);
101 _display.append_column ("", _columns.sync);
102 _display.append_column ("", _columns.fadein);
103 _display.append_column ("", _columns.fadeout);
104 _display.append_column ("", _columns.locked);
105 _display.append_column ("", _columns.glued);
106 _display.append_column ("", _columns.muted);
107 _display.append_column ("", _columns.opaque);
113 { 0, _("Region"), _("Region name, with number of channels in []'s") },
114 { 1, _("Position"), _("Position of start of region") },
115 { 2, _("End"), _("Position of end of region") },
116 { 3, _("Length"), _("Length of the region") },
117 { 4, _("Sync"), _("Position of region sync point, relative to start of the region") },
118 { 5, _("Fade In"), _("Length of region fade-in (units: secondary clock), () if disabled") },
119 { 6, _("Fade Out"), _("Length of region fade-out (units: secondary clock), () if disabled") },
120 { 7, S_("Lock|L"), _("Region position locked?") },
121 { 8, S_("Gain|G"), _("Region position glued to Bars|Beats time?") },
122 { 9, S_("Mute|M"), _("Region muted?") },
123 { 10, S_("Opaque|O"), _("Region opaque (blocks regions below it from being heard)?") },
127 for (int i = 0; ci[i].index >= 0; ++i) {
128 col = _display.get_column (ci[i].index);
129 l = manage (new Label (ci[i].label));
130 ARDOUR_UI::instance()->set_tip (*l, ci[i].tooltip);
131 col->set_widget (*l);
134 if (ci[i].index > 6) {
135 col->set_expand (false);
136 col->set_alignment (ALIGN_CENTER);
140 _display.set_headers_visible (true);
141 _display.set_rules_hint ();
143 /* show path as the row tooltip */
144 _display.set_tooltip_column (14); /* path */
146 CellRendererText* region_name_cell = dynamic_cast<CellRendererText*>(_display.get_column_cell_renderer (0));
147 region_name_cell->property_editable() = true;
148 region_name_cell->signal_edited().connect (sigc::mem_fun (*this, &EditorRegions::name_edit));
149 region_name_cell->signal_editing_started().connect (sigc::mem_fun (*this, &EditorRegions::name_editing_started));
151 _display.get_selection()->set_select_function (sigc::mem_fun (*this, &EditorRegions::selection_filter));
153 TreeViewColumn* tv_col = _display.get_column(0);
154 CellRendererText* renderer = dynamic_cast<CellRendererText*>(_display.get_column_cell_renderer (0));
155 tv_col->add_attribute(renderer->property_text(), _columns.name);
156 tv_col->add_attribute(renderer->property_foreground_gdk(), _columns.color_);
157 tv_col->set_expand (true);
159 CellRendererToggle* locked_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (7));
160 locked_cell->property_activatable() = true;
161 locked_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::locked_changed));
163 TreeViewColumn* locked_col = _display.get_column (7);
164 locked_col->add_attribute (locked_cell->property_visible(), _columns.property_toggles_visible);
166 CellRendererToggle* glued_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (8));
167 glued_cell->property_activatable() = true;
168 glued_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::glued_changed));
170 TreeViewColumn* glued_col = _display.get_column (8);
171 glued_col->add_attribute (glued_cell->property_visible(), _columns.property_toggles_visible);
173 CellRendererToggle* muted_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (9));
174 muted_cell->property_activatable() = true;
175 muted_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::muted_changed));
177 TreeViewColumn* muted_col = _display.get_column (9);
178 muted_col->add_attribute (muted_cell->property_visible(), _columns.property_toggles_visible);
180 CellRendererToggle* opaque_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (10));
181 opaque_cell->property_activatable() = true;
182 opaque_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::opaque_changed));
184 TreeViewColumn* opaque_col = _display.get_column (10);
185 opaque_col->add_attribute (opaque_cell->property_visible(), _columns.property_toggles_visible);
187 _display.get_selection()->set_mode (SELECTION_MULTIPLE);
188 _display.add_object_drag (_columns.region.index(), "regions");
190 /* setup DnD handling */
192 list<TargetEntry> region_list_target_table;
194 region_list_target_table.push_back (TargetEntry ("text/plain"));
195 region_list_target_table.push_back (TargetEntry ("text/uri-list"));
196 region_list_target_table.push_back (TargetEntry ("application/x-rootwin-drop"));
198 _display.add_drop_targets (region_list_target_table);
199 _display.signal_drag_data_received().connect (sigc::mem_fun(*this, &EditorRegions::drag_data_received));
201 _scroller.add (_display);
202 _scroller.set_policy (POLICY_AUTOMATIC, POLICY_AUTOMATIC);
204 _display.signal_button_press_event().connect (sigc::mem_fun(*this, &EditorRegions::button_press), false);
205 _change_connection = _display.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &EditorRegions::selection_changed));
207 _scroller.signal_key_press_event().connect (sigc::mem_fun(*this, &EditorRegions::key_press), false);
208 _scroller.signal_focus_in_event().connect (sigc::mem_fun (*this, &EditorRegions::focus_in), false);
209 _scroller.signal_focus_out_event().connect (sigc::mem_fun (*this, &EditorRegions::focus_out));
211 _display.signal_enter_notify_event().connect (sigc::mem_fun (*this, &EditorRegions::enter_notify), false);
212 _display.signal_leave_notify_event().connect (sigc::mem_fun (*this, &EditorRegions::leave_notify), false);
214 // _display.signal_popup_menu().connect (sigc::bind (sigc::mem_fun (*this, &Editor::show__display_context_menu), 1, 0));
216 //ARDOUR_UI::instance()->secondary_clock.mode_changed.connect (sigc::mem_fun(*this, &Editor::redisplay_regions));
217 ARDOUR_UI::instance()->secondary_clock->mode_changed.connect (sigc::mem_fun(*this, &EditorRegions::update_all_rows));
218 ARDOUR::Region::RegionPropertyChanged.connect (region_property_connection, MISSING_INVALIDATOR, boost::bind (&EditorRegions::region_changed, this, _1, _2), gui_context());
219 ARDOUR::RegionFactory::CheckNewRegion.connect (check_new_region_connection, MISSING_INVALIDATOR, boost::bind (&EditorRegions::add_region, this, _1), gui_context());
221 e->EditorFreeze.connect (editor_freeze_connection, MISSING_INVALIDATOR, boost::bind (&EditorRegions::freeze_tree_model, this), gui_context());
222 e->EditorThaw.connect (editor_thaw_connection, MISSING_INVALIDATOR, boost::bind (&EditorRegions::thaw_tree_model, this), gui_context());
226 EditorRegions::focus_in (GdkEventFocus*)
228 Window* win = dynamic_cast<Window*> (_scroller.get_toplevel ());
231 old_focus = win->get_focus ();
238 /* try to do nothing on focus in (doesn't work, hence selection_count nonsense) */
243 EditorRegions::focus_out (GdkEventFocus*)
246 old_focus->grab_focus ();
256 EditorRegions::enter_notify (GdkEventCrossing*)
262 /* arm counter so that ::selection_filter() will deny selecting anything for the
263 next two attempts to change selection status.
265 _scroller.grab_focus ();
266 Keyboard::magic_widget_grab_focus ();
271 EditorRegions::leave_notify (GdkEventCrossing*)
274 old_focus->grab_focus ();
278 Keyboard::magic_widget_drop_focus ();
283 EditorRegions::set_session (ARDOUR::Session* s)
285 SessionHandlePtr::set_session (s);
290 EditorRegions::add_region (boost::shared_ptr<Region> region)
292 if (!region || !_session) {
299 bool missing_source = boost::dynamic_pointer_cast<SilentFileSource>(region->source()) != NULL;
301 if (!_show_automatic_regions && region->automatic()) {
305 if (region->hidden()) {
307 TreeModel::iterator iter = _model->get_iter ("0");
308 TreeModel::Row parent;
311 parent = *(_model->append());
312 parent[_columns.name] = _("Hidden");
313 boost::shared_ptr<Region> proxy = parent[_columns.region];
316 string s = (*iter)[_columns.name];
317 if (s != _("Hidden")) {
318 parent = *(_model->insert(iter));
319 parent[_columns.name] = _("Hidden");
320 boost::shared_ptr<Region> proxy = parent[_columns.region];
327 row = *(_model->append (parent.children()));
329 } else if (region->whole_file()) {
331 TreeModel::iterator i;
332 TreeModel::Children rows = _model->children();
334 for (i = rows.begin(); i != rows.end(); ++i) {
335 boost::shared_ptr<Region> rr = (*i)[_columns.region];
337 if (rr && region->region_list_equivalent (rr)) {
342 row = *(_model->append());
344 if (missing_source) {
345 // c.set_rgb(65535,0,0); // FIXME: error color from style
346 set_color_from_rgba (c, UIConfiguration::instance().color ("region list missing source"));
348 } else if (region->automatic()){
349 // c.set_rgb(0,65535,0); // FIXME: error color from style
350 set_color_from_rgba (c, UIConfiguration::instance().color ("region list automatic"));
353 set_color_from_rgba (c, UIConfiguration::instance().color ("region list whole file"));
356 row[_columns.color_] = c;
358 if (region->source()->name()[0] == '/') { // external file
360 if (region->whole_file()) {
362 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(region->source());
366 str = region_name_from_path (afs->path(), region->n_channels() > 1);
368 str += region->source()->name();
372 str = region->name();
376 str = region->name();
379 if (region->n_channels() > 1) {
380 std::stringstream foo;
381 foo << region->n_channels ();
387 row[_columns.name] = str;
388 row[_columns.region] = region;
389 row[_columns.property_toggles_visible] = false;
391 if (missing_source) {
392 row[_columns.path] = _("(MISSING) ") + region->source()->name();
395 boost::shared_ptr<FileSource> fs = boost::dynamic_pointer_cast<FileSource>(region->source());
397 row[_columns.path] = fs->path();
399 row[_columns.path] = region->source()->name();
403 region_row_map.insert(pair<boost::shared_ptr<ARDOUR::Region>, Gtk::TreeModel::RowReference>(region, TreeRowReference(_model, TreePath (row))) );
404 parent_regions_sources_map.insert(pair<string, Gtk::TreeModel::RowReference>(region->source_string(), TreeRowReference(_model, TreePath (row))) );
409 // find parent node, add as new child
410 TreeModel::iterator i;
412 boost::unordered_map<string, Gtk::TreeModel::RowReference>::iterator it;
414 it = parent_regions_sources_map.find (region->source_string());
416 if (it != parent_regions_sources_map.end()){
418 TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
420 TreeModel::iterator ii;
421 TreeModel::Children subrows = (*j).children();
423 /* XXXX: should we be accounting for all regions? */
425 for (ii = subrows.begin(); ii != subrows.end(); ++ii) {
426 boost::shared_ptr<Region> rr = (*ii)[_columns.region];
428 if (region->region_list_equivalent (rr)) {
434 row = *(_model->insert (subrows.end()));
437 row = *(_model->append());
440 row[_columns.property_toggles_visible] = true;
443 row[_columns.region] = region;
445 region_row_map.insert(pair<boost::shared_ptr<ARDOUR::Region>, Gtk::TreeModel::RowReference>(region, TreeRowReference(_model, TreePath (row))) );
447 populate_row(region, (*row));
451 EditorRegions::remove_unused_regions ()
453 vector<string> choices;
460 prompt = _("Do you really want to remove unused regions?"
461 "\n(This is destructive and cannot be undone)");
463 choices.push_back (_("No, do nothing."));
464 choices.push_back (_("Yes, remove."));
466 Gtkmm2ext::Choice prompter (_("Remove unused regions"), prompt, choices);
468 if (prompter.run () == 1) {
469 _no_redisplay = true;
470 _session->cleanup_regions ();
471 _no_redisplay = false;
477 EditorRegions::region_changed (boost::shared_ptr<Region> r, const PropertyChange& what_changed)
479 PropertyChange our_interests;
481 our_interests.add (ARDOUR::Properties::name);
482 our_interests.add (ARDOUR::Properties::position);
483 our_interests.add (ARDOUR::Properties::length);
484 our_interests.add (ARDOUR::Properties::start);
485 our_interests.add (ARDOUR::Properties::locked);
486 our_interests.add (ARDOUR::Properties::position_lock_style);
487 our_interests.add (ARDOUR::Properties::muted);
488 our_interests.add (ARDOUR::Properties::opaque);
489 our_interests.add (ARDOUR::Properties::fade_in);
490 our_interests.add (ARDOUR::Properties::fade_out);
491 our_interests.add (ARDOUR::Properties::fade_in_active);
492 our_interests.add (ARDOUR::Properties::fade_out_active);
494 if (what_changed.contains (our_interests)) {
498 TreeModel::iterator j = _model->get_iter (last_row.get_path());
499 boost::shared_ptr<Region> c = (*j)[_columns.region];
502 populate_row (r, (*j));
504 if (what_changed.contains (ARDOUR::Properties::hidden)) {
512 RegionRowMap::iterator it;
514 it = region_row_map.find (r);
516 if (it != region_row_map.end()){
518 TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
519 boost::shared_ptr<Region> c = (*j)[_columns.region];
522 populate_row (r, (*j));
524 if (what_changed.contains (ARDOUR::Properties::hidden)) {
533 if (what_changed.contains (ARDOUR::Properties::hidden)) {
539 EditorRegions::selection_changed ()
541 if (ignore_region_list_selection_change) {
545 _editor->_region_selection_change_updates_region_list = false;
547 if (_display.get_selection()->count_selected_rows() > 0) {
550 TreeView::Selection::ListHandle_Path rows = _display.get_selection()->get_selected_rows ();
552 _editor->get_selection().clear_regions ();
554 for (TreeView::Selection::ListHandle_Path::iterator i = rows.begin(); i != rows.end(); ++i) {
556 if ((iter = _model->get_iter (*i))) {
558 boost::shared_ptr<Region> region = (*iter)[_columns.region];
560 // they could have clicked on a row that is just a placeholder, like "Hidden"
561 // although that is not allowed by our selection filter. check it anyway
562 // since we need a region ptr.
566 _change_connection.block (true);
567 _editor->set_selected_regionview_from_region_list (region, Selection::Add);
568 _change_connection.block (false);
574 _editor->get_selection().clear_regions ();
577 _editor->_region_selection_change_updates_region_list = true;
581 EditorRegions::set_selected (RegionSelection& regions)
583 for (RegionSelection::iterator i = regions.begin(); i != regions.end(); ++i) {
585 boost::shared_ptr<Region> r ((*i)->region());
587 RegionRowMap::iterator it;
589 it = region_row_map.find (r);
591 if (it != region_row_map.end()){
592 TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
593 _display.get_selection()->select(*j);
599 EditorRegions::redisplay ()
601 if (_no_redisplay || !_session) {
605 bool tree_expanded = false;
607 /* If the list was expanded prior to rebuilding, expand it again afterwards */
608 if (toggle_full_action()->get_active()) {
609 tree_expanded = true;
612 _display.set_model (Glib::RefPtr<Gtk::TreeStore>(0));
614 _model->set_sort_column (-2, SORT_ASCENDING); //Disable sorting to gain performance
617 region_row_map.clear();
618 parent_regions_sources_map.clear();
620 /* now add everything we have, via a temporary list used to help with sorting */
622 const RegionFactory::RegionMap& regions (RegionFactory::regions());
624 for (RegionFactory::RegionMap::const_iterator i = regions.begin(); i != regions.end(); ++i) {
626 if ( i->second->whole_file()) {
627 /* add automatic regions first so that children can find their parents as we add them */
628 add_region (i->second);
632 tmp_region_list.push_front (i->second);
635 for (list<boost::shared_ptr<Region> >::iterator r = tmp_region_list.begin(); r != tmp_region_list.end(); ++r) {
639 _model->set_sort_column (0, SORT_ASCENDING); // renabale sorting
640 _display.set_model (_model);
642 tmp_region_list.clear();
645 _display.expand_all();
650 EditorRegions::update_row (boost::shared_ptr<Region> region)
652 if (!region || !_session) {
656 RegionRowMap::iterator it;
658 it = region_row_map.find (region);
660 if (it != region_row_map.end()){
662 TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
663 populate_row(region, (*j));
668 EditorRegions::update_all_rows ()
674 RegionRowMap::iterator i;
676 for (i = region_row_map.begin(); i != region_row_map.end(); ++i) {
678 TreeModel::iterator j = _model->get_iter ((*i).second.get_path());
680 boost::shared_ptr<Region> region = (*j)[_columns.region];
682 if (!region->automatic()) {
683 populate_row(region, (*j));
689 EditorRegions::format_position (framepos_t pos, char* buf, size_t bufsize, bool onoff)
691 Timecode::BBT_Time bbt;
692 Timecode::Time timecode;
695 error << string_compose (_("EditorRegions::format_position: negative timecode position: %1"), pos) << endmsg;
696 snprintf (buf, bufsize, "invalid");
700 switch (ARDOUR_UI::instance()->secondary_clock->mode ()) {
701 case AudioClock::BBT:
702 _session->tempo_map().bbt_time (pos, bbt);
704 snprintf (buf, bufsize, "%03d|%02d|%04d" , bbt.bars, bbt.beats, bbt.ticks);
706 snprintf (buf, bufsize, "(%03d|%02d|%04d)" , bbt.bars, bbt.beats, bbt.ticks);
710 case AudioClock::MinSec:
717 hrs = (int) floor (left / (_session->frame_rate() * 60.0f * 60.0f));
718 left -= (framecnt_t) floor (hrs * _session->frame_rate() * 60.0f * 60.0f);
719 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
720 left -= (framecnt_t) floor (mins * _session->frame_rate() * 60.0f);
721 secs = left / (float) _session->frame_rate();
723 snprintf (buf, bufsize, "%02d:%02d:%06.3f", hrs, mins, secs);
725 snprintf (buf, bufsize, "(%02d:%02d:%06.3f)", hrs, mins, secs);
729 case AudioClock::Frames:
731 snprintf (buf, bufsize, "%" PRId64, pos);
733 snprintf (buf, bufsize, "(%" PRId64 ")", pos);
737 case AudioClock::Timecode:
739 _session->timecode_time (pos, timecode);
741 snprintf (buf, bufsize, "%02d:%02d:%02d:%02d", timecode.hours, timecode.minutes, timecode.seconds, timecode.frames);
743 snprintf (buf, bufsize, "(%02d:%02d:%02d:%02d)", timecode.hours, timecode.minutes, timecode.seconds, timecode.frames);
750 EditorRegions::populate_row (boost::shared_ptr<Region> region, TreeModel::Row const &row)
752 boost::shared_ptr<AudioRegion> audioregion = boost::dynamic_pointer_cast<AudioRegion>(region);
753 //uint32_t used = _session->playlists->region_use_count (region);
754 /* Presently a region is only used once so let's save on the sequential scan to determine use count */
757 populate_row_position (region, row, used);
758 populate_row_end (region, row, used);
759 populate_row_sync (region, row, used);
760 populate_row_fade_in (region, row, used, audioregion);
761 populate_row_fade_out (region, row, used, audioregion);
762 populate_row_locked (region, row, used);
763 populate_row_glued (region, row, used);
764 populate_row_muted (region, row, used);
765 populate_row_opaque (region, row, used);
766 populate_row_length (region, row);
767 populate_row_source (region, row);
768 populate_row_name (region, row);
769 populate_row_used (region, row, used);
773 if (audioRegion && fades_in_seconds) {
779 left = audioRegion->fade_in()->back()->when;
780 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
781 left -= (framepos_t) floor (mins * _session->frame_rate() * 60.0f);
782 millisecs = (int) floor ((left * 1000.0f) / _session->frame_rate());
784 if (audioRegion->fade_in()->back()->when >= _session->frame_rate()) {
785 sprintf (fadein_str, "%01dM %01dmS", mins, millisecs);
787 sprintf (fadein_str, "%01dmS", millisecs);
790 left = audioRegion->fade_out()->back()->when;
791 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
792 left -= (framepos_t) floor (mins * _session->frame_rate() * 60.0f);
793 millisecs = (int) floor ((left * 1000.0f) / _session->frame_rate());
795 if (audioRegion->fade_out()->back()->when >= _session->frame_rate()) {
796 sprintf (fadeout_str, "%01dM %01dmS", mins, millisecs);
798 sprintf (fadeout_str, "%01dmS", millisecs);
804 EditorRegions::populate_row_used (boost::shared_ptr<Region>, TreeModel::Row const& row, uint32_t used)
807 snprintf (buf, sizeof (buf), "%4d" , used);
808 row[_columns.used] = buf;
812 EditorRegions::populate_row_length (boost::shared_ptr<Region> region, TreeModel::Row const &row)
815 format_position (region->length(), buf, sizeof (buf));
816 row[_columns.length] = buf;
820 EditorRegions::populate_row_end (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
822 if (region->whole_file()) {
823 row[_columns.end] = "";
824 } else if (used > 1) {
825 row[_columns.end] = _("Mult.");
826 } else if (region->last_frame() >= region->first_frame()) {
828 format_position (region->last_frame(), buf, sizeof (buf));
829 row[_columns.end] = buf;
831 row[_columns.end] = "empty";
836 EditorRegions::populate_row_position (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
838 if (region->whole_file()) {
839 row[_columns.position] = "";
840 } else if (used > 1) {
841 row[_columns.position] = _("Mult.");
844 format_position (region->position(), buf, sizeof (buf));
845 row[_columns.position] = buf;
850 EditorRegions::populate_row_sync (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
852 if (region->whole_file()) {
853 row[_columns.sync] = "";
854 } else if (used > 1) {
855 row[_columns.sync] = _("Mult."); /* translators: a short phrase for "multiple" as in "many" */
857 if (region->sync_position() == region->position()) {
858 row[_columns.sync] = _("Start");
859 } else if (region->sync_position() == (region->last_frame())) {
860 row[_columns.sync] = _("End");
863 format_position (region->sync_position(), buf, sizeof (buf));
864 row[_columns.sync] = buf;
870 EditorRegions::populate_row_fade_in (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used, boost::shared_ptr<AudioRegion> audioregion)
872 if (!audioregion || region->whole_file()) {
873 row[_columns.fadein] = "";
876 row[_columns.fadein] = _("Multiple");
879 format_position (audioregion->fade_in()->back()->when, buf, sizeof (buf), audioregion->fade_in_active());
880 row[_columns.fadein] = buf;
886 EditorRegions::populate_row_fade_out (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used, boost::shared_ptr<AudioRegion> audioregion)
888 if (!audioregion || region->whole_file()) {
889 row[_columns.fadeout] = "";
892 row[_columns.fadeout] = _("Multiple");
895 format_position (audioregion->fade_out()->back()->when, buf, sizeof (buf), audioregion->fade_out_active());
896 row[_columns.fadeout] = buf;
902 EditorRegions::populate_row_locked (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
904 if (region->whole_file()) {
905 row[_columns.locked] = false;
906 } else if (used > 1) {
907 row[_columns.locked] = false;
909 row[_columns.locked] = region->locked();
914 EditorRegions::populate_row_glued (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
916 if (region->whole_file() || used > 1) {
917 row[_columns.glued] = false;
919 if (region->position_lock_style() == MusicTime) {
920 row[_columns.glued] = true;
922 row[_columns.glued] = false;
928 EditorRegions::populate_row_muted (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
930 if (region->whole_file() || used > 1) {
931 row[_columns.muted] = false;
933 row[_columns.muted] = region->muted();
938 EditorRegions::populate_row_opaque (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
940 if (region->whole_file() || used > 1) {
941 row[_columns.opaque] = false;
943 row[_columns.opaque] = region->opaque();
948 EditorRegions::populate_row_name (boost::shared_ptr<Region> region, TreeModel::Row const &row)
950 if (region->n_channels() > 1) {
951 row[_columns.name] = string_compose("%1 [%2]", region->name(), region->n_channels());
953 row[_columns.name] = region->name();
958 EditorRegions::populate_row_source (boost::shared_ptr<Region> region, TreeModel::Row const &row)
960 if (boost::dynamic_pointer_cast<SilentFileSource>(region->source())) {
961 row[_columns.path] = _("MISSING ") + region->source()->name();
963 row[_columns.path] = region->source()->name();
968 EditorRegions::toggle_show_auto_regions ()
970 _show_automatic_regions = toggle_show_auto_regions_action()->get_active();
975 EditorRegions::toggle_full ()
977 set_full (toggle_full_action()->get_active ());
981 EditorRegions::set_full (bool f)
984 _display.expand_all ();
987 _display.collapse_all ();
993 EditorRegions::show_context_menu (int button, int time)
996 _menu = dynamic_cast<Menu*> (ActionManager::get_widget ("/RegionListMenu"));
999 if (_display.get_selection()->count_selected_rows() > 0) {
1000 ActionManager::set_sensitive (ActionManager::region_list_selection_sensitive_actions, true);
1002 ActionManager::set_sensitive (ActionManager::region_list_selection_sensitive_actions, false);
1005 /* Enable the "Show" option if any selected regions are hidden, and vice versa for "Hide" */
1007 bool have_shown = false;
1008 bool have_hidden = false;
1010 TreeView::Selection::ListHandle_Path rows = _display.get_selection()->get_selected_rows ();
1011 for (TreeView::Selection::ListHandle_Path::iterator i = rows.begin(); i != rows.end(); ++i) {
1012 TreeIter t = _model->get_iter (*i);
1013 boost::shared_ptr<Region> r = (*t)[_columns.region];
1023 hide_action()->set_sensitive (have_shown);
1024 show_action()->set_sensitive (have_hidden);
1026 _menu->popup (button, time);
1030 EditorRegions::key_press (GdkEventKey* ev)
1032 TreeViewColumn *col;
1034 switch (ev->keyval) {
1036 case GDK_ISO_Left_Tab:
1038 if (name_editable) {
1039 name_editable->editing_done ();
1043 col = _display.get_column (0); // select&focus on name column
1045 if (Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)) {
1046 treeview_select_previous (_display, _model, col);
1048 treeview_select_next (_display, _model, col);
1062 EditorRegions::button_press (GdkEventButton *ev)
1064 boost::shared_ptr<Region> region;
1066 TreeModel::Path path;
1067 TreeViewColumn* column;
1071 if (_display.get_path_at_pos ((int)ev->x, (int)ev->y, path, column, cellx, celly)) {
1072 if ((iter = _model->get_iter (path))) {
1073 region = (*iter)[_columns.region];
1077 if (Keyboard::is_context_menu_event (ev)) {
1078 show_context_menu (ev->button, ev->time);
1082 if (region != 0 && Keyboard::is_button2_event (ev)) {
1083 // start/stop audition
1084 if (!Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
1085 _editor->consider_auditioning (region);
1094 EditorRegions::sorter (TreeModel::iterator a, TreeModel::iterator b)
1098 boost::shared_ptr<Region> r1 = (*a)[_columns.region];
1099 boost::shared_ptr<Region> r2 = (*b)[_columns.region];
1101 /* handle rows without regions, like "Hidden" */
1111 boost::shared_ptr<AudioRegion> region1 = boost::dynamic_pointer_cast<AudioRegion> (r1);
1112 boost::shared_ptr<AudioRegion> region2 = boost::dynamic_pointer_cast<AudioRegion> (r2);
1114 if (region1 == 0 || region2 == 0) {
1117 switch (_sort_type) {
1119 s1 = (*a)[_columns.name];
1120 s2 = (*b)[_columns.name];
1121 return (s1.compare (s2));
1127 switch (_sort_type) {
1129 cmp = region1->name().compare(region2->name());
1133 cmp = region1->length() - region2->length();
1137 cmp = region1->position() - region2->position();
1141 cmp = region1->source()->timestamp() - region2->source()->timestamp();
1145 cmp = region1->start() - region2->start();
1149 // cerr << "Compare " << (region1->start() + region1->length()) << " and " << (region2->start() + region2->length()) << endl;
1150 cmp = (region1->start() + region1->length()) - (region2->start() + region2->length());
1153 case BySourceFileName:
1154 cmp = region1->source()->name().compare(region2->source()->name());
1157 case BySourceFileLength:
1158 cmp = region1->source_length(0) - region2->source_length(0);
1161 case BySourceFileCreationDate:
1162 cmp = region1->source()->timestamp() - region2->source()->timestamp();
1165 case BySourceFileFS:
1166 if (region1->source()->name() == region2->source()->name()) {
1167 cmp = region1->name().compare(region2->name());
1169 cmp = region1->source()->name().compare(region2->source()->name());
1174 // cerr << "Comparison on " << enum_2_string (_sort_type) << " gives " << cmp << endl;
1178 } else if (cmp > 0) {
1186 EditorRegions::reset_sort_type (RegionListSortType type, bool force)
1188 if (type != _sort_type || force) {
1190 _model->set_sort_func (0, (sigc::mem_fun (*this, &EditorRegions::sorter)));
1195 EditorRegions::reset_sort_direction (bool up)
1197 _model->set_sort_column (0, up ? SORT_ASCENDING : SORT_DESCENDING);
1201 EditorRegions::selection_mapover (sigc::slot<void,boost::shared_ptr<Region> > sl)
1203 Glib::RefPtr<TreeSelection> selection = _display.get_selection();
1204 TreeView::Selection::ListHandle_Path rows = selection->get_selected_rows ();
1205 TreeView::Selection::ListHandle_Path::iterator i = rows.begin();
1207 if (selection->count_selected_rows() == 0 || _session == 0) {
1211 for (; i != rows.end(); ++i) {
1214 if ((iter = _model->get_iter (*i))) {
1216 /* some rows don't have a region associated with them, but can still be
1217 selected (XXX maybe prevent them from being selected)
1220 boost::shared_ptr<Region> r = (*iter)[_columns.region];
1231 EditorRegions::drag_data_received (const RefPtr<Gdk::DragContext>& context,
1233 const SelectionData& data,
1234 guint info, guint time)
1236 vector<string> paths;
1238 if (data.get_target() == "GTK_TREE_MODEL_ROW") {
1239 /* something is being dragged over the region list */
1240 _editor->_drags->abort ();
1241 _display.on_drag_data_received (context, x, y, data, info, time);
1245 if (_editor->convert_drop_to_paths (paths, context, x, y, data, info, time) == 0) {
1247 bool copy = ((context->get_actions() & (Gdk::ACTION_COPY | Gdk::ACTION_LINK | Gdk::ACTION_MOVE)) == Gdk::ACTION_COPY);
1249 if (Profile->get_sae() || UIConfiguration::instance().get_only_copy_imported_files() || copy) {
1250 _editor->do_import (paths, Editing::ImportDistinctFiles, Editing::ImportAsRegion, SrcBest, pos);
1252 _editor->do_embed (paths, Editing::ImportDistinctFiles, ImportAsRegion, pos);
1254 context->drag_finish (true, false, time);
1259 EditorRegions::selection_filter (const RefPtr<TreeModel>& model, const TreeModel::Path& path, bool already_selected)
1261 /* not possible to select rows that do not represent regions, like "Hidden" */
1263 if (already_selected) {
1264 /* deselecting anything is OK with us */
1268 TreeModel::iterator iter = model->get_iter (path);
1271 boost::shared_ptr<Region> r =(*iter)[_columns.region];
1281 EditorRegions::name_editing_started (CellEditable* ce, const Glib::ustring&)
1285 /* give it a special name */
1287 Gtk::Entry *e = dynamic_cast<Gtk::Entry*> (ce);
1290 e->set_name (X_("RegionNameEditorEntry"));
1295 EditorRegions::name_edit (const std::string& path, const std::string& new_text)
1299 boost::shared_ptr<Region> region;
1302 if ((iter = _model->get_iter (path))) {
1303 region = (*iter)[_columns.region];
1304 (*iter)[_columns.name] = new_text;
1307 /* now mapover everything */
1310 vector<RegionView*> equivalents;
1311 _editor->get_regions_corresponding_to (region, equivalents, false);
1313 for (vector<RegionView*>::iterator i = equivalents.begin(); i != equivalents.end(); ++i) {
1314 if (new_text != (*i)->region()->name()) {
1315 (*i)->region()->set_name (new_text);
1322 /** @return Region that has been dragged out of the list, or 0 */
1323 boost::shared_ptr<Region>
1324 EditorRegions::get_dragged_region ()
1326 list<boost::shared_ptr<Region> > regions;
1328 _display.get_object_drag_data (regions, &source);
1330 if (regions.empty()) {
1331 return boost::shared_ptr<Region> ();
1334 assert (regions.size() == 1);
1335 return regions.front ();
1339 EditorRegions::clear ()
1341 _display.set_model (Glib::RefPtr<Gtk::TreeStore> (0));
1343 _display.set_model (_model);
1345 /* Clean up the maps */
1346 region_row_map.clear();
1347 parent_regions_sources_map.clear();
1350 boost::shared_ptr<Region>
1351 EditorRegions::get_single_selection ()
1353 Glib::RefPtr<TreeSelection> selected = _display.get_selection();
1355 if (selected->count_selected_rows() != 1) {
1356 return boost::shared_ptr<Region> ();
1359 TreeView::Selection::ListHandle_Path rows = selected->get_selected_rows ();
1361 /* only one row selected, so rows.begin() is it */
1363 TreeIter iter = _model->get_iter (*rows.begin());
1366 return boost::shared_ptr<Region> ();
1369 return (*iter)[_columns.region];
1373 EditorRegions::freeze_tree_model (){
1375 _display.set_model (Glib::RefPtr<Gtk::TreeStore>(0));
1376 _model->set_sort_column (-2, SORT_ASCENDING); //Disable sorting to gain performance
1381 EditorRegions::thaw_tree_model (){
1383 _model->set_sort_column (0, SORT_ASCENDING); // renabale sorting
1384 _display.set_model (_model);
1386 if (toggle_full_action()->get_active()) {
1387 _display.expand_all();
1392 EditorRegions::locked_changed (std::string const & path)
1394 TreeIter i = _model->get_iter (path);
1396 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1398 region->set_locked (!(*i)[_columns.locked]);
1404 EditorRegions::glued_changed (std::string const & path)
1406 TreeIter i = _model->get_iter (path);
1408 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1410 /* `glued' means MusicTime, and we're toggling here */
1411 region->set_position_lock_style ((*i)[_columns.glued] ? AudioTime : MusicTime);
1418 EditorRegions::muted_changed (std::string const & path)
1420 TreeIter i = _model->get_iter (path);
1422 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1424 region->set_muted (!(*i)[_columns.muted]);
1431 EditorRegions::opaque_changed (std::string const & path)
1433 TreeIter i = _model->get_iter (path);
1435 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1437 region->set_opaque (!(*i)[_columns.opaque]);
1444 EditorRegions::get_state () const
1446 XMLNode* node = new XMLNode (X_("RegionList"));
1448 node->add_property (X_("sort-type"), enum_2_string (_sort_type));
1450 RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), X_("SortAscending"));
1451 bool const ascending = RefPtr<RadioAction>::cast_dynamic(act)->get_active ();
1452 node->add_property (X_("sort-ascending"), ascending ? "yes" : "no");
1453 node->add_property (X_("show-all"), toggle_full_action()->get_active() ? "yes" : "no");
1454 node->add_property (X_("show-automatic-regions"), _show_automatic_regions ? "yes" : "no");
1460 EditorRegions::set_state (const XMLNode & node)
1462 bool changed = false;
1464 if (node.name() != X_("RegionList")) {
1468 XMLProperty const * p = node.property (X_("sort-type"));
1471 Editing::RegionListSortType const t = static_cast<Editing::RegionListSortType> (string_2_enum (p->value(), _sort_type));
1473 if (_sort_type != t) {
1477 reset_sort_type (t, true);
1478 RefPtr<RadioAction> ract = sort_type_action (t);
1479 ract->set_active ();
1482 p = node.property (X_("sort-ascending"));
1485 bool const yn = string_is_affirmative (p->value ());
1486 SortType old_sort_type;
1487 int old_sort_column;
1489 _model->get_sort_column_id (old_sort_column, old_sort_type);
1491 if (old_sort_type != (yn ? SORT_ASCENDING : SORT_DESCENDING)) {
1495 reset_sort_direction (yn);
1499 act = ActionManager::get_action (X_("RegionList"), X_("SortAscending"));
1501 act = ActionManager::get_action (X_("RegionList"), X_("SortDescending"));
1504 RefPtr<RadioAction>::cast_dynamic(act)->set_active ();
1507 p = node.property (X_("show-all"));
1509 bool const yn = string_is_affirmative (p->value ());
1511 if (expanded != yn) {
1516 toggle_full_action()->set_active (yn);
1519 p = node.property (X_("show-automatic-regions"));
1521 bool const yn = string_is_affirmative (p->value ());
1523 if (yn != _show_automatic_regions) {
1524 _show_automatic_regions = yn;
1525 toggle_show_auto_regions_action()->set_active (yn);
1536 EditorRegions::sort_type_action (Editing::RegionListSortType t) const
1538 const char* action = 0;
1541 case Editing::ByName:
1542 action = X_("SortByRegionName");
1544 case Editing::ByLength:
1545 action = X_("SortByRegionLength");
1547 case Editing::ByPosition:
1548 action = X_("SortByRegionPosition");
1550 case Editing::ByTimestamp:
1551 action = X_("SortByRegionTimestamp");
1553 case Editing::ByStartInFile:
1554 action = X_("SortByRegionStartinFile");
1556 case Editing::ByEndInFile:
1557 action = X_("SortByRegionEndinFile");
1559 case Editing::BySourceFileName:
1560 action = X_("SortBySourceFileName");
1562 case Editing::BySourceFileLength:
1563 action = X_("SortBySourceFileLength");
1565 case Editing::BySourceFileCreationDate:
1566 action = X_("SortBySourceFileCreationDate");
1568 case Editing::BySourceFileFS:
1569 action = X_("SortBySourceFilesystem");
1572 fatal << string_compose (_("programming error: %1: %2"), "EditorRegions: impossible sort type", (int) t) << endmsg;
1573 abort(); /*NOTREACHED*/
1576 RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), action);
1579 return RefPtr<RadioAction>::cast_dynamic (act);
1583 EditorRegions::hide_action () const
1585 return ActionManager::get_action (X_("RegionList"), X_("rlHide"));
1590 EditorRegions::show_action () const
1592 return ActionManager::get_action (X_("RegionList"), X_("rlShow"));
1596 EditorRegions::remove_unused_regions_action () const
1598 return ActionManager::get_action (X_("RegionList"), X_("removeUnusedRegions"));
1601 RefPtr<ToggleAction>
1602 EditorRegions::toggle_full_action () const
1604 Glib::RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), X_("rlShowAll"));
1606 return Glib::RefPtr<ToggleAction>::cast_dynamic (act);
1609 RefPtr<ToggleAction>
1610 EditorRegions::toggle_show_auto_regions_action () const
1612 Glib::RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), X_("rlShowAuto"));
1614 return Glib::RefPtr<ToggleAction>::cast_dynamic (act);