Eliminate a ton of unnecessary complete redrawing in MIDI stream views:
[ardour.git] / gtk2_ardour / midi_time_axis.cc
1 /*
2     Copyright (C) 2000 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 #include <cstdlib>
20 #include <cmath>
21
22 #include <algorithm>
23 #include <string>
24 #include <vector>
25
26 #include <sigc++/bind.h>
27
28 #include <pbd/error.h>
29 #include <pbd/stl_delete.h>
30 #include <pbd/whitespace.h>
31
32 #include <gtkmm2ext/gtk_ui.h>
33 #include <gtkmm2ext/selector.h>
34 #include <gtkmm2ext/stop_signal.h>
35 #include <gtkmm2ext/bindable_button.h>
36 #include <gtkmm2ext/utils.h>
37
38 #include <ardour/midi_playlist.h>
39 #include <ardour/midi_diskstream.h>
40 #include <ardour/processor.h>
41 #include <ardour/ladspa_plugin.h>
42 #include <ardour/location.h>
43 #include <ardour/playlist.h>
44 #include <ardour/session.h>
45 #include <ardour/session_playlist.h>
46 #include <ardour/utils.h>
47
48 #include "ardour_ui.h"
49 #include "midi_time_axis.h"
50 #include "automation_time_axis.h"
51 #include "automation_line.h"
52 #include "add_midi_cc_track_dialog.h"
53 #include "canvas_impl.h"
54 #include "crossfade_view.h"
55 #include "enums.h"
56 #include "gui_thread.h"
57 #include "keyboard.h"
58 #include "playlist_selector.h"
59 #include "plugin_selector.h"
60 #include "plugin_ui.h"
61 #include "point_selection.h"
62 #include "prompter.h"
63 #include "public_editor.h"
64 #include "region_view.h"
65 #include "rgb_macros.h"
66 #include "selection.h"
67 #include "simplerect.h"
68 #include "midi_streamview.h"
69 #include "utils.h"
70 #include "midi_scroomer.h"
71 #include "piano_roll_header.h"
72 #include "ghostregion.h"
73
74 #include <ardour/midi_track.h>
75
76 #include "i18n.h"
77
78 using namespace ARDOUR;
79 using namespace PBD;
80 using namespace Gtk;
81 using namespace sigc;
82 using namespace Editing;
83
84
85 MidiTimeAxisView::MidiTimeAxisView (PublicEditor& ed, Session& sess, boost::shared_ptr<Route> rt, Canvas& canvas)
86         : AxisView(sess) // virtually inherited
87         , RouteTimeAxisView(ed, sess, rt, canvas)
88         , _ignore_signals(false)  
89         , _range_scroomer(0)
90         , _piano_roll_header(0)
91         , _note_mode(Sustained)
92         , _note_mode_item(NULL)
93         , _percussion_mode_item(NULL)
94         , _midi_expander("MIDI")
95 {
96         subplugin_menu.set_name ("ArdourContextMenu");
97
98         _view = new MidiStreamView (*this);
99
100         ignore_toggle = false;
101
102         mute_button->set_active (false);
103         solo_button->set_active (false);
104         
105         if (is_midi_track()) {
106                 controls_ebox.set_name ("MidiTimeAxisViewControlsBaseUnselected");
107                 _note_mode = midi_track()->note_mode();
108         } else { // MIDI bus (which doesn't exist yet..)
109                 controls_ebox.set_name ("MidiBusControlsBaseUnselected");
110         }
111
112         /* map current state of the route */
113
114         processors_changed ();
115
116         ensure_xml_node ();
117
118         set_state (*xml_node);
119         
120         _route->processors_changed.connect (mem_fun(*this, &MidiTimeAxisView::processors_changed));
121
122         if (is_track()) {
123                 _piano_roll_header = new PianoRollHeader(*midi_view());
124                 _range_scroomer = new MidiScroomer(midi_view()->note_range_adjustment);
125
126                 controls_hbox.pack_start(*_range_scroomer);
127                 controls_hbox.pack_start(*_piano_roll_header);
128
129                 controls_ebox.set_name ("MidiTrackControlsBaseUnselected");
130                 controls_base_selected_name = "MidiTrackControlsBaseSelected";
131                 controls_base_unselected_name = "MidiTrackControlsBaseUnselected";
132
133                 midi_view()->NoteRangeChanged.connect (mem_fun(*this, &MidiTimeAxisView::update_range));
134
135                 /* ask for notifications of any new RegionViews */
136                 _view->RegionViewAdded.connect (mem_fun(*this, &MidiTimeAxisView::region_view_added));
137                 _view->attach ();
138         }
139                 
140         // add channel selector expander
141         HBox *channel_selector_box = manage(new HBox());
142         channel_selector_box->pack_start(_channel_selector, SHRINK, 0);
143         _midi_expander.add(*channel_selector_box);
144         _midi_expander.property_expanded().signal_changed().connect(
145                         mem_fun(this, &MidiTimeAxisView::channel_selector_toggled));
146         controls_vbox.pack_end(_midi_expander, SHRINK, 0);
147         boost::shared_ptr<MidiDiskstream> diskstream = midi_track()->midi_diskstream();
148
149         // restore channel selector settings
150         _channel_selector.set_channel_mode(diskstream->get_channel_mode(), diskstream->get_channel_mask());
151         _channel_selector.mode_changed.connect(
152                 mem_fun(*midi_track()->midi_diskstream(), &MidiDiskstream::set_channel_mode));
153
154 }
155
156 MidiTimeAxisView::~MidiTimeAxisView ()
157 {
158         delete _piano_roll_header;
159         _piano_roll_header = 0;
160
161         delete _range_scroomer;
162         _range_scroomer = 0;
163 }
164
165 MidiStreamView*
166 MidiTimeAxisView::midi_view()
167 {
168         return dynamic_cast<MidiStreamView*>(_view);
169 }
170
171 guint32
172 MidiTimeAxisView::show_at (double y, int& nth, Gtk::VBox *parent)
173 {
174         ensure_xml_node ();
175         xml_node->add_property ("shown_editor", "yes");
176                 
177         guint32 ret = TimeAxisView::show_at (y, nth, parent);
178         _piano_roll_header->show();
179         _range_scroomer->show();
180         return ret;
181 }
182
183 void
184 MidiTimeAxisView::hide ()
185 {
186         ensure_xml_node ();
187         xml_node->add_property ("shown_editor", "no");
188
189         TimeAxisView::hide ();
190 }
191
192 void
193 MidiTimeAxisView::append_extra_display_menu_items ()
194 {
195         using namespace Menu_Helpers;
196
197         MenuList& items = display_menu->items();
198
199         // Note range
200         Menu *range_menu = manage(new Menu);
201         MenuList& range_items = range_menu->items();
202         range_menu->set_name ("ArdourContextMenu");
203         
204         range_items.push_back (MenuElem (_("Show Full Range"), bind (
205                         mem_fun(*this, &MidiTimeAxisView::set_note_range),
206                         MidiStreamView::FullRange)));
207         
208         range_items.push_back (MenuElem (_("Fit Contents"), bind (
209                         mem_fun(*this, &MidiTimeAxisView::set_note_range),
210                         MidiStreamView::ContentsRange)));
211
212         items.push_back (MenuElem (_("Note range"), *range_menu));
213 }
214
215 void
216 MidiTimeAxisView::build_automation_action_menu ()
217 {
218         using namespace Menu_Helpers;
219
220         RouteTimeAxisView::build_automation_action_menu ();
221
222         MenuList& automation_items = automation_action_menu->items();
223         
224         automation_items.push_back (SeparatorElem());
225         automation_items.push_back (MenuElem (_("Controller..."), 
226                         mem_fun(*this, &MidiTimeAxisView::add_cc_track)));
227         automation_items.push_back (MenuElem (_("Bender"), 
228                         sigc::bind(mem_fun(*this, &MidiTimeAxisView::add_parameter_track),
229                                 Parameter(MidiPitchBenderAutomation))));
230         automation_items.push_back (MenuElem (_("Pressure"), 
231                         sigc::bind(mem_fun(*this, &MidiTimeAxisView::add_parameter_track),
232                                 Parameter(MidiChannelPressureAutomation))));
233
234 }
235
236 Gtk::Menu*
237 MidiTimeAxisView::build_mode_menu()
238 {
239         using namespace Menu_Helpers;
240
241         Menu* mode_menu = manage (new Menu);
242         MenuList& items = mode_menu->items();
243         mode_menu->set_name ("ArdourContextMenu");
244
245         RadioMenuItem::Group mode_group;
246         items.push_back (RadioMenuElem (mode_group, _("Sustained"),
247                                 bind (mem_fun (*this, &MidiTimeAxisView::set_note_mode), Sustained)));
248         _note_mode_item = dynamic_cast<RadioMenuItem*>(&items.back());
249         _note_mode_item->set_active(_note_mode == Sustained);
250
251         items.push_back (RadioMenuElem (mode_group, _("Percussive"),
252                                 bind (mem_fun (*this, &MidiTimeAxisView::set_note_mode), Percussive)));
253         _percussion_mode_item = dynamic_cast<RadioMenuItem*>(&items.back());
254         _percussion_mode_item->set_active(_note_mode == Percussive);
255
256         return mode_menu;
257 }
258         
259 void
260 MidiTimeAxisView::set_note_mode(NoteMode mode)
261 {
262         if (_note_mode != mode || midi_track()->note_mode() != mode) {
263                 _note_mode = mode;
264                 midi_track()->set_note_mode(mode);
265                 _view->redisplay_diskstream();
266         }
267 }
268
269
270 void
271 MidiTimeAxisView::set_note_range(MidiStreamView::VisibleNoteRange range)
272 {
273         if (!_ignore_signals)
274                 midi_view()->set_note_range(range);
275 }
276
277
278 void
279 MidiTimeAxisView::update_range()
280 {
281         MidiGhostRegion* mgr;
282
283         for(list<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
284                 if ((mgr = dynamic_cast<MidiGhostRegion*>(*i)) != 0) {
285                         mgr->update_range();
286                 }
287         }
288 }
289
290 void
291 MidiTimeAxisView::show_all_automation ()
292 {
293         if (midi_track()) {
294                 const set<Parameter> params = midi_track()->midi_diskstream()->
295                                 midi_playlist()->contained_automation();
296
297                 for (set<Parameter>::const_iterator i = params.begin(); i != params.end(); ++i) {
298                         create_automation_child(*i, true);
299                 }
300         }
301
302         RouteTimeAxisView::show_all_automation ();
303 }
304
305 void
306 MidiTimeAxisView::show_existing_automation ()
307 {
308         if (midi_track()) {
309                 const set<Parameter> params = midi_track()->midi_diskstream()->
310                                 midi_playlist()->contained_automation();
311
312                 for (set<Parameter>::const_iterator i = params.begin(); i != params.end(); ++i) {
313                         create_automation_child(*i, true);
314                 }
315         }
316
317         RouteTimeAxisView::show_existing_automation ();
318 }
319
320 /** Prompt for a controller with a dialog and add an automation track for it
321  */
322 void
323 MidiTimeAxisView::add_cc_track()
324 {
325         int response;
326         Parameter param;
327
328         {
329                 AddMidiCCTrackDialog dialog;
330                 dialog.set_transient_for(editor);
331                 response = dialog.run();
332                 
333                 if (response == Gtk::RESPONSE_ACCEPT)
334                         param = dialog.parameter();
335         }
336
337         if (response == Gtk::RESPONSE_ACCEPT)
338                 create_automation_child(param, true);
339 }
340
341
342 /** Add an automation track for the given parameter (pitch bend, channel pressure).
343  */
344 void
345 MidiTimeAxisView::add_parameter_track(const Parameter& param)
346 {
347         create_automation_child(param, true);
348 }
349
350 void
351 MidiTimeAxisView::create_automation_child (const Parameter& param, bool show)
352 {
353         if (    param.type() == MidiCCAutomation ||
354                         param.type() == MidiPgmChangeAutomation ||
355                         param.type() == MidiPitchBenderAutomation ||
356                         param.type() == MidiChannelPressureAutomation
357            ) {
358         
359                 /* These controllers are region "automation", so we do not create
360                  * an AutomationList/Line for the track */
361
362                 AutomationTracks::iterator existing = _automation_tracks.find(param);
363                 if (existing != _automation_tracks.end())
364                         return;
365
366                 boost::shared_ptr<AutomationControl> c
367                         = boost::dynamic_pointer_cast<AutomationControl>(_route->data().control(param));
368
369                 if (!c) {
370                         c = boost::dynamic_pointer_cast<AutomationControl>(_route->control_factory(param));
371                         _route->add_control(c);
372                 }
373
374                 boost::shared_ptr<AutomationTimeAxisView> track(new AutomationTimeAxisView (_session,
375                                 _route, boost::shared_ptr<ARDOUR::Automatable>(), c,
376                                 editor,
377                                 *this,
378                                 true,
379                                 parent_canvas,
380                                 _route->describe_parameter(param)));
381                 
382                 add_automation_child(param, track, show);
383
384         } else {
385                 error << "MidiTimeAxisView: unknown automation child " << param.symbol() << endmsg;
386         }
387 }
388
389 void
390 MidiTimeAxisView::route_active_changed ()
391 {
392         RouteUI::route_active_changed ();
393
394         if (is_track()) {
395                 if (_route->active()) {
396                         controls_ebox.set_name ("MidiTrackControlsBaseUnselected");
397                         controls_base_selected_name = "MidiTrackControlsBaseSelected";
398                         controls_base_unselected_name = "MidiTrackControlsBaseUnselected";
399                 } else {
400                         controls_ebox.set_name ("MidiTrackControlsBaseInactiveUnselected");
401                         controls_base_selected_name = "MidiTrackControlsBaseInactiveSelected";
402                         controls_base_unselected_name = "MidiTrackControlsBaseInactiveUnselected";
403                 }
404         } else {
405
406                 throw; // wha?
407                 
408                 if (_route->active()) {
409                         controls_ebox.set_name ("BusControlsBaseUnselected");
410                         controls_base_selected_name = "BusControlsBaseSelected";
411                         controls_base_unselected_name = "BusControlsBaseUnselected";
412                 } else {
413                         controls_ebox.set_name ("BusControlsBaseInactiveUnselected");
414                         controls_base_selected_name = "BusControlsBaseInactiveSelected";
415                         controls_base_unselected_name = "BusControlsBaseInactiveUnselected";
416                 }
417         }
418 }
419
420 void 
421 MidiTimeAxisView::channel_selector_toggled()
422 {
423         static uint32_t previous_height;
424         
425         if(_midi_expander.property_expanded()) {
426
427                 previous_height = current_height();
428
429                 if (previous_height < TimeAxisView::hLargest) {
430                         set_height (TimeAxisView::hLarge);
431                 }
432
433         } else {
434
435                 set_height (previous_height);
436         }
437 }
438
439
440