2 * Copyright (C) 2017 Robin Gareus <robin@gareus.org>
3 * Copyright (C) 2011 Paul Davis
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; either version 2
8 * of the License, or (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 #include <gtkmm/frame.h>
23 #include "pbd/unwind.h"
25 #include "evoral/midi_events.h"
26 #include "evoral/PatchChange.hpp"
28 #include "midi++/midnam_patch.h"
30 #include "ardour/instrument_info.h"
31 #include "ardour/midi_track.h"
32 #include "ardour/plugin_insert.h"
34 #include "gtkmm2ext/menu_elems.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> (_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 _bank_select.AddMenuElem (MenuElemNoMnemonic (n, sigc::bind (sigc::mem_fun (*this, &PatchChangeWidget::select_bank), (*i)->number ())));
241 if ((*i)->number () == b) {
242 _current_patch_bank = *i;
243 _bank_select.set_text (n);
248 if (!_current_patch_bank) {
249 std::string n = string_compose (_("Bank %1"), b);
250 _bank_select.AddMenuElem (MenuElemNoMnemonic (n, sigc::bind (sigc::mem_fun (*this, &PatchChangeWidget::select_bank), b)));
251 _bank_select.set_text (n);
254 refill_program_list ();
258 PatchChangeWidget::refill_program_list ()
260 std::bitset<128> unset_notes;
263 if (_current_patch_bank) {
264 const MIDI::Name::PatchNameList& patches = _current_patch_bank->patch_name_list ();
265 for (MIDI::Name::PatchNameList::const_iterator i = patches.begin(); i != patches.end(); ++i) {
266 const std::string n = (*i)->name ();
267 MIDI::Name::PatchPrimaryKey const& key = (*i)->patch_primary_key ();
269 const uint8_t pgm = key.program();
270 _program_btn[pgm].set_text (n);
271 set_tooltip (_program_btn[pgm], string_compose (_("%1 (Pgm-%2)"), n, (int)(pgm +1)));
272 unset_notes.reset (pgm);
276 for (uint8_t pgm = 0; pgm < 128; ++pgm) {
277 if (!unset_notes.test (pgm)) {
278 _program_btn[pgm].set_name (X_("patch change button"));
281 std::string n = string_compose (_("Pgm-%1"), (int)(pgm +1));
282 _program_btn[pgm].set_text (n);
283 _program_btn[pgm].set_name (X_("patch change dim button"));
284 set_tooltip (_program_btn[pgm], n);
290 /* ***** user GUI actions *****/
293 PatchChangeWidget::select_bank_spin ()
295 if (_ignore_spin_btn_signals) {
298 const uint32_t b = (_bank_msb_spin.get_value_as_int() << 7) + _bank_lsb_spin.get_value_as_int();
303 PatchChangeWidget::select_bank (uint32_t bank)
307 if (boost::dynamic_pointer_cast<MidiTrack> (_route)) {
308 boost::shared_ptr<AutomationControl> bank_msb = _route->automation_control(Evoral::Parameter (MidiCCAutomation, _channel, MIDI_CTL_MSB_BANK), true);
309 boost::shared_ptr<AutomationControl> bank_lsb = _route->automation_control(Evoral::Parameter (MidiCCAutomation, _channel, MIDI_CTL_LSB_BANK), true);
311 bank_msb->set_value (bank >> 7, PBD::Controllable::NoGroup);
312 bank_lsb->set_value (bank & 127, PBD::Controllable::NoGroup);
313 } else if (boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_route->the_instrument())) {
315 event[0] = (MIDI_CMD_CONTROL | _channel);
317 event[2] = bank >> 7;
318 pi->write_immediate_event (3, event);
321 event[2] = bank & 127;
322 pi->write_immediate_event (3, event);
325 select_program (program (_channel));
329 PatchChangeWidget::select_program (uint8_t pgm)
332 if (_no_notifications) {
340 if (boost::dynamic_pointer_cast<MidiTrack> (_route)) {
341 boost::shared_ptr<AutomationControl> program = _route->automation_control(Evoral::Parameter (MidiPgmChangeAutomation, _channel), true);
342 program->set_value (pgm, PBD::Controllable::NoGroup);
343 } else if (boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_route->the_instrument())) {
345 event[0] = (MIDI_CMD_PGM_CHANGE | _channel);
347 pi->write_immediate_event (2, event);
353 /* ***** callbacks, external changes *****/
356 PatchChangeWidget::bank_changed ()
362 PatchChangeWidget::bankpatch_changed (uint8_t chn)
364 if (chn == _channel) {
370 PatchChangeWidget::program_changed ()
372 uint8_t p = program (_channel);
373 for (uint8_t pgm = 0; pgm < 128; ++pgm) {
374 _program_btn[pgm].set_active (pgm == p);
379 PatchChangeWidget::instrument_info_changed ()
385 PatchChangeWidget::processors_changed ()
387 assert (!boost::dynamic_pointer_cast<MidiTrack> (_route));
388 if (_route->the_instrument ()) {
389 set_sensitive (true);
391 set_sensitive (false);
395 /* ***** play notes *****/
398 PatchChangeWidget::audition_toggle ()
400 _audition_enable.set_active (!_audition_enable.get_active ());
401 if (_audition_enable.get_active()) {
402 _audition_start_spin.set_sensitive (true);
403 _audition_end_spin.set_sensitive (true);
406 _audition_start_spin.set_sensitive (false);
407 _audition_end_spin.set_sensitive (false);
412 PatchChangeWidget::check_note_range (bool upper)
414 int s = _audition_start_spin.get_value_as_int ();
415 int e = _audition_end_spin.get_value_as_int ();
420 _audition_start_spin.set_value (e);
422 _audition_end_spin.set_value (s);
427 PatchChangeWidget::cancel_audition ()
429 _note_queue_connection.disconnect();
431 if (_audition_note_on) {
432 note_off_event_handler (_audition_note_num);
433 piano_keyboard_set_note_off (_piano, _audition_note_num);
438 PatchChangeWidget::audition ()
440 if (!boost::dynamic_pointer_cast<MidiTrack> (_route) && !boost::dynamic_pointer_cast<PluginInsert> (_route)) {
447 if (_note_queue_connection.connected ()) {
451 if (!_audition_enable.get_active ()) {
455 assert (!_audition_note_on);
456 _audition_note_num = _audition_start_spin.get_value_as_int ();
458 _note_queue_connection = Glib::signal_timeout().connect (sigc::bind (sigc::mem_fun (&PatchChangeWidget::audition_next), this), 250);
462 PatchChangeWidget::audition_next ()
464 if (_audition_note_on) {
465 note_off_event_handler (_audition_note_num);
466 piano_keyboard_set_note_off (_piano, _audition_note_num);
467 return ++_audition_note_num <= _audition_end_spin.get_value_as_int() && _audition_enable.get_active ();
469 note_on_event_handler (_audition_note_num);
470 piano_keyboard_set_note_on (_piano, _audition_note_num);
476 PatchChangeWidget::_note_on_event_handler(GtkWidget*, int note, gpointer arg)
478 ((PatchChangeWidget*)arg)->note_on_event_handler(note);
482 PatchChangeWidget::_note_off_event_handler(GtkWidget*, int note, gpointer arg)
484 ((PatchChangeWidget*)arg)->note_off_event_handler(note);
488 PatchChangeWidget::note_on_event_handler (int note)
491 _pianomm->grab_focus ();
493 event[0] = (MIDI_CMD_NOTE_ON | _channel);
495 event[2] = _audition_velocity.get_value_as_int ();
496 _audition_note_on = true;
497 _audition_note_num = note;
499 if (boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (_route)) {
500 mt->write_immediate_event (3, event);
501 } else if (boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_route->the_instrument())) {
502 pi->write_immediate_event (3, event);
507 PatchChangeWidget::note_off_event_handler (int note)
510 event[0] = (MIDI_CMD_NOTE_OFF | _channel);
513 _audition_note_on = false;
515 if (boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (_route)) {
516 mt->write_immediate_event (3, event);
517 } else if (boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_route->the_instrument())) {
518 pi->write_immediate_event (3, event);
522 /* ***** query info *****/
525 PatchChangeWidget::bank (uint8_t chn) const
527 if (boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (_route)) {
528 boost::shared_ptr<AutomationControl> bank_msb = _route->automation_control(Evoral::Parameter (MidiCCAutomation, chn, MIDI_CTL_MSB_BANK), true);
529 boost::shared_ptr<AutomationControl> bank_lsb = _route->automation_control(Evoral::Parameter (MidiCCAutomation, chn, MIDI_CTL_LSB_BANK), true);
531 return ((int)bank_msb->get_value () << 7) + (int)bank_lsb->get_value();
532 } else if (boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_route->the_instrument())) {
533 uint32_t bankpatch = pi->plugin()->bank_patch (chn);
534 if (bankpatch != UINT32_MAX) {
535 return bankpatch >> 7;
542 PatchChangeWidget::program (uint8_t chn) const
544 if (boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (_route)) {
545 boost::shared_ptr<AutomationControl> program = _route->automation_control(Evoral::Parameter (MidiPgmChangeAutomation, chn), true);
546 return program->get_value();
547 } else if (boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (_route->the_instrument())) {
548 uint32_t bankpatch = pi->plugin()->bank_patch (chn);
549 if (bankpatch != UINT32_MAX) {
550 return bankpatch & 127;
556 /* ***************************************************************************/
558 PatchChangeGridDialog::PatchChangeGridDialog (boost::shared_ptr<ARDOUR::Route> r)
559 : ArdourDialog (string_compose (_("Select Patch for '%1"), r->name()), false, false)
562 r->PropertyChanged.connect (_route_connection, invalidator (*this), boost::bind (&PatchChangeGridDialog::route_property_changed, this, _1, boost::weak_ptr<Route>(r)), gui_context());
568 PatchChangeGridDialog::route_property_changed (const PBD::PropertyChange& what_changed, boost::weak_ptr<Route> wr)
570 boost::shared_ptr<ARDOUR::Route> r = wr.lock ();
571 if (r && what_changed.contains (ARDOUR::Properties::name)) {
572 set_title (string_compose (_("Select Patch for '%1"), r->name()));