2 * Copyright (C) 2017-2019 Robin Gareus <robin@gareus.org>
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.
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.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #include <gtkmm/frame.h>
22 #include "pbd/unwind.h"
24 #include "evoral/midi_events.h"
25 #include "evoral/PatchChange.hpp"
27 #include "midi++/midnam_patch.h"
29 #include "ardour/instrument_info.h"
30 #include "ardour/midi_track.h"
31 #include "ardour/plugin_insert.h"
33 #include "gtkmm2ext/menu_elems.h"
34 #include "gtkmm2ext/utils.h"
35 #include "widgets/tooltips.h"
37 #include "gui_thread.h"
38 #include "patch_change_widget.h"
39 #include "ui_config.h"
44 using namespace ARDOUR;
46 PatchChangeWidget::PatchChangeWidget (boost::shared_ptr<ARDOUR::Route> r)
48 , _bank_msb_spin (*manage (new Adjustment (0, 0, 127, 1, 16)))
49 , _bank_lsb_spin (*manage (new Adjustment (0, 0, 127, 1, 16)))
50 , _program_table (/*rows*/ 16, /*cols*/ 8, true)
52 , _ignore_spin_btn_signals (false)
53 , _no_notifications (false)
54 , _info (r->instrument_info ())
55 , _audition_enable (_("Audition on Change"), ArdourWidgets::ArdourButton::led_default_elements)
56 , _audition_start_spin (*manage (new Adjustment (48, 0, 127, 1, 16)))
57 , _audition_end_spin (*manage (new Adjustment (60, 0, 127, 1, 16)))
58 , _audition_velocity (*manage (new Adjustment (100, 1, 127, 1, 16)))
59 , _audition_note_on (false)
60 , _piano ((PianoKeyboard*)piano_keyboard_new())
61 , _pianomm (Glib::wrap((GtkWidget*)_piano))
64 box = manage (new HBox ());
65 box->set_border_width (2);
67 box->pack_start (*manage (new Label (_("Channel:"))), false, false);
68 box->pack_start (_channel_select, false, false);
69 box->pack_start (*manage (new Label (_("Bank:"))), false, false);
70 box->pack_start (_bank_select, true, true);
71 box->pack_start (*manage (new Label (_("MSB:"))), false, false);
72 box->pack_start (_bank_msb_spin, false, false);
73 box->pack_start (*manage (new Label (_("LSB:"))), false, false);
74 box->pack_start (_bank_lsb_spin, false, false);
76 pack_start (*box, false, false);
78 _program_table.set_spacings (1);
79 pack_start (_program_table, true, true);
81 if (!boost::dynamic_pointer_cast<MidiTrack> (_route)) {
82 pack_start ( *manage (new Label (_("Note: Patch Selection is volatile (only Midi-Tracks retain bank/patch selection)."))), false, false);
85 box = manage (new HBox ());
87 box->pack_start (_audition_enable, false, false);
88 box->pack_start (*manage (new Label (_("Start Note:"))), false, false);
89 box->pack_start (_audition_start_spin, false, false);
90 box->pack_start (*manage (new Label (_("End Note:"))), false, false);
91 box->pack_start (_audition_end_spin, false, false);
92 box->pack_start (*manage (new Label (_("Velocity:"))), false, false);
93 box->pack_start (_audition_velocity, false, false);
95 Box* box2 = manage (new HBox ());
96 box2->pack_start (*box, true, false);
97 box2->set_border_width (2);
98 pack_start (*box2, false, false);
100 for (uint8_t pgm = 0; pgm < 128; ++pgm) {
101 _program_btn[pgm].set_text_ellipsize (Pango::ELLIPSIZE_END);
102 _program_btn[pgm].set_layout_ellipsize_width (PANGO_SCALE * 112 * UIConfiguration::instance ().get_ui_scale ());
105 _program_table.attach (_program_btn[pgm], col, col + 1, row, row + 1);
106 _program_btn[pgm].signal_clicked.connect (sigc::bind (sigc::mem_fun (*this, &PatchChangeWidget::select_program), pgm));
109 for (uint32_t chn = 0; chn < 16; ++chn) {
110 using namespace Menu_Helpers;
111 using namespace Gtkmm2ext;
113 snprintf (buf, sizeof(buf), "%d", chn + 1);
114 _channel_select.AddMenuElem (MenuElemNoMnemonic (buf, sigc::bind (sigc::mem_fun (*this, &PatchChangeWidget::select_channel), chn)));
117 piano_keyboard_set_monophonic (_piano, TRUE);
118 g_signal_connect (G_OBJECT (_piano), "note-on", G_CALLBACK (PatchChangeWidget::_note_on_event_handler), this);
119 g_signal_connect (G_OBJECT (_piano), "note-off", G_CALLBACK (PatchChangeWidget::_note_off_event_handler), this);
120 _pianomm->set_flags(Gtk::CAN_FOCUS);
121 pack_start (*_pianomm, false, false);
123 _audition_start_spin.set_sensitive (false);
124 _audition_end_spin.set_sensitive (false);
126 _audition_enable.signal_clicked.connect (sigc::mem_fun (*this, &PatchChangeWidget::audition_toggle));
127 _audition_start_spin.signal_changed().connect (sigc::bind (sigc::mem_fun (*this, &PatchChangeWidget::check_note_range), false));
128 _audition_end_spin.signal_changed().connect (sigc::bind (sigc::mem_fun (*this, &PatchChangeWidget::check_note_range), true));
129 _bank_msb_spin.signal_changed().connect (sigc::mem_fun (*this, &PatchChangeWidget::select_bank_spin));
130 _bank_lsb_spin.signal_changed().connect (sigc::mem_fun (*this, &PatchChangeWidget::select_bank_spin));
132 _info.Changed.connect (_info_changed_connection, invalidator (*this),
133 boost::bind (&PatchChangeWidget::instrument_info_changed, this), gui_context());
135 if (!boost::dynamic_pointer_cast<MidiTrack> (_route)) {
136 _route->processors_changed.connect (_route_connection, invalidator (*this),
137 boost::bind (&PatchChangeWidget::processors_changed, this), gui_context());
138 processors_changed ();
145 PatchChangeWidget::~PatchChangeWidget ()
152 PatchChangeWidget::refresh ()
160 PatchChangeWidget::on_show ()
162 Gtk::VBox::on_show ();
169 PatchChangeWidget::on_hide ()
171 Gtk::VBox::on_hide ();
172 _ac_connections.drop_connections ();
177 PatchChangeWidget::select_channel (uint8_t chn)
182 if (_channel == chn) {
188 _channel_select.set_text (string_compose ("%1", (int)(chn + 1)));
190 _no_notifications = false;
192 _ac_connections.drop_connections ();
194 if (boost::dynamic_pointer_cast<MidiTrack> (_route)) {
195 boost::shared_ptr<AutomationControl> bank_msb = _route->automation_control(Evoral::Parameter (MidiCCAutomation, chn, MIDI_CTL_MSB_BANK), true);
196 boost::shared_ptr<AutomationControl> bank_lsb = _route->automation_control(Evoral::Parameter (MidiCCAutomation, chn, MIDI_CTL_LSB_BANK), true);
197 boost::shared_ptr<AutomationControl> program = _route->automation_control(Evoral::Parameter (MidiPgmChangeAutomation, chn), true);
199 bank_msb->Changed.connect (_ac_connections, invalidator (*this),
200 boost::bind (&PatchChangeWidget::bank_changed, this), gui_context ());
201 bank_lsb->Changed.connect (_ac_connections, invalidator (*this),
202 boost::bind (&PatchChangeWidget::bank_changed, this), gui_context ());
203 program->Changed.connect (_ac_connections, invalidator (*this),
204 boost::bind (&PatchChangeWidget::program_changed, this), gui_context ());
205 } else if (boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_route->the_instrument())) {
206 if (pi->plugin()->knows_bank_patch ()) {
207 pi->plugin ()->BankPatchChange.connect (_ac_connections, invalidator (*this),
208 boost::bind (&PatchChangeWidget::bankpatch_changed, this, _1), gui_context ());
210 _no_notifications = true;
211 // TODO add note: instrument does not report changes.
219 PatchChangeWidget::refill_banks ()
222 using namespace Menu_Helpers;
223 using namespace Gtkmm2ext;
225 _current_patch_bank.reset ();
226 _bank_select.clear_items ();
228 const int b = bank (_channel);
231 PBD::Unwinder<bool> uw (_ignore_spin_btn_signals, true);
232 _bank_msb_spin.set_value (b >> 7);
233 _bank_lsb_spin.set_value (b & 127);
236 boost::shared_ptr<MIDI::Name::ChannelNameSet> cns = _info.get_patches (_channel);
238 for (MIDI::Name::ChannelNameSet::PatchBanks::const_iterator i = cns->patch_banks().begin(); i != cns->patch_banks().end(); ++i) {
239 std::string n = (*i)->name ();
240 if ((*i)->number () == UINT16_MAX) {
243 _bank_select.AddMenuElem (MenuElemNoMnemonic (n, sigc::bind (sigc::mem_fun (*this, &PatchChangeWidget::select_bank), (*i)->number ())));
244 if ((*i)->number () == b) {
245 _current_patch_bank = *i;
246 _bank_select.set_text (n);
251 if (!_current_patch_bank) {
252 std::string n = string_compose (_("Bank %1"), b);
253 _bank_select.AddMenuElem (MenuElemNoMnemonic (n, sigc::bind (sigc::mem_fun (*this, &PatchChangeWidget::select_bank), b)));
254 _bank_select.set_text (n);
257 refill_program_list ();
261 PatchChangeWidget::refill_program_list ()
263 std::bitset<128> unset_notes;
266 if (_current_patch_bank) {
267 const MIDI::Name::PatchNameList& patches = _current_patch_bank->patch_name_list ();
268 for (MIDI::Name::PatchNameList::const_iterator i = patches.begin(); i != patches.end(); ++i) {
269 const std::string n = (*i)->name ();
270 MIDI::Name::PatchPrimaryKey const& key = (*i)->patch_primary_key ();
272 const uint8_t pgm = key.program();
273 _program_btn[pgm].set_text (n);
274 set_tooltip (_program_btn[pgm], string_compose (_("%1 (Pgm-%2)"),
275 Gtkmm2ext::markup_escape_text (n), (int)(pgm +1)));
276 unset_notes.reset (pgm);
280 for (uint8_t pgm = 0; pgm < 128; ++pgm) {
281 if (!unset_notes.test (pgm)) {
282 _program_btn[pgm].set_name (X_("patch change button"));
285 std::string n = string_compose (_("Pgm-%1"), (int)(pgm +1));
286 _program_btn[pgm].set_text (n);
287 _program_btn[pgm].set_name (X_("patch change dim button"));
288 set_tooltip (_program_btn[pgm], n);
294 /* ***** user GUI actions *****/
297 PatchChangeWidget::select_bank_spin ()
299 if (_ignore_spin_btn_signals) {
302 const uint32_t b = (_bank_msb_spin.get_value_as_int() << 7) + _bank_lsb_spin.get_value_as_int();
307 PatchChangeWidget::select_bank (uint32_t bank)
311 if (boost::dynamic_pointer_cast<MidiTrack> (_route)) {
312 boost::shared_ptr<AutomationControl> bank_msb = _route->automation_control(Evoral::Parameter (MidiCCAutomation, _channel, MIDI_CTL_MSB_BANK), true);
313 boost::shared_ptr<AutomationControl> bank_lsb = _route->automation_control(Evoral::Parameter (MidiCCAutomation, _channel, MIDI_CTL_LSB_BANK), true);
315 bank_msb->set_value (bank >> 7, PBD::Controllable::NoGroup);
316 bank_lsb->set_value (bank & 127, PBD::Controllable::NoGroup);
317 } else if (boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_route->the_instrument())) {
319 event[0] = (MIDI_CMD_CONTROL | _channel);
321 event[2] = bank >> 7;
322 pi->write_immediate_event (3, event);
325 event[2] = bank & 127;
326 pi->write_immediate_event (3, event);
329 select_program (program (_channel));
333 PatchChangeWidget::select_program (uint8_t pgm)
336 if (_no_notifications) {
344 if (boost::dynamic_pointer_cast<MidiTrack> (_route)) {
345 boost::shared_ptr<AutomationControl> program = _route->automation_control(Evoral::Parameter (MidiPgmChangeAutomation, _channel), true);
346 program->set_value (pgm, PBD::Controllable::NoGroup);
347 } else if (boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_route->the_instrument())) {
349 event[0] = (MIDI_CMD_PGM_CHANGE | _channel);
351 pi->write_immediate_event (2, event);
357 /* ***** callbacks, external changes *****/
360 PatchChangeWidget::bank_changed ()
366 PatchChangeWidget::bankpatch_changed (uint8_t chn)
368 if (chn == _channel) {
374 PatchChangeWidget::program_changed ()
376 uint8_t p = program (_channel);
377 for (uint8_t pgm = 0; pgm < 128; ++pgm) {
378 _program_btn[pgm].set_active (pgm == p);
383 PatchChangeWidget::instrument_info_changed ()
389 PatchChangeWidget::processors_changed ()
391 assert (!boost::dynamic_pointer_cast<MidiTrack> (_route));
392 if (_route->the_instrument ()) {
393 set_sensitive (true);
395 set_sensitive (false);
399 /* ***** play notes *****/
402 PatchChangeWidget::audition_toggle ()
404 _audition_enable.set_active (!_audition_enable.get_active ());
405 if (_audition_enable.get_active()) {
406 _audition_start_spin.set_sensitive (true);
407 _audition_end_spin.set_sensitive (true);
410 _audition_start_spin.set_sensitive (false);
411 _audition_end_spin.set_sensitive (false);
416 PatchChangeWidget::check_note_range (bool upper)
418 int s = _audition_start_spin.get_value_as_int ();
419 int e = _audition_end_spin.get_value_as_int ();
424 _audition_start_spin.set_value (e);
426 _audition_end_spin.set_value (s);
431 PatchChangeWidget::cancel_audition ()
433 _note_queue_connection.disconnect();
435 if (_audition_note_on) {
436 note_off_event_handler (_audition_note_num);
437 piano_keyboard_set_note_off (_piano, _audition_note_num);
442 PatchChangeWidget::audition ()
444 if (!boost::dynamic_pointer_cast<MidiTrack> (_route) && !boost::dynamic_pointer_cast<PluginInsert> (_route)) {
451 if (_note_queue_connection.connected ()) {
455 if (!_audition_enable.get_active ()) {
459 assert (!_audition_note_on);
460 _audition_note_num = _audition_start_spin.get_value_as_int ();
462 _note_queue_connection = Glib::signal_timeout().connect (sigc::bind (sigc::mem_fun (&PatchChangeWidget::audition_next), this), 250);
466 PatchChangeWidget::audition_next ()
468 if (_audition_note_on) {
469 note_off_event_handler (_audition_note_num);
470 piano_keyboard_set_note_off (_piano, _audition_note_num);
471 return ++_audition_note_num <= _audition_end_spin.get_value_as_int() && _audition_enable.get_active ();
473 note_on_event_handler (_audition_note_num, true);
474 piano_keyboard_set_note_on (_piano, _audition_note_num);
480 PatchChangeWidget::_note_on_event_handler(GtkWidget*, int note, gpointer arg)
482 ((PatchChangeWidget*)arg)->note_on_event_handler(note, false);
486 PatchChangeWidget::_note_off_event_handler(GtkWidget*, int note, gpointer arg)
488 ((PatchChangeWidget*)arg)->note_off_event_handler(note);
492 PatchChangeWidget::note_on_event_handler (int note, bool for_audition)
496 _pianomm->grab_focus ();
499 event[0] = (MIDI_CMD_NOTE_ON | _channel);
501 event[2] = _audition_velocity.get_value_as_int ();
502 _audition_note_on = true;
503 _audition_note_num = note;
505 if (boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (_route)) {
506 mt->write_immediate_event (3, event);
507 } else if (boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_route->the_instrument())) {
508 pi->write_immediate_event (3, event);
513 PatchChangeWidget::note_off_event_handler (int note)
516 event[0] = (MIDI_CMD_NOTE_OFF | _channel);
519 _audition_note_on = false;
521 if (boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (_route)) {
522 mt->write_immediate_event (3, event);
523 } else if (boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_route->the_instrument())) {
524 pi->write_immediate_event (3, event);
528 /* ***** query info *****/
531 PatchChangeWidget::bank (uint8_t chn) const
533 if (boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (_route)) {
534 boost::shared_ptr<AutomationControl> bank_msb = _route->automation_control(Evoral::Parameter (MidiCCAutomation, chn, MIDI_CTL_MSB_BANK), true);
535 boost::shared_ptr<AutomationControl> bank_lsb = _route->automation_control(Evoral::Parameter (MidiCCAutomation, chn, MIDI_CTL_LSB_BANK), true);
537 return ((int)bank_msb->get_value () << 7) + (int)bank_lsb->get_value();
538 } else if (boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_route->the_instrument())) {
539 uint32_t bankpatch = pi->plugin()->bank_patch (chn);
540 if (bankpatch != UINT32_MAX) {
541 return bankpatch >> 7;
548 PatchChangeWidget::program (uint8_t chn) const
550 if (boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (_route)) {
551 boost::shared_ptr<AutomationControl> program = _route->automation_control(Evoral::Parameter (MidiPgmChangeAutomation, chn), true);
552 return program->get_value();
553 } else if (boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_route->the_instrument())) {
554 uint32_t bankpatch = pi->plugin()->bank_patch (chn);
555 if (bankpatch != UINT32_MAX) {
556 return bankpatch & 127;
562 /* ***************************************************************************/
564 PatchChangeGridDialog::PatchChangeGridDialog (boost::shared_ptr<ARDOUR::Route> r)
565 : ArdourDialog (string_compose (_("Select Patch for \"%1\""), r->name()), false, false)
568 r->PropertyChanged.connect (_route_connection, invalidator (*this), boost::bind (&PatchChangeGridDialog::route_property_changed, this, _1, boost::weak_ptr<Route>(r)), gui_context());
574 PatchChangeGridDialog::route_property_changed (const PBD::PropertyChange& what_changed, boost::weak_ptr<Route> wr)
576 boost::shared_ptr<ARDOUR::Route> r = wr.lock ();
577 if (r && what_changed.contains (ARDOUR::Properties::name)) {
578 set_title (string_compose (_("Select Patch for \"%1\"'"), r->name()));