Fix one more warning.
[ardour2.git] / gtk2_ardour / editor_regions.cc
blob154af6c97776f56635bdded615f4a4d57f4537bd
1 /*
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.
20 #include <cstdlib>
21 #include <cmath>
22 #include <algorithm>
23 #include <string>
24 #include <sstream>
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"
41 #include "editor.h"
42 #include "editing.h"
43 #include "keyboard.h"
44 #include "ardour_ui.h"
45 #include "gui_thread.h"
46 #include "actions.h"
47 #include "region_view.h"
48 #include "utils.h"
49 #include "editor_regions.h"
50 #include "editor_drag.h"
52 #include "i18n.h"
54 using namespace std;
55 using namespace ARDOUR;
56 using namespace PBD;
57 using namespace Gtk;
58 using namespace Glib;
59 using namespace Editing;
60 using Gtkmm2ext::Keyboard;
62 EditorRegions::EditorRegions (Editor* e)
63 : EditorComponent (e)
64 , old_focus (0)
65 , name_editable (0)
66 , _menu (0)
67 , _show_automatic_regions (true)
68 , ignore_region_list_selection_change (false)
69 , ignore_selected_region_change (false)
70 , _no_redisplay (false)
71 , _sort_type ((Editing::RegionListSortType) 0)
72 , expanded (false)
74 _display.set_size_request (100, -1);
75 _display.set_name ("RegionListDisplay");
76 _display.set_rules_hint (true);
78 /* Try to prevent single mouse presses from initiating edits.
79 This relies on a hack in gtktreeview.c:gtk_treeview_button_press()
81 _display.set_data ("mouse-edits-require-mod1", (gpointer) 0x1);
83 _model = TreeStore::create (_columns);
84 _model->set_sort_func (0, sigc::mem_fun (*this, &EditorRegions::sorter));
85 _model->set_sort_column (0, SORT_ASCENDING);
87 _display.set_model (_model);
89 _display.append_column (_("Regions"), _columns.name);
90 _display.append_column (_("Position"), _columns.position);
91 _display.append_column (_("End"), _columns.end);
92 _display.append_column (_("Length"), _columns.length);
93 _display.append_column (_("Sync"), _columns.sync);
94 _display.append_column (_("Fade In"), _columns.fadein);
95 _display.append_column (_("Fade Out"), _columns.fadeout);
96 _display.append_column (_("L"), _columns.locked);
97 _display.append_column (_("G"), _columns.glued);
98 _display.append_column (_("M"), _columns.muted);
99 _display.append_column (_("O"), _columns.opaque);
100 // _display.append_column (_("Used"), _columns.used);
101 // _display.append_column (_("Path"), _columns.path);
102 _display.set_headers_visible (true);
103 //_display.set_grid_lines (TREE_VIEW_GRID_LINES_BOTH);
105 /* show path as the row tooltip */
106 _display.set_tooltip_column (15); /* path */
108 CellRendererText* region_name_cell = dynamic_cast<CellRendererText*>(_display.get_column_cell_renderer (0));
109 region_name_cell->property_editable() = true;
110 region_name_cell->signal_edited().connect (sigc::mem_fun (*this, &EditorRegions::name_edit));
111 region_name_cell->signal_editing_started().connect (sigc::mem_fun (*this, &EditorRegions::name_editing_started));
113 _display.get_selection()->set_select_function (sigc::mem_fun (*this, &EditorRegions::selection_filter));
115 TreeViewColumn* tv_col = _display.get_column(0);
116 CellRendererText* renderer = dynamic_cast<CellRendererText*>(_display.get_column_cell_renderer (0));
117 tv_col->add_attribute(renderer->property_text(), _columns.name);
118 tv_col->add_attribute(renderer->property_foreground_gdk(), _columns.color_);
120 CellRendererToggle* locked_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (7));
121 locked_cell->property_activatable() = true;
122 locked_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::locked_changed));
124 TreeViewColumn* locked_col = _display.get_column (7);
125 locked_col->add_attribute (locked_cell->property_visible(), _columns.property_toggles_visible);
127 CellRendererToggle* glued_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (8));
128 glued_cell->property_activatable() = true;
129 glued_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::glued_changed));
131 TreeViewColumn* glued_col = _display.get_column (8);
132 glued_col->add_attribute (glued_cell->property_visible(), _columns.property_toggles_visible);
134 CellRendererToggle* muted_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (9));
135 muted_cell->property_activatable() = true;
136 muted_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::muted_changed));
138 TreeViewColumn* muted_col = _display.get_column (9);
139 muted_col->add_attribute (muted_cell->property_visible(), _columns.property_toggles_visible);
141 CellRendererToggle* opaque_cell = dynamic_cast<CellRendererToggle*> (_display.get_column_cell_renderer (10));
142 opaque_cell->property_activatable() = true;
143 opaque_cell->signal_toggled().connect (sigc::mem_fun (*this, &EditorRegions::opaque_changed));
145 TreeViewColumn* opaque_col = _display.get_column (10);
146 opaque_col->add_attribute (opaque_cell->property_visible(), _columns.property_toggles_visible);
148 _display.get_selection()->set_mode (SELECTION_MULTIPLE);
149 _display.add_object_drag (_columns.region.index(), "regions");
151 /* setup DnD handling */
153 list<TargetEntry> region_list_target_table;
155 region_list_target_table.push_back (TargetEntry ("text/plain"));
156 region_list_target_table.push_back (TargetEntry ("text/uri-list"));
157 region_list_target_table.push_back (TargetEntry ("application/x-rootwin-drop"));
159 _display.add_drop_targets (region_list_target_table);
160 _display.signal_drag_data_received().connect (sigc::mem_fun(*this, &EditorRegions::drag_data_received));
162 _scroller.add (_display);
163 _scroller.set_policy (POLICY_AUTOMATIC, POLICY_AUTOMATIC);
165 _display.signal_button_press_event().connect (sigc::mem_fun(*this, &EditorRegions::button_press), false);
166 _change_connection = _display.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &EditorRegions::selection_changed));
168 _scroller.signal_key_press_event().connect (sigc::mem_fun(*this, &EditorRegions::key_press), false);
169 _scroller.signal_focus_in_event().connect (sigc::mem_fun (*this, &EditorRegions::focus_in), false);
170 _scroller.signal_focus_out_event().connect (sigc::mem_fun (*this, &EditorRegions::focus_out));
172 _display.signal_enter_notify_event().connect (sigc::mem_fun (*this, &EditorRegions::enter_notify), false);
173 _display.signal_leave_notify_event().connect (sigc::mem_fun (*this, &EditorRegions::leave_notify), false);
175 // _display.signal_popup_menu().connect (sigc::bind (sigc::mem_fun (*this, &Editor::show__display_context_menu), 1, 0));
177 //ARDOUR_UI::instance()->secondary_clock.mode_changed.connect (sigc::mem_fun(*this, &Editor::redisplay_regions));
178 ARDOUR_UI::instance()->secondary_clock->mode_changed.connect (sigc::mem_fun(*this, &EditorRegions::update_all_rows));
179 ARDOUR::Region::RegionPropertyChanged.connect (region_property_connection, MISSING_INVALIDATOR, ui_bind (&EditorRegions::region_changed, this, _1, _2), gui_context());
180 ARDOUR::RegionFactory::CheckNewRegion.connect (check_new_region_connection, MISSING_INVALIDATOR, ui_bind (&EditorRegions::add_region, this, _1), gui_context());
182 e->EditorFreeze.connect (editor_freeze_connection, MISSING_INVALIDATOR, ui_bind (&EditorRegions::freeze_tree_model, this), gui_context());
183 e->EditorThaw.connect (editor_thaw_connection, MISSING_INVALIDATOR, ui_bind (&EditorRegions::thaw_tree_model, this), gui_context());
186 bool
187 EditorRegions::focus_in (GdkEventFocus*)
189 Window* win = dynamic_cast<Window*> (_scroller.get_toplevel ());
191 if (win) {
192 old_focus = win->get_focus ();
193 } else {
194 old_focus = 0;
197 name_editable = 0;
199 /* try to do nothing on focus in (doesn't work, hence selection_count nonsense) */
200 return true;
203 bool
204 EditorRegions::focus_out (GdkEventFocus*)
206 if (old_focus) {
207 old_focus->grab_focus ();
208 old_focus = 0;
211 name_editable = 0;
213 return false;
216 bool
217 EditorRegions::enter_notify (GdkEventCrossing* ev)
219 if (name_editable) {
220 return true;
223 /* arm counter so that ::selection_filter() will deny selecting anything for the
224 next two attempts to change selection status.
226 _scroller.grab_focus ();
227 Keyboard::magic_widget_grab_focus ();
228 return false;
231 bool
232 EditorRegions::leave_notify (GdkEventCrossing*)
234 if (old_focus) {
235 old_focus->grab_focus ();
236 old_focus = 0;
239 Keyboard::magic_widget_drop_focus ();
240 return false;
243 void
244 EditorRegions::set_session (ARDOUR::Session* s)
246 SessionHandlePtr::set_session (s);
247 redisplay ();
250 void
251 EditorRegions::add_region (boost::shared_ptr<Region> region)
253 if (!region || !_session) {
254 return;
257 string str;
258 TreeModel::Row row;
259 Gdk::Color c;
260 bool missing_source = boost::dynamic_pointer_cast<SilentFileSource>(region->source());
262 if (!_show_automatic_regions && region->automatic()) {
263 return;
266 if (region->hidden()) {
268 TreeModel::iterator iter = _model->get_iter ("0");
269 TreeModel::Row parent;
270 TreeModel::Row child;
272 if (!iter) {
273 parent = *(_model->append());
274 parent[_columns.name] = _("Hidden");
275 boost::shared_ptr<Region> proxy = parent[_columns.region];
276 proxy.reset ();
277 } else {
278 string s = (*iter)[_columns.name];
279 if (s != _("Hidden")) {
280 parent = *(_model->insert(iter));
281 parent[_columns.name] = _("Hidden");
282 boost::shared_ptr<Region> proxy = parent[_columns.region];
283 proxy.reset ();
284 } else {
285 parent = *iter;
289 row = *(_model->append (parent.children()));
291 } else if (region->whole_file()) {
293 TreeModel::iterator i;
294 TreeModel::Children rows = _model->children();
296 for (i = rows.begin(); i != rows.end(); ++i) {
297 boost::shared_ptr<Region> rr = (*i)[_columns.region];
299 if (rr && region->region_list_equivalent (rr)) {
300 return;
304 row = *(_model->append());
306 if (missing_source) {
307 c.set_rgb(65535,0,0); // FIXME: error color from style
309 } else if (region->automatic()){
310 c.set_rgb(0,65535,0); // FIXME: error color from style
312 } else {
313 set_color(c, rgba_from_style ("RegionListWholeFile", 0xff, 0, 0, 0, "fg", Gtk::STATE_NORMAL, false ));
317 row[_columns.color_] = c;
319 if (region->source()->name()[0] == '/') { // external file
321 if (region->whole_file()) {
323 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(region->source());
324 str = ".../";
326 if (afs) {
327 str = region_name_from_path (afs->path(), region->n_channels() > 1);
328 } else {
329 str += region->source()->name();
332 } else {
333 str = region->name();
336 } else {
337 str = region->name();
340 if (region->n_channels() > 1) {
341 std::stringstream foo;
342 foo << region->n_channels ();
343 str += " [";
344 str += foo.str();
345 str += "]";
348 row[_columns.name] = str;
349 row[_columns.region] = region;
350 row[_columns.property_toggles_visible] = false;
352 if (missing_source) {
353 row[_columns.path] = _("(MISSING) ") + region->source()->name();
355 } else {
356 boost::shared_ptr<FileSource> fs = boost::dynamic_pointer_cast<FileSource>(region->source());
357 if (fs) {
358 row[_columns.path] = fs->path();
359 } else {
360 row[_columns.path] = region->source()->name();
364 region_row_map.insert(pair<boost::shared_ptr<ARDOUR::Region>, Gtk::TreeModel::RowReference>(region, TreeRowReference(_model, TreePath (row))) );
365 parent_regions_sources_map.insert(pair<string, Gtk::TreeModel::RowReference>(region->source_string(), TreeRowReference(_model, TreePath (row))) );
367 return;
369 } else {
370 // find parent node, add as new child
371 TreeModel::iterator i;
373 boost::unordered_map<string, Gtk::TreeModel::RowReference>::iterator it;
375 it = parent_regions_sources_map.find (region->source_string());
377 if (it != parent_regions_sources_map.end()){
379 TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
381 TreeModel::iterator ii;
382 TreeModel::Children subrows = (*j).children();
384 /* XXXX: should we be accounting for all regions? */
386 for (ii = subrows.begin(); ii != subrows.end(); ++ii) {
387 boost::shared_ptr<Region> rr = (*ii)[_columns.region];
389 if (region->region_list_equivalent (rr)) {
390 return;
395 row = *(_model->insert (subrows.end()));
397 } else {
398 row = *(_model->append());
401 row[_columns.property_toggles_visible] = true;
404 row[_columns.region] = region;
406 region_row_map.insert(pair<boost::shared_ptr<ARDOUR::Region>, Gtk::TreeModel::RowReference>(region, TreeRowReference(_model, TreePath (row))) );
408 populate_row(region, (*row));
411 void
412 EditorRegions::delete_unused_regions ()
414 vector<string> choices;
415 string prompt;
417 if (!_session) {
418 return;
421 prompt = _("Do you really want to remove unused regions?"
422 "\n(This is destructive and cannot be undone)");
424 choices.push_back (_("No, do nothing."));
425 choices.push_back (_("Yes, remove."));
427 Gtkmm2ext::Choice prompter (_("Remove unused regions"), prompt, choices);
429 if (prompter.run () == 1) {
430 _no_redisplay = true;
431 _session->cleanup_regions ();
432 _no_redisplay = false;
433 redisplay ();
437 void
438 EditorRegions::region_changed (boost::shared_ptr<Region> r, const PropertyChange& what_changed)
440 PropertyChange our_interests;
442 our_interests.add (ARDOUR::Properties::name);
443 our_interests.add (ARDOUR::Properties::position);
444 our_interests.add (ARDOUR::Properties::length);
445 our_interests.add (ARDOUR::Properties::start);
446 our_interests.add (ARDOUR::Properties::locked);
447 our_interests.add (ARDOUR::Properties::position_lock_style);
448 our_interests.add (ARDOUR::Properties::muted);
449 our_interests.add (ARDOUR::Properties::opaque);
450 our_interests.add (ARDOUR::Properties::fade_in);
451 our_interests.add (ARDOUR::Properties::fade_out);
453 if (what_changed.contains (our_interests)) {
455 if (last_row != 0) {
457 TreeModel::iterator j = _model->get_iter (last_row.get_path());
458 boost::shared_ptr<Region> c = (*j)[_columns.region];
460 if (c == r) {
461 populate_row (r, (*j));
463 if (what_changed.contains (ARDOUR::Properties::hidden)) {
464 redisplay ();
467 return;
471 RegionRowMap::iterator it;
473 it = region_row_map.find (r);
475 if (it != region_row_map.end()){
477 TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
478 boost::shared_ptr<Region> c = (*j)[_columns.region];
480 if (c == r) {
481 populate_row (r, (*j));
483 if (what_changed.contains (ARDOUR::Properties::hidden)) {
484 redisplay ();
487 return;
492 if (what_changed.contains (ARDOUR::Properties::hidden)) {
493 redisplay ();
497 void
498 EditorRegions::selection_changed ()
500 if (ignore_region_list_selection_change) {
501 return;
504 _editor->_region_selection_change_updates_region_list = false;
506 if (_display.get_selection()->count_selected_rows() > 0) {
508 TreeIter iter;
509 TreeView::Selection::ListHandle_Path rows = _display.get_selection()->get_selected_rows ();
511 _editor->get_selection().clear_regions ();
513 for (TreeView::Selection::ListHandle_Path::iterator i = rows.begin(); i != rows.end(); ++i) {
515 if (iter = _model->get_iter (*i)) {
516 boost::shared_ptr<Region> region = (*iter)[_columns.region];
518 // they could have clicked on a row that is just a placeholder, like "Hidden"
519 // although that is not allowed by our selection filter. check it anyway
520 // since we need a region ptr.
522 if (region) {
524 if (region->automatic()) {
526 _display.get_selection()->unselect(*i);
528 } else {
529 _change_connection.block (true);
530 _editor->set_selected_regionview_from_region_list (region, Selection::Add);
532 _change_connection.block (false);
537 } else {
538 _editor->get_selection().clear_regions ();
541 _editor->_region_selection_change_updates_region_list = true;
544 void
545 EditorRegions::set_selected (RegionSelection& regions)
547 for (RegionSelection::iterator i = regions.begin(); i != regions.end(); ++i) {
549 boost::shared_ptr<Region> r ((*i)->region());
551 RegionRowMap::iterator it;
553 it = region_row_map.find (r);
555 if (it != region_row_map.end()){
556 TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
557 _display.get_selection()->select(*j);
562 void
563 EditorRegions::redisplay ()
565 if (_no_redisplay || !_session) {
566 return;
569 bool tree_expanded = false;
571 /* If the list was expanded prior to rebuilding, expand it again afterwards */
572 if (toggle_full_action()->get_active()) {
573 tree_expanded = true;
576 _display.set_model (Glib::RefPtr<Gtk::TreeStore>(0));
577 _model->clear ();
578 _model->set_sort_column (-2, SORT_ASCENDING); //Disable sorting to gain performance
581 region_row_map.clear();
582 parent_regions_sources_map.clear();
584 /* now add everything we have, via a temporary list used to help with sorting */
586 const RegionFactory::RegionMap& regions (RegionFactory::regions());
588 for (RegionFactory::RegionMap::const_iterator i = regions.begin(); i != regions.end(); ++i) {
590 if ( i->second->whole_file()) {
591 /* add automatic regions first so that children can find their parents as we add them */
592 add_region (i->second);
593 continue;
596 tmp_region_list.push_front (i->second);
599 for (list<boost::shared_ptr<Region> >::iterator r = tmp_region_list.begin(); r != tmp_region_list.end(); ++r) {
600 add_region (*r);
603 _model->set_sort_column (0, SORT_ASCENDING); // renabale sorting
604 _display.set_model (_model);
606 tmp_region_list.clear();
608 if (tree_expanded) {
609 _display.expand_all();
613 void
614 EditorRegions::update_row (boost::shared_ptr<Region> region)
616 if (!region || !_session) {
617 return;
620 RegionRowMap::iterator it;
622 it = region_row_map.find (region);
624 if (it != region_row_map.end()){
626 TreeModel::iterator j = _model->get_iter ((*it).second.get_path());
627 populate_row(region, (*j));
631 void
632 EditorRegions::update_all_rows ()
634 if (!_session) {
635 return;
638 RegionRowMap::iterator i;
640 for (i = region_row_map.begin(); i != region_row_map.end(); ++i) {
642 TreeModel::iterator j = _model->get_iter ((*i).second.get_path());
644 boost::shared_ptr<Region> region = (*j)[_columns.region];
646 if (!region->automatic()) {
647 populate_row(region, (*j));
652 void
653 EditorRegions::format_position (framepos_t pos, char* buf, size_t bufsize)
655 Timecode::BBT_Time bbt;
656 Timecode::Time timecode;
658 switch (ARDOUR_UI::instance()->secondary_clock->mode ()) {
659 case AudioClock::BBT:
660 _session->tempo_map().bbt_time (pos, bbt);
661 snprintf (buf, bufsize, "%03d|%02d|%04d" , bbt.bars, bbt.beats, bbt.ticks);
662 break;
664 case AudioClock::MinSec:
665 framepos_t left;
666 int hrs;
667 int mins;
668 float secs;
670 left = pos;
671 hrs = (int) floor (left / (_session->frame_rate() * 60.0f * 60.0f));
672 left -= (framecnt_t) floor (hrs * _session->frame_rate() * 60.0f * 60.0f);
673 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
674 left -= (framecnt_t) floor (mins * _session->frame_rate() * 60.0f);
675 secs = left / (float) _session->frame_rate();
676 snprintf (buf, bufsize, "%02d:%02d:%06.3f", hrs, mins, secs);
677 break;
679 case AudioClock::Frames:
680 snprintf (buf, bufsize, "%" PRId64, pos);
681 break;
683 case AudioClock::Timecode:
684 default:
685 _session->timecode_time (pos, timecode);
686 snprintf (buf, bufsize, "%02d:%02d:%02d:%02d", timecode.hours, timecode.minutes, timecode.seconds, timecode.frames);
687 break;
691 void
692 EditorRegions::populate_row (boost::shared_ptr<Region> region, TreeModel::Row const &row)
694 boost::shared_ptr<AudioRegion> audioregion = boost::dynamic_pointer_cast<AudioRegion>(region);
695 //uint32_t used = _session->playlists->region_use_count (region);
696 /* Presently a region is only used once so let's save on the sequential scan to determine use count */
697 uint32_t used = 1;
699 populate_row_position (region, row, used);
700 populate_row_end (region, row, used);
701 populate_row_sync (region, row, used);
702 populate_row_fade_in (region, row, used, audioregion);
703 populate_row_fade_out (region, row, used, audioregion);
704 populate_row_locked (region, row, used);
705 populate_row_glued (region, row, used);
706 populate_row_muted (region, row, used);
707 populate_row_opaque (region, row, used);
708 populate_row_length (region, row);
709 populate_row_source (region, row);
710 populate_row_name (region, row);
711 populate_row_used (region, row, used);
714 #if 0
715 if (audioRegion && fades_in_seconds) {
717 framepos_t left;
718 int mins;
719 int millisecs;
721 left = audioRegion->fade_in()->back()->when;
722 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
723 left -= (framepos_t) floor (mins * _session->frame_rate() * 60.0f);
724 millisecs = (int) floor ((left * 1000.0f) / _session->frame_rate());
726 if (audioRegion->fade_in()->back()->when >= _session->frame_rate()) {
727 sprintf (fadein_str, "%01dM %01dmS", mins, millisecs);
728 } else {
729 sprintf (fadein_str, "%01dmS", millisecs);
732 left = audioRegion->fade_out()->back()->when;
733 mins = (int) floor (left / (_session->frame_rate() * 60.0f));
734 left -= (framepos_t) floor (mins * _session->frame_rate() * 60.0f);
735 millisecs = (int) floor ((left * 1000.0f) / _session->frame_rate());
737 if (audioRegion->fade_out()->back()->when >= _session->frame_rate()) {
738 sprintf (fadeout_str, "%01dM %01dmS", mins, millisecs);
739 } else {
740 sprintf (fadeout_str, "%01dmS", millisecs);
743 #endif
745 void
746 EditorRegions::populate_row_used (boost::shared_ptr<Region> region, TreeModel::Row const& row, uint32_t used)
748 char buf[8];
749 snprintf (buf, sizeof (buf), "%4d" , used);
750 row[_columns.used] = buf;
753 void
754 EditorRegions::populate_row_length (boost::shared_ptr<Region> region, TreeModel::Row const &row)
756 char buf[16];
757 format_position (region->length(), buf, sizeof (buf));
758 row[_columns.length] = buf;
761 void
762 EditorRegions::populate_row_end (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
764 if (region->whole_file()) {
765 row[_columns.end] = "";
766 } else if (used > 1) {
767 row[_columns.end] = _("Mult.");
768 } else {
769 char buf[16];
770 format_position (region->last_frame(), buf, sizeof (buf));
771 row[_columns.end] = buf;
775 void
776 EditorRegions::populate_row_position (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
778 if (region->whole_file()) {
779 row[_columns.position] = "";
780 } else if (used > 1) {
781 row[_columns.position] = _("Mult.");
782 } else {
783 char buf[16];
784 format_position (region->position(), buf, sizeof (buf));
785 row[_columns.position] = buf;
789 void
790 EditorRegions::populate_row_sync (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
792 if (region->whole_file()) {
793 row[_columns.sync] = "";
794 } else if (used > 1) {
795 row[_columns.sync] = _("Mult."); /* translators: a short phrase for "multiple" as in "many" */
796 } else {
797 if (region->sync_position() == region->position()) {
798 row[_columns.sync] = _("Start");
799 } else if (region->sync_position() == (region->last_frame())) {
800 row[_columns.sync] = _("End");
801 } else {
802 char buf[16];
803 format_position (region->sync_position(), buf, sizeof (buf));
804 row[_columns.sync] = buf;
809 void
810 EditorRegions::populate_row_fade_in (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used, boost::shared_ptr<AudioRegion> audioregion)
812 if (!audioregion || region->whole_file()) {
813 row[_columns.fadein] = "";
814 } else {
815 if (used > 1) {
816 row[_columns.fadein] = _("Multiple");
817 } else {
819 char buf[16];
820 format_position (audioregion->fade_in()->back()->when, buf, sizeof (buf));
821 row[_columns.fadein] = buf;
823 if (audioregion->fade_in_active()) {
824 row[_columns.fadein] = string_compose("%1%2%3", " ", buf, " ");
825 } else {
826 row[_columns.fadein] = string_compose("%1%2%3", "(", buf, ")");
832 void
833 EditorRegions::populate_row_fade_out (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used, boost::shared_ptr<AudioRegion> audioregion)
835 if (!audioregion || region->whole_file()) {
836 row[_columns.fadeout] = "";
837 } else {
838 if (used > 1) {
839 row[_columns.fadeout] = _("Multiple");
840 } else {
841 char buf[16];
842 format_position (audioregion->fade_out()->back()->when, buf, sizeof (buf));
844 if (audioregion->fade_out_active()) {
845 row[_columns.fadeout] = string_compose("%1%2%3", " ", buf, " ");
846 } else {
847 row[_columns.fadeout] = string_compose("%1%2%3", "(", buf, ")");
853 void
854 EditorRegions::populate_row_locked (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
856 if (region->whole_file()) {
857 row[_columns.locked] = false;
858 } else if (used > 1) {
859 row[_columns.locked] = false;
860 } else {
861 row[_columns.locked] = region->locked();
865 void
866 EditorRegions::populate_row_glued (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
868 if (region->whole_file() || used > 1) {
869 row[_columns.glued] = false;
870 } else {
871 if (region->position_lock_style() == MusicTime) {
872 row[_columns.glued] = true;
873 } else {
874 row[_columns.glued] = false;
879 void
880 EditorRegions::populate_row_muted (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
882 if (region->whole_file() || used > 1) {
883 row[_columns.muted] = false;
884 } else {
885 row[_columns.muted] = region->muted();
889 void
890 EditorRegions::populate_row_opaque (boost::shared_ptr<Region> region, TreeModel::Row const &row, uint32_t used)
892 if (region->whole_file() || used > 1) {
893 row[_columns.opaque] = false;
894 } else {
895 row[_columns.opaque] = region->opaque();
899 void
900 EditorRegions::populate_row_name (boost::shared_ptr<Region> region, TreeModel::Row const &row)
902 if (region->n_channels() > 1) {
903 row[_columns.name] = string_compose("%1 [%2]", region->name(), region->n_channels());
904 } else {
905 row[_columns.name] = region->name();
909 void
910 EditorRegions::populate_row_source (boost::shared_ptr<Region> region, TreeModel::Row const &row)
912 if (boost::dynamic_pointer_cast<SilentFileSource>(region->source())) {
913 row[_columns.path] = _("MISSING ") + region->source()->name();
914 } else {
915 row[_columns.path] = region->source()->name();
919 void
920 EditorRegions::toggle_show_auto_regions ()
922 _show_automatic_regions = toggle_show_auto_regions_action()->get_active();
923 redisplay ();
926 void
927 EditorRegions::toggle_full ()
929 set_full (toggle_full_action()->get_active ());
932 void
933 EditorRegions::set_full (bool f)
935 if (f) {
936 _display.expand_all ();
937 expanded = true;
938 } else {
939 _display.collapse_all ();
940 expanded = false;
944 void
945 EditorRegions::show_context_menu (int button, int time)
947 if (_menu == 0) {
948 _menu = dynamic_cast<Menu*> (ActionManager::get_widget ("/RegionListMenu"));
951 if (_display.get_selection()->count_selected_rows() > 0) {
952 ActionManager::set_sensitive (ActionManager::region_list_selection_sensitive_actions, true);
953 } else {
954 ActionManager::set_sensitive (ActionManager::region_list_selection_sensitive_actions, false);
957 /* Enable the "Show" option if any selected regions are hidden, and vice versa for "Hide" */
959 bool have_shown = false;
960 bool have_hidden = false;
962 TreeView::Selection::ListHandle_Path rows = _display.get_selection()->get_selected_rows ();
963 for (TreeView::Selection::ListHandle_Path::iterator i = rows.begin(); i != rows.end(); ++i) {
964 TreeIter t = _model->get_iter (*i);
965 boost::shared_ptr<Region> r = (*t)[_columns.region];
966 if (r) {
967 if (r->hidden ()) {
968 have_hidden = true;
969 } else {
970 have_shown = true;
975 hide_action()->set_sensitive (have_shown);
976 show_action()->set_sensitive (have_hidden);
978 _menu->popup (button, time);
981 bool
982 EditorRegions::key_press (GdkEventKey* ev)
984 TreeViewColumn *col;
986 switch (ev->keyval) {
987 case GDK_Tab:
988 case GDK_ISO_Left_Tab:
990 if (name_editable) {
991 name_editable->editing_done ();
992 name_editable = 0;
995 col = _display.get_column (0); // select&focus on name column
997 if (Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)) {
998 treeview_select_previous (_display, _model, col);
999 } else {
1000 treeview_select_next (_display, _model, col);
1003 return true;
1004 break;
1006 default:
1007 break;
1010 return false;
1013 bool
1014 EditorRegions::button_press (GdkEventButton *ev)
1016 boost::shared_ptr<Region> region;
1017 TreeIter iter;
1018 TreeModel::Path path;
1019 TreeViewColumn* column;
1020 int cellx;
1021 int celly;
1023 if (_display.get_path_at_pos ((int)ev->x, (int)ev->y, path, column, cellx, celly)) {
1024 if ((iter = _model->get_iter (path))) {
1025 region = (*iter)[_columns.region];
1029 if (Keyboard::is_context_menu_event (ev)) {
1030 show_context_menu (ev->button, ev->time);
1031 return false;
1034 if (region != 0 && Keyboard::is_button2_event (ev)) {
1035 // start/stop audition
1036 if (!Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
1037 _editor->consider_auditioning (region);
1039 return true;
1042 return false;
1046 EditorRegions::sorter (TreeModel::iterator a, TreeModel::iterator b)
1048 int cmp = 0;
1050 boost::shared_ptr<Region> r1 = (*a)[_columns.region];
1051 boost::shared_ptr<Region> r2 = (*b)[_columns.region];
1053 /* handle rows without regions, like "Hidden" */
1055 if (r1 == 0) {
1056 return -1;
1059 if (r2 == 0) {
1060 return 1;
1063 boost::shared_ptr<AudioRegion> region1 = boost::dynamic_pointer_cast<AudioRegion> (r1);
1064 boost::shared_ptr<AudioRegion> region2 = boost::dynamic_pointer_cast<AudioRegion> (r2);
1066 if (region1 == 0 || region2 == 0) {
1067 std::string s1;
1068 std::string s2;
1069 switch (_sort_type) {
1070 case ByName:
1071 s1 = (*a)[_columns.name];
1072 s2 = (*b)[_columns.name];
1073 return (s1.compare (s2));
1074 default:
1075 return 0;
1079 switch (_sort_type) {
1080 case ByName:
1081 cmp = strcasecmp (region1->name().c_str(), region2->name().c_str());
1082 break;
1084 case ByLength:
1085 cmp = region1->length() - region2->length();
1086 break;
1088 case ByPosition:
1089 cmp = region1->position() - region2->position();
1090 break;
1092 case ByTimestamp:
1093 cmp = region1->source()->timestamp() - region2->source()->timestamp();
1094 break;
1096 case ByStartInFile:
1097 cmp = region1->start() - region2->start();
1098 break;
1100 case ByEndInFile:
1101 // cerr << "Compare " << (region1->start() + region1->length()) << " and " << (region2->start() + region2->length()) << endl;
1102 cmp = (region1->start() + region1->length()) - (region2->start() + region2->length());
1103 break;
1105 case BySourceFileName:
1106 cmp = strcasecmp (region1->source()->name().c_str(), region2->source()->name().c_str());
1107 break;
1109 case BySourceFileLength:
1110 cmp = region1->source_length(0) - region2->source_length(0);
1111 break;
1113 case BySourceFileCreationDate:
1114 cmp = region1->source()->timestamp() - region2->source()->timestamp();
1115 break;
1117 case BySourceFileFS:
1118 if (region1->source()->name() == region2->source()->name()) {
1119 cmp = strcasecmp (region1->name().c_str(), region2->name().c_str());
1120 } else {
1121 cmp = strcasecmp (region1->source()->name().c_str(), region2->source()->name().c_str());
1123 break;
1126 // cerr << "Comparison on " << enum_2_string (_sort_type) << " gives " << cmp << endl;
1128 if (cmp < 0) {
1129 return -1;
1130 } else if (cmp > 0) {
1131 return 1;
1132 } else {
1133 return 0;
1137 void
1138 EditorRegions::reset_sort_type (RegionListSortType type, bool force)
1140 if (type != _sort_type || force) {
1141 _sort_type = type;
1142 _model->set_sort_func (0, (sigc::mem_fun (*this, &EditorRegions::sorter)));
1146 void
1147 EditorRegions::reset_sort_direction (bool up)
1149 _model->set_sort_column (0, up ? SORT_ASCENDING : SORT_DESCENDING);
1152 void
1153 EditorRegions::selection_mapover (sigc::slot<void,boost::shared_ptr<Region> > sl)
1155 Glib::RefPtr<TreeSelection> selection = _display.get_selection();
1156 TreeView::Selection::ListHandle_Path rows = selection->get_selected_rows ();
1157 TreeView::Selection::ListHandle_Path::iterator i = rows.begin();
1159 if (selection->count_selected_rows() == 0 || _session == 0) {
1160 return;
1163 for (; i != rows.end(); ++i) {
1164 TreeIter iter;
1166 if ((iter = _model->get_iter (*i))) {
1168 /* some rows don't have a region associated with them, but can still be
1169 selected (XXX maybe prevent them from being selected)
1172 boost::shared_ptr<Region> r = (*iter)[_columns.region];
1174 if (r) {
1175 sl (r);
1182 void
1183 EditorRegions::drag_data_received (const RefPtr<Gdk::DragContext>& context,
1184 int x, int y,
1185 const SelectionData& data,
1186 guint info, guint time)
1188 vector<string> paths;
1190 if (data.get_target() == "GTK_TREE_MODEL_ROW") {
1191 /* something is being dragged over the region list */
1192 _editor->_drags->abort ();
1193 _display.on_drag_data_received (context, x, y, data, info, time);
1194 return;
1197 if (_editor->convert_drop_to_paths (paths, context, x, y, data, info, time) == 0) {
1198 framepos_t pos = 0;
1199 if (Profile->get_sae() || Config->get_only_copy_imported_files()) {
1200 _editor->do_import (paths, Editing::ImportDistinctFiles, Editing::ImportAsRegion, SrcBest, pos);
1201 } else {
1202 _editor->do_embed (paths, Editing::ImportDistinctFiles, ImportAsRegion, pos);
1204 context->drag_finish (true, false, time);
1208 bool
1209 EditorRegions::selection_filter (const RefPtr<TreeModel>& model, const TreeModel::Path& path, bool already_selected)
1211 /* not possible to select rows that do not represent regions, like "Hidden" */
1213 if (already_selected) {
1214 /* deselecting anything is OK with us */
1215 return true;
1218 TreeModel::iterator iter = model->get_iter (path);
1220 if (iter) {
1221 boost::shared_ptr<Region> r =(*iter)[_columns.region];
1222 if (!r) {
1223 return false;
1227 return true;
1230 void
1231 EditorRegions::name_editing_started (CellEditable* ce, const Glib::ustring&)
1233 name_editable = ce;
1235 /* give it a special name */
1237 Gtk::Entry *e = dynamic_cast<Gtk::Entry*> (ce);
1239 if (e) {
1240 e->set_name (X_("RegionNameEditorEntry"));
1244 void
1245 EditorRegions::name_edit (const std::string& path, const std::string& new_text)
1247 name_editable = 0;
1249 boost::shared_ptr<Region> region;
1250 TreeIter iter;
1252 if ((iter = _model->get_iter (path))) {
1253 region = (*iter)[_columns.region];
1254 (*iter)[_columns.name] = new_text;
1257 /* now mapover everything */
1259 if (region) {
1260 vector<RegionView*> equivalents;
1261 _editor->get_regions_corresponding_to (region, equivalents);
1263 for (vector<RegionView*>::iterator i = equivalents.begin(); i != equivalents.end(); ++i) {
1264 if (new_text != (*i)->region()->name()) {
1265 (*i)->region()->set_name (new_text);
1272 /** @return Region that has been dragged out of the list, or 0 */
1273 boost::shared_ptr<Region>
1274 EditorRegions::get_dragged_region ()
1276 list<boost::shared_ptr<Region> > regions;
1277 TreeView* source;
1278 _display.get_object_drag_data (regions, &source);
1280 if (regions.empty()) {
1281 return boost::shared_ptr<Region> ();
1284 assert (regions.size() == 1);
1285 return regions.front ();
1288 void
1289 EditorRegions::clear ()
1291 _display.set_model (Glib::RefPtr<Gtk::TreeStore> (0));
1292 _model->clear ();
1293 _display.set_model (_model);
1295 /* Clean up the maps */
1296 region_row_map.clear();
1297 parent_regions_sources_map.clear();
1300 boost::shared_ptr<Region>
1301 EditorRegions::get_single_selection ()
1303 Glib::RefPtr<TreeSelection> selected = _display.get_selection();
1305 if (selected->count_selected_rows() != 1) {
1306 return boost::shared_ptr<Region> ();
1309 TreeView::Selection::ListHandle_Path rows = selected->get_selected_rows ();
1311 /* only one row selected, so rows.begin() is it */
1313 TreeIter iter = _model->get_iter (*rows.begin());
1315 if (!iter) {
1316 return boost::shared_ptr<Region> ();
1319 return (*iter)[_columns.region];
1322 void
1323 EditorRegions::freeze_tree_model (){
1325 _display.set_model (Glib::RefPtr<Gtk::TreeStore>(0));
1326 _model->set_sort_column (-2, SORT_ASCENDING); //Disable sorting to gain performance
1330 void
1331 EditorRegions::thaw_tree_model (){
1333 _model->set_sort_column (0, SORT_ASCENDING); // renabale sorting
1334 _display.set_model (_model);
1336 if (toggle_full_action()->get_active()) {
1337 _display.expand_all();
1341 void
1342 EditorRegions::locked_changed (std::string const & path)
1344 TreeIter i = _model->get_iter (path);
1345 if (i) {
1346 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1347 if (region) {
1348 region->set_locked (!(*i)[_columns.locked]);
1353 void
1354 EditorRegions::glued_changed (std::string const & path)
1356 TreeIter i = _model->get_iter (path);
1357 if (i) {
1358 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1359 if (region) {
1360 /* `glued' means MusicTime, and we're toggling here */
1361 region->set_position_lock_style ((*i)[_columns.glued] ? AudioTime : MusicTime);
1367 void
1368 EditorRegions::muted_changed (std::string const & path)
1370 TreeIter i = _model->get_iter (path);
1371 if (i) {
1372 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1373 if (region) {
1374 region->set_muted (!(*i)[_columns.muted]);
1380 void
1381 EditorRegions::opaque_changed (std::string const & path)
1383 TreeIter i = _model->get_iter (path);
1384 if (i) {
1385 boost::shared_ptr<ARDOUR::Region> region = (*i)[_columns.region];
1386 if (region) {
1387 region->set_opaque (!(*i)[_columns.opaque]);
1393 XMLNode &
1394 EditorRegions::get_state () const
1396 XMLNode* node = new XMLNode (X_("RegionList"));
1398 node->add_property (X_("sort-type"), enum_2_string (_sort_type));
1400 RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), X_("SortAscending"));
1401 bool const ascending = RefPtr<RadioAction>::cast_dynamic(act)->get_active ();
1402 node->add_property (X_("sort-ascending"), ascending ? "yes" : "no");
1403 node->add_property (X_("show-all"), toggle_full_action()->get_active() ? "yes" : "no");
1404 node->add_property (X_("show-automatic-regions"), _show_automatic_regions ? "yes" : "no");
1406 return *node;
1409 void
1410 EditorRegions::set_state (const XMLNode & node)
1412 bool changed = false;
1414 if (node.name() != X_("RegionList")) {
1415 return;
1418 XMLProperty const * p = node.property (X_("sort-type"));
1420 if (p) {
1421 Editing::RegionListSortType const t = static_cast<Editing::RegionListSortType> (string_2_enum (p->value(), _sort_type));
1423 if (_sort_type != t) {
1424 changed = true;
1427 reset_sort_type (t, true);
1428 RefPtr<RadioAction> ract = sort_type_action (t);
1429 ract->set_active ();
1432 p = node.property (X_("sort-ascending"));
1434 if (p) {
1435 bool const yn = string_is_affirmative (p->value ());
1436 SortType old_sort_type;
1437 int old_sort_column;
1439 _model->get_sort_column_id (old_sort_column, old_sort_type);
1441 if (old_sort_type != (yn ? SORT_ASCENDING : SORT_DESCENDING)) {
1442 changed = true;
1445 reset_sort_direction (yn);
1446 RefPtr<Action> act;
1448 if (yn) {
1449 act = ActionManager::get_action (X_("RegionList"), X_("SortAscending"));
1450 } else {
1451 act = ActionManager::get_action (X_("RegionList"), X_("SortDescending"));
1454 RefPtr<RadioAction>::cast_dynamic(act)->set_active ();
1457 p = node.property (X_("show-all"));
1458 if (p) {
1459 bool const yn = string_is_affirmative (p->value ());
1461 if (expanded != yn) {
1462 changed = true;
1465 set_full (yn);
1466 toggle_full_action()->set_active (yn);
1469 p = node.property (X_("show-automatic-regions"));
1470 if (p) {
1471 bool const yn = string_is_affirmative (p->value ());
1473 if (yn != _show_automatic_regions) {
1474 _show_automatic_regions = yn;
1475 toggle_show_auto_regions_action()->set_active (yn);
1476 changed = true;
1480 if (changed) {
1481 redisplay ();
1485 RefPtr<RadioAction>
1486 EditorRegions::sort_type_action (Editing::RegionListSortType t) const
1488 const char* action = 0;
1490 switch (t) {
1491 case Editing::ByName:
1492 action = X_("SortByRegionName");
1493 break;
1494 case Editing::ByLength:
1495 action = X_("SortByRegionLength");
1496 break;
1497 case Editing::ByPosition:
1498 action = X_("SortByRegionPosition");
1499 break;
1500 case Editing::ByTimestamp:
1501 action = X_("SortByRegionTimestamp");
1502 break;
1503 case Editing::ByStartInFile:
1504 action = X_("SortByRegionStartinFile");
1505 break;
1506 case Editing::ByEndInFile:
1507 action = X_("SortByRegionEndinFile");
1508 break;
1509 case Editing::BySourceFileName:
1510 action = X_("SortBySourceFileName");
1511 break;
1512 case Editing::BySourceFileLength:
1513 action = X_("SortBySourceFileLength");
1514 break;
1515 case Editing::BySourceFileCreationDate:
1516 action = X_("SortBySourceFileCreationDate");
1517 break;
1518 case Editing::BySourceFileFS:
1519 action = X_("SortBySourceFilesystem");
1520 break;
1521 default:
1522 fatal << string_compose (_("programming error: %1: %2"), "EditorRegions: impossible sort type", (int) t) << endmsg;
1523 /*NOTREACHED*/
1526 RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), action);
1527 assert (act);
1529 return RefPtr<RadioAction>::cast_dynamic (act);
1532 RefPtr<Action>
1533 EditorRegions::hide_action () const
1535 return ActionManager::get_action (X_("RegionList"), X_("rlHide"));
1539 RefPtr<Action>
1540 EditorRegions::show_action () const
1542 return ActionManager::get_action (X_("RegionList"), X_("rlShow"));
1545 RefPtr<Action>
1546 EditorRegions::delete_unused_regions_action () const
1548 return ActionManager::get_action (X_("RegionList"), X_("removeUnusedRegions"));
1551 RefPtr<ToggleAction>
1552 EditorRegions::toggle_full_action () const
1554 Glib::RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), X_("rlShowAll"));
1555 assert (act);
1556 return Glib::RefPtr<ToggleAction>::cast_dynamic (act);
1559 RefPtr<ToggleAction>
1560 EditorRegions::toggle_show_auto_regions_action () const
1562 Glib::RefPtr<Action> act = ActionManager::get_action (X_("RegionList"), X_("rlShowAuto"));
1563 assert (act);
1564 return Glib::RefPtr<ToggleAction>::cast_dynamic (act);