Add EngineControl::stop_engine method to show errors when stopping engine
[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 "ardour_knob.h"
51 #include "route_ui.h"
52 #include "gain_meter.h"
53 #include "panner_ui.h"
54 #include "enums.h"
55 #include "processor_box.h"
56 #include "visibility_group.h"
57
58 namespace ARDOUR {
59         class Route;
60         class Send;
61         class Processor;
62         class Session;
63         class PortInsert;
64         class Bundle;
65         class Plugin;
66 }
67 namespace Gtk {
68         class Window;
69         class Style;
70 }
71
72 class Mixer_UI;
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 deselect_all_processors ();
130         bool delete_processors ();  //note: returns false if nothing was deleted
131         void toggle_processors ();
132         void ab_plugins ();
133
134         void set_selected(bool yn);
135         bool is_selected() {return _selected;}
136
137         static MixerStrip* entered_mixer_strip() { return _entered_mixer_strip; }
138
139   protected:
140         friend class Mixer_UI;
141         void set_packed (bool yn);
142         bool packed () { return _packed; }
143
144         void set_stuff_from_route ();
145
146   private:
147         Mixer_UI& _mixer;
148
149         void init ();
150
151         bool  _embedded;
152         bool  _packed;
153         bool  _mixer_owned;
154         Width _width;
155         void*  _width_owner;
156
157         ArdourButton         hide_button;
158         ArdourButton         width_button;
159         ArdourButton         number_label;
160         Gtk::HBox           width_hide_box;
161         Gtk::EventBox*      spacer;
162
163         void hide_clicked();
164         bool width_button_pressed (GdkEventButton *);
165
166         Gtk::Frame          global_frame;
167         Gtk::VBox           global_vpacker;
168
169         ProcessorBox processor_box;
170         GainMeter    gpm;
171         PannerUI     panners;
172
173         Glib::RefPtr<Gtk::SizeGroup> button_size_group;
174
175         Gtk::Table rec_mon_table;
176         Gtk::Table solo_iso_table;
177         Gtk::Table mute_solo_table;
178         Gtk::Table bottom_button_table;
179
180         ArdourButton                 meter_point_button;
181
182         void meter_changed ();
183
184         ArdourButton input_button;
185         ArdourButton output_button;
186
187         void input_button_resized (Gtk::Allocation&);
188         void output_button_resized (Gtk::Allocation&);
189
190         ArdourButton* midi_input_enable_button;
191         Gtk::HBox   input_button_box;
192
193         std::string longest_label;
194
195         void midi_input_status_changed ();
196         bool input_active_button_press (GdkEventButton*);
197         bool input_active_button_release (GdkEventButton*);
198
199         gint    mark_update_safe ();
200         guint32 mode_switch_in_progress;
201
202         ArdourButton   name_button;
203
204         ArdourButton   _comment_button;
205
206         ArdourKnob     trim_control;
207
208         void setup_comment_button ();
209
210         ArdourButton   group_button;
211         RouteGroupMenu *group_menu;
212
213         gint input_press (GdkEventButton *);
214         gint input_release (GdkEventButton *);
215
216         gint output_press (GdkEventButton *);
217         gint output_release (GdkEventButton *);
218
219         Gtk::Menu input_menu;
220         std::list<boost::shared_ptr<ARDOUR::Bundle> > input_menu_bundles;
221         void maybe_add_bundle_to_input_menu (boost::shared_ptr<ARDOUR::Bundle>, ARDOUR::BundleList const &);
222
223         Gtk::Menu output_menu;
224         std::list<boost::shared_ptr<ARDOUR::Bundle> > output_menu_bundles;
225         void maybe_add_bundle_to_output_menu (boost::shared_ptr<ARDOUR::Bundle>, ARDOUR::BundleList const &);
226
227         void bundle_input_chosen (boost::shared_ptr<ARDOUR::Bundle>);
228         void bundle_output_chosen (boost::shared_ptr<ARDOUR::Bundle>);
229
230         void diskstream_changed ();
231         void io_changed_proxy ();
232
233         Gtk::Menu *send_action_menu;
234         Gtk::MenuItem* rename_menu_item;
235         void build_send_action_menu ();
236
237         void new_send ();
238         void show_send_controls ();
239
240         PBD::ScopedConnection panstate_connection;
241         PBD::ScopedConnection panstyle_connection;
242         void connect_to_pan ();
243         void update_panner_choices ();
244
245         void update_diskstream_display ();
246         void update_input_display ();
247         void update_output_display ();
248
249         void set_automated_controls_sensitivity (bool yn);
250
251         Gtk::Menu* route_ops_menu;
252         void build_route_ops_menu ();
253         gboolean name_button_button_press (GdkEventButton*);
254         gboolean name_button_button_release (GdkEventButton*);
255         gboolean number_button_button_press (GdkEventButton*);
256         void list_route_operations ();
257
258         bool select_route_group (GdkEventButton *);
259         void route_group_changed ();
260
261         Gtk::Style *passthru_style;
262
263         void route_color_changed ();
264         void show_passthru_color ();
265
266         void property_changed (const PBD::PropertyChange&);
267         void name_button_resized (Gtk::Allocation&);
268         void name_changed ();
269         void update_speed_display ();
270         void map_frozen ();
271         void hide_processor_editor (boost::weak_ptr<ARDOUR::Processor> processor);
272         void hide_redirect_editors ();
273
274         bool ignore_speed_adjustment;
275
276         static MixerStrip* _entered_mixer_strip;
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
285         void drop_send ();
286         PBD::ScopedConnection send_gone_connection;
287
288         void reset_strip_style ();
289
290         void update_io_button (boost::shared_ptr<ARDOUR::Route> route, Width width, bool input_button);
291         void port_connected_or_disconnected (boost::weak_ptr<ARDOUR::Port>, boost::weak_ptr<ARDOUR::Port>);
292
293         bool mixer_strip_enter_event ( GdkEventCrossing * );
294         bool mixer_strip_leave_event ( GdkEventCrossing * );
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-element-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::ScopedConnectionList _config_connection;
307
308         void add_input_port (ARDOUR::DataType);
309         void add_output_port (ARDOUR::DataType);
310
311         bool _suspend_menu_callbacks;
312         bool level_meter_button_press (GdkEventButton *);
313         void popup_level_meter_menu (GdkEventButton *);
314         void add_level_meter_item_point (Gtk::Menu_Helpers::MenuList &, Gtk::RadioMenuItem::Group &, std::string const &, ARDOUR::MeterPoint);
315         void add_level_meter_item_type (Gtk::Menu_Helpers::MenuList &, Gtk::RadioMenuItem::Group &, std::string const &, ARDOUR::MeterType);
316         void set_meter_point (ARDOUR::MeterPoint);
317         void set_meter_type (ARDOUR::MeterType);
318         PBD::ScopedConnection _level_meter_connection;
319
320         std::string meter_point_string (ARDOUR::MeterPoint);
321 };
322
323 #endif /* __ardour_mixer_strip__ */