add Favorite Plugins List (DnD) to the Mixer.
[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 #include "ardour/plugin.h"
43 #include "ardour/plugin_manager.h"
44
45 #include "gtkmm2ext/visibility_tracker.h"
46 #include "gtkmm2ext/dndtreeview.h"
47 #include "gtkmm2ext/treeutils.h"
48
49 #include "enums.h"
50 #include "mixer_actor.h"
51
52 namespace ARDOUR {
53         class Route;
54         class RouteGroup;
55 };
56
57 class MixerStrip;
58 class PluginSelector;
59 class MixerGroupTabs;
60 class MonitorSection;
61
62 class Mixer_UI : public Gtk::Window, public PBD::ScopedConnectionList, public ARDOUR::SessionHandlePtr, public MixerActor, public Gtkmm2ext::VisibilityTracker
63 {
64   public:
65         static Mixer_UI* instance();
66         ~Mixer_UI();
67
68         void set_session (ARDOUR::Session *);
69         void track_editor_selection ();
70
71         PluginSelector* plugin_selector();
72
73         void  set_strip_width (Width, bool save = false);
74         Width get_strip_width () const { return _strip_width; }
75
76         void unselect_strip_in_display (MixerStrip*);
77         void select_strip_in_display (MixerStrip*);
78
79         XMLNode& get_state (void);
80         int set_state (const XMLNode& );
81
82         void show_mixer_list (bool yn);
83         void show_monitor_section (bool);
84         
85         void show_window ();
86         bool hide_window (GdkEventAny *ev);
87         void show_strip (MixerStrip *);
88         void hide_strip (MixerStrip *);
89
90         void maximise_mixer_space();
91         void restore_mixer_space();
92
93         void ensure_float (Gtk::Window&);
94
95         MonitorSection* monitor_section() const { return _monitor_section; }
96
97         void deselect_all_strip_processors();
98         void delete_processors();
99
100         void select_none ();
101
102   protected:
103         void set_route_targets_for_operation ();
104
105   private:
106         Mixer_UI ();
107         static Mixer_UI* _instance;
108
109         bool                                    _visible;
110
111         Gtk::HBox                               global_hpacker;
112         Gtk::VBox                               global_vpacker;
113         Gtk::ScrolledWindow             scroller;
114         Gtk::EventBox                   scroller_base;
115         Gtk::HBox                               scroller_hpacker;
116         Gtk::VBox                               mixer_scroller_vpacker;
117         Gtk::VBox                               list_vpacker;
118         Gtk::Label                              group_display_button_label;
119         Gtk::Button                             group_display_button;
120         Gtk::ScrolledWindow             track_display_scroller;
121         Gtk::ScrolledWindow             group_display_scroller;
122         Gtk::ScrolledWindow             favorite_plugins_scroller;
123         Gtk::VBox                               group_display_vbox;
124         Gtk::Frame                              track_display_frame;
125         Gtk::Frame                              group_display_frame;
126         Gtk::Frame                              favorite_plugins_frame;
127         Gtk::VPaned                             rhs_pane1;
128         Gtk::VPaned                             rhs_pane2;
129         Gtk::HBox                               strip_packer;
130         Gtk::HBox                               out_packer;
131         Gtk::HPaned                             list_hpane;
132
133         MixerGroupTabs* _group_tabs;
134
135         // for restoring window geometry.
136         int m_root_x, m_root_y, m_width, m_height;
137
138         void set_window_pos_and_size ();
139         void get_window_pos_and_size ();
140
141         bool on_key_press_event (GdkEventKey*);
142         bool on_key_release_event (GdkEventKey*);
143         bool on_scroll_event (GdkEventScroll*);
144
145         void pane_allocation_handler (Gtk::Allocation&, Gtk::Paned*);
146
147         std::list<MixerStrip *> strips;
148
149         bool strip_scroller_button_release (GdkEventButton*);
150         void scroll_left ();
151         void scroll_right ();
152         void toggle_midi_input_active (bool flip_others);
153
154         void add_strips (ARDOUR::RouteList&);
155         void remove_strip (MixerStrip *);
156
157         MixerStrip* strip_by_route (boost::shared_ptr<ARDOUR::Route>);
158
159         void hide_all_strips (bool with_select);
160         void unselect_all_strips();
161         void select_all_strips ();
162         void unselect_all_audiotrack_strips ();
163         void select_all_audiotrack_strips ();
164         void unselect_all_audiobus_strips ();
165         void select_all_audiobus_strips ();
166
167         void strip_select_op (bool audiotrack, bool select);
168         void select_strip_op (MixerStrip*, bool select);
169
170         gint start_updating ();
171         gint stop_updating ();
172
173         void session_going_away ();
174
175         sigc::connection fast_screen_update_connection;
176         void fast_update_strips ();
177
178         void track_name_changed (MixerStrip *);
179
180         void redisplay_track_list ();
181         bool no_track_list_redisplay;
182         bool track_display_button_press (GdkEventButton*);
183         void strip_width_changed ();
184
185         void track_list_delete (const Gtk::TreeModel::Path&);
186         void track_list_reorder (const Gtk::TreeModel::Path& path, const Gtk::TreeModel::iterator& iter, int* new_order);
187
188         void initial_track_display ();
189         void show_track_list_menu ();
190
191         void set_all_strips_visibility (bool yn);
192         void set_all_audio_midi_visibility (int, bool);
193         void track_visibility_changed (std::string const & path);
194         void update_track_visibility ();
195
196         void hide_all_routes ();
197         void show_all_routes ();
198         void show_all_audiobus ();
199         void hide_all_audiobus ();
200         void show_all_audiotracks();
201         void hide_all_audiotracks ();
202         void show_all_miditracks();
203         void hide_all_miditracks ();
204
205         bool in_group_row_change;
206
207         void group_selected (gint row, gint col, GdkEvent *ev);
208         void group_unselected (gint row, gint col, GdkEvent *ev);
209         void group_display_active_clicked();
210         void new_route_group ();
211         void remove_selected_route_group ();
212         void activate_all_route_groups ();
213         void disable_all_route_groups ();
214         void add_route_group (ARDOUR::RouteGroup *);
215         void route_groups_changed ();
216         void route_group_name_edit (const std::string&, const std::string&);
217         void route_group_row_change (const Gtk::TreeModel::Path& path,const Gtk::TreeModel::iterator& iter);
218         void route_group_row_deleted (Gtk::TreeModel::Path const &);
219
220         Gtk::Menu *track_menu;
221         void track_column_click (gint);
222         void build_track_menu ();
223
224         MonitorSection* _monitor_section;
225         PluginSelector    *_plugin_selector;
226
227         void strip_property_changed (const PBD::PropertyChange&, MixerStrip *);
228         void route_group_property_changed (ARDOUR::RouteGroup *, const PBD::PropertyChange &);
229
230         /* various treeviews */
231
232         struct TrackDisplayModelColumns : public Gtk::TreeModel::ColumnRecord {
233             TrackDisplayModelColumns () {
234                     add (text);
235                     add (visible);
236                     add (route);
237                     add (strip);
238             }
239             Gtk::TreeModelColumn<bool>           visible;
240             Gtk::TreeModelColumn<std::string>  text;
241             Gtk::TreeModelColumn<boost::shared_ptr<ARDOUR::Route> > route;
242             Gtk::TreeModelColumn<MixerStrip*>    strip;
243         };
244
245         struct GroupDisplayModelColumns : public Gtk::TreeModel::ColumnRecord {
246             GroupDisplayModelColumns() {
247                     add (visible);
248                     add (text);
249                     add (group);
250             }
251             Gtk::TreeModelColumn<bool>                                  visible;
252             Gtk::TreeModelColumn<std::string>                   text;
253             Gtk::TreeModelColumn<ARDOUR::RouteGroup*>   group;
254         };
255
256         struct PluginsDisplayModelColumns : public Gtk::TreeModel::ColumnRecord {
257             PluginsDisplayModelColumns() {
258                     add (name);
259                     add (plugin);
260             }
261             Gtk::TreeModelColumn<std::string> name;
262                         Gtk::TreeModelColumn<ARDOUR::PluginInfoPtr> plugin;
263         };
264
265
266         TrackDisplayModelColumns    track_columns;
267         GroupDisplayModelColumns    group_columns;
268         PluginsDisplayModelColumns  favorite_plugins_columns;
269
270         Gtk::TreeView track_display;
271         Gtk::TreeView group_display;
272         Gtkmm2ext::DnDTreeView<ARDOUR::PluginInfoPtr> favorite_plugins_display;
273
274         Glib::RefPtr<Gtk::ListStore> track_model;
275         Glib::RefPtr<Gtk::ListStore> group_model;
276         Glib::RefPtr<Gtk::ListStore> favorite_plugins_model;
277
278         bool group_display_button_press (GdkEventButton*);
279         void group_display_selection_changed ();
280
281         bool strip_button_release_event (GdkEventButton*, MixerStrip*);
282
283         Width _strip_width;
284
285         void sync_order_keys_from_treeview ();
286         void sync_treeview_from_order_keys ();
287         void reset_remote_control_ids ();
288         void reset_order_keys ();
289
290         bool ignore_reorder;
291
292         void parameter_changed (std::string const &);
293         void set_route_group_activation (ARDOUR::RouteGroup *, bool);
294
295         void setup_track_display ();
296         void new_track_or_bus ();
297
298         static const int32_t default_width = 478;
299         static const int32_t default_height = 765;
300
301         /** true if we are rebuilding the route group list, or clearing
302             it during a session teardown.
303         */
304         bool _in_group_rebuild_or_clear;
305         bool _route_deletion_in_progress;
306
307         void update_title ();
308         MixerStrip* strip_by_x (int x);
309
310         friend class MixerGroupTabs;
311
312         void follow_editor_selection ();
313         bool _following_editor_selection;
314
315         void monitor_section_going_away ();
316
317         void monitor_section_attached ();
318         void monitor_section_detached ();
319
320         void refiller (ARDOUR::PluginManager& manager, const ARDOUR::PluginInfoList& plugs);
321         void refill_favorite_plugins ();
322
323         /// true if we are in fullscreen mode
324         bool _maximised;
325
326         // true if mixer list is visible
327         bool _show_mixer_list;
328 };
329
330 #endif /* __ardour_mixer_ui_h__ */
331
332