/*
    Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>

    This file is part of DCP-o-matic.

    DCP-o-matic 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.

    DCP-o-matic 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 DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.

*/


/** @file  src/wx/audio_mapping_view.h
 *  @brief AudioMappingView class.
 */


#include "lib/audio_mapping.h"
#include "lib/named_channel.h"
#include <dcp/warnings.h>
LIBDCP_DISABLE_WARNINGS
#include <wx/wx.h>
LIBDCP_ENABLE_WARNINGS
#include <boost/signals2.hpp>


/** @class AudioMappingView
 *  @brief This class displays the mapping of one set of audio channels to another,
 *  with gain values on each node of the map.
 *
 *  The AudioMapping passed to set() describes the actual channel mapping,
 *  and the names passed to set_input_channels() and set_output_channels() are
 *  used to label the rows and columns.
 *
 *  The display's row count is equal to the AudioMapping's input channel count,
 *  and the column count is equal to the number of name passed to
 *  set_output_channels().  Any other output channels in the AudioMapping are
 *  hidden from view.  Thus input channels are never hidden but output channels
 *  might be.
 */
class AudioMappingView : public wxPanel
{
public:
	AudioMappingView (wxWindow *, wxString left_label, wxString from, wxString top_label, wxString to);

	void set (AudioMapping);
	void set_input_channels (std::vector<NamedChannel> const& channels);
	void set_output_channels (std::vector<NamedChannel> const& channels);

	struct Group
	{
		Group (int f, int t, std::string n)
			: from (f)
			, to (t)
			, name (n)
		{}

		/** First channel index (from 0) */
		int from;
		/** Last channel index (from 0) */
		int to;
		/** Name of this group */
		std::string name;
	};

	void set_input_groups (std::vector<Group> const & groups);

	boost::signals2::signal<void (AudioMapping)> Changed;

private:
	void map_values_changed ();
	void paint ();
	void paint_static (wxDC& dc);
	void paint_column_labels (wxDC& dc);
	void paint_column_lines (wxDC& dc);
	void paint_row_labels (wxDC& dc);
	void paint_row_lines (wxDC& dc);
	void paint_indicators (wxDC& dc);
	void size (wxSizeEvent &);
	void left_down (wxMouseEvent &);
	void right_down (wxMouseEvent &);
	void motion (wxMouseEvent &);
	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 input_channel_name_with_group (NamedChannel const& n) const;
	int left_width() const;

	void set_gain_from_menu (double linear);
	void edit ();
	void all_off ();

	AudioMapping _map;

	wxMenu* _menu = nullptr;
	int _menu_input;
	int _menu_output;

	wxString _left_label;
	wxString _from;
	wxString _top_label;
	wxString _to;

	std::vector<NamedChannel> _input_channels;
	std::vector<NamedChannel> _output_channels;
	std::vector<Group> _input_groups;
	std::vector<int> _column_widths;
	int _column_widths_total = 0;

	boost::optional<std::pair<NamedChannel, NamedChannel>> _last_tooltip_channels;
};