Add NamedChannel and use it to hide the never-used channels

when mapping into a DCP.

17 files changed, 101 insertions, 91 deletions

diff --git a/src/lib/audio_content.cc b/src/lib/audio_content.cc
index 014221f2e..22521c9e9 100644
--- a/src/lib/audio_content.cc
+++ b/src/lib/audio_content.cc
@@ -265,17 +265,18 @@ AudioContent::processing_description (shared_ptr<const Film> film) const
 }
 
 /** @return User-visible names of each of our audio channels */
-vector<string>
+vector<NamedChannel>
 AudioContent::channel_names () const
 {
-	vector<string> n;
+	vector<NamedChannel> n;
 
-	int t = 1;
+	int index = 0;
+	int stream = 1;
 	BOOST_FOREACH (AudioStreamPtr i, streams ()) {
 		for (int j = 0; j < i->channels(); ++j) {
-			n.push_back (String::compose ("%1:%2", t, j + 1));
+			n.push_back (NamedChannel(String::compose ("%1:%2", stream, j + 1), index++));
 		}
-		++t;
+		++stream;
 	}
 
 	return n;
diff --git a/src/lib/audio_content.h b/src/lib/audio_content.h
index 504c2aecf..b109cc15e 100644
--- a/src/lib/audio_content.h
+++ b/src/lib/audio_content.h
@@ -53,7 +53,7 @@ public:
 	AudioMapping mapping () const;
 	void set_mapping (AudioMapping);
 	int resampled_frame_rate (boost::shared_ptr<const Film> film) const;
-	std::vector<std::string> channel_names () const;
+	std::vector<NamedChannel> channel_names () const;
 
 	void set_gain (double);
 	void set_delay (int);
diff --git a/src/lib/audio_processor.h b/src/lib/audio_processor.h
index 78a3efb58..194c9bf0e 100644
--- a/src/lib/audio_processor.h
+++ b/src/lib/audio_processor.h
@@ -25,6 +25,7 @@
 #ifndef DCPOMATIC_AUDIO_PROCESSOR_H
 #define DCPOMATIC_AUDIO_PROCESSOR_H
 
+#include "types.h"
 #include <boost/shared_ptr.hpp>
 #include <list>
 #include <string>
@@ -58,7 +59,7 @@ public:
 	/** Make the supplied audio mapping into a sensible default for this processor */
 	virtual void make_audio_mapping_default (AudioMapping& mapping) const = 0;
 	/** @return the user-visible (translated) names of each of our inputs, in order */
-	virtual std::vector<std::string> input_names () const = 0;
+	virtual std::vector<NamedChannel> input_names () const = 0;
 
 	static std::list<AudioProcessor const *> all ();
 	static std::list<AudioProcessor const *> visible ();
diff --git a/src/lib/film.cc b/src/lib/film.cc
index ea0a2bdd7..e2e77cce2 100644
--- a/src/lib/film.cc
+++ b/src/lib/film.cc
@@ -1707,7 +1707,7 @@ Film::subtitle_language () const
 /** @return The names of the channels that audio contents' outputs are passed into;
  *  this is either the DCP or a AudioProcessor.
  */
-vector<string>
+vector<NamedChannel>
 Film::audio_output_names () const
 {
 	if (audio_processor ()) {
@@ -1716,10 +1716,12 @@ Film::audio_output_names () const
 
 	DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
 
-	vector<string> n;
+	vector<NamedChannel> n;
 
 	for (int i = 0; i < audio_channels(); ++i) {
-		n.push_back (short_audio_channel_name (i));
+		if (i != 8 && i != 9 && i != 15) {
+			n.push_back (NamedChannel(short_audio_channel_name(i), i));
+		}
 	}
 
 	return n;
diff --git a/src/lib/film.h b/src/lib/film.h
index 66bcce806..887433bea 100644
--- a/src/lib/film.h
+++ b/src/lib/film.h
@@ -177,7 +177,7 @@ public:
 
 	std::string subtitle_language () const;
 
-	std::vector<std::string> audio_output_names () const;
+	std::vector<NamedChannel> audio_output_names () const;
 
 	void repeat_content (ContentList, int);
 
diff --git a/src/lib/mid_side_decoder.cc b/src/lib/mid_side_decoder.cc
index b9b8dd098..fd80937ed 100644
--- a/src/lib/mid_side_decoder.cc
+++ b/src/lib/mid_side_decoder.cc
@@ -90,13 +90,11 @@ MidSideDecoder::make_audio_mapping_default (AudioMapping& mapping) const
 	}
 }
 
-vector<string>
+vector<NamedChannel>
 MidSideDecoder::input_names () const
 {
-	vector<string> n;
-
-	n.push_back (_("Left"));
-	n.push_back (_("Right"));
-
+	vector<NamedChannel> n;
+	n.push_back (NamedChannel(_("Left"), 0));
+	n.push_back (NamedChannel(_("Right"), 1));
 	return n;
 }
diff --git a/src/lib/mid_side_decoder.h b/src/lib/mid_side_decoder.h
index a4c7e2263..e5c1e0a05 100644
--- a/src/lib/mid_side_decoder.h
+++ b/src/lib/mid_side_decoder.h
@@ -29,5 +29,5 @@ public:
 	boost::shared_ptr<AudioProcessor> clone (int) const;
 	boost::shared_ptr<AudioBuffers> run (boost::shared_ptr<const AudioBuffers>, int channels);
 	void make_audio_mapping_default (AudioMapping& mapping) const;
-	std::vector<std::string> input_names () const;
+	std::vector<NamedChannel> input_names () const;
 };
diff --git a/src/lib/types.cc b/src/lib/types.cc
index df57f2d47..e7acf6992 100644
--- a/src/lib/types.cc
+++ b/src/lib/types.cc
@@ -222,3 +222,10 @@ CPLSummary::CPLSummary (boost::filesystem::path p)
 
 	last_write_time = boost::filesystem::last_write_time (p);
 }
+
+
+bool operator== (NamedChannel const& a, NamedChannel const& b)
+{
+	return a.name == b.name && a.index == b.index;
+}
+
diff --git a/src/lib/types.h b/src/lib/types.h
index 50eed9aa1..2ba0408ad 100644
--- a/src/lib/types.h
+++ b/src/lib/types.h
@@ -259,4 +259,20 @@ enum EmailProtocol {
 	EMAIL_PROTOCOL_SSL
 };
 
+
+class NamedChannel
+{
+public:
+	NamedChannel (std::string name_, int index_)
+		: name(name_)
+		, index(index_)
+	{}
+
+	std::string name;
+	int index;
+};
+
+
+bool operator== (NamedChannel const& a, NamedChannel const& b);
+
 #endif
diff --git a/src/lib/upmixer_a.cc b/src/lib/upmixer_a.cc
index ca42cd386..fc92b081d 100644
--- a/src/lib/upmixer_a.cc
+++ b/src/lib/upmixer_a.cc
@@ -120,11 +120,11 @@ UpmixerA::make_audio_mapping_default (AudioMapping& mapping) const
 	}
 }
 
-vector<string>
+vector<NamedChannel>
 UpmixerA::input_names () const
 {
-	vector<string> n;
-	n.push_back (_("Upmix L"));
-	n.push_back (_("Upmix R"));
+	vector<NamedChannel> n;
+	n.push_back (NamedChannel(_("Upmix L"), 0));
+	n.push_back (NamedChannel(_("Upmix R"), 1));
 	return n;
 }
diff --git a/src/lib/upmixer_a.h b/src/lib/upmixer_a.h
index fe6a373ca..18569dcfa 100644
--- a/src/lib/upmixer_a.h
+++ b/src/lib/upmixer_a.h
@@ -40,7 +40,7 @@ public:
 	boost::shared_ptr<AudioBuffers> run (boost::shared_ptr<const AudioBuffers>, int channels);
 	void flush ();
 	void make_audio_mapping_default (AudioMapping& mapping) const;
-	std::vector<std::string> input_names () const;
+	std::vector<NamedChannel> input_names () const;
 
 private:
 	BandPassAudioFilter _left;
diff --git a/src/lib/upmixer_b.cc b/src/lib/upmixer_b.cc
index 2847da03b..dfc9d67d5 100644
--- a/src/lib/upmixer_b.cc
+++ b/src/lib/upmixer_b.cc
@@ -130,11 +130,11 @@ UpmixerB::make_audio_mapping_default (AudioMapping& mapping) const
 	}
 }
 
-vector<string>
+vector<NamedChannel>
 UpmixerB::input_names () const
 {
-	vector<string> n;
-	n.push_back (_("Upmix L"));
-	n.push_back (_("Upmix R"));
+	vector<NamedChannel> n;
+	n.push_back (NamedChannel(_("Upmix L"), 0));
+	n.push_back (NamedChannel(_("Upmix R"), 1));
 	return n;
 }
diff --git a/src/lib/upmixer_b.h b/src/lib/upmixer_b.h
index 47b4fadef..221be1615 100644
--- a/src/lib/upmixer_b.h
+++ b/src/lib/upmixer_b.h
@@ -38,7 +38,7 @@ public:
 	boost::shared_ptr<AudioBuffers> run (boost::shared_ptr<const AudioBuffers>, int channels);
 	void flush ();
 	void make_audio_mapping_default (AudioMapping& mapping) const;
-	std::vector<std::string> input_names () const;
+	std::vector<NamedChannel> input_names () const;
 
 private:
 	LowPassAudioFilter _lfe;
diff --git a/src/lib/util.cc b/src/lib/util.cc
index 32deac2e8..7c0d1dc4e 100644
--- a/src/lib/util.cc
+++ b/src/lib/util.cc
@@ -825,8 +825,6 @@ audio_channel_types (list<int> mapped, int channels)
 		case dcp::CENTRE:
 		case dcp::LS:
 		case dcp::RS:
-		case dcp::LC:
-		case dcp::RC:
 		case dcp::BSL:
 		case dcp::BSR:
 			++non_lfe;
@@ -836,7 +834,6 @@ audio_channel_types (list<int> mapped, int channels)
 		case dcp::MOTION_DATA:
 		case dcp::SYNC_SIGNAL:
 		case dcp::SIGN_LANGUAGE:
-		case dcp::UNUSED:
 		case dcp::CHANNEL_COUNT:
 			break;
 		}
diff --git a/src/wx/audio_mapping_view.cc b/src/wx/audio_mapping_view.cc
index 438b1e856..da08b66ad 100644
--- a/src/wx/audio_mapping_view.cc
+++ b/src/wx/audio_mapping_view.cc
@@ -191,9 +191,9 @@ AudioMappingView::paint_column_labels (wxDC& dc)
 	wxCoord label_width;
 	wxCoord label_height;
 	int N = 0;
-	BOOST_FOREACH (string i, _output_channels) {
-		dc.GetTextExtent (std_to_wx(i), &label_width, &label_height);
-		dc.DrawText (std_to_wx(i), LEFT_WIDTH + GRID_SPACING * N + (GRID_SPACING - label_width) / 2, GRID_SPACING + (GRID_SPACING - label_height) / 2);
+	BOOST_FOREACH (NamedChannel const& i, _output_channels) {
+		dc.GetTextExtent (std_to_wx(i.name), &label_width, &label_height);
+		dc.DrawText (std_to_wx(i.name), LEFT_WIDTH + GRID_SPACING * N + (GRID_SPACING - label_width) / 2, GRID_SPACING + (GRID_SPACING - label_height) / 2);
 		++N;
 	}
 
@@ -226,9 +226,9 @@ AudioMappingView::paint_row_labels (wxDC& dc)
 	/* Row channel labels */
 
 	int N = 0;
-	BOOST_FOREACH (string i, _input_channels) {
-		dc.GetTextExtent (std_to_wx(i), &label_width, &label_height);
-		dc.DrawText (std_to_wx(i), GRID_SPACING * 2 + (GRID_SPACING - label_width) / 2, TOP_HEIGHT + GRID_SPACING * N + (GRID_SPACING - label_height) / 2);
+	BOOST_FOREACH (NamedChannel const& i, _input_channels) {
+		dc.GetTextExtent (std_to_wx(i.name), &label_width, &label_height);
+		dc.DrawText (std_to_wx(i.name), GRID_SPACING * 2 + (GRID_SPACING - label_width) / 2, TOP_HEIGHT + GRID_SPACING * N + (GRID_SPACING - label_height) / 2);
 		++N;
 	}
 
@@ -305,7 +305,7 @@ AudioMappingView::paint_indicators (wxDC& dc)
 					)
 				);
 
-			float const value_dB = linear_to_db(_map.get(y, x));
+			float const value_dB = linear_to_db(_map.get(_input_channels[y].index, _output_channels[x].index));
 			wxColour const colour = value_dB <= 0 ? wxColour(0, 255, 0) : wxColour(255, 150, 0);
 			int const range = 18;
 			int height = 0;
@@ -410,24 +410,24 @@ AudioMappingView::paint ()
 	restore (dc);
 }
 
-optional<pair<int, int> >
+optional<pair<NamedChannel, NamedChannel> >
 AudioMappingView::mouse_event_to_channels (wxMouseEvent& ev) const
 {
 	int const x = ev.GetX() + _horizontal_scroll->GetThumbPosition();
 	int const y = ev.GetY() + _vertical_scroll->GetThumbPosition();
 
 	if (x <= LEFT_WIDTH || y < TOP_HEIGHT) {
-		return optional<pair<int, int> >();
+		return optional<pair<NamedChannel, NamedChannel> >();
 	}
 
 	int const input = (y - TOP_HEIGHT) / GRID_SPACING;
 	int const output = (x - LEFT_WIDTH) / GRID_SPACING;
 
 	if (input >= int(_input_channels.size()) || output >= int(_output_channels.size())) {
-		return optional<pair<int, int> >();
+		return optional<pair<NamedChannel, NamedChannel> >();
 	}
 
-	return make_pair (input, output);
+	return make_pair (_input_channels[input], _output_channels[output]);
 }
 
 optional<string>
@@ -451,15 +451,15 @@ AudioMappingView::mouse_event_to_input_group_name (wxMouseEvent& ev) const
 void
 AudioMappingView::left_down (wxMouseEvent& ev)
 {
-	optional<pair<int, int> > channels = mouse_event_to_channels (ev);
+	optional<pair<NamedChannel, NamedChannel> > channels = mouse_event_to_channels (ev);
 	if (!channels) {
 		return;
 	}
 
-	if (_map.get(channels->first, channels->second) > 0) {
-		_map.set (channels->first, channels->second, 0);
+	if (_map.get(channels->first.index, channels->second.index) > 0) {
+		_map.set (channels->first.index, channels->second.index, 0);
 	} else {
-		_map.set (channels->first, channels->second, 1);
+		_map.set (channels->first.index, channels->second.index, 1);
 	}
 
 	map_values_changed ();
@@ -468,13 +468,13 @@ AudioMappingView::left_down (wxMouseEvent& ev)
 void
 AudioMappingView::right_down (wxMouseEvent& ev)
 {
-	optional<pair<int, int> > channels = mouse_event_to_channels (ev);
+	optional<pair<NamedChannel, NamedChannel> > channels = mouse_event_to_channels (ev);
 	if (!channels) {
 		return;
 	}
 
-	_menu_input = channels->first;
-	_menu_output = channels->second;
+	_menu_input = channels->first.index;
+	_menu_output = channels->second.index;
 	PopupMenu (_menu, ev.GetPosition());
 }
 
@@ -499,7 +499,7 @@ void
 AudioMappingView::map_values_changed ()
 {
 	Changed (_map);
-	_last_tooltip_channels = optional<pair<int, int> >();
+	_last_tooltip_channels = optional<pair<NamedChannel, NamedChannel> >();
 	Refresh ();
 }
 
@@ -530,84 +530,72 @@ AudioMappingView::set (AudioMapping map)
 }
 
 void
-AudioMappingView::set_input_channels (vector<string> const & names)
+AudioMappingView::set_input_channels (vector<NamedChannel> const& channels)
 {
-	_input_channels = names;
+	_input_channels = channels;
 	setup ();
 	Refresh ();
 }
 
 void
-AudioMappingView::set_output_channels (vector<string> const & names)
+AudioMappingView::set_output_channels (vector<NamedChannel> const & channels)
 {
-	_output_channels = names;
+	_output_channels = channels;
 	setup ();
 	Refresh ();
 }
 
+
 wxString
-AudioMappingView::safe_input_channel_name (int n) const
+AudioMappingView::input_channel_name_with_group (NamedChannel const& n) const
 {
-	if (n >= int(_input_channels.size())) {
-		return wxString::Format ("%d", n + 1);
-	}
-
 	optional<wxString> group;
 	BOOST_FOREACH (Group i, _input_groups) {
-		if (i.from <= n && n <= i.to) {
+		if (i.from <= n.index && n.index <= i.to) {
 			group = std_to_wx (i.name);
 		}
 	}
 
 	if (group && !group->IsEmpty()) {
-		return wxString::Format ("%s/%s", group->data(), std_to_wx(_input_channels[n]).data());
+		return wxString::Format ("%s/%s", group->data(), std_to_wx(n.name).data());
 	}
 
-	return std_to_wx(_input_channels[n]);
+	return std_to_wx(n.name);
 }
 
-wxString
-AudioMappingView::safe_output_channel_name (int n) const
-{
-	if (n >= int(_output_channels.size())) {
-		return wxString::Format ("%d", n + 1);
-	}
-
-	return std_to_wx(_output_channels[n]);
-}
 
 void
 AudioMappingView::motion (wxMouseEvent& ev)
 {
-	optional<pair<int, int> > channels = mouse_event_to_channels (ev);
+	optional<pair<NamedChannel, NamedChannel> > channels = mouse_event_to_channels (ev);
 	if (channels) {
 		if (channels != _last_tooltip_channels) {
 			wxString s;
-			float const gain = _map.get(channels->first, channels->second);
+			float const gain = _map.get(channels->first.index, channels->second.index);
 			if (gain == 0) {
 				s = wxString::Format (
 					_("No audio will be passed from %s channel '%s' to %s channel '%s'."),
 					_from,
-					safe_input_channel_name(channels->first),
+					input_channel_name_with_group(channels->first),
 					_to,
-					safe_output_channel_name(channels->second)
+					std_to_wx(channels->second.name)
 					);
 			} else if (gain == 1) {
 				s = wxString::Format (
 					_("Audio will be passed from %s channel %s to %s channel %s unaltered."),
 					_from,
-					safe_input_channel_name(channels->first),
+					input_channel_name_with_group(channels->first),
 					_to,
-					safe_output_channel_name(channels->second)
+					std_to_wx(channels->second.name)
 					);
 			} else {
 				float const dB = linear_to_db(gain);
 				s = wxString::Format (
 					_("Audio will be passed from %s channel %s to %s channel %s with gain %.1fdB."),
 					_from,
-					safe_input_channel_name(channels->first),
+					input_channel_name_with_group(channels->first),
 					_to,
-					safe_output_channel_name(channels->second),
+					std_to_wx(channels->second.name),
 					dB
 					);
 			}
diff --git a/src/wx/audio_mapping_view.h b/src/wx/audio_mapping_view.h
index c65df4daf..f5626e524 100644
--- a/src/wx/audio_mapping_view.h
+++ b/src/wx/audio_mapping_view.h
@@ -24,6 +24,7 @@
  */
 
 #include "lib/audio_mapping.h"
+#include "lib/types.h"
 #include "lib/warnings.h"
 DCPOMATIC_DISABLE_WARNINGS
 #include <wx/wx.h>
@@ -51,8 +52,8 @@ public:
 	AudioMappingView (wxWindow *, wxString left_label, wxString from, wxString top_label, wxString to);
 
 	void set (AudioMapping);
-	void set_input_channels (std::vector<std::string> const & names);
-	void set_output_channels (std::vector<std::string> const & names);
+	void set_input_channels (std::vector<NamedChannel> const& channels);
+	void set_output_channels (std::vector<NamedChannel> const& channels);
 
 	struct Group
 	{
@@ -90,11 +91,10 @@ private:
 	void right_down (wxMouseEvent &);
 	void motion (wxMouseEvent &);
 	void mouse_wheel (wxMouseEvent &);
-	boost::optional<std::pair<int, int> > mouse_event_to_channels (wxMouseEvent& ev) const;
+	boost::optional<std::pair<NamedChannel, NamedChannel> > mouse_event_to_channels (wxMouseEvent& ev) const;
 	boost::optional<std::string> mouse_event_to_input_group_name (wxMouseEvent& ev) const;
 	void setup ();
-	wxString safe_input_channel_name (int n) const;
-	wxString safe_output_channel_name (int n) const;
+	wxString input_channel_name_with_group (NamedChannel const& n) const;
 
 	void set_gain_from_menu (double linear);
 	void edit ();
@@ -113,9 +113,9 @@ private:
 	wxString _top_label;
 	wxString _to;
 
-	std::vector<std::string> _input_channels;
-	std::vector<std::string> _output_channels;
+	std::vector<NamedChannel> _input_channels;
+	std::vector<NamedChannel> _output_channels;
 	std::vector<Group> _input_groups;
 
-	boost::optional<std::pair<int, int> > _last_tooltip_channels;
+	boost::optional<std::pair<NamedChannel, NamedChannel> > _last_tooltip_channels;
 };
diff --git a/src/wx/config_dialog.cc b/src/wx/config_dialog.cc
index fe8e84795..40bb43407 100644
--- a/src/wx/config_dialog.cc
+++ b/src/wx/config_dialog.cc
@@ -1016,15 +1016,15 @@ SoundPage::config_changed ()
 
 	_map->set (Config::instance()->audio_mapping(channels));
 
-	vector<string> input;
+	vector<NamedChannel> input;
 	for (int i = 0; i < MAX_DCP_AUDIO_CHANNELS; ++i) {
-		input.push_back (short_audio_channel_name(i));
+		input.push_back (NamedChannel(short_audio_channel_name(i), i));
 	}
 	_map->set_input_channels (input);
 
-	vector<string> output;
+	vector<NamedChannel> output;
 	for (int i = 0; i < channels; ++i) {
-		output.push_back (dcp::raw_convert<string>(i));
+		output.push_back (NamedChannel(dcp::raw_convert<string>(i), i));
 	}
 	_map->set_output_channels (output);