patch from colinf tomake region property editor clocks use 2ndary clock mode (#5200)
[ardour.git] / gtk2_ardour / region_editor.cc
1 /*
2     Copyright (C) 2001 Paul Davis
3
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.
8
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.
13
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.
17
18 */
19
20 #include <cmath>
21
22 #include <gtkmm/listviewtext.h>
23
24 #include "pbd/memento_command.h"
25 #include "pbd/stateful_diff_command.h"
26
27 #include "ardour/region.h"
28 #include "ardour/session.h"
29 #include "ardour/source.h"
30
31 #include "ardour_ui.h"
32 #include "clock_group.h"
33 #include "main_clock.h"
34 #include "gui_thread.h"
35 #include "region_editor.h"
36 #include "utils.h"
37
38 #include "i18n.h"
39
40 using namespace ARDOUR;
41 using namespace PBD;
42 using namespace std;
43 using namespace Gtkmm2ext;
44
45 RegionEditor::RegionEditor (Session* s, boost::shared_ptr<Region> r)
46         : ArdourDialog (_("Region"))
47         , _table (9, 2)
48         , _table_row (0)
49         , _region (r)
50         , name_label (_("Name:"))
51         , audition_button (_("Audition"))
52         , _clock_group (new ClockGroup)
53         , position_clock (X_("regionposition"), true, "", true, false)
54         , end_clock (X_("regionend"), true, "", true, false)
55         , length_clock (X_("regionlength"), true, "", true, false, true)
56         , sync_offset_relative_clock (X_("regionsyncoffsetrelative"), true, "", true, false)
57         , sync_offset_absolute_clock (X_("regionsyncoffsetabsolute"), true, "", true, false)
58           /* XXX cannot file start yet */
59         , start_clock (X_("regionstart"), true, "", false, false)
60         , _sources (1)
61 {
62         set_session (s);
63
64         _clock_group->set_clock_mode (ARDOUR_UI::instance()->secondary_clock->mode());
65         _clock_group->add (position_clock);
66         _clock_group->add (end_clock);
67         _clock_group->add (length_clock);
68         _clock_group->add (sync_offset_relative_clock);
69         _clock_group->add (sync_offset_absolute_clock);
70         _clock_group->add (start_clock);
71
72         position_clock.set_session (_session);
73         end_clock.set_session (_session);
74         length_clock.set_session (_session);
75         sync_offset_relative_clock.set_session (_session);
76         sync_offset_absolute_clock.set_session (_session);
77         start_clock.set_session (_session);
78
79         ARDOUR_UI::instance()->set_tip (audition_button, _("audition this region"));
80
81         audition_button.unset_flags (Gtk::CAN_FOCUS);
82
83         audition_button.set_events (audition_button.get_events() & ~(Gdk::ENTER_NOTIFY_MASK|Gdk::LEAVE_NOTIFY_MASK));
84
85         name_entry.set_name ("RegionEditorEntry");
86         name_label.set_name ("RegionEditorLabel");
87         position_label.set_name ("RegionEditorLabel");
88         position_label.set_text (_("Position:"));
89         end_label.set_name ("RegionEditorLabel");
90         end_label.set_text (_("End:"));
91         length_label.set_name ("RegionEditorLabel");
92         length_label.set_text (_("Length:"));
93         sync_relative_label.set_name ("RegionEditorLabel");
94         sync_relative_label.set_text (_("Sync point (relative to region):"));
95         sync_absolute_label.set_name ("RegionEditorLabel");
96         sync_absolute_label.set_text (_("Sync point (absolute):"));
97         start_label.set_name ("RegionEditorLabel");
98         start_label.set_text (_("File start:"));
99         _sources_label.set_name ("RegionEditorLabel");
100
101         if (_region->n_channels() > 1) {
102                 _sources_label.set_text (_("Sources:"));
103         } else {
104                 _sources_label.set_text (_("Source:"));
105         }
106
107         _table.set_col_spacings (12);
108         _table.set_row_spacings (6);
109         _table.set_border_width (12);
110
111         name_label.set_alignment (1, 0.5);
112         position_label.set_alignment (1, 0.5);
113         end_label.set_alignment (1, 0.5);
114         length_label.set_alignment (1, 0.5);
115         sync_relative_label.set_alignment (1, 0.5);
116         sync_absolute_label.set_alignment (1, 0.5);
117         start_label.set_alignment (1, 0.5);
118         _sources_label.set_alignment (1, 0.5);
119
120         Gtk::HBox* nb = Gtk::manage (new Gtk::HBox);
121         nb->set_spacing (6);
122         nb->pack_start (name_entry);
123         nb->pack_start (audition_button, false, false);
124
125         _table.attach (name_label, 0, 1, _table_row, _table_row + 1, Gtk::FILL, Gtk::FILL);
126         _table.attach (*nb, 1, 2, _table_row, _table_row + 1, Gtk::FILL | Gtk::EXPAND, Gtk::FILL);
127         ++_table_row;
128
129         _table.attach (position_label, 0, 1, _table_row, _table_row + 1, Gtk::FILL, Gtk::FILL);
130         _table.attach (position_clock, 1, 2, _table_row, _table_row + 1, Gtk::FILL | Gtk::EXPAND, Gtk::FILL);
131         ++_table_row;
132
133         _table.attach (end_label, 0, 1, _table_row, _table_row + 1, Gtk::FILL, Gtk::FILL);
134         _table.attach (end_clock, 1, 2, _table_row, _table_row + 1, Gtk::FILL | Gtk::EXPAND, Gtk::FILL);
135         ++_table_row;
136
137         _table.attach (length_label, 0, 1, _table_row, _table_row + 1, Gtk::FILL, Gtk::FILL);
138         _table.attach (length_clock, 1, 2, _table_row, _table_row + 1, Gtk::FILL | Gtk::EXPAND, Gtk::FILL);
139         ++_table_row;
140
141         _table.attach (sync_relative_label, 0, 1, _table_row, _table_row + 1, Gtk::FILL, Gtk::FILL);
142         _table.attach (sync_offset_relative_clock, 1, 2, _table_row, _table_row + 1, Gtk::FILL | Gtk::EXPAND, Gtk::FILL);
143         ++_table_row;
144
145         _table.attach (sync_absolute_label, 0, 1, _table_row, _table_row + 1, Gtk::FILL, Gtk::FILL);
146         _table.attach (sync_offset_absolute_clock, 1, 2, _table_row, _table_row + 1, Gtk::FILL | Gtk::EXPAND, Gtk::FILL);
147         ++_table_row;
148
149         _table.attach (start_label, 0, 1, _table_row, _table_row + 1, Gtk::FILL, Gtk::FILL);
150         _table.attach (start_clock, 1, 2, _table_row, _table_row + 1, Gtk::FILL | Gtk::EXPAND, Gtk::FILL);
151         ++_table_row;
152
153         _table.attach (_sources_label, 0, 1, _table_row, _table_row + 1, Gtk::FILL, Gtk::FILL);
154         _table.attach (_sources, 1, 2, _table_row, _table_row + 1, Gtk::FILL | Gtk::EXPAND, Gtk::FILL);
155         ++_table_row;
156
157         get_vbox()->pack_start (_table, true, true);
158
159         add_button (Gtk::Stock::CLOSE, Gtk::RESPONSE_ACCEPT);
160
161         set_name ("RegionEditorWindow");
162         add_events (Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK);
163
164         signal_delete_event().connect (sigc::bind (sigc::ptr_fun (just_hide_it), static_cast<Window *> (this)));
165         signal_response().connect (sigc::mem_fun (*this, &RegionEditor::handle_response));
166
167         set_title (string_compose (_("Region '%1'"), _region->name()));
168
169         for (uint32_t i = 0; i < _region->n_channels(); ++i) {
170                 _sources.append_text (_region->source(i)->name());
171         }
172
173         _sources.set_headers_visible (false);
174         Gtk::CellRendererText* t = dynamic_cast<Gtk::CellRendererText*> (_sources.get_column_cell_renderer(0));
175         assert (t);
176         t->property_ellipsize() = Pango::ELLIPSIZE_END;
177
178         show_all();
179
180         name_changed ();
181
182         PropertyChange change;
183
184         change.add (ARDOUR::Properties::start);
185         change.add (ARDOUR::Properties::length);
186         change.add (ARDOUR::Properties::position);
187         change.add (ARDOUR::Properties::sync_position);
188
189         bounds_changed (change);
190
191         _region->PropertyChanged.connect (state_connection, invalidator (*this), boost::bind (&RegionEditor::region_changed, this, _1), gui_context());
192
193         spin_arrow_grab = false;
194
195         connect_editor_events ();
196 }
197
198 RegionEditor::~RegionEditor ()
199 {
200         delete _clock_group;
201 }
202
203 void
204 RegionEditor::region_changed (const PBD::PropertyChange& what_changed)
205 {
206         if (what_changed.contains (ARDOUR::Properties::name)) {
207                 name_changed ();
208         }
209
210         PropertyChange interesting_stuff;
211
212         interesting_stuff.add (ARDOUR::Properties::position);
213         interesting_stuff.add (ARDOUR::Properties::length);
214         interesting_stuff.add (ARDOUR::Properties::start);
215         interesting_stuff.add (ARDOUR::Properties::sync_position);
216
217         if (what_changed.contains (interesting_stuff)) {
218                 bounds_changed (what_changed);
219         }
220 }
221
222 gint
223 RegionEditor::bpressed (GdkEventButton* ev, Gtk::SpinButton* /*but*/, void (RegionEditor::*/*pmf*/)())
224 {
225         switch (ev->button) {
226         case 1:
227         case 2:
228         case 3:
229                 if (ev->type == GDK_BUTTON_PRESS) { /* no double clicks here */
230                         if (!spin_arrow_grab) {
231                                 // GTK2FIX probably nuke the region editor
232                                 // if ((ev->window == but->gobj()->panel)) {
233                                 // spin_arrow_grab = true;
234                                 // (this->*pmf)();
235                                 // }
236                         }
237                 }
238                 break;
239         default:
240                 break;
241         }
242         return FALSE;
243 }
244
245 gint
246 RegionEditor::breleased (GdkEventButton* /*ev*/, Gtk::SpinButton* /*but*/, void (RegionEditor::*pmf)())
247 {
248         if (spin_arrow_grab) {
249                 (this->*pmf)();
250                 spin_arrow_grab = false;
251         }
252         return FALSE;
253 }
254
255 void
256 RegionEditor::connect_editor_events ()
257 {
258         name_entry.signal_changed().connect (sigc::mem_fun(*this, &RegionEditor::name_entry_changed));
259
260         position_clock.ValueChanged.connect (sigc::mem_fun(*this, &RegionEditor::position_clock_changed));
261         end_clock.ValueChanged.connect (sigc::mem_fun(*this, &RegionEditor::end_clock_changed));
262         length_clock.ValueChanged.connect (sigc::mem_fun(*this, &RegionEditor::length_clock_changed));
263         sync_offset_absolute_clock.ValueChanged.connect (sigc::mem_fun (*this, &RegionEditor::sync_offset_absolute_clock_changed));
264         sync_offset_relative_clock.ValueChanged.connect (sigc::mem_fun (*this, &RegionEditor::sync_offset_relative_clock_changed));
265
266         audition_button.signal_toggled().connect (sigc::mem_fun(*this, &RegionEditor::audition_button_toggled));
267
268         _session->AuditionActive.connect (audition_connection, invalidator (*this), boost::bind (&RegionEditor::audition_state_changed, this, _1), gui_context());
269 }
270
271 void
272 RegionEditor::position_clock_changed ()
273 {
274         _session->begin_reversible_command (_("change region start position"));
275
276         boost::shared_ptr<Playlist> pl = _region->playlist();
277
278         if (pl) {
279                 _region->clear_changes ();
280                 _region->set_position (position_clock.current_time());
281                 _session->add_command(new StatefulDiffCommand (_region));
282         }
283
284         _session->commit_reversible_command ();
285 }
286
287 void
288 RegionEditor::end_clock_changed ()
289 {
290         _session->begin_reversible_command (_("change region end position"));
291
292         boost::shared_ptr<Playlist> pl = _region->playlist();
293
294         if (pl) {
295                 _region->clear_changes ();
296                 _region->trim_end (end_clock.current_time());
297                 _session->add_command(new StatefulDiffCommand (_region));
298         }
299
300         _session->commit_reversible_command ();
301
302         end_clock.set (_region->position() + _region->length() - 1, true);
303 }
304
305 void
306 RegionEditor::length_clock_changed ()
307 {
308         framecnt_t frames = length_clock.current_time();
309
310         _session->begin_reversible_command (_("change region length"));
311
312         boost::shared_ptr<Playlist> pl = _region->playlist();
313
314         if (pl) {
315                 _region->clear_changes ();
316                 _region->trim_end (_region->position() + frames - 1);
317                 _session->add_command(new StatefulDiffCommand (_region));
318         }
319
320         _session->commit_reversible_command ();
321
322         length_clock.set (_region->length());
323 }
324
325 void
326 RegionEditor::audition_button_toggled ()
327 {
328         if (audition_button.get_active()) {
329                 _session->audition_region (_region);
330         } else {
331                 _session->cancel_audition ();
332         }
333 }
334
335 void
336 RegionEditor::name_changed ()
337 {
338         if (name_entry.get_text() != _region->name()) {
339                 name_entry.set_text (_region->name());
340         }
341 }
342
343 void
344 RegionEditor::bounds_changed (const PropertyChange& what_changed)
345 {
346         if (what_changed.contains (ARDOUR::Properties::position) && what_changed.contains (ARDOUR::Properties::length)) {
347                 position_clock.set (_region->position(), true);
348                 end_clock.set (_region->position() + _region->length() - 1, true);
349                 length_clock.set (_region->length(), true);
350         } else if (what_changed.contains (ARDOUR::Properties::position)) {
351                 position_clock.set (_region->position(), true);
352                 end_clock.set (_region->position() + _region->length() - 1, true);
353         } else if (what_changed.contains (ARDOUR::Properties::length)) {
354                 end_clock.set (_region->position() + _region->length() - 1, true);
355                 length_clock.set (_region->length(), true);
356         }
357
358         if (what_changed.contains (ARDOUR::Properties::sync_position) || what_changed.contains (ARDOUR::Properties::position)) {
359                 int dir;
360                 frameoffset_t off = _region->sync_offset (dir);
361                 if (dir == -1) {
362                         off = -off;
363                 }
364
365                 if (what_changed.contains (ARDOUR::Properties::sync_position)) {
366                         sync_offset_relative_clock.set (off, true);
367                 }
368
369                 sync_offset_absolute_clock.set (off + _region->position (), true);
370         }
371
372         if (what_changed.contains (ARDOUR::Properties::start)) {
373                 start_clock.set (_region->start(), true);
374         }
375 }
376
377 void
378 RegionEditor::activation ()
379 {
380
381 }
382
383 void
384 RegionEditor::name_entry_changed ()
385 {
386         if (name_entry.get_text() != _region->name()) {
387                 _region->set_name (name_entry.get_text());
388         }
389 }
390
391 void
392 RegionEditor::audition_state_changed (bool yn)
393 {
394         ENSURE_GUI_THREAD (*this, &RegionEditor::audition_state_changed, yn)
395
396         if (!yn) {
397                 audition_button.set_active (false);
398         }
399 }
400
401 void
402 RegionEditor::sync_offset_absolute_clock_changed ()
403 {
404         _session->begin_reversible_command (_("change region sync point"));
405
406         _region->clear_changes ();
407         _region->set_sync_position (sync_offset_absolute_clock.current_time());
408         _session->add_command (new StatefulDiffCommand (_region));
409
410         _session->commit_reversible_command ();
411 }
412
413 void
414 RegionEditor::sync_offset_relative_clock_changed ()
415 {
416         _session->begin_reversible_command (_("change region sync point"));
417
418         _region->clear_changes ();
419         _region->set_sync_position (sync_offset_relative_clock.current_time() + _region->position ());
420         _session->add_command (new StatefulDiffCommand (_region));
421
422         _session->commit_reversible_command ();
423 }
424
425 bool
426 RegionEditor::on_delete_event (GdkEventAny*)
427 {
428         PropertyChange change;
429
430         change.add (ARDOUR::Properties::start);
431         change.add (ARDOUR::Properties::length);
432         change.add (ARDOUR::Properties::position);
433         change.add (ARDOUR::Properties::sync_position);
434
435         bounds_changed (change);
436
437         return true;
438 }
439
440 void
441 RegionEditor::handle_response (int)
442 {
443         hide ();
444 }