leave some todo-notes #6709 (track templates & state)
[ardour.git] / gtk2_ardour / mixer_ui.h
1 /*
2     Copyright (C) 2000 Paul Davis
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 #ifndef __ardour_mixer_ui_h__
21 #define __ardour_mixer_ui_h__
22
23 #include <list>
24
25 #include <gtkmm/box.h>
26 #include <gtkmm/scrolledwindow.h>
27 #include <gtkmm/eventbox.h>
28 #include <gtkmm/label.h>
29 #include <gtkmm/button.h>
30 #include <gtkmm/frame.h>
31 #include <gtkmm/paned.h>
32 #include <gtkmm/menu.h>
33 #include <gtkmm/treeview.h>
34 #include <gtkmm/liststore.h>
35
36 #include "pbd/stateful.h"
37 #include "pbd/signals.h"
38
39 #include "ardour/ardour.h"
40 #include "ardour/types.h"
41 #include "ardour/session_handle.h"
42
43 #include "gtkmm2ext/visibility_tracker.h"
44
45 #include "enums.h"
46 #include "mixer_actor.h"
47
48 namespace ARDOUR {
49         class Route;
50         class RouteGroup;
51 };
52
53 class MixerStrip;
54 class PluginSelector;
55 class MixerGroupTabs;
56 class MonitorSection;
57
58 class Mixer_UI : public Gtk::Window, public PBD::ScopedConnectionList, public ARDOUR::SessionHandlePtr, public MixerActor, public Gtkmm2ext::VisibilityTracker
59 {
60   public:
61         static Mixer_UI* instance();
62         ~Mixer_UI();
63
64         void set_session (ARDOUR::Session *);
65         void track_editor_selection ();
66
67         PluginSelector* plugin_selector();
68
69         void  set_strip_width (Width, bool save = false);
70         Width get_strip_width () const { return _strip_width; }
71
72         void unselect_strip_in_display (MixerStrip*);
73         void select_strip_in_display (MixerStrip*);
74
75         XMLNode& get_state (void);
76         int set_state (const XMLNode& );
77
78         void show_mixer_list (bool yn);
79         
80         void show_window ();
81         bool hide_window (GdkEventAny *ev);
82         void show_strip (MixerStrip *);
83         void hide_strip (MixerStrip *);
84
85         void maximise_mixer_space();
86         void restore_mixer_space();
87
88         void ensure_float (Gtk::Window&);
89
90         MonitorSection* monitor_section() const { return _monitor_section; }
91
92         void deselect_all_strip_processors();
93         void delete_processors();
94
95         void select_none ();
96
97   protected:
98         void set_route_targets_for_operation ();
99
100   private:
101         Mixer_UI ();
102         static Mixer_UI* _instance;
103
104         bool                                    _visible;
105
106         Gtk::HBox                               global_hpacker;
107         Gtk::VBox                               global_vpacker;
108         Gtk::ScrolledWindow             scroller;
109         Gtk::EventBox                   scroller_base;
110         Gtk::HBox                               scroller_hpacker;
111         Gtk::VBox                               mixer_scroller_vpacker;
112         Gtk::VBox                               list_vpacker;
113         Gtk::Label                              group_display_button_label;
114         Gtk::Button                             group_display_button;
115         Gtk::ScrolledWindow             track_display_scroller;
116         Gtk::ScrolledWindow             group_display_scroller;
117         Gtk::VBox                               group_display_vbox;
118         Gtk::Frame                              track_display_frame;
119         Gtk::Frame                              group_display_frame;
120         Gtk::VPaned                             rhs_pane1;
121         Gtk::HBox                               strip_packer;
122         Gtk::HBox                               out_packer;
123         Gtk::HPaned                             list_hpane;
124
125         MixerGroupTabs* _group_tabs;
126
127         // for restoring window geometry.
128         int m_root_x, m_root_y, m_width, m_height;
129
130         void set_window_pos_and_size ();
131         void get_window_pos_and_size ();
132
133         bool on_key_press_event (GdkEventKey*);
134         bool on_key_release_event (GdkEventKey*);
135         bool on_scroll_event (GdkEventScroll*);
136
137         void pane_allocation_handler (Gtk::Allocation&, Gtk::Paned*);
138
139         std::list<MixerStrip *> strips;
140
141         bool strip_scroller_button_release (GdkEventButton*);
142         void scroll_left ();
143         void scroll_right ();
144         void toggle_midi_input_active (bool flip_others);
145
146         void add_strips (ARDOUR::RouteList&);
147         void remove_strip (MixerStrip *);
148
149         MixerStrip* strip_by_route (boost::shared_ptr<ARDOUR::Route>);
150
151         void hide_all_strips (bool with_select);
152         void unselect_all_strips();
153         void select_all_strips ();
154         void unselect_all_audiotrack_strips ();
155         void select_all_audiotrack_strips ();
156         void unselect_all_audiobus_strips ();
157         void select_all_audiobus_strips ();
158
159         void strip_select_op (bool audiotrack, bool select);
160         void select_strip_op (MixerStrip*, bool select);
161
162         gint start_updating ();
163         gint stop_updating ();
164
165         void session_going_away ();
166
167         sigc::connection fast_screen_update_connection;
168         void fast_update_strips ();
169
170         void track_name_changed (MixerStrip *);
171
172         void redisplay_track_list ();
173         bool no_track_list_redisplay;
174         bool track_display_button_press (GdkEventButton*);
175         void strip_width_changed ();
176
177         void track_list_delete (const Gtk::TreeModel::Path&);
178         void track_list_reorder (const Gtk::TreeModel::Path& path, const Gtk::TreeModel::iterator& iter, int* new_order);
179
180         void initial_track_display ();
181         void show_track_list_menu ();
182
183         void set_all_strips_visibility (bool yn);
184         void set_all_audio_midi_visibility (int, bool);
185         void track_visibility_changed (std::string const & path);
186         void update_track_visibility ();
187
188         void hide_all_routes ();
189         void show_all_routes ();
190         void show_all_audiobus ();
191         void hide_all_audiobus ();
192         void show_all_audiotracks();
193         void hide_all_audiotracks ();
194         void show_all_miditracks();
195         void hide_all_miditracks ();
196
197         bool in_group_row_change;
198
199         void group_selected (gint row, gint col, GdkEvent *ev);
200         void group_unselected (gint row, gint col, GdkEvent *ev);
201         void group_display_active_clicked();
202         void new_route_group ();
203         void remove_selected_route_group ();
204         void activate_all_route_groups ();
205         void disable_all_route_groups ();
206         void add_route_group (ARDOUR::RouteGroup *);
207         void route_groups_changed ();
208         void route_group_name_edit (const std::string&, const std::string&);
209         void route_group_row_change (const Gtk::TreeModel::Path& path,const Gtk::TreeModel::iterator& iter);
210         void route_group_row_deleted (Gtk::TreeModel::Path const &);
211
212         Gtk::Menu *track_menu;
213         void track_column_click (gint);
214         void build_track_menu ();
215
216         MonitorSection* _monitor_section;
217         PluginSelector    *_plugin_selector;
218
219         void strip_property_changed (const PBD::PropertyChange&, MixerStrip *);
220         void route_group_property_changed (ARDOUR::RouteGroup *, const PBD::PropertyChange &);
221
222         /* various treeviews */
223
224         struct TrackDisplayModelColumns : public Gtk::TreeModel::ColumnRecord {
225             TrackDisplayModelColumns () {
226                     add (text);
227                     add (visible);
228                     add (route);
229                     add (strip);
230             }
231             Gtk::TreeModelColumn<bool>           visible;
232             Gtk::TreeModelColumn<std::string>  text;
233             Gtk::TreeModelColumn<boost::shared_ptr<ARDOUR::Route> > route;
234             Gtk::TreeModelColumn<MixerStrip*>    strip;
235         };
236
237         struct GroupDisplayModelColumns : public Gtk::TreeModel::ColumnRecord {
238             GroupDisplayModelColumns() {
239                     add (visible);
240                     add (text);
241                     add (group);
242             }
243             Gtk::TreeModelColumn<bool>                                  visible;
244             Gtk::TreeModelColumn<std::string>                   text;
245             Gtk::TreeModelColumn<ARDOUR::RouteGroup*>   group;
246         };
247
248         TrackDisplayModelColumns    track_columns;
249         GroupDisplayModelColumns    group_columns;
250
251         Gtk::TreeView track_display;
252         Gtk::TreeView group_display;
253
254         Glib::RefPtr<Gtk::ListStore> track_model;
255         Glib::RefPtr<Gtk::ListStore> group_model;
256
257         bool group_display_button_press (GdkEventButton*);
258         void group_display_selection_changed ();
259
260         bool strip_button_release_event (GdkEventButton*, MixerStrip*);
261
262         Width _strip_width;
263
264         void sync_order_keys_from_treeview ();
265         void sync_treeview_from_order_keys ();
266         void reset_remote_control_ids ();
267         void reset_order_keys ();
268
269         bool ignore_reorder;
270
271         void parameter_changed (std::string const &);
272         void set_route_group_activation (ARDOUR::RouteGroup *, bool);
273
274         void setup_track_display ();
275         void new_track_or_bus ();
276
277         static const int32_t default_width = 478;
278         static const int32_t default_height = 765;
279
280         /** true if we are rebuilding the route group list, or clearing
281             it during a session teardown.
282         */
283         bool _in_group_rebuild_or_clear;
284         bool _route_deletion_in_progress;
285
286         void update_title ();
287         MixerStrip* strip_by_x (int x);
288
289         friend class MixerGroupTabs;
290
291         void follow_editor_selection ();
292         bool _following_editor_selection;
293
294         void monitor_section_going_away ();
295
296         /// true if we are in fullscreen mode
297         bool _maximised;
298
299         // true if mixer list is visible
300         bool _show_mixer_list;
301 };
302
303 #endif /* __ardour_mixer_ui_h__ */
304
305