expose Pango::Layout member of ArdourButton; set ellipsizing behaviour for mixer...
[ardour.git] / gtk2_ardour / mixer_strip.h
1 /*
2     Copyright (C) 2000-2006 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 #ifndef __ardour_mixer_strip__
20 #define __ardour_mixer_strip__
21
22 #include <vector>
23
24 #include <cmath>
25
26 #include <gtkmm/eventbox.h>
27 #include <gtkmm/button.h>
28 #include <gtkmm/box.h>
29 #include <gtkmm/frame.h>
30 #include <gtkmm/button.h>
31 #include <gtkmm/label.h>
32 #include <gtkmm/togglebutton.h>
33 #include <gtkmm/menu.h>
34 #include <gtkmm/textview.h>
35 #include <gtkmm/adjustment.h>
36
37 #include "gtkmm2ext/auto_spin.h"
38 #include "gtkmm2ext/click_box.h"
39 #include "gtkmm2ext/bindable_button.h"
40 #include "gtkmm2ext/stateful_button.h"
41
42 #include "pbd/stateful.h"
43
44 #include "ardour/types.h"
45 #include "ardour/ardour.h"
46 #include "ardour/processor.h"
47
48 #include "pbd/fastlog.h"
49
50 #include "route_ui.h"
51 #include "gain_meter.h"
52 #include "panner_ui.h"
53 #include "enums.h"
54 #include "processor_box.h"
55 #include "visibility_group.h"
56
57 namespace ARDOUR {
58         class Route;
59         class Send;
60         class Processor;
61         class Session;
62         class PortInsert;
63         class Bundle;
64         class Plugin;
65 }
66 namespace Gtk {
67         class Window;
68         class Style;
69 }
70
71 class Mixer_UI;
72 class IOSelectorWindow;
73 class MotionController;
74 class RouteGroupMenu;
75 class ArdourWindow;
76
77 class MixerStrip : public RouteUI, public Gtk::EventBox
78 {
79   public:
80         MixerStrip (Mixer_UI&, ARDOUR::Session*, boost::shared_ptr<ARDOUR::Route>, bool in_mixer = true);
81         MixerStrip (Mixer_UI&, ARDOUR::Session*, bool in_mixer = true);
82         ~MixerStrip ();
83
84         void set_width_enum (Width, void* owner);
85         Width get_width_enum () const { return _width; }
86         void* width_owner () const { return _width_owner; }
87
88         GainMeter&      gain_meter()      { return gpm; }
89         PannerUI&       panner_ui()       { return panners; }
90         PluginSelector* plugin_selector();
91
92         void fast_update ();
93         void set_embedded (bool);
94
95         void set_route (boost::shared_ptr<ARDOUR::Route>);
96         void set_button_names ();
97         void show_send (boost::shared_ptr<ARDOUR::Send>);
98         void revert_to_default_display ();
99
100         /** @return the delivery that is being edited using our fader; it will be the
101          *  last send passed to ::show_send, or our route's main out delivery.
102          */
103         boost::shared_ptr<ARDOUR::Delivery> current_delivery () const {
104                 return _current_delivery;
105         }
106
107         bool mixer_owned () const {
108                 return _mixer_owned;
109         }
110
111         void hide_things ();
112
113         sigc::signal<void> WidthChanged;
114
115         /** The delivery that we are handling the level for with our fader has changed */
116         PBD::Signal1<void, boost::weak_ptr<ARDOUR::Delivery> > DeliveryChanged;
117
118         static PBD::Signal1<void,MixerStrip*> CatchDeletion;
119
120         std::string state_id() const;
121
122         void parameter_changed (std::string);
123         void route_active_changed ();
124
125         void copy_processors ();
126         void cut_processors ();
127         void paste_processors ();
128         void select_all_processors ();
129         void delete_processors ();
130         void toggle_processors ();
131         void ab_plugins ();
132
133   protected:
134         friend class Mixer_UI;
135         void set_packed (bool yn);
136         bool packed () { return _packed; }
137
138         void set_selected(bool yn);
139         void set_stuff_from_route ();
140
141   private:
142         Mixer_UI& _mixer;
143
144         void init ();
145
146         bool  _embedded;
147         bool  _packed;
148         bool  _mixer_owned;
149         Width _width;
150         void*  _width_owner;
151
152         ArdourButton         hide_button;
153         ArdourButton         width_button;
154         Gtk::HBox           width_hide_box;
155         Gtk::VBox           whvbox;
156         Gtk::EventBox       top_event_box;
157         Gtk::EventBox*      spacer;
158
159         void hide_clicked();
160         bool width_button_pressed (GdkEventButton *);
161
162         Gtk::Frame          global_frame;
163         Gtk::VBox           global_vpacker;
164
165         ProcessorBox processor_box;
166         GainMeter    gpm;
167         PannerUI     panners;
168
169         Glib::RefPtr<Gtk::SizeGroup> button_size_group;
170
171         Gtk::Table button_table;
172         Gtk::Table rec_solo_table;
173         Gtk::Table top_button_table;
174         Gtk::Table middle_button_table;
175         Gtk::Table bottom_button_table;
176
177         ArdourButton                 meter_point_button;
178
179         void meter_changed ();
180
181         ArdourButton input_button;
182         ArdourButton output_button;
183
184         ArdourButton* midi_input_enable_button;
185         Gtk::HBox   input_button_box;
186
187         std::string longest_label;
188
189         void midi_input_status_changed ();
190         bool input_active_button_press (GdkEventButton*);
191         bool input_active_button_release (GdkEventButton*);
192
193         gint    mark_update_safe ();
194         guint32 mode_switch_in_progress;
195
196         ArdourButton   name_button;
197
198         ArdourWindow*  comment_window;
199         Gtk::TextView* comment_area;
200         ArdourButton   _comment_button;
201
202         void comment_editor_done_editing ();
203         void setup_comment_editor ();
204         void open_comment_editor ();
205         void toggle_comment_editor ();
206         void setup_comment_button ();
207
208         ArdourButton   group_button;
209         RouteGroupMenu *group_menu;
210
211         gint input_press (GdkEventButton *);
212         gint output_press (GdkEventButton *);
213
214         Gtk::Menu input_menu;
215         std::list<boost::shared_ptr<ARDOUR::Bundle> > input_menu_bundles;
216         void maybe_add_bundle_to_input_menu (boost::shared_ptr<ARDOUR::Bundle>, ARDOUR::BundleList const &);
217
218         Gtk::Menu output_menu;
219         std::list<boost::shared_ptr<ARDOUR::Bundle> > output_menu_bundles;
220         void maybe_add_bundle_to_output_menu (boost::shared_ptr<ARDOUR::Bundle>, ARDOUR::BundleList const &);
221
222         void bundle_input_toggled (boost::shared_ptr<ARDOUR::Bundle>);
223         void bundle_output_toggled (boost::shared_ptr<ARDOUR::Bundle>);
224
225         void edit_input_configuration ();
226         void edit_output_configuration ();
227
228         void diskstream_changed ();
229
230         Gtk::Menu *send_action_menu;
231         Gtk::MenuItem* rename_menu_item;
232         void build_send_action_menu ();
233
234         void new_send ();
235         void show_send_controls ();
236
237         PBD::ScopedConnection panstate_connection;
238         PBD::ScopedConnection panstyle_connection;
239         void connect_to_pan ();
240
241         void update_diskstream_display ();
242         void update_input_display ();
243         void update_output_display ();
244
245         void set_automated_controls_sensitivity (bool yn);
246
247         Gtk::Menu* route_ops_menu;
248         void build_route_ops_menu ();
249         gboolean name_button_button_press (GdkEventButton*);
250         void list_route_operations ();
251
252         gint comment_key_release_handler (GdkEventKey*);
253         void comment_changed (void *src);
254         void comment_edited ();
255         bool ignore_comment_edit;
256
257         bool select_route_group (GdkEventButton *);
258         void route_group_changed ();
259
260         IOSelectorWindow *input_selector;
261         IOSelectorWindow *output_selector;
262
263         Gtk::Style *passthru_style;
264
265         void route_color_changed ();
266         void show_passthru_color ();
267
268         void property_changed (const PBD::PropertyChange&);
269         void name_button_resized (Gtk::Allocation&);
270         void name_changed ();
271         void update_speed_display ();
272         void map_frozen ();
273         void hide_processor_editor (boost::weak_ptr<ARDOUR::Processor> processor);
274         void hide_redirect_editors ();
275
276         bool ignore_speed_adjustment;
277
278         void engine_running();
279         void engine_stopped();
280
281         virtual void bus_send_display_changed (boost::shared_ptr<ARDOUR::Route>);
282
283         void set_current_delivery (boost::shared_ptr<ARDOUR::Delivery>);
284         boost::shared_ptr<ARDOUR::Delivery> _current_delivery;
285
286         void drop_send ();
287         PBD::ScopedConnection send_gone_connection;
288
289         void reset_strip_style ();
290
291         static int scrollbar_height;
292
293         void update_io_button (boost::shared_ptr<ARDOUR::Route> route, Width width, bool input_button);
294         void port_connected_or_disconnected (boost::weak_ptr<ARDOUR::Port>, boost::weak_ptr<ARDOUR::Port>);
295
296         /** A VisibilityGroup to manage the visibility of some of our controls.
297          *  We fill it with the controls that are being managed, using the same names
298          *  as those used with _mixer_strip_visibility in RCOptionEditor.  Then
299          *  this VisibilityGroup is configured by changes to the RC variable
300          *  mixer-strip-visibility, which happen when the user makes changes in
301          *  the RC option editor.
302          */
303         VisibilityGroup _visibility;
304         boost::optional<bool> override_solo_visibility () const;
305
306         PBD::ScopedConnection _config_connection;
307
308         void add_input_port (ARDOUR::DataType);
309         void add_output_port (ARDOUR::DataType);
310
311         bool level_meter_button_press (GdkEventButton *);
312         void popup_level_meter_menu (GdkEventButton *);
313         void add_level_meter_item (Gtk::Menu_Helpers::MenuList &, Gtk::RadioMenuItem::Group &, std::string const &, ARDOUR::MeterPoint);
314         void set_meter_point (ARDOUR::MeterPoint);
315         PBD::ScopedConnection _level_meter_connection;
316
317         static std::string meter_point_string (ARDOUR::MeterPoint);
318 };
319
320 #endif /* __ardour_mixer_strip__ */