Add NamedChannel and use it to hide the never-used channels
[dcpomatic.git] / src / wx / audio_mapping_view.h
1 /*
2     Copyright (C) 2013-2020 Carl Hetherington <cth@carlh.net>
3
4     This file is part of DCP-o-matic.
5
6     DCP-o-matic is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     DCP-o-matic is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License
17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
18
19 */
20
21 /** @file  src/wx/audio_mapping_view.h
22  *  @brief AudioMappingView class.
23  *
24  */
25
26 #include "lib/audio_mapping.h"
27 #include "lib/types.h"
28 #include "lib/warnings.h"
29 DCPOMATIC_DISABLE_WARNINGS
30 #include <wx/wx.h>
31 DCPOMATIC_ENABLE_WARNINGS
32 #include <boost/signals2.hpp>
33
34 /** @class AudioMappingView
35  *  @brief This class displays the mapping of one set of audio channels to another,
36  *  with gain values on each node of the map.
37  *
38  *  The AudioMapping passed to set() describes the actual channel mapping,
39  *  and the names passed to set_input_channels() and set_output_channels() are
40  *  used to label the rows and columns.
41  *
42  *  The display's row count is equal to the AudioMapping's input channel count,
43  *  and the column count is equal to the number of name passed to
44  *  set_output_channels().  Any other output channels in the AudioMapping are
45  *  hidden from view.  Thus input channels are never hidden but output channels
46  *  might be.
47  */
48
49 class AudioMappingView : public wxPanel
50 {
51 public:
52         AudioMappingView (wxWindow *, wxString left_label, wxString from, wxString top_label, wxString to);
53
54         void set (AudioMapping);
55         void set_input_channels (std::vector<NamedChannel> const& channels);
56         void set_output_channels (std::vector<NamedChannel> const& channels);
57
58         struct Group
59         {
60                 Group (int f, int t, std::string n)
61                         : from (f)
62                         , to (t)
63                         , name (n)
64                 {}
65
66                 /** First channel index (from 0) */
67                 int from;
68                 /** Last channel index (from 0) */
69                 int to;
70                 /** Name of this group */
71                 std::string name;
72         };
73
74         void set_input_groups (std::vector<Group> const & groups);
75
76         boost::signals2::signal<void (AudioMapping)> Changed;
77
78 private:
79         void map_values_changed ();
80         void setup_sizes ();
81         void paint ();
82         void paint_static (wxDC& dc);
83         void paint_column_labels (wxDC& dc);
84         void paint_column_lines (wxDC& dc);
85         void paint_row_labels (wxDC& dc);
86         void paint_row_lines (wxDC& dc);
87         void paint_indicators (wxDC& dc);
88         void size (wxSizeEvent &);
89         void scroll ();
90         void left_down (wxMouseEvent &);
91         void right_down (wxMouseEvent &);
92         void motion (wxMouseEvent &);
93         void mouse_wheel (wxMouseEvent &);
94         boost::optional<std::pair<NamedChannel, NamedChannel> > mouse_event_to_channels (wxMouseEvent& ev) const;
95         boost::optional<std::string> mouse_event_to_input_group_name (wxMouseEvent& ev) const;
96         void setup ();
97         wxString input_channel_name_with_group (NamedChannel const& n) const;
98
99         void set_gain_from_menu (double linear);
100         void edit ();
101
102         AudioMapping _map;
103
104         wxMenu* _menu;
105         wxPanel* _body;
106         wxScrollBar* _vertical_scroll;
107         wxScrollBar* _horizontal_scroll;
108         int _menu_input;
109         int _menu_output;
110
111         wxString _left_label;
112         wxString _from;
113         wxString _top_label;
114         wxString _to;
115
116         std::vector<NamedChannel> _input_channels;
117         std::vector<NamedChannel> _output_channels;
118         std::vector<Group> _input_groups;
119
120         boost::optional<std::pair<NamedChannel, NamedChannel> > _last_tooltip_channels;
121 };