1 /* Faderport 8 Control Surface
2 * This is the button "Controller" of the MVC surface inteface,
3 * see callbacks.cc for the "View".
5 * Copyright (C) 2017 Robin Gareus <robin@gareus.org>
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 #include "ardour/dB.h"
23 #include "ardour/plugin_insert.h"
24 #include "ardour/session.h"
25 #include "ardour/session_configuration.h"
26 #include "ardour/track.h"
27 #include "ardour/types.h"
29 #include "gtkmm2ext/actions.h"
31 #include "faderport8.h"
36 using namespace ARDOUR;
37 using namespace ArdourSurface::FP_NAMESPACE;
38 using namespace ArdourSurface::FP_NAMESPACE::FP8Types;
40 #define BindMethod(ID, CB) \
41 _ctrls.button (FP8Controls::ID).released.connect_same_thread (button_connections, boost::bind (&FaderPort8:: CB, this));
43 #define BindMethod2(ID, ACT, CB) \
44 _ctrls.button (FP8Controls::ID). ACT .connect_same_thread (button_connections, boost::bind (&FaderPort8:: CB, this));
46 #define BindFunction(ID, ACT, CB, ...) \
47 _ctrls.button (FP8Controls::ID). ACT .connect_same_thread (button_connections, boost::bind (&FaderPort8:: CB, this, __VA_ARGS__));
49 #define BindAction(ID, GRP, ITEM) \
50 _ctrls.button (FP8Controls::ID).released.connect_same_thread (button_connections, boost::bind (&FaderPort8::button_action, this, GRP, ITEM));
52 #define BindUserAction(ID) \
53 _ctrls.button (ID).pressed.connect_same_thread (button_connections, boost::bind (&FaderPort8::button_user, this, true, ID)); \
54 _ctrls.button (ID).released.connect_same_thread (button_connections, boost::bind (&FaderPort8::button_user, this, false, ID));
57 /* Bind button signals (press, release) to callback methods
58 * (called once after constructing buttons).
59 * Bound actions are handled the the ctrl-surface thread.
62 FaderPort8::setup_actions ()
64 BindMethod2 (BtnPlay, pressed, button_play);
65 BindMethod2 (BtnStop, pressed, button_stop);
66 BindMethod2 (BtnLoop, pressed, button_loop);
67 BindMethod2 (BtnRecord, pressed, button_record);
68 BindMethod2 (BtnClick, pressed, button_metronom);
69 BindAction (BtnRedo, "Editor", "redo");
71 BindAction (BtnSave, "Common", "Save");
72 BindAction (BtnUndo, "Editor", "undo");
73 BindAction (BtnRedo, "Editor", "redo");
75 #ifdef FP8_MUTESOLO_UNDO
76 BindMethod (BtnSoloClear, button_solo_clear);
78 BindAction (BtnSoloClear, "Main", "cancel-solo");
80 BindMethod (BtnMuteClear, button_mute_clear);
82 BindMethod (FP8Controls::BtnArmAll, button_arm_all);
84 BindFunction (BtnRewind, pressed, button_varispeed, false);
85 BindFunction (BtnFastForward, pressed, button_varispeed, true);
87 BindFunction (BtnPrev, released, button_prev_next, false);
88 BindFunction (BtnNext, released, button_prev_next, true);
90 BindFunction (BtnArm, pressed, button_arm, true);
91 BindFunction (BtnArm, released, button_arm, false);
93 BindFunction (BtnAOff, released, button_automation, ARDOUR::Off);
94 BindFunction (BtnATouch, released, button_automation, ARDOUR::Touch);
95 BindFunction (BtnARead, released, button_automation, ARDOUR::Play);
96 BindFunction (BtnAWrite, released, button_automation, ARDOUR::Write);
97 BindFunction (BtnALatch, released, button_automation, ARDOUR::Latch);
99 _ctrls.button (FP8Controls::BtnEncoder).pressed.connect_same_thread (button_connections, boost::bind (&FaderPort8::button_encoder, this));
101 _ctrls.button (FP8Controls::BtnParam).pressed.connect_same_thread (button_connections, boost::bind (&FaderPort8::button_encoder, this));
103 _ctrls.button (FP8Controls::BtnParam).pressed.connect_same_thread (button_connections, boost::bind (&FaderPort8::button_parameter, this));
107 BindMethod (BtnBypass, button_bypass);
108 BindAction (BtnBypassAll, "Mixer", "ab-plugins");
110 BindAction (BtnMacro, "Common", "toggle-editor-and-mixer");
111 BindMethod (BtnOpen, button_open);
113 BindMethod (BtnLink, button_link);
114 BindMethod (BtnLock, button_lock);
117 BindMethod (BtnChanLock, button_chanlock);
118 BindMethod (BtnFlip, button_flip);
122 for (FP8Controls::UserButtonMap::const_iterator i = _ctrls.user_buttons ().begin ();
123 i != _ctrls.user_buttons ().end (); ++i) {
124 BindUserAction ((*i).first);
128 /* ****************************************************************************
129 * Direct control callback Actions
133 FaderPort8::button_play ()
135 if (session->transport_rolling ()) {
136 if (session->transport_speed () != 1.0) {
137 session->request_transport_speed (1.0);
147 FaderPort8::button_stop ()
149 if (session->transport_rolling ()) {
152 AccessAction ("Transport", "GotoStart");
157 FaderPort8::button_record ()
159 set_record_enable (!get_record_enabled ());
163 FaderPort8::button_loop ()
169 FaderPort8::button_metronom ()
171 Config->set_clicking (!Config->get_clicking ());
175 FaderPort8::button_bypass ()
177 boost::shared_ptr<PluginInsert> pi = _plugin_insert.lock();
179 pi->enable (! pi->enabled ());
181 AccessAction ("Mixer", "ab-plugins");
186 FaderPort8::button_open ()
188 boost::shared_ptr<PluginInsert> pi = _plugin_insert.lock();
190 pi->ToggleUI (); /* EMIT SIGNAL */
192 AccessAction ("Common", "addExistingAudioFiles");
197 FaderPort8::button_chanlock ()
199 _chan_locked = !_chan_locked;
201 _ctrls.button (FP8Controls::BtnChannel).set_blinking (_chan_locked);
205 FaderPort8::button_flip ()
210 FaderPort8::button_lock ()
212 if (!_link_enabled) {
213 AccessAction ("Editor", "lock");
218 } else if (!_link_control.expired ()) {
224 FaderPort8::button_link ()
226 switch (_ctrls.fader_mode()) {
236 //AccessAction ("Window", "show-mixer");
242 FaderPort8::button_automation (ARDOUR::AutoState as)
244 FaderMode fadermode = _ctrls.fader_mode ();
247 #if 0 // Plugin Control Automation Mode
248 for (std::list <ProcessorCtrl>::iterator i = _proc_params.begin(); i != _proc_params.end(); ++i) {
249 ((*i).ac)->set_automation_state (as);
254 if (first_selected_stripable()) {
255 #if 0 // Send Level Automation
256 boost::shared_ptr<Stripable> s = first_selected_stripable();
257 boost::shared_ptr<AutomationControl> send;
259 while (0 != (send = s->send_level_controllable (i))) {
260 send->set_automation_state (as);
270 // TODO link/lock control automation?
272 // apply to all selected tracks
274 session->get_stripables (all);
275 for (StripableList::const_iterator i = all.begin(); i != all.end(); ++i) {
276 if ((*i)->is_master() || (*i)->is_monitor()) {
279 if (!(*i)->is_selected()) {
282 boost::shared_ptr<AutomationControl> ac;
285 ac = (*i)->gain_control ();
288 ac = (*i)->pan_azimuth_control ();
294 ac->set_automation_state (as);
300 FaderPort8::button_varispeed (bool ffw)
302 /* pressing both rew + ffwd -> return to zero */
303 FP8ButtonInterface& b_rew = _ctrls.button (FP8Controls::BtnRewind);
304 FP8ButtonInterface& b_ffw = _ctrls.button (FP8Controls::BtnFastForward);
305 if (b_rew.is_pressed () && b_ffw.is_pressed ()){
307 dynamic_cast<FP8RepeatButton*>(&b_ffw)->stop_repeat();
308 dynamic_cast<FP8RepeatButton*>(&b_rew)->stop_repeat();
309 session->request_locate (0, false);
313 // switch play direction, if needed
315 if (session->transport_speed () <= 0) {
316 session->request_transport_speed (1.0);
320 if (session->transport_speed () >= 0) {
321 session->request_transport_speed (-1.0);
325 // incremetally increase speed. double speed every 10 clicks
326 // (keypress auto-repeat is 100ms)
327 float maxspeed = Config->get_shuttle_max_speed();
328 float speed = exp2f(0.1f) * session->transport_speed ();
329 speed = std::max (-maxspeed, std::min (maxspeed, speed));
330 session->request_transport_speed (speed, false);
333 #ifdef FP8_MUTESOLO_UNDO
335 FaderPort8::button_solo_clear ()
337 bool soloing = session->soloing() || session->listening();
339 soloing |= session->mixbus_soloed();
343 session->get_stripables (all);
344 for (StripableList::const_iterator i = all.begin(); i != all.end(); ++i) {
345 if ((*i)->is_master() || (*i)->is_auditioner() || (*i)->is_monitor()) {
348 boost::shared_ptr<SoloControl> sc = (*i)->solo_control();
349 if (sc && sc->self_soloed ()) {
350 _solo_state.push_back (boost::weak_ptr<AutomationControl>(sc));
353 cancel_all_solo (); // AccessAction ("Main", "cancel-solo");
356 boost::shared_ptr<ControlList> cl (new ControlList);
357 for (std::vector <boost::weak_ptr<AutomationControl> >::const_iterator i = _solo_state.begin(); i != _solo_state.end(); ++i) {
358 boost::shared_ptr<AutomationControl> ac = (*i).lock();
362 ac->start_touch (ac->session().transport_sample());
366 session->set_controls (cl, 1.0, PBD::Controllable::NoGroup);
373 FaderPort8::button_mute_clear ()
375 #ifdef FP8_MUTESOLO_UNDO
376 if (session->muted ()) {
377 _mute_state = session->cancel_all_mute ();
380 boost::shared_ptr<ControlList> cl (new ControlList);
381 for (std::vector <boost::weak_ptr<AutomationControl> >::const_iterator i = _mute_state.begin(); i != _mute_state.end(); ++i) {
382 boost::shared_ptr<AutomationControl> ac = (*i).lock();
387 ac->start_touch (ac->session().transport_sample());
390 session->set_controls (cl, 1.0, PBD::Controllable::NoGroup);
394 session->cancel_all_mute ();
399 FaderPort8::button_arm_all ()
401 BasicUI::all_tracks_rec_in ();
404 /* access generic action */
406 FaderPort8::button_action (const std::string& group, const std::string& item)
408 AccessAction (group, item);
411 /* ****************************************************************************
412 * Control Interaction (encoder)
416 FaderPort8::handle_encoder_pan (int steps)
418 boost::shared_ptr<Stripable> s = first_selected_stripable();
420 boost::shared_ptr<AutomationControl> ac;
421 if (shift_mod () || _ctrls.fader_mode() == ModePan) {
422 ac = s->pan_width_control ();
424 ac = s->pan_azimuth_control ();
427 ac->start_touch (ac->session().transport_sample());
429 ac->set_value (ac->normal(), PBD::Controllable::UseGroup);
431 double v = ac->internal_to_interface (ac->get_value());
432 v = std::max (0.0, std::min (1.0, v + steps * .01));
433 ac->set_value (ac->interface_to_internal(v), PBD::Controllable::UseGroup);
440 FaderPort8::handle_encoder_link (int steps)
442 if (_link_control.expired ()) {
445 boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl> (_link_control.lock ());
450 double v = ac->internal_to_interface (ac->get_value());
451 ac->start_touch (ac->session().transport_sample());
454 ac->set_value (ac->normal(), PBD::Controllable::UseGroup);
458 if (ac->desc().toggled) {
460 } else if (ac->desc().integer_step) {
461 v += steps / (1.f + ac->desc().upper - ac->desc().lower);
462 } else if (ac->desc().enumeration) {
463 ac->set_value (ac->desc().step_enum (ac->get_value(), steps < 0), PBD::Controllable::UseGroup);
466 v = std::max (0.0, std::min (1.0, v + steps * .01));
468 ac->set_value (ac->interface_to_internal(v), PBD::Controllable::UseGroup);
472 /* ****************************************************************************
473 * Mode specific and internal callbacks
476 /* handle "ARM" press -- act like shift, change "Select" button mode */
478 FaderPort8::button_arm (bool press)
481 boost::shared_ptr<Stripable> s = first_selected_stripable();
483 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track>(s);
485 t->rec_enable_control()->set_value (!t->rec_enable_control()->get_value(), PBD::Controllable::UseGroup);
489 FaderMode fadermode = _ctrls.fader_mode ();
490 if (fadermode == ModeTrack || fadermode == ModePan) {
491 _ctrls.button (FP8Controls::BtnArm).set_active (press);
492 ARMButtonChange (press); /* EMIT SIGNAL */
498 FaderPort8::button_prev_next (bool next)
500 switch (_ctrls.nav_mode()) {
503 select_prev_next (next);
516 VerticalZoomInSelected ();
518 VerticalZoomOutSelected ();
523 AccessAction ("Region", "nudge-forward");
525 AccessAction ("Region", "nudge-backward");
538 /* handle navigation encoder press */
540 FaderPort8::button_encoder ()
542 /* special-case metronome level */
543 if (_ctrls.button (FP8Controls::BtnClick).is_pressed ()) {
544 Config->set_click_gain (1.0);
545 _ctrls.button (FP8Controls::BtnClick).ignore_release();
548 switch (_ctrls.nav_mode()) {
550 ZoomToSession (); // XXX undo zoom
556 AccessAction ("Editor", "select-topmost");
559 move_selected_into_view ();
563 /* master || monitor level -- reset to 0dB */
564 boost::shared_ptr<AutomationControl> ac;
565 if (session->monitor_active() && !_ctrls.button (FP8Controls::BtnMaster).is_pressed ()) {
566 ac = session->monitor_out()->gain_control ();
567 } else if (session->master_out()) {
568 ac = session->master_out()->gain_control ();
571 ac->start_touch (ac->session().transport_sample());
572 ac->set_value (ac->normal(), PBD::Controllable::NoGroup);
584 /* Don't add another mark if one exists within 1/100th of a second of
585 * the current position and we're not rolling.
587 samplepos_t where = session->audible_sample();
588 if (session->transport_stopped() && session->locations()->mark_at (where, session->sample_rate() / 100.0)) {
592 session->locations()->next_available_name (markername,"mark");
593 add_marker (markername);
599 /* handle navigation encoder turn */
601 FaderPort8::encoder_navigate (bool neg, int steps)
603 /* special-case metronome level */
604 if (_ctrls.button (FP8Controls::BtnClick).is_pressed ()) {
605 // compare to ARDOUR_UI::click_button_scroll()
606 gain_t gain = Config->get_click_gain();
607 float gain_db = accurate_coefficient_to_dB (gain);
608 gain_db += (neg ? -1.f : 1.f) * steps;
609 gain_db = std::max (-60.f, gain_db);
610 gain = dB_to_coefficient (gain_db);
611 gain = std::min (gain, Config->get_max_gain());
612 Config->set_click_gain (gain);
613 _ctrls.button (FP8Controls::BtnClick).ignore_release();
617 switch (_ctrls.nav_mode()) {
620 AccessAction ("Mixer", "scroll-left");
621 AccessAction ("Editor", "step-tracks-up");
623 AccessAction ("Mixer", "scroll-right");
624 AccessAction ("Editor", "step-tracks-down");
636 ScrollTimeline ((neg ? -1.f : 1.f) * steps / (shift_mod() ? 1024.f : 256.f));
643 /* master || monitor level */
644 boost::shared_ptr<AutomationControl> ac;
645 if (session->monitor_active() && !_ctrls.button (FP8Controls::BtnMaster).is_pressed ()) {
646 ac = session->monitor_out()->gain_control ();
647 } else if (session->master_out()) {
648 ac = session->master_out()->gain_control ();
651 double v = ac->internal_to_interface (ac->get_value());
652 v = std::max (0.0, std::min (1.0, v + steps * (neg ? -.01 : .01)));
653 ac->start_touch (ac->session().transport_sample());
654 ac->set_value (ac->interface_to_internal(v), PBD::Controllable::NoGroup);
660 AccessAction ("Common", "nudge-playhead-backward");
662 AccessAction ("Common", "nudge-playhead-forward");
666 abort(); /*NOTREACHED*/
671 /* handle pan/param encoder press */
673 FaderPort8::button_parameter ()
675 switch (_ctrls.fader_mode()) {
678 if (_link_enabled || _link_locked) {
679 handle_encoder_link (0);
681 handle_encoder_pan (0);
685 toggle_preset_param_mode ();
692 /* handle pan/param encoder turn */
694 FaderPort8::encoder_parameter (bool neg, int steps)
696 switch (_ctrls.fader_mode()) {
700 if (_link_enabled || _link_locked) {
701 handle_encoder_link (neg ? -steps : steps);
703 handle_encoder_pan (neg ? -steps : steps);
710 bank_param (neg, shift_mod());
717 /* handle user-specific actions */
719 FaderPort8::button_user (bool press, FP8Controls::ButtonId btn)
721 _user_action_map[btn].call (*this, press);