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/bindings.h"
34 #include "gtkmm2ext/dndtreeview.h"
35 #include "gtkmm2ext/dndvbox.h"
36 #include "gtkmm2ext/persistent_tooltip.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/luaproc.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 "widgets/ardour_button.h"
53 #include "widgets/ardour_fader.h"
54 #include "widgets/slider_controller.h"
56 #include "plugin_interest.h"
57 #include "plugin_display.h"
58 #include "io_selector.h"
61 #include "window_manager.h"
63 class MotionController;
66 class ProcessorSelection;
82 class ProcessorWindowProxy : public WM::ProxyBase
85 ProcessorWindowProxy (std::string const &, ProcessorBox *, boost::weak_ptr<ARDOUR::Processor>);
86 ~ProcessorWindowProxy();
88 Gtk::Window* get (bool create = false);
90 boost::weak_ptr<ARDOUR::Processor> processor () const {
94 ARDOUR::SessionHandlePtr* session_handle();
95 void show_the_right_window (bool show_not_toggle = false);
96 void set_custom_ui_mode(bool use_custom) { want_custom = use_custom; }
98 int set_state (const XMLNode&, int);
99 XMLNode& get_state ();
102 ProcessorBox* _processor_box;
103 boost::weak_ptr<ARDOUR::Processor> _processor;
107 void processor_going_away ();
108 PBD::ScopedConnection going_away_connection;
109 PBD::ScopedConnectionList gui_connections;
113 class PluginPinWindowProxy : public WM::ProxyBase
116 PluginPinWindowProxy (std::string const &, boost::weak_ptr<ARDOUR::Processor>);
117 ~PluginPinWindowProxy();
119 Gtk::Window* get (bool create = false);
120 ARDOUR::SessionHandlePtr* session_handle();
123 boost::weak_ptr<ARDOUR::Processor> _processor;
125 void processor_going_away ();
126 PBD::ScopedConnection going_away_connection;
131 class ProcessorEntry : public Gtkmm2ext::DnDVBoxChild, public sigc::trackable
134 ProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::Processor>, Width);
137 Gtk::EventBox& action_widget ();
138 Gtk::Widget& widget ();
139 std::string drag_text () const;
140 void set_visual_state (Gtkmm2ext::VisualState, bool);
142 bool is_selectable() const {return _selectable;}
143 void set_selectable(bool s) { _selectable = s; }
145 bool drag_data_get (Glib::RefPtr<Gdk::DragContext> const, Gtk::SelectionData &);
146 bool can_copy_state (Gtkmm2ext::DnDVBoxChild*) const;
154 void set_position (Position, uint32_t);
155 bool unknown_processor () const { return _unknown_processor; } ;
156 boost::shared_ptr<ARDOUR::Processor> processor () const;
157 void set_enum_width (Width);
159 /** Hide any widgets that should be hidden */
160 virtual void hide_things ();
162 void toggle_inline_display_visibility ();
163 void show_all_controls ();
164 void hide_all_controls ();
165 void add_control_state (XMLNode *) const;
166 void set_control_state (XMLNode const *);
167 std::string state_id () const;
168 Gtk::Menu* build_controls_menu ();
169 Gtk::Menu* build_send_options_menu ();
172 ArdourWidgets::ArdourButton _button;
175 uint32_t _position_num;
176 ProcessorBox* _parent;
178 virtual void setup_visuals ();
182 bool _unknown_processor;
183 void led_clicked(GdkEventButton *);
184 void processor_active_changed ();
185 void processor_property_changed (const PBD::PropertyChange&);
186 void processor_configuration_changed (const ARDOUR::ChanCount in, const ARDOUR::ChanCount out);
187 std::string name (Width) const;
188 void setup_tooltip ();
190 boost::shared_ptr<ARDOUR::Processor> _processor;
192 PBD::ScopedConnection active_connection;
193 PBD::ScopedConnection name_connection;
194 PBD::ScopedConnection config_connection;
195 ARDOUR::PluginPresetPtr _plugin_preset_pointer;
197 class Control : public sigc::trackable {
199 Control (boost::shared_ptr<ARDOUR::AutomationControl>, std::string const &);
202 void set_visible (bool);
203 void add_state (XMLNode *) const;
204 void set_state (XMLNode const *);
207 bool visible () const {
211 std::string name () const {
218 void slider_adjusted ();
219 void button_clicked ();
220 void button_clicked_event (GdkEventButton *);
221 void control_changed ();
222 void control_automation_state_changed ();
223 std::string state_id () const;
229 boost::weak_ptr<ARDOUR::AutomationControl> _control;
230 /* things for a slider */
231 Gtk::Adjustment _adjustment;
232 ArdourWidgets::HSliderController _slider;
233 Gtkmm2ext::PersistentTooltip _slider_persistant_tooltip;
234 /* things for a button */
235 ArdourWidgets::ArdourButton _button;
236 bool _ignore_ui_adjustment;
237 PBD::ScopedConnectionList _connections;
242 std::list<Control*> _controls;
244 void toggle_control_visibility (Control *);
245 void toggle_panner_link ();
246 void toggle_allow_feedback ();
248 class PluginInlineDisplay : public PluginDisplay {
250 PluginInlineDisplay(ProcessorEntry&, boost::shared_ptr<ARDOUR::Plugin>, uint32_t max_height = 80);
251 ~PluginInlineDisplay() {}
253 void on_size_request (Gtk::Requisition* req);
254 bool on_button_press_event (GdkEventButton *ev);
255 void update_height_alloc (uint32_t inline_height);
257 void display_sample (cairo_t* cr, double w, double h);
259 ProcessorEntry& _entry;
261 const uint32_t _given_max_height;
264 class LuaPluginDisplay : public PluginInlineDisplay {
266 LuaPluginDisplay(ProcessorEntry&, boost::shared_ptr<ARDOUR::LuaProc>, uint32_t max_height = 80);
269 virtual uint32_t render_inline (cairo_t *, uint32_t width);
271 boost::shared_ptr<ARDOUR::LuaProc> _luaproc;
273 luabridge::LuaRef * _lua_render_inline;
276 class PortIcon : public Gtk::DrawingArea {
278 PortIcon(bool input);
279 void set_ports(ARDOUR::ChanCount const ports) { _ports = ports; }
281 bool on_expose_event (GdkEventExpose *);
283 ARDOUR::ChanCount _ports;
286 class RoutingIcon : public Gtk::DrawingArea {
288 RoutingIcon(bool inputrouting = true);
290 const ARDOUR::ChanCount&,
291 const ARDOUR::ChanCount&,
292 const ARDOUR::ChanCount&,
293 const ARDOUR::ChanCount&,
294 const ARDOUR::ChanMapping&,
295 const ARDOUR::ChanMapping&,
296 const ARDOUR::ChanMapping&);
298 const ARDOUR::ChanCount&,
299 const ARDOUR::ChanCount&,
300 const ARDOUR::ChanMapping&,
301 const ARDOUR::ChanMapping&);
304 const ARDOUR::ChanCount&,
305 const ARDOUR::ChanCount&,
306 const ARDOUR::ChanMapping&,
307 const ARDOUR::ChanMapping&);
309 void set_terminal (bool b);
311 void copy_state (const RoutingIcon& other) {
314 _sources = other._sources;
315 _sinks = other._sinks;
316 _in_map = other._in_map;
317 _out_map = other._out_map;
318 _thru_map = other._thru_map;
319 _f_out = other._f_out;
320 _f_out_map = other._f_out_map;
321 _f_thru_map = other._f_thru_map;
322 _f_sources = other._f_sources;
324 _i_in_map = other._i_in_map;
325 _i_thru_map = other._i_thru_map;
326 _i_sinks = other._i_sinks;
327 _fed_by = other._fed_by;
328 _feeding = other._feeding;
331 void unset_fed_by () { _fed_by = false ; }
332 void unset_feeding () { _feeding = false ; }
333 bool in_identity () const;
334 bool out_identity () const;
335 bool can_coalesce () const;
337 static double pin_x_pos (uint32_t, double, uint32_t, uint32_t, bool);
338 static void draw_connection (cairo_t*, double, double, double, double, bool, bool dashed = false);
339 static void draw_gnd (cairo_t*, double, double, double, bool);
340 static void draw_sidechain (cairo_t*, double, double, double, bool);
341 static void draw_thru_src (cairo_t*, double, double, double, bool);
342 static void draw_thru_sink (cairo_t*, double, double, double, bool);
345 bool on_expose_event (GdkEventExpose *);
346 void expose_input_map (cairo_t*, const double, const double);
347 void expose_coalesced_input_map (cairo_t*, const double, const double);
348 void expose_output_map (cairo_t*, const double, const double);
350 ARDOUR::ChanCount _in;
351 ARDOUR::ChanCount _out;
352 ARDOUR::ChanCount _sources;
353 ARDOUR::ChanCount _sinks;
354 ARDOUR::ChanMapping _in_map;
355 ARDOUR::ChanMapping _out_map;
356 ARDOUR::ChanMapping _thru_map;
357 ARDOUR::ChanCount _f_out;
358 ARDOUR::ChanMapping _f_out_map;
359 ARDOUR::ChanMapping _f_thru_map;
360 ARDOUR::ChanCount _f_sources;
361 ARDOUR::ChanCount _i_in;
362 ARDOUR::ChanMapping _i_in_map;
363 ARDOUR::ChanMapping _i_thru_map;
364 ARDOUR::ChanCount _i_sinks;
373 PortIcon output_icon;
374 RoutingIcon routing_icon; // sits on top of every processor (input routing)
375 RoutingIcon output_routing_icon; // only used by last processor in the chain
378 PluginDisplay *_plugin_display ;
381 class PluginInsertProcessorEntry : public ProcessorEntry
384 PluginInsertProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::PluginInsert>, Width);
389 void iomap_changed ();
390 boost::shared_ptr<ARDOUR::PluginInsert> _plugin_insert;
392 PBD::ScopedConnectionList _iomap_connection;
395 class ProcessorBox : public Gtk::HBox, public PluginInterestedObject, public ARDOUR::SessionHandlePtr
398 enum ProcessorOperation {
404 ProcessorsSelectNone,
405 ProcessorsToggleActive,
409 ProcessorBox (ARDOUR::Session*, boost::function<PluginSelector*()> get_plugin_selector,
410 ProcessorSelection&, MixerStrip* parent, bool owner_is_mixer = false);
413 void set_route (boost::shared_ptr<ARDOUR::Route>);
414 void set_width (Width);
416 bool processor_operation (ProcessorOperation);
418 void select_all_processors ();
419 void deselect_all_processors ();
420 void select_all_plugins ();
421 void select_all_inserts ();
422 void select_all_sends ();
424 void all_visible_processors_active(bool state);
425 void setup_routing_feeds ();
429 bool edit_aux_send(boost::shared_ptr<ARDOUR::Processor>);
431 /* Everything except a WindowProxy object should use this to get the window */
432 Gtk::Window* get_processor_ui (boost::shared_ptr<ARDOUR::Processor>) const;
434 /* a WindowProxy object can use this */
435 Gtk::Window* get_editor_window (boost::shared_ptr<ARDOUR::Processor>, bool);
436 Gtk::Window* get_generic_editor_window (boost::shared_ptr<ARDOUR::Processor>);
438 void manage_pins (boost::shared_ptr<ARDOUR::Processor>);
439 void edit_processor (boost::shared_ptr<ARDOUR::Processor>);
440 void generic_edit_processor (boost::shared_ptr<ARDOUR::Processor>);
442 void update_gui_object_state (ProcessorEntry *);
444 sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorSelected;
445 sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorUnselected;
447 static Glib::RefPtr<Gtk::ActionGroup> processor_box_actions;
448 static Gtkmm2ext::Bindings* bindings;
449 static void register_actions();
451 typedef std::vector<boost::shared_ptr<ARDOUR::Processor> > ProcSelection;
453 static ProcSelection current_processor_selection ()
456 if (_current_processor_box) {
457 _current_processor_box->get_selected_processors (ps);
463 static bool show_all_processors;
467 /* prevent copy construction */
468 ProcessorBox (ProcessorBox const &);
470 boost::shared_ptr<ARDOUR::Route> _route;
471 MixerStrip* _parent_strip; // null if in RouteParamsUI
472 bool _owner_is_mixer;
474 PBD::ScopedConnectionList _mixer_strip_connections;
475 PBD::ScopedConnectionList _route_connections;
477 boost::function<PluginSelector*()> _get_plugin_selector;
479 boost::shared_ptr<ARDOUR::Processor> _processor_being_created;
481 /** Index at which to place a new plugin (based on where the menu was opened), or -1 to
482 * put at the end of the plugin list.
486 ProcessorSelection& _p_selection;
487 static Gtkmm2ext::ActionMap myactions;
489 static void load_bindings ();
491 void route_going_away ();
493 bool is_editor_mixer_strip() const;
495 Gtkmm2ext::DnDVBox<ProcessorEntry> processor_display;
496 Gtk::ScrolledWindow processor_scroller;
498 boost::shared_ptr<ARDOUR::Processor> find_drop_position (ProcessorEntry* position);
500 void _drop_plugin_preset (Gtk::SelectionData const &, ARDOUR::Route::ProcessorList &);
501 void _drop_plugin (Gtk::SelectionData const &, ARDOUR::Route::ProcessorList &);
503 void plugin_drop (Gtk::SelectionData const &, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context);
504 void object_drop (Gtkmm2ext::DnDVBox<ProcessorEntry> *, ProcessorEntry *, Glib::RefPtr<Gdk::DragContext> const &);
507 bool _redisplay_pending;
509 Gtk::Menu *processor_menu;
510 gint processor_menu_map_handler (GdkEventAny *ev);
511 Gtk::Menu * build_processor_menu ();
512 void show_processor_menu (int);
513 Gtk::Menu* build_possible_aux_menu();
514 Gtk::Menu* build_possible_listener_menu();
515 Gtk::Menu* build_possible_remove_listener_menu();
517 void choose_aux (boost::weak_ptr<ARDOUR::Route>);
518 void remove_aux (boost::weak_ptr<ARDOUR::Route>);
520 void send_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
521 void return_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
522 void choose_insert ();
523 void choose_plugin ();
524 bool use_plugins (const SelectedPlugins&);
526 bool no_processor_redisplay;
528 bool enter_notify (GdkEventCrossing *ev);
529 bool leave_notify (GdkEventCrossing *ev);
530 bool processor_button_press_event (GdkEventButton *, ProcessorEntry *);
531 bool processor_button_release_event (GdkEventButton *, ProcessorEntry *);
532 void redisplay_processors ();
533 void add_processor_to_display (boost::weak_ptr<ARDOUR::Processor>);
535 void report_failed_reorder ();
536 void route_processors_changed (ARDOUR::RouteProcessorChange);
537 void processor_menu_unmapped ();
539 void processors_reordered (const Gtk::TreeModel::Path&, const Gtk::TreeModel::iterator&, int*);
540 void compute_processor_sort_keys ();
544 void cut_processors (const ProcSelection&);
545 void copy_processors (const ProcSelection&);
546 void delete_processors (const ProcSelection&);
547 void paste_processors ();
548 void paste_processors (boost::shared_ptr<ARDOUR::Processor> before);
550 void delete_dragged_processors (const std::list<boost::shared_ptr<ARDOUR::Processor> >&);
551 void clear_processors ();
552 void clear_processors (ARDOUR::Placement);
553 void rename_processors ();
555 void for_selected_processors (void (ProcessorBox::*pmf)(boost::shared_ptr<ARDOUR::Processor>));
556 void get_selected_processors (ProcSelection&) const;
558 void set_disk_io_position (ARDOUR::DiskIOPoint);
560 bool can_cut() const;
561 bool stub_processor_selected() const;
563 static Glib::RefPtr<Gtk::Action> cut_action;
564 static Glib::RefPtr<Gtk::Action> copy_action;
565 static Glib::RefPtr<Gtk::Action> paste_action;
566 static Glib::RefPtr<Gtk::Action> rename_action;
567 static Glib::RefPtr<Gtk::Action> delete_action;
568 static Glib::RefPtr<Gtk::Action> backspace_action;
569 static Glib::RefPtr<Gtk::Action> manage_pins_action;
570 static Glib::RefPtr<Gtk::Action> disk_io_action;
571 static Glib::RefPtr<Gtk::Action> edit_action;
572 static Glib::RefPtr<Gtk::Action> edit_generic_action;
573 void paste_processor_state (const XMLNodeList&, boost::shared_ptr<ARDOUR::Processor>);
575 void hide_processor_editor (boost::shared_ptr<ARDOUR::Processor>);
576 void rename_processor (boost::shared_ptr<ARDOUR::Processor>);
578 gint idle_delete_processor (boost::weak_ptr<ARDOUR::Processor>);
580 void weird_plugin_dialog (ARDOUR::Plugin& p, ARDOUR::Route::ProcessorStreams streams);
582 void setup_entry_positions ();
584 static ProcessorBox* _current_processor_box;
586 static void rb_choose_aux (boost::weak_ptr<ARDOUR::Route>);
587 static void rb_remove_aux (boost::weak_ptr<ARDOUR::Route>);
588 static void rb_choose_plugin ();
589 static void rb_choose_insert ();
590 static void rb_choose_send ();
591 static void rb_clear ();
592 static void rb_clear_pre ();
593 static void rb_clear_post ();
594 static void rb_cut ();
595 static void rb_copy ();
596 static void rb_paste ();
597 static void rb_delete ();
598 static void rb_rename ();
599 static void rb_select_all ();
600 static void rb_deselect_all ();
601 static void rb_activate_all ();
602 static void rb_deactivate_all ();
603 static void rb_ab_plugins ();
604 static void rb_manage_pins ();
605 static void rb_set_disk_io_position (ARDOUR::DiskIOPoint);
606 static void rb_edit ();
607 static void rb_edit_generic ();
609 void route_property_changed (const PBD::PropertyChange&);
610 std::string generate_processor_title (boost::shared_ptr<ARDOUR::PluginInsert> pi);
612 //typedef std::list<ProcessorWindowProxy*> ProcessorWindowProxies;
613 //ProcessorWindowProxies _processor_window_info;
615 ProcessorWindowProxy* find_window_proxy (boost::shared_ptr<ARDOUR::Processor>) const;
617 void set_processor_ui (boost::shared_ptr<ARDOUR::Processor>, Gtk::Window *);
618 void maybe_add_processor_to_ui_list (boost::weak_ptr<ARDOUR::Processor>);
619 void maybe_add_processor_pin_mgr (boost::weak_ptr<ARDOUR::Processor>);
621 bool one_processor_can_be_edited ();
622 bool processor_can_be_edited (boost::shared_ptr<ARDOUR::Processor>);
624 void mixer_strip_delivery_changed (boost::weak_ptr<ARDOUR::Delivery>);
626 XMLNode* entry_gui_object_state (ProcessorEntry *);
627 PBD::ScopedConnection amp_config_connection;
630 #endif /* __ardour_gtk_processor_box__ */