fix load+save of plugin parameter automation
[ardour.git] / gtk2_ardour / audio_time_axis.cc
1 /*
2     Copyright (C) 2000-2006 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 <cstdlib>
21 #include <cmath>
22 #include <cassert>
23
24 #include <algorithm>
25 #include <string>
26 #include <vector>
27
28 #include <sigc++/bind.h>
29
30 #include "pbd/error.h"
31 #include "pbd/stl_delete.h"
32 #include "pbd/memento_command.h"
33
34 #include <gtkmm2ext/gtk_ui.h>
35 #include <gtkmm2ext/selector.h>
36 #include <gtkmm2ext/bindable_button.h>
37 #include <gtkmm2ext/utils.h>
38
39 #include "ardour/amp.h"
40 #include "ardour/audioplaylist.h"
41 #include "ardour/event_type_map.h"
42 #include "ardour/location.h"
43 #include "ardour/panner.h"
44 #include "ardour/playlist.h"
45 #include "ardour/processor.h"
46 #include "ardour/profile.h"
47 #include "ardour/session.h"
48 #include "ardour/session_playlist.h"
49 #include "ardour/utils.h"
50
51 #include "ardour_ui.h"
52 #include "audio_time_axis.h"
53 #include "automation_line.h"
54 #include "canvas_impl.h"
55 #include "crossfade_view.h"
56 #include "enums.h"
57 #include "gui_thread.h"
58 #include "automation_time_axis.h"
59 #include "keyboard.h"
60 #include "playlist_selector.h"
61 #include "prompter.h"
62 #include "public_editor.h"
63 #include "audio_region_view.h"
64 #include "simplerect.h"
65 #include "audio_streamview.h"
66 #include "utils.h"
67
68 #include "ardour/audio_track.h"
69
70 #include "i18n.h"
71
72 using namespace std;
73 using namespace ARDOUR;
74 using namespace PBD;
75 using namespace Gtk;
76 using namespace Editing;
77
78 AudioTimeAxisView::AudioTimeAxisView (PublicEditor& ed, Session* sess, boost::shared_ptr<Route> rt, Canvas& canvas)
79         : AxisView(sess)
80         , RouteTimeAxisView(ed, sess, rt, canvas)
81 {
82         // Make sure things are sane...
83         assert(!is_track() || is_audio_track());
84
85         subplugin_menu.set_name ("ArdourContextMenu");
86
87         _view = new AudioStreamView (*this);
88
89         ignore_toggle = false;
90
91         mute_button->set_active (false);
92         solo_button->set_active (false);
93
94         if (is_audio_track()) {
95                 controls_ebox.set_name ("AudioTrackControlsBaseUnselected");
96         } else { // bus
97                 controls_ebox.set_name ("AudioBusControlsBaseUnselected");
98         }
99
100         ensure_xml_node ();
101
102         set_state (*xml_node, Stateful::loading_state_version);
103
104         /* if set_state above didn't create a gain automation child, we need to make one */
105         if (automation_child (GainAutomation) == 0) {
106                 create_automation_child (GainAutomation, false);
107         }
108
109         if (_route->panner()) {
110                 _route->panner()->Changed.connect (*this, invalidator (*this), 
111                                                    boost::bind (&AudioTimeAxisView::ensure_pan_views, this, false), gui_context());
112         }
113
114         /* map current state of the route */
115
116         processors_changed (RouteProcessorChange ());
117         reset_processor_automation_curves ();
118         ensure_pan_views (false);
119         update_control_names ();
120
121         if (is_audio_track()) {
122
123                 /* ask for notifications of any new RegionViews */
124                 _view->RegionViewAdded.connect (sigc::mem_fun(*this, &AudioTimeAxisView::region_view_added));
125
126                 if (!_editor.have_idled()) {
127                         /* first idle will do what we need */
128                 } else {
129                         first_idle ();
130                 }
131
132         } else {
133                 post_construct ();
134         }
135 }
136
137 AudioTimeAxisView::~AudioTimeAxisView ()
138 {
139 }
140
141 void
142 AudioTimeAxisView::first_idle ()
143 {
144         _view->attach ();
145         post_construct ();
146 }
147
148 AudioStreamView*
149 AudioTimeAxisView::audio_view()
150 {
151         return dynamic_cast<AudioStreamView*>(_view);
152 }
153
154 guint32
155 AudioTimeAxisView::show_at (double y, int& nth, Gtk::VBox *parent)
156 {
157         ensure_xml_node ();
158         xml_node->add_property ("shown-editor", "yes");
159
160         return TimeAxisView::show_at (y, nth, parent);
161 }
162
163 void
164 AudioTimeAxisView::hide ()
165 {
166         ensure_xml_node ();
167         xml_node->add_property ("shown-editor", "no");
168
169         TimeAxisView::hide ();
170 }
171
172
173 void
174 AudioTimeAxisView::append_extra_display_menu_items ()
175 {
176         using namespace Menu_Helpers;
177
178         MenuList& items = display_menu->items();
179
180         // crossfade stuff
181         if (!Profile->get_sae()) {
182                 items.push_back (MenuElem (_("Hide All Crossfades"), sigc::mem_fun(*this, &AudioTimeAxisView::hide_all_xfades)));
183                 items.push_back (MenuElem (_("Show All Crossfades"), sigc::mem_fun(*this, &AudioTimeAxisView::show_all_xfades)));
184         }
185 }
186
187 void
188 AudioTimeAxisView::create_automation_child (const Evoral::Parameter& param, bool show)
189 {
190         if (param.type() == GainAutomation) {
191
192                 boost::shared_ptr<AutomationControl> c = _route->gain_control();
193                 if (!c) {
194                         error << "Route has no gain automation, unable to add automation track view." << endmsg;
195                         return;
196                 }
197
198                 gain_track.reset (new AutomationTimeAxisView (_session,
199                                                               _route, _route->amp(), c,
200                                                               _editor,
201                                                               *this,
202                                                               false,
203                                                               parent_canvas,
204                                                               _route->amp()->describe_parameter(param)));
205
206                 add_automation_child(Evoral::Parameter(GainAutomation), gain_track, show);
207
208         } else if (param.type() == PanAutomation) {
209
210                 ensure_xml_node ();
211                 ensure_pan_views (show);
212
213         } else if (param.type() == PluginAutomation) {
214                 
215                 /* handled elsewhere */
216
217         } else {
218                 error << "AudioTimeAxisView: unknown automation child " << EventTypeMap::instance().to_symbol(param) << endmsg;
219         }
220 }
221
222 /** Ensure that we have the appropriate AutomationTimeAxisViews for the
223  *  panners that we have.
224  *
225  *  @param show true to show any new views that we create, otherwise false.
226  */
227 void
228 AudioTimeAxisView::ensure_pan_views (bool show)
229 {
230         if (!_route->panner()) {
231                 return;
232         }
233
234         const set<Evoral::Parameter>& params = _route->panner()->what_can_be_automated();
235         set<Evoral::Parameter>::iterator p;
236
237         for (p = params.begin(); p != params.end(); ++p) {
238                 boost::shared_ptr<ARDOUR::AutomationControl> pan_control
239                         = boost::dynamic_pointer_cast<ARDOUR::AutomationControl>(
240                                 _route->panner()->control(*p));
241
242                 if (pan_control->parameter().type() == NullAutomation) {
243                         error << "Pan control has NULL automation type!" << endmsg;
244                         continue;
245                 }
246
247                 if (automation_child (pan_control->parameter ()).get () == 0) {
248
249                         /* we don't already have an AutomationTimeAxisView for this parameter */
250
251                         std::string const name = _route->panner()->describe_parameter (pan_control->parameter ());
252
253                         boost::shared_ptr<AutomationTimeAxisView> t (
254                                 new AutomationTimeAxisView (_session,
255                                                             _route, _route->panner(), pan_control,
256                                                             _editor,
257                                                             *this,
258                                                             false,
259                                                             parent_canvas,
260                                                             name)
261                                 );
262
263                         pan_tracks.push_back (t);
264                         add_automation_child (*p, t, show);
265                 }
266         }
267 }
268
269 void
270 AudioTimeAxisView::update_gain_track_visibility ()
271 {
272         bool const showit = gain_automation_item->get_active();
273
274         if (showit != gain_track->marked_for_display()) {
275                 if (showit) {
276                         gain_track->set_marked_for_display (true);
277                         gain_track->canvas_display()->show();
278                         gain_track->canvas_background()->show();
279                         gain_track->get_state_node()->add_property ("shown", X_("yes"));
280                 } else {
281                         gain_track->set_marked_for_display (false);
282                         gain_track->hide ();
283                         gain_track->get_state_node()->add_property ("shown", X_("no"));
284                 }
285
286                 /* now trigger a redisplay */
287
288                 if (!no_redraw) {
289                          _route->gui_changed (X_("visible_tracks"), (void *) 0); /* EMIT_SIGNAL */
290                 }
291         }
292 }
293
294 void
295 AudioTimeAxisView::update_pan_track_visibility ()
296 {
297         bool const showit = pan_automation_item->get_active();
298
299         for (list<boost::shared_ptr<AutomationTimeAxisView> >::iterator i = pan_tracks.begin(); i != pan_tracks.end(); ++i) {
300
301                 if (showit != (*i)->marked_for_display()) {
302                         if (showit) {
303                                 (*i)->set_marked_for_display (true);
304                                 (*i)->canvas_display()->show();
305                                 (*i)->canvas_background()->show();
306                                 (*i)->get_state_node()->add_property ("shown", X_("yes"));
307                         } else {
308                                 (*i)->set_marked_for_display (false);
309                                 (*i)->hide ();
310                                 (*i)->get_state_node()->add_property ("shown", X_("no"));
311                         }
312                         
313                         /* now trigger a redisplay */
314                         if (!no_redraw) {
315                                 _route->gui_changed (X_("visible_tracks"), (void *) 0); /* EMIT_SIGNAL */
316                         }
317                 }
318         }
319 }
320
321 void
322 AudioTimeAxisView::show_all_automation ()
323 {
324         no_redraw = true;
325
326         RouteTimeAxisView::show_all_automation ();
327
328         no_redraw = false;
329
330         _route->gui_changed ("track_height", (void *) 0); /* EMIT_SIGNAL */
331 }
332
333 void
334 AudioTimeAxisView::show_existing_automation ()
335 {
336         no_redraw = true;
337
338         RouteTimeAxisView::show_existing_automation ();
339
340         no_redraw = false;
341
342         _route->gui_changed ("track_height", (void *) 0); /* EMIT_SIGNAL */
343 }
344
345 void
346 AudioTimeAxisView::hide_all_automation ()
347 {
348         no_redraw = true;
349
350         RouteTimeAxisView::hide_all_automation();
351
352         no_redraw = false;
353         _route->gui_changed ("track_height", (void *) 0); /* EMIT_SIGNAL */
354 }
355
356 void
357 AudioTimeAxisView::show_all_xfades ()
358 {
359         AudioStreamView* asv = audio_view();
360
361         if (asv) {
362                 asv->show_all_xfades ();
363         }
364 }
365
366 void
367 AudioTimeAxisView::hide_all_xfades ()
368 {
369         AudioStreamView* asv = audio_view();
370
371         if (asv) {
372                 asv->hide_all_xfades ();
373         }
374 }
375
376 void
377 AudioTimeAxisView::hide_dependent_views (TimeAxisViewItem& tavi)
378 {
379         AudioStreamView* asv = audio_view();
380         AudioRegionView* rv;
381
382         if (asv && (rv = dynamic_cast<AudioRegionView*>(&tavi)) != 0) {
383                 asv->hide_xfades_involving (*rv);
384         }
385 }
386
387 void
388 AudioTimeAxisView::reveal_dependent_views (TimeAxisViewItem& tavi)
389 {
390         AudioStreamView* asv = audio_view();
391         AudioRegionView* rv;
392
393         if (asv && (rv = dynamic_cast<AudioRegionView*>(&tavi)) != 0) {
394                 asv->reveal_xfades_involving (*rv);
395         }
396 }
397
398 void
399 AudioTimeAxisView::route_active_changed ()
400 {
401         RouteTimeAxisView::route_active_changed ();
402         update_control_names ();
403 }
404
405
406 /**
407  *    Set up the names of the controls so that they are coloured
408  *    correctly depending on whether this route is inactive or
409  *    selected.
410  */
411
412 void
413 AudioTimeAxisView::update_control_names ()
414 {
415         if (is_audio_track()) {
416                 if (_route->active()) {
417                         controls_base_selected_name = "AudioTrackControlsBaseSelected";
418                         controls_base_unselected_name = "AudioTrackControlsBaseUnselected";
419                 } else {
420                         controls_base_selected_name = "AudioTrackControlsBaseInactiveSelected";
421                         controls_base_unselected_name = "AudioTrackControlsBaseInactiveUnselected";
422                 }
423         } else {
424                 if (_route->active()) {
425                         controls_base_selected_name = "BusControlsBaseSelected";
426                         controls_base_unselected_name = "BusControlsBaseUnselected";
427                 } else {
428                         controls_base_selected_name = "BusControlsBaseInactiveSelected";
429                         controls_base_unselected_name = "BusControlsBaseInactiveUnselected";
430                 }
431         }
432
433         if (get_selected()) {
434                 controls_ebox.set_name (controls_base_selected_name);
435         } else {
436                 controls_ebox.set_name (controls_base_unselected_name);
437         }
438 }
439
440 void
441 AudioTimeAxisView::build_automation_action_menu ()
442 {
443         using namespace Menu_Helpers;
444
445         RouteTimeAxisView::build_automation_action_menu ();
446
447         MenuList& automation_items = automation_action_menu->items ();
448
449         automation_items.push_back (CheckMenuElem (_("Fader"), sigc::mem_fun (*this, &AudioTimeAxisView::update_gain_track_visibility)));
450         gain_automation_item = dynamic_cast<CheckMenuItem*> (&automation_items.back ());
451         gain_automation_item->set_active (gain_track->marked_for_display ());
452
453         _main_automation_menu_map[Evoral::Parameter(GainAutomation)] = gain_automation_item;
454
455         automation_items.push_back (CheckMenuElem (_("Pan"), sigc::mem_fun (*this, &AudioTimeAxisView::update_pan_track_visibility)));
456         pan_automation_item = dynamic_cast<CheckMenuItem*> (&automation_items.back ());
457         pan_automation_item->set_active (pan_tracks.front()->marked_for_display ());
458
459         set<Evoral::Parameter> const & params = _route->panner()->what_can_be_automated ();
460         for (set<Evoral::Parameter>::iterator p = params.begin(); p != params.end(); ++p) {
461                 _main_automation_menu_map[*p] = pan_automation_item;
462         }
463 }
464
465 void
466 AudioTimeAxisView::add_processor_to_subplugin_menu (boost::weak_ptr<Processor> wp)
467 {
468         /* we use this override to veto the Amp processor from the plugin menu,
469            as its automation lane can be accessed using the special "Fader" menu
470            option
471         */
472         
473         boost::shared_ptr<Processor> p = wp.lock ();
474         if (!p) {
475                 return;
476         }
477
478         if (boost::dynamic_pointer_cast<Amp> (p) == 0) {
479                 RouteTimeAxisView::add_processor_to_subplugin_menu (wp);
480         }
481 }