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"
38 #include "gtkmm2ext/utils.h"
40 #include "audio_clock.h"
44 #include "ardour_ui.h"
45 #include "gui_thread.h"
47 #include "region_view.h"
49 #include "editor_regions.h"
50 #include "editor_drag.h"
51 #include "main_clock.h"
53 #include "ui_config.h"
58 using namespace ARDOUR;
59 using namespace ARDOUR_UI_UTILS;
63 using namespace Editing;
64 using Gtkmm2ext::Keyboard;
72 EditorRegions::EditorRegions (Editor* e)
77 , _show_automatic_regions (true)
78 , ignore_region_list_selection_change (false)
79 , ignore_selected_region_change (false)
80 , _no_redisplay (false)
81 , _sort_type ((Editing::RegionListSortType) 0)
84 _display.set_size_request (100, -1);
85 _display.set_rules_hint (true);
86 _display.set_name ("EditGroupList");
88 /* Try to prevent single mouse presses from initiating edits.
89 This relies on a hack in gtktreeview.c:gtk_treeview_button_press()
91 _display.set_data ("mouse-edits-require-mod1", (gpointer) 0x1);
93 _model = TreeStore::create (_columns);
94 _model->set_sort_func (0, sigc::mem_fun (*this, &EditorRegions::sorter));
95 _model->set_sort_column (0, SORT_ASCENDING);
97 _display.set_model (_model);
99 _display.append_column ("", _columns.name);
100 _display.append_column ("", _columns.position);
101 _display.append_column ("", _columns.end);
102 _display.append_column ("", _columns.length);
103 _display.append_column ("", _columns.sync);
104 _display.append_column ("", _columns.fadein);
105 _display.append_column ("", _columns.fadeout);
106 _display.append_column ("", _columns.locked);
107 _display.append_column ("", _columns.glued);
108 _display.append_column ("", _columns.muted);
109 _display.append_column ("", _columns.opaque);
115 { 0, _("Region"), _("Region name, with number of channels in []'s") },
116 { 1, _("Position"), _("Position of start of region") },
117 { 2, _("End"), _("Position of end of region") },
118 { 3, _("Length"), _("Length of the region") },
119 { 4, _("Sync"), _("Position of region sync point, relative to start of the region") },
120 { 5, _("Fade In"), _("Length of region fade-in (units: secondary clock), () if disabled") },
121 { 6, _("Fade Out"), _("Length of region fade-out (units: secondary clock), () if disabled") },
122 { 7, S_("Lock|L"), _("Region position locked?") },
123 { 8, S_("Gain|G"), _("Region position glued to Bars|Beats time?") },
124 { 9, S_("Mute|M"), _("Region muted?") },
125 { 10, S_("Opaque|O"), _("Region opaque (blocks regions below it from being heard)?") },
129 for (int i = 0; ci[i].index >= 0; ++i) {
130 col = _display.get_column (ci[i].index);
131 l = manage (new Label (ci[i].label));
132 set_tooltip (*l, ci[i].tooltip);
133 col->set_widget (*l);
136 if (ci[i].index > 6) {
137 col->set_expand (false);
138 col->set_alignment (ALIGN_CENTER);
142 _display.set_headers_visible (true);
143 _display.set_rules_hint ();
145 /* show path as the row tooltip */
146 _display.set_tooltip_column (14); /* path */
148 CellRendererText* region_name_cell = dynamic_cast<CellRendererText*>(_display.get_column_cell_renderer (0));
149 region_name_cell->property_editable() = true;
150 region_name_cell->signal_edited().connect (sigc::mem_fun (*this, &EditorRegions::name_edit));
151 region_name_cell->signal_editing_started().connect (sigc::mem_fun (*this, &EditorRegions::name_editing_started));
153 _display.get_selection()->set_select_function (sigc::mem_fun (*this, &EditorRegions::selection_filter));
155 TreeViewColumn* tv_col = _display.get_column(0);
156 CellRendererText* renderer = dynamic_cast<CellRendererText*>(_display.get_column_cell_renderer (0));
157 tv_col->add_attribute(renderer->property_text(), _columns.name);
158 tv_col->add_attribute(renderer->property_foreground_gdk(), _columns.color_);
159 tv_col->set_expand (true);
161 CellRendererToggle* locked_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (7));
162 locked_cell->property_activatable() = true;
163 locked_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::locked_changed));
165 TreeViewColumn* locked_col = _display.get_column (7);
166 locked_col->add_attribute (locked_cell->property_visible(), _columns.property_toggles_visible);
168 CellRendererToggle* glued_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (8));
169 glued_cell->property_activatable() = true;
170 glued_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::glued_changed));
172 TreeViewColumn* glued_col = _display.get_column (8);
173 glued_col->add_attribute (glued_cell->property_visible(), _columns.property_toggles_visible);
175 CellRendererToggle* muted_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (9));
176 muted_cell->property_activatable() = true;
177 muted_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::muted_changed));
179 TreeViewColumn* muted_col = _display.get_column (9);
180 muted_col->add_attribute (muted_cell->property_visible(), _columns.property_toggles_visible);
182 CellRendererToggle* opaque_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (10));
183 opaque_cell->property_activatable() = true;
184 opaque_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::opaque_changed));
186 TreeViewColumn* opaque_col = _display.get_column (10);
187 opaque_col->add_attribute (opaque_cell->property_visible(), _columns.property_toggles_visible);
189 _display.get_selection()->set_mode (SELECTION_MULTIPLE);
190 _display.add_object_drag (_columns.region.index(), "regions");
192 /* setup DnD handling */
194 list<TargetEntry> region_list_target_table;
196 region_list_target_table.push_back (TargetEntry ("text/plain"));
197 region_list_target_table.push_back (TargetEntry ("text/uri-list"));
198 region_list_target_table.push_back (TargetEntry ("application/x-rootwin-drop"));
200 _display.add_drop_targets (region_list_target_table);
201 _display.signal_drag_data_received().connect (sigc::mem_fun(*this, &EditorRegions::drag_data_received));
203 _scroller.add (_display);
204 _scroller.set_policy (POLICY_AUTOMATIC, POLICY_AUTOMATIC);
206 _display.signal_button_press_event().connect (sigc::mem_fun(*this, &EditorRegions::button_press), false);
207 _change_connection = _display.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &EditorRegions::selection_changed));
209 _scroller.signal_key_press_event().connect (sigc::mem_fun(*this, &EditorRegions::key_press), false);
210 _scroller.signal_focus_in_event().connect (sigc::mem_fun (*this, &EditorRegions::focus_in), false);
211 _scroller.signal_focus_out_event().connect (sigc::mem_fun (*this, &EditorRegions::focus_out));
213 _display.signal_enter_notify_event().connect (sigc::mem_fun (*this, &EditorRegions::enter_notify), false);
214 _display.signal_leave_notify_event().connect (sigc::mem_fun (*this, &EditorRegions::leave_notify), false);
216 // _display.signal_popup_menu().connect (sigc::bind (sigc::mem_fun (*this, &Editor::show__display_context_menu), 1, 0));
218 //ARDOUR_UI::instance()->secondary_clock.mode_changed.connect (sigc::mem_fun(*this, &Editor::redisplay_regions));
219 ARDOUR_UI::instance()->secondary_clock->mode_changed.connect (sigc::mem_fun(*this, &EditorRegions::update_all_rows));
220 ARDOUR::Region::RegionPropertyChanged.connect (region_property_connection, MISSING_INVALIDATOR, boost::bind (&EditorRegions::region_changed, this, _1, _2), gui_context());
221 ARDOUR::RegionFactory::CheckNewRegion.connect (check_new_region_connection, MISSING_INVALIDATOR, boost::bind (&EditorRegions::add_region, this, _1), gui_context());
223 e->EditorFreeze.connect (editor_freeze_connection, MISSING_INVALIDATOR, boost::bind (&EditorRegions::freeze_tree_model, this), gui_context());
224 e->EditorThaw.connect (editor_thaw_connection, MISSING_INVALIDATOR, boost::bind (&EditorRegions::thaw_tree_model, this), gui_context());
228 EditorRegions::focus_in (GdkEventFocus*)
230 Window* win = dynamic_cast<Window*> (_scroller.get_toplevel ());
233 old_focus = win->get_focus ();
240 /* try to do nothing on focus in (doesn't work, hence selection_count nonsense) */
245 EditorRegions::focus_out (GdkEventFocus*)
248 old_focus->grab_focus ();
258 EditorRegions::enter_notify (GdkEventCrossing*)
264 /* arm counter so that ::selection_filter() will deny selecting anything for the
265 next two attempts to change selection status.
267 _scroller.grab_focus ();
268 Keyboard::magic_widget_grab_focus ();
273 EditorRegions::leave_notify (GdkEventCrossing*)
276 old_focus->grab_focus ();
280 Keyboard::magic_widget_drop_focus ();
285 EditorRegions::set_session (ARDOUR::Session* s)
287 SessionHandlePtr::set_session (s);
292 EditorRegions::add_region (boost::shared_ptr<Region> region)
294 if (!region || !_session) {
301 bool missing_source = boost::dynamic_pointer_cast<SilentFileSource>(region->source()) != NULL;
303 if (!_show_automatic_regions && region->automatic()) {
307 if (region->hidden()) {
309 TreeModel::iterator iter = _model->get_iter ("0");
310 TreeModel::Row parent;
313 parent = *(_model->append());
314 parent[_columns.name] = _("Hidden");
315 boost::shared_ptr<Region> proxy = parent[_columns.region];
318 string s = (*iter)[_columns.name];
319 if (s != _("Hidden")) {
320 parent = *(_model->insert(iter));
321 parent[_columns.name] = _("Hidden");
322 boost::shared_ptr<Region> proxy = parent[_columns.region];
329 row = *(_model->append (parent.children()));
331 } else if (region->whole_file()) {
333 TreeModel::iterator i;
334 TreeModel::Children rows = _model->children();
336 for (i = rows.begin(); i != rows.end(); ++i) {
337 boost::shared_ptr<Region> rr = (*i)[_columns.region];
339 if (rr && region->region_list_equivalent (rr)) {
344 row = *(_model->append());
346 if (missing_source) {
347 // c.set_rgb(65535,0,0); // FIXME: error color from style
348 set_color_from_rgba (c, UIConfiguration::instance().color ("region list missing source"));
350 } else if (region->automatic()){
351 // c.set_rgb(0,65535,0); // FIXME: error color from style
352 set_color_from_rgba (c, UIConfiguration::instance().color ("region list automatic"));
355 set_color_from_rgba (c, UIConfiguration::instance().color ("region list whole file"));
358 row[_columns.color_] = c;
360 if (region->source()->name()[0] == '/') { // external file
362 if (region->whole_file()) {
364 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(region->source());
368 str = region_name_from_path (afs->path(), region->n_channels() > 1);
370 str += region->source()->name();
374 str = region->name();
378 str = region->name();
381 if (region->n_channels() > 1) {
382 std::stringstream foo;
383 foo << region->n_channels ();
389 row[_columns.name] = str;
390 row[_columns.region] = region;
391 row[_columns.property_toggles_visible] = false;
393 if (missing_source) {
394 row[_columns.path] = _("(MISSING) ") + Gtkmm2ext::markup_escape_text (region->source()->name());
397 boost::shared_ptr<FileSource> fs = boost::dynamic_pointer_cast<FileSource>(region->source());
399 row[_columns.path] = Gtkmm2ext::markup_escape_text (fs->path());
401 row[_columns.path] = Gtkmm2ext::markup_escape_text (region->source()->name());
405 region_row_map.insert(pair<boost::shared_ptr<ARDOUR::Region>, Gtk::TreeModel::RowReference>(region, TreeRowReference(_model, TreePath (row))) );
406 parent_regions_sources_map.insert(pair<string, Gtk::TreeModel::RowReference>(region->source_string(), TreeRowReference(_model, TreePath (row))) );
411 // find parent node, add as new child
412 TreeModel::iterator i;
414 boost::unordered_map<string, Gtk::TreeModel::RowReference>::iterator it;
416 it = parent_regions_sources_map.find (region->source_string());
418 if (it != parent_regions_sources_map.end()){
420 TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
422 TreeModel::iterator ii;
423 TreeModel::Children subrows = (*j).children();
425 /* XXXX: should we be accounting for all regions? */
427 for (ii = subrows.begin(); ii != subrows.end(); ++ii) {
428 boost::shared_ptr<Region> rr = (*ii)[_columns.region];
430 if (region->region_list_equivalent (rr)) {
436 row = *(_model->insert (subrows.end()));
439 row = *(_model->append());
442 row[_columns.property_toggles_visible] = true;
445 row[_columns.region] = region;
447 region_row_map.insert(pair<boost::shared_ptr<ARDOUR::Region>, Gtk::TreeModel::RowReference>(region, TreeRowReference(_model, TreePath (row))) );
449 populate_row(region, (*row));
453 EditorRegions::remove_unused_regions ()
455 vector<string> choices;
462 prompt = _("Do you really want to remove unused regions?"
463 "\n(This is destructive and cannot be undone)");
465 choices.push_back (_("No, do nothing."));
466 choices.push_back (_("Yes, remove."));
468 Gtkmm2ext::Choice prompter (_("Remove unused regions"), prompt, choices);
470 if (prompter.run () == 1) {
471 _no_redisplay = true;
472 _session->cleanup_regions ();
473 _no_redisplay = false;
479 EditorRegions::region_changed (boost::shared_ptr<Region> r, const PropertyChange& what_changed)
481 PropertyChange our_interests;
483 our_interests.add (ARDOUR::Properties::name);
484 our_interests.add (ARDOUR::Properties::position);
485 our_interests.add (ARDOUR::Properties::length);
486 our_interests.add (ARDOUR::Properties::start);
487 our_interests.add (ARDOUR::Properties::locked);
488 our_interests.add (ARDOUR::Properties::position_lock_style);
489 our_interests.add (ARDOUR::Properties::muted);
490 our_interests.add (ARDOUR::Properties::opaque);
491 our_interests.add (ARDOUR::Properties::fade_in);
492 our_interests.add (ARDOUR::Properties::fade_out);
493 our_interests.add (ARDOUR::Properties::fade_in_active);
494 our_interests.add (ARDOUR::Properties::fade_out_active);
496 if (what_changed.contains (our_interests)) {
500 TreeModel::iterator j = _model->get_iter (last_row.get_path());
501 boost::shared_ptr<Region> c = (*j)[_columns.region];
504 populate_row (r, (*j));
506 if (what_changed.contains (ARDOUR::Properties::hidden)) {
514 RegionRowMap::iterator it;
516 it = region_row_map.find (r);
518 if (it != region_row_map.end()){
520 TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
521 boost::shared_ptr<Region> c = (*j)[_columns.region];
524 populate_row (r, (*j));
526 if (what_changed.contains (ARDOUR::Properties::hidden)) {
535 if (what_changed.contains (ARDOUR::Properties::hidden)) {
541 EditorRegions::selection_changed ()
543 if (ignore_region_list_selection_change) {
547 _editor->_region_selection_change_updates_region_list = false;
549 if (_display.get_selection()->count_selected_rows() > 0) {
552 TreeView::Selection::ListHandle_Path rows = _display.get_selection()->get_selected_rows ();
554 _editor->get_selection().clear_regions ();
556 for (TreeView::Selection::ListHandle_Path::iterator i = rows.begin(); i != rows.end(); ++i) {
558 if ((iter = _model->get_iter (*i))) {
560 boost::shared_ptr<Region> region = (*iter)[_columns.region];
562 // they could have clicked on a row that is just a placeholder, like "Hidden"
563 // although that is not allowed by our selection filter. check it anyway
564 // since we need a region ptr.
568 _change_connection.block (true);
569 _editor->set_selected_regionview_from_region_list (region, Selection::Add);
570 _change_connection.block (false);
576 _editor->get_selection().clear_regions ();
579 _editor->_region_selection_change_updates_region_list = true;
583 EditorRegions::set_selected (RegionSelection& regions)
585 for (RegionSelection::iterator i = regions.begin(); i != regions.end(); ++i) {
587 boost::shared_ptr<Region> r ((*i)->region());
589 RegionRowMap::iterator it;
591 it = region_row_map.find (r);
593 if (it != region_row_map.end()){
594 TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
595 _display.get_selection()->select(*j);
601 EditorRegions::redisplay ()
603 if (_no_redisplay || !_session) {
607 bool tree_expanded = false;
609 /* If the list was expanded prior to rebuilding, expand it again afterwards */
610 if (toggle_full_action()->get_active()) {
611 tree_expanded = true;
614 _display.set_model (Glib::RefPtr<Gtk::TreeStore>(0));
616 _model->set_sort_column (-2, SORT_ASCENDING); //Disable sorting to gain performance
619 region_row_map.clear();
620 parent_regions_sources_map.clear();
622 /* now add everything we have, via a temporary list used to help with sorting */
624 const RegionFactory::RegionMap& regions (RegionFactory::regions());
626 for (RegionFactory::RegionMap::const_iterator i = regions.begin(); i != regions.end(); ++i) {
628 if ( i->second->whole_file()) {
629 /* add automatic regions first so that children can find their parents as we add them */
630 add_region (i->second);
634 tmp_region_list.push_front (i->second);
637 for (list<boost::shared_ptr<Region> >::iterator r = tmp_region_list.begin(); r != tmp_region_list.end(); ++r) {
641 _model->set_sort_column (0, SORT_ASCENDING); // renabale sorting
642 _display.set_model (_model);
644 tmp_region_list.clear();
647 _display.expand_all();
652 EditorRegions::update_row (boost::shared_ptr<Region> region)
654 if (!region || !_session) {
658 RegionRowMap::iterator it;
660 it = region_row_map.find (region);
662 if (it != region_row_map.end()){
664 TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
665 populate_row(region, (*j));
670 EditorRegions::update_all_rows ()
676 RegionRowMap::iterator i;
678 for (i = region_row_map.begin(); i != region_row_map.end(); ++i) {
680 TreeModel::iterator j = _model->get_iter ((*i).second.get_path());
682 boost::shared_ptr<Region> region = (*j)[_columns.region];
684 if (!region->automatic()) {
685 populate_row(region, (*j));
691 EditorRegions::format_position (framepos_t pos, char* buf, size_t bufsize, bool onoff)
693 Timecode::BBT_Time bbt;
694 Timecode::Time timecode;
697 error << string_compose (_("EditorRegions::format_position: negative timecode position: %1"), pos) << endmsg;
698 snprintf (buf, bufsize, "invalid");
702 switch (ARDOUR_UI::instance()->secondary_clock->mode ()) {
703 case AudioClock::BBT:
704 _session->tempo_map().bbt_time (pos, bbt);
706 snprintf (buf, bufsize, "%03d|%02d|%04d" , bbt.bars, bbt.beats, bbt.ticks);
708 snprintf (buf, bufsize, "(%03d|%02d|%04d)" , bbt.bars, bbt.beats, bbt.ticks);
712 case AudioClock::MinSec:
719 hrs = (int) floor (left / (_session->frame_rate() * 60.0f * 60.0f));
720 left -= (framecnt_t) floor (hrs * _session->frame_rate() * 60.0f * 60.0f);
721 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
722 left -= (framecnt_t) floor (mins * _session->frame_rate() * 60.0f);
723 secs = left / (float) _session->frame_rate();
725 snprintf (buf, bufsize, "%02d:%02d:%06.3f", hrs, mins, secs);
727 snprintf (buf, bufsize, "(%02d:%02d:%06.3f)", hrs, mins, secs);
731 case AudioClock::Frames:
733 snprintf (buf, bufsize, "%" PRId64, pos);
735 snprintf (buf, bufsize, "(%" PRId64 ")", pos);
739 case AudioClock::Timecode:
741 _session->timecode_time (pos, timecode);
743 snprintf (buf, bufsize, "%02d:%02d:%02d:%02d", timecode.hours, timecode.minutes, timecode.seconds, timecode.frames);
745 snprintf (buf, bufsize, "(%02d:%02d:%02d:%02d)", timecode.hours, timecode.minutes, timecode.seconds, timecode.frames);
752 EditorRegions::populate_row (boost::shared_ptr<Region> region, TreeModel::Row const &row)
754 boost::shared_ptr<AudioRegion> audioregion = boost::dynamic_pointer_cast<AudioRegion>(region);
755 //uint32_t used = _session->playlists->region_use_count (region);
756 /* Presently a region is only used once so let's save on the sequential scan to determine use count */
759 populate_row_position (region, row, used);
760 populate_row_end (region, row, used);
761 populate_row_sync (region, row, used);
762 populate_row_fade_in (region, row, used, audioregion);
763 populate_row_fade_out (region, row, used, audioregion);
764 populate_row_locked (region, row, used);
765 populate_row_glued (region, row, used);
766 populate_row_muted (region, row, used);
767 populate_row_opaque (region, row, used);
768 populate_row_length (region, row);
769 populate_row_source (region, row);
770 populate_row_name (region, row);
771 populate_row_used (region, row, used);
775 if (audioRegion && fades_in_seconds) {
781 left = audioRegion->fade_in()->back()->when;
782 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
783 left -= (framepos_t) floor (mins * _session->frame_rate() * 60.0f);
784 millisecs = (int) floor ((left * 1000.0f) / _session->frame_rate());
786 if (audioRegion->fade_in()->back()->when >= _session->frame_rate()) {
787 sprintf (fadein_str, "%01dM %01dmS", mins, millisecs);
789 sprintf (fadein_str, "%01dmS", millisecs);
792 left = audioRegion->fade_out()->back()->when;
793 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
794 left -= (framepos_t) floor (mins * _session->frame_rate() * 60.0f);
795 millisecs = (int) floor ((left * 1000.0f) / _session->frame_rate());
797 if (audioRegion->fade_out()->back()->when >= _session->frame_rate()) {
798 sprintf (fadeout_str, "%01dM %01dmS", mins, millisecs);
800 sprintf (fadeout_str, "%01dmS", millisecs);
806 EditorRegions::populate_row_used (boost::shared_ptr<Region>, TreeModel::Row const& row, uint32_t used)
809 snprintf (buf, sizeof (buf), "%4d" , used);
810 row[_columns.used] = buf;
814 EditorRegions::populate_row_length (boost::shared_ptr<Region> region, TreeModel::Row const &row)
817 format_position (region->length(), buf, sizeof (buf));
818 row[_columns.length] = buf;
822 EditorRegions::populate_row_end (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
824 if (region->whole_file()) {
825 row[_columns.end] = "";
826 } else if (used > 1) {
827 row[_columns.end] = _("Mult.");
828 } else if (region->last_frame() >= region->first_frame()) {
830 format_position (region->last_frame(), buf, sizeof (buf));
831 row[_columns.end] = buf;
833 row[_columns.end] = "empty";
838 EditorRegions::populate_row_position (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
840 if (region->whole_file()) {
841 row[_columns.position] = "";
842 } else if (used > 1) {
843 row[_columns.position] = _("Mult.");
846 format_position (region->position(), buf, sizeof (buf));
847 row[_columns.position] = buf;
852 EditorRegions::populate_row_sync (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
854 if (region->whole_file()) {
855 row[_columns.sync] = "";
856 } else if (used > 1) {
857 row[_columns.sync] = _("Mult."); /* translators: a short phrase for "multiple" as in "many" */
859 if (region->sync_position() == region->position()) {
860 row[_columns.sync] = _("Start");
861 } else if (region->sync_position() == (region->last_frame())) {
862 row[_columns.sync] = _("End");
865 format_position (region->sync_position(), buf, sizeof (buf));
866 row[_columns.sync] = buf;
872 EditorRegions::populate_row_fade_in (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used, boost::shared_ptr<AudioRegion> audioregion)
874 if (!audioregion || region->whole_file()) {
875 row[_columns.fadein] = "";
878 row[_columns.fadein] = _("Multiple");
881 format_position (audioregion->fade_in()->back()->when, buf, sizeof (buf), audioregion->fade_in_active());
882 row[_columns.fadein] = buf;
888 EditorRegions::populate_row_fade_out (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used, boost::shared_ptr<AudioRegion> audioregion)
890 if (!audioregion || region->whole_file()) {
891 row[_columns.fadeout] = "";
894 row[_columns.fadeout] = _("Multiple");
897 format_position (audioregion->fade_out()->back()->when, buf, sizeof (buf), audioregion->fade_out_active());
898 row[_columns.fadeout] = buf;
904 EditorRegions::populate_row_locked (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
906 if (region->whole_file()) {
907 row[_columns.locked] = false;
908 } else if (used > 1) {
909 row[_columns.locked] = false;
911 row[_columns.locked] = region->locked();
916 EditorRegions::populate_row_glued (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
918 if (region->whole_file() || used > 1) {
919 row[_columns.glued] = false;
921 if (region->position_lock_style() == MusicTime) {
922 row[_columns.glued] = true;
924 row[_columns.glued] = false;
930 EditorRegions::populate_row_muted (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
932 if (region->whole_file() || used > 1) {
933 row[_columns.muted] = false;
935 row[_columns.muted] = region->muted();
940 EditorRegions::populate_row_opaque (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
942 if (region->whole_file() || used > 1) {
943 row[_columns.opaque] = false;
945 row[_columns.opaque] = region->opaque();
950 EditorRegions::populate_row_name (boost::shared_ptr<Region> region, TreeModel::Row const &row)
952 if (region->n_channels() > 1) {
953 row[_columns.name] = string_compose("%1 [%2]", Gtkmm2ext::markup_escape_text (region->name()), region->n_channels());
955 row[_columns.name] = Gtkmm2ext::markup_escape_text (region->name());
960 EditorRegions::populate_row_source (boost::shared_ptr<Region> region, TreeModel::Row const &row)
962 if (boost::dynamic_pointer_cast<SilentFileSource>(region->source())) {
963 row[_columns.path] = _("MISSING ") + Gtkmm2ext::markup_escape_text (region->source()->name());
965 row[_columns.path] = Gtkmm2ext::markup_escape_text (region->source()->name());
970 EditorRegions::toggle_show_auto_regions ()
972 _show_automatic_regions = toggle_show_auto_regions_action()->get_active();
977 EditorRegions::toggle_full ()
979 set_full (toggle_full_action()->get_active ());
983 EditorRegions::set_full (bool f)
986 _display.expand_all ();
989 _display.collapse_all ();
995 EditorRegions::show_context_menu (int button, int time)
998 _menu = dynamic_cast<Menu*> (ActionManager::get_widget ("/RegionListMenu"));
1001 if (_display.get_selection()->count_selected_rows() > 0) {
1002 ActionManager::set_sensitive (ActionManager::region_list_selection_sensitive_actions, true);
1004 ActionManager::set_sensitive (ActionManager::region_list_selection_sensitive_actions, false);
1007 /* Enable the "Show" option if any selected regions are hidden, and vice versa for "Hide" */
1009 bool have_shown = false;
1010 bool have_hidden = false;
1012 TreeView::Selection::ListHandle_Path rows = _display.get_selection()->get_selected_rows ();
1013 for (TreeView::Selection::ListHandle_Path::iterator i = rows.begin(); i != rows.end(); ++i) {
1014 TreeIter t = _model->get_iter (*i);
1015 boost::shared_ptr<Region> r = (*t)[_columns.region];
1025 hide_action()->set_sensitive (have_shown);
1026 show_action()->set_sensitive (have_hidden);
1028 _menu->popup (button, time);
1032 EditorRegions::key_press (GdkEventKey* ev)
1034 TreeViewColumn *col;
1036 switch (ev->keyval) {
1038 case GDK_ISO_Left_Tab:
1040 if (name_editable) {
1041 name_editable->editing_done ();
1045 col = _display.get_column (0); // select&focus on name column
1047 if (Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)) {
1048 treeview_select_previous (_display, _model, col);
1050 treeview_select_next (_display, _model, col);
1064 EditorRegions::button_press (GdkEventButton *ev)
1066 boost::shared_ptr<Region> region;
1068 TreeModel::Path path;
1069 TreeViewColumn* column;
1073 if (_display.get_path_at_pos ((int)ev->x, (int)ev->y, path, column, cellx, celly)) {
1074 if ((iter = _model->get_iter (path))) {
1075 region = (*iter)[_columns.region];
1079 if (Keyboard::is_context_menu_event (ev)) {
1080 show_context_menu (ev->button, ev->time);
1084 if (region != 0 && Keyboard::is_button2_event (ev)) {
1085 // start/stop audition
1086 if (!Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
1087 _editor->consider_auditioning (region);
1096 EditorRegions::sorter (TreeModel::iterator a, TreeModel::iterator b)
1100 boost::shared_ptr<Region> r1 = (*a)[_columns.region];
1101 boost::shared_ptr<Region> r2 = (*b)[_columns.region];
1103 /* handle rows without regions, like "Hidden" */
1113 boost::shared_ptr<AudioRegion> region1 = boost::dynamic_pointer_cast<AudioRegion> (r1);
1114 boost::shared_ptr<AudioRegion> region2 = boost::dynamic_pointer_cast<AudioRegion> (r2);
1116 if (region1 == 0 || region2 == 0) {
1119 switch (_sort_type) {
1121 s1 = (*a)[_columns.name];
1122 s2 = (*b)[_columns.name];
1123 return (s1.compare (s2));
1129 switch (_sort_type) {
1131 cmp = region1->name().compare(region2->name());
1135 cmp = region1->length() - region2->length();
1139 cmp = region1->position() - region2->position();
1143 cmp = region1->source()->timestamp() - region2->source()->timestamp();
1147 cmp = region1->start() - region2->start();
1151 // cerr << "Compare " << (region1->start() + region1->length()) << " and " << (region2->start() + region2->length()) << endl;
1152 cmp = (region1->start() + region1->length()) - (region2->start() + region2->length());
1155 case BySourceFileName:
1156 cmp = region1->source()->name().compare(region2->source()->name());
1159 case BySourceFileLength:
1160 cmp = region1->source_length(0) - region2->source_length(0);
1163 case BySourceFileCreationDate:
1164 cmp = region1->source()->timestamp() - region2->source()->timestamp();
1167 case BySourceFileFS:
1168 if (region1->source()->name() == region2->source()->name()) {
1169 cmp = region1->name().compare(region2->name());
1171 cmp = region1->source()->name().compare(region2->source()->name());
1176 // cerr << "Comparison on " << enum_2_string (_sort_type) << " gives " << cmp << endl;
1180 } else if (cmp > 0) {
1188 EditorRegions::reset_sort_type (RegionListSortType type, bool force)
1190 if (type != _sort_type || force) {
1192 _model->set_sort_func (0, (sigc::mem_fun (*this, &EditorRegions::sorter)));
1197 EditorRegions::reset_sort_direction (bool up)
1199 _model->set_sort_column (0, up ? SORT_ASCENDING : SORT_DESCENDING);
1203 EditorRegions::selection_mapover (sigc::slot<void,boost::shared_ptr<Region> > sl)
1205 Glib::RefPtr<TreeSelection> selection = _display.get_selection();
1206 TreeView::Selection::ListHandle_Path rows = selection->get_selected_rows ();
1207 TreeView::Selection::ListHandle_Path::iterator i = rows.begin();
1209 if (selection->count_selected_rows() == 0 || _session == 0) {
1213 for (; i != rows.end(); ++i) {
1216 if ((iter = _model->get_iter (*i))) {
1218 /* some rows don't have a region associated with them, but can still be
1219 selected (XXX maybe prevent them from being selected)
1222 boost::shared_ptr<Region> r = (*iter)[_columns.region];
1233 EditorRegions::drag_data_received (const RefPtr<Gdk::DragContext>& context,
1235 const SelectionData& data,
1236 guint info, guint time)
1238 vector<string> paths;
1240 if (data.get_target() == "GTK_TREE_MODEL_ROW") {
1241 /* something is being dragged over the region list */
1242 _editor->_drags->abort ();
1243 _display.on_drag_data_received (context, x, y, data, info, time);
1247 if (_editor->convert_drop_to_paths (paths, context, x, y, data, info, time) == 0) {
1249 bool copy = ((context->get_actions() & (Gdk::ACTION_COPY | Gdk::ACTION_LINK | Gdk::ACTION_MOVE)) == Gdk::ACTION_COPY);
1251 if (Profile->get_sae() || UIConfiguration::instance().get_only_copy_imported_files() || copy) {
1252 _editor->do_import (paths, Editing::ImportDistinctFiles, Editing::ImportAsRegion, SrcBest, pos);
1254 _editor->do_embed (paths, Editing::ImportDistinctFiles, ImportAsRegion, pos);
1256 context->drag_finish (true, false, time);
1261 EditorRegions::selection_filter (const RefPtr<TreeModel>& model, const TreeModel::Path& path, bool already_selected)
1263 /* not possible to select rows that do not represent regions, like "Hidden" */
1265 if (already_selected) {
1266 /* deselecting anything is OK with us */
1270 TreeModel::iterator iter = model->get_iter (path);
1273 boost::shared_ptr<Region> r =(*iter)[_columns.region];
1283 EditorRegions::name_editing_started (CellEditable* ce, const Glib::ustring&)
1287 /* give it a special name */
1289 Gtk::Entry *e = dynamic_cast<Gtk::Entry*> (ce);
1292 e->set_name (X_("RegionNameEditorEntry"));
1297 EditorRegions::name_edit (const std::string& path, const std::string& new_text)
1301 boost::shared_ptr<Region> region;
1304 if ((iter = _model->get_iter (path))) {
1305 region = (*iter)[_columns.region];
1306 (*iter)[_columns.name] = new_text;
1309 /* now mapover everything */
1312 vector<RegionView*> equivalents;
1313 _editor->get_regions_corresponding_to (region, equivalents, false);
1315 for (vector<RegionView*>::iterator i = equivalents.begin(); i != equivalents.end(); ++i) {
1316 if (new_text != (*i)->region()->name()) {
1317 (*i)->region()->set_name (new_text);
1324 /** @return Region that has been dragged out of the list, or 0 */
1325 boost::shared_ptr<Region>
1326 EditorRegions::get_dragged_region ()
1328 list<boost::shared_ptr<Region> > regions;
1330 _display.get_object_drag_data (regions, &source);
1332 if (regions.empty()) {
1333 return boost::shared_ptr<Region> ();
1336 assert (regions.size() == 1);
1337 return regions.front ();
1341 EditorRegions::clear ()
1343 _display.set_model (Glib::RefPtr<Gtk::TreeStore> (0));
1345 _display.set_model (_model);
1347 /* Clean up the maps */
1348 region_row_map.clear();
1349 parent_regions_sources_map.clear();
1352 boost::shared_ptr<Region>
1353 EditorRegions::get_single_selection ()
1355 Glib::RefPtr<TreeSelection> selected = _display.get_selection();
1357 if (selected->count_selected_rows() != 1) {
1358 return boost::shared_ptr<Region> ();
1361 TreeView::Selection::ListHandle_Path rows = selected->get_selected_rows ();
1363 /* only one row selected, so rows.begin() is it */
1365 TreeIter iter = _model->get_iter (*rows.begin());
1368 return boost::shared_ptr<Region> ();
1371 return (*iter)[_columns.region];
1375 EditorRegions::freeze_tree_model (){
1377 _display.set_model (Glib::RefPtr<Gtk::TreeStore>(0));
1378 _model->set_sort_column (-2, SORT_ASCENDING); //Disable sorting to gain performance
1383 EditorRegions::thaw_tree_model (){
1385 _model->set_sort_column (0, SORT_ASCENDING); // renabale sorting
1386 _display.set_model (_model);
1388 if (toggle_full_action()->get_active()) {
1389 _display.expand_all();
1394 EditorRegions::locked_changed (std::string const & path)
1396 TreeIter i = _model->get_iter (path);
1398 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1400 region->set_locked (!(*i)[_columns.locked]);
1406 EditorRegions::glued_changed (std::string const & path)
1408 TreeIter i = _model->get_iter (path);
1410 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1412 /* `glued' means MusicTime, and we're toggling here */
1413 region->set_position_lock_style ((*i)[_columns.glued] ? AudioTime : MusicTime);
1420 EditorRegions::muted_changed (std::string const & path)
1422 TreeIter i = _model->get_iter (path);
1424 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1426 region->set_muted (!(*i)[_columns.muted]);
1433 EditorRegions::opaque_changed (std::string const & path)
1435 TreeIter i = _model->get_iter (path);
1437 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1439 region->set_opaque (!(*i)[_columns.opaque]);
1446 EditorRegions::get_state () const
1448 XMLNode* node = new XMLNode (X_("RegionList"));
1450 node->add_property (X_("sort-type"), enum_2_string (_sort_type));
1452 RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), X_("SortAscending"));
1453 bool const ascending = RefPtr<RadioAction>::cast_dynamic(act)->get_active ();
1454 node->add_property (X_("sort-ascending"), ascending ? "yes" : "no");
1455 node->add_property (X_("show-all"), toggle_full_action()->get_active() ? "yes" : "no");
1456 node->add_property (X_("show-automatic-regions"), _show_automatic_regions ? "yes" : "no");
1462 EditorRegions::set_state (const XMLNode & node)
1464 bool changed = false;
1466 if (node.name() != X_("RegionList")) {
1470 XMLProperty const * p = node.property (X_("sort-type"));
1473 Editing::RegionListSortType const t = static_cast<Editing::RegionListSortType> (string_2_enum (p->value(), _sort_type));
1475 if (_sort_type != t) {
1479 reset_sort_type (t, true);
1480 RefPtr<RadioAction> ract = sort_type_action (t);
1481 ract->set_active ();
1484 p = node.property (X_("sort-ascending"));
1487 bool const yn = string_is_affirmative (p->value ());
1488 SortType old_sort_type;
1489 int old_sort_column;
1491 _model->get_sort_column_id (old_sort_column, old_sort_type);
1493 if (old_sort_type != (yn ? SORT_ASCENDING : SORT_DESCENDING)) {
1497 reset_sort_direction (yn);
1501 act = ActionManager::get_action (X_("RegionList"), X_("SortAscending"));
1503 act = ActionManager::get_action (X_("RegionList"), X_("SortDescending"));
1506 RefPtr<RadioAction>::cast_dynamic(act)->set_active ();
1509 p = node.property (X_("show-all"));
1511 bool const yn = string_is_affirmative (p->value ());
1513 if (expanded != yn) {
1518 toggle_full_action()->set_active (yn);
1521 p = node.property (X_("show-automatic-regions"));
1523 bool const yn = string_is_affirmative (p->value ());
1525 if (yn != _show_automatic_regions) {
1526 _show_automatic_regions = yn;
1527 toggle_show_auto_regions_action()->set_active (yn);
1538 EditorRegions::sort_type_action (Editing::RegionListSortType t) const
1540 const char* action = 0;
1543 case Editing::ByName:
1544 action = X_("SortByRegionName");
1546 case Editing::ByLength:
1547 action = X_("SortByRegionLength");
1549 case Editing::ByPosition:
1550 action = X_("SortByRegionPosition");
1552 case Editing::ByTimestamp:
1553 action = X_("SortByRegionTimestamp");
1555 case Editing::ByStartInFile:
1556 action = X_("SortByRegionStartinFile");
1558 case Editing::ByEndInFile:
1559 action = X_("SortByRegionEndinFile");
1561 case Editing::BySourceFileName:
1562 action = X_("SortBySourceFileName");
1564 case Editing::BySourceFileLength:
1565 action = X_("SortBySourceFileLength");
1567 case Editing::BySourceFileCreationDate:
1568 action = X_("SortBySourceFileCreationDate");
1570 case Editing::BySourceFileFS:
1571 action = X_("SortBySourceFilesystem");
1574 fatal << string_compose (_("programming error: %1: %2"), "EditorRegions: impossible sort type", (int) t) << endmsg;
1575 abort(); /*NOTREACHED*/
1578 RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), action);
1581 return RefPtr<RadioAction>::cast_dynamic (act);
1585 EditorRegions::hide_action () const
1587 return ActionManager::get_action (X_("RegionList"), X_("rlHide"));
1592 EditorRegions::show_action () const
1594 return ActionManager::get_action (X_("RegionList"), X_("rlShow"));
1598 EditorRegions::remove_unused_regions_action () const
1600 return ActionManager::get_action (X_("RegionList"), X_("removeUnusedRegions"));
1603 RefPtr<ToggleAction>
1604 EditorRegions::toggle_full_action () const
1606 Glib::RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), X_("rlShowAll"));
1608 return Glib::RefPtr<ToggleAction>::cast_dynamic (act);
1611 RefPtr<ToggleAction>
1612 EditorRegions::toggle_show_auto_regions_action () const
1614 Glib::RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), X_("rlShowAuto"));
1616 return Glib::RefPtr<ToggleAction>::cast_dynamic (act);