Implement per-channel phase invert. Fixes #3392. Breaks loading of existing 3.0 session files.

git-svn-id: svn://localhost/ardour2/branches/3.0@7621 d708f5d6-7413-0410-9779-e7cbd77b26cf

gtk2_ardour/mixer_strip.cc

@@ -183,7 +183,6 @@ MixerStrip::init ()
 
 	mute_button->set_name ("MixerMuteButton");
 	solo_button->set_name ("MixerSoloButton");
-        invert_button->set_name ("MixerInvertButton");
 
         solo_isolated_led = manage (new LED);
         solo_isolated_led->show ();
@@ -228,7 +227,7 @@ MixerStrip::init ()
 
 	button_table.attach (name_button, 0, 2, 0, 1);
 	button_table.attach (input_button, 0, 2, 1, 2);
-	button_table.attach (*invert_button, 0, 2, 3, 4);
+	button_table.attach (_invert_button_box, 0, 2, 3, 4);
 
 	middle_button_table.set_homogeneous (true);
 	middle_button_table.set_spacings (0);
@@ -434,8 +433,6 @@ MixerStrip::set_route (boost::shared_ptr<Route> rt)
 		}
 	}
 
-	invert_button->set_active (_route->phase_invert ());
-
 	switch (_route->meter_point()) {
 	case MeterInput:
 		meter_point_label.set_text (_("input"));
@@ -1769,8 +1766,6 @@ MixerStrip::revert_to_default_display ()
 void
 MixerStrip::set_button_names ()
 {
-        invert_button_label.set_text (X_("Ø"));
-
         switch (_width) {
 	case Wide:
 		rec_enable_button_label.set_text (_("Rec"));

gtk2_ardour/route_ui.cc

@@ -62,6 +62,8 @@ using namespace Gtkmm2ext;
 using namespace ARDOUR;
 using namespace PBD;
 
+uint32_t RouteUI::_max_invert_buttons = 4;
+
 RouteUI::RouteUI (ARDOUR::Session* sess)
 	: AxisView(sess)
 {
@@ -84,6 +86,7 @@ RouteUI::~RouteUI()
 	delete mute_menu;
 	delete sends_menu;
         delete record_menu;
+	delete _invert_menu;
 }
 
 void
@@ -95,6 +98,7 @@ RouteUI::init ()
 	solo_menu = 0;
 	sends_menu = 0;
         record_menu = 0;
+	_invert_menu = 0;
 	pre_fader_mute_check = 0;
 	post_fader_mute_check = 0;
 	listen_mute_check = 0;
@@ -103,7 +107,6 @@ RouteUI::init ()
         solo_isolated_check = 0;
         solo_isolated_led = 0;
         solo_safe_led = 0;
-	ignore_toggle = false;
 	_solo_release = 0;
 	_mute_release = 0;
 	route_active_menu_item = 0;
@@ -111,13 +114,9 @@ RouteUI::init ()
         step_edit_item = 0;
 	multiple_mute_change = false;
 	multiple_solo_change = false;
+	_i_am_the_modifier = 0;
 
-	invert_button = manage (new BindableToggleButton ());
+	setup_invert_buttons ();
-	// mute_button->set_self_managed (true);
-	invert_button->set_name ("InvertButton");
-	invert_button->add (invert_button_label);
-	invert_button_label.show ();
-	UI::instance()->set_tip (invert_button, _("Invert (Phase reverse) this track"), "");
 
 	mute_button = manage (new BindableToggleButton ());
 	// mute_button->set_self_managed (true);
@@ -162,8 +161,6 @@ RouteUI::init ()
 	solo_button->signal_button_release_event().connect (sigc::mem_fun(*this, &RouteUI::solo_release), false);
 	mute_button->signal_button_press_event().connect (sigc::mem_fun(*this, &RouteUI::mute_press), false);
 	mute_button->signal_button_release_event().connect (sigc::mem_fun(*this, &RouteUI::mute_release), false);
-	invert_button->signal_toggled().connect (sigc::mem_fun(*this, &RouteUI::invert_toggled), false);
-
 }
 
 void
@@ -223,6 +220,8 @@ RouteUI::set_route (boost::shared_ptr<Route> rp)
         _route->phase_invert_changed.connect (route_connections, invalidator (*this), boost::bind (&RouteUI::polarity_changed, this), gui_context());
 	_route->PropertyChanged.connect (route_connections, invalidator (*this), ui_bind (&RouteUI::property_changed, this, _1), gui_context());
 
+	_route->io_changed.connect (route_connections, invalidator (*this), ui_bind (&RouteUI::setup_invert_buttons, this), gui_context ());
+
 	if (_session->writable() && is_track()) {
 		boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track>(_route);
 
@@ -244,7 +243,6 @@ RouteUI::set_route (boost::shared_ptr<Route> rp)
 	solo_button->unset_flags (Gtk::CAN_FOCUS);
 
 	mute_button->show();
-        invert_button->show ();
 
 	if (_route->is_monitor()) {
 		solo_button->hide ();
@@ -253,12 +251,9 @@ RouteUI::set_route (boost::shared_ptr<Route> rp)
 	}
 
 	map_frozen ();
-}
 
-void
+	setup_invert_buttons ();
-RouteUI::invert_toggled ()
+	set_invert_button_state ();
-{
-        _route->set_phase_invert (invert_button->get_active());
 }
 
 void
@@ -268,11 +263,7 @@ RouteUI::polarity_changed ()
                 return;
         }
 
-	if (_route->phase_invert()) {
+	set_invert_button_state ();
-                invert_button->set_active (true);
-	} else {
-                invert_button->set_active (false);
-	}
 }
 
 bool
@@ -284,7 +275,7 @@ RouteUI::mute_press (GdkEventButton* ev)
 
 	multiple_mute_change = false;
 
-	if (!ignore_toggle) {
+	if (!_i_am_the_modifier) {
 
 		if (Keyboard::is_context_menu_event (ev)) {
 
@@ -357,7 +348,7 @@ RouteUI::mute_press (GdkEventButton* ev)
 bool
 RouteUI::mute_release (GdkEventButton*)
 {
-	if (!ignore_toggle) {
+	if (!_i_am_the_modifier) {
 		if (_mute_release){
 			_session->set_mute (_mute_release->routes, _mute_release->active, Session::rt_cleanup, true);
 			delete _mute_release;
@@ -379,7 +370,7 @@ RouteUI::solo_press(GdkEventButton* ev)
 	
 	multiple_solo_change = false;
 
-	if (!ignore_toggle) {
+	if (!_i_am_the_modifier) {
 		
 		if (Keyboard::is_context_menu_event (ev)) {
 			
@@ -500,7 +491,7 @@ RouteUI::solo_press(GdkEventButton* ev)
 bool
 RouteUI::solo_release (GdkEventButton*)
 {
-	if (!ignore_toggle) {
+	if (!_i_am_the_modifier) {
 		
 		if (_solo_release) {
 
@@ -544,7 +535,7 @@ RouteUI::rec_enable_press(GdkEventButton* ev)
                 } 
         }
 
-	if (!ignore_toggle && is_track() && rec_enable_button) {
+	if (!_i_am_the_modifier && is_track() && rec_enable_button) {
 
 		if (Keyboard::is_button2_event (ev)) {
 
@@ -730,7 +721,7 @@ RouteUI::show_sends_press(GdkEventButton* ev)
 		return true;
 	}
 
-	if (!ignore_toggle && !is_track() && show_sends_button) {
+	if (!_i_am_the_modifier && !is_track() && show_sends_button) {
 
 		if (Keyboard::is_button2_event (ev) && Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
 
@@ -883,17 +874,17 @@ RouteUI::update_solo_display ()
 	if (Config->get_solo_control_is_listen_control()) {
 
 		if (solo_button->get_active() != (x = _route->listening())) {
-			ignore_toggle = true;
+			++_i_am_the_modifier;
 			solo_button->set_active(x);
-			ignore_toggle = false;
+			--_i_am_the_modifier;
 		}
 
 	} else {
 
 		if (solo_button->get_active() != (x = _route->soloed())) {
-			ignore_toggle = true;
+			++_i_am_the_modifier;
 			solo_button->set_active (x);
-			ignore_toggle = false;
+			--_i_am_the_modifier;
 		}
 
 	}
@@ -988,9 +979,9 @@ RouteUI::update_mute_display ()
 	*/
 
 	if (model != view) {
-		ignore_toggle = true;
+		++_i_am_the_modifier;
 		mute_button->set_active (model);
-		ignore_toggle = false;
+		--_i_am_the_modifier;
 	}
 
 	mute_button->set_visual_state (mute_visual_state (_session, _route));
@@ -1023,9 +1014,9 @@ RouteUI::update_rec_display ()
 	*/
 
 	if (model != view) {
-		ignore_toggle = true;
+		++_i_am_the_modifier;
 		rec_enable_button->set_active (model);
-		ignore_toggle = false;
+		--_i_am_the_modifier;
 	}
 
 	/* now make sure its color state is correct */
@@ -1655,3 +1646,123 @@ RouteUI::open_remote_control_id_dialog ()
 		_route->set_remote_control_id (spin->get_value_as_int ());
 	}
 }
+
+void
+RouteUI::setup_invert_buttons ()
+{
+	/* remove old invert buttons */
+	for (list<BindableToggleButton*>::iterator i = _invert_buttons.begin(); i != _invert_buttons.end(); ++i) {
+		_invert_button_box.remove (**i);
+	}
+
+	_invert_buttons.clear ();
+
+	if (!_route || !_route->input()) {
+		return;
+	}
+
+	uint32_t const N = _route->input()->n_ports().n_audio ();
+
+	uint32_t const to_add = (N <= _max_invert_buttons) ? N : 1;
+
+	for (uint32_t i = 0; i < to_add; ++i) {
+		BindableToggleButton* b = manage (new BindableToggleButton);
+		b->signal_toggled().connect (sigc::bind (sigc::mem_fun (*this, &RouteUI::invert_toggled), i, b));
+		b->signal_button_press_event().connect (sigc::mem_fun (*this, &RouteUI::invert_press));
+		
+		b->set_name (X_("InvertButton"));
+		if (to_add == 1) {
+			b->add (*manage (new Label (X_("Ø"))));
+		} else {
+			b->add (*manage (new Label (string_compose (X_("Ø%1"), i + 1))));
+		}
+
+		if (N <= 4) {
+			UI::instance()->set_tip (*b, string_compose (_("Left-click to invert (phase reverse) channel %1 of this track.  Right-click to show menu."), i + 1));
+		} else {
+			UI::instance()->set_tip (*b, string_compose (_("Left-click to invert (phase reverse) all channels of this track.  Right-click to show menu."), i + 1));
+		}
+		
+		_invert_buttons.push_back (b);
+		_invert_button_box.pack_start (*b);
+	}
+	
+	_invert_button_box.show_all ();
+}
+
+void
+RouteUI::set_invert_button_state ()
+{
+	++_i_am_the_modifier;
+	
+	uint32_t const N = _route->input()->n_ports().n_audio();
+	if (N > _max_invert_buttons) {
+		_invert_buttons.front()->set_active (_route->phase_invert().any());
+		--_i_am_the_modifier;
+		return;
+	}
+
+	int j = 0;
+	for (list<BindableToggleButton*>::iterator i = _invert_buttons.begin(); i != _invert_buttons.end(); ++i, ++j) {
+		(*i)->set_active (_route->phase_invert (j));
+	}
+
+	--_i_am_the_modifier;
+}
+
+void
+RouteUI::invert_toggled (uint32_t i, BindableToggleButton* b)
+{
+	if (_i_am_the_modifier) {
+		return;
+	}
+	
+	uint32_t const N = _route->input()->n_ports().n_audio();
+	if (N <= _max_invert_buttons) {
+		_route->set_phase_invert (i, b->get_active ());
+	} else {
+		boost::dynamic_bitset<> p (N);
+		if (b->get_active ()) {
+			p.set ();
+		}
+		_route->set_phase_invert (p);
+	}
+}
+
+bool
+RouteUI::invert_press (GdkEventButton* ev)
+{
+	using namespace Menu_Helpers;
+
+	if (ev->button != 3) {
+		return true;
+	}
+
+	delete _invert_menu;
+	_invert_menu = new Menu;
+	_invert_menu->set_name ("ArdourContextMenu");
+	MenuList& items = _invert_menu->items ();
+
+	uint32_t const N = _route->input()->n_ports().n_audio();
+	for (uint32_t i = 0; i < N; ++i) {
+		items.push_back (CheckMenuElem (string_compose (X_("Ø%1"), i + 1), sigc::bind (sigc::mem_fun (*this, &RouteUI::invert_menu_toggled), i)));
+		CheckMenuItem* e = dynamic_cast<CheckMenuItem*> (&items.back ());
+		++_i_am_the_modifier;
+		e->set_active (_route->phase_invert (i));
+		--_i_am_the_modifier;
+	}
+
+	_invert_menu->popup (0, ev->time);
+
+	return false;
+}
+
+void
+RouteUI::invert_menu_toggled (uint32_t c)
+{
+	if (_i_am_the_modifier) {
+		return;
+	}
+	
+	_route->set_phase_invert (c, !_route->phase_invert (c));
+}

gtk2_ardour/route_ui.h

@@ -85,7 +85,7 @@ class RouteUI : public virtual AxisView
 	bool multiple_mute_change;
 	bool multiple_solo_change;
 
-	BindableToggleButton* invert_button;
+	Gtk::HBox _invert_button_box;
 	BindableToggleButton* mute_button;
 	BindableToggleButton* solo_button;
 	BindableToggleButton* rec_enable_button; /* audio tracks */
@@ -96,7 +96,6 @@ class RouteUI : public virtual AxisView
 
 	Gtk::Label solo_button_label;
 	Gtk::Label mute_button_label;
-	Gtk::Label invert_button_label;
 	Gtk::Label rec_enable_button_label;
 
 	void send_blink (bool);
@@ -114,7 +113,6 @@ class RouteUI : public virtual AxisView
 
 	virtual XMLNode* get_automation_child_xml_node (Evoral::Parameter param);
 
-	void invert_toggled();
 	bool mute_press(GdkEventButton*);
 	bool mute_release(GdkEventButton*);
 	bool solo_press(GdkEventButton*);
@@ -246,6 +244,17 @@ class RouteUI : public virtual AxisView
 	SoloMuteRelease* _solo_release;
 	SoloMuteRelease* _mute_release;
 
+	void setup_invert_buttons ();
+	void set_invert_button_state ();
+	void invert_toggled (uint32_t, BindableToggleButton *);
+	void invert_menu_toggled (uint32_t);
+	bool invert_press (GdkEventButton *);
+	
+	int _i_am_the_modifier;
+	std::list<BindableToggleButton*> _invert_buttons;
+	Gtk::Menu* _invert_menu;
+
+	static uint32_t _max_invert_buttons;
 };
 
 #endif /* __ardour_route_ui__ */

libs/ardour/ardour/route.h

@@ -29,6 +29,7 @@
 
 #include <boost/shared_ptr.hpp>
 #include <boost/weak_ptr.hpp>
+#include <boost/dynamic_bitset.hpp>
 
 #include <glibmm/thread.h>
 #include "pbd/fastlog.h"
@@ -150,8 +151,10 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
 	void set_listen (bool yn, void* src);
 	bool listening () const;
 
-	void set_phase_invert (bool yn);
+	void set_phase_invert (uint32_t, bool yn);
-	bool phase_invert() const;
+	void set_phase_invert (boost::dynamic_bitset<>);
+	bool phase_invert (uint32_t) const;
+	boost::dynamic_bitset<> phase_invert () const;
 
 	void set_denormal_protection (bool yn);
 	bool denormal_protection() const;
@@ -258,6 +261,7 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
 	PBD::Signal0<void>       signal_latency_changed;
 	PBD::Signal0<void>       initial_delay_changed;
 	PBD::Signal0<void>       order_key_changed;
+	PBD::Signal0<void>       io_changed;
 
 	/* gui's call this for their own purposes. */
 
@@ -411,7 +415,7 @@ class Route : public SessionObject, public Automatable, public RouteGroupMember,
 	Flag           _flags;
 	int            _pending_declick;
 	MeterPoint     _meter_point;
-	uint32_t       _phase_invert;
+	boost::dynamic_bitset<> _phase_invert;
 	bool           _self_solo;
 	uint32_t       _soloed_by_others_upstream;
 	uint32_t       _soloed_by_others_downstream;

libs/ardour/route.cc

@@ -80,7 +80,6 @@ Route::Route (Session& sess, string name, Flag flg, DataType default_type)
 	, _flags (flg)
         , _pending_declick (true)
         , _meter_point (MeterPostFader)
-        , _phase_invert (0)
         , _self_solo (false)
         , _soloed_by_others_upstream (0)
         , _soloed_by_others_downstream (0)
@@ -424,7 +423,7 @@ Route::process_output_buffers (BufferSet& bufs,
 	   DENORMAL CONTROL/PHASE INVERT
 	   ----------------------------------------------------------------------------------------- */
 
-	if (_phase_invert) {
+	if (_phase_invert.any ()) {
 
 		int chn = 0;
 
@@ -433,7 +432,7 @@ Route::process_output_buffers (BufferSet& bufs,
 			for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
 				Sample* const sp = i->data();
 
-				if (_phase_invert & chn) {
+				if (_phase_invert[chn]) {
 					for (nframes_t nx = 0; nx < nframes; ++nx) {
 						sp[nx]  = -sp[nx];
 						sp[nx] += 1.0e-27f;
@@ -450,7 +449,7 @@ Route::process_output_buffers (BufferSet& bufs,
 			for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i, ++chn) {
 				Sample* const sp = i->data();
 
-				if (_phase_invert & (1<<chn)) {
+				if (_phase_invert[chn]) {
 					for (nframes_t nx = 0; nx < nframes; ++nx) {
 						sp[nx] = -sp[nx];
 					}
@@ -1720,7 +1719,9 @@ Route::state(bool full_state)
 	}
 
 	node->add_property("active", _active?"yes":"no");
-	node->add_property("phase-invert", _phase_invert?"yes":"no");
+	string p;
+	boost::to_string (_phase_invert, p);
+	node->add_property("phase-invert", p);
 	node->add_property("denormal-protection", _denormal_protection?"yes":"no");
 	node->add_property("meter-point", enum_2_string (_meter_point));
 
@@ -1867,7 +1868,7 @@ Route::_set_state (const XMLNode& node, int version, bool /*call_base*/)
 	}
 
 	if ((prop = node.property (X_("phase-invert"))) != 0) {
-		set_phase_invert (string_is_affirmative (prop->value()));
+		set_phase_invert (boost::dynamic_bitset<> (prop->value ()));
 	}
 
 	if ((prop = node.property (X_("denormal-protection"))) != 0) {
@@ -1982,7 +1983,11 @@ Route::_set_state_2X (const XMLNode& node, int version)
 	}
 	
 	if ((prop = node.property (X_("phase-invert"))) != 0) {
-		set_phase_invert (string_is_affirmative (prop->value()));
+		boost::dynamic_bitset<> p (_input->n_ports().n_audio ());
+		if (string_is_affirmative (prop->value ())) {
+			p.set ();
+		}			
+		set_phase_invert (p);
 	}
 
 	if ((prop = node.property (X_("denormal-protection"))) != 0) {
@@ -2644,6 +2649,8 @@ Route::input_change_handler (IOChange change, void * /*src*/)
 {
 	if ((change & ConfigurationChanged)) {
 		configure_processors (0);
+		_phase_invert.resize (_input->n_ports().n_audio ());
+		io_changed (); /* EMIT SIGNAL */
 	}
 }
 
@@ -3223,25 +3230,39 @@ Route::internal_send_for (boost::shared_ptr<const Route> target) const
 	return boost::shared_ptr<Send>();
 }
 
+/** @param c Audio channel index.
+ *  @param yn true to invert phase, otherwise false.
+ */
 void
-Route::set_phase_invert (bool yn)
+Route::set_phase_invert (uint32_t c, bool yn)
 {
-	if (_phase_invert != yn) {
+	if (_phase_invert[c] != yn) {
-                if (yn) {
+		_phase_invert[c] = yn;
-                        _phase_invert = 0xffff; // XXX all channels
+		phase_invert_changed (); /* EMIT SIGNAL */
-                } else {
+                _session.set_dirty ();
-                        _phase_invert = 0; // XXX no channels
 	}
+}
 
+void
+Route::set_phase_invert (boost::dynamic_bitset<> p)
+{
+	if (_phase_invert != p) {
+		_phase_invert = p;
 		phase_invert_changed (); /* EMIT SIGNAL */
                 _session.set_dirty ();
 	}
 }
 
 bool
+Route::phase_invert (uint32_t c) const
+{
+	return _phase_invert[c];
+}
+
+boost::dynamic_bitset<>
 Route::phase_invert () const
 {
-	return _phase_invert != 0;
+	return _phase_invert;
 }
 
 void
@@ -3405,3 +3426,4 @@ Route::set_processor_positions ()
 		}
 	}
 }
+