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