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"
47 using namespace ARDOUR;
51 using namespace ArdourSurface;
53 #include "pbd/abstract_ui.cc" // instantiate template
55 const int Push2::cols = 960;
56 const int Push2::rows = 160;
57 const int Push2::pixels_per_row = 1024;
59 #define ABLETON 0x2982
62 __attribute__((constructor)) static void
65 EnumWriter& enum_writer (EnumWriter::instance());
69 MusicalMode::Type mode;
71 #define REGISTER(e) enum_writer.register_distinct (typeid(e).name(), i, s); i.clear(); s.clear()
72 #define REGISTER_CLASS_ENUM(t,e) i.push_back (t::e); s.push_back (#e)
74 REGISTER_CLASS_ENUM (MusicalMode,Dorian);
75 REGISTER_CLASS_ENUM (MusicalMode, IonianMajor);
76 REGISTER_CLASS_ENUM (MusicalMode, Minor);
77 REGISTER_CLASS_ENUM (MusicalMode, HarmonicMinor);
78 REGISTER_CLASS_ENUM (MusicalMode, MelodicMinorAscending);
79 REGISTER_CLASS_ENUM (MusicalMode, MelodicMinorDescending);
80 REGISTER_CLASS_ENUM (MusicalMode, Phrygian);
81 REGISTER_CLASS_ENUM (MusicalMode, Lydian);
82 REGISTER_CLASS_ENUM (MusicalMode, Mixolydian);
83 REGISTER_CLASS_ENUM (MusicalMode, Aeolian);
84 REGISTER_CLASS_ENUM (MusicalMode, Locrian);
85 REGISTER_CLASS_ENUM (MusicalMode, PentatonicMajor);
86 REGISTER_CLASS_ENUM (MusicalMode, PentatonicMinor);
87 REGISTER_CLASS_ENUM (MusicalMode, Chromatic);
88 REGISTER_CLASS_ENUM (MusicalMode, BluesScale);
89 REGISTER_CLASS_ENUM (MusicalMode, NeapolitanMinor);
90 REGISTER_CLASS_ENUM (MusicalMode, NeapolitanMajor);
91 REGISTER_CLASS_ENUM (MusicalMode, Oriental);
92 REGISTER_CLASS_ENUM (MusicalMode, DoubleHarmonic);
93 REGISTER_CLASS_ENUM (MusicalMode, Enigmatic);
94 REGISTER_CLASS_ENUM (MusicalMode, Hirajoshi);
95 REGISTER_CLASS_ENUM (MusicalMode, HungarianMinor);
96 REGISTER_CLASS_ENUM (MusicalMode, HungarianMajor);
97 REGISTER_CLASS_ENUM (MusicalMode, Kumoi);
98 REGISTER_CLASS_ENUM (MusicalMode, Iwato);
99 REGISTER_CLASS_ENUM (MusicalMode, Hindu);
100 REGISTER_CLASS_ENUM (MusicalMode, Spanish8Tone);
101 REGISTER_CLASS_ENUM (MusicalMode, Pelog);
102 REGISTER_CLASS_ENUM (MusicalMode, HungarianGypsy);
103 REGISTER_CLASS_ENUM (MusicalMode, Overtone);
104 REGISTER_CLASS_ENUM (MusicalMode, LeadingWholeTone);
105 REGISTER_CLASS_ENUM (MusicalMode, Arabian);
106 REGISTER_CLASS_ENUM (MusicalMode, Balinese);
107 REGISTER_CLASS_ENUM (MusicalMode, Gypsy);
108 REGISTER_CLASS_ENUM (MusicalMode, Mohammedan);
109 REGISTER_CLASS_ENUM (MusicalMode, Javanese);
110 REGISTER_CLASS_ENUM (MusicalMode, Persian);
111 REGISTER_CLASS_ENUM (MusicalMode, Algerian);
115 Push2::Push2 (ARDOUR::Session& s)
116 : ControlProtocol (s, string (X_("Ableton Push 2")))
117 , AbstractUI<Push2Request> (name())
120 , frame_buffer (Cairo::ImageSurface::create (Cairo::FORMAT_ARGB32, cols, rows))
121 , _modifier_state (None)
123 , _current_layout (0)
125 , connection_state (ConnectionState (0))
127 , _mode (MusicalMode::IonianMajor)
134 context = Cairo::Context::create (frame_buffer);
139 /* master cannot be removed, so no need to connect to going-away signal */
140 master = session->master_out ();
143 throw failed_constructor ();
146 ControlProtocol::StripableSelectionChanged.connect (selection_connection, MISSING_INVALIDATOR, boost::bind (&Push2::stripable_selection_change, this, _1), this);
148 /* catch current selection, if any */
150 StripableNotificationListPtr sp (new StripableNotificationList (ControlProtocol::last_selected()));
151 stripable_selection_change (sp);
154 /* catch arrival and departure of Push2 itself */
155 ARDOUR::AudioEngine::instance()->PortRegisteredOrUnregistered.connect (port_reg_connection, MISSING_INVALIDATOR, boost::bind (&Push2::port_registration_handler, this), this);
157 /* Catch port connections and disconnections */
158 ARDOUR::AudioEngine::instance()->PortConnectedOrDisconnected.connect (port_connection, MISSING_INVALIDATOR, boost::bind (&Push2::connection_handler, this, _1, _2, _3, _4, _5), this);
160 /* ports might already be there */
161 port_registration_handler ();
170 Push2::port_registration_handler ()
172 if (_async_in->connected() && _async_out->connected()) {
173 /* don't waste cycles here */
177 string input_port_name = X_("Ableton Push 2 MIDI 1 in");
178 string output_port_name = X_("Ableton Push 2 MIDI 1 out");
182 AudioEngine::instance()->get_ports (string_compose (".*%1", input_port_name), DataType::MIDI, PortFlags (IsPhysical|IsOutput), in);
183 AudioEngine::instance()->get_ports (string_compose (".*%1", output_port_name), DataType::MIDI, PortFlags (IsPhysical|IsInput), out);
185 if (!in.empty() && !out.empty()) {
186 cerr << "Push2: both ports found\n";
187 cerr << "\tconnecting to " << in.front() << " + " << out.front() << endl;
188 if (!_async_in->connected()) {
189 AudioEngine::instance()->connect (_async_in->name(), in.front());
191 if (!_async_out->connected()) {
192 AudioEngine::instance()->connect (_async_out->name(), out.front());
207 if ((handle = libusb_open_device_with_vid_pid (NULL, ABLETON, PUSH2)) == 0) {
211 if ((err = libusb_claim_interface (handle, 0x00))) {
215 device_frame_buffer = new uint16_t[rows*pixels_per_row];
217 memset (device_frame_buffer, 0, sizeof (uint16_t) * rows * pixels_per_row);
219 frame_header[0] = 0xef;
220 frame_header[1] = 0xcd;
221 frame_header[2] = 0xab;
222 frame_header[3] = 0x89;
223 memset (&frame_header[4], 0, 12);
227 _async_in = AudioEngine::instance()->register_input_port (DataType::MIDI, X_("Push 2 in"), true);
228 _async_out = AudioEngine::instance()->register_output_port (DataType::MIDI, X_("Push 2 out"), true);
230 if (_async_in == 0 || _async_out == 0) {
234 /* We do not add our ports to the input/output bundles because we don't
235 * want users wiring them by hand. They could use JACK tools if they
236 * really insist on that.
239 _input_port = boost::dynamic_pointer_cast<AsyncMIDIPort>(_async_in).get();
240 _output_port = boost::dynamic_pointer_cast<AsyncMIDIPort>(_async_out).get();
242 /* Create a shadow port where, depending on the state of the surface,
243 * we will make pad note on/off events appear. The surface code will
244 * automatically this port to the first selected MIDI track.
247 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));
248 boost::shared_ptr<MidiPort> shadow_port = boost::dynamic_pointer_cast<AsyncMIDIPort>(_async_in)->shadow_port();
252 _output_bundle.reset (new ARDOUR::Bundle (_("Push 2 Pads"), false));
254 _output_bundle->add_channel (
256 ARDOUR::DataType::MIDI,
257 session->engine().make_port_name_non_relative (shadow_port->name())
261 session->BundleAddedOrRemoved ();
263 connect_to_parser ();
265 mix_layout = new MixLayout (*this, *session, context);
266 scale_layout = new ScaleLayout (*this, *session, context);
267 _current_layout = mix_layout;
272 list<boost::shared_ptr<ARDOUR::Bundle> >
275 list<boost::shared_ptr<ARDOUR::Bundle> > b;
277 if (_output_bundle) {
278 b.push_back (_output_bundle);
287 init_buttons (false);
289 /* wait for button data to be flushed */
291 asp = dynamic_cast<AsyncMIDIPort*> (_output_port);
292 asp->drain (10000, 500000);
294 AudioEngine::instance()->unregister_port (_async_in);
295 AudioEngine::instance()->unregister_port (_async_out);
297 _async_in.reset ((ARDOUR::Port*) 0);
298 _async_out.reset ((ARDOUR::Port*) 0);
302 vblank_connection.disconnect ();
303 periodic_connection.disconnect ();
304 session_connections.drop_connections ();
314 libusb_release_interface (handle, 0x00);
315 libusb_close (handle);
319 delete [] device_frame_buffer;
320 device_frame_buffer = 0;
326 Push2::init_buttons (bool startup)
328 /* This is a list of buttons that we want lit because they do something
329 in ardour related (loosely, sometimes) to their illuminated label.
332 ButtonID buttons[] = { Mute, Solo, Master, Up, Right, Left, Down, Note, Session, Mix, AddTrack, Delete, Undo,
333 Metronome, Shift, Select, Play, RecordEnable, Automate, Repeat, Note, Session, DoubleLoop,
334 Quantize, Duplicate, Browse, PageRight, PageLeft, OctaveUp, OctaveDown, Layout, Scale
337 for (size_t n = 0; n < sizeof (buttons) / sizeof (buttons[0]); ++n) {
338 Button* b = id_button_map[buttons[n]];
341 b->set_color (LED::White);
343 b->set_color (LED::Black);
345 b->set_state (LED::OneShot24th);
346 write (b->state_msg());
349 /* Strip buttons should all be off (black) by default. They will change
350 * color to reflect various conditions
353 ButtonID strip_buttons[] = { Upper1, Upper2, Upper3, Upper4, Upper5, Upper6, Upper7, Upper8,
354 Lower1, Lower2, Lower3, Lower4, Lower5, Lower6, Lower7, Lower8, };
356 for (size_t n = 0; n < sizeof (strip_buttons) / sizeof (strip_buttons[0]); ++n) {
357 Button* b = id_button_map[strip_buttons[n]];
359 b->set_color (LED::Black);
360 b->set_state (LED::OneShot24th);
361 write (b->state_msg());
366 /* all other buttons are off (black) */
368 ButtonID off_buttons[] = { TapTempo, Setup, User, Stop, Convert, New, FixedLength,
369 Fwd32ndT, Fwd32nd, Fwd16thT, Fwd16th, Fwd8thT, Fwd8th, Fwd4trT, Fwd4tr,
370 Accent, Note, Session, };
372 for (size_t n = 0; n < sizeof (off_buttons) / sizeof (off_buttons[0]); ++n) {
373 Button* b = id_button_map[off_buttons[n]];
375 b->set_color (LED::Black);
376 b->set_state (LED::OneShot24th);
377 write (b->state_msg());
382 for (NNPadMap::iterator pi = nn_pad_map.begin(); pi != nn_pad_map.end(); ++pi) {
383 Pad* pad = pi->second;
385 pad->set_color (LED::Black);
386 pad->set_state (LED::OneShot24th);
387 write (pad->state_msg());
395 libusb_device_handle *h;
398 if ((h = libusb_open_device_with_vid_pid (NULL, ABLETON, PUSH2)) == 0) {
399 DEBUG_TRACE (DEBUG::Push2, "no Push2 device found\n");
404 DEBUG_TRACE (DEBUG::Push2, "Push2 device located\n");
409 Push2::request_factory (uint32_t num_requests)
411 /* AbstractUI<T>::request_buffer_factory() is a template method only
412 instantiated in this source module. To provide something visible for
413 use in the interface/descriptor, we have this static method that is
416 return request_buffer_factory (num_requests);
420 Push2::do_request (Push2Request * req)
422 DEBUG_TRACE (DEBUG::Push2, string_compose ("doing request type %1\n", req->type));
423 if (req->type == CallSlot) {
425 call_slot (MISSING_INVALIDATOR, req->the_slot);
427 } else if (req->type == Quit) {
441 /** render host-side frame buffer (a Cairo ImageSurface) to the current
442 * device-side frame buffer. The device frame buffer will be pushed to the
443 * device on the next call to vblank()
447 Push2::blit_to_device_frame_buffer ()
449 /* ensure that all drawing has been done before we fetch pixel data */
451 frame_buffer->flush ();
453 const int stride = 3840; /* bytes per row for Cairo::FORMAT_ARGB32 */
454 const uint8_t* data = frame_buffer->get_data ();
456 /* fill frame buffer (320kB) */
458 uint16_t* fb = (uint16_t*) device_frame_buffer;
460 for (int row = 0; row < rows; ++row) {
462 const uint8_t* dp = data + row * stride;
464 for (int col = 0; col < cols; ++col) {
466 /* fetch r, g, b (range 0..255). Ignore alpha */
468 const int r = (*((const uint32_t*)dp) >> 16) & 0xff;
469 const int g = (*((const uint32_t*)dp) >> 8) & 0xff;
470 const int b = *((const uint32_t*)dp) & 0xff;
472 /* convert to 5 bits, 6 bits, 5 bits, respectively */
473 /* generate 16 bit BGB565 value */
475 *fb++ = (r >> 3) | ((g & 0xfc) << 3) | ((b & 0xf8) << 8);
477 /* the push2 docs state that we should xor the pixel
478 * data. Doing so doesn't work correctly, and not doing
479 * so seems to work fine (colors roughly match intended
486 /* skip 128 bytes to next line. This is filler, used to avoid line borders occuring in the middle of 512
490 fb += 64; /* 128 bytes = 64 int16_t */
501 /* display splash for 3 seconds */
503 if (get_microseconds() - splash_start > 3000000) {
510 Glib::Threads::Mutex::Lock lm (layout_lock, Glib::Threads::TRY_LOCK);
513 /* can't get layout, no re-render needed */
517 bool render_needed = false;
519 if (drawn_layout != _current_layout) {
520 render_needed = true;
523 bool dirty = _current_layout->redraw (context);
524 drawn_layout = _current_layout;
526 return dirty || render_needed;
533 const int timeout_msecs = 1000;
536 if ((err = libusb_bulk_transfer (handle, 0x01, frame_header, sizeof (frame_header), &transferred, timeout_msecs))) {
542 blit_to_device_frame_buffer ();
545 if ((err = libusb_bulk_transfer (handle, 0x01, (uint8_t*) device_frame_buffer , 2 * rows * pixels_per_row, &transferred, timeout_msecs))) {
553 Push2::set_active (bool yn)
555 DEBUG_TRACE (DEBUG::Push2, string_compose("Push2Protocol::set_active init with yn: '%1'\n", yn));
557 if (yn == active()) {
563 /* start event loop */
568 DEBUG_TRACE (DEBUG::Push2, "device open failed\n");
573 /* Connect input port to event loop */
577 asp = dynamic_cast<AsyncMIDIPort*> (_input_port);
578 asp->xthread().set_receive_handler (sigc::bind (sigc::mem_fun (this, &Push2::midi_input_handler), _input_port));
579 asp->xthread().attach (main_loop()->get_context());
581 connect_session_signals ();
583 /* set up periodic task used to push a frame buffer to the
584 * device (25fps). The device can handle 60fps, but we don't
585 * need that frame rate.
588 Glib::RefPtr<Glib::TimeoutSource> vblank_timeout = Glib::TimeoutSource::create (40); // milliseconds
589 vblank_connection = vblank_timeout->connect (sigc::mem_fun (*this, &Push2::vblank));
590 vblank_timeout->attach (main_loop()->get_context());
593 Glib::RefPtr<Glib::TimeoutSource> periodic_timeout = Glib::TimeoutSource::create (1000); // milliseconds
594 periodic_connection = periodic_timeout->connect (sigc::mem_fun (*this, &Push2::periodic));
595 periodic_timeout->attach (main_loop()->get_context());
599 set_pad_scale (_scale_root, _root_octave, _mode, _in_key);
609 ControlProtocol::set_active (yn);
611 DEBUG_TRACE (DEBUG::Push2, string_compose("Push2Protocol::set_active done with yn: '%1'\n", yn));
617 Push2::init_touch_strip ()
619 MidiByteArray msg (9, 0xf0, 0x00, 0x21, 0x1d, 0x01, 0x01, 0x17, 0x00, 0xf7);
620 /* flags are the final byte (ignore end-of-sysex */
622 /* show bar, not point
626 msg[7] = (1<<4) | (1<<5) | (1<<6);
631 Push2::write (const MidiByteArray& data)
633 /* immediate delivery */
634 _output_port->write (&data[0], data.size(), 0);
638 Push2::midi_input_handler (IOCondition ioc, MIDI::Port* port)
641 DEBUG_TRACE (DEBUG::Push2, "MIDI port closed\n");
647 // DEBUG_TRACE (DEBUG::Push2, string_compose ("something happend on %1\n", port->name()));
649 AsyncMIDIPort* asp = dynamic_cast<AsyncMIDIPort*>(port);
654 //DEBUG_TRACE (DEBUG::Push2, string_compose ("data available on %1\n", port->name()));
655 framepos_t now = AudioEngine::instance()->sample_time();
669 Push2::connect_to_parser ()
671 DEBUG_TRACE (DEBUG::Push2, string_compose ("Connecting to signals on port %2\n", _input_port->name()));
673 MIDI::Parser* p = _input_port->parser();
676 p->sysex.connect_same_thread (*this, boost::bind (&Push2::handle_midi_sysex, this, _1, _2, _3));
677 /* V-Pot messages are Controller */
678 p->controller.connect_same_thread (*this, boost::bind (&Push2::handle_midi_controller_message, this, _1, _2));
679 /* Button messages are NoteOn */
680 p->note_on.connect_same_thread (*this, boost::bind (&Push2::handle_midi_note_on_message, this, _1, _2));
681 /* Button messages are NoteOn but libmidi++ sends note-on w/velocity = 0 as note-off so catch them too */
682 p->note_off.connect_same_thread (*this, boost::bind (&Push2::handle_midi_note_on_message, this, _1, _2));
683 /* Fader messages are Pitchbend */
684 p->channel_pitchbend[0].connect_same_thread (*this, boost::bind (&Push2::handle_midi_pitchbend_message, this, _1, _2));
688 Push2::handle_midi_sysex (MIDI::Parser&, MIDI::byte* raw_bytes, size_t sz)
690 DEBUG_TRACE (DEBUG::Push2, string_compose ("Sysex, %1 bytes\n", sz));
694 Push2::handle_midi_controller_message (MIDI::Parser&, MIDI::EventTwoBytes* ev)
696 DEBUG_TRACE (DEBUG::Push2, string_compose ("CC %1 (value %2)\n", (int) ev->controller_number, (int) ev->value));
698 CCButtonMap::iterator b = cc_button_map.find (ev->controller_number);
701 /* any press cancels any pending long press timeouts */
702 for (set<ButtonID>::iterator x = buttons_down.begin(); x != buttons_down.end(); ++x) {
703 Button* bb = id_button_map[*x];
704 bb->timeout_connection.disconnect ();
708 if (b != cc_button_map.end()) {
710 Button* button = b->second;
713 buttons_down.insert (button->id);
714 start_press_timeout (*button, button->id);
716 buttons_down.erase (button->id);
717 button->timeout_connection.disconnect ();
721 set<ButtonID>::iterator c = consumed.find (button->id);
723 if (c == consumed.end()) {
724 if (ev->value == 0) {
725 (this->*button->release_method)();
727 (this->*button->press_method)();
730 DEBUG_TRACE (DEBUG::Push2, "button was consumed, ignored\n");
738 int delta = ev->value;
741 delta = -(128 - delta);
744 switch (ev->controller_number) {
746 _current_layout->strip_vpot (0, delta);
749 _current_layout->strip_vpot (1, delta);
752 _current_layout->strip_vpot (2, delta);
755 _current_layout->strip_vpot (3, delta);
758 _current_layout->strip_vpot (4, delta);
761 _current_layout->strip_vpot (5, delta);
764 _current_layout->strip_vpot (6, delta);
767 _current_layout->strip_vpot (7, delta);
772 other_vpot (8, delta);
775 other_vpot (1, delta);
780 other_vpot (2, delta);
787 Push2::handle_midi_note_on_message (MIDI::Parser& parser, MIDI::EventTwoBytes* ev)
789 DEBUG_TRACE (DEBUG::Push2, string_compose ("Note On %1 (velocity %2)\n", (int) ev->note_number, (int) ev->velocity));
791 if (ev->velocity == 0) {
792 handle_midi_note_off_message (parser, ev);
796 switch (ev->note_number) {
798 _current_layout->strip_vpot_touch (0, ev->velocity > 64);
801 _current_layout->strip_vpot_touch (1, ev->velocity > 64);
804 _current_layout->strip_vpot_touch (2, ev->velocity > 64);
807 _current_layout->strip_vpot_touch (3, ev->velocity > 64);
810 _current_layout->strip_vpot_touch (4, ev->velocity > 64);
813 _current_layout->strip_vpot_touch (5, ev->velocity > 64);
816 _current_layout->strip_vpot_touch (6, ev->velocity > 64);
819 _current_layout->strip_vpot_touch (7, ev->velocity > 64);
824 other_vpot_touch (0, ev->velocity > 64);
827 other_vpot_touch (1, ev->velocity > 64);
832 other_vpot_touch (3, ev->velocity > 64);
837 if (ev->velocity < 64) {
843 if (ev->note_number < 11) {
849 NNPadMap::iterator pi = nn_pad_map.find (ev->note_number);
851 if (pi == nn_pad_map.end()) {
855 Pad* pad = pi->second;
857 if (pad->do_when_pressed == Pad::FlashOn) {
858 pad->set_color (LED::White);
859 pad->set_state (LED::OneShot24th);
860 write (pad->state_msg());
861 } else if (pad->do_when_pressed == Pad::FlashOff) {
862 pad->set_color (LED::Black);
863 pad->set_state (LED::OneShot24th);
864 write (pad->state_msg());
869 Push2::handle_midi_note_off_message (MIDI::Parser&, MIDI::EventTwoBytes* ev)
871 DEBUG_TRACE (DEBUG::Push2, string_compose ("Note Off %1 (velocity %2)\n", (int) ev->note_number, (int) ev->velocity));
873 if (ev->note_number < 11) {
874 /* theoretically related to encoder touch start/end, but
875 * actually they send note on with two different velocity
881 NNPadMap::iterator pi = nn_pad_map.find (ev->note_number);
883 if (pi == nn_pad_map.end()) {
887 Pad* pad = pi->second;
889 if (pad->do_when_pressed == Pad::FlashOn) {
890 pad->set_color (LED::Black);
891 pad->set_state (LED::OneShot24th);
892 write (pad->state_msg());
893 } else if (pad->do_when_pressed == Pad::FlashOff) {
894 pad->set_color (pad->perma_color);
895 pad->set_state (LED::OneShot24th);
896 write (pad->state_msg());
901 Push2::handle_midi_pitchbend_message (MIDI::Parser&, MIDI::pitchbend_t pb)
906 Push2::thread_init ()
908 struct sched_param rtparam;
910 pthread_set_name (event_loop_name().c_str());
912 PBD::notify_event_loops_about_thread_creation (pthread_self(), event_loop_name(), 2048);
913 ARDOUR::SessionEvent::create_per_thread_pool (event_loop_name(), 128);
915 memset (&rtparam, 0, sizeof (rtparam));
916 rtparam.sched_priority = 9; /* XXX should be relative to audio (JACK) thread */
918 if (pthread_setschedparam (pthread_self(), SCHED_FIFO, &rtparam) != 0) {
919 // do we care? not particularly.
924 Push2::connect_session_signals()
926 // receive routes added
927 //session->RouteAdded.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_routes_added, this, _1), this);
928 // receive VCAs added
929 //session->vca_manager().VCAAdded.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&Push2::notify_vca_added, this, _1), this);
931 // receive record state toggled
932 session->RecordStateChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&Push2::notify_record_state_changed, this), this);
933 // receive transport state changed
934 session->TransportStateChange.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&Push2::notify_transport_state_changed, this), this);
935 session->TransportLooped.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&Push2::notify_loop_state_changed, this), this);
936 // receive punch-in and punch-out
937 Config->ParameterChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&Push2::notify_parameter_changed, this, _1), this);
938 session->config.ParameterChanged.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&Push2::notify_parameter_changed, this, _1), this);
939 // receive rude solo changed
940 session->SoloActive.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&Push2::notify_solo_active_changed, this, _1), this);
944 Push2::notify_record_state_changed ()
946 IDButtonMap::iterator b = id_button_map.find (RecordEnable);
948 if (b == id_button_map.end()) {
952 switch (session->record_status ()) {
953 case Session::Disabled:
954 b->second->set_color (LED::White);
955 b->second->set_state (LED::NoTransition);
957 case Session::Enabled:
958 b->second->set_color (LED::Red);
959 b->second->set_state (LED::Blinking4th);
961 case Session::Recording:
962 b->second->set_color (LED::Red);
963 b->second->set_state (LED::OneShot24th);
967 write (b->second->state_msg());
971 Push2::notify_transport_state_changed ()
973 Button* b = id_button_map[Play];
975 if (session->transport_rolling()) {
976 b->set_state (LED::OneShot24th);
977 b->set_color (LED::Green);
980 /* disable any blink on FixedLength from pending edit range op */
981 Button* fl = id_button_map[FixedLength];
983 fl->set_color (LED::Black);
984 fl->set_state (LED::NoTransition);
985 write (fl->state_msg());
987 b->set_color (LED::White);
988 b->set_state (LED::NoTransition);
991 write (b->state_msg());
995 Push2::notify_loop_state_changed ()
1000 Push2::notify_parameter_changed (std::string param)
1002 IDButtonMap::iterator b;
1004 if (param == "clicking") {
1005 if ((b = id_button_map.find (Metronome)) == id_button_map.end()) {
1008 if (Config->get_clicking()) {
1009 b->second->set_state (LED::Blinking4th);
1010 b->second->set_color (LED::White);
1012 b->second->set_color (LED::White);
1013 b->second->set_state (LED::NoTransition);
1015 write (b->second->state_msg ());
1020 Push2::notify_solo_active_changed (bool yn)
1022 IDButtonMap::iterator b = id_button_map.find (Solo);
1024 if (b == id_button_map.end()) {
1029 b->second->set_state (LED::Blinking4th);
1030 b->second->set_color (LED::Red);
1032 b->second->set_state (LED::NoTransition);
1033 b->second->set_color (LED::White);
1036 write (b->second->state_msg());
1042 XMLNode& node (ControlProtocol::get_state());
1045 child = new XMLNode (X_("Input"));
1046 child->add_child_nocopy (_async_in->get_state());
1047 node.add_child_nocopy (*child);
1048 child = new XMLNode (X_("Output"));
1049 child->add_child_nocopy (_async_out->get_state());
1050 node.add_child_nocopy (*child);
1052 node.add_property (X_("root"), to_string (_scale_root, std::dec));
1053 node.add_property (X_("root_octave"), to_string (_root_octave, std::dec));
1054 node.add_property (X_("in_key"), _in_key ? X_("yes") : X_("no"));
1055 node.add_property (X_("mode"), enum_2_string (_mode));
1061 Push2::set_state (const XMLNode & node, int version)
1063 DEBUG_TRACE (DEBUG::Push2, string_compose ("Push2::set_state: active %1\n", active()));
1067 if (ControlProtocol::set_state (node, version)) {
1073 if ((child = node.child (X_("Input"))) != 0) {
1074 XMLNode* portnode = child->child (Port::state_node_name.c_str());
1076 _async_in->set_state (*portnode, version);
1080 if ((child = node.child (X_("Output"))) != 0) {
1081 XMLNode* portnode = child->child (Port::state_node_name.c_str());
1083 _async_out->set_state (*portnode, version);
1087 XMLProperty const* prop;
1089 if ((prop = node.property (X_("root"))) != 0) {
1090 _scale_root = atoi (prop->value());
1093 if ((prop = node.property (X_("root_octave"))) != 0) {
1094 _root_octave = atoi (prop->value());
1097 if ((prop = node.property (X_("in_key"))) != 0) {
1098 _in_key = string_is_affirmative (prop->value());
1101 if ((prop = node.property (X_("mode"))) != 0) {
1102 _mode = (MusicalMode::Type) string_2_enum (prop->value(), _mode);
1109 Push2::other_vpot (int n, int delta)
1117 /* master gain control */
1119 boost::shared_ptr<AutomationControl> ac = master->gain_control();
1121 ac->set_value (ac->get_value() + ((2.0/64.0) * delta), PBD::Controllable::UseGroup);
1129 Push2::other_vpot_touch (int n, bool touching)
1138 boost::shared_ptr<AutomationControl> ac = master->gain_control();
1141 ac->start_touch (session->audible_frame());
1143 ac->stop_touch (true, session->audible_frame());
1151 Push2::start_shift ()
1153 cerr << "start shift\n";
1154 _modifier_state = ModifierState (_modifier_state | ModShift);
1155 Button* b = id_button_map[Shift];
1156 b->set_color (LED::White);
1157 b->set_state (LED::Blinking16th);
1158 write (b->state_msg());
1164 if (_modifier_state & ModShift) {
1165 cerr << "end shift\n";
1166 _modifier_state = ModifierState (_modifier_state & ~(ModShift));
1167 Button* b = id_button_map[Shift];
1168 b->timeout_connection.disconnect ();
1169 b->set_color (LED::White);
1170 b->set_state (LED::OneShot24th);
1171 write (b->state_msg());
1178 std::string splash_file;
1180 Searchpath rc (ARDOUR::ardour_data_search_path());
1181 rc.add_subdirectory_to_paths ("resources");
1183 if (!find_file (rc, PROGRAM_NAME "-splash.png", splash_file)) {
1184 cerr << "Cannot find splash screen image file\n";
1185 throw failed_constructor();
1188 Cairo::RefPtr<Cairo::ImageSurface> img = Cairo::ImageSurface::create_from_png (splash_file);
1190 double x_ratio = (double) img->get_width() / (cols - 20);
1191 double y_ratio = (double) img->get_height() / (rows - 20);
1192 double scale = min (x_ratio, y_ratio);
1196 context->set_source_rgb (0.764, 0.882, 0.882);
1202 context->translate (5, 5);
1203 context->scale (scale, scale);
1204 context->set_source (img, 0, 0);
1206 context->restore ();
1210 Glib::RefPtr<Pango::Layout> some_text = Pango::Layout::create (context);
1212 Pango::FontDescription fd ("Sans 38");
1213 some_text->set_font_description (fd);
1214 some_text->set_text (string_compose ("%1 %2", PROGRAM_NAME, VERSIONSTRING));
1216 context->move_to (200, 10);
1217 context->set_source_rgb (0, 0, 0);
1218 some_text->update_from_cairo_context (context);
1219 some_text->show_in_cairo_context (context);
1221 Pango::FontDescription fd2 ("Sans Italic 18");
1222 some_text->set_font_description (fd2);
1223 some_text->set_text (_("Ableton Push 2 Support"));
1225 context->move_to (200, 80);
1226 context->set_source_rgb (0, 0, 0);
1227 some_text->update_from_cairo_context (context);
1228 some_text->show_in_cairo_context (context);
1230 splash_start = get_microseconds ();
1231 blit_to_device_frame_buffer ();
1235 Push2::pad_filter (MidiBuffer& in, MidiBuffer& out) const
1237 /* This filter is called asynchronously from a realtime process
1238 context. It must use atomics to check state, and must not block.
1241 bool matched = false;
1243 for (MidiBuffer::iterator ev = in.begin(); ev != in.end(); ++ev) {
1244 if ((*ev).is_note_on() || (*ev).is_note_off()) {
1246 /* encoder touch start/touch end use note
1247 * 0-10. touchstrip uses note 12
1250 if ((*ev).note() > 10 && (*ev).note() != 12) {
1252 const int n = (*ev).note ();
1253 NNPadMap::const_iterator nni = nn_pad_map.find (n);
1255 if (nni != nn_pad_map.end()) {
1256 Pad const * pad = nni->second;
1257 /* shift for output to the shadow port */
1258 if (pad->filtered >= 0) {
1259 (*ev).set_note (pad->filtered + (octave_shift*12));
1260 out.push_back (*ev);
1261 /* shift back so that the pads light correctly */
1264 /* no mapping, don't send event */
1267 out.push_back (*ev);
1272 } else if ((*ev).is_pitch_bender() || (*ev).is_aftertouch() || (*ev).is_channel_pressure()) {
1273 out.push_back (*ev);
1281 Push2::connection_handler (boost::weak_ptr<ARDOUR::Port>, std::string name1, boost::weak_ptr<ARDOUR::Port>, std::string name2, bool yn)
1283 DEBUG_TRACE (DEBUG::FaderPort, "FaderPort::connection_handler start\n");
1284 if (!_input_port || !_output_port) {
1288 string ni = ARDOUR::AudioEngine::instance()->make_port_name_non_relative (boost::shared_ptr<ARDOUR::Port>(_async_in)->name());
1289 string no = ARDOUR::AudioEngine::instance()->make_port_name_non_relative (boost::shared_ptr<ARDOUR::Port>(_async_out)->name());
1291 if (ni == name1 || ni == name2) {
1293 connection_state |= InputConnected;
1295 connection_state &= ~InputConnected;
1297 } else if (no == name1 || no == name2) {
1299 connection_state |= OutputConnected;
1301 connection_state &= ~OutputConnected;
1304 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("Connections between %1 and %2 changed, but I ignored it\n", name1, name2));
1309 if ((connection_state & (InputConnected|OutputConnected)) == (InputConnected|OutputConnected)) {
1311 /* XXX this is a horrible hack. Without a short sleep here,
1312 something prevents the device wakeup messages from being
1313 sent and/or the responses from being received.
1317 DEBUG_TRACE (DEBUG::FaderPort, "device now connected for both input and output\n");
1321 DEBUG_TRACE (DEBUG::FaderPort, "Device disconnected (input or output or both) or not yet fully connected\n");
1324 ConnectionChange (); /* emit signal for our GUI */
1326 DEBUG_TRACE (DEBUG::FaderPort, "FaderPort::connection_handler end\n");
1328 return true; /* connection status changed */
1331 boost::shared_ptr<Port>
1332 Push2::output_port()
1337 boost::shared_ptr<Port>
1344 Push2::build_pad_table ()
1346 for (int n = 36; n < 100; ++n) {
1347 pad_map[n] = n + (octave_shift*12);
1350 PadChange (); /* emit signal */
1354 Push2::pad_note (int row, int col) const
1356 NNPadMap::const_iterator nni = nn_pad_map.find (36+(row*8)+col);
1358 if (nni != nn_pad_map.end()) {
1359 return nni->second->filtered;
1366 Push2::set_pad_scale (int root, int octave, MusicalMode::Type mode, bool inkey)
1368 MusicalMode m (mode);
1369 vector<float>::iterator interval;
1371 const int original_root = root;
1373 interval = m.steps.begin();
1374 root += (octave*12);
1377 const int root_start = root;
1379 set<int> mode_map; /* contains only notes in mode, O(logN) lookup */
1380 vector<int> mode_vector; /* sorted in note order */
1382 mode_map.insert (note);
1383 mode_vector.push_back (note);
1385 /* build a map of all notes in the mode, from the root to 127 */
1387 while (note < 128) {
1389 if (interval == m.steps.end()) {
1391 /* last distance was the end of the scale,
1392 so wrap, adding the next note at one
1393 octave above the last root.
1396 interval = m.steps.begin();
1398 mode_map.insert (root);
1399 mode_vector.push_back (root);
1402 note = (int) floor (root + (2.0 * (*interval)));
1404 mode_map.insert (note);
1405 mode_vector.push_back (note);
1411 vector<int>::iterator notei;
1413 for (int row = 0; row < 8; ++row) {
1415 /* Ableton's grid layout wraps the available notes in the scale
1416 * by offsetting 3 notes per row (from the bottom)
1419 notei = mode_vector.begin();
1420 notei += row_offset;
1423 for (int col = 0; col < 8; ++col) {
1424 int index = 36 + (row*8) + col;
1425 Pad* pad = nn_pad_map[index];
1427 if (notei != mode_vector.end()) {
1430 pad->filtered = notenum;
1432 if ((notenum % 12) == original_root) {
1433 pad->set_color (LED::Green);
1434 pad->perma_color = LED::Green;
1436 pad->set_color (LED::White);
1437 pad->perma_color = LED::White;
1440 pad->do_when_pressed = Pad::FlashOff;
1445 pad->set_color (LED::Black);
1446 pad->do_when_pressed = Pad::Nothing;
1450 write (pad->state_msg());
1456 /* chromatic: all notes available, but highlight those in the scale */
1458 for (note = 36; note < 100; ++note) {
1460 Pad* pad = nn_pad_map[note];
1462 /* Chromatic: all pads play, half-tone steps. Light
1463 * those in the scale, and highlight root notes
1466 pad->filtered = root_start + (note - 36);
1468 if (mode_map.find (note) != mode_map.end()) {
1470 if ((note % 12) == original_root) {
1471 pad->set_color (LED::Green);
1472 pad->perma_color = LED::Green;
1474 pad->set_color (LED::White);
1475 pad->perma_color = LED::White;
1478 pad->do_when_pressed = Pad::FlashOff;
1482 /* note is not in mode, turn it off */
1484 pad->do_when_pressed = Pad::FlashOn;
1485 pad->set_color (LED::Black);
1489 write (pad->state_msg());
1493 PadChange (); /* EMIT SIGNAL */
1497 _scale_root = original_root;
1498 _root_octave = octave;
1504 Push2::set_percussive_mode (bool yn)
1507 cerr << "back to scale\n";
1508 set_pad_scale (_scale_root, _root_octave, _mode, _in_key);
1515 for (int row = 0; row < 8; ++row) {
1517 for (int col = 0; col < 4; ++col) {
1519 int index = 36 + (row*8) + col;
1520 Pad* pad = nn_pad_map[index];
1522 pad->filtered = drum_note;
1527 for (int row = 0; row < 8; ++row) {
1529 for (int col = 4; col < 8; ++col) {
1531 int index = 36 + (row*8) + col;
1532 Pad* pad = nn_pad_map[index];
1534 pad->filtered = drum_note;
1541 PadChange (); /* EMIT SIGNAL */
1545 Push2::current_layout () const
1547 Glib::Threads::Mutex::Lock lm (layout_lock);
1548 return _current_layout;
1552 Push2::stripable_selection_change (StripableNotificationListPtr selected)
1554 boost::shared_ptr<MidiPort> pad_port = boost::dynamic_pointer_cast<AsyncMIDIPort>(_async_in)->shadow_port();
1555 boost::shared_ptr<MidiTrack> current_midi_track = current_pad_target.lock();
1556 boost::shared_ptr<MidiTrack> new_pad_target;
1558 /* See if there's a MIDI track selected */
1560 for (StripableNotificationList::iterator si = selected->begin(); si != selected->end(); ++si) {
1562 new_pad_target = boost::dynamic_pointer_cast<MidiTrack> ((*si).lock());
1564 if (new_pad_target) {
1569 if (new_pad_target) {
1570 cerr << "new midi pad target " << new_pad_target->name() << endl;
1572 cerr << "no midi pad target\n";
1575 if (current_midi_track == new_pad_target) {
1580 if (!new_pad_target) {
1581 /* leave existing connection alone */
1585 /* disconnect from pad port, if appropriate */
1587 if (current_midi_track && pad_port) {
1588 cerr << "Disconnect pads from " << current_midi_track->name() << endl;
1589 current_midi_track->input()->disconnect (current_midi_track->input()->nth(0), pad_port->name(), this);
1592 /* now connect the pad port to this (newly) selected midi
1593 * track, if indeed there is one.
1596 if (new_pad_target && pad_port) {
1597 cerr << "Reconnect pads to " << new_pad_target->name() << endl;
1598 new_pad_target->input()->connect (new_pad_target->input()->nth (0), pad_port->name(), this);
1599 current_pad_target = new_pad_target;
1601 current_pad_target.reset ();
1606 Push2::button_by_id (ButtonID bid)
1608 return id_button_map[bid];