first pass at the big rethink of managing sort order keys for editor and mixer. this...
[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 "enums.h"
44 #include "mixer_actor.h"
45
46 namespace ARDOUR {
47         class Route;
48         class RouteGroup;
49 };
50
51 class MixerStrip;
52 class PluginSelector;
53 class MixerGroupTabs;
54 class MonitorSection;
55
56 class Mixer_UI : public Gtk::Window, public PBD::ScopedConnectionList, public ARDOUR::SessionHandlePtr, public MixerActor
57 {
58   public:
59         static Mixer_UI* instance();
60         ~Mixer_UI();
61
62         void set_session (ARDOUR::Session *);
63         void track_editor_selection ();
64
65         PluginSelector* plugin_selector();
66
67         void  set_strip_width (Width);
68         Width get_strip_width () const { return _strip_width; }
69
70         void unselect_strip_in_display (MixerStrip*);
71         void select_strip_in_display (MixerStrip*);
72
73         XMLNode& get_state (void);
74         int set_state (const XMLNode& );
75
76         void show_window ();
77         bool hide_window (GdkEventAny *ev);
78         void show_strip (MixerStrip *);
79         void hide_strip (MixerStrip *);
80
81         void ensure_float (Gtk::Window&);
82
83         MonitorSection* monitor_section() const { return _monitor_section; }
84
85   protected:
86         void set_route_targets_for_operation ();
87
88   private:
89         Mixer_UI ();
90         static Mixer_UI* _instance;
91
92         bool                                    _visible;
93
94         Gtk::HBox                               global_hpacker;
95         Gtk::VBox                               global_vpacker;
96         Gtk::ScrolledWindow             scroller;
97         Gtk::EventBox                   scroller_base;
98         Gtk::HBox                               scroller_hpacker;
99         Gtk::VBox                               mixer_scroller_vpacker;
100         Gtk::VBox                               list_vpacker;
101         Gtk::Label                              group_display_button_label;
102         Gtk::Button                             group_display_button;
103         Gtk::ScrolledWindow             track_display_scroller;
104         Gtk::ScrolledWindow             group_display_scroller;
105         Gtk::VBox                               group_display_vbox;
106         Gtk::Frame                              track_display_frame;
107         Gtk::Frame                              group_display_frame;
108         Gtk::VPaned                             rhs_pane1;
109         Gtk::HBox                               strip_packer;
110         Gtk::HBox                               out_packer;
111         Gtk::HPaned                             list_hpane;
112
113         MixerGroupTabs* _group_tabs;
114
115         // for restoring window geometry.
116         int m_root_x, m_root_y, m_width, m_height;
117
118         void set_window_pos_and_size ();
119         void get_window_pos_and_size ();
120
121         bool on_key_press_event (GdkEventKey*);
122         bool on_key_release_event (GdkEventKey*);
123         bool on_scroll_event (GdkEventScroll*);
124
125         void pane_allocation_handler (Gtk::Allocation&, Gtk::Paned*);
126
127         std::list<MixerStrip *> strips;
128
129         bool strip_scroller_button_release (GdkEventButton*);
130         void scroll_left ();
131         void scroll_right ();
132
133         void add_strips (ARDOUR::RouteList&);
134         void remove_strip (MixerStrip *);
135
136         MixerStrip* strip_by_route (boost::shared_ptr<ARDOUR::Route>);
137
138         void hide_all_strips (bool with_select);
139         void unselect_all_strips();
140         void select_all_strips ();
141         void unselect_all_audiotrack_strips ();
142         void select_all_audiotrack_strips ();
143         void unselect_all_audiobus_strips ();
144         void select_all_audiobus_strips ();
145
146         void strip_select_op (bool audiotrack, bool select);
147         void select_strip_op (MixerStrip*, bool select);
148
149         gint start_updating ();
150         gint stop_updating ();
151
152         void session_going_away ();
153
154         sigc::connection fast_screen_update_connection;
155         void fast_update_strips ();
156
157         void track_name_changed (MixerStrip *);
158
159         void redisplay_track_list ();
160         bool no_track_list_redisplay;
161         bool track_display_button_press (GdkEventButton*);
162         void strip_width_changed ();
163
164         void track_list_delete (const Gtk::TreeModel::Path&);
165         void track_list_reorder (const Gtk::TreeModel::Path& path, const Gtk::TreeModel::iterator& iter, int* new_order);
166
167         void initial_track_display ();
168         void show_track_list_menu ();
169
170         void set_all_strips_visibility (bool yn);
171         void set_all_audio_visibility (int tracks, bool yn);
172
173         void hide_all_routes ();
174         void show_all_routes ();
175         void show_all_audiobus ();
176         void hide_all_audiobus ();
177         void show_all_audiotracks();
178         void hide_all_audiotracks ();
179
180         bool in_group_row_change;
181
182         void group_selected (gint row, gint col, GdkEvent *ev);
183         void group_unselected (gint row, gint col, GdkEvent *ev);
184         void group_display_active_clicked();
185         void new_route_group ();
186         void remove_selected_route_group ();
187         void activate_all_route_groups ();
188         void disable_all_route_groups ();
189         void add_route_group (ARDOUR::RouteGroup *);
190         void route_groups_changed ();
191         void route_group_name_edit (const std::string&, const std::string&);
192         void route_group_row_change (const Gtk::TreeModel::Path& path,const Gtk::TreeModel::iterator& iter);
193         void route_group_row_deleted (Gtk::TreeModel::Path const &);
194
195         Gtk::Menu *track_menu;
196         void track_column_click (gint);
197         void build_track_menu ();
198
199         MonitorSection* _monitor_section;
200         PluginSelector    *_plugin_selector;
201
202         void strip_property_changed (const PBD::PropertyChange&, MixerStrip *);
203         void route_group_property_changed (ARDOUR::RouteGroup *, const PBD::PropertyChange &);
204
205         /* various treeviews */
206
207         struct TrackDisplayModelColumns : public Gtk::TreeModel::ColumnRecord {
208             TrackDisplayModelColumns () {
209                     add (text);
210                     add (visible);
211                     add (route);
212                     add (strip);
213             }
214             Gtk::TreeModelColumn<bool>           visible;
215             Gtk::TreeModelColumn<std::string>  text;
216             Gtk::TreeModelColumn<boost::shared_ptr<ARDOUR::Route> > route;
217             Gtk::TreeModelColumn<MixerStrip*>    strip;
218         };
219
220         struct GroupDisplayModelColumns : public Gtk::TreeModel::ColumnRecord {
221             GroupDisplayModelColumns() {
222                     add (visible);
223                     add (text);
224                     add (group);
225             }
226             Gtk::TreeModelColumn<bool>                                  visible;
227             Gtk::TreeModelColumn<std::string>                   text;
228             Gtk::TreeModelColumn<ARDOUR::RouteGroup*>   group;
229         };
230
231         TrackDisplayModelColumns    track_columns;
232         GroupDisplayModelColumns    group_columns;
233
234         Gtk::TreeView track_display;
235         Gtk::TreeView group_display;
236
237         Glib::RefPtr<Gtk::ListStore> track_model;
238         Glib::RefPtr<Gtk::ListStore> group_model;
239
240         bool group_display_button_press (GdkEventButton*);
241         void group_display_selection_changed ();
242
243         bool strip_button_release_event (GdkEventButton*, MixerStrip*);
244
245         Width _strip_width;
246
247         void sync_order_keys_from_model ();
248         void sync_model_from_order_keys (ARDOUR::RouteSortOrderKey);
249         bool ignore_reorder;
250
251         void parameter_changed (std::string const &);
252         void set_route_group_activation (ARDOUR::RouteGroup *, bool);
253
254         void setup_track_display ();
255         void new_track_or_bus ();
256
257         static const int32_t default_width = 478;
258         static const int32_t default_height = 765;
259
260         /** true if we are rebuilding the route group list, or clearing
261             it during a session teardown.
262         */
263         bool _in_group_rebuild_or_clear;
264
265         void update_title ();
266         MixerStrip* strip_by_x (int x);
267
268         friend class MixerGroupTabs;
269
270         void follow_editor_selection ();
271         bool _following_editor_selection;
272
273         void monitor_section_going_away ();
274 };
275
276 #endif /* __ardour_mixer_ui_h__ */
277
278