* fixed missing track color mode persistence
[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 #include <pbd/enumwriter.h>
32
33 #include <gtkmm2ext/gtk_ui.h>
34 #include <gtkmm2ext/selector.h>
35 #include <gtkmm2ext/stop_signal.h>
36 #include <gtkmm2ext/bindable_button.h>
37 #include <gtkmm2ext/utils.h>
38
39 #include <ardour/midi_playlist.h>
40 #include <ardour/midi_diskstream.h>
41 #include <ardour/midi_patch_manager.h>
42 #include <ardour/processor.h>
43 #include <ardour/ladspa_plugin.h>
44 #include <ardour/location.h>
45 #include <ardour/playlist.h>
46 #include <ardour/session.h>
47 #include <ardour/session_playlist.h>
48 #include <ardour/utils.h>
49
50 #include "ardour_ui.h"
51 #include "midi_time_axis.h"
52 #include "automation_time_axis.h"
53 #include "automation_line.h"
54 #include "add_midi_cc_track_dialog.h"
55 #include "canvas_impl.h"
56 #include "crossfade_view.h"
57 #include "enums.h"
58 #include "gui_thread.h"
59 #include "keyboard.h"
60 #include "playlist_selector.h"
61 #include "plugin_selector.h"
62 #include "plugin_ui.h"
63 #include "point_selection.h"
64 #include "prompter.h"
65 #include "public_editor.h"
66 #include "region_view.h"
67 #include "rgb_macros.h"
68 #include "selection.h"
69 #include "simplerect.h"
70 #include "midi_streamview.h"
71 #include "utils.h"
72 #include "midi_scroomer.h"
73 #include "piano_roll_header.h"
74 #include "ghostregion.h"
75 #include "canvas-note-event.h"
76
77 #include <ardour/midi_track.h>
78
79 #include "i18n.h"
80
81 using namespace ARDOUR;
82 using namespace PBD;
83 using namespace Gtk;
84 using namespace sigc;
85 using namespace Editing;
86         
87 // Minimum height at which a control is displayed
88 static const uint32_t MIDI_CONTROLS_BOX_MIN_HEIGHT = 162;
89 static const uint32_t KEYBOARD_MIN_HEIGHT = 140;
90
91 MidiTimeAxisView::MidiTimeAxisView (PublicEditor& ed, Session& sess, boost::shared_ptr<Route> rt, Canvas& canvas)
92         : AxisView(sess) // virtually inherited
93         , RouteTimeAxisView(ed, sess, rt, canvas)
94         , _ignore_signals(false)  
95         , _range_scroomer(0)
96         , _piano_roll_header(0)
97         , _note_mode(Sustained)
98         , _note_mode_item(0)
99         , _percussion_mode_item(0)
100         , _color_mode(MeterColors)
101         , _meter_color_mode_item(0)
102         , _channel_color_mode_item(0)
103         , _track_color_mode_item(0)
104 {
105         subplugin_menu.set_name ("ArdourContextMenu");
106
107         _view = new MidiStreamView (*this);
108
109         ignore_toggle = false;
110
111         mute_button->set_active (false);
112         solo_button->set_active (false);
113         
114         if (is_midi_track()) {
115                 controls_ebox.set_name ("MidiTimeAxisViewControlsBaseUnselected");
116                 _note_mode = midi_track()->note_mode();
117         } else { // MIDI bus (which doesn't exist yet..)
118                 controls_ebox.set_name ("MidiBusControlsBaseUnselected");
119         }
120
121         /* map current state of the route */
122
123         processors_changed ();
124
125         ensure_xml_node ();
126
127         set_state (*xml_node);
128         
129         _route->processors_changed.connect (mem_fun(*this, &MidiTimeAxisView::processors_changed));
130
131         if (is_track()) {
132                 _piano_roll_header = new PianoRollHeader(*midi_view());
133                 _range_scroomer = new MidiScroomer(midi_view()->note_range_adjustment);
134
135                 controls_hbox.pack_start(*_range_scroomer);
136                 controls_hbox.pack_start(*_piano_roll_header);
137
138                 controls_ebox.set_name ("MidiTrackControlsBaseUnselected");
139                 controls_base_selected_name = "MidiTrackControlsBaseSelected";
140                 controls_base_unselected_name = "MidiTrackControlsBaseUnselected";
141
142                 midi_view()->NoteRangeChanged.connect (mem_fun(*this, &MidiTimeAxisView::update_range));
143
144                 /* ask for notifications of any new RegionViews */
145                 _view->RegionViewAdded.connect (mem_fun(*this, &MidiTimeAxisView::region_view_added));
146                 _view->attach ();
147         }
148                 
149         HBox* midi_controls_hbox = manage(new HBox());
150                 
151         MIDI::Name::MidiPatchManager& patch_manager = MIDI::Name::MidiPatchManager::instance();
152
153         for (MIDI::Name::MasterDeviceNames::Models::const_iterator model = patch_manager.all_models().begin();
154              model != patch_manager.all_models().end();
155              ++model) {
156                 _model_selector.append_text(model->c_str());
157         }
158         
159         _model_selector.signal_changed().connect(mem_fun(*this, &MidiTimeAxisView::model_changed));
160         
161         _custom_device_mode_selector.signal_changed().connect(
162                         mem_fun(*this, &MidiTimeAxisView::custom_device_mode_changed));
163         
164         // TODO: persist the choice
165         // this initializes the comboboxes and sends out the signal
166         _model_selector.set_active(0);
167
168         midi_controls_hbox->pack_start(_channel_selector, true, false);
169         if (!patch_manager.all_models().empty()) {
170                 _midi_controls_box.pack_start(_model_selector, true, false);
171                 _midi_controls_box.pack_start(_custom_device_mode_selector, true, false);
172         }
173         
174         _midi_controls_box.pack_start(*midi_controls_hbox, true, true);
175         
176         controls_vbox.pack_start(_midi_controls_box, false, false);
177         
178         boost::shared_ptr<MidiDiskstream> diskstream = midi_track()->midi_diskstream();
179
180         // restore channel selector settings
181         _channel_selector.set_channel_mode(diskstream->get_channel_mode(), diskstream->get_channel_mask());
182         _channel_selector.mode_changed.connect(
183                 mem_fun(*midi_track()->midi_diskstream(), &MidiDiskstream::set_channel_mode));
184
185         XMLProperty *prop;
186         if ((prop = xml_node->property ("color-mode")) != 0) {
187                 _color_mode = ColorMode (string_2_enum(prop->value(), _color_mode));
188                 if (_color_mode == ChannelColors) {
189                         _channel_selector.set_channel_colors(CanvasNoteEvent::midi_channel_colors);
190                 }
191         }
192 }
193
194 MidiTimeAxisView::~MidiTimeAxisView ()
195 {
196         delete _piano_roll_header;
197         _piano_roll_header = 0;
198
199         delete _range_scroomer;
200         _range_scroomer = 0;
201 }
202
203 void MidiTimeAxisView::model_changed()
204 {
205         std::list<std::string> device_modes = MIDI::Name::MidiPatchManager::instance()
206                 .custom_device_mode_names_by_model(_model_selector.get_active_text());
207         
208         _custom_device_mode_selector.clear_items();
209         
210         for (std::list<std::string>::const_iterator i = device_modes.begin(); i != device_modes.end(); ++i) {
211                 cerr << "found custom device mode " << *i << " thread_id: " << pthread_self() << endl;
212                 _custom_device_mode_selector.append_text(*i);
213         }
214
215         _custom_device_mode_selector.set_active(0);
216 }
217
218 void MidiTimeAxisView::custom_device_mode_changed()
219 {
220         _midi_patch_settings_changed.emit(_model_selector.get_active_text(), _custom_device_mode_selector.get_active_text());   
221 }
222
223 MidiStreamView*
224 MidiTimeAxisView::midi_view()
225 {
226         return dynamic_cast<MidiStreamView*>(_view);
227 }
228
229 guint32
230 MidiTimeAxisView::show_at (double y, int& nth, Gtk::VBox *parent)
231 {
232         ensure_xml_node ();
233         xml_node->add_property ("shown-editor", "yes");
234                 
235         guint32 ret = TimeAxisView::show_at (y, nth, parent);
236         return ret;
237 }
238
239 void
240 MidiTimeAxisView::hide ()
241 {
242         ensure_xml_node ();
243         xml_node->add_property ("shown-editor", "no");
244
245         TimeAxisView::hide ();
246 }
247
248 void
249 MidiTimeAxisView::set_height (uint32_t h)
250 {
251         RouteTimeAxisView::set_height (h);
252
253         if (height >= MIDI_CONTROLS_BOX_MIN_HEIGHT) {
254                 _midi_controls_box.show();
255         } else {
256                 _midi_controls_box.hide();
257         }
258         
259         if (height >= KEYBOARD_MIN_HEIGHT) {
260                 if (is_track() && _range_scroomer)
261                         _range_scroomer->show();
262                 if (is_track() && _piano_roll_header)
263                         _piano_roll_header->show();
264         } else {
265                 if (is_track() && _range_scroomer)
266                         _range_scroomer->hide();
267                 if (is_track() && _piano_roll_header)
268                         _piano_roll_header->hide();
269         }
270 }
271
272 void
273 MidiTimeAxisView::append_extra_display_menu_items ()
274 {
275         using namespace Menu_Helpers;
276
277         MenuList& items = display_menu->items();
278
279         // Note range
280         Menu *range_menu = manage(new Menu);
281         MenuList& range_items = range_menu->items();
282         range_menu->set_name ("ArdourContextMenu");
283         
284         range_items.push_back (MenuElem (_("Show Full Range"), bind (
285                         mem_fun(*this, &MidiTimeAxisView::set_note_range),
286                         MidiStreamView::FullRange)));
287         
288         range_items.push_back (MenuElem (_("Fit Contents"), bind (
289                         mem_fun(*this, &MidiTimeAxisView::set_note_range),
290                         MidiStreamView::ContentsRange)));
291
292         items.push_back (MenuElem (_("Note range"), *range_menu));
293 }
294
295 void
296 MidiTimeAxisView::build_automation_action_menu ()
297 {
298         using namespace Menu_Helpers;
299
300         RouteTimeAxisView::build_automation_action_menu ();
301
302         MenuList& automation_items = automation_action_menu->items();
303         
304         automation_items.push_back (SeparatorElem());
305         automation_items.push_back (MenuElem (_("Controller..."), 
306                         mem_fun(*this, &MidiTimeAxisView::add_cc_track)));
307         automation_items.push_back (MenuElem (_("Bender"), 
308                         sigc::bind(mem_fun(*this, &MidiTimeAxisView::add_parameter_track),
309                                 Evoral::Parameter(MidiPitchBenderAutomation))));
310         automation_items.push_back (MenuElem (_("Pressure"), 
311                         sigc::bind(mem_fun(*this, &MidiTimeAxisView::add_parameter_track),
312                                 Evoral::Parameter(MidiChannelPressureAutomation))));
313
314 }
315
316 Gtk::Menu*
317 MidiTimeAxisView::build_note_mode_menu()
318 {
319         using namespace Menu_Helpers;
320
321         Menu* mode_menu = manage (new Menu);
322         MenuList& items = mode_menu->items();
323         mode_menu->set_name ("ArdourContextMenu");
324
325         RadioMenuItem::Group mode_group;
326         items.push_back (RadioMenuElem (mode_group, _("Sustained"),
327                                 bind (mem_fun (*this, &MidiTimeAxisView::set_note_mode), Sustained)));
328         _note_mode_item = dynamic_cast<RadioMenuItem*>(&items.back());
329         _note_mode_item->set_active(_note_mode == Sustained);
330
331         items.push_back (RadioMenuElem (mode_group, _("Percussive"),
332                                 bind (mem_fun (*this, &MidiTimeAxisView::set_note_mode), Percussive)));
333         _percussion_mode_item = dynamic_cast<RadioMenuItem*>(&items.back());
334         _percussion_mode_item->set_active(_note_mode == Percussive);
335
336         return mode_menu;
337 }
338
339 Gtk::Menu*
340 MidiTimeAxisView::build_color_mode_menu()
341 {
342         using namespace Menu_Helpers;
343
344         Menu* mode_menu = manage (new Menu);
345         MenuList& items = mode_menu->items();
346         mode_menu->set_name ("ArdourContextMenu");
347
348         RadioMenuItem::Group mode_group;
349         items.push_back (RadioMenuElem (mode_group, _("Meter Colors"),
350                                 bind (mem_fun (*this, &MidiTimeAxisView::set_color_mode), MeterColors)));
351         _meter_color_mode_item = dynamic_cast<RadioMenuItem*>(&items.back());
352         _meter_color_mode_item->set_active(_color_mode == MeterColors);
353
354         items.push_back (RadioMenuElem (mode_group, _("Channel Colors"),
355                                 bind (mem_fun (*this, &MidiTimeAxisView::set_color_mode), ChannelColors)));
356         _channel_color_mode_item = dynamic_cast<RadioMenuItem*>(&items.back());
357         _channel_color_mode_item->set_active(_color_mode == ChannelColors);
358         
359         items.push_back (RadioMenuElem (mode_group, _("Track Color"),
360                                 bind (mem_fun (*this, &MidiTimeAxisView::set_color_mode), TrackColor)));
361         _channel_color_mode_item = dynamic_cast<RadioMenuItem*>(&items.back());
362         _channel_color_mode_item->set_active(_color_mode == TrackColor);
363                 
364         return mode_menu;
365 }
366         
367 void
368 MidiTimeAxisView::set_note_mode(NoteMode mode)
369 {
370         if (_note_mode != mode || midi_track()->note_mode() != mode) {
371                 _note_mode = mode;
372                 midi_track()->set_note_mode(mode);
373                 _view->redisplay_diskstream();
374         }
375 }
376
377 void
378 MidiTimeAxisView::set_color_mode(ColorMode mode)
379 {
380         if (_color_mode != mode) {
381                 if (mode == ChannelColors) {
382                         _channel_selector.set_channel_colors(CanvasNoteEvent::midi_channel_colors);
383                 } else {
384                         _channel_selector.set_default_channel_color();
385                 }
386
387                 _color_mode = mode;
388                 xml_node->add_property ("color-mode", enum_2_string(_color_mode));
389                 _view->redisplay_diskstream();
390         }
391 }
392
393 void
394 MidiTimeAxisView::set_note_range(MidiStreamView::VisibleNoteRange range)
395 {
396         if (!_ignore_signals)
397                 midi_view()->set_note_range(range);
398 }
399
400
401 void
402 MidiTimeAxisView::update_range()
403 {
404         MidiGhostRegion* mgr;
405
406         for(list<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
407                 if ((mgr = dynamic_cast<MidiGhostRegion*>(*i)) != 0) {
408                         mgr->update_range();
409                 }
410         }
411 }
412
413 void
414 MidiTimeAxisView::show_all_automation ()
415 {
416         if (midi_track()) {
417                 const set<Evoral::Parameter> params = midi_track()->midi_diskstream()->
418                                 midi_playlist()->contained_automation();
419
420                 for (set<Evoral::Parameter>::const_iterator i = params.begin(); i != params.end(); ++i) {
421                         create_automation_child(*i, true);
422                 }
423         }
424
425         RouteTimeAxisView::show_all_automation ();
426 }
427
428 void
429 MidiTimeAxisView::show_existing_automation ()
430 {
431         if (midi_track()) {
432                 const set<Evoral::Parameter> params = midi_track()->midi_diskstream()->
433                                 midi_playlist()->contained_automation();
434
435                 for (set<Evoral::Parameter>::const_iterator i = params.begin(); i != params.end(); ++i) {
436                         create_automation_child(*i, true);
437                 }
438         }
439
440         RouteTimeAxisView::show_existing_automation ();
441 }
442
443 /** Prompt for a controller with a dialog and add an automation track for it
444  */
445 void
446 MidiTimeAxisView::add_cc_track()
447 {
448         int response;
449         Evoral::Parameter param(0, 0, 0);
450
451         {
452                 AddMidiCCTrackDialog dialog;
453                 dialog.set_transient_for(editor);
454                 response = dialog.run();
455                 
456                 if (response == Gtk::RESPONSE_ACCEPT)
457                         param = dialog.parameter();
458         }
459
460         if (param.type() != 0 && response == Gtk::RESPONSE_ACCEPT)
461                 create_automation_child(param, true);
462 }
463
464
465 /** Add an automation track for the given parameter (pitch bend, channel pressure).
466  */
467 void
468 MidiTimeAxisView::add_parameter_track(const Evoral::Parameter& param)
469 {
470         create_automation_child(param, true);
471 }
472
473 void
474 MidiTimeAxisView::create_automation_child (const Evoral::Parameter& param, bool show)
475 {
476         if (    param.type() == MidiCCAutomation ||
477                         param.type() == MidiPgmChangeAutomation ||
478                         param.type() == MidiPitchBenderAutomation ||
479                         param.type() == MidiChannelPressureAutomation
480            ) {
481         
482                 /* These controllers are region "automation", so we do not create
483                  * an AutomationList/Line for the track */
484
485                 AutomationTracks::iterator existing = _automation_tracks.find(param);
486                 if (existing != _automation_tracks.end())
487                         return;
488
489                 boost::shared_ptr<AutomationControl> c
490                         = boost::dynamic_pointer_cast<AutomationControl>(_route->data().control(param));
491
492                 if (!c) {
493                         c = boost::dynamic_pointer_cast<AutomationControl>(_route->control_factory(param));
494                         _route->add_control(c);
495                 }
496
497                 boost::shared_ptr<AutomationTimeAxisView> track(new AutomationTimeAxisView (_session,
498                                 _route, boost::shared_ptr<ARDOUR::Automatable>(), c,
499                                 editor,
500                                 *this,
501                                 true,
502                                 parent_canvas,
503                                 _route->describe_parameter(param)));
504                 
505                 add_automation_child(param, track, show);
506
507         } else {
508                 error << "MidiTimeAxisView: unknown automation child "
509                         << ARDOUR::EventTypeMap::instance().to_symbol(param) << endmsg;
510         }
511 }
512
513 void
514 MidiTimeAxisView::route_active_changed ()
515 {
516         RouteUI::route_active_changed ();
517
518         if (is_track()) {
519                 if (_route->active()) {
520                         controls_ebox.set_name ("MidiTrackControlsBaseUnselected");
521                         controls_base_selected_name = "MidiTrackControlsBaseSelected";
522                         controls_base_unselected_name = "MidiTrackControlsBaseUnselected";
523                 } else {
524                         controls_ebox.set_name ("MidiTrackControlsBaseInactiveUnselected");
525                         controls_base_selected_name = "MidiTrackControlsBaseInactiveSelected";
526                         controls_base_unselected_name = "MidiTrackControlsBaseInactiveUnselected";
527                 }
528         } else {
529
530                 throw; // wha?
531                 
532                 if (_route->active()) {
533                         controls_ebox.set_name ("BusControlsBaseUnselected");
534                         controls_base_selected_name = "BusControlsBaseSelected";
535                         controls_base_unselected_name = "BusControlsBaseUnselected";
536                 } else {
537                         controls_ebox.set_name ("BusControlsBaseInactiveUnselected");
538                         controls_base_selected_name = "BusControlsBaseInactiveSelected";
539                         controls_base_unselected_name = "BusControlsBaseInactiveUnselected";
540                 }
541         }
542 }
543
544
545
546