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>
33 #include "gtkmm2ext/auto_spin.h"
34 #include "gtkmm2ext/bindings.h"
35 #include "gtkmm2ext/click_box.h"
36 #include "gtkmm2ext/dndtreeview.h"
37 #include "gtkmm2ext/dndvbox.h"
38 #include "gtkmm2ext/pixfader.h"
39 #include "gtkmm2ext/persistent_tooltip.h"
41 #include "pbd/stateful.h"
42 #include "pbd/signals.h"
44 #include "ardour/types.h"
45 #include "ardour/ardour.h"
46 #include "ardour/plugin_insert.h"
47 #include "ardour/luaproc.h"
48 #include "ardour/port_insert.h"
49 #include "ardour/processor.h"
50 #include "ardour/route.h"
51 #include "ardour/session_handle.h"
53 #include "pbd/fastlog.h"
55 #include "plugin_interest.h"
56 #include "io_selector.h"
59 #include "ardour_button.h"
60 #include "window_manager.h"
62 class MotionController;
65 class RouteProcessorSelection;
81 class ProcessorWindowProxy : public WM::ProxyBase
84 ProcessorWindowProxy (std::string const &, ProcessorBox *, boost::weak_ptr<ARDOUR::Processor>);
85 ~ProcessorWindowProxy();
87 Gtk::Window* get (bool create = false);
89 boost::weak_ptr<ARDOUR::Processor> processor () const {
93 ARDOUR::SessionHandlePtr* session_handle();
94 void show_the_right_window ();
95 void set_custom_ui_mode(bool use_custom) { want_custom = use_custom; }
97 int set_state (const XMLNode&, int);
98 XMLNode& get_state ();
101 ProcessorBox* _processor_box;
102 boost::weak_ptr<ARDOUR::Processor> _processor;
106 void processor_going_away ();
107 PBD::ScopedConnection going_away_connection;
111 class PluginPinWindowProxy : public WM::ProxyBase
114 PluginPinWindowProxy (std::string const &, boost::weak_ptr<ARDOUR::Processor>);
115 ~PluginPinWindowProxy();
117 Gtk::Window* get (bool create = false);
118 ARDOUR::SessionHandlePtr* session_handle();
121 ProcessorBox* _processor_box;
122 boost::weak_ptr<ARDOUR::Processor> _processor;
124 void processor_going_away ();
125 PBD::ScopedConnection going_away_connection;
130 class ProcessorEntry : public Gtkmm2ext::DnDVBoxChild, public sigc::trackable
133 ProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::Processor>, Width);
136 Gtk::EventBox& action_widget ();
137 Gtk::Widget& widget ();
138 std::string drag_text () const;
139 void set_visual_state (Gtkmm2ext::VisualState, bool);
141 bool is_selectable() const {return _selectable;}
142 void set_selectable(bool s) { _selectable = s; }
144 bool drag_data_get (Glib::RefPtr<Gdk::DragContext> const, Gtk::SelectionData &);
145 bool can_copy_state (Gtkmm2ext::DnDVBoxChild*) const;
153 void set_position (Position, uint32_t);
154 bool unknown_processor () const { return _unknown_processor; } ;
155 boost::shared_ptr<ARDOUR::Processor> processor () const;
156 void set_enum_width (Width);
158 /** Hide any widgets that should be hidden */
159 virtual void hide_things ();
161 void show_all_controls ();
162 void hide_all_controls ();
163 void add_control_state (XMLNode *) const;
164 void set_control_state (XMLNode const *);
165 std::string state_id () const;
166 Gtk::Menu* build_controls_menu ();
167 Gtk::Menu* build_send_options_menu ();
170 ArdourButton _button;
173 uint32_t _position_num;
174 ProcessorBox* _parent;
176 virtual void setup_visuals ();
180 bool _unknown_processor;
181 void led_clicked(GdkEventButton *);
182 void processor_active_changed ();
183 void processor_property_changed (const PBD::PropertyChange&);
184 void processor_configuration_changed (const ARDOUR::ChanCount in, const ARDOUR::ChanCount out);
185 std::string name (Width) const;
186 void setup_tooltip ();
188 boost::shared_ptr<ARDOUR::Processor> _processor;
190 PBD::ScopedConnection active_connection;
191 PBD::ScopedConnection name_connection;
192 PBD::ScopedConnection config_connection;
193 ARDOUR::PluginPresetPtr _plugin_preset_pointer;
195 class Control : public sigc::trackable {
197 Control (boost::shared_ptr<ARDOUR::AutomationControl>, std::string const &);
200 void set_visible (bool);
201 void add_state (XMLNode *) const;
202 void set_state (XMLNode const *);
205 bool visible () const {
209 std::string name () const {
216 void slider_adjusted ();
217 void button_clicked ();
218 void button_clicked_event (GdkEventButton *);
219 void control_changed ();
220 std::string state_id () const;
223 boost::weak_ptr<ARDOUR::AutomationControl> _control;
224 /* things for a slider */
225 Gtk::Adjustment _adjustment;
226 Gtkmm2ext::HSliderController _slider;
227 Gtkmm2ext::PersistentTooltip _slider_persistant_tooltip;
228 /* things for a button */
229 ArdourButton _button;
230 bool _ignore_ui_adjustment;
231 PBD::ScopedConnection _connection;
234 sigc::connection timer_connection;
237 std::list<Control*> _controls;
239 void toggle_inline_display_visibility ();
240 void toggle_control_visibility (Control *);
241 void toggle_panner_link ();
243 class PluginDisplay : public Gtk::DrawingArea {
245 PluginDisplay(ProcessorEntry&, boost::shared_ptr<ARDOUR::Plugin>, uint32_t max_height = 80);
246 virtual ~PluginDisplay();
248 bool on_expose_event (GdkEventExpose *);
249 void on_size_request (Gtk::Requisition* req);
250 bool on_button_press_event (GdkEventButton *ev);
251 bool on_button_release_event (GdkEventButton *ev);
253 void update_height_alloc (uint32_t inline_height);
254 virtual uint32_t render_inline (cairo_t *, uint32_t width);
256 ProcessorEntry& _entry;
257 boost::shared_ptr<ARDOUR::Plugin> _plug;
258 PBD::ScopedConnection _qdraw_connection;
259 cairo_surface_t* _surf;
260 uint32_t _max_height;
261 uint32_t _cur_height;
265 class LuaPluginDisplay : public PluginDisplay {
267 LuaPluginDisplay(ProcessorEntry&, boost::shared_ptr<ARDOUR::LuaProc>, uint32_t max_height = 80);
270 virtual uint32_t render_inline (cairo_t *, uint32_t width);
272 boost::shared_ptr<ARDOUR::LuaProc> _luaproc;
274 luabridge::LuaRef * _lua_render_inline;
277 class PortIcon : public Gtk::DrawingArea {
279 PortIcon(bool input);
280 void set_ports(ARDOUR::ChanCount const ports) { _ports = ports; }
282 bool on_expose_event (GdkEventExpose *);
284 ARDOUR::ChanCount _ports;
287 class RoutingIcon : public Gtk::DrawingArea {
289 RoutingIcon(bool inputrouting = true);
291 const ARDOUR::ChanCount&,
292 const ARDOUR::ChanCount&,
293 const ARDOUR::ChanCount&,
294 const ARDOUR::ChanCount&,
295 const ARDOUR::ChanMapping&,
296 const ARDOUR::ChanMapping&,
297 const ARDOUR::ChanMapping&);
299 const ARDOUR::ChanCount&,
300 const ARDOUR::ChanCount&,
301 const ARDOUR::ChanMapping&,
302 const ARDOUR::ChanMapping&);
305 const ARDOUR::ChanCount&,
306 const ARDOUR::ChanCount&,
307 const ARDOUR::ChanMapping&,
308 const ARDOUR::ChanMapping&);
310 void set_terminal (bool b);
312 void copy_state (const RoutingIcon& other) {
315 _sources = other._sources;
316 _sinks = other._sinks;
317 _in_map = other._in_map;
318 _out_map = other._out_map;
319 _thru_map = other._thru_map;
320 _f_out = other._f_out;
321 _f_out_map = other._f_out_map;
322 _f_thru_map = other._f_thru_map;
323 _f_sources = other._f_sources;
325 _i_in_map = other._i_in_map;
326 _i_thru_map = other._i_thru_map;
327 _i_sinks = other._i_sinks;
328 _fed_by = other._fed_by;
329 _feeding = other._feeding;
332 void unset_fed_by () { _fed_by = false ; }
333 void unset_feeding () { _feeding = false ; }
334 bool in_identity () const;
335 bool out_identity () const;
336 bool can_coalesce () const;
338 static double pin_x_pos (uint32_t, double, uint32_t, uint32_t, bool);
339 static void draw_connection (cairo_t*, double, double, double, double, bool, bool dashed = false);
340 static void draw_gnd (cairo_t*, double, double, double, bool);
341 static void draw_sidechain (cairo_t*, double, double, double, bool);
342 static void draw_thru_src (cairo_t*, double, double, double, bool);
343 static void draw_thru_sink (cairo_t*, double, double, double, bool);
346 bool on_expose_event (GdkEventExpose *);
347 void expose_input_map (cairo_t*, const double, const double);
348 void expose_coalesced_input_map (cairo_t*, const double, const double);
349 void expose_output_map (cairo_t*, const double, const double);
351 ARDOUR::ChanCount _in;
352 ARDOUR::ChanCount _out;
353 ARDOUR::ChanCount _sources;
354 ARDOUR::ChanCount _sinks;
355 ARDOUR::ChanMapping _in_map;
356 ARDOUR::ChanMapping _out_map;
357 ARDOUR::ChanMapping _thru_map;
358 ARDOUR::ChanCount _f_out;
359 ARDOUR::ChanMapping _f_out_map;
360 ARDOUR::ChanMapping _f_thru_map;
361 ARDOUR::ChanCount _f_sources;
362 ARDOUR::ChanCount _i_in;
363 ARDOUR::ChanMapping _i_in_map;
364 ARDOUR::ChanMapping _i_thru_map;
365 ARDOUR::ChanCount _i_sinks;
374 PortIcon output_icon;
375 RoutingIcon routing_icon; // sits on top of every processor (input routing)
376 RoutingIcon output_routing_icon; // only used by last processor in the chain
379 PluginDisplay *_plugin_display ;
382 class PluginInsertProcessorEntry : public ProcessorEntry
385 PluginInsertProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::PluginInsert>, Width);
390 void iomap_changed ();
391 boost::shared_ptr<ARDOUR::PluginInsert> _plugin_insert;
393 PBD::ScopedConnectionList _iomap_connection;
396 class ProcessorBox : public Gtk::HBox, public PluginInterestedObject, public ARDOUR::SessionHandlePtr
399 enum ProcessorOperation {
405 ProcessorsSelectNone,
406 ProcessorsToggleActive,
410 ProcessorBox (ARDOUR::Session*, boost::function<PluginSelector*()> get_plugin_selector,
411 RouteProcessorSelection&, MixerStrip* parent, bool owner_is_mixer = false);
414 void set_route (boost::shared_ptr<ARDOUR::Route>);
415 void set_width (Width);
417 bool processor_operation (ProcessorOperation);
419 void select_all_processors ();
420 void deselect_all_processors ();
421 void select_all_plugins ();
422 void select_all_inserts ();
423 void select_all_sends ();
425 void all_visible_processors_active(bool state);
426 void setup_routing_feeds ();
430 bool edit_aux_send(boost::shared_ptr<ARDOUR::Processor>);
432 /* Everything except a WindowProxy object should use this to get the window */
433 Gtk::Window* get_processor_ui (boost::shared_ptr<ARDOUR::Processor>) const;
435 /* a WindowProxy object can use this */
436 Gtk::Window* get_editor_window (boost::shared_ptr<ARDOUR::Processor>, bool);
437 Gtk::Window* get_generic_editor_window (boost::shared_ptr<ARDOUR::Processor>);
439 void manage_pins (boost::shared_ptr<ARDOUR::Processor>);
440 void edit_processor (boost::shared_ptr<ARDOUR::Processor>);
441 void generic_edit_processor (boost::shared_ptr<ARDOUR::Processor>);
443 void update_gui_object_state (ProcessorEntry *);
445 sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorSelected;
446 sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorUnselected;
448 static Glib::RefPtr<Gtk::ActionGroup> processor_box_actions;
449 static Gtkmm2ext::Bindings* bindings;
450 static void register_actions();
453 static bool show_all_processors;
457 /* prevent copy construction */
458 ProcessorBox (ProcessorBox const &);
460 boost::shared_ptr<ARDOUR::Route> _route;
461 MixerStrip* _parent_strip; // null if in RouteParamsUI
462 bool _owner_is_mixer;
464 PBD::ScopedConnectionList _mixer_strip_connections;
465 PBD::ScopedConnectionList _route_connections;
467 boost::function<PluginSelector*()> _get_plugin_selector;
469 boost::shared_ptr<ARDOUR::Processor> _processor_being_created;
471 /** Index at which to place a new plugin (based on where the menu was opened), or -1 to
472 * put at the end of the plugin list.
475 uint32_t _visible_prefader_processors;
477 RouteProcessorSelection& _rr_selection;
478 static Gtkmm2ext::ActionMap myactions;
480 static void load_bindings ();
482 void route_going_away ();
484 bool is_editor_mixer_strip() const;
486 Gtkmm2ext::DnDVBox<ProcessorEntry> processor_display;
487 Gtk::ScrolledWindow processor_scroller;
489 boost::shared_ptr<ARDOUR::Processor> find_drop_position (ProcessorEntry* position);
491 void _drop_plugin_preset (Gtk::SelectionData const &, ARDOUR::Route::ProcessorList &);
492 void _drop_plugin (Gtk::SelectionData const &, ARDOUR::Route::ProcessorList &);
494 void plugin_drop (Gtk::SelectionData const &, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context);
495 void object_drop (Gtkmm2ext::DnDVBox<ProcessorEntry> *, ProcessorEntry *, Glib::RefPtr<Gdk::DragContext> const &);
498 bool _redisplay_pending;
500 Gtk::Menu *processor_menu;
501 gint processor_menu_map_handler (GdkEventAny *ev);
502 Gtk::Menu * build_processor_menu ();
503 void show_processor_menu (int);
504 Gtk::Menu* build_possible_aux_menu();
506 void choose_aux (boost::weak_ptr<ARDOUR::Route>);
508 void send_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
509 void return_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
510 void choose_insert ();
511 void choose_plugin ();
512 bool use_plugins (const SelectedPlugins&);
514 bool no_processor_redisplay;
516 bool enter_notify (GdkEventCrossing *ev);
517 bool leave_notify (GdkEventCrossing *ev);
518 bool processor_button_press_event (GdkEventButton *, ProcessorEntry *);
519 bool processor_button_release_event (GdkEventButton *, ProcessorEntry *);
520 void redisplay_processors ();
521 void add_processor_to_display (boost::weak_ptr<ARDOUR::Processor>);
522 void help_count_visible_prefader_processors (boost::weak_ptr<ARDOUR::Processor>, uint32_t*, bool*);
524 void report_failed_reorder ();
525 void route_processors_changed (ARDOUR::RouteProcessorChange);
526 void processor_menu_unmapped ();
528 void processors_reordered (const Gtk::TreeModel::Path&, const Gtk::TreeModel::iterator&, int*);
529 void compute_processor_sort_keys ();
533 typedef std::vector<boost::shared_ptr<ARDOUR::Processor> > ProcSelection;
535 void cut_processors (const ProcSelection&);
536 void copy_processors (const ProcSelection&);
537 void delete_processors (const ProcSelection&);
538 void paste_processors ();
539 void paste_processors (boost::shared_ptr<ARDOUR::Processor> before);
541 void delete_dragged_processors (const std::list<boost::shared_ptr<ARDOUR::Processor> >&);
542 void clear_processors ();
543 void clear_processors (ARDOUR::Placement);
544 void rename_processors ();
546 void for_selected_processors (void (ProcessorBox::*pmf)(boost::shared_ptr<ARDOUR::Processor>));
547 void get_selected_processors (ProcSelection&) const;
549 bool can_cut() const;
550 bool stub_processor_selected() const;
552 static Glib::RefPtr<Gtk::Action> cut_action;
553 static Glib::RefPtr<Gtk::Action> copy_action;
554 static Glib::RefPtr<Gtk::Action> paste_action;
555 static Glib::RefPtr<Gtk::Action> rename_action;
556 static Glib::RefPtr<Gtk::Action> delete_action;
557 static Glib::RefPtr<Gtk::Action> backspace_action;
558 static Glib::RefPtr<Gtk::Action> manage_pins_action;
559 static Glib::RefPtr<Gtk::Action> edit_action;
560 static Glib::RefPtr<Gtk::Action> edit_generic_action;
561 void paste_processor_state (const XMLNodeList&, boost::shared_ptr<ARDOUR::Processor>);
563 void hide_processor_editor (boost::shared_ptr<ARDOUR::Processor>);
564 void rename_processor (boost::shared_ptr<ARDOUR::Processor>);
566 gint idle_delete_processor (boost::weak_ptr<ARDOUR::Processor>);
568 void weird_plugin_dialog (ARDOUR::Plugin& p, ARDOUR::Route::ProcessorStreams streams);
570 void setup_entry_positions ();
572 static ProcessorBox* _current_processor_box;
574 static void rb_choose_aux (boost::weak_ptr<ARDOUR::Route>);
575 static void rb_choose_plugin ();
576 static void rb_choose_insert ();
577 static void rb_choose_send ();
578 static void rb_clear ();
579 static void rb_clear_pre ();
580 static void rb_clear_post ();
581 static void rb_cut ();
582 static void rb_copy ();
583 static void rb_paste ();
584 static void rb_delete ();
585 static void rb_rename ();
586 static void rb_select_all ();
587 static void rb_deselect_all ();
588 static void rb_activate_all ();
589 static void rb_deactivate_all ();
590 static void rb_ab_plugins ();
591 static void rb_manage_pins ();
592 static void rb_edit ();
593 static void rb_edit_generic ();
595 void route_property_changed (const PBD::PropertyChange&);
596 std::string generate_processor_title (boost::shared_ptr<ARDOUR::PluginInsert> pi);
598 //typedef std::list<ProcessorWindowProxy*> ProcessorWindowProxies;
599 //ProcessorWindowProxies _processor_window_info;
601 ProcessorWindowProxy* find_window_proxy (boost::shared_ptr<ARDOUR::Processor>) const;
603 void set_processor_ui (boost::shared_ptr<ARDOUR::Processor>, Gtk::Window *);
604 void maybe_add_processor_to_ui_list (boost::weak_ptr<ARDOUR::Processor>);
605 void maybe_add_processor_pin_mgr (boost::weak_ptr<ARDOUR::Processor>);
607 bool one_processor_can_be_edited ();
608 bool processor_can_be_edited (boost::shared_ptr<ARDOUR::Processor>);
610 void mixer_strip_delivery_changed (boost::weak_ptr<ARDOUR::Delivery>);
612 XMLNode* entry_gui_object_state (ProcessorEntry *);
613 PBD::ScopedConnection amp_config_connection;
616 #endif /* __ardour_gtk_processor_box__ */