Allow strips to add or remove personal sends
[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 "automation_region_view.h"
33 #include "editing.h"
34 #include "editor.h"
35 #include "editor_drag.h"
36 #include "gui_thread.h"
37 #include "midi_automation_line.h"
38 #include "public_editor.h"
39 #include "ui_config.h"
40
41 #include "pbd/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         TimeAxisViewItem::set_position (_region->position(), this);
56
57         if (list) {
58                 assert(list->parameter() == param);
59                 create_line(list);
60         }
61
62         group->raise_to_top();
63
64         trackview.editor().MouseModeChanged.connect(_mouse_mode_connection, invalidator (*this),
65                                                     boost::bind (&AutomationRegionView::mouse_mode_changed, this),
66                                                     gui_context ());
67 }
68
69 AutomationRegionView::~AutomationRegionView ()
70 {
71         in_destructor = true;
72         RegionViewGoingAway (this); /* EMIT_SIGNAL */
73 }
74
75 void
76 AutomationRegionView::init (bool /*wfd*/)
77 {
78         _enable_display = false;
79
80         RegionView::init (false);
81
82         reset_width_dependent_items ((double) _region->length() / samples_per_pixel);
83
84         set_height (trackview.current_height());
85
86         fill_color_name = "midi frame base";
87         set_colors ();
88
89         _enable_display = true;
90 }
91
92 void
93 AutomationRegionView::create_line (boost::shared_ptr<ARDOUR::AutomationList> list)
94 {
95         _line = boost::shared_ptr<AutomationLine> (new MidiAutomationLine(
96                                 ARDOUR::EventTypeMap::instance().to_symbol(list->parameter()),
97                                 trackview, *get_canvas_group(), list,
98                                 boost::dynamic_pointer_cast<ARDOUR::MidiRegion> (_region),
99                                 _parameter,
100                                 &_source_relative_time_converter));
101         _line->set_colors();
102         _line->set_height ((uint32_t)rint(trackview.current_height() - 2.5 - NAME_HIGHLIGHT_SIZE));
103         _line->set_visibility (AutomationLine::VisibleAspects (AutomationLine::Line|AutomationLine::ControlPoints));
104         _line->set_maximum_time (_region->length());
105         _line->set_offset (_region->start ());
106 }
107
108 uint32_t
109 AutomationRegionView::get_fill_color() const
110 {
111         const std::string mod_name = (_dragging ? "dragging region" :
112                                       trackview.editor().internal_editing() ? "editable region" :
113                                       "midi frame base");
114         if (_selected) {
115                 return UIConfiguration::instance().color_mod ("selected region base", mod_name);
116         } else if (high_enough_for_name || !UIConfiguration::instance().get_color_regions_using_track_color()) {
117                 return UIConfiguration::instance().color_mod ("midi frame base", mod_name);
118         }
119         return UIConfiguration::instance().color_mod (fill_color, mod_name);
120 }
121
122 void
123 AutomationRegionView::mouse_mode_changed ()
124 {
125         // Adjust sample colour (become more transparent for internal tools)
126         set_sample_color();
127 }
128
129 bool
130 AutomationRegionView::canvas_group_event (GdkEvent* ev)
131 {
132         if (in_destructor) {
133                 return false;
134         }
135
136         PublicEditor& e = trackview.editor ();
137
138         if (trackview.editor().internal_editing() &&
139             ev->type == GDK_BUTTON_RELEASE &&
140             ev->button.button == 1 &&
141             e.current_mouse_mode() == Editing::MouseDraw &&
142             !e.drags()->active()) {
143
144                 double x = ev->button.x;
145                 double y = ev->button.y;
146
147                 /* convert to item coordinates in the time axis view */
148                 automation_view()->canvas_display()->canvas_to_item (x, y);
149
150                 /* clamp y */
151                 y = std::max (y, 0.0);
152                 y = std::min (y, _height - NAME_HIGHLIGHT_SIZE);
153
154                 /* guard points only if primary modifier is used */
155                 bool with_guard_points = Gtkmm2ext::Keyboard::modifier_state_equals (ev->button.state, Gtkmm2ext::Keyboard::PrimaryModifier);
156                 add_automation_event (ev, e.pixel_to_sample (x) - _region->position() + _region->start(), y, with_guard_points);
157                 return true;
158         }
159
160         return RegionView::canvas_group_event (ev);
161 }
162
163 /** @param when Position in samples, where 0 is the start of the region.
164  *  @param y y position, relative to our TimeAxisView.
165  */
166 void
167 AutomationRegionView::add_automation_event (GdkEvent *, samplepos_t when, double y, bool with_guard_points)
168 {
169         if (!_line) {
170                 boost::shared_ptr<Evoral::Control> c = _region->control(_parameter, true);
171                 boost::shared_ptr<ARDOUR::AutomationControl> ac
172                                 = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(c);
173                 assert(ac);
174                 create_line(ac->alist());
175         }
176         assert(_line);
177
178         AutomationTimeAxisView* const view = automation_view ();
179
180         /* compute vertical fractional position */
181
182         const double h = trackview.current_height() - TimeAxisViewItem::NAME_HIGHLIGHT_SIZE - 2;
183         y = 1.0 - (y / h);
184
185         /* snap sample */
186
187         when = snap_sample_to_sample (when - _region->start ()).sample + _region->start ();
188
189         /* map using line */
190
191         double when_d = when;
192         _line->view_to_model_coord (when_d, y);
193
194         XMLNode& before = _line->the_list()->get_state();
195
196         if (_line->the_list()->editor_add (when_d, y, with_guard_points)) {
197                 view->editor().begin_reversible_command (_("add automation event"));
198
199                 XMLNode& after = _line->the_list()->get_state();
200
201                 view->session()->add_command (new MementoCommand<ARDOUR::AutomationList> (_line->memento_command_binder(), &before, &after));
202                 view->editor().commit_reversible_command ();
203
204                 view->session()->set_dirty ();
205         }
206 }
207
208 bool
209 AutomationRegionView::paste (samplepos_t                                      pos,
210                              unsigned                                        paste_count,
211                              float                                           times,
212                              boost::shared_ptr<const ARDOUR::AutomationList> slist)
213 {
214         using namespace ARDOUR;
215
216         AutomationTimeAxisView* const             view    = automation_view();
217         boost::shared_ptr<ARDOUR::AutomationList> my_list = _line->the_list();
218
219         if (view->session()->transport_rolling() && my_list->automation_write()) {
220                 /* do not paste if this control is in write mode and we're rolling */
221                 return false;
222         }
223
224         AutomationType src_type = (AutomationType)slist->parameter().type ();
225         double len = slist->length();
226
227         /* add multi-paste offset if applicable */
228         if (parameter_is_midi (src_type)) {
229                 // convert length to samples (incl tempo-ramps)
230                 len = DoubleBeatsSamplesConverter (view->session()->tempo_map(), pos).to (len * paste_count);
231                 pos += view->editor ().get_paste_offset (pos, paste_count > 0 ? 1 : 0, len);
232         } else {
233                 pos += view->editor ().get_paste_offset (pos, paste_count, len);
234         }
235
236         /* convert sample-position to model's unit and position */
237         const double model_pos = _source_relative_time_converter.from (
238                 pos - _source_relative_time_converter.origin_b());
239
240         XMLNode& before = my_list->get_state();
241         my_list->paste(*slist, model_pos, DoubleBeatsSamplesConverter (view->session()->tempo_map(), pos));
242         view->session()->add_command(
243                 new MementoCommand<ARDOUR::AutomationList>(_line->memento_command_binder(), &before, &my_list->get_state()));
244
245         return true;
246 }
247
248 void
249 AutomationRegionView::set_height (double h)
250 {
251         RegionView::set_height(h);
252
253         if (_line) {
254                 _line->set_height ((uint32_t)rint(h - 2.5 - NAME_HIGHLIGHT_SIZE));
255         }
256 }
257
258 bool
259 AutomationRegionView::set_position (samplepos_t pos, void* src, double* ignored)
260 {
261         if (_line) {
262                 _line->set_maximum_time (_region->length ());
263         }
264
265         return RegionView::set_position(pos, src, ignored);
266 }
267
268
269 void
270 AutomationRegionView::reset_width_dependent_items (double pixel_width)
271 {
272         RegionView::reset_width_dependent_items(pixel_width);
273
274         if (_line) {
275                 _line->reset();
276         }
277 }
278
279
280 void
281 AutomationRegionView::region_resized (const PBD::PropertyChange& what_changed)
282 {
283         RegionView::region_resized (what_changed);
284
285         if (what_changed.contains (ARDOUR::Properties::position)) {
286                 _region_relative_time_converter.set_origin_b(_region->position());
287         }
288
289         if (what_changed.contains (ARDOUR::Properties::start) ||
290             what_changed.contains (ARDOUR::Properties::position)) {
291                 _source_relative_time_converter.set_origin_b (_region->position() - _region->start());
292         }
293
294         if (!_line) {
295                 return;
296         }
297
298         if (what_changed.contains (ARDOUR::Properties::start)) {
299                 _line->set_offset (_region->start ());
300         }
301
302         if (what_changed.contains (ARDOUR::Properties::length)) {
303                 _line->set_maximum_time (_region->length());
304         }
305 }
306
307
308 void
309 AutomationRegionView::entered ()
310 {
311         if (_line) {
312                 _line->track_entered();
313         }
314 }
315
316
317 void
318 AutomationRegionView::exited ()
319 {
320         if (_line) {
321                 _line->track_exited();
322         }
323 }