2 Copyright (C) 2004 Paul Davis
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.
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.
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.
20 #ifndef __ardour_gtk_processor_box__
21 #define __ardour_gtk_processor_box__
26 #include <boost/function.hpp>
28 #include <gtkmm/box.h>
29 #include <gtkmm/eventbox.h>
30 #include <gtkmm/menu.h>
31 #include <gtkmm/scrolledwindow.h>
32 #include "gtkmm2ext/dndtreeview.h"
33 #include "gtkmm2ext/auto_spin.h"
34 #include "gtkmm2ext/click_box.h"
35 #include "gtkmm2ext/dndvbox.h"
36 #include "gtkmm2ext/pixfader.h"
38 #include "pbd/stateful.h"
39 #include "pbd/signals.h"
41 #include "ardour/types.h"
42 #include "ardour/ardour.h"
43 #include "ardour/plugin_insert.h"
44 #include "ardour/port_insert.h"
45 #include "ardour/processor.h"
46 #include "ardour/route.h"
47 #include "ardour/session_handle.h"
49 #include "pbd/fastlog.h"
51 #include "plugin_interest.h"
52 #include "io_selector.h"
55 #include "window_proxy.h"
57 class MotionController;
60 class RouteRedirectSelection;
77 /** A WindowProxy for Processor UI windows; it knows how to ask a ProcessorBox
78 * to create a UI window for a particular processor.
80 class ProcessorWindowProxy : public WindowProxy<Gtk::Window>
83 ProcessorWindowProxy (std::string const &, XMLNode const *, ProcessorBox *, boost::weak_ptr<ARDOUR::Processor>);
86 bool rc_configured () const {
90 boost::weak_ptr<ARDOUR::Processor> processor () const {
97 ProcessorBox* _processor_box;
98 boost::weak_ptr<ARDOUR::Processor> _processor;
101 class ProcessorEntry : public Gtkmm2ext::DnDVBoxChild, public sigc::trackable
104 ProcessorEntry (boost::shared_ptr<ARDOUR::Processor>, Width);
106 Gtk::EventBox& action_widget ();
107 Gtk::Widget& widget ();
108 std::string drag_text () const;
109 void set_visual_state (Gtk::StateType);
117 void set_position (Position);
118 boost::shared_ptr<ARDOUR::Processor> processor () const;
119 void set_enum_width (Width);
120 virtual void set_pixel_width (int) {}
122 /** Hide any widgets that should be hidden */
123 virtual void hide_things () {}
127 virtual void setup_visuals ();
134 void active_toggled ();
135 void processor_active_changed ();
136 void processor_property_changed (const PBD::PropertyChange&);
137 std::string name () const;
140 Gtk::EventBox _event_box;
143 Gtk::CheckButton _active;
144 boost::shared_ptr<ARDOUR::Processor> _processor;
146 Gtk::StateType _visual_state;
147 PBD::ScopedConnection active_connection;
148 PBD::ScopedConnection name_connection;
151 class SendProcessorEntry : public ProcessorEntry
154 SendProcessorEntry (boost::shared_ptr<ARDOUR::Send>, Width);
156 static void setup_slider_pix ();
158 void set_enum_width (Width, int);
159 void set_pixel_width (int);
163 void gain_adjusted ();
164 void setup_gain_adjustment ();
166 boost::shared_ptr<ARDOUR::Send> _send;
167 Gtk::Adjustment _adjustment;
168 Gtkmm2ext::HSliderController _fader;
169 bool _ignore_gain_change;
170 PBD::ScopedConnectionList _send_connections;
171 ARDOUR::DataType _data_type;
173 static Glib::RefPtr<Gdk::Pixbuf> _slider;
176 class PluginInsertProcessorEntry : public ProcessorEntry
179 PluginInsertProcessorEntry (boost::shared_ptr<ARDOUR::PluginInsert>, Width);
184 void setup_visuals ();
185 void plugin_insert_splitting_changed ();
187 /* XXX: this seems a little ridiculous just for a simple scaleable icon */
188 class SplittingIcon : public Gtk::DrawingArea {
190 bool on_expose_event (GdkEventExpose *);
193 boost::shared_ptr<ARDOUR::PluginInsert> _plugin_insert;
194 SplittingIcon _splitting_icon;
195 PBD::ScopedConnection _splitting_connection;
198 class ProcessorBox : public Gtk::HBox, public PluginInterestedObject, public ARDOUR::SessionHandlePtr
201 ProcessorBox (ARDOUR::Session*, boost::function<PluginSelector*()> get_plugin_selector,
202 RouteRedirectSelection&, MixerStrip* parent, bool owner_is_mixer = false);
205 void set_route (boost::shared_ptr<ARDOUR::Route>);
206 void set_width (Width);
210 void select_all_processors ();
211 void deselect_all_processors ();
212 void select_all_plugins ();
213 void select_all_inserts ();
214 void select_all_sends ();
218 Gtk::Window* get_processor_ui (boost::shared_ptr<ARDOUR::Processor>) const;
219 void toggle_edit_processor (boost::shared_ptr<ARDOUR::Processor>);
220 void toggle_processor_controls (boost::shared_ptr<ARDOUR::Processor>);
222 sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorSelected;
223 sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorUnselected;
225 static void register_actions();
229 /* prevent copy construction */
230 ProcessorBox (ProcessorBox const &);
232 boost::shared_ptr<ARDOUR::Route> _route;
233 MixerStrip* _parent_strip; // null if in RouteParamsUI
234 bool _owner_is_mixer;
236 PBD::ScopedConnectionList _mixer_strip_connections;
237 PBD::ScopedConnectionList _route_connections;
239 boost::function<PluginSelector*()> _get_plugin_selector;
241 boost::shared_ptr<ARDOUR::Processor> _processor_being_created;
243 ARDOUR::Placement _placement;
245 RouteRedirectSelection& _rr_selection;
247 void route_going_away ();
249 void selection_changed ();
251 Gtkmm2ext::DnDVBox<ProcessorEntry> processor_display;
252 Gtk::ScrolledWindow processor_scroller;
254 void object_drop (Gtkmm2ext::DnDVBox<ProcessorEntry> *, ProcessorEntry *, Glib::RefPtr<Gdk::DragContext> const &);
258 Gtk::Menu *send_action_menu;
259 void build_send_action_menu ();
262 void show_send_controls ();
264 Gtk::Menu *processor_menu;
265 gint processor_menu_map_handler (GdkEventAny *ev);
266 Gtk::Menu * build_processor_menu ();
267 void build_processor_tooltip (Gtk::EventBox&, std::string);
268 void show_processor_menu (gint arg);
269 Gtk::Menu* build_possible_aux_menu();
271 void choose_aux (boost::weak_ptr<ARDOUR::Route>);
273 void send_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
274 void return_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
275 void choose_insert ();
276 void choose_plugin ();
277 bool use_plugins (const SelectedPlugins&);
279 bool no_processor_redisplay;
281 bool enter_notify (GdkEventCrossing *ev);
282 bool leave_notify (GdkEventCrossing *ev);
283 bool processor_key_press_event (GdkEventKey *);
284 bool processor_key_release_event (GdkEventKey *);
285 bool processor_button_press_event (GdkEventButton *, ProcessorEntry *);
286 bool processor_button_release_event (GdkEventButton *, ProcessorEntry *);
287 void redisplay_processors ();
288 void add_processor_to_display (boost::weak_ptr<ARDOUR::Processor>);
290 void report_failed_reorder ();
291 void route_processors_changed (ARDOUR::RouteProcessorChange);
293 void processors_reordered (const Gtk::TreeModel::Path&, const Gtk::TreeModel::iterator&, int*);
294 void compute_processor_sort_keys ();
296 void all_processors_active(bool state);
297 void all_plugins_active(bool state);
300 typedef std::vector<boost::shared_ptr<ARDOUR::Processor> > ProcSelection;
302 void cut_processors (const ProcSelection&);
303 void cut_processors ();
304 void copy_processors (const ProcSelection&);
305 void copy_processors ();
306 void delete_processors (const ProcSelection&);
307 void delete_processors ();
308 void paste_processors ();
309 void paste_processors (boost::shared_ptr<ARDOUR::Processor> before);
311 void delete_dragged_processors (const std::list<boost::shared_ptr<ARDOUR::Processor> >&);
312 void clear_processors ();
313 void clear_processors (ARDOUR::Placement);
314 void rename_processors ();
316 void for_selected_processors (void (ProcessorBox::*pmf)(boost::shared_ptr<ARDOUR::Processor>));
317 void get_selected_processors (ProcSelection&) const;
319 bool can_cut() const;
321 static Glib::RefPtr<Gtk::Action> cut_action;
322 static Glib::RefPtr<Gtk::Action> paste_action;
323 static Glib::RefPtr<Gtk::Action> rename_action;
324 static Glib::RefPtr<Gtk::Action> edit_action;
325 static Glib::RefPtr<Gtk::Action> controls_action;
326 void paste_processor_state (const XMLNodeList&, boost::shared_ptr<ARDOUR::Processor>);
328 void activate_processor (boost::shared_ptr<ARDOUR::Processor>);
329 void deactivate_processor (boost::shared_ptr<ARDOUR::Processor>);
330 void hide_processor_editor (boost::shared_ptr<ARDOUR::Processor>);
331 void rename_processor (boost::shared_ptr<ARDOUR::Processor>);
333 gint idle_delete_processor (boost::weak_ptr<ARDOUR::Processor>);
335 void weird_plugin_dialog (ARDOUR::Plugin& p, ARDOUR::Route::ProcessorStreams streams);
336 void on_size_allocate (Gtk::Allocation &);
338 void setup_entry_positions ();
340 static ProcessorBox* _current_processor_box;
342 static void rb_choose_aux (boost::weak_ptr<ARDOUR::Route>);
343 static void rb_choose_plugin ();
344 static void rb_choose_insert ();
345 static void rb_choose_send ();
346 static void rb_clear ();
347 static void rb_clear_pre ();
348 static void rb_clear_post ();
349 static void rb_cut ();
350 static void rb_copy ();
351 static void rb_paste ();
352 static void rb_delete ();
353 static void rb_rename ();
354 static void rb_select_all ();
355 static void rb_deselect_all ();
356 static void rb_activate_all ();
357 static void rb_deactivate_all ();
358 static void rb_ab_plugins ();
359 static void rb_edit ();
360 static void rb_controls ();
362 void route_property_changed (const PBD::PropertyChange&);
363 std::string generate_processor_title (boost::shared_ptr<ARDOUR::PluginInsert> pi);
365 std::list<ProcessorWindowProxy*> _processor_window_proxies;
366 void set_processor_ui (boost::shared_ptr<ARDOUR::Processor>, Gtk::Window *);
367 void maybe_add_processor_to_ui_list (boost::weak_ptr<ARDOUR::Processor>);
369 bool one_processor_can_be_edited ();
370 bool processor_can_be_edited (boost::shared_ptr<ARDOUR::Processor>);
372 void mixer_strip_delivery_changed (boost::weak_ptr<ARDOUR::Delivery>);
375 #endif /* __ardour_gtk_processor_box__ */