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/session.h"
24 #include "ardour/session_configuration.h"
25 #include "ardour/types.h"
27 #include "gtkmm2ext/actions.h"
29 #include "faderport8.h"
33 using namespace ARDOUR;
34 using namespace ArdourSurface;
36 using namespace ArdourSurface::FP8Types;
38 #define BindMethod(ID, CB) \
39 _ctrls.button (FP8Controls::ID).released.connect_same_thread (button_connections, boost::bind (&FaderPort8:: CB, this));
41 #define BindFunction(ID, ACT, CB, ...) \
42 _ctrls.button (FP8Controls::ID). ACT .connect_same_thread (button_connections, boost::bind (&FaderPort8:: CB, this, __VA_ARGS__));
44 #define BindAction(ID, GRP, ITEM) \
45 _ctrls.button (FP8Controls::ID).released.connect_same_thread (button_connections, boost::bind (&FaderPort8::button_action, this, GRP, ITEM));
47 #define BindUserAction(ID) \
48 _ctrls.button (ID).pressed.connect_same_thread (button_connections, boost::bind (&FaderPort8::button_user, this, true, ID)); \
49 _ctrls.button (ID).released.connect_same_thread (button_connections, boost::bind (&FaderPort8::button_user, this, false, ID));
52 /* Bind button signals (press, release) to callback methods
53 * (called once after constructing buttons).
54 * Bound actions are handled the the ctrl-surface thread.
57 FaderPort8::setup_actions ()
59 BindMethod (BtnPlay, button_play);
60 BindMethod (BtnStop, button_stop);
61 BindMethod (BtnLoop, button_loop);
62 BindMethod (BtnRecord, button_record);
63 BindMethod (BtnClick, button_metronom);
64 BindAction (BtnRedo, "Editor", "redo");
66 BindAction (BtnSave, "Common", "Save");
67 BindAction (BtnUndo, "Editor", "undo");
68 BindAction (BtnRedo, "Editor", "redo");
70 BindAction (BtnSoloClear, "Main", "cancel-solo");
71 BindMethod (BtnMuteClear, button_mute_clear);
73 BindMethod (FP8Controls::BtnArmAll, button_arm_all);
75 BindFunction (BtnRewind, pressed, button_varispeed, false);
76 BindFunction (BtnFastForward, pressed, button_varispeed, true);
78 BindFunction (BtnPrev, released, button_prev_next, false);
79 BindFunction (BtnNext, released, button_prev_next, true);
81 BindFunction (BtnArm, pressed, button_arm, true);
82 BindFunction (BtnArm, released, button_arm, false);
84 BindFunction (BtnAOff, released, button_automation, ARDOUR::Off);
85 BindFunction (BtnATouch, released, button_automation, ARDOUR::Touch);
86 BindFunction (BtnARead, released, button_automation, ARDOUR::Play);
87 BindFunction (BtnAWrite, released, button_automation, ARDOUR::Write);
89 _ctrls.button (FP8Controls::BtnEncoder).pressed.connect_same_thread (button_connections, boost::bind (&FaderPort8::button_encoder, this));
90 _ctrls.button (FP8Controls::BtnParam).pressed.connect_same_thread (button_connections, boost::bind (&FaderPort8::button_parameter, this));
93 BindAction (BtnBypass, "Mixer", "ab-plugins");
94 BindAction (BtnBypassAll, "Mixer", "ab-plugins"); // XXX
96 BindAction (BtnMacro, "Mixer", "show-editor");
97 BindAction (BtnLink, "Window", "show-mixer");
99 BindAction (BtnOpen, "Common", "addExistingAudioFiles");
100 BindAction (BtnLock, "Editor", "lock");
103 for (FP8Controls::UserButtonMap::const_iterator i = _ctrls.user_buttons ().begin ();
104 i != _ctrls.user_buttons ().end (); ++i) {
105 BindUserAction ((*i).first);
109 /* ****************************************************************************
110 * Direct control callback Actions
114 FaderPort8::button_play ()
116 if (session->transport_rolling ()) {
117 if (session->transport_speed () != 1.0) {
118 session->request_transport_speed (1.0);
128 FaderPort8::button_stop ()
130 if (session->transport_rolling ()) {
133 AccessAction ("Transport", "GotoStart");
138 FaderPort8::button_record ()
140 set_record_enable (!get_record_enabled ());
144 FaderPort8::button_loop ()
150 FaderPort8::button_metronom ()
152 Config->set_clicking (!Config->get_clicking ());
156 FaderPort8::button_automation (ARDOUR::AutoState as)
158 FaderMode fadermode = _ctrls.fader_mode ();
161 #if 0 // Plugin Control Automation Mode
162 for ( std::list <ProcessorCtrl>::iterator i = _proc_params.begin(); i != _proc_params.end(); ++i) {
163 ((*i).ac)->set_automation_state (as);
168 if (first_selected_stripable()) {
169 #if 0 // Send Level Automation
170 boost::shared_ptr<Stripable> s = first_selected_stripable();
171 boost::shared_ptr<AutomationControl> send;
173 while (0 != (send = s->send_level_controllable (i))) {
174 send->set_automation_state (as);
184 // apply to all selected tracks
186 session->get_stripables (all);
187 for (StripableList::const_iterator i = all.begin(); i != all.end(); ++i) {
188 if ((*i)->is_master() || (*i)->is_monitor()) {
191 if (!(*i)->is_selected()) {
194 boost::shared_ptr<AutomationControl> ac;
197 ac = (*i)->gain_control ();
200 ac = (*i)->pan_azimuth_control ();
206 ac->set_automation_state (as);
212 FaderPort8::button_varispeed (bool ffw)
214 /* pressing both rew + ffwd -> return to zero */
215 FP8ButtonInterface& b_rew = _ctrls.button (FP8Controls::BtnRewind);
216 FP8ButtonInterface& b_ffw = _ctrls.button (FP8Controls::BtnFastForward);
217 if (b_rew.is_pressed () && b_ffw.is_pressed ()){
219 dynamic_cast<FP8RepeatButton*>(&b_ffw)->stop_repeat();
220 dynamic_cast<FP8RepeatButton*>(&b_rew)->stop_repeat();
221 session->request_locate (0, false);
225 // switch play direction, if needed
227 if (session->transport_speed () <= 0) {
228 session->request_transport_speed (1.0);
232 if (session->transport_speed () >= 0) {
233 session->request_transport_speed (-1.0);
237 // incremetally increase speed. double speed every 10 clicks
238 // (keypress auto-repeat is 100ms)
239 float maxspeed = Config->get_shuttle_max_speed();
240 float speed = exp2f(0.1f) * session->transport_speed ();
241 speed = std::max (-maxspeed, std::min (maxspeed, speed));
242 session->request_transport_speed (speed, false);
246 FaderPort8::button_mute_clear ()
249 session->get_stripables (all);
250 boost::shared_ptr<ControlList> cl (new ControlList);
251 for (StripableList::const_iterator i = all.begin(); i != all.end(); ++i) {
252 if ((*i)->is_master() || (*i)->is_monitor()) {
255 boost::shared_ptr<AutomationControl> ac = (*i)->mute_control();
256 if (ac && ac->get_value () > 0) {
257 if (ac->automation_state() == Touch && !ac->touching ()) {
258 ac->start_touch (ac->session().transport_frame());
263 session->set_controls (cl, 0.0, PBD::Controllable::UseGroup);
267 FaderPort8::button_arm_all ()
269 BasicUI::all_tracks_rec_in ();
272 /* access generic action */
274 FaderPort8::button_action (const std::string& group, const std::string& item)
276 AccessAction (group, item);
279 /* ****************************************************************************
280 * Mode specific and internal callbacks
283 /* handle "ARM" press -- act like shift, change "Select" button mode */
285 FaderPort8::button_arm (bool press)
287 FaderMode fadermode = _ctrls.fader_mode ();
288 if (fadermode == ModeTrack || fadermode == ModePan) {
289 _ctrls.button (FP8Controls::BtnArm).set_active (press);
290 ARMButtonChange (press); /* EMIT SIGNAL */
295 FaderPort8::button_prev_next (bool next)
297 switch (_ctrls.nav_mode()) {
299 select_prev_next (next);
310 VerticalZoomInSelected ();
312 VerticalZoomOutSelected ();
317 AccessAction ("Region", "nudge-forward");
319 AccessAction ("Region", "nudge-backward");
332 /* handle navigation encoder press */
334 FaderPort8::button_encoder ()
336 /* special-case metronome level */
337 if (_ctrls.button (FP8Controls::BtnClick).is_pressed ()) {
338 Config->set_click_gain (1.0);
339 _ctrls.button (FP8Controls::BtnClick).ignore_release();
342 switch (_ctrls.nav_mode()) {
344 ZoomToSession (); // XXX undo zoom
351 move_selected_into_view ();
355 /* master || monitor level -- reset to 0dB */
356 boost::shared_ptr<AutomationControl> ac;
357 if (session->monitor_active() && !_ctrls.button (FP8Controls::BtnMaster).is_pressed ()) {
358 ac = session->monitor_out()->gain_control ();
359 } else if (session->master_out()) {
360 ac = session->master_out()->gain_control ();
363 if (ac->automation_state() == Touch && !ac->touching ()) {
364 ac->start_touch (ac->session().transport_frame());
366 ac->set_value (ac->normal(), PBD::Controllable::NoGroup);
376 /* Don't add another mark if one exists within 1/100th of a second of
377 * the current position and we're not rolling.
379 framepos_t where = session->audible_frame();
380 if (session->transport_stopped() && session->locations()->mark_at (where, session->frame_rate() / 100.0)) {
384 session->locations()->next_available_name (markername,"mark");
385 add_marker (markername);
391 /* handle navigation encoder turn */
393 FaderPort8::encoder_navigate (bool neg, int steps)
395 /* special-case metronome level */
396 if (_ctrls.button (FP8Controls::BtnClick).is_pressed ()) {
397 // compare to ARDOUR_UI::click_button_scroll()
398 gain_t gain = Config->get_click_gain();
399 float gain_db = accurate_coefficient_to_dB (gain);
400 gain_db += (neg ? -1.f : 1.f) * steps;
401 gain_db = std::max (-60.f, gain_db);
402 gain = dB_to_coefficient (gain_db);
403 gain = std::min (gain, Config->get_max_gain());
404 Config->set_click_gain (gain);
405 _ctrls.button (FP8Controls::BtnClick).ignore_release();
409 switch (_ctrls.nav_mode()) {
412 AccessAction ("Mixer", "scroll-left");
413 AccessAction ("Editor", "step-tracks-up");
415 AccessAction ("Mixer", "scroll-right");
416 AccessAction ("Editor", "step-tracks-down");
428 ScrollTimeline ((neg ? -1.f : 1.f) * steps / (shift_mod() ? 1024.f : 256.f));
435 /* master || monitor level */
436 boost::shared_ptr<AutomationControl> ac;
437 if (session->monitor_active() && !_ctrls.button (FP8Controls::BtnMaster).is_pressed ()) {
438 ac = session->monitor_out()->gain_control ();
439 } else if (session->master_out()) {
440 ac = session->master_out()->gain_control ();
443 double v = ac->internal_to_interface (ac->get_value());
444 v = std::max (0.0, std::min (1.0, v + steps * (neg ? -.01 : .01)));
445 if (ac->automation_state() == Touch && !ac->touching ()) {
446 ac->start_touch (ac->session().transport_frame());
448 ac->set_value (ac->interface_to_internal(v), PBD::Controllable::NoGroup);
454 AccessAction ("Common", "nudge-playhead-backward");
456 AccessAction ("Common", "nudge-playhead-forward");
462 /* handle pan/param encoder press */
464 FaderPort8::button_parameter ()
466 switch (_ctrls.fader_mode()) {
470 boost::shared_ptr<Stripable> s = first_selected_stripable();
472 boost::shared_ptr<AutomationControl> ac;
473 if (shift_mod () || _ctrls.fader_mode() == ModePan) {
474 ac = s->pan_width_control ();
476 ac = s->pan_azimuth_control ();
479 if (ac->automation_state() == Touch && !ac->touching ()) {
480 ac->start_touch (ac->session().transport_frame());
482 ac->set_value (ac->normal(), PBD::Controllable::UseGroup);
494 /* handle pan/param encoder turn */
496 FaderPort8::encoder_parameter (bool neg, int steps)
498 switch (_ctrls.fader_mode()) {
502 boost::shared_ptr<Stripable> s = first_selected_stripable();
504 boost::shared_ptr<AutomationControl> ac;
505 if (shift_mod () || _ctrls.fader_mode() == ModePan) {
506 ac = s->pan_width_control ();
508 ac = s->pan_azimuth_control ();
511 double v = ac->internal_to_interface (ac->get_value());
512 v = std::max (0.0, std::min (1.0, v + steps * (neg ? -.01 : .01)));
513 if (ac->automation_state() == Touch && !ac->touching ()) {
514 ac->start_touch (ac->session().transport_frame());
516 ac->set_value (ac->interface_to_internal(v), PBD::Controllable::UseGroup);
524 bank_param (neg, false);
531 /* handle user-specific actions */
533 FaderPort8::button_user (bool press, FP8Controls::ButtonId btn)
535 _user_action_map[btn].call (*this, press);