livetrax/gtk2_ardour/panner_ui.cc

/*
 * Copyright (C) 2005-2006 Nick Mainsbridge <mainsbridge@gmail.com>
 * Copyright (C) 2005-2006 Taybin Rutkin <taybin@taybin.com>
 * Copyright (C) 2005-2017 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2006-2007 Doug McLain <doug@nostar.net>
 * Copyright (C) 2006-2012 David Robillard <d@drobilla.net>
 * Copyright (C) 2006 Sampo Savolainen <v2@iki.fi>
 * Copyright (C) 2008-2012 Carl Hetherington <carl@carlh.net>
 * Copyright (C) 2012-2019 Robin Gareus <robin@gareus.org>
 * Copyright (C) 2014-2015 Tim Mayberry <mojofunk@gmail.com>
 *
 * 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.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#include <limits.h>

#include <gtkmm2ext/utils.h>

#include "pbd/fastlog.h"

#include "ardour/pannable.h"
#include "ardour/panner.h"
#include "ardour/panner_shell.h"
#include "ardour/profile.h"
#include "ardour/session.h"

#include "widgets/ardour_knob.h"
#include "widgets/tooltips.h"

#include "gain_meter.h"
#include "panner_ui.h"
#include "panner2d.h"
#include "gui_thread.h"
#include "stereo_panner.h"
#include "timers.h"
#include "mono_panner.h"
#include "ui_config.h"

#include "pbd/i18n.h"

using namespace std;
using namespace ARDOUR;
using namespace PBD;
using namespace Gtkmm2ext;
using namespace Gtk;

PannerUI::PannerUI (Session* s)
	: in_pan_update (false)
	, _current_nouts (-1)
	, _current_nins (-1)
	, _current_uri ("")
	, _send_mode (false)
	, twod_panner (nullptr)
	, big_window (nullptr)
	, _stereo_panner (nullptr)
	, _mono_panner (nullptr)
	, _knob_panner (nullptr)
	, _ignore_width_change (false)
	, _ignore_position_change (false)
	, pan_astate_menu (nullptr)
	, pan_astyle_menu (nullptr)
	, pan_automation_state_button ("")
	, pan_menu (nullptr)
	, bypass_menu_item (nullptr)
	, send_link_menu_item (nullptr)
{
	set_session (s);

	pan_automation_state_button.set_name ("MixerAutomationPlaybackButton");

	ArdourWidgets::set_tooltip (pan_automation_state_button, _("Pan automation mode"));

	//set_size_request_to_display_given_text (pan_automation_state_button, X_("O"), 2, 2);

	pan_automation_state_button.set_can_focus (false);

	pan_automation_state_button.signal_button_press_event().connect (sigc::mem_fun(*this, &PannerUI::pan_automation_state_button_event), false);

	pan_vbox.set_spacing (2);
	pack_start (pan_vbox, true, true);

	set_width (Narrow);
}

void
PannerUI::set_panner (std::shared_ptr<PannerShell> ps, std::shared_ptr<Panner> p)
{
	/* note that the panshell might not change here (i.e. ps == _panshell)
	 */

	connections.drop_connections ();

	delete pan_astyle_menu;
	pan_astyle_menu = 0;

	delete pan_astate_menu;
	pan_astate_menu = 0;

	_panshell = ps;
	_panner = p;

	delete twod_panner;
	twod_panner = 0;

	delete big_window;
	big_window = 0;

	delete _stereo_panner;
	_stereo_panner = 0;

	delete _mono_panner;
	_mono_panner = 0;

	delete _knob_panner;
	_knob_panner = 0;

	if (!_panner) {
		return;
	}

	_panshell->Changed.connect (connections, invalidator (*this), boost::bind (&PannerUI::panshell_changed, this), gui_context());

	/* new panner object, force complete reset of panner GUI
	 */

	_current_nouts = 0;
	_current_nins = 0;

	setup_pan ();
	update_pan_sensitive ();
	pan_automation_state_changed ();
}

void
PannerUI::build_astate_menu ()
{
	using namespace Menu_Helpers;

	if (pan_astate_menu == 0) {
		pan_astate_menu = new Menu;
		pan_astate_menu->set_name ("ArdourContextMenu");
	} else {
		pan_astate_menu->items().clear ();
	}

	std::shared_ptr<Pannable> pannable = _panshell->pannable();

	pan_astate_menu->items().push_back (MenuElem (GainMeterBase::astate_string (ARDOUR::Off),
			sigc::bind ( sigc::mem_fun (pannable.get(), &Pannable::set_automation_state), (AutoState) ARDOUR::Off)));
	pan_astate_menu->items().push_back (MenuElem (GainMeterBase::astate_string (ARDOUR::Play),
			sigc::bind ( sigc::mem_fun (pannable.get(), &Pannable::set_automation_state), (AutoState) Play)));
	pan_astate_menu->items().push_back (MenuElem (GainMeterBase::astate_string (ARDOUR::Write),
			sigc::bind ( sigc::mem_fun (pannable.get(), &Pannable::set_automation_state), (AutoState) Write)));
	pan_astate_menu->items().push_back (MenuElem (GainMeterBase::astate_string (ARDOUR::Touch),
			sigc::bind (sigc::mem_fun (pannable.get(), &Pannable::set_automation_state), (AutoState) Touch)));
	pan_astate_menu->items().push_back (MenuElem (GainMeterBase::astate_string (ARDOUR::Latch),
			sigc::bind ( sigc::mem_fun (pannable.get(), &Pannable::set_automation_state), (AutoState) Latch)));

}

void
PannerUI::build_astyle_menu ()
{
	using namespace Menu_Helpers;

	if (pan_astyle_menu == 0) {
		pan_astyle_menu = new Menu;
		pan_astyle_menu->set_name ("ArdourContextMenu");
	} else {
		pan_astyle_menu->items().clear();
	}

	pan_astyle_menu->items().push_back (MenuElem (_("Trim")));
	pan_astyle_menu->items().push_back (MenuElem (_("Abs")));
}

void
PannerUI::on_size_allocate (Allocation& a)
{
	HBox::on_size_allocate (a);
}

void
PannerUI::set_width (Width w)
{
	_width = w;
}

PannerUI::~PannerUI ()
{
	delete twod_panner;
	delete big_window;
	delete pan_menu;
	delete pan_astyle_menu;
	delete pan_astate_menu;
	delete _stereo_panner;
	delete _mono_panner;
	delete _knob_panner;
}

void
PannerUI::set_sensitive (bool yn)
{
	/* XXX incomplete - written for livetrax and only affects knob */

	if (_knob_panner) {
		_knob_panner->set_sensitive (yn);
	}
}

void
PannerUI::panshell_changed ()
{
	set_panner (_panshell, _panshell->panner());
	setup_pan ();
}

void
PannerUI::setup_pan ()
{
	int const nouts = _panner ? _panner->out().n_audio() : -1;
	int const nins = _panner ? _panner->in().n_audio() : -1;

	assert (_panshell);

	if (nouts == _current_nouts &&
	    nins == _current_nins &&
	    _current_uri == _panshell->panner_gui_uri()) {
		return;
	}

	_current_nins = nins;
	_current_nouts = nouts;
	_current_uri = _panshell->panner_gui_uri();

	container_clear (pan_vbox);

	delete twod_panner;
	twod_panner = 0;
	delete _stereo_panner;
	_stereo_panner = 0;
	delete _mono_panner;
	_mono_panner = 0;
	delete _knob_panner;
	_knob_panner = 0;

	if (!_panner) {
		delete big_window;
		big_window = 0;
		return;
	}

	const float scale = std::max (1.f, UIConfiguration::instance().get_ui_scale());

	if (_current_uri == "http://ardour.org/plugin/panner_2in2out#ui")
	{
		delete big_window;
		big_window = 0;

		std::shared_ptr<Pannable> pannable = _panner->pannable();

		_stereo_panner = new StereoPanner (_panshell);
		_stereo_panner->set_size_request (-1, 5 * ceilf(7.f * scale));
		_stereo_panner->set_send_drawing_mode (_send_mode);
		pan_vbox.pack_start (*_stereo_panner, false, false);

		std::shared_ptr<AutomationControl> ac;

		ac = pannable->pan_azimuth_control;
		_stereo_panner->StartPositionGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::start_touch),
					std::weak_ptr<AutomationControl> (ac)));
		_stereo_panner->StopPositionGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::stop_touch),
					std::weak_ptr<AutomationControl>(ac)));

		ac = pannable->pan_width_control;
		_stereo_panner->StartWidthGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::start_touch),
					std::weak_ptr<AutomationControl> (ac)));
		_stereo_panner->StopWidthGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::stop_touch),
					std::weak_ptr<AutomationControl>(ac)));
		_stereo_panner->signal_button_release_event().connect (sigc::mem_fun(*this, &PannerUI::pan_button_event));
	}
	else if (_current_uri == "http://ardour.org/plugin/panner_1in2out#ui"
			|| _current_uri == "http://ardour.org/plugin/panner_balance#ui")
	{
		delete big_window;
		big_window = 0;
		std::shared_ptr<Pannable> pannable = _panner->pannable();
		std::shared_ptr<AutomationControl> ac = pannable->pan_azimuth_control;

		if (ARDOUR::Profile->get_livetrax()) {

			_knob_panner = new ArdourWidgets::ArdourKnob (ArdourWidgets::ArdourKnob::default_elements,
			                                              ArdourWidgets::ArdourCtrlBase::Flags (ArdourWidgets::ArdourCtrlBase::Detent|ArdourWidgets::ArdourCtrlBase::ArcToZero));

			_knob_panner->set_controllable (ac);
			update_pan_sensitive ();
			_knob_panner->show ();
			_knob_panner->set_size_request (-1, 5 * ceilf(7.f * scale));
			_knob_panner->set_name ("monitor section knob");
			pan_vbox.pack_start (*_knob_panner, false, false);

		} else {

			_mono_panner = new MonoPanner (_panshell);

			_mono_panner->StartGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::start_touch),
			                                                std::weak_ptr<AutomationControl> (ac)));
			_mono_panner->StopGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::stop_touch),
			                                               std::weak_ptr<AutomationControl>(ac)));

			_mono_panner->signal_button_release_event().connect (sigc::mem_fun(*this, &PannerUI::pan_button_event));

			_mono_panner->set_size_request (-1, 5 * ceilf(7.f * scale));
			_mono_panner->set_send_drawing_mode (_send_mode);

			update_pan_sensitive ();
			pan_vbox.pack_start (*_mono_panner, false, false);
		}
	}
	else if (_current_uri == "http://ardour.org/plugin/panner_vbap#ui")
	{
		if (!twod_panner) {
			twod_panner = new Panner2d (_panshell, rintf(61.f * scale));
			twod_panner->set_name ("MixerPanZone");
			twod_panner->show ();
			twod_panner->signal_button_press_event().connect (sigc::mem_fun(*this, &PannerUI::pan_button_event), false);
		}

		update_pan_sensitive ();
		twod_panner->reset (nins);
		if (big_window) {
			big_window->reset (nins);
		}
		twod_panner->set_size_request (-1, rintf(61.f * scale));
		twod_panner->set_send_drawing_mode (_send_mode);

		/* and finally, add it to the panner frame */

		pan_vbox.pack_start (*twod_panner, false, false);
	}
	else
	{
		/* stick something into the panning viewport so that it redraws */
		EventBox* eb = manage (new EventBox());
		pan_vbox.pack_start (*eb, false, false);

		delete big_window;
		big_window = 0;
	}

	pan_vbox.show_all ();
}

void
PannerUI::set_send_drawing_mode (bool onoff)
{
	if (_stereo_panner) {
		_stereo_panner->set_send_drawing_mode (onoff);
	} else if (_mono_panner) {
		_mono_panner->set_send_drawing_mode (onoff);
	} else if (twod_panner) {
		twod_panner->set_send_drawing_mode (onoff);
	}
	_send_mode = onoff;
}

void
PannerUI::start_touch (std::weak_ptr<AutomationControl> wac)
{
	std::shared_ptr<AutomationControl> ac = wac.lock();
	if (!ac) {
		return;
	}
	ac->start_touch (timepos_t (ac->session().transport_sample()));
}

void
PannerUI::stop_touch (std::weak_ptr<AutomationControl> wac)
{
	std::shared_ptr<AutomationControl> ac = wac.lock();
	if (!ac) {
		return;
	}
	ac->stop_touch (timepos_t (ac->session().transport_sample()));
}

bool
PannerUI::pan_button_event (GdkEventButton* ev)
{
	switch (ev->button) {
	case 1:
		if (twod_panner && ev->type == GDK_2BUTTON_PRESS) {
			if (!big_window) {
				big_window = new Panner2dWindow (_panshell, 400, _panner->in().n_audio());
			}
			big_window->show ();
			return true;
		}
		break;

	case 3:
		if (pan_menu == 0) {
			pan_menu = new Menu;
			pan_menu->set_name ("ArdourContextMenu");
		}
		build_pan_menu ();
		pan_menu->popup (ev->button, ev->time);
		return true;
		break;
	default:
		return false;
	}

	return false; // what's wrong with gcc?
}

void
PannerUI::build_pan_menu ()
{
	using namespace Menu_Helpers;
	MenuList& items (pan_menu->items());

	items.clear ();

	items.push_back (CheckMenuElem (_("Bypass"), sigc::mem_fun(*this, &PannerUI::pan_bypass_toggle)));
	bypass_menu_item = static_cast<Gtk::CheckMenuItem*> (&items.back());

	/* set state first, connect second */

	bypass_menu_item->set_active (_panshell->bypassed());
	bypass_menu_item->signal_toggled().connect (sigc::mem_fun(*this, &PannerUI::pan_bypass_toggle));

	if (!_panshell->bypassed()) {
		items.push_back (MenuElem (_("Reset"), sigc::mem_fun (*this, &PannerUI::pan_reset)));
		items.push_back (MenuElem (_("Edit..."), sigc::mem_fun (*this, &PannerUI::pan_edit)));
	}

	if (_send_mode) {
		items.push_back (SeparatorElem());
		items.push_back (CheckMenuElem (_("Link send and main panner"), sigc::mem_fun(*this, &PannerUI::pan_bypass_toggle)));
		send_link_menu_item = static_cast<Gtk::CheckMenuItem*> (&items.back());
		send_link_menu_item->set_active (_panshell->is_linked_to_route ());
		send_link_menu_item->signal_toggled().connect (sigc::mem_fun(*this, &PannerUI::pan_link_toggle));
	} else {
		send_link_menu_item = NULL;
	}

	if (_panner_list.size() > 1 && !_panshell->bypassed()) {
		RadioMenuItem::Group group;
		items.push_back (SeparatorElem());

		_suspend_menu_callbacks = true;
		for (std::map<std::string,std::string>::const_iterator p = _panner_list.begin(); p != _panner_list.end(); ++p) {
			items.push_back (RadioMenuElem (group, p->second,
						sigc::bind(sigc::mem_fun (*this, &PannerUI::pan_set_custom_type), p->first)));
			RadioMenuItem* i = dynamic_cast<RadioMenuItem *> (&items.back ());
			i->set_active (_panshell->current_panner_uri() == p->first);
		}
		_suspend_menu_callbacks = false;
	}
}

void
PannerUI::pan_bypass_toggle ()
{
	if (bypass_menu_item && (_panshell->bypassed() != bypass_menu_item->get_active())) {
		_panshell->set_bypassed (!_panshell->bypassed());
	}
}

void
PannerUI::pan_link_toggle ()
{
	if (send_link_menu_item && (_panshell->is_linked_to_route() != send_link_menu_item->get_active())) {
		_panshell->set_linked_to_route (!_panshell->is_linked_to_route());
	}
}

void
PannerUI::pan_edit ()
{
	if (_panshell->bypassed()) {
		return;
	}
	if (_mono_panner) {
		_mono_panner->edit ();
	} else if (_stereo_panner) {
		_stereo_panner->edit ();
	} else if (twod_panner) {
		if (!big_window) {
			big_window = new Panner2dWindow (_panshell, 400, _panner->in().n_audio());
		}
		big_window->show ();
	}
}

void
PannerUI::pan_reset ()
{
	if (_panshell->bypassed()) {
		return;
	}
	_panner->reset ();
}

void
PannerUI::pan_set_custom_type (std::string uri) {
	if (_suspend_menu_callbacks) return;
	_panshell->select_panner_by_uri(uri);
}

void
PannerUI::effective_pan_display ()
{
	if (_stereo_panner) {
		_stereo_panner->queue_draw ();
	} else if (_mono_panner) {
		_mono_panner->queue_draw ();
	} else if (twod_panner) {
		twod_panner->queue_draw ();
	}
}

void
PannerUI::update_pan_sensitive ()
{
	bool const sensitive = !(_panner->pannable()->automation_state() & Play);

	pan_vbox.set_sensitive (sensitive);

	if (big_window) {
		big_window->set_sensitive (sensitive);
	}
}

gint
PannerUI::pan_automation_state_button_event (GdkEventButton *ev)
{
	using namespace Menu_Helpers;

	if (ev->type == GDK_BUTTON_RELEASE) {
		return TRUE;
	}

	switch (ev->button) {
	case 1:
		if (pan_astate_menu == 0) {
			build_astate_menu ();
		}
		pan_astate_menu->popup (ev->button, ev->time);
		break;
	default:
		break;
	}

	return TRUE;
}

void
PannerUI::pan_automation_state_changed ()
{
	std::shared_ptr<Pannable> pannable (_panner->pannable());
	pan_automation_state_button.set_label (GainMeterBase::short_astate_string(pannable->automation_state()));

	bool x = (pannable->automation_state() != ARDOUR::Off);

	if (pan_automation_state_button.get_active() != x) {
		pan_automation_state_button.set_active (x);
	}

	update_pan_sensitive ();
}

void
PannerUI::show_width ()
{
}

void
PannerUI::width_adjusted ()
{
}

void
PannerUI::show_position ()
{
}

void
PannerUI::position_adjusted ()
{
}

void
PannerUI::set_available_panners(std::map<std::string,std::string> p)
{
	_panner_list = p;
}