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