2 Copyright (C) 2016 Paul Davis
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
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 #include "pbd/compose.h"
20 #include "pbd/convert.h"
21 #include "pbd/debug.h"
22 #include "pbd/failed_constructor.h"
23 #include "pbd/file_utils.h"
24 #include "pbd/search_path.h"
25 #include "pbd/enumwriter.h"
27 #include "midi++/parser.h"
28 #include "timecode/time.h"
29 #include "timecode/bbt_time.h"
31 #include "ardour/async_midi_port.h"
32 #include "ardour/audioengine.h"
33 #include "ardour/debug.h"
34 #include "ardour/filesystem_paths.h"
35 #include "ardour/midiport_manager.h"
36 #include "ardour/midi_track.h"
37 #include "ardour/midi_port.h"
38 #include "ardour/session.h"
39 #include "ardour/tempo.h"
41 #include "gtkmm2ext/rgb_macros.h"
48 #include "track_mix.h"
53 using namespace ARDOUR;
57 using namespace ArdourSurface;
59 #include "pbd/abstract_ui.cc" // instantiate template
61 const int Push2::cols = 960;
62 const int Push2::rows = 160;
63 const int Push2::pixels_per_row = 1024;
65 #define ABLETON 0x2982
68 __attribute__((constructor)) static void
71 EnumWriter& enum_writer (EnumWriter::instance());
75 MusicalMode::Type mode;
77 #define REGISTER(e) enum_writer.register_distinct (typeid(e).name(), i, s); i.clear(); s.clear()
78 #define REGISTER_CLASS_ENUM(t,e) i.push_back (t::e); s.push_back (#e)
80 REGISTER_CLASS_ENUM (MusicalMode,Dorian);
81 REGISTER_CLASS_ENUM (MusicalMode, IonianMajor);
82 REGISTER_CLASS_ENUM (MusicalMode, Minor);
83 REGISTER_CLASS_ENUM (MusicalMode, HarmonicMinor);
84 REGISTER_CLASS_ENUM (MusicalMode, MelodicMinorAscending);
85 REGISTER_CLASS_ENUM (MusicalMode, MelodicMinorDescending);
86 REGISTER_CLASS_ENUM (MusicalMode, Phrygian);
87 REGISTER_CLASS_ENUM (MusicalMode, Lydian);
88 REGISTER_CLASS_ENUM (MusicalMode, Mixolydian);
89 REGISTER_CLASS_ENUM (MusicalMode, Aeolian);
90 REGISTER_CLASS_ENUM (MusicalMode, Locrian);
91 REGISTER_CLASS_ENUM (MusicalMode, PentatonicMajor);
92 REGISTER_CLASS_ENUM (MusicalMode, PentatonicMinor);
93 REGISTER_CLASS_ENUM (MusicalMode, Chromatic);
94 REGISTER_CLASS_ENUM (MusicalMode, BluesScale);
95 REGISTER_CLASS_ENUM (MusicalMode, NeapolitanMinor);
96 REGISTER_CLASS_ENUM (MusicalMode, NeapolitanMajor);
97 REGISTER_CLASS_ENUM (MusicalMode, Oriental);
98 REGISTER_CLASS_ENUM (MusicalMode, DoubleHarmonic);
99 REGISTER_CLASS_ENUM (MusicalMode, Enigmatic);
100 REGISTER_CLASS_ENUM (MusicalMode, Hirajoshi);
101 REGISTER_CLASS_ENUM (MusicalMode, HungarianMinor);
102 REGISTER_CLASS_ENUM (MusicalMode, HungarianMajor);
103 REGISTER_CLASS_ENUM (MusicalMode, Kumoi);
104 REGISTER_CLASS_ENUM (MusicalMode, Iwato);
105 REGISTER_CLASS_ENUM (MusicalMode, Hindu);
106 REGISTER_CLASS_ENUM (MusicalMode, Spanish8Tone);
107 REGISTER_CLASS_ENUM (MusicalMode, Pelog);
108 REGISTER_CLASS_ENUM (MusicalMode, HungarianGypsy);
109 REGISTER_CLASS_ENUM (MusicalMode, Overtone);
110 REGISTER_CLASS_ENUM (MusicalMode, LeadingWholeTone);
111 REGISTER_CLASS_ENUM (MusicalMode, Arabian);
112 REGISTER_CLASS_ENUM (MusicalMode, Balinese);
113 REGISTER_CLASS_ENUM (MusicalMode, Gypsy);
114 REGISTER_CLASS_ENUM (MusicalMode, Mohammedan);
115 REGISTER_CLASS_ENUM (MusicalMode, Javanese);
116 REGISTER_CLASS_ENUM (MusicalMode, Persian);
117 REGISTER_CLASS_ENUM (MusicalMode, Algerian);
121 Push2::Push2 (ARDOUR::Session& s)
122 : ControlProtocol (s, string (X_("Ableton Push 2")))
123 , AbstractUI<Push2Request> (name())
126 , frame_buffer (Cairo::ImageSurface::create (Cairo::FORMAT_ARGB32, cols, rows))
127 , _modifier_state (None)
129 , _current_layout (0)
131 , connection_state (ConnectionState (0))
133 , _mode (MusicalMode::IonianMajor)
140 context = Cairo::Context::create (frame_buffer);
145 /* master cannot be removed, so no need to connect to going-away signal */
146 master = session->master_out ();
149 throw failed_constructor ();
152 ControlProtocol::StripableSelectionChanged.connect (selection_connection, MISSING_INVALIDATOR, boost::bind (&Push2::stripable_selection_change, this, _1), this);
154 /* catch current selection, if any */
156 StripableNotificationListPtr sp (new StripableNotificationList (ControlProtocol::last_selected()));
157 stripable_selection_change (sp);
160 /* catch arrival and departure of Push2 itself */
161 ARDOUR::AudioEngine::instance()->PortRegisteredOrUnregistered.connect (port_reg_connection, MISSING_INVALIDATOR, boost::bind (&Push2::port_registration_handler, this), this);
163 /* Catch port connections and disconnections */
164 ARDOUR::AudioEngine::instance()->PortConnectedOrDisconnected.connect (port_connection, MISSING_INVALIDATOR, boost::bind (&Push2::connection_handler, this, _1, _2, _3, _4, _5), this);
166 /* ports might already be there */
167 port_registration_handler ();
176 Push2::port_registration_handler ()
178 if (_async_in->connected() && _async_out->connected()) {
179 /* don't waste cycles here */
183 string input_port_name = X_("Ableton Push 2 MIDI 1 in");
184 string output_port_name = X_("Ableton Push 2 MIDI 1 out");
188 AudioEngine::instance()->get_ports (string_compose (".*%1", input_port_name), DataType::MIDI, PortFlags (IsPhysical|IsOutput), in);
189 AudioEngine::instance()->get_ports (string_compose (".*%1", output_port_name), DataType::MIDI, PortFlags (IsPhysical|IsInput), out);
191 if (!in.empty() && !out.empty()) {
192 cerr << "Push2: both ports found\n";
193 cerr << "\tconnecting to " << in.front() << " + " << out.front() << endl;
194 if (!_async_in->connected()) {
195 AudioEngine::instance()->connect (_async_in->name(), in.front());
197 if (!_async_out->connected()) {
198 AudioEngine::instance()->connect (_async_out->name(), out.front());
213 if ((handle = libusb_open_device_with_vid_pid (NULL, ABLETON, PUSH2)) == 0) {
217 if ((err = libusb_claim_interface (handle, 0x00))) {
221 device_frame_buffer = new uint16_t[rows*pixels_per_row];
223 memset (device_frame_buffer, 0, sizeof (uint16_t) * rows * pixels_per_row);
225 frame_header[0] = 0xef;
226 frame_header[1] = 0xcd;
227 frame_header[2] = 0xab;
228 frame_header[3] = 0x89;
229 memset (&frame_header[4], 0, 12);
233 _async_in = AudioEngine::instance()->register_input_port (DataType::MIDI, X_("Push 2 in"), true);
234 _async_out = AudioEngine::instance()->register_output_port (DataType::MIDI, X_("Push 2 out"), true);
236 if (_async_in == 0 || _async_out == 0) {
240 /* We do not add our ports to the input/output bundles because we don't
241 * want users wiring them by hand. They could use JACK tools if they
242 * really insist on that.
245 _input_port = boost::dynamic_pointer_cast<AsyncMIDIPort>(_async_in).get();
246 _output_port = boost::dynamic_pointer_cast<AsyncMIDIPort>(_async_out).get();
248 /* Create a shadow port where, depending on the state of the surface,
249 * we will make pad note on/off events appear. The surface code will
250 * automatically this port to the first selected MIDI track.
253 boost::dynamic_pointer_cast<AsyncMIDIPort>(_async_in)->add_shadow_port (string_compose (_("%1 Pads"), X_("Push 2")), boost::bind (&Push2::pad_filter, this, _1, _2));
254 boost::shared_ptr<MidiPort> shadow_port = boost::dynamic_pointer_cast<AsyncMIDIPort>(_async_in)->shadow_port();
258 _output_bundle.reset (new ARDOUR::Bundle (_("Push 2 Pads"), false));
260 _output_bundle->add_channel (
262 ARDOUR::DataType::MIDI,
263 session->engine().make_port_name_non_relative (shadow_port->name())
267 session->BundleAddedOrRemoved ();
269 connect_to_parser ();
271 mix_layout = new MixLayout (*this, *session, context);
272 scale_layout = new ScaleLayout (*this, *session, context);
273 track_mix_layout = new TrackMixLayout (*this, *session, context);
275 _current_layout = mix_layout;
280 list<boost::shared_ptr<ARDOUR::Bundle> >
283 list<boost::shared_ptr<ARDOUR::Bundle> > b;
285 if (_output_bundle) {
286 b.push_back (_output_bundle);
295 init_buttons (false);
297 /* wait for button data to be flushed */
299 asp = dynamic_cast<AsyncMIDIPort*> (_output_port);
300 asp->drain (10000, 500000);
302 AudioEngine::instance()->unregister_port (_async_in);
303 AudioEngine::instance()->unregister_port (_async_out);
305 _async_in.reset ((ARDOUR::Port*) 0);
306 _async_out.reset ((ARDOUR::Port*) 0);
310 vblank_connection.disconnect ();
311 periodic_connection.disconnect ();
312 session_connections.drop_connections ();
322 libusb_release_interface (handle, 0x00);
323 libusb_close (handle);
327 delete [] device_frame_buffer;
328 device_frame_buffer = 0;
334 Push2::init_buttons (bool startup)
336 /* This is a list of buttons that we want lit because they do something
337 in ardour related (loosely, sometimes) to their illuminated label.
340 ButtonID buttons[] = { Mute, Solo, Master, Up, Right, Left, Down, Note, Session, Mix, AddTrack, Delete, Undo,
341 Metronome, Shift, Select, Play, RecordEnable, Automate, Repeat, Note, Session, DoubleLoop,
342 Quantize, Duplicate, Browse, PageRight, PageLeft, OctaveUp, OctaveDown, Layout, Scale
345 for (size_t n = 0; n < sizeof (buttons) / sizeof (buttons[0]); ++n) {
346 Button* b = id_button_map[buttons[n]];
349 b->set_color (LED::White);
351 b->set_color (LED::Black);
353 b->set_state (LED::OneShot24th);
354 write (b->state_msg());
357 /* Strip buttons should all be off (black) by default. They will change
358 * color to reflect various conditions
361 ButtonID strip_buttons[] = { Upper1, Upper2, Upper3, Upper4, Upper5, Upper6, Upper7, Upper8,
362 Lower1, Lower2, Lower3, Lower4, Lower5, Lower6, Lower7, Lower8, };
364 for (size_t n = 0; n < sizeof (strip_buttons) / sizeof (strip_buttons[0]); ++n) {
365 Button* b = id_button_map[strip_buttons[n]];
367 b->set_color (LED::Black);
368 b->set_state (LED::OneShot24th);
369 write (b->state_msg());
374 /* all other buttons are off (black) */
376 ButtonID off_buttons[] = { TapTempo, Setup, User, Stop, Convert, New, FixedLength,
377 Fwd32ndT, Fwd32nd, Fwd16thT, Fwd16th, Fwd8thT, Fwd8th, Fwd4trT, Fwd4tr,
378 Accent, Note, Session, };
380 for (size_t n = 0; n < sizeof (off_buttons) / sizeof (off_buttons[0]); ++n) {
381 Button* b = id_button_map[off_buttons[n]];
383 b->set_color (LED::Black);
384 b->set_state (LED::OneShot24th);
385 write (b->state_msg());
390 for (NNPadMap::iterator pi = nn_pad_map.begin(); pi != nn_pad_map.end(); ++pi) {
391 Pad* pad = pi->second;
393 pad->set_color (LED::Black);
394 pad->set_state (LED::OneShot24th);
395 write (pad->state_msg());
403 libusb_device_handle *h;
406 if ((h = libusb_open_device_with_vid_pid (NULL, ABLETON, PUSH2)) == 0) {
407 DEBUG_TRACE (DEBUG::Push2, "no Push2 device found\n");
412 DEBUG_TRACE (DEBUG::Push2, "Push2 device located\n");
417 Push2::request_factory (uint32_t num_requests)
419 /* AbstractUI<T>::request_buffer_factory() is a template method only
420 instantiated in this source module. To provide something visible for
421 use in the interface/descriptor, we have this static method that is
424 return request_buffer_factory (num_requests);
428 Push2::do_request (Push2Request * req)
430 DEBUG_TRACE (DEBUG::Push2, string_compose ("doing request type %1\n", req->type));
431 if (req->type == CallSlot) {
433 call_slot (MISSING_INVALIDATOR, req->the_slot);
435 } else if (req->type == Quit) {
449 /** render host-side frame buffer (a Cairo ImageSurface) to the current
450 * device-side frame buffer. The device frame buffer will be pushed to the
451 * device on the next call to vblank()
455 Push2::blit_to_device_frame_buffer ()
457 /* ensure that all drawing has been done before we fetch pixel data */
459 frame_buffer->flush ();
461 const int stride = 3840; /* bytes per row for Cairo::FORMAT_ARGB32 */
462 const uint8_t* data = frame_buffer->get_data ();
464 /* fill frame buffer (320kB) */
466 uint16_t* fb = (uint16_t*) device_frame_buffer;
468 for (int row = 0; row < rows; ++row) {
470 const uint8_t* dp = data + row * stride;
472 for (int col = 0; col < cols; ++col) {
474 /* fetch r, g, b (range 0..255). Ignore alpha */
476 const int r = (*((const uint32_t*)dp) >> 16) & 0xff;
477 const int g = (*((const uint32_t*)dp) >> 8) & 0xff;
478 const int b = *((const uint32_t*)dp) & 0xff;
480 /* convert to 5 bits, 6 bits, 5 bits, respectively */
481 /* generate 16 bit BGB565 value */
483 *fb++ = (r >> 3) | ((g & 0xfc) << 3) | ((b & 0xf8) << 8);
485 /* the push2 docs state that we should xor the pixel
486 * data. Doing so doesn't work correctly, and not doing
487 * so seems to work fine (colors roughly match intended
494 /* skip 128 bytes to next line. This is filler, used to avoid line borders occuring in the middle of 512
498 fb += 64; /* 128 bytes = 64 int16_t */
509 /* display splash for 3 seconds */
511 if (get_microseconds() - splash_start > 3000000) {
518 Glib::Threads::Mutex::Lock lm (layout_lock, Glib::Threads::TRY_LOCK);
521 /* can't get layout, no re-render needed */
525 bool render_needed = false;
527 if (drawn_layout != _current_layout) {
528 render_needed = true;
531 bool dirty = _current_layout->redraw (context);
532 drawn_layout = _current_layout;
534 return dirty || render_needed;
541 const int timeout_msecs = 1000;
544 if ((err = libusb_bulk_transfer (handle, 0x01, frame_header, sizeof (frame_header), &transferred, timeout_msecs))) {
550 blit_to_device_frame_buffer ();
553 if ((err = libusb_bulk_transfer (handle, 0x01, (uint8_t*) device_frame_buffer , 2 * rows * pixels_per_row, &transferred, timeout_msecs))) {
561 Push2::set_active (bool yn)
563 DEBUG_TRACE (DEBUG::Push2, string_compose("Push2Protocol::set_active init with yn: '%1'\n", yn));
565 if (yn == active()) {
571 /* start event loop */
576 DEBUG_TRACE (DEBUG::Push2, "device open failed\n");
581 /* Connect input port to event loop */
585 asp = dynamic_cast<AsyncMIDIPort*> (_input_port);
586 asp->xthread().set_receive_handler (sigc::bind (sigc::mem_fun (this, &Push2::midi_input_handler), _input_port));
587 asp->xthread().attach (main_loop()->get_context());
589 connect_session_signals ();
591 /* set up periodic task used to push a frame buffer to the
592 * device (25fps). The device can handle 60fps, but we don't
593 * need that frame rate.
596 Glib::RefPtr<Glib::TimeoutSource> vblank_timeout = Glib::TimeoutSource::create (40); // milliseconds
597 vblank_connection = vblank_timeout->connect (sigc::mem_fun (*this, &Push2::vblank));
598 vblank_timeout->attach (main_loop()->get_context());
601 Glib::RefPtr<Glib::TimeoutSource> periodic_timeout = Glib::TimeoutSource::create (1000); // milliseconds
602 periodic_connection = periodic_timeout->connect (sigc::mem_fun (*this, &Push2::periodic));
603 periodic_timeout->attach (main_loop()->get_context());
607 set_pad_scale (_scale_root, _root_octave, _mode, _in_key);
617 ControlProtocol::set_active (yn);
619 DEBUG_TRACE (DEBUG::Push2, string_compose("Push2Protocol::set_active done with yn: '%1'\n", yn));
625 Push2::init_touch_strip ()
627 MidiByteArray msg (9, 0xf0, 0x00, 0x21, 0x1d, 0x01, 0x01, 0x17, 0x00, 0xf7);
628 /* flags are the final byte (ignore end-of-sysex */
630 /* show bar, not point
634 msg[7] = (1<<4) | (1<<5) | (1<<6);
639 Push2::write (const MidiByteArray& data)
641 /* immediate delivery */
642 _output_port->write (&data[0], data.size(), 0);
646 Push2::midi_input_handler (IOCondition ioc, MIDI::Port* port)
649 DEBUG_TRACE (DEBUG::Push2, "MIDI port closed\n");
655 // DEBUG_TRACE (DEBUG::Push2, string_compose ("something happend on %1\n", port->name()));
657 AsyncMIDIPort* asp = dynamic_cast<AsyncMIDIPort*>(port);
662 //DEBUG_TRACE (DEBUG::Push2, string_compose ("data available on %1\n", port->name()));
663 framepos_t now = AudioEngine::instance()->sample_time();
677 Push2::connect_to_parser ()
679 DEBUG_TRACE (DEBUG::Push2, string_compose ("Connecting to signals on port %2\n", _input_port->name()));
681 MIDI::Parser* p = _input_port->parser();
684 p->sysex.connect_same_thread (*this, boost::bind (&Push2::handle_midi_sysex, this, _1, _2, _3));
685 /* V-Pot messages are Controller */
686 p->controller.connect_same_thread (*this, boost::bind (&Push2::handle_midi_controller_message, this, _1, _2));
687 /* Button messages are NoteOn */
688 p->note_on.connect_same_thread (*this, boost::bind (&Push2::handle_midi_note_on_message, this, _1, _2));
689 /* Button messages are NoteOn but libmidi++ sends note-on w/velocity = 0 as note-off so catch them too */
690 p->note_off.connect_same_thread (*this, boost::bind (&Push2::handle_midi_note_on_message, this, _1, _2));
691 /* Fader messages are Pitchbend */
692 p->channel_pitchbend[0].connect_same_thread (*this, boost::bind (&Push2::handle_midi_pitchbend_message, this, _1, _2));
696 Push2::handle_midi_sysex (MIDI::Parser&, MIDI::byte* raw_bytes, size_t sz)
698 DEBUG_TRACE (DEBUG::Push2, string_compose ("Sysex, %1 bytes\n", sz));
702 Push2::handle_midi_controller_message (MIDI::Parser&, MIDI::EventTwoBytes* ev)
704 DEBUG_TRACE (DEBUG::Push2, string_compose ("CC %1 (value %2)\n", (int) ev->controller_number, (int) ev->value));
706 CCButtonMap::iterator b = cc_button_map.find (ev->controller_number);
709 /* any press cancels any pending long press timeouts */
710 for (set<ButtonID>::iterator x = buttons_down.begin(); x != buttons_down.end(); ++x) {
711 Button* bb = id_button_map[*x];
712 bb->timeout_connection.disconnect ();
716 if (b != cc_button_map.end()) {
718 Button* button = b->second;
721 buttons_down.insert (button->id);
722 start_press_timeout (*button, button->id);
724 buttons_down.erase (button->id);
725 button->timeout_connection.disconnect ();
729 set<ButtonID>::iterator c = consumed.find (button->id);
731 if (c == consumed.end()) {
732 if (ev->value == 0) {
733 (this->*button->release_method)();
735 (this->*button->press_method)();
738 DEBUG_TRACE (DEBUG::Push2, "button was consumed, ignored\n");
746 int delta = ev->value;
749 delta = -(128 - delta);
752 switch (ev->controller_number) {
754 _current_layout->strip_vpot (0, delta);
757 _current_layout->strip_vpot (1, delta);
760 _current_layout->strip_vpot (2, delta);
763 _current_layout->strip_vpot (3, delta);
766 _current_layout->strip_vpot (4, delta);
769 _current_layout->strip_vpot (5, delta);
772 _current_layout->strip_vpot (6, delta);
775 _current_layout->strip_vpot (7, delta);
780 other_vpot (8, delta);
783 other_vpot (1, delta);
788 other_vpot (2, delta);
795 Push2::handle_midi_note_on_message (MIDI::Parser& parser, MIDI::EventTwoBytes* ev)
797 DEBUG_TRACE (DEBUG::Push2, string_compose ("Note On %1 (velocity %2)\n", (int) ev->note_number, (int) ev->velocity));
799 if (ev->velocity == 0) {
800 handle_midi_note_off_message (parser, ev);
804 switch (ev->note_number) {
806 _current_layout->strip_vpot_touch (0, ev->velocity > 64);
809 _current_layout->strip_vpot_touch (1, ev->velocity > 64);
812 _current_layout->strip_vpot_touch (2, ev->velocity > 64);
815 _current_layout->strip_vpot_touch (3, ev->velocity > 64);
818 _current_layout->strip_vpot_touch (4, ev->velocity > 64);
821 _current_layout->strip_vpot_touch (5, ev->velocity > 64);
824 _current_layout->strip_vpot_touch (6, ev->velocity > 64);
827 _current_layout->strip_vpot_touch (7, ev->velocity > 64);
832 other_vpot_touch (0, ev->velocity > 64);
835 other_vpot_touch (1, ev->velocity > 64);
840 other_vpot_touch (3, ev->velocity > 64);
845 if (ev->velocity < 64) {
851 if (ev->note_number < 11) {
857 NNPadMap::iterator pi = nn_pad_map.find (ev->note_number);
859 if (pi == nn_pad_map.end()) {
863 Pad* pad = pi->second;
865 if (pad->do_when_pressed == Pad::FlashOn) {
866 pad->set_color (LED::White);
867 pad->set_state (LED::OneShot24th);
868 write (pad->state_msg());
869 } else if (pad->do_when_pressed == Pad::FlashOff) {
870 pad->set_color (LED::Black);
871 pad->set_state (LED::OneShot24th);
872 write (pad->state_msg());
877 Push2::handle_midi_note_off_message (MIDI::Parser&, MIDI::EventTwoBytes* ev)
879 DEBUG_TRACE (DEBUG::Push2, string_compose ("Note Off %1 (velocity %2)\n", (int) ev->note_number, (int) ev->velocity));
881 if (ev->note_number < 11) {
882 /* theoretically related to encoder touch start/end, but
883 * actually they send note on with two different velocity
889 NNPadMap::iterator pi = nn_pad_map.find (ev->note_number);
891 if (pi == nn_pad_map.end()) {
895 Pad* pad = pi->second;
897 if (pad->do_when_pressed == Pad::FlashOn) {
898 pad->set_color (LED::Black);
899 pad->set_state (LED::OneShot24th);
900 write (pad->state_msg());
901 } else if (pad->do_when_pressed == Pad::FlashOff) {
902 pad->set_color (pad->perma_color);
903 pad->set_state (LED::OneShot24th);
904 write (pad->state_msg());
909 Push2::handle_midi_pitchbend_message (MIDI::Parser&, MIDI::pitchbend_t pb)
914 Push2::thread_init ()
916 struct sched_param rtparam;
918 pthread_set_name (event_loop_name().c_str());
920 PBD::notify_event_loops_about_thread_creation (pthread_self(), event_loop_name(), 2048);
921 ARDOUR::SessionEvent::create_per_thread_pool (event_loop_name(), 128);
923 memset (&rtparam, 0, sizeof (rtparam));
924 rtparam.sched_priority = 9; /* XXX should be relative to audio (JACK) thread */
926 if (pthread_setschedparam (pthread_self(), SCHED_FIFO, &rtparam) != 0) {
927 // do we care? not particularly.
932 Push2::connect_session_signals()
934 // receive routes added
935 //session->RouteAdded.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_routes_added, this, _1), this);
936 // receive VCAs added
937 //session->vca_manager().VCAAdded.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&Push2::notify_vca_added, this, _1), this);
939 // receive record state toggled
940 session->RecordStateChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&Push2::notify_record_state_changed, this), this);
941 // receive transport state changed
942 session->TransportStateChange.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&Push2::notify_transport_state_changed, this), this);
943 session->TransportLooped.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&Push2::notify_loop_state_changed, this), this);
944 // receive punch-in and punch-out
945 Config->ParameterChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&Push2::notify_parameter_changed, this, _1), this);
946 session->config.ParameterChanged.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&Push2::notify_parameter_changed, this, _1), this);
947 // receive rude solo changed
948 session->SoloActive.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&Push2::notify_solo_active_changed, this, _1), this);
952 Push2::notify_record_state_changed ()
954 IDButtonMap::iterator b = id_button_map.find (RecordEnable);
956 if (b == id_button_map.end()) {
960 switch (session->record_status ()) {
961 case Session::Disabled:
962 b->second->set_color (LED::White);
963 b->second->set_state (LED::NoTransition);
965 case Session::Enabled:
966 b->second->set_color (LED::Red);
967 b->second->set_state (LED::Blinking4th);
969 case Session::Recording:
970 b->second->set_color (LED::Red);
971 b->second->set_state (LED::OneShot24th);
975 write (b->second->state_msg());
979 Push2::notify_transport_state_changed ()
981 Button* b = id_button_map[Play];
983 if (session->transport_rolling()) {
984 b->set_state (LED::OneShot24th);
985 b->set_color (LED::Green);
988 /* disable any blink on FixedLength from pending edit range op */
989 Button* fl = id_button_map[FixedLength];
991 fl->set_color (LED::Black);
992 fl->set_state (LED::NoTransition);
993 write (fl->state_msg());
995 b->set_color (LED::White);
996 b->set_state (LED::NoTransition);
999 write (b->state_msg());
1003 Push2::notify_loop_state_changed ()
1008 Push2::notify_parameter_changed (std::string param)
1010 IDButtonMap::iterator b;
1012 if (param == "clicking") {
1013 if ((b = id_button_map.find (Metronome)) == id_button_map.end()) {
1016 if (Config->get_clicking()) {
1017 b->second->set_state (LED::Blinking4th);
1018 b->second->set_color (LED::White);
1020 b->second->set_color (LED::White);
1021 b->second->set_state (LED::NoTransition);
1023 write (b->second->state_msg ());
1028 Push2::notify_solo_active_changed (bool yn)
1030 IDButtonMap::iterator b = id_button_map.find (Solo);
1032 if (b == id_button_map.end()) {
1037 b->second->set_state (LED::Blinking4th);
1038 b->second->set_color (LED::Red);
1040 b->second->set_state (LED::NoTransition);
1041 b->second->set_color (LED::White);
1044 write (b->second->state_msg());
1050 XMLNode& node (ControlProtocol::get_state());
1053 child = new XMLNode (X_("Input"));
1054 child->add_child_nocopy (_async_in->get_state());
1055 node.add_child_nocopy (*child);
1056 child = new XMLNode (X_("Output"));
1057 child->add_child_nocopy (_async_out->get_state());
1058 node.add_child_nocopy (*child);
1060 node.add_property (X_("root"), to_string (_scale_root, std::dec));
1061 node.add_property (X_("root_octave"), to_string (_root_octave, std::dec));
1062 node.add_property (X_("in_key"), _in_key ? X_("yes") : X_("no"));
1063 node.add_property (X_("mode"), enum_2_string (_mode));
1069 Push2::set_state (const XMLNode & node, int version)
1071 DEBUG_TRACE (DEBUG::Push2, string_compose ("Push2::set_state: active %1\n", active()));
1075 if (ControlProtocol::set_state (node, version)) {
1081 if ((child = node.child (X_("Input"))) != 0) {
1082 XMLNode* portnode = child->child (Port::state_node_name.c_str());
1084 _async_in->set_state (*portnode, version);
1088 if ((child = node.child (X_("Output"))) != 0) {
1089 XMLNode* portnode = child->child (Port::state_node_name.c_str());
1091 _async_out->set_state (*portnode, version);
1095 XMLProperty const* prop;
1097 if ((prop = node.property (X_("root"))) != 0) {
1098 _scale_root = atoi (prop->value());
1101 if ((prop = node.property (X_("root_octave"))) != 0) {
1102 _root_octave = atoi (prop->value());
1105 if ((prop = node.property (X_("in_key"))) != 0) {
1106 _in_key = string_is_affirmative (prop->value());
1109 if ((prop = node.property (X_("mode"))) != 0) {
1110 _mode = (MusicalMode::Type) string_2_enum (prop->value(), _mode);
1117 Push2::other_vpot (int n, int delta)
1125 /* master gain control */
1127 boost::shared_ptr<AutomationControl> ac = master->gain_control();
1129 ac->set_value (ac->get_value() + ((2.0/64.0) * delta), PBD::Controllable::UseGroup);
1137 Push2::other_vpot_touch (int n, bool touching)
1146 boost::shared_ptr<AutomationControl> ac = master->gain_control();
1149 ac->start_touch (session->audible_frame());
1151 ac->stop_touch (true, session->audible_frame());
1159 Push2::start_shift ()
1161 cerr << "start shift\n";
1162 _modifier_state = ModifierState (_modifier_state | ModShift);
1163 Button* b = id_button_map[Shift];
1164 b->set_color (LED::White);
1165 b->set_state (LED::Blinking16th);
1166 write (b->state_msg());
1172 if (_modifier_state & ModShift) {
1173 cerr << "end shift\n";
1174 _modifier_state = ModifierState (_modifier_state & ~(ModShift));
1175 Button* b = id_button_map[Shift];
1176 b->timeout_connection.disconnect ();
1177 b->set_color (LED::White);
1178 b->set_state (LED::OneShot24th);
1179 write (b->state_msg());
1186 std::string splash_file;
1188 Searchpath rc (ARDOUR::ardour_data_search_path());
1189 rc.add_subdirectory_to_paths ("resources");
1191 if (!find_file (rc, PROGRAM_NAME "-splash.png", splash_file)) {
1192 cerr << "Cannot find splash screen image file\n";
1193 throw failed_constructor();
1196 Cairo::RefPtr<Cairo::ImageSurface> img = Cairo::ImageSurface::create_from_png (splash_file);
1198 double x_ratio = (double) img->get_width() / (cols - 20);
1199 double y_ratio = (double) img->get_height() / (rows - 20);
1200 double scale = min (x_ratio, y_ratio);
1204 context->set_source_rgb (0.764, 0.882, 0.882);
1210 context->translate (5, 5);
1211 context->scale (scale, scale);
1212 context->set_source (img, 0, 0);
1214 context->restore ();
1218 Glib::RefPtr<Pango::Layout> some_text = Pango::Layout::create (context);
1220 Pango::FontDescription fd ("Sans 38");
1221 some_text->set_font_description (fd);
1222 some_text->set_text (string_compose ("%1 %2", PROGRAM_NAME, VERSIONSTRING));
1224 context->move_to (200, 10);
1225 context->set_source_rgb (0, 0, 0);
1226 some_text->update_from_cairo_context (context);
1227 some_text->show_in_cairo_context (context);
1229 Pango::FontDescription fd2 ("Sans Italic 18");
1230 some_text->set_font_description (fd2);
1231 some_text->set_text (_("Ableton Push 2 Support"));
1233 context->move_to (200, 80);
1234 context->set_source_rgb (0, 0, 0);
1235 some_text->update_from_cairo_context (context);
1236 some_text->show_in_cairo_context (context);
1238 splash_start = get_microseconds ();
1239 blit_to_device_frame_buffer ();
1243 Push2::pad_filter (MidiBuffer& in, MidiBuffer& out) const
1245 /* This filter is called asynchronously from a realtime process
1246 context. It must use atomics to check state, and must not block.
1249 bool matched = false;
1251 for (MidiBuffer::iterator ev = in.begin(); ev != in.end(); ++ev) {
1252 if ((*ev).is_note_on() || (*ev).is_note_off()) {
1254 /* encoder touch start/touch end use note
1255 * 0-10. touchstrip uses note 12
1258 if ((*ev).note() > 10 && (*ev).note() != 12) {
1260 const int n = (*ev).note ();
1261 NNPadMap::const_iterator nni = nn_pad_map.find (n);
1263 if (nni != nn_pad_map.end()) {
1264 Pad const * pad = nni->second;
1265 /* shift for output to the shadow port */
1266 if (pad->filtered >= 0) {
1267 (*ev).set_note (pad->filtered + (octave_shift*12));
1268 out.push_back (*ev);
1269 /* shift back so that the pads light correctly */
1272 /* no mapping, don't send event */
1275 out.push_back (*ev);
1280 } else if ((*ev).is_pitch_bender() || (*ev).is_aftertouch() || (*ev).is_channel_pressure()) {
1281 out.push_back (*ev);
1289 Push2::connection_handler (boost::weak_ptr<ARDOUR::Port>, std::string name1, boost::weak_ptr<ARDOUR::Port>, std::string name2, bool yn)
1291 DEBUG_TRACE (DEBUG::FaderPort, "FaderPort::connection_handler start\n");
1292 if (!_input_port || !_output_port) {
1296 string ni = ARDOUR::AudioEngine::instance()->make_port_name_non_relative (boost::shared_ptr<ARDOUR::Port>(_async_in)->name());
1297 string no = ARDOUR::AudioEngine::instance()->make_port_name_non_relative (boost::shared_ptr<ARDOUR::Port>(_async_out)->name());
1299 if (ni == name1 || ni == name2) {
1301 connection_state |= InputConnected;
1303 connection_state &= ~InputConnected;
1305 } else if (no == name1 || no == name2) {
1307 connection_state |= OutputConnected;
1309 connection_state &= ~OutputConnected;
1312 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("Connections between %1 and %2 changed, but I ignored it\n", name1, name2));
1317 if ((connection_state & (InputConnected|OutputConnected)) == (InputConnected|OutputConnected)) {
1319 /* XXX this is a horrible hack. Without a short sleep here,
1320 something prevents the device wakeup messages from being
1321 sent and/or the responses from being received.
1325 DEBUG_TRACE (DEBUG::FaderPort, "device now connected for both input and output\n");
1329 DEBUG_TRACE (DEBUG::FaderPort, "Device disconnected (input or output or both) or not yet fully connected\n");
1332 ConnectionChange (); /* emit signal for our GUI */
1334 DEBUG_TRACE (DEBUG::FaderPort, "FaderPort::connection_handler end\n");
1336 return true; /* connection status changed */
1339 boost::shared_ptr<Port>
1340 Push2::output_port()
1345 boost::shared_ptr<Port>
1352 Push2::pad_note (int row, int col) const
1354 NNPadMap::const_iterator nni = nn_pad_map.find (36+(row*8)+col);
1356 if (nni != nn_pad_map.end()) {
1357 return nni->second->filtered;
1364 Push2::set_pad_scale (int root, int octave, MusicalMode::Type mode, bool inkey)
1366 MusicalMode m (mode);
1367 vector<float>::iterator interval;
1369 const int original_root = root;
1371 interval = m.steps.begin();
1372 root += (octave*12);
1375 const int root_start = root;
1377 set<int> mode_map; /* contains only notes in mode, O(logN) lookup */
1378 vector<int> mode_vector; /* sorted in note order */
1380 mode_map.insert (note);
1381 mode_vector.push_back (note);
1383 /* build a map of all notes in the mode, from the root to 127 */
1385 while (note < 128) {
1387 if (interval == m.steps.end()) {
1389 /* last distance was the end of the scale,
1390 so wrap, adding the next note at one
1391 octave above the last root.
1394 interval = m.steps.begin();
1396 mode_map.insert (root);
1397 mode_vector.push_back (root);
1400 note = (int) floor (root + (2.0 * (*interval)));
1402 mode_map.insert (note);
1403 mode_vector.push_back (note);
1409 vector<int>::iterator notei;
1411 for (int row = 0; row < 8; ++row) {
1413 /* Ableton's grid layout wraps the available notes in the scale
1414 * by offsetting 3 notes per row (from the bottom)
1417 notei = mode_vector.begin();
1418 notei += row_offset;
1421 for (int col = 0; col < 8; ++col) {
1422 int index = 36 + (row*8) + col;
1423 Pad* pad = nn_pad_map[index];
1425 if (notei != mode_vector.end()) {
1428 pad->filtered = notenum;
1430 if ((notenum % 12) == original_root) {
1431 pad->set_color (LED::Green);
1432 pad->perma_color = LED::Green;
1434 pad->set_color (LED::White);
1435 pad->perma_color = LED::White;
1438 pad->do_when_pressed = Pad::FlashOff;
1443 pad->set_color (LED::Black);
1444 pad->do_when_pressed = Pad::Nothing;
1448 write (pad->state_msg());
1454 /* chromatic: all notes available, but highlight those in the scale */
1456 for (note = 36; note < 100; ++note) {
1458 Pad* pad = nn_pad_map[note];
1460 /* Chromatic: all pads play, half-tone steps. Light
1461 * those in the scale, and highlight root notes
1464 pad->filtered = root_start + (note - 36);
1466 if (mode_map.find (note) != mode_map.end()) {
1468 if ((note % 12) == original_root) {
1469 pad->set_color (LED::Green);
1470 pad->perma_color = LED::Green;
1472 pad->set_color (LED::White);
1473 pad->perma_color = LED::White;
1476 pad->do_when_pressed = Pad::FlashOff;
1480 /* note is not in mode, turn it off */
1482 pad->do_when_pressed = Pad::FlashOn;
1483 pad->set_color (LED::Black);
1487 write (pad->state_msg());
1491 PadChange (); /* EMIT SIGNAL */
1495 _scale_root = original_root;
1496 _root_octave = octave;
1502 Push2::set_percussive_mode (bool yn)
1505 cerr << "back to scale\n";
1506 set_pad_scale (_scale_root, _root_octave, _mode, _in_key);
1513 for (int row = 0; row < 8; ++row) {
1515 for (int col = 0; col < 4; ++col) {
1517 int index = 36 + (row*8) + col;
1518 Pad* pad = nn_pad_map[index];
1520 pad->filtered = drum_note;
1525 for (int row = 0; row < 8; ++row) {
1527 for (int col = 4; col < 8; ++col) {
1529 int index = 36 + (row*8) + col;
1530 Pad* pad = nn_pad_map[index];
1532 pad->filtered = drum_note;
1539 PadChange (); /* EMIT SIGNAL */
1543 Push2::current_layout () const
1545 Glib::Threads::Mutex::Lock lm (layout_lock);
1546 return _current_layout;
1550 Push2::stripable_selection_change (StripableNotificationListPtr selected)
1552 boost::shared_ptr<MidiPort> pad_port = boost::dynamic_pointer_cast<AsyncMIDIPort>(_async_in)->shadow_port();
1553 boost::shared_ptr<MidiTrack> current_midi_track = current_pad_target.lock();
1554 boost::shared_ptr<MidiTrack> new_pad_target;
1556 /* See if there's a MIDI track selected */
1558 for (StripableNotificationList::iterator si = selected->begin(); si != selected->end(); ++si) {
1560 new_pad_target = boost::dynamic_pointer_cast<MidiTrack> ((*si).lock());
1562 if (new_pad_target) {
1567 if (new_pad_target) {
1568 cerr << "new midi pad target " << new_pad_target->name() << endl;
1570 cerr << "no midi pad target\n";
1573 if (current_midi_track == new_pad_target) {
1578 if (!new_pad_target) {
1579 /* leave existing connection alone */
1583 /* disconnect from pad port, if appropriate */
1585 if (current_midi_track && pad_port) {
1586 cerr << "Disconnect pads from " << current_midi_track->name() << endl;
1587 current_midi_track->input()->disconnect (current_midi_track->input()->nth(0), pad_port->name(), this);
1590 /* now connect the pad port to this (newly) selected midi
1591 * track, if indeed there is one.
1594 if (new_pad_target && pad_port) {
1595 cerr << "Reconnect pads to " << new_pad_target->name() << endl;
1596 new_pad_target->input()->connect (new_pad_target->input()->nth (0), pad_port->name(), this);
1597 current_pad_target = new_pad_target;
1599 current_pad_target.reset ();
1604 Push2::button_by_id (ButtonID bid)
1606 return id_button_map[bid];
1610 Push2::get_color_index (uint32_t rgb)
1612 ColorMap::iterator i = color_map.find (rgb);
1614 if (i != color_map.end()) {
1619 UINT_TO_RGBA (rgb, &r, &g, &b, &a);
1620 int w = 204; /* not sure where/when we should get this value */
1622 /* get a free index */
1626 if (color_map_free_list.empty()) {
1627 /* random replacement of any entry above zero and below 122 (where the
1628 * Ableton standard colors live)
1630 index = 1 + (random() % 121);
1632 index = color_map_free_list.top();
1633 color_map_free_list.pop();
1636 MidiByteArray palette_msg (17, 0xf0, 0x00 , 0x21, 0x1d, 0x01, 0x01, 0x03, 0x7D, 0x00, 0x00, 0x00, 0x00, 0x7F, 0x01, 0x7E, 0x00, 0xF7);
1637 MidiByteArray update_pallette_msg (8, 0xf0, 0x00, 0x21, 0x1d, 0x01, 0x01, 0x05, 0xF7);
1639 palette_msg[7] = index;
1640 palette_msg[8] = r & 0x7f;
1641 palette_msg[9] = r & 0x1;
1642 palette_msg[10] = g & 0x7f;
1643 palette_msg[11] = g & 0x1;
1644 palette_msg[12] = b & 0x7f;
1645 palette_msg[13] = b & 0x1;
1646 palette_msg[14] = w & 0x7f;
1647 palette_msg[15] = w & 0x1;
1649 write (palette_msg);
1650 write (update_pallette_msg);
1652 color_map[index] = rgb;
1658 Push2::build_color_map ()
1660 /* These are "standard" colors that Ableton docs suggest will always be
1664 color_map.insert (make_pair (RGB_TO_UINT (0,0,0), 0));
1665 color_map.insert (make_pair (RGB_TO_UINT (204,204,204), 122));
1666 color_map.insert (make_pair (RGB_TO_UINT (64,64,64), 123));
1667 color_map.insert (make_pair (RGB_TO_UINT (20,20,20), 124));
1668 color_map.insert (make_pair (RGB_TO_UINT (0,0,255), 125));
1669 color_map.insert (make_pair (RGB_TO_UINT (0,255,0), 126));
1670 color_map.insert (make_pair (RGB_TO_UINT (255,0,0), 127));
1672 for (uint8_t n = 1; n < 122; ++n) {
1673 color_map_free_list.push (n);