Keep automation lines within their parent (#6215).
[ardour.git] / gtk2_ardour / automation_region_view.cc
1 /*
2     Copyright (C) 2007 Paul Davis
3     Author: David Robillard
4
5     This program is free software; you can redistribute it and/or modify
6     it under the terms of the GNU General Public License as published by
7     the Free Software Foundation; either version 2 of the License, or
8     (at your option) any later version.
9
10     This program is distributed in the hope that it will be useful,
11     but WITHOUT ANY WARRANTY; without even the implied warranty of
12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13     GNU General Public License for more details.
14
15     You should have received a copy of the GNU General Public License
16     along with this program; if not, write to the Free Software
17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 */
19
20 #include <utility>
21
22 #include "pbd/memento_command.h"
23
24 #include "ardour/automation_control.h"
25 #include "ardour/event_type_map.h"
26 #include "ardour/midi_automation_list_binder.h"
27 #include "ardour/midi_region.h"
28 #include "ardour/session.h"
29
30 #include "gtkmm2ext/keyboard.h"
31
32 #include "ardour_ui.h"
33 #include "automation_region_view.h"
34 #include "editing.h"
35 #include "editor.h"
36 #include "editor_drag.h"
37 #include "gui_thread.h"
38 #include "midi_automation_line.h"
39 #include "public_editor.h"
40
41 #include "i18n.h"
42
43 AutomationRegionView::AutomationRegionView (ArdourCanvas::Container*                  parent,
44                                             AutomationTimeAxisView&                   time_axis,
45                                             boost::shared_ptr<ARDOUR::Region>         region,
46                                             const Evoral::Parameter&                  param,
47                                             boost::shared_ptr<ARDOUR::AutomationList> list,
48                                             double                                    spu,
49                                             uint32_t                                  basic_color)
50         : RegionView(parent, time_axis, region, spu, basic_color, true)
51         , _region_relative_time_converter(region->session().tempo_map(), region->position())
52         , _source_relative_time_converter(region->session().tempo_map(), region->position() - region->start())
53         , _parameter(param)
54 {
55         if (list) {
56                 assert(list->parameter() == param);
57                 create_line(list);
58         }
59
60         group->raise_to_top();
61
62         trackview.editor().MouseModeChanged.connect(_mouse_mode_connection, invalidator (*this),
63                                                     boost::bind (&AutomationRegionView::mouse_mode_changed, this),
64                                                     gui_context ());
65 }
66
67 AutomationRegionView::~AutomationRegionView ()
68 {
69         RegionViewGoingAway (this); /* EMIT_SIGNAL */
70 }
71
72 void
73 AutomationRegionView::init (bool /*wfd*/)
74 {
75         _enable_display = false;
76
77         RegionView::init (false);
78
79         reset_width_dependent_items ((double) _region->length() / samples_per_pixel);
80
81         set_height (trackview.current_height());
82
83         fill_color_name = "midi frame base";
84         set_colors ();
85
86         _enable_display = true;
87 }
88
89 void
90 AutomationRegionView::create_line (boost::shared_ptr<ARDOUR::AutomationList> list)
91 {
92         _line = boost::shared_ptr<AutomationLine> (new MidiAutomationLine(
93                                 ARDOUR::EventTypeMap::instance().to_symbol(list->parameter()),
94                                 trackview, *get_canvas_group(), list,
95                                 boost::dynamic_pointer_cast<ARDOUR::MidiRegion> (_region),
96                                 _parameter,
97                                 &_source_relative_time_converter));
98         _line->set_colors();
99         _line->set_height ((uint32_t)rint(trackview.current_height() - 2.5 - NAME_HIGHLIGHT_SIZE));
100         _line->set_visibility (AutomationLine::VisibleAspects (AutomationLine::Line|AutomationLine::ControlPoints));
101         _line->set_maximum_time (_region->length());
102         _line->set_offset (_region->start ());
103 }
104
105 uint32_t
106 AutomationRegionView::get_fill_color() const
107 {
108         const std::string mod_name = (_dragging ? "dragging region" :
109                                       trackview.editor().internal_editing() ? "editable region" :
110                                       "midi frame base");
111         if (_selected) {
112                 return ARDOUR_UI::config()->color_mod ("selected region base", mod_name);
113         } else if (high_enough_for_name || !ARDOUR_UI::config()->get_color_regions_using_track_color()) {
114                 return ARDOUR_UI::config()->color_mod ("midi frame base", mod_name);
115         }
116         return ARDOUR_UI::config()->color_mod (fill_color, mod_name);
117 }
118
119 void
120 AutomationRegionView::mouse_mode_changed ()
121 {
122         // Adjust frame colour (become more transparent for internal tools)
123         set_frame_color();
124 }
125
126 bool
127 AutomationRegionView::canvas_group_event (GdkEvent* ev)
128 {
129         if (in_destructor) {
130                 return false;
131         }
132
133         PublicEditor& e = trackview.editor ();
134
135         if (trackview.editor().internal_editing() &&
136             ev->type == GDK_BUTTON_RELEASE &&
137             e.current_mouse_mode() == Editing::MouseDraw &&
138             !e.drags()->active()) {
139
140                 double x = ev->button.x;
141                 double y = ev->button.y;
142
143                 /* convert to item coordinates in the time axis view */
144                 automation_view()->canvas_display()->canvas_to_item (x, y);
145
146                 /* clamp y */
147                 y = std::max (y, 0.0);
148                 y = std::min (y, _height - NAME_HIGHLIGHT_SIZE);
149
150                 /* guard points only if primary modifier is used */
151                 bool with_guard_points = Gtkmm2ext::Keyboard::modifier_state_equals (ev->button.state, Gtkmm2ext::Keyboard::PrimaryModifier);
152                 add_automation_event (ev, e.pixel_to_sample (x) - _region->position() + _region->start(), y, with_guard_points);
153                 return true;
154         }
155
156         return RegionView::canvas_group_event (ev);
157 }
158
159 /** @param when Position in frames, where 0 is the start of the region.
160  *  @param y y position, relative to our TimeAxisView.
161  */
162 void
163 AutomationRegionView::add_automation_event (GdkEvent *, framepos_t when, double y, bool with_guard_points)
164 {
165         if (!_line) {
166                 boost::shared_ptr<Evoral::Control> c = _region->control(_parameter, true);
167                 boost::shared_ptr<ARDOUR::AutomationControl> ac
168                                 = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(c);
169                 assert(ac);
170                 create_line(ac->alist());
171         }
172         assert(_line);
173
174         AutomationTimeAxisView* const view = automation_view ();
175
176         /* compute vertical fractional position */
177
178         const double h = trackview.current_height() - TimeAxisViewItem::NAME_HIGHLIGHT_SIZE - 2;
179         y = 1.0 - (y / h);
180
181         /* snap frame */
182
183         when = snap_frame_to_frame (when - _region->start ()) + _region->start ();
184
185         /* map using line */
186
187         double when_d = when;
188         _line->view_to_model_coord (when_d, y);
189
190         view->editor().begin_reversible_command (_("add automation event"));
191         XMLNode& before = _line->the_list()->get_state();
192
193         _line->the_list()->add (when_d, y, with_guard_points, false);
194
195         XMLNode& after = _line->the_list()->get_state();
196
197         view->session()->add_command (new MementoCommand<ARDOUR::AutomationList> (_line->memento_command_binder(), &before, &after));
198         view->editor().commit_reversible_command ();
199
200         view->session()->set_dirty ();
201 }
202
203 bool
204 AutomationRegionView::paste (framepos_t                                      pos,
205                              unsigned                                        paste_count,
206                              float                                           times,
207                              boost::shared_ptr<const ARDOUR::AutomationList> slist)
208 {
209         AutomationTimeAxisView* const             view    = automation_view();
210         boost::shared_ptr<ARDOUR::AutomationList> my_list = _line->the_list();
211
212         if (view->session()->transport_rolling() && my_list->automation_write()) {
213                 /* do not paste if this control is in write mode and we're rolling */
214                 return false;
215         }
216
217         /* add multi-paste offset if applicable */
218         pos += view->editor().get_paste_offset(
219                 pos, paste_count, _source_relative_time_converter.to(slist->length()));
220
221         const double model_pos = _source_relative_time_converter.from(
222                 pos - _source_relative_time_converter.origin_b());
223
224         XMLNode& before = my_list->get_state();
225         my_list->paste(*slist, model_pos, times);
226         view->session()->add_command(
227                 new MementoCommand<ARDOUR::AutomationList>(_line->memento_command_binder(), &before, &my_list->get_state()));
228
229         return true;
230 }
231
232 void
233 AutomationRegionView::set_height (double h)
234 {
235         RegionView::set_height(h);
236
237         if (_line) {
238                 _line->set_height ((uint32_t)rint(h - 2.5 - NAME_HIGHLIGHT_SIZE));
239         }
240 }
241
242 bool
243 AutomationRegionView::set_position (framepos_t pos, void* src, double* ignored)
244 {
245         if (_line) {
246                 _line->set_maximum_time (_region->length ());
247         }
248
249         return RegionView::set_position(pos, src, ignored);
250 }
251
252
253 void
254 AutomationRegionView::reset_width_dependent_items (double pixel_width)
255 {
256         RegionView::reset_width_dependent_items(pixel_width);
257
258         if (_line) {
259                 _line->reset();
260         }
261 }
262
263
264 void
265 AutomationRegionView::region_resized (const PBD::PropertyChange& what_changed)
266 {
267         RegionView::region_resized (what_changed);
268
269         if (what_changed.contains (ARDOUR::Properties::position)) {
270                 _region_relative_time_converter.set_origin_b(_region->position());
271         }
272
273         if (what_changed.contains (ARDOUR::Properties::start) ||
274             what_changed.contains (ARDOUR::Properties::position)) {
275                 _source_relative_time_converter.set_origin_b (_region->position() - _region->start());
276         }
277
278         if (!_line) {
279                 return;
280         }
281
282         if (what_changed.contains (ARDOUR::Properties::start)) {
283                 _line->set_offset (_region->start ());
284         }
285
286         if (what_changed.contains (ARDOUR::Properties::length)) {
287                 _line->set_maximum_time (_region->length());
288         }
289 }
290
291
292 void
293 AutomationRegionView::entered ()
294 {
295         if (_line) {
296                 _line->track_entered();
297         }
298 }
299
300
301 void
302 AutomationRegionView::exited ()
303 {
304         if (_line) {
305                 _line->track_exited();
306         }
307 }