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"
37 #include "gtkmm2ext/persistent_tooltip.h"
39 #include "pbd/stateful.h"
40 #include "pbd/signals.h"
42 #include "ardour/types.h"
43 #include "ardour/ardour.h"
44 #include "ardour/plugin_insert.h"
45 #include "ardour/port_insert.h"
46 #include "ardour/processor.h"
47 #include "ardour/route.h"
48 #include "ardour/session_handle.h"
50 #include "pbd/fastlog.h"
52 #include "plugin_interest.h"
53 #include "io_selector.h"
56 #include "ardour_button.h"
57 #include "window_manager.h"
59 class MotionController;
62 class RouteProcessorSelection;
78 class ProcessorWindowProxy : public WM::ProxyBase
81 ProcessorWindowProxy (std::string const &, ProcessorBox *, boost::weak_ptr<ARDOUR::Processor>);
82 ~ProcessorWindowProxy();
84 Gtk::Window* get (bool create = false);
86 boost::weak_ptr<ARDOUR::Processor> processor () const {
90 ARDOUR::SessionHandlePtr* session_handle();
92 void set_custom_ui_mode(bool use_custom) { want_custom = use_custom; }
97 void set_state (const XMLNode&);
98 XMLNode& get_state () const;
101 ProcessorBox* _processor_box;
102 boost::weak_ptr<ARDOUR::Processor> _processor;
107 void processor_going_away ();
108 PBD::ScopedConnection going_away_connection;
111 class ProcessorEntry : public Gtkmm2ext::DnDVBoxChild, public sigc::trackable
114 ProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::Processor>, Width);
117 Gtk::EventBox& action_widget ();
118 Gtk::Widget& widget ();
119 std::string drag_text () const;
120 void set_visual_state (Gtkmm2ext::VisualState, bool);
128 void set_position (Position);
129 boost::shared_ptr<ARDOUR::Processor> processor () const;
130 void set_enum_width (Width);
132 /** Hide any widgets that should be hidden */
133 virtual void hide_things ();
135 void show_all_controls ();
136 void hide_all_controls ();
137 void add_control_state (XMLNode *) const;
138 void set_control_state (XMLNode const *);
139 std::string state_id () const;
140 Gtk::Menu* build_controls_menu ();
143 ArdourButton _button;
147 virtual void setup_visuals ();
151 void processor_active_changed ();
152 void processor_property_changed (const PBD::PropertyChange&);
153 std::string name (Width) const;
154 void setup_tooltip ();
156 ProcessorBox* _parent;
157 boost::shared_ptr<ARDOUR::Processor> _processor;
159 Gtk::StateType _visual_state;
160 PBD::ScopedConnection active_connection;
161 PBD::ScopedConnection name_connection;
163 class Control : public sigc::trackable {
165 Control (boost::shared_ptr<ARDOUR::AutomationControl>, std::string const &);
167 void set_visible (bool);
168 void add_state (XMLNode *) const;
169 void set_state (XMLNode const *);
173 bool visible () const {
177 std::string name () const {
184 void slider_adjusted ();
185 void button_clicked ();
186 void control_changed ();
187 std::string state_id () const;
190 boost::weak_ptr<ARDOUR::AutomationControl> _control;
191 /* things for a slider */
192 Gtk::Adjustment _adjustment;
193 Gtkmm2ext::HSliderController _slider;
195 Gtkmm2ext::PersistentTooltip _slider_persistant_tooltip;
196 /* things for a button */
197 ArdourButton _button;
198 bool _ignore_ui_adjustment;
199 PBD::ScopedConnection _connection;
204 std::list<Control*> _controls;
206 void toggle_control_visibility (Control *);
209 class BlankProcessorEntry : public ProcessorEntry
212 BlankProcessorEntry (ProcessorBox *, Width w);
215 class PluginInsertProcessorEntry : public ProcessorEntry
218 PluginInsertProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::PluginInsert>, Width);
223 void setup_visuals ();
224 void plugin_insert_splitting_changed ();
226 class SplittingIcon : public Gtk::DrawingArea {
228 SplittingIcon() { _branches = 2; }
229 void set_branches(uint32_t const branches) { _branches = branches; }
231 bool on_expose_event (GdkEventExpose *);
235 boost::shared_ptr<ARDOUR::PluginInsert> _plugin_insert;
236 SplittingIcon _splitting_icon;
237 PBD::ScopedConnection _splitting_connection;
240 class ProcessorBox : public Gtk::HBox, public PluginInterestedObject, public ARDOUR::SessionHandlePtr
243 enum ProcessorOperation {
249 ProcessorsToggleActive,
253 ProcessorBox (ARDOUR::Session*, boost::function<PluginSelector*()> get_plugin_selector,
254 RouteProcessorSelection&, MixerStrip* parent, bool owner_is_mixer = false);
257 void set_route (boost::shared_ptr<ARDOUR::Route>);
258 void set_width (Width);
260 void processor_operation (ProcessorOperation);
262 void select_all_processors ();
263 void deselect_all_processors ();
264 void select_all_plugins ();
265 void select_all_inserts ();
266 void select_all_sends ();
270 bool edit_aux_send(boost::shared_ptr<ARDOUR::Processor>);
272 /* Everything except a WindowProxy object should use this to get the window */
273 Gtk::Window* get_processor_ui (boost::shared_ptr<ARDOUR::Processor>) const;
275 /* a WindowProxy object can use this */
276 Gtk::Window* get_editor_window (boost::shared_ptr<ARDOUR::Processor>, bool);
277 Gtk::Window* get_generic_editor_window (boost::shared_ptr<ARDOUR::Processor>);
279 void edit_processor (boost::shared_ptr<ARDOUR::Processor>);
280 void generic_edit_processor (boost::shared_ptr<ARDOUR::Processor>);
282 void update_gui_object_state (ProcessorEntry *);
284 sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorSelected;
285 sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorUnselected;
287 static void register_actions();
291 /* prevent copy construction */
292 ProcessorBox (ProcessorBox const &);
294 boost::shared_ptr<ARDOUR::Route> _route;
295 MixerStrip* _parent_strip; // null if in RouteParamsUI
296 bool _owner_is_mixer;
298 PBD::ScopedConnectionList _mixer_strip_connections;
299 PBD::ScopedConnectionList _route_connections;
301 boost::function<PluginSelector*()> _get_plugin_selector;
303 boost::shared_ptr<ARDOUR::Processor> _processor_being_created;
305 /** Index at which to place a new plugin (based on where the menu was opened), or -1 to
306 * put at the end of the plugin list.
309 uint32_t _visible_prefader_processors;
311 RouteProcessorSelection& _rr_selection;
313 void route_going_away ();
315 bool is_editor_mixer_strip() const;
317 Gtkmm2ext::DnDVBox<ProcessorEntry> processor_display;
318 Gtk::ScrolledWindow processor_scroller;
320 void object_drop (Gtkmm2ext::DnDVBox<ProcessorEntry> *, ProcessorEntry *, Glib::RefPtr<Gdk::DragContext> const &);
323 bool _redisplay_pending;
325 Gtk::Menu *processor_menu;
326 gint processor_menu_map_handler (GdkEventAny *ev);
327 Gtk::Menu * build_processor_menu ();
328 void show_processor_menu (int);
329 Gtk::Menu* build_possible_aux_menu();
331 void choose_aux (boost::weak_ptr<ARDOUR::Route>);
333 void send_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
334 void return_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
335 void choose_insert ();
336 void choose_plugin ();
337 bool use_plugins (const SelectedPlugins&);
339 bool no_processor_redisplay;
341 bool enter_notify (GdkEventCrossing *ev);
342 bool leave_notify (GdkEventCrossing *ev);
343 bool processor_button_press_event (GdkEventButton *, ProcessorEntry *);
344 bool processor_button_release_event (GdkEventButton *, ProcessorEntry *);
345 void redisplay_processors ();
346 void add_processor_to_display (boost::weak_ptr<ARDOUR::Processor>);
347 void help_count_visible_prefader_processors (boost::weak_ptr<ARDOUR::Processor>, uint32_t*, bool*);
349 void report_failed_reorder ();
350 void route_processors_changed (ARDOUR::RouteProcessorChange);
351 void processor_menu_unmapped ();
353 void processors_reordered (const Gtk::TreeModel::Path&, const Gtk::TreeModel::iterator&, int*);
354 void compute_processor_sort_keys ();
356 void all_visible_processors_active(bool state);
359 typedef std::vector<boost::shared_ptr<ARDOUR::Processor> > ProcSelection;
361 void cut_processors (const ProcSelection&);
362 void copy_processors (const ProcSelection&);
363 void delete_processors (const ProcSelection&);
364 void paste_processors ();
365 void paste_processors (boost::shared_ptr<ARDOUR::Processor> before);
367 void delete_dragged_processors (const std::list<boost::shared_ptr<ARDOUR::Processor> >&);
368 void clear_processors ();
369 void clear_processors (ARDOUR::Placement);
370 void rename_processors ();
372 void for_selected_processors (void (ProcessorBox::*pmf)(boost::shared_ptr<ARDOUR::Processor>));
373 void get_selected_processors (ProcSelection&) const;
375 bool can_cut() const;
377 static Glib::RefPtr<Gtk::Action> cut_action;
378 static Glib::RefPtr<Gtk::Action> paste_action;
379 static Glib::RefPtr<Gtk::Action> rename_action;
380 static Glib::RefPtr<Gtk::Action> edit_action;
381 static Glib::RefPtr<Gtk::Action> edit_generic_action;
382 void paste_processor_state (const XMLNodeList&, boost::shared_ptr<ARDOUR::Processor>);
384 void hide_processor_editor (boost::shared_ptr<ARDOUR::Processor>);
385 void rename_processor (boost::shared_ptr<ARDOUR::Processor>);
387 gint idle_delete_processor (boost::weak_ptr<ARDOUR::Processor>);
389 void weird_plugin_dialog (ARDOUR::Plugin& p, ARDOUR::Route::ProcessorStreams streams);
391 void setup_entry_positions ();
393 static ProcessorBox* _current_processor_box;
395 static void rb_choose_aux (boost::weak_ptr<ARDOUR::Route>);
396 static void rb_choose_plugin ();
397 static void rb_choose_insert ();
398 static void rb_choose_send ();
399 static void rb_clear ();
400 static void rb_clear_pre ();
401 static void rb_clear_post ();
402 static void rb_cut ();
403 static void rb_copy ();
404 static void rb_paste ();
405 static void rb_delete ();
406 static void rb_rename ();
407 static void rb_select_all ();
408 static void rb_deselect_all ();
409 static void rb_activate_all ();
410 static void rb_deactivate_all ();
411 static void rb_ab_plugins ();
412 static void rb_edit ();
413 static void rb_edit_generic ();
415 void route_property_changed (const PBD::PropertyChange&);
416 std::string generate_processor_title (boost::shared_ptr<ARDOUR::PluginInsert> pi);
418 typedef std::list<ProcessorWindowProxy*> ProcessorWindowProxies;
419 ProcessorWindowProxies _processor_window_info;
421 ProcessorWindowProxy* find_window_proxy (boost::shared_ptr<ARDOUR::Processor>) const;
423 void set_processor_ui (boost::shared_ptr<ARDOUR::Processor>, Gtk::Window *);
424 void maybe_add_processor_to_ui_list (boost::weak_ptr<ARDOUR::Processor>);
426 bool one_processor_can_be_edited ();
427 bool processor_can_be_edited (boost::shared_ptr<ARDOUR::Processor>);
429 void mixer_strip_delivery_changed (boost::weak_ptr<ARDOUR::Delivery>);
431 XMLNode* entry_gui_object_state (ProcessorEntry *);
434 #endif /* __ardour_gtk_processor_box__ */