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/region_factory.h"
32 #include "ardour/session.h"
33 #include "ardour/session_playlists.h"
34 #include "ardour/silentfilesource.h"
35 #include "ardour/profile.h"
37 #include "gtkmm2ext/choice.h"
38 #include "gtkmm2ext/treeutils.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"
55 using namespace ARDOUR;
59 using namespace Editing;
60 using Gtkmm2ext::Keyboard;
68 EditorRegions::EditorRegions (Editor* e)
73 , _show_automatic_regions (true)
74 , ignore_region_list_selection_change (false)
75 , ignore_selected_region_change (false)
76 , _no_redisplay (false)
77 , _sort_type ((Editing::RegionListSortType) 0)
80 _display.set_size_request (100, -1);
81 _display.set_name ("RegionListDisplay");
82 _display.set_rules_hint (true);
84 /* Try to prevent single mouse presses from initiating edits.
85 This relies on a hack in gtktreeview.c:gtk_treeview_button_press()
87 _display.set_data ("mouse-edits-require-mod1", (gpointer) 0x1);
89 _model = TreeStore::create (_columns);
90 _model->set_sort_func (0, sigc::mem_fun (*this, &EditorRegions::sorter));
91 _model->set_sort_column (0, SORT_ASCENDING);
93 _display.set_model (_model);
95 _display.append_column ("", _columns.name);
96 _display.append_column ("", _columns.position);
97 _display.append_column ("", _columns.end);
98 _display.append_column ("", _columns.length);
99 _display.append_column ("", _columns.sync);
100 _display.append_column ("", _columns.fadein);
101 _display.append_column ("", _columns.fadeout);
102 _display.append_column ("", _columns.locked);
103 _display.append_column ("", _columns.glued);
104 _display.append_column ("", _columns.muted);
105 _display.append_column ("", _columns.opaque);
111 { 0, _("Region"), _("Region name, with number of channels in []'s") },
112 { 1, _("Position"), _("Length of the region") },
113 { 2, _("End"), _("Length of the region") },
114 { 3, _("End"), _("Length of the region") },
115 { 4, _("Sync"), _("Position of region sync point, relative to start of the region") },
116 { 5, _("Sync"), _("Region fade-in enabled?") },
117 { 6, _("Fade In"), _("Region fade-out enabled?") },
118 { 7, _("L"), _("Region position locked?") },
119 { 8, _("G"), _("Region position glued to Bars|Beats time?") },
120 { 9, _("M"), _("Region muted?") },
121 { 10, _("O"), _("Region opaque (blocks regions below it from being heard)?") },
125 for (int i = 0; ci[i].index >= 0; ++i) {
126 col = _display.get_column (ci[i].index);
127 l = manage (new Label (ci[i].label));
128 ARDOUR_UI::instance()->set_tip (*l, ci[i].tooltip);
129 col->set_widget (*l);
133 _display.set_headers_visible (true);
134 //_display.set_grid_lines (TREE_VIEW_GRID_LINES_BOTH);
136 /* show path as the row tooltip */
137 _display.set_tooltip_column (14); /* path */
139 CellRendererText* region_name_cell = dynamic_cast<CellRendererText*>(_display.get_column_cell_renderer (0));
140 region_name_cell->property_editable() = true;
141 region_name_cell->signal_edited().connect (sigc::mem_fun (*this, &EditorRegions::name_edit));
142 region_name_cell->signal_editing_started().connect (sigc::mem_fun (*this, &EditorRegions::name_editing_started));
144 _display.get_selection()->set_select_function (sigc::mem_fun (*this, &EditorRegions::selection_filter));
146 TreeViewColumn* tv_col = _display.get_column(0);
147 tv_col->set_resizable (true);
148 CellRendererText* renderer = dynamic_cast<CellRendererText*>(_display.get_column_cell_renderer (0));
149 tv_col->add_attribute(renderer->property_text(), _columns.name);
150 tv_col->add_attribute(renderer->property_foreground_gdk(), _columns.color_);
152 CellRendererToggle* locked_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (7));
153 locked_cell->property_activatable() = true;
154 locked_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::locked_changed));
156 TreeViewColumn* locked_col = _display.get_column (7);
157 locked_col->add_attribute (locked_cell->property_visible(), _columns.property_toggles_visible);
159 CellRendererToggle* glued_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (8));
160 glued_cell->property_activatable() = true;
161 glued_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::glued_changed));
163 TreeViewColumn* glued_col = _display.get_column (8);
164 glued_col->add_attribute (glued_cell->property_visible(), _columns.property_toggles_visible);
166 CellRendererToggle* muted_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (9));
167 muted_cell->property_activatable() = true;
168 muted_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::muted_changed));
170 TreeViewColumn* muted_col = _display.get_column (9);
171 muted_col->add_attribute (muted_cell->property_visible(), _columns.property_toggles_visible);
173 CellRendererToggle* opaque_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (10));
174 opaque_cell->property_activatable() = true;
175 opaque_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::opaque_changed));
177 TreeViewColumn* opaque_col = _display.get_column (10);
178 opaque_col->add_attribute (opaque_cell->property_visible(), _columns.property_toggles_visible);
180 _display.get_selection()->set_mode (SELECTION_MULTIPLE);
181 _display.add_object_drag (_columns.region.index(), "regions");
184 /* only the first column (Region name) is resizable */
186 for (int i = 1; ; ++i) {
187 TreeViewColumn* col = _display.get_column (i);
191 col->set_resizable (false);
194 /* setup DnD handling */
196 list<TargetEntry> region_list_target_table;
198 region_list_target_table.push_back (TargetEntry ("text/plain"));
199 region_list_target_table.push_back (TargetEntry ("text/uri-list"));
200 region_list_target_table.push_back (TargetEntry ("application/x-rootwin-drop"));
202 _display.add_drop_targets (region_list_target_table);
203 _display.signal_drag_data_received().connect (sigc::mem_fun(*this, &EditorRegions::drag_data_received));
205 _scroller.add (_display);
206 _scroller.set_policy (POLICY_AUTOMATIC, POLICY_AUTOMATIC);
208 _display.signal_button_press_event().connect (sigc::mem_fun(*this, &EditorRegions::button_press), false);
209 _change_connection = _display.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &EditorRegions::selection_changed));
211 _scroller.signal_key_press_event().connect (sigc::mem_fun(*this, &EditorRegions::key_press), false);
212 _scroller.signal_focus_in_event().connect (sigc::mem_fun (*this, &EditorRegions::focus_in), false);
213 _scroller.signal_focus_out_event().connect (sigc::mem_fun (*this, &EditorRegions::focus_out));
215 _display.signal_enter_notify_event().connect (sigc::mem_fun (*this, &EditorRegions::enter_notify), false);
216 _display.signal_leave_notify_event().connect (sigc::mem_fun (*this, &EditorRegions::leave_notify), false);
218 // _display.signal_popup_menu().connect (sigc::bind (sigc::mem_fun (*this, &Editor::show__display_context_menu), 1, 0));
220 //ARDOUR_UI::instance()->secondary_clock.mode_changed.connect (sigc::mem_fun(*this, &Editor::redisplay_regions));
221 ARDOUR_UI::instance()->secondary_clock->mode_changed.connect (sigc::mem_fun(*this, &EditorRegions::update_all_rows));
222 ARDOUR::Region::RegionPropertyChanged.connect (region_property_connection, MISSING_INVALIDATOR, ui_bind (&EditorRegions::region_changed, this, _1, _2), gui_context());
223 ARDOUR::RegionFactory::CheckNewRegion.connect (check_new_region_connection, MISSING_INVALIDATOR, ui_bind (&EditorRegions::add_region, this, _1), gui_context());
225 e->EditorFreeze.connect (editor_freeze_connection, MISSING_INVALIDATOR, ui_bind (&EditorRegions::freeze_tree_model, this), gui_context());
226 e->EditorThaw.connect (editor_thaw_connection, MISSING_INVALIDATOR, ui_bind (&EditorRegions::thaw_tree_model, this), gui_context());
230 EditorRegions::focus_in (GdkEventFocus*)
232 Window* win = dynamic_cast<Window*> (_scroller.get_toplevel ());
235 old_focus = win->get_focus ();
242 /* try to do nothing on focus in (doesn't work, hence selection_count nonsense) */
247 EditorRegions::focus_out (GdkEventFocus*)
250 old_focus->grab_focus ();
260 EditorRegions::enter_notify (GdkEventCrossing*)
266 /* arm counter so that ::selection_filter() will deny selecting anything for the
267 next two attempts to change selection status.
269 _scroller.grab_focus ();
270 Keyboard::magic_widget_grab_focus ();
275 EditorRegions::leave_notify (GdkEventCrossing*)
278 old_focus->grab_focus ();
282 Keyboard::magic_widget_drop_focus ();
287 EditorRegions::set_session (ARDOUR::Session* s)
289 SessionHandlePtr::set_session (s);
294 EditorRegions::add_region (boost::shared_ptr<Region> region)
296 if (!region || !_session) {
303 bool missing_source = boost::dynamic_pointer_cast<SilentFileSource>(region->source());
305 if (!_show_automatic_regions && region->automatic()) {
309 if (region->hidden()) {
311 TreeModel::iterator iter = _model->get_iter ("0");
312 TreeModel::Row parent;
313 TreeModel::Row child;
316 parent = *(_model->append());
317 parent[_columns.name] = _("Hidden");
318 boost::shared_ptr<Region> proxy = parent[_columns.region];
321 string s = (*iter)[_columns.name];
322 if (s != _("Hidden")) {
323 parent = *(_model->insert(iter));
324 parent[_columns.name] = _("Hidden");
325 boost::shared_ptr<Region> proxy = parent[_columns.region];
332 row = *(_model->append (parent.children()));
334 } else if (region->whole_file()) {
336 TreeModel::iterator i;
337 TreeModel::Children rows = _model->children();
339 for (i = rows.begin(); i != rows.end(); ++i) {
340 boost::shared_ptr<Region> rr = (*i)[_columns.region];
342 if (rr && region->region_list_equivalent (rr)) {
347 row = *(_model->append());
349 if (missing_source) {
350 c.set_rgb(65535,0,0); // FIXME: error color from style
352 } else if (region->automatic()){
353 c.set_rgb(0,65535,0); // FIXME: error color from style
356 set_color(c, rgba_from_style ("RegionListWholeFile", 0xff, 0, 0, 0, "fg", Gtk::STATE_NORMAL, false ));
360 row[_columns.color_] = c;
362 if (region->source()->name()[0] == '/') { // external file
364 if (region->whole_file()) {
366 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(region->source());
370 str = region_name_from_path (afs->path(), region->n_channels() > 1);
372 str += region->source()->name();
376 str = region->name();
380 str = region->name();
383 if (region->n_channels() > 1) {
384 std::stringstream foo;
385 foo << region->n_channels ();
391 row[_columns.name] = str;
392 row[_columns.region] = region;
393 row[_columns.property_toggles_visible] = false;
395 if (missing_source) {
396 row[_columns.path] = _("(MISSING) ") + region->source()->name();
399 boost::shared_ptr<FileSource> fs = boost::dynamic_pointer_cast<FileSource>(region->source());
401 row[_columns.path] = fs->path();
403 row[_columns.path] = region->source()->name();
407 region_row_map.insert(pair<boost::shared_ptr<ARDOUR::Region>, Gtk::TreeModel::RowReference>(region, TreeRowReference(_model, TreePath (row))) );
408 parent_regions_sources_map.insert(pair<string, Gtk::TreeModel::RowReference>(region->source_string(), TreeRowReference(_model, TreePath (row))) );
413 // find parent node, add as new child
414 TreeModel::iterator i;
416 boost::unordered_map<string, Gtk::TreeModel::RowReference>::iterator it;
418 it = parent_regions_sources_map.find (region->source_string());
420 if (it != parent_regions_sources_map.end()){
422 TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
424 TreeModel::iterator ii;
425 TreeModel::Children subrows = (*j).children();
427 /* XXXX: should we be accounting for all regions? */
429 for (ii = subrows.begin(); ii != subrows.end(); ++ii) {
430 boost::shared_ptr<Region> rr = (*ii)[_columns.region];
432 if (region->region_list_equivalent (rr)) {
438 row = *(_model->insert (subrows.end()));
441 row = *(_model->append());
444 row[_columns.property_toggles_visible] = true;
447 row[_columns.region] = region;
449 region_row_map.insert(pair<boost::shared_ptr<ARDOUR::Region>, Gtk::TreeModel::RowReference>(region, TreeRowReference(_model, TreePath (row))) );
451 populate_row(region, (*row));
455 EditorRegions::remove_unused_regions ()
457 vector<string> choices;
464 prompt = _("Do you really want to remove unused regions?"
465 "\n(This is destructive and cannot be undone)");
467 choices.push_back (_("No, do nothing."));
468 choices.push_back (_("Yes, remove."));
470 Gtkmm2ext::Choice prompter (_("Remove unused regions"), prompt, choices);
472 if (prompter.run () == 1) {
473 _no_redisplay = true;
474 _session->cleanup_regions ();
475 _no_redisplay = false;
481 EditorRegions::region_changed (boost::shared_ptr<Region> r, const PropertyChange& what_changed)
483 PropertyChange our_interests;
485 our_interests.add (ARDOUR::Properties::name);
486 our_interests.add (ARDOUR::Properties::position);
487 our_interests.add (ARDOUR::Properties::length);
488 our_interests.add (ARDOUR::Properties::start);
489 our_interests.add (ARDOUR::Properties::locked);
490 our_interests.add (ARDOUR::Properties::position_lock_style);
491 our_interests.add (ARDOUR::Properties::muted);
492 our_interests.add (ARDOUR::Properties::opaque);
493 our_interests.add (ARDOUR::Properties::fade_in);
494 our_interests.add (ARDOUR::Properties::fade_out);
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)) {
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 if (region->automatic()) {
569 _display.get_selection()->unselect(*i);
572 _change_connection.block (true);
573 _editor->set_selected_regionview_from_region_list (region, Selection::Add);
575 _change_connection.block (false);
581 _editor->get_selection().clear_regions ();
584 _editor->_region_selection_change_updates_region_list = true;
588 EditorRegions::set_selected (RegionSelection& regions)
590 for (RegionSelection::iterator i = regions.begin(); i != regions.end(); ++i) {
592 boost::shared_ptr<Region> r ((*i)->region());
594 RegionRowMap::iterator it;
596 it = region_row_map.find (r);
598 if (it != region_row_map.end()){
599 TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
600 _display.get_selection()->select(*j);
606 EditorRegions::redisplay ()
608 if (_no_redisplay || !_session) {
612 bool tree_expanded = false;
614 /* If the list was expanded prior to rebuilding, expand it again afterwards */
615 if (toggle_full_action()->get_active()) {
616 tree_expanded = true;
619 _display.set_model (Glib::RefPtr<Gtk::TreeStore>(0));
621 _model->set_sort_column (-2, SORT_ASCENDING); //Disable sorting to gain performance
624 region_row_map.clear();
625 parent_regions_sources_map.clear();
627 /* now add everything we have, via a temporary list used to help with sorting */
629 const RegionFactory::RegionMap& regions (RegionFactory::regions());
631 for (RegionFactory::RegionMap::const_iterator i = regions.begin(); i != regions.end(); ++i) {
633 if ( i->second->whole_file()) {
634 /* add automatic regions first so that children can find their parents as we add them */
635 add_region (i->second);
639 tmp_region_list.push_front (i->second);
642 for (list<boost::shared_ptr<Region> >::iterator r = tmp_region_list.begin(); r != tmp_region_list.end(); ++r) {
646 _model->set_sort_column (0, SORT_ASCENDING); // renabale sorting
647 _display.set_model (_model);
649 tmp_region_list.clear();
652 _display.expand_all();
657 EditorRegions::update_row (boost::shared_ptr<Region> region)
659 if (!region || !_session) {
663 RegionRowMap::iterator it;
665 it = region_row_map.find (region);
667 if (it != region_row_map.end()){
669 TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
670 populate_row(region, (*j));
675 EditorRegions::update_all_rows ()
681 RegionRowMap::iterator i;
683 for (i = region_row_map.begin(); i != region_row_map.end(); ++i) {
685 TreeModel::iterator j = _model->get_iter ((*i).second.get_path());
687 boost::shared_ptr<Region> region = (*j)[_columns.region];
689 if (!region->automatic()) {
690 populate_row(region, (*j));
696 EditorRegions::format_position (framepos_t pos, char* buf, size_t bufsize)
698 Timecode::BBT_Time bbt;
699 Timecode::Time timecode;
701 switch (ARDOUR_UI::instance()->secondary_clock->mode ()) {
702 case AudioClock::BBT:
703 _session->tempo_map().bbt_time (pos, bbt);
704 snprintf (buf, bufsize, "%03d|%02d|%04d" , bbt.bars, bbt.beats, bbt.ticks);
707 case AudioClock::MinSec:
714 hrs = (int) floor (left / (_session->frame_rate() * 60.0f * 60.0f));
715 left -= (framecnt_t) floor (hrs * _session->frame_rate() * 60.0f * 60.0f);
716 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
717 left -= (framecnt_t) floor (mins * _session->frame_rate() * 60.0f);
718 secs = left / (float) _session->frame_rate();
719 snprintf (buf, bufsize, "%02d:%02d:%06.3f", hrs, mins, secs);
722 case AudioClock::Frames:
723 snprintf (buf, bufsize, "%" PRId64, pos);
726 case AudioClock::Timecode:
728 _session->timecode_time (pos, timecode);
729 snprintf (buf, bufsize, "%02d:%02d:%02d:%02d", timecode.hours, timecode.minutes, timecode.seconds, timecode.frames);
735 EditorRegions::populate_row (boost::shared_ptr<Region> region, TreeModel::Row const &row)
737 boost::shared_ptr<AudioRegion> audioregion = boost::dynamic_pointer_cast<AudioRegion>(region);
738 //uint32_t used = _session->playlists->region_use_count (region);
739 /* Presently a region is only used once so let's save on the sequential scan to determine use count */
742 populate_row_position (region, row, used);
743 populate_row_end (region, row, used);
744 populate_row_sync (region, row, used);
745 populate_row_fade_in (region, row, used, audioregion);
746 populate_row_fade_out (region, row, used, audioregion);
747 populate_row_locked (region, row, used);
748 populate_row_glued (region, row, used);
749 populate_row_muted (region, row, used);
750 populate_row_opaque (region, row, used);
751 populate_row_length (region, row);
752 populate_row_source (region, row);
753 populate_row_name (region, row);
754 populate_row_used (region, row, used);
758 if (audioRegion && fades_in_seconds) {
764 left = audioRegion->fade_in()->back()->when;
765 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
766 left -= (framepos_t) floor (mins * _session->frame_rate() * 60.0f);
767 millisecs = (int) floor ((left * 1000.0f) / _session->frame_rate());
769 if (audioRegion->fade_in()->back()->when >= _session->frame_rate()) {
770 sprintf (fadein_str, "%01dM %01dmS", mins, millisecs);
772 sprintf (fadein_str, "%01dmS", millisecs);
775 left = audioRegion->fade_out()->back()->when;
776 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
777 left -= (framepos_t) floor (mins * _session->frame_rate() * 60.0f);
778 millisecs = (int) floor ((left * 1000.0f) / _session->frame_rate());
780 if (audioRegion->fade_out()->back()->when >= _session->frame_rate()) {
781 sprintf (fadeout_str, "%01dM %01dmS", mins, millisecs);
783 sprintf (fadeout_str, "%01dmS", millisecs);
789 EditorRegions::populate_row_used (boost::shared_ptr<Region>, TreeModel::Row const& row, uint32_t used)
792 snprintf (buf, sizeof (buf), "%4d" , used);
793 row[_columns.used] = buf;
797 EditorRegions::populate_row_length (boost::shared_ptr<Region> region, TreeModel::Row const &row)
800 format_position (region->length(), buf, sizeof (buf));
801 row[_columns.length] = buf;
805 EditorRegions::populate_row_end (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
807 if (region->whole_file()) {
808 row[_columns.end] = "";
809 } else if (used > 1) {
810 row[_columns.end] = _("Mult.");
813 format_position (region->last_frame(), buf, sizeof (buf));
814 row[_columns.end] = buf;
819 EditorRegions::populate_row_position (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
821 if (region->whole_file()) {
822 row[_columns.position] = "";
823 } else if (used > 1) {
824 row[_columns.position] = _("Mult.");
827 format_position (region->position(), buf, sizeof (buf));
828 row[_columns.position] = buf;
833 EditorRegions::populate_row_sync (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
835 if (region->whole_file()) {
836 row[_columns.sync] = "";
837 } else if (used > 1) {
838 row[_columns.sync] = _("Mult."); /* translators: a short phrase for "multiple" as in "many" */
840 if (region->sync_position() == region->position()) {
841 row[_columns.sync] = _("Start");
842 } else if (region->sync_position() == (region->last_frame())) {
843 row[_columns.sync] = _("End");
846 format_position (region->sync_position(), buf, sizeof (buf));
847 row[_columns.sync] = buf;
853 EditorRegions::populate_row_fade_in (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used, boost::shared_ptr<AudioRegion> audioregion)
855 if (!audioregion || region->whole_file()) {
856 row[_columns.fadein] = "";
859 row[_columns.fadein] = _("Multiple");
863 format_position (audioregion->fade_in()->back()->when, buf, sizeof (buf));
864 row[_columns.fadein] = buf;
866 if (audioregion->fade_in_active()) {
867 row[_columns.fadein] = string_compose("%1%2%3", " ", buf, " ");
869 row[_columns.fadein] = string_compose("%1%2%3", "(", buf, ")");
876 EditorRegions::populate_row_fade_out (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used, boost::shared_ptr<AudioRegion> audioregion)
878 if (!audioregion || region->whole_file()) {
879 row[_columns.fadeout] = "";
882 row[_columns.fadeout] = _("Multiple");
885 format_position (audioregion->fade_out()->back()->when, buf, sizeof (buf));
887 if (audioregion->fade_out_active()) {
888 row[_columns.fadeout] = string_compose("%1%2%3", " ", buf, " ");
890 row[_columns.fadeout] = string_compose("%1%2%3", "(", buf, ")");
897 EditorRegions::populate_row_locked (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
899 if (region->whole_file()) {
900 row[_columns.locked] = false;
901 } else if (used > 1) {
902 row[_columns.locked] = false;
904 row[_columns.locked] = region->locked();
909 EditorRegions::populate_row_glued (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
911 if (region->whole_file() || used > 1) {
912 row[_columns.glued] = false;
914 if (region->position_lock_style() == MusicTime) {
915 row[_columns.glued] = true;
917 row[_columns.glued] = false;
923 EditorRegions::populate_row_muted (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
925 if (region->whole_file() || used > 1) {
926 row[_columns.muted] = false;
928 row[_columns.muted] = region->muted();
933 EditorRegions::populate_row_opaque (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
935 if (region->whole_file() || used > 1) {
936 row[_columns.opaque] = false;
938 row[_columns.opaque] = region->opaque();
943 EditorRegions::populate_row_name (boost::shared_ptr<Region> region, TreeModel::Row const &row)
945 if (region->n_channels() > 1) {
946 row[_columns.name] = string_compose("%1 [%2]", region->name(), region->n_channels());
948 row[_columns.name] = region->name();
953 EditorRegions::populate_row_source (boost::shared_ptr<Region> region, TreeModel::Row const &row)
955 if (boost::dynamic_pointer_cast<SilentFileSource>(region->source())) {
956 row[_columns.path] = _("MISSING ") + region->source()->name();
958 row[_columns.path] = region->source()->name();
963 EditorRegions::toggle_show_auto_regions ()
965 _show_automatic_regions = toggle_show_auto_regions_action()->get_active();
970 EditorRegions::toggle_full ()
972 set_full (toggle_full_action()->get_active ());
976 EditorRegions::set_full (bool f)
979 _display.expand_all ();
982 _display.collapse_all ();
988 EditorRegions::show_context_menu (int button, int time)
991 _menu = dynamic_cast<Menu*> (ActionManager::get_widget ("/RegionListMenu"));
994 if (_display.get_selection()->count_selected_rows() > 0) {
995 ActionManager::set_sensitive (ActionManager::region_list_selection_sensitive_actions, true);
997 ActionManager::set_sensitive (ActionManager::region_list_selection_sensitive_actions, false);
1000 /* Enable the "Show" option if any selected regions are hidden, and vice versa for "Hide" */
1002 bool have_shown = false;
1003 bool have_hidden = false;
1005 TreeView::Selection::ListHandle_Path rows = _display.get_selection()->get_selected_rows ();
1006 for (TreeView::Selection::ListHandle_Path::iterator i = rows.begin(); i != rows.end(); ++i) {
1007 TreeIter t = _model->get_iter (*i);
1008 boost::shared_ptr<Region> r = (*t)[_columns.region];
1018 hide_action()->set_sensitive (have_shown);
1019 show_action()->set_sensitive (have_hidden);
1021 _menu->popup (button, time);
1025 EditorRegions::key_press (GdkEventKey* ev)
1027 TreeViewColumn *col;
1029 switch (ev->keyval) {
1031 case GDK_ISO_Left_Tab:
1033 if (name_editable) {
1034 name_editable->editing_done ();
1038 col = _display.get_column (0); // select&focus on name column
1040 if (Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)) {
1041 treeview_select_previous (_display, _model, col);
1043 treeview_select_next (_display, _model, col);
1057 EditorRegions::button_press (GdkEventButton *ev)
1059 boost::shared_ptr<Region> region;
1061 TreeModel::Path path;
1062 TreeViewColumn* column;
1066 if (_display.get_path_at_pos ((int)ev->x, (int)ev->y, path, column, cellx, celly)) {
1067 if ((iter = _model->get_iter (path))) {
1068 region = (*iter)[_columns.region];
1072 if (Keyboard::is_context_menu_event (ev)) {
1073 show_context_menu (ev->button, ev->time);
1077 if (region != 0 && Keyboard::is_button2_event (ev)) {
1078 // start/stop audition
1079 if (!Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
1080 _editor->consider_auditioning (region);
1089 EditorRegions::sorter (TreeModel::iterator a, TreeModel::iterator b)
1093 boost::shared_ptr<Region> r1 = (*a)[_columns.region];
1094 boost::shared_ptr<Region> r2 = (*b)[_columns.region];
1096 /* handle rows without regions, like "Hidden" */
1106 boost::shared_ptr<AudioRegion> region1 = boost::dynamic_pointer_cast<AudioRegion> (r1);
1107 boost::shared_ptr<AudioRegion> region2 = boost::dynamic_pointer_cast<AudioRegion> (r2);
1109 if (region1 == 0 || region2 == 0) {
1112 switch (_sort_type) {
1114 s1 = (*a)[_columns.name];
1115 s2 = (*b)[_columns.name];
1116 return (s1.compare (s2));
1122 switch (_sort_type) {
1124 cmp = strcasecmp (region1->name().c_str(), region2->name().c_str());
1128 cmp = region1->length() - region2->length();
1132 cmp = region1->position() - region2->position();
1136 cmp = region1->source()->timestamp() - region2->source()->timestamp();
1140 cmp = region1->start() - region2->start();
1144 // cerr << "Compare " << (region1->start() + region1->length()) << " and " << (region2->start() + region2->length()) << endl;
1145 cmp = (region1->start() + region1->length()) - (region2->start() + region2->length());
1148 case BySourceFileName:
1149 cmp = strcasecmp (region1->source()->name().c_str(), region2->source()->name().c_str());
1152 case BySourceFileLength:
1153 cmp = region1->source_length(0) - region2->source_length(0);
1156 case BySourceFileCreationDate:
1157 cmp = region1->source()->timestamp() - region2->source()->timestamp();
1160 case BySourceFileFS:
1161 if (region1->source()->name() == region2->source()->name()) {
1162 cmp = strcasecmp (region1->name().c_str(), region2->name().c_str());
1164 cmp = strcasecmp (region1->source()->name().c_str(), region2->source()->name().c_str());
1169 // cerr << "Comparison on " << enum_2_string (_sort_type) << " gives " << cmp << endl;
1173 } else if (cmp > 0) {
1181 EditorRegions::reset_sort_type (RegionListSortType type, bool force)
1183 if (type != _sort_type || force) {
1185 _model->set_sort_func (0, (sigc::mem_fun (*this, &EditorRegions::sorter)));
1190 EditorRegions::reset_sort_direction (bool up)
1192 _model->set_sort_column (0, up ? SORT_ASCENDING : SORT_DESCENDING);
1196 EditorRegions::selection_mapover (sigc::slot<void,boost::shared_ptr<Region> > sl)
1198 Glib::RefPtr<TreeSelection> selection = _display.get_selection();
1199 TreeView::Selection::ListHandle_Path rows = selection->get_selected_rows ();
1200 TreeView::Selection::ListHandle_Path::iterator i = rows.begin();
1202 if (selection->count_selected_rows() == 0 || _session == 0) {
1206 for (; i != rows.end(); ++i) {
1209 if ((iter = _model->get_iter (*i))) {
1211 /* some rows don't have a region associated with them, but can still be
1212 selected (XXX maybe prevent them from being selected)
1215 boost::shared_ptr<Region> r = (*iter)[_columns.region];
1226 EditorRegions::drag_data_received (const RefPtr<Gdk::DragContext>& context,
1228 const SelectionData& data,
1229 guint info, guint time)
1231 vector<string> paths;
1233 if (data.get_target() == "GTK_TREE_MODEL_ROW") {
1234 /* something is being dragged over the region list */
1235 _editor->_drags->abort ();
1236 _display.on_drag_data_received (context, x, y, data, info, time);
1240 if (_editor->convert_drop_to_paths (paths, context, x, y, data, info, time) == 0) {
1242 if (Profile->get_sae() || Config->get_only_copy_imported_files()) {
1243 _editor->do_import (paths, Editing::ImportDistinctFiles, Editing::ImportAsRegion, SrcBest, pos);
1245 _editor->do_embed (paths, Editing::ImportDistinctFiles, ImportAsRegion, pos);
1247 context->drag_finish (true, false, time);
1252 EditorRegions::selection_filter (const RefPtr<TreeModel>& model, const TreeModel::Path& path, bool already_selected)
1254 /* not possible to select rows that do not represent regions, like "Hidden" */
1256 if (already_selected) {
1257 /* deselecting anything is OK with us */
1261 TreeModel::iterator iter = model->get_iter (path);
1264 boost::shared_ptr<Region> r =(*iter)[_columns.region];
1274 EditorRegions::name_editing_started (CellEditable* ce, const Glib::ustring&)
1278 /* give it a special name */
1280 Gtk::Entry *e = dynamic_cast<Gtk::Entry*> (ce);
1283 e->set_name (X_("RegionNameEditorEntry"));
1288 EditorRegions::name_edit (const std::string& path, const std::string& new_text)
1292 boost::shared_ptr<Region> region;
1295 if ((iter = _model->get_iter (path))) {
1296 region = (*iter)[_columns.region];
1297 (*iter)[_columns.name] = new_text;
1300 /* now mapover everything */
1303 vector<RegionView*> equivalents;
1304 _editor->get_regions_corresponding_to (region, equivalents);
1306 for (vector<RegionView*>::iterator i = equivalents.begin(); i != equivalents.end(); ++i) {
1307 if (new_text != (*i)->region()->name()) {
1308 (*i)->region()->set_name (new_text);
1315 /** @return Region that has been dragged out of the list, or 0 */
1316 boost::shared_ptr<Region>
1317 EditorRegions::get_dragged_region ()
1319 list<boost::shared_ptr<Region> > regions;
1321 _display.get_object_drag_data (regions, &source);
1323 if (regions.empty()) {
1324 return boost::shared_ptr<Region> ();
1327 assert (regions.size() == 1);
1328 return regions.front ();
1332 EditorRegions::clear ()
1334 _display.set_model (Glib::RefPtr<Gtk::TreeStore> (0));
1336 _display.set_model (_model);
1338 /* Clean up the maps */
1339 region_row_map.clear();
1340 parent_regions_sources_map.clear();
1343 boost::shared_ptr<Region>
1344 EditorRegions::get_single_selection ()
1346 Glib::RefPtr<TreeSelection> selected = _display.get_selection();
1348 if (selected->count_selected_rows() != 1) {
1349 return boost::shared_ptr<Region> ();
1352 TreeView::Selection::ListHandle_Path rows = selected->get_selected_rows ();
1354 /* only one row selected, so rows.begin() is it */
1356 TreeIter iter = _model->get_iter (*rows.begin());
1359 return boost::shared_ptr<Region> ();
1362 return (*iter)[_columns.region];
1366 EditorRegions::freeze_tree_model (){
1368 _display.set_model (Glib::RefPtr<Gtk::TreeStore>(0));
1369 _model->set_sort_column (-2, SORT_ASCENDING); //Disable sorting to gain performance
1374 EditorRegions::thaw_tree_model (){
1376 _model->set_sort_column (0, SORT_ASCENDING); // renabale sorting
1377 _display.set_model (_model);
1379 if (toggle_full_action()->get_active()) {
1380 _display.expand_all();
1385 EditorRegions::locked_changed (std::string const & path)
1387 TreeIter i = _model->get_iter (path);
1389 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1391 region->set_locked (!(*i)[_columns.locked]);
1397 EditorRegions::glued_changed (std::string const & path)
1399 TreeIter i = _model->get_iter (path);
1401 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1403 /* `glued' means MusicTime, and we're toggling here */
1404 region->set_position_lock_style ((*i)[_columns.glued] ? AudioTime : MusicTime);
1411 EditorRegions::muted_changed (std::string const & path)
1413 TreeIter i = _model->get_iter (path);
1415 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1417 region->set_muted (!(*i)[_columns.muted]);
1424 EditorRegions::opaque_changed (std::string const & path)
1426 TreeIter i = _model->get_iter (path);
1428 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1430 region->set_opaque (!(*i)[_columns.opaque]);
1437 EditorRegions::get_state () const
1439 XMLNode* node = new XMLNode (X_("RegionList"));
1441 node->add_property (X_("sort-type"), enum_2_string (_sort_type));
1443 RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), X_("SortAscending"));
1444 bool const ascending = RefPtr<RadioAction>::cast_dynamic(act)->get_active ();
1445 node->add_property (X_("sort-ascending"), ascending ? "yes" : "no");
1446 node->add_property (X_("show-all"), toggle_full_action()->get_active() ? "yes" : "no");
1447 node->add_property (X_("show-automatic-regions"), _show_automatic_regions ? "yes" : "no");
1453 EditorRegions::set_state (const XMLNode & node)
1455 bool changed = false;
1457 if (node.name() != X_("RegionList")) {
1461 XMLProperty const * p = node.property (X_("sort-type"));
1464 Editing::RegionListSortType const t = static_cast<Editing::RegionListSortType> (string_2_enum (p->value(), _sort_type));
1466 if (_sort_type != t) {
1470 reset_sort_type (t, true);
1471 RefPtr<RadioAction> ract = sort_type_action (t);
1472 ract->set_active ();
1475 p = node.property (X_("sort-ascending"));
1478 bool const yn = string_is_affirmative (p->value ());
1479 SortType old_sort_type;
1480 int old_sort_column;
1482 _model->get_sort_column_id (old_sort_column, old_sort_type);
1484 if (old_sort_type != (yn ? SORT_ASCENDING : SORT_DESCENDING)) {
1488 reset_sort_direction (yn);
1492 act = ActionManager::get_action (X_("RegionList"), X_("SortAscending"));
1494 act = ActionManager::get_action (X_("RegionList"), X_("SortDescending"));
1497 RefPtr<RadioAction>::cast_dynamic(act)->set_active ();
1500 p = node.property (X_("show-all"));
1502 bool const yn = string_is_affirmative (p->value ());
1504 if (expanded != yn) {
1509 toggle_full_action()->set_active (yn);
1512 p = node.property (X_("show-automatic-regions"));
1514 bool const yn = string_is_affirmative (p->value ());
1516 if (yn != _show_automatic_regions) {
1517 _show_automatic_regions = yn;
1518 toggle_show_auto_regions_action()->set_active (yn);
1529 EditorRegions::sort_type_action (Editing::RegionListSortType t) const
1531 const char* action = 0;
1534 case Editing::ByName:
1535 action = X_("SortByRegionName");
1537 case Editing::ByLength:
1538 action = X_("SortByRegionLength");
1540 case Editing::ByPosition:
1541 action = X_("SortByRegionPosition");
1543 case Editing::ByTimestamp:
1544 action = X_("SortByRegionTimestamp");
1546 case Editing::ByStartInFile:
1547 action = X_("SortByRegionStartinFile");
1549 case Editing::ByEndInFile:
1550 action = X_("SortByRegionEndinFile");
1552 case Editing::BySourceFileName:
1553 action = X_("SortBySourceFileName");
1555 case Editing::BySourceFileLength:
1556 action = X_("SortBySourceFileLength");
1558 case Editing::BySourceFileCreationDate:
1559 action = X_("SortBySourceFileCreationDate");
1561 case Editing::BySourceFileFS:
1562 action = X_("SortBySourceFilesystem");
1565 fatal << string_compose (_("programming error: %1: %2"), "EditorRegions: impossible sort type", (int) t) << endmsg;
1569 RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), action);
1572 return RefPtr<RadioAction>::cast_dynamic (act);
1576 EditorRegions::hide_action () const
1578 return ActionManager::get_action (X_("RegionList"), X_("rlHide"));
1583 EditorRegions::show_action () const
1585 return ActionManager::get_action (X_("RegionList"), X_("rlShow"));
1589 EditorRegions::remove_unused_regions_action () const
1591 return ActionManager::get_action (X_("RegionList"), X_("removeUnusedRegions"));
1594 RefPtr<ToggleAction>
1595 EditorRegions::toggle_full_action () const
1597 Glib::RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), X_("rlShowAll"));
1599 return Glib::RefPtr<ToggleAction>::cast_dynamic (act);
1602 RefPtr<ToggleAction>
1603 EditorRegions::toggle_show_auto_regions_action () const
1605 Glib::RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), X_("rlShowAuto"));
1607 return Glib::RefPtr<ToggleAction>::cast_dynamic (act);