livetrax/libs/surfaces/mackie/mcp_buttons.cc

/*
	Copyright (C) 2006,2007 John Anderson
	Copyright (C) 2012 Paul Davis

	This program is free software; you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation; either version 2 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with this program; if not, write to the Free Software
	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#include "pbd/memento_command.h"

#include "ardour/debug.h"
#include "ardour/session.h"
#include "ardour/route.h"
#include "ardour/location.h"
#include "ardour/rc_configuration.h"

#include "mackie_control_protocol.h"
#include "surface.h"

#include "i18n.h"

/* handlers for all buttons, broken into a separate file to avoid clutter in
 * mackie_control_protocol.cc 
 */

using namespace Mackie;
using namespace ARDOUR;
using namespace PBD;
using std::string;

LedState
MackieControlProtocol::shift_press (Button &)
{
	_modifier_state |= MODIFIER_SHIFT;
	return on;
}
LedState
MackieControlProtocol::shift_release (Button &)
{
	_modifier_state &= ~MODIFIER_SHIFT;
	return on;
}
LedState
MackieControlProtocol::option_press (Button &)
{
	_modifier_state |= MODIFIER_OPTION;
	return on;
}
LedState
MackieControlProtocol::option_release (Button &)
{
	_modifier_state &= ~MODIFIER_OPTION;
	return on;
}
LedState
MackieControlProtocol::control_press (Button &)
{
	_modifier_state |= MODIFIER_CONTROL;
	return on;
}
LedState
MackieControlProtocol::control_release (Button &)
{
	_modifier_state &= ~MODIFIER_CONTROL;
	return on;
}
LedState
MackieControlProtocol::cmd_alt_press (Button &)
{
	_modifier_state |= MODIFIER_CMDALT;
	return on;
}
LedState
MackieControlProtocol::cmd_alt_release (Button &)
{
	_modifier_state &= ~MODIFIER_CMDALT;
	return on;
}

LedState 
MackieControlProtocol::left_press (Button &)
{
	Sorted sorted = get_sorted_routes();
	uint32_t strip_cnt = n_strips ();

	DEBUG_TRACE (DEBUG::MackieControl, string_compose ("bank left with current initial = %1 nstrips = %2 tracks/busses = %3\n",
							   _current_initial_bank, strip_cnt, sorted.size()));

	if (sorted.size() > strip_cnt) {
		int new_initial = _current_initial_bank - strip_cnt;
		if (new_initial < 0) {
			new_initial = 0;
		}
		
		if (new_initial != int (_current_initial_bank)) {
			switch_banks (new_initial);
		}

		return on;
	} else {
		return flashing;
	}
}

LedState 
MackieControlProtocol::left_release (Button &)
{
	return off;
}

LedState 
MackieControlProtocol::right_press (Button &)
{
	Sorted sorted = get_sorted_routes();
	uint32_t strip_cnt = n_strips();

	DEBUG_TRACE (DEBUG::MackieControl, string_compose ("bank right with current initial = %1 nstrips = %2 tracks/busses = %3\n",
							   _current_initial_bank, strip_cnt, sorted.size()));

	if (sorted.size() > strip_cnt) {
		uint32_t delta = sorted.size() - (strip_cnt + _current_initial_bank);

		if (delta > strip_cnt) {
			delta = strip_cnt;
		}
		
		if (delta > 0) {
			switch_banks (_current_initial_bank + delta);
		}

		return on;
	} else {
		return flashing;
	}
	return off;
}

LedState 
MackieControlProtocol::right_release (Button &)
{
	if (_zoom_mode) {

	}

	return off;
}

LedState
MackieControlProtocol::cursor_left_press (Button& )
{
	if (_zoom_mode) {

		if (_modifier_state & MODIFIER_OPTION) {
			/* reset selected tracks to default vertical zoom */
		} else {
			ZoomOut (); /* EMIT SIGNAL */
		}
	}

	return off;
}

LedState
MackieControlProtocol::cursor_left_release (Button&)
{
	return off;
}

LedState
MackieControlProtocol::cursor_right_press (Button& )
{
	if (_zoom_mode) {
		
		if (_modifier_state & MODIFIER_OPTION) {
			/* reset selected tracks to default vertical zoom */
		} else {
			ZoomIn (); /* EMIT SIGNAL */
		}
	}

	return off;
}

LedState
MackieControlProtocol::cursor_right_release (Button&)
{
	return off;
}

LedState
MackieControlProtocol::cursor_up_press (Button&)
{
	if (_zoom_mode) {
		if (_modifier_state & MODIFIER_OPTION) {
			VerticalZoomOutSelected (); /* EMIT SIGNAL */
		} else {
			VerticalZoomOutAll (); /* EMIT SIGNAL */
		}
	}
	return off;
}

LedState
MackieControlProtocol::cursor_up_release (Button&)
{
	return off;
}

LedState
MackieControlProtocol::cursor_down_press (Button&)
{
	if (_zoom_mode) {
		
		if (_modifier_state & MODIFIER_OPTION) {
			VerticalZoomInSelected (); /* EMIT SIGNAL */
		} else {
			VerticalZoomInAll (); /* EMIT SIGNAL */
		}
	}
	return off;
}

LedState
MackieControlProtocol::cursor_down_release (Button&)
{
	return off;
}

LedState 
MackieControlProtocol::channel_left_press (Button &)
{
	Sorted sorted = get_sorted_routes();
	if (sorted.size() > n_strips()) {
		prev_track();
		return on;
	} else {
		return flashing;
	}
}

LedState 
MackieControlProtocol::channel_left_release (Button &)
{
	return off;
}

LedState 
MackieControlProtocol::channel_right_press (Button &)
{
	Sorted sorted = get_sorted_routes();
	if (sorted.size() > n_strips()) {
		next_track();
		return on;
	} else {
		return flashing;
	}
}

LedState 
MackieControlProtocol::channel_right_release (Button &)
{
	return off;
}

Mackie::LedState 
MackieControlProtocol::zoom_press (Mackie::Button &)
{
	_zoom_mode = !_zoom_mode;
	return (_zoom_mode ? on : off);
}

Mackie::LedState 
MackieControlProtocol::zoom_release (Mackie::Button &)
{
	return (_zoom_mode ? on : off);
}

Mackie::LedState 
MackieControlProtocol::scrub_press (Mackie::Button &)
{
	_scrub_mode = !_scrub_mode;
	return (_scrub_mode ? on : off);
}

Mackie::LedState 
MackieControlProtocol::scrub_release (Mackie::Button &)
{
	return (_scrub_mode ? on : off);
}

LedState
MackieControlProtocol::undo_press (Button&)
{
	if (_modifier_state & MODIFIER_SHIFT) {
		Redo(); /* EMIT SIGNAL */
	} else {
		Undo(); /* EMIT SIGNAL */
	}
	return off;
}

LedState
MackieControlProtocol::undo_release (Button&)
{
	return off;
}

LedState
MackieControlProtocol::redo_press (Button&)
{
	Redo(); /* EMIT SIGNAL */
	return off;
}

LedState
MackieControlProtocol::redo_release (Button&)
{
	return off;
}

LedState 
MackieControlProtocol::drop_press (Button &)
{
	session->remove_last_capture();
	return on;
}

LedState 
MackieControlProtocol::drop_release (Button &)
{
	return off;
}

LedState 
MackieControlProtocol::save_press (Button &)
{
	session->save_state ("");
	return on;
}

LedState 
MackieControlProtocol::save_release (Button &)
{
	return off;
}

LedState 
MackieControlProtocol::timecode_beats_press (Button &)
{
	switch (_timecode_type) {
	case ARDOUR::AnyTime::BBT:
		_timecode_type = ARDOUR::AnyTime::Timecode;
		break;
	case ARDOUR::AnyTime::Timecode:
		_timecode_type = ARDOUR::AnyTime::BBT;
		break;
	default:
		return off;
	}

	update_timecode_beats_led();

	return on;
}

LedState 
MackieControlProtocol::timecode_beats_release (Button &)
{
	return off;
}

/////////////////////////////////////
// Functions
/////////////////////////////////////
LedState 
MackieControlProtocol::marker_press (Button &)
{
	// cut'n'paste from LocationUI::add_new_location()
	string markername;
	framepos_t where = session->audible_frame();
	session->locations()->next_available_name(markername,"mcu");
	Location *location = new Location (*session, where, where, markername, Location::IsMark);
	session->begin_reversible_command (_("add marker"));
	XMLNode &before = session->locations()->get_state();
	session->locations()->add (location, true);
	XMLNode &after = session->locations()->get_state();
	session->add_command (new MementoCommand<Locations>(*(session->locations()), &before, &after));
	session->commit_reversible_command ();
	return on;
}

LedState 
MackieControlProtocol::marker_release (Button &)
{
	return off;
}

/////////////////////////////////////
// Transport Buttons
/////////////////////////////////////

LedState 
MackieControlProtocol::frm_left_press (Button &)
{
	// can use first_mark_before/after as well
	unsigned long elapsed = _frm_left_last.restart();

	Location * loc = session->locations()->first_location_before (
		session->transport_frame()
	);

	// allow a quick double to go past a previous mark
	if (session->transport_rolling() && elapsed < 500 && loc != 0) {
		Location * loc_two_back = session->locations()->first_location_before (loc->start());
		if (loc_two_back != 0)
		{
			loc = loc_two_back;
		}
	}

	// move to the location, if it's valid
	if (loc != 0) {
		session->request_locate (loc->start(), session->transport_rolling());
	}

	return on;
}

LedState 
MackieControlProtocol::frm_left_release (Button &)
{
	return off;
}

LedState 
MackieControlProtocol::frm_right_press (Button &)
{
	// can use first_mark_before/after as well
	Location * loc = session->locations()->first_location_after (session->transport_frame());
	
	if (loc != 0) {
		session->request_locate (loc->start(), session->transport_rolling());
	}
		
	return on;
}

LedState 
MackieControlProtocol::frm_right_release (Button &)
{
	return off;
}

LedState 
MackieControlProtocol::stop_press (Button &)
{
	transport_stop ();
	return on;
}

LedState 
MackieControlProtocol::stop_release (Button &)
{
	return session->transport_stopped();
}

LedState 
MackieControlProtocol::play_press (Button &)
{
	transport_play ();
	return none;
}

LedState 
MackieControlProtocol::play_release (Button &)
{
	return none;
}

LedState 
MackieControlProtocol::record_press (Button &)
{
	rec_enable_toggle ();
	return none;
}

LedState 
MackieControlProtocol::record_release (Button &)
{
	return none;
}

LedState 
MackieControlProtocol::rewind_press (Button &)
{
	rewind ();
	return none;
}

LedState 
MackieControlProtocol::rewind_release (Button &)
{
	return none;
}

LedState 
MackieControlProtocol::ffwd_press (Button &)
{
	ffwd ();
	return none;
}

LedState 
MackieControlProtocol::ffwd_release (Button &)
{
	return none;
}

LedState 
MackieControlProtocol::loop_press (Button &)
{
	if (_modifier_state & MODIFIER_CONTROL) {
		set_view_mode (Loop);
		return on;
	} else {
		session->request_play_loop (!session->get_play_loop());
		return none;
	}
}

LedState 
MackieControlProtocol::loop_release (Button &)
{
	return none;
}

LedState 
MackieControlProtocol::punch_in_press (Button &)
{
	bool const state = !session->config.get_punch_in();
	session->config.set_punch_in (state);
	return state;
}

LedState 
MackieControlProtocol::punch_in_release (Button &)
{
	return session->config.get_punch_in();
}

LedState 
MackieControlProtocol::punch_out_press (Button &)
{
	bool const state = !session->config.get_punch_out();
	session->config.set_punch_out (state);
	return state;
}

LedState 
MackieControlProtocol::punch_out_release (Button &)
{
	return session->config.get_punch_out();
}

LedState 
MackieControlProtocol::home_press (Button &)
{
	session->goto_start();
	return on;
}

LedState 
MackieControlProtocol::home_release (Button &)
{
	return off;
}

LedState 
MackieControlProtocol::end_press (Button &)
{
	session->goto_end();
	return on;
}

LedState 
MackieControlProtocol::end_release (Button &)
{
	return off;
}

LedState 
MackieControlProtocol::clicking_press (Button &)
{
	bool state = !Config->get_clicking();
	Config->set_clicking (state);
	return state;
}

LedState 
MackieControlProtocol::clicking_release (Button &)
{
	return Config->get_clicking();
}

LedState MackieControlProtocol::global_solo_press (Button &)
{
	bool state = !session->soloing();
	session->set_solo (session->get_routes(), state);
	return state;
}

LedState MackieControlProtocol::global_solo_release (Button &)
{
	return session->soloing();
}

LedState
MackieControlProtocol::enter_press (Button &) 
{ 
	Enter(); /* EMIT SIGNAL */
	return off;
}

LedState
MackieControlProtocol::enter_release (Button &) 
{ 
	return off;
}
LedState
MackieControlProtocol::F1_press (Button &) 
{ 
	f_press (0);
	return off; 
}
LedState
MackieControlProtocol::F1_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::F2_press (Button &) 
{ 
	f_press (1);
	return off; 
}
LedState
MackieControlProtocol::F2_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::F3_press (Button &) 
{ 
	f_press (2);
	return off; 
}
LedState
MackieControlProtocol::F3_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::F4_press (Button &) 
{ 
	f_press (3);
	return off; 
}
LedState
MackieControlProtocol::F4_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::F5_press (Button &) 
{ 
	f_press (4);
	return off; 
}
LedState
MackieControlProtocol::F5_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::F6_press (Button &) 
{ 
	f_press (5);
	return off; 
}
LedState
MackieControlProtocol::F6_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::F7_press (Button &) 
{ 
	f_press (6);
	return off; 
}
LedState
MackieControlProtocol::F7_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::F8_press (Button &) 
{ 
	CloseDialog (); /* EMIT SIGNAL */
	return off; 
}
LedState
MackieControlProtocol::F8_release (Button &) 
{ 
	return off; 
}

/* UNIMPLEMENTED */

LedState
MackieControlProtocol::io_press (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::io_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::sends_press (Button &) 
{ 
	set_view_mode (Sends);
	return on;
}
LedState
MackieControlProtocol::sends_release (Button &) 
{ 
	return none; 
}
LedState
MackieControlProtocol::pan_press (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::pan_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::plugin_press (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::plugin_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::eq_press (Button &) 
{ 
	set_view_mode (EQ);
	return on;
}
LedState
MackieControlProtocol::eq_release (Button &) 
{ 
	return none;
}
LedState
MackieControlProtocol::dyn_press (Button &) 
{ 
	set_view_mode (Dynamics);
	return on;
}
LedState
MackieControlProtocol::dyn_release (Button &) 
{ 
	return none;
}
LedState
MackieControlProtocol::flip_press (Button &) 
{ 
	if (_modifier_state == 0) {
		if (_flip_mode != Normal) {
			_flip_mode = Normal;
		} else {
			_flip_mode = Swap;
		}
	} else if (_modifier_state & MODIFIER_CONTROL) {
		_flip_mode = Zero;
	}

	return (_flip_mode != Normal ? on : off);
}
LedState
MackieControlProtocol::flip_release (Button &) 
{ 
	return none;
}
LedState
MackieControlProtocol::edit_press (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::edit_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::name_value_press (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::name_value_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::F9_press (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::F9_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::F10_press (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::F10_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::F11_press (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::F11_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::F12_press (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::F12_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::F13_press (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::F13_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::F14_press (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::F14_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::F15_press (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::F15_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::F16_press (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::F16_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::on_press (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::on_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::rec_ready_press (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::rec_ready_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::touch_press (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::touch_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::cancel_press (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::cancel_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::mixer_press (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::mixer_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::user_a_press (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::user_a_release (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::user_b_press (Button &) 
{ 
	return off; 
}
LedState
MackieControlProtocol::user_b_release (Button &) 
{ 
	return off; 
}