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"
46 #include "track_mix.h"
51 using namespace ARDOUR;
55 using namespace ArdourSurface;
57 #include "pbd/abstract_ui.cc" // instantiate template
59 const int Push2::cols = 960;
60 const int Push2::rows = 160;
61 const int Push2::pixels_per_row = 1024;
63 #define ABLETON 0x2982
66 __attribute__((constructor)) static void
69 EnumWriter& enum_writer (EnumWriter::instance());
73 MusicalMode::Type mode;
75 #define REGISTER(e) enum_writer.register_distinct (typeid(e).name(), i, s); i.clear(); s.clear()
76 #define REGISTER_CLASS_ENUM(t,e) i.push_back (t::e); s.push_back (#e)
78 REGISTER_CLASS_ENUM (MusicalMode,Dorian);
79 REGISTER_CLASS_ENUM (MusicalMode, IonianMajor);
80 REGISTER_CLASS_ENUM (MusicalMode, Minor);
81 REGISTER_CLASS_ENUM (MusicalMode, HarmonicMinor);
82 REGISTER_CLASS_ENUM (MusicalMode, MelodicMinorAscending);
83 REGISTER_CLASS_ENUM (MusicalMode, MelodicMinorDescending);
84 REGISTER_CLASS_ENUM (MusicalMode, Phrygian);
85 REGISTER_CLASS_ENUM (MusicalMode, Lydian);
86 REGISTER_CLASS_ENUM (MusicalMode, Mixolydian);
87 REGISTER_CLASS_ENUM (MusicalMode, Aeolian);
88 REGISTER_CLASS_ENUM (MusicalMode, Locrian);
89 REGISTER_CLASS_ENUM (MusicalMode, PentatonicMajor);
90 REGISTER_CLASS_ENUM (MusicalMode, PentatonicMinor);
91 REGISTER_CLASS_ENUM (MusicalMode, Chromatic);
92 REGISTER_CLASS_ENUM (MusicalMode, BluesScale);
93 REGISTER_CLASS_ENUM (MusicalMode, NeapolitanMinor);
94 REGISTER_CLASS_ENUM (MusicalMode, NeapolitanMajor);
95 REGISTER_CLASS_ENUM (MusicalMode, Oriental);
96 REGISTER_CLASS_ENUM (MusicalMode, DoubleHarmonic);
97 REGISTER_CLASS_ENUM (MusicalMode, Enigmatic);
98 REGISTER_CLASS_ENUM (MusicalMode, Hirajoshi);
99 REGISTER_CLASS_ENUM (MusicalMode, HungarianMinor);
100 REGISTER_CLASS_ENUM (MusicalMode, HungarianMajor);
101 REGISTER_CLASS_ENUM (MusicalMode, Kumoi);
102 REGISTER_CLASS_ENUM (MusicalMode, Iwato);
103 REGISTER_CLASS_ENUM (MusicalMode, Hindu);
104 REGISTER_CLASS_ENUM (MusicalMode, Spanish8Tone);
105 REGISTER_CLASS_ENUM (MusicalMode, Pelog);
106 REGISTER_CLASS_ENUM (MusicalMode, HungarianGypsy);
107 REGISTER_CLASS_ENUM (MusicalMode, Overtone);
108 REGISTER_CLASS_ENUM (MusicalMode, LeadingWholeTone);
109 REGISTER_CLASS_ENUM (MusicalMode, Arabian);
110 REGISTER_CLASS_ENUM (MusicalMode, Balinese);
111 REGISTER_CLASS_ENUM (MusicalMode, Gypsy);
112 REGISTER_CLASS_ENUM (MusicalMode, Mohammedan);
113 REGISTER_CLASS_ENUM (MusicalMode, Javanese);
114 REGISTER_CLASS_ENUM (MusicalMode, Persian);
115 REGISTER_CLASS_ENUM (MusicalMode, Algerian);
119 Push2::Push2 (ARDOUR::Session& s)
120 : ControlProtocol (s, string (X_("Ableton Push 2")))
121 , AbstractUI<Push2Request> (name())
124 , frame_buffer (Cairo::ImageSurface::create (Cairo::FORMAT_ARGB32, cols, rows))
125 , _modifier_state (None)
127 , _current_layout (0)
129 , connection_state (ConnectionState (0))
131 , _mode (MusicalMode::IonianMajor)
138 context = Cairo::Context::create (frame_buffer);
142 /* master cannot be removed, so no need to connect to going-away signal */
143 master = session->master_out ();
146 throw failed_constructor ();
149 ControlProtocol::StripableSelectionChanged.connect (selection_connection, MISSING_INVALIDATOR, boost::bind (&Push2::stripable_selection_change, this, _1), this);
151 /* catch current selection, if any */
153 StripableNotificationListPtr sp (new StripableNotificationList (ControlProtocol::last_selected()));
154 stripable_selection_change (sp);
157 /* catch arrival and departure of Push2 itself */
158 ARDOUR::AudioEngine::instance()->PortRegisteredOrUnregistered.connect (port_reg_connection, MISSING_INVALIDATOR, boost::bind (&Push2::port_registration_handler, this), this);
160 /* Catch port connections and disconnections */
161 ARDOUR::AudioEngine::instance()->PortConnectedOrDisconnected.connect (port_connection, MISSING_INVALIDATOR, boost::bind (&Push2::connection_handler, this, _1, _2, _3, _4, _5), this);
163 /* ports might already be there */
164 port_registration_handler ();
173 Push2::port_registration_handler ()
175 if (_async_in->connected() && _async_out->connected()) {
176 /* don't waste cycles here */
180 string input_port_name = X_("Ableton Push 2 MIDI 1 in");
181 string output_port_name = X_("Ableton Push 2 MIDI 1 out");
185 AudioEngine::instance()->get_ports (string_compose (".*%1", input_port_name), DataType::MIDI, PortFlags (IsPhysical|IsOutput), in);
186 AudioEngine::instance()->get_ports (string_compose (".*%1", output_port_name), DataType::MIDI, PortFlags (IsPhysical|IsInput), out);
188 if (!in.empty() && !out.empty()) {
189 cerr << "Push2: both ports found\n";
190 cerr << "\tconnecting to " << in.front() << " + " << out.front() << endl;
191 if (!_async_in->connected()) {
192 AudioEngine::instance()->connect (_async_in->name(), in.front());
194 if (!_async_out->connected()) {
195 AudioEngine::instance()->connect (_async_out->name(), out.front());
210 if ((handle = libusb_open_device_with_vid_pid (NULL, ABLETON, PUSH2)) == 0) {
214 if ((err = libusb_claim_interface (handle, 0x00))) {
218 device_frame_buffer = new uint16_t[rows*pixels_per_row];
220 memset (device_frame_buffer, 0, sizeof (uint16_t) * rows * pixels_per_row);
222 frame_header[0] = 0xef;
223 frame_header[1] = 0xcd;
224 frame_header[2] = 0xab;
225 frame_header[3] = 0x89;
226 memset (&frame_header[4], 0, 12);
230 _async_in = AudioEngine::instance()->register_input_port (DataType::MIDI, X_("Push 2 in"), true);
231 _async_out = AudioEngine::instance()->register_output_port (DataType::MIDI, X_("Push 2 out"), true);
233 if (_async_in == 0 || _async_out == 0) {
237 /* We do not add our ports to the input/output bundles because we don't
238 * want users wiring them by hand. They could use JACK tools if they
239 * really insist on that.
242 _input_port = boost::dynamic_pointer_cast<AsyncMIDIPort>(_async_in).get();
243 _output_port = boost::dynamic_pointer_cast<AsyncMIDIPort>(_async_out).get();
245 /* Create a shadow port where, depending on the state of the surface,
246 * we will make pad note on/off events appear. The surface code will
247 * automatically this port to the first selected MIDI track.
250 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));
251 boost::shared_ptr<MidiPort> shadow_port = boost::dynamic_pointer_cast<AsyncMIDIPort>(_async_in)->shadow_port();
255 _output_bundle.reset (new ARDOUR::Bundle (_("Push 2 Pads"), false));
257 _output_bundle->add_channel (
259 ARDOUR::DataType::MIDI,
260 session->engine().make_port_name_non_relative (shadow_port->name())
264 session->BundleAddedOrRemoved ();
266 connect_to_parser ();
268 mix_layout = new MixLayout (*this, *session, context);
269 scale_layout = new ScaleLayout (*this, *session, context);
270 _current_layout = mix_layout;
275 list<boost::shared_ptr<ARDOUR::Bundle> >
278 list<boost::shared_ptr<ARDOUR::Bundle> > b;
280 if (_output_bundle) {
281 b.push_back (_output_bundle);
290 init_buttons (false);
292 /* wait for button data to be flushed */
294 asp = dynamic_cast<AsyncMIDIPort*> (_output_port);
295 asp->drain (10000, 500000);
297 AudioEngine::instance()->unregister_port (_async_in);
298 AudioEngine::instance()->unregister_port (_async_out);
300 _async_in.reset ((ARDOUR::Port*) 0);
301 _async_out.reset ((ARDOUR::Port*) 0);
305 vblank_connection.disconnect ();
306 periodic_connection.disconnect ();
307 session_connections.drop_connections ();
317 libusb_release_interface (handle, 0x00);
318 libusb_close (handle);
322 delete [] device_frame_buffer;
323 device_frame_buffer = 0;
329 Push2::init_buttons (bool startup)
331 /* This is a list of buttons that we want lit because they do something
332 in ardour related (loosely, sometimes) to their illuminated label.
335 ButtonID buttons[] = { Mute, Solo, Master, Up, Right, Left, Down, Note, Session, Mix, AddTrack, Delete, Undo,
336 Metronome, Shift, Select, Play, RecordEnable, Automate, Repeat, Note, Session, DoubleLoop,
337 Quantize, Duplicate, Browse, PageRight, PageLeft, OctaveUp, OctaveDown, Layout, Scale
340 for (size_t n = 0; n < sizeof (buttons) / sizeof (buttons[0]); ++n) {
341 Button* b = id_button_map[buttons[n]];
344 b->set_color (LED::White);
346 b->set_color (LED::Black);
348 b->set_state (LED::OneShot24th);
349 write (b->state_msg());
352 /* Strip buttons should all be off (black) by default. They will change
353 * color to reflect various conditions
356 ButtonID strip_buttons[] = { Upper1, Upper2, Upper3, Upper4, Upper5, Upper6, Upper7, Upper8,
357 Lower1, Lower2, Lower3, Lower4, Lower5, Lower6, Lower7, Lower8, };
359 for (size_t n = 0; n < sizeof (strip_buttons) / sizeof (strip_buttons[0]); ++n) {
360 Button* b = id_button_map[strip_buttons[n]];
362 b->set_color (LED::Black);
363 b->set_state (LED::OneShot24th);
364 write (b->state_msg());
369 /* all other buttons are off (black) */
371 ButtonID off_buttons[] = { TapTempo, Setup, User, Stop, Convert, New, FixedLength,
372 Fwd32ndT, Fwd32nd, Fwd16thT, Fwd16th, Fwd8thT, Fwd8th, Fwd4trT, Fwd4tr,
373 Accent, Note, Session, };
375 for (size_t n = 0; n < sizeof (off_buttons) / sizeof (off_buttons[0]); ++n) {
376 Button* b = id_button_map[off_buttons[n]];
378 b->set_color (LED::Black);
379 b->set_state (LED::OneShot24th);
380 write (b->state_msg());
385 for (NNPadMap::iterator pi = nn_pad_map.begin(); pi != nn_pad_map.end(); ++pi) {
386 Pad* pad = pi->second;
388 pad->set_color (LED::Black);
389 pad->set_state (LED::OneShot24th);
390 write (pad->state_msg());
398 libusb_device_handle *h;
401 if ((h = libusb_open_device_with_vid_pid (NULL, ABLETON, PUSH2)) == 0) {
402 DEBUG_TRACE (DEBUG::Push2, "no Push2 device found\n");
407 DEBUG_TRACE (DEBUG::Push2, "Push2 device located\n");
412 Push2::request_factory (uint32_t num_requests)
414 /* AbstractUI<T>::request_buffer_factory() is a template method only
415 instantiated in this source module. To provide something visible for
416 use in the interface/descriptor, we have this static method that is
419 return request_buffer_factory (num_requests);
423 Push2::do_request (Push2Request * req)
425 DEBUG_TRACE (DEBUG::Push2, string_compose ("doing request type %1\n", req->type));
426 if (req->type == CallSlot) {
428 call_slot (MISSING_INVALIDATOR, req->the_slot);
430 } else if (req->type == Quit) {
444 /** render host-side frame buffer (a Cairo ImageSurface) to the current
445 * device-side frame buffer. The device frame buffer will be pushed to the
446 * device on the next call to vblank()
450 Push2::blit_to_device_frame_buffer ()
452 /* ensure that all drawing has been done before we fetch pixel data */
454 frame_buffer->flush ();
456 const int stride = 3840; /* bytes per row for Cairo::FORMAT_ARGB32 */
457 const uint8_t* data = frame_buffer->get_data ();
459 /* fill frame buffer (320kB) */
461 uint16_t* fb = (uint16_t*) device_frame_buffer;
463 for (int row = 0; row < rows; ++row) {
465 const uint8_t* dp = data + row * stride;
467 for (int col = 0; col < cols; ++col) {
469 /* fetch r, g, b (range 0..255). Ignore alpha */
471 const int r = (*((const uint32_t*)dp) >> 16) & 0xff;
472 const int g = (*((const uint32_t*)dp) >> 8) & 0xff;
473 const int b = *((const uint32_t*)dp) & 0xff;
475 /* convert to 5 bits, 6 bits, 5 bits, respectively */
476 /* generate 16 bit BGB565 value */
478 *fb++ = (r >> 3) | ((g & 0xfc) << 3) | ((b & 0xf8) << 8);
480 /* the push2 docs state that we should xor the pixel
481 * data. Doing so doesn't work correctly, and not doing
482 * so seems to work fine (colors roughly match intended
489 /* skip 128 bytes to next line. This is filler, used to avoid line borders occuring in the middle of 512
493 fb += 64; /* 128 bytes = 64 int16_t */
504 /* display splash for 3 seconds */
506 if (get_microseconds() - splash_start > 3000000) {
513 Glib::Threads::Mutex::Lock lm (layout_lock, Glib::Threads::TRY_LOCK);
516 /* can't get layout, no re-render needed */
520 bool render_needed = false;
522 if (drawn_layout != _current_layout) {
523 render_needed = true;
526 bool dirty = _current_layout->redraw (context);
527 drawn_layout = _current_layout;
529 return dirty || render_needed;
536 const int timeout_msecs = 1000;
539 if ((err = libusb_bulk_transfer (handle, 0x01, frame_header, sizeof (frame_header), &transferred, timeout_msecs))) {
545 blit_to_device_frame_buffer ();
548 if ((err = libusb_bulk_transfer (handle, 0x01, (uint8_t*) device_frame_buffer , 2 * rows * pixels_per_row, &transferred, timeout_msecs))) {
556 Push2::set_active (bool yn)
558 DEBUG_TRACE (DEBUG::Push2, string_compose("Push2Protocol::set_active init with yn: '%1'\n", yn));
560 if (yn == active()) {
566 /* start event loop */
571 DEBUG_TRACE (DEBUG::Push2, "device open failed\n");
576 /* Connect input port to event loop */
580 asp = dynamic_cast<AsyncMIDIPort*> (_input_port);
581 asp->xthread().set_receive_handler (sigc::bind (sigc::mem_fun (this, &Push2::midi_input_handler), _input_port));
582 asp->xthread().attach (main_loop()->get_context());
584 connect_session_signals ();
586 /* set up periodic task used to push a frame buffer to the
587 * device (25fps). The device can handle 60fps, but we don't
588 * need that frame rate.
591 Glib::RefPtr<Glib::TimeoutSource> vblank_timeout = Glib::TimeoutSource::create (40); // milliseconds
592 vblank_connection = vblank_timeout->connect (sigc::mem_fun (*this, &Push2::vblank));
593 vblank_timeout->attach (main_loop()->get_context());
596 Glib::RefPtr<Glib::TimeoutSource> periodic_timeout = Glib::TimeoutSource::create (1000); // milliseconds
597 periodic_connection = periodic_timeout->connect (sigc::mem_fun (*this, &Push2::periodic));
598 periodic_timeout->attach (main_loop()->get_context());
602 set_pad_scale (_scale_root, _root_octave, _mode, _in_key);
612 ControlProtocol::set_active (yn);
614 DEBUG_TRACE (DEBUG::Push2, string_compose("Push2Protocol::set_active done with yn: '%1'\n", yn));
620 Push2::init_touch_strip ()
622 MidiByteArray msg (9, 0xf0, 0x00, 0x21, 0x1d, 0x01, 0x01, 0x17, 0x00, 0xf7);
623 /* flags are the final byte (ignore end-of-sysex */
625 /* show bar, not point
629 msg[7] = (1<<4) | (1<<5) | (1<<6);
634 Push2::write (const MidiByteArray& data)
636 /* immediate delivery */
637 _output_port->write (&data[0], data.size(), 0);
641 Push2::midi_input_handler (IOCondition ioc, MIDI::Port* port)
644 DEBUG_TRACE (DEBUG::Push2, "MIDI port closed\n");
650 // DEBUG_TRACE (DEBUG::Push2, string_compose ("something happend on %1\n", port->name()));
652 AsyncMIDIPort* asp = dynamic_cast<AsyncMIDIPort*>(port);
657 //DEBUG_TRACE (DEBUG::Push2, string_compose ("data available on %1\n", port->name()));
658 framepos_t now = AudioEngine::instance()->sample_time();
672 Push2::connect_to_parser ()
674 DEBUG_TRACE (DEBUG::Push2, string_compose ("Connecting to signals on port %2\n", _input_port->name()));
676 MIDI::Parser* p = _input_port->parser();
679 p->sysex.connect_same_thread (*this, boost::bind (&Push2::handle_midi_sysex, this, _1, _2, _3));
680 /* V-Pot messages are Controller */
681 p->controller.connect_same_thread (*this, boost::bind (&Push2::handle_midi_controller_message, this, _1, _2));
682 /* Button messages are NoteOn */
683 p->note_on.connect_same_thread (*this, boost::bind (&Push2::handle_midi_note_on_message, this, _1, _2));
684 /* Button messages are NoteOn but libmidi++ sends note-on w/velocity = 0 as note-off so catch them too */
685 p->note_off.connect_same_thread (*this, boost::bind (&Push2::handle_midi_note_on_message, this, _1, _2));
686 /* Fader messages are Pitchbend */
687 p->channel_pitchbend[0].connect_same_thread (*this, boost::bind (&Push2::handle_midi_pitchbend_message, this, _1, _2));
691 Push2::handle_midi_sysex (MIDI::Parser&, MIDI::byte* raw_bytes, size_t sz)
693 DEBUG_TRACE (DEBUG::Push2, string_compose ("Sysex, %1 bytes\n", sz));
697 Push2::handle_midi_controller_message (MIDI::Parser&, MIDI::EventTwoBytes* ev)
699 DEBUG_TRACE (DEBUG::Push2, string_compose ("CC %1 (value %2)\n", (int) ev->controller_number, (int) ev->value));
701 CCButtonMap::iterator b = cc_button_map.find (ev->controller_number);
704 /* any press cancels any pending long press timeouts */
705 for (set<ButtonID>::iterator x = buttons_down.begin(); x != buttons_down.end(); ++x) {
706 Button* bb = id_button_map[*x];
707 bb->timeout_connection.disconnect ();
711 if (b != cc_button_map.end()) {
713 Button* button = b->second;
716 buttons_down.insert (button->id);
717 start_press_timeout (*button, button->id);
719 buttons_down.erase (button->id);
720 button->timeout_connection.disconnect ();
724 set<ButtonID>::iterator c = consumed.find (button->id);
726 if (c == consumed.end()) {
727 if (ev->value == 0) {
728 (this->*button->release_method)();
730 (this->*button->press_method)();
733 DEBUG_TRACE (DEBUG::Push2, "button was consumed, ignored\n");
741 int delta = ev->value;
744 delta = -(128 - delta);
747 switch (ev->controller_number) {
749 _current_layout->strip_vpot (0, delta);
752 _current_layout->strip_vpot (1, delta);
755 _current_layout->strip_vpot (2, delta);
758 _current_layout->strip_vpot (3, delta);
761 _current_layout->strip_vpot (4, delta);
764 _current_layout->strip_vpot (5, delta);
767 _current_layout->strip_vpot (6, delta);
770 _current_layout->strip_vpot (7, delta);
775 other_vpot (8, delta);
778 other_vpot (1, delta);
783 other_vpot (2, delta);
790 Push2::handle_midi_note_on_message (MIDI::Parser& parser, MIDI::EventTwoBytes* ev)
792 DEBUG_TRACE (DEBUG::Push2, string_compose ("Note On %1 (velocity %2)\n", (int) ev->note_number, (int) ev->velocity));
794 if (ev->velocity == 0) {
795 handle_midi_note_off_message (parser, ev);
799 switch (ev->note_number) {
801 _current_layout->strip_vpot_touch (0, ev->velocity > 64);
804 _current_layout->strip_vpot_touch (1, ev->velocity > 64);
807 _current_layout->strip_vpot_touch (2, ev->velocity > 64);
810 _current_layout->strip_vpot_touch (3, ev->velocity > 64);
813 _current_layout->strip_vpot_touch (4, ev->velocity > 64);
816 _current_layout->strip_vpot_touch (5, ev->velocity > 64);
819 _current_layout->strip_vpot_touch (6, ev->velocity > 64);
822 _current_layout->strip_vpot_touch (7, ev->velocity > 64);
827 other_vpot_touch (0, ev->velocity > 64);
830 other_vpot_touch (1, ev->velocity > 64);
835 other_vpot_touch (3, ev->velocity > 64);
840 if (ev->velocity < 64) {
846 if (ev->note_number < 11) {
852 NNPadMap::iterator pi = nn_pad_map.find (ev->note_number);
854 if (pi == nn_pad_map.end()) {
858 Pad* pad = pi->second;
860 if (pad->do_when_pressed == Pad::FlashOn) {
861 pad->set_color (LED::White);
862 pad->set_state (LED::OneShot24th);
863 write (pad->state_msg());
864 } else if (pad->do_when_pressed == Pad::FlashOff) {
865 pad->set_color (LED::Black);
866 pad->set_state (LED::OneShot24th);
867 write (pad->state_msg());
872 Push2::handle_midi_note_off_message (MIDI::Parser&, MIDI::EventTwoBytes* ev)
874 DEBUG_TRACE (DEBUG::Push2, string_compose ("Note Off %1 (velocity %2)\n", (int) ev->note_number, (int) ev->velocity));
876 if (ev->note_number < 11) {
877 /* theoretically related to encoder touch start/end, but
878 * actually they send note on with two different velocity
884 NNPadMap::iterator pi = nn_pad_map.find (ev->note_number);
886 if (pi == nn_pad_map.end()) {
890 Pad* pad = pi->second;
892 if (pad->do_when_pressed == Pad::FlashOn) {
893 pad->set_color (LED::Black);
894 pad->set_state (LED::OneShot24th);
895 write (pad->state_msg());
896 } else if (pad->do_when_pressed == Pad::FlashOff) {
897 pad->set_color (pad->perma_color);
898 pad->set_state (LED::OneShot24th);
899 write (pad->state_msg());
904 Push2::handle_midi_pitchbend_message (MIDI::Parser&, MIDI::pitchbend_t pb)
909 Push2::thread_init ()
911 struct sched_param rtparam;
913 pthread_set_name (event_loop_name().c_str());
915 PBD::notify_event_loops_about_thread_creation (pthread_self(), event_loop_name(), 2048);
916 ARDOUR::SessionEvent::create_per_thread_pool (event_loop_name(), 128);
918 memset (&rtparam, 0, sizeof (rtparam));
919 rtparam.sched_priority = 9; /* XXX should be relative to audio (JACK) thread */
921 if (pthread_setschedparam (pthread_self(), SCHED_FIFO, &rtparam) != 0) {
922 // do we care? not particularly.
927 Push2::connect_session_signals()
929 // receive routes added
930 //session->RouteAdded.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&MackieControlProtocol::notify_routes_added, this, _1), this);
931 // receive VCAs added
932 //session->vca_manager().VCAAdded.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&Push2::notify_vca_added, this, _1), this);
934 // receive record state toggled
935 session->RecordStateChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&Push2::notify_record_state_changed, this), this);
936 // receive transport state changed
937 session->TransportStateChange.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&Push2::notify_transport_state_changed, this), this);
938 session->TransportLooped.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&Push2::notify_loop_state_changed, this), this);
939 // receive punch-in and punch-out
940 Config->ParameterChanged.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&Push2::notify_parameter_changed, this, _1), this);
941 session->config.ParameterChanged.connect (session_connections, MISSING_INVALIDATOR, boost::bind (&Push2::notify_parameter_changed, this, _1), this);
942 // receive rude solo changed
943 session->SoloActive.connect(session_connections, MISSING_INVALIDATOR, boost::bind (&Push2::notify_solo_active_changed, this, _1), this);
947 Push2::notify_record_state_changed ()
949 IDButtonMap::iterator b = id_button_map.find (RecordEnable);
951 if (b == id_button_map.end()) {
955 switch (session->record_status ()) {
956 case Session::Disabled:
957 b->second->set_color (LED::White);
958 b->second->set_state (LED::NoTransition);
960 case Session::Enabled:
961 b->second->set_color (LED::Red);
962 b->second->set_state (LED::Blinking4th);
964 case Session::Recording:
965 b->second->set_color (LED::Red);
966 b->second->set_state (LED::OneShot24th);
970 write (b->second->state_msg());
974 Push2::notify_transport_state_changed ()
976 Button* b = id_button_map[Play];
978 if (session->transport_rolling()) {
979 b->set_state (LED::OneShot24th);
980 b->set_color (LED::Green);
983 /* disable any blink on FixedLength from pending edit range op */
984 Button* fl = id_button_map[FixedLength];
986 fl->set_color (LED::Black);
987 fl->set_state (LED::NoTransition);
988 write (fl->state_msg());
990 b->set_color (LED::White);
991 b->set_state (LED::NoTransition);
994 write (b->state_msg());
998 Push2::notify_loop_state_changed ()
1003 Push2::notify_parameter_changed (std::string param)
1005 IDButtonMap::iterator b;
1007 if (param == "clicking") {
1008 if ((b = id_button_map.find (Metronome)) == id_button_map.end()) {
1011 if (Config->get_clicking()) {
1012 b->second->set_state (LED::Blinking4th);
1013 b->second->set_color (LED::White);
1015 b->second->set_color (LED::White);
1016 b->second->set_state (LED::NoTransition);
1018 write (b->second->state_msg ());
1023 Push2::notify_solo_active_changed (bool yn)
1025 IDButtonMap::iterator b = id_button_map.find (Solo);
1027 if (b == id_button_map.end()) {
1032 b->second->set_state (LED::Blinking4th);
1033 b->second->set_color (LED::Red);
1035 b->second->set_state (LED::NoTransition);
1036 b->second->set_color (LED::White);
1039 write (b->second->state_msg());
1045 XMLNode& node (ControlProtocol::get_state());
1048 child = new XMLNode (X_("Input"));
1049 child->add_child_nocopy (_async_in->get_state());
1050 node.add_child_nocopy (*child);
1051 child = new XMLNode (X_("Output"));
1052 child->add_child_nocopy (_async_out->get_state());
1053 node.add_child_nocopy (*child);
1055 node.add_property (X_("root"), to_string (_scale_root, std::dec));
1056 node.add_property (X_("root_octave"), to_string (_root_octave, std::dec));
1057 node.add_property (X_("in_key"), _in_key ? X_("yes") : X_("no"));
1058 node.add_property (X_("mode"), enum_2_string (_mode));
1064 Push2::set_state (const XMLNode & node, int version)
1066 DEBUG_TRACE (DEBUG::Push2, string_compose ("Push2::set_state: active %1\n", active()));
1070 if (ControlProtocol::set_state (node, version)) {
1076 if ((child = node.child (X_("Input"))) != 0) {
1077 XMLNode* portnode = child->child (Port::state_node_name.c_str());
1079 _async_in->set_state (*portnode, version);
1083 if ((child = node.child (X_("Output"))) != 0) {
1084 XMLNode* portnode = child->child (Port::state_node_name.c_str());
1086 _async_out->set_state (*portnode, version);
1090 XMLProperty const* prop;
1092 if ((prop = node.property (X_("root"))) != 0) {
1093 _scale_root = atoi (prop->value());
1096 if ((prop = node.property (X_("root_octave"))) != 0) {
1097 _root_octave = atoi (prop->value());
1100 if ((prop = node.property (X_("in_key"))) != 0) {
1101 _in_key = string_is_affirmative (prop->value());
1104 if ((prop = node.property (X_("mode"))) != 0) {
1105 _mode = (MusicalMode::Type) string_2_enum (prop->value(), _mode);
1112 Push2::other_vpot (int n, int delta)
1120 /* master gain control */
1122 boost::shared_ptr<AutomationControl> ac = master->gain_control();
1124 ac->set_value (ac->get_value() + ((2.0/64.0) * delta), PBD::Controllable::UseGroup);
1132 Push2::other_vpot_touch (int n, bool touching)
1141 boost::shared_ptr<AutomationControl> ac = master->gain_control();
1144 ac->start_touch (session->audible_frame());
1146 ac->stop_touch (true, session->audible_frame());
1154 Push2::start_shift ()
1156 cerr << "start shift\n";
1157 _modifier_state = ModifierState (_modifier_state | ModShift);
1158 Button* b = id_button_map[Shift];
1159 b->set_color (LED::White);
1160 b->set_state (LED::Blinking16th);
1161 write (b->state_msg());
1167 if (_modifier_state & ModShift) {
1168 cerr << "end shift\n";
1169 _modifier_state = ModifierState (_modifier_state & ~(ModShift));
1170 Button* b = id_button_map[Shift];
1171 b->timeout_connection.disconnect ();
1172 b->set_color (LED::White);
1173 b->set_state (LED::OneShot24th);
1174 write (b->state_msg());
1181 std::string splash_file;
1183 Searchpath rc (ARDOUR::ardour_data_search_path());
1184 rc.add_subdirectory_to_paths ("resources");
1186 if (!find_file (rc, PROGRAM_NAME "-splash.png", splash_file)) {
1187 cerr << "Cannot find splash screen image file\n";
1188 throw failed_constructor();
1191 Cairo::RefPtr<Cairo::ImageSurface> img = Cairo::ImageSurface::create_from_png (splash_file);
1193 double x_ratio = (double) img->get_width() / (cols - 20);
1194 double y_ratio = (double) img->get_height() / (rows - 20);
1195 double scale = min (x_ratio, y_ratio);
1199 context->set_source_rgb (0.764, 0.882, 0.882);
1205 context->translate (5, 5);
1206 context->scale (scale, scale);
1207 context->set_source (img, 0, 0);
1209 context->restore ();
1213 Glib::RefPtr<Pango::Layout> some_text = Pango::Layout::create (context);
1215 Pango::FontDescription fd ("Sans 38");
1216 some_text->set_font_description (fd);
1217 some_text->set_text (string_compose ("%1 %2", PROGRAM_NAME, VERSIONSTRING));
1219 context->move_to (200, 10);
1220 context->set_source_rgb (0, 0, 0);
1221 some_text->update_from_cairo_context (context);
1222 some_text->show_in_cairo_context (context);
1224 Pango::FontDescription fd2 ("Sans Italic 18");
1225 some_text->set_font_description (fd2);
1226 some_text->set_text (_("Ableton Push 2 Support"));
1228 context->move_to (200, 80);
1229 context->set_source_rgb (0, 0, 0);
1230 some_text->update_from_cairo_context (context);
1231 some_text->show_in_cairo_context (context);
1233 splash_start = get_microseconds ();
1234 blit_to_device_frame_buffer ();
1238 Push2::pad_filter (MidiBuffer& in, MidiBuffer& out) const
1240 /* This filter is called asynchronously from a realtime process
1241 context. It must use atomics to check state, and must not block.
1244 bool matched = false;
1246 for (MidiBuffer::iterator ev = in.begin(); ev != in.end(); ++ev) {
1247 if ((*ev).is_note_on() || (*ev).is_note_off()) {
1249 /* encoder touch start/touch end use note
1250 * 0-10. touchstrip uses note 12
1253 if ((*ev).note() > 10 && (*ev).note() != 12) {
1255 const int n = (*ev).note ();
1256 NNPadMap::const_iterator nni = nn_pad_map.find (n);
1258 if (nni != nn_pad_map.end()) {
1259 Pad const * pad = nni->second;
1260 /* shift for output to the shadow port */
1261 if (pad->filtered >= 0) {
1262 (*ev).set_note (pad->filtered + (octave_shift*12));
1263 out.push_back (*ev);
1264 /* shift back so that the pads light correctly */
1267 /* no mapping, don't send event */
1270 out.push_back (*ev);
1275 } else if ((*ev).is_pitch_bender() || (*ev).is_aftertouch() || (*ev).is_channel_pressure()) {
1276 out.push_back (*ev);
1284 Push2::connection_handler (boost::weak_ptr<ARDOUR::Port>, std::string name1, boost::weak_ptr<ARDOUR::Port>, std::string name2, bool yn)
1286 DEBUG_TRACE (DEBUG::FaderPort, "FaderPort::connection_handler start\n");
1287 if (!_input_port || !_output_port) {
1291 string ni = ARDOUR::AudioEngine::instance()->make_port_name_non_relative (boost::shared_ptr<ARDOUR::Port>(_async_in)->name());
1292 string no = ARDOUR::AudioEngine::instance()->make_port_name_non_relative (boost::shared_ptr<ARDOUR::Port>(_async_out)->name());
1294 if (ni == name1 || ni == name2) {
1296 connection_state |= InputConnected;
1298 connection_state &= ~InputConnected;
1300 } else if (no == name1 || no == name2) {
1302 connection_state |= OutputConnected;
1304 connection_state &= ~OutputConnected;
1307 DEBUG_TRACE (DEBUG::FaderPort, string_compose ("Connections between %1 and %2 changed, but I ignored it\n", name1, name2));
1312 if ((connection_state & (InputConnected|OutputConnected)) == (InputConnected|OutputConnected)) {
1314 /* XXX this is a horrible hack. Without a short sleep here,
1315 something prevents the device wakeup messages from being
1316 sent and/or the responses from being received.
1320 DEBUG_TRACE (DEBUG::FaderPort, "device now connected for both input and output\n");
1324 DEBUG_TRACE (DEBUG::FaderPort, "Device disconnected (input or output or both) or not yet fully connected\n");
1327 ConnectionChange (); /* emit signal for our GUI */
1329 DEBUG_TRACE (DEBUG::FaderPort, "FaderPort::connection_handler end\n");
1331 return true; /* connection status changed */
1334 boost::shared_ptr<Port>
1335 Push2::output_port()
1340 boost::shared_ptr<Port>
1347 Push2::pad_note (int row, int col) const
1349 NNPadMap::const_iterator nni = nn_pad_map.find (36+(row*8)+col);
1351 if (nni != nn_pad_map.end()) {
1352 return nni->second->filtered;
1359 Push2::set_pad_scale (int root, int octave, MusicalMode::Type mode, bool inkey)
1361 MusicalMode m (mode);
1362 vector<float>::iterator interval;
1364 const int original_root = root;
1366 interval = m.steps.begin();
1367 root += (octave*12);
1370 const int root_start = root;
1372 set<int> mode_map; /* contains only notes in mode, O(logN) lookup */
1373 vector<int> mode_vector; /* sorted in note order */
1375 mode_map.insert (note);
1376 mode_vector.push_back (note);
1378 /* build a map of all notes in the mode, from the root to 127 */
1380 while (note < 128) {
1382 if (interval == m.steps.end()) {
1384 /* last distance was the end of the scale,
1385 so wrap, adding the next note at one
1386 octave above the last root.
1389 interval = m.steps.begin();
1391 mode_map.insert (root);
1392 mode_vector.push_back (root);
1395 note = (int) floor (root + (2.0 * (*interval)));
1397 mode_map.insert (note);
1398 mode_vector.push_back (note);
1404 vector<int>::iterator notei;
1406 for (int row = 0; row < 8; ++row) {
1408 /* Ableton's grid layout wraps the available notes in the scale
1409 * by offsetting 3 notes per row (from the bottom)
1412 notei = mode_vector.begin();
1413 notei += row_offset;
1416 for (int col = 0; col < 8; ++col) {
1417 int index = 36 + (row*8) + col;
1418 Pad* pad = nn_pad_map[index];
1420 if (notei != mode_vector.end()) {
1423 pad->filtered = notenum;
1425 if ((notenum % 12) == original_root) {
1426 pad->set_color (LED::Green);
1427 pad->perma_color = LED::Green;
1429 pad->set_color (LED::White);
1430 pad->perma_color = LED::White;
1433 pad->do_when_pressed = Pad::FlashOff;
1438 pad->set_color (LED::Black);
1439 pad->do_when_pressed = Pad::Nothing;
1443 write (pad->state_msg());
1449 /* chromatic: all notes available, but highlight those in the scale */
1451 for (note = 36; note < 100; ++note) {
1453 Pad* pad = nn_pad_map[note];
1455 /* Chromatic: all pads play, half-tone steps. Light
1456 * those in the scale, and highlight root notes
1459 pad->filtered = root_start + (note - 36);
1461 if (mode_map.find (note) != mode_map.end()) {
1463 if ((note % 12) == original_root) {
1464 pad->set_color (LED::Green);
1465 pad->perma_color = LED::Green;
1467 pad->set_color (LED::White);
1468 pad->perma_color = LED::White;
1471 pad->do_when_pressed = Pad::FlashOff;
1475 /* note is not in mode, turn it off */
1477 pad->do_when_pressed = Pad::FlashOn;
1478 pad->set_color (LED::Black);
1482 write (pad->state_msg());
1486 PadChange (); /* EMIT SIGNAL */
1490 _scale_root = original_root;
1491 _root_octave = octave;
1497 Push2::set_percussive_mode (bool yn)
1500 cerr << "back to scale\n";
1501 set_pad_scale (_scale_root, _root_octave, _mode, _in_key);
1508 for (int row = 0; row < 8; ++row) {
1510 for (int col = 0; col < 4; ++col) {
1512 int index = 36 + (row*8) + col;
1513 Pad* pad = nn_pad_map[index];
1515 pad->filtered = drum_note;
1520 for (int row = 0; row < 8; ++row) {
1522 for (int col = 4; col < 8; ++col) {
1524 int index = 36 + (row*8) + col;
1525 Pad* pad = nn_pad_map[index];
1527 pad->filtered = drum_note;
1534 PadChange (); /* EMIT SIGNAL */
1538 Push2::current_layout () const
1540 Glib::Threads::Mutex::Lock lm (layout_lock);
1541 return _current_layout;
1545 Push2::stripable_selection_change (StripableNotificationListPtr selected)
1547 boost::shared_ptr<MidiPort> pad_port = boost::dynamic_pointer_cast<AsyncMIDIPort>(_async_in)->shadow_port();
1548 boost::shared_ptr<MidiTrack> current_midi_track = current_pad_target.lock();
1549 boost::shared_ptr<MidiTrack> new_pad_target;
1551 /* See if there's a MIDI track selected */
1553 for (StripableNotificationList::iterator si = selected->begin(); si != selected->end(); ++si) {
1555 new_pad_target = boost::dynamic_pointer_cast<MidiTrack> ((*si).lock());
1557 if (new_pad_target) {
1562 if (new_pad_target) {
1563 cerr << "new midi pad target " << new_pad_target->name() << endl;
1565 cerr << "no midi pad target\n";
1568 if (current_midi_track == new_pad_target) {
1573 if (!new_pad_target) {
1574 /* leave existing connection alone */
1578 /* disconnect from pad port, if appropriate */
1580 if (current_midi_track && pad_port) {
1581 cerr << "Disconnect pads from " << current_midi_track->name() << endl;
1582 current_midi_track->input()->disconnect (current_midi_track->input()->nth(0), pad_port->name(), this);
1585 /* now connect the pad port to this (newly) selected midi
1586 * track, if indeed there is one.
1589 if (new_pad_target && pad_port) {
1590 cerr << "Reconnect pads to " << new_pad_target->name() << endl;
1591 new_pad_target->input()->connect (new_pad_target->input()->nth (0), pad_port->name(), this);
1592 current_pad_target = new_pad_target;
1594 current_pad_target.reset ();
1599 Push2::button_by_id (ButtonID bid)
1601 return id_button_map[bid];