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