start using ActionMap in preference to ActionManager
[ardour.git] / gtk2_ardour / processor_box.h
1 /*
2     Copyright (C) 2004 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
20 #ifndef __ardour_gtk_processor_box__
21 #define __ardour_gtk_processor_box__
22
23 #include <cmath>
24 #include <vector>
25
26 #include <boost/function.hpp>
27
28 #include <gtkmm/box.h>
29 #include <gtkmm/eventbox.h>
30 #include <gtkmm/menu.h>
31 #include <gtkmm/scrolledwindow.h>
32
33 #include "gtkmm2ext/bindings.h"
34 #include "gtkmm2ext/dndtreeview.h"
35 #include "gtkmm2ext/dndvbox.h"
36 #include "gtkmm2ext/persistent_tooltip.h"
37
38 #include "pbd/stateful.h"
39 #include "pbd/signals.h"
40
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"
49
50 #include "pbd/fastlog.h"
51
52 #include "widgets/ardour_button.h"
53 #include "widgets/ardour_fader.h"
54 #include "widgets/slider_controller.h"
55
56 #include "plugin_interest.h"
57 #include "plugin_display.h"
58 #include "io_selector.h"
59 #include "send_ui.h"
60 #include "enums.h"
61 #include "window_manager.h"
62
63 class MotionController;
64 class PluginSelector;
65 class PluginUIWindow;
66 class ProcessorSelection;
67 class MixerStrip;
68
69 namespace ARDOUR {
70         class Connection;
71         class IO;
72         class Insert;
73         class Plugin;
74         class PluginInsert;
75         class PortInsert;
76         class Route;
77         class Session;
78 }
79
80 class ProcessorBox;
81
82 class ProcessorWindowProxy : public WM::ProxyBase
83 {
84 public:
85         ProcessorWindowProxy (std::string const &, ProcessorBox *, boost::weak_ptr<ARDOUR::Processor>);
86         ~ProcessorWindowProxy();
87
88         Gtk::Window* get (bool create = false);
89
90         boost::weak_ptr<ARDOUR::Processor> processor () const {
91                 return _processor;
92         }
93
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; }
97
98         int set_state (const XMLNode&, int);
99         XMLNode& get_state ();
100
101 private:
102         ProcessorBox* _processor_box;
103         boost::weak_ptr<ARDOUR::Processor> _processor;
104         bool is_custom;
105         bool want_custom;
106
107         void processor_going_away ();
108         PBD::ScopedConnection going_away_connection;
109         PBD::ScopedConnectionList gui_connections;
110 };
111
112
113 class PluginPinWindowProxy : public WM::ProxyBase
114 {
115   public:
116         PluginPinWindowProxy (std::string const &, boost::weak_ptr<ARDOUR::Processor>);
117         ~PluginPinWindowProxy();
118
119         Gtk::Window* get (bool create = false);
120         ARDOUR::SessionHandlePtr* session_handle();
121
122   private:
123         boost::weak_ptr<ARDOUR::Processor> _processor;
124
125         void processor_going_away ();
126         PBD::ScopedConnection going_away_connection;
127 };
128
129
130
131 class ProcessorEntry : public Gtkmm2ext::DnDVBoxChild, public sigc::trackable
132 {
133 public:
134         ProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::Processor>, Width);
135         ~ProcessorEntry ();
136
137         Gtk::EventBox& action_widget ();
138         Gtk::Widget& widget ();
139         std::string drag_text () const;
140         void set_visual_state (Gtkmm2ext::VisualState, bool);
141
142         bool is_selectable() const {return _selectable;}
143         void set_selectable(bool s) { _selectable = s; }
144
145         bool drag_data_get (Glib::RefPtr<Gdk::DragContext> const, Gtk::SelectionData &);
146         bool can_copy_state (Gtkmm2ext::DnDVBoxChild*) const;
147
148         enum Position {
149                 PreFader,
150                 Fader,
151                 PostFader
152         };
153
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);
158
159         /** Hide any widgets that should be hidden */
160         virtual void hide_things ();
161
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 ();
170
171 protected:
172         ArdourWidgets::ArdourButton _button;
173         Gtk::VBox _vbox;
174         Position _position;
175         uint32_t _position_num;
176         ProcessorBox* _parent;
177
178         virtual void setup_visuals ();
179
180 private:
181         bool _selectable;
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 ();
189
190         boost::shared_ptr<ARDOUR::Processor> _processor;
191         Width _width;
192         PBD::ScopedConnection active_connection;
193         PBD::ScopedConnection name_connection;
194         PBD::ScopedConnection config_connection;
195         ARDOUR::PluginPresetPtr _plugin_preset_pointer;
196
197         class Control : public sigc::trackable {
198         public:
199                 Control (boost::shared_ptr<ARDOUR::AutomationControl>, std::string const &);
200                 ~Control ();
201
202                 void set_visible (bool);
203                 void add_state (XMLNode *) const;
204                 void set_state (XMLNode const *);
205                 void hide_things ();
206
207                 bool visible () const {
208                         return _visible;
209                 }
210
211                 std::string name () const {
212                         return _name;
213                 }
214
215                 Gtk::Alignment box;
216
217         private:
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;
224                 void set_tooltip ();
225
226                 void start_touch ();
227                 void end_touch ();
228
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;
238                 bool _visible;
239                 std::string _name;
240         };
241
242         std::list<Control*> _controls;
243
244         void toggle_control_visibility (Control *);
245         void toggle_panner_link ();
246         void toggle_allow_feedback ();
247
248         class PluginInlineDisplay : public PluginDisplay {
249         public:
250                 PluginInlineDisplay(ProcessorEntry&, boost::shared_ptr<ARDOUR::Plugin>, uint32_t max_height = 80);
251                 ~PluginInlineDisplay() {}
252         protected:
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);
256
257                 void display_sample (cairo_t* cr, double w, double h);
258
259                 ProcessorEntry& _entry;
260                 bool _scroll;
261                 const uint32_t _given_max_height;
262         };
263
264         class LuaPluginDisplay : public PluginInlineDisplay {
265         public:
266                 LuaPluginDisplay(ProcessorEntry&, boost::shared_ptr<ARDOUR::LuaProc>, uint32_t max_height = 80);
267                 ~LuaPluginDisplay();
268         protected:
269                 virtual uint32_t render_inline (cairo_t *, uint32_t width);
270         private:
271                 boost::shared_ptr<ARDOUR::LuaProc> _luaproc;
272                 LuaState lua_gui;
273                 luabridge::LuaRef * _lua_render_inline;
274         };
275
276         class PortIcon : public Gtk::DrawingArea {
277         public:
278                 PortIcon(bool input);
279                 void set_ports(ARDOUR::ChanCount const ports) { _ports = ports; }
280         private:
281                 bool on_expose_event (GdkEventExpose *);
282                 bool _input;
283                 ARDOUR::ChanCount _ports;
284         };
285
286         class RoutingIcon : public Gtk::DrawingArea {
287         public:
288                 RoutingIcon(bool inputrouting = true);
289                 void set (
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&);
297                 void set_fed_by (
298                                 const ARDOUR::ChanCount&,
299                                 const ARDOUR::ChanCount&,
300                                 const ARDOUR::ChanMapping&,
301                                 const ARDOUR::ChanMapping&);
302
303                 void set_feeding (
304                                 const ARDOUR::ChanCount&,
305                                 const ARDOUR::ChanCount&,
306                                 const ARDOUR::ChanMapping&,
307                                 const ARDOUR::ChanMapping&);
308
309                 void set_terminal (bool b);
310
311                 void copy_state (const RoutingIcon& other) {
312                         _in         = other._in;
313                         _out        = other._out;
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;
323                         _i_in       = other._i_in;
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;
329                 }
330
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;
336
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);
343
344         private:
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);
349
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;
365                 bool _fed_by;
366                 bool _feeding;
367                 bool _input;
368                 bool _terminal;
369         };
370
371 public:
372         PortIcon input_icon;
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
376
377 protected:
378         PluginDisplay *_plugin_display ;
379 };
380
381 class PluginInsertProcessorEntry : public ProcessorEntry
382 {
383 public:
384         PluginInsertProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::PluginInsert>, Width);
385
386         void hide_things ();
387
388 private:
389         void iomap_changed ();
390         boost::shared_ptr<ARDOUR::PluginInsert> _plugin_insert;
391
392         PBD::ScopedConnectionList _iomap_connection;
393 };
394
395 class ProcessorBox : public Gtk::HBox, public PluginInterestedObject, public ARDOUR::SessionHandlePtr, Gtkmm2ext::StaticActionMapOwner
396 {
397 public:
398         enum ProcessorOperation {
399                 ProcessorsCut,
400                 ProcessorsCopy,
401                 ProcessorsPaste,
402                 ProcessorsDelete,
403                 ProcessorsSelectAll,
404                 ProcessorsSelectNone,
405                 ProcessorsToggleActive,
406                 ProcessorsAB,
407         };
408
409         ProcessorBox (ARDOUR::Session*, boost::function<PluginSelector*()> get_plugin_selector,
410                       ProcessorSelection&, MixerStrip* parent, bool owner_is_mixer = false);
411         ~ProcessorBox ();
412
413         void set_route (boost::shared_ptr<ARDOUR::Route>);
414         void set_width (Width);
415
416         bool processor_operation (ProcessorOperation);
417
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 ();
423
424         void all_visible_processors_active(bool state);
425         void setup_routing_feeds ();
426
427         void hide_things ();
428
429         bool edit_aux_send(boost::shared_ptr<ARDOUR::Processor>);
430
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;
433
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>);
437
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>);
441
442         void update_gui_object_state (ProcessorEntry *);
443
444         sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorSelected;
445         sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorUnselected;
446
447         Gtkmm2ext::ActionMap& my_actions() const { return myactions; }
448
449         static Glib::RefPtr<Gtk::ActionGroup> processor_box_actions;
450         static Gtkmm2ext::Bindings* bindings;
451         static void register_actions();
452
453         typedef std::vector<boost::shared_ptr<ARDOUR::Processor> > ProcSelection;
454
455         static ProcSelection current_processor_selection ()
456         {
457                 ProcSelection ps;
458                 if (_current_processor_box) {
459                         _current_processor_box->get_selected_processors (ps);
460                 }
461                 return ps;
462         }
463
464 #ifndef NDEBUG
465         static bool show_all_processors;
466 #endif
467
468 private:
469         /* prevent copy construction */
470         ProcessorBox (ProcessorBox const &);
471
472         boost::shared_ptr<ARDOUR::Route>  _route;
473         MixerStrip*         _parent_strip; // null if in RouteParamsUI
474         bool                _owner_is_mixer;
475         bool                 ab_direction;
476         PBD::ScopedConnectionList _mixer_strip_connections;
477         PBD::ScopedConnectionList _route_connections;
478
479         boost::function<PluginSelector*()> _get_plugin_selector;
480
481         boost::shared_ptr<ARDOUR::Processor> _processor_being_created;
482
483         /** Index at which to place a new plugin (based on where the menu was opened), or -1 to
484          *  put at the end of the plugin list.
485          */
486         int _placement;
487
488         ProcessorSelection& _p_selection;
489         static Gtkmm2ext::ActionMap myactions;
490
491         static void load_bindings ();
492
493         void route_going_away ();
494
495         bool is_editor_mixer_strip() const;
496
497         Gtkmm2ext::DnDVBox<ProcessorEntry> processor_display;
498         Gtk::ScrolledWindow    processor_scroller;
499
500         boost::shared_ptr<ARDOUR::Processor> find_drop_position (ProcessorEntry* position);
501
502         void _drop_plugin_preset (Gtk::SelectionData const &, ARDOUR::Route::ProcessorList &);
503         void _drop_plugin (Gtk::SelectionData const &, ARDOUR::Route::ProcessorList &);
504
505         void plugin_drop (Gtk::SelectionData const &, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context);
506         void object_drop (Gtkmm2ext::DnDVBox<ProcessorEntry> *, ProcessorEntry *, Glib::RefPtr<Gdk::DragContext> const &);
507
508         Width _width;
509         bool  _redisplay_pending;
510
511         Gtk::Menu *processor_menu;
512         gint processor_menu_map_handler (GdkEventAny *ev);
513         Gtk::Menu * build_processor_menu ();
514         void show_processor_menu (int);
515         Gtk::Menu* build_possible_aux_menu();
516         Gtk::Menu* build_possible_listener_menu();
517         Gtk::Menu* build_possible_remove_listener_menu();
518
519         void choose_aux (boost::weak_ptr<ARDOUR::Route>);
520         void remove_aux (boost::weak_ptr<ARDOUR::Route>);
521         void choose_send ();
522         void send_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
523         void return_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
524         void choose_insert ();
525         void choose_plugin ();
526         bool use_plugins (const SelectedPlugins&);
527
528         bool no_processor_redisplay;
529
530         bool enter_notify (GdkEventCrossing *ev);
531         bool leave_notify (GdkEventCrossing *ev);
532         bool processor_button_press_event (GdkEventButton *, ProcessorEntry *);
533         bool processor_button_release_event (GdkEventButton *, ProcessorEntry *);
534         void redisplay_processors ();
535         void add_processor_to_display (boost::weak_ptr<ARDOUR::Processor>);
536         void reordered ();
537         void report_failed_reorder ();
538         void route_processors_changed (ARDOUR::RouteProcessorChange);
539         void processor_menu_unmapped ();
540
541         void processors_reordered (const Gtk::TreeModel::Path&, const Gtk::TreeModel::iterator&, int*);
542         void compute_processor_sort_keys ();
543
544         void ab_plugins ();
545
546         void cut_processors (const ProcSelection&);
547         void copy_processors (const ProcSelection&);
548         void delete_processors (const ProcSelection&);
549         void paste_processors ();
550         void paste_processors (boost::shared_ptr<ARDOUR::Processor> before);
551
552         void delete_dragged_processors (const std::list<boost::shared_ptr<ARDOUR::Processor> >&);
553         void clear_processors ();
554         void clear_processors (ARDOUR::Placement);
555         void rename_processors ();
556
557         void for_selected_processors (void (ProcessorBox::*pmf)(boost::shared_ptr<ARDOUR::Processor>));
558         void get_selected_processors (ProcSelection&) const;
559
560         void set_disk_io_position (ARDOUR::DiskIOPoint);
561
562         bool can_cut() const;
563         bool stub_processor_selected() const;
564
565         static Glib::RefPtr<Gtk::Action> cut_action;
566         static Glib::RefPtr<Gtk::Action> copy_action;
567         static Glib::RefPtr<Gtk::Action> paste_action;
568         static Glib::RefPtr<Gtk::Action> rename_action;
569         static Glib::RefPtr<Gtk::Action> delete_action;
570         static Glib::RefPtr<Gtk::Action> backspace_action;
571         static Glib::RefPtr<Gtk::Action> manage_pins_action;
572         static Glib::RefPtr<Gtk::Action> disk_io_action;
573         static Glib::RefPtr<Gtk::Action> edit_action;
574         static Glib::RefPtr<Gtk::Action> edit_generic_action;
575         void paste_processor_state (const XMLNodeList&, boost::shared_ptr<ARDOUR::Processor>);
576
577         void hide_processor_editor (boost::shared_ptr<ARDOUR::Processor>);
578         void rename_processor (boost::shared_ptr<ARDOUR::Processor>);
579
580         gint idle_delete_processor (boost::weak_ptr<ARDOUR::Processor>);
581
582         void weird_plugin_dialog (ARDOUR::Plugin& p, ARDOUR::Route::ProcessorStreams streams);
583
584         void setup_entry_positions ();
585
586         static ProcessorBox* _current_processor_box;
587
588         static void rb_choose_aux (boost::weak_ptr<ARDOUR::Route>);
589         static void rb_remove_aux (boost::weak_ptr<ARDOUR::Route>);
590         static void rb_choose_plugin ();
591         static void rb_choose_insert ();
592         static void rb_choose_send ();
593         static void rb_clear ();
594         static void rb_clear_pre ();
595         static void rb_clear_post ();
596         static void rb_cut ();
597         static void rb_copy ();
598         static void rb_paste ();
599         static void rb_delete ();
600         static void rb_rename ();
601         static void rb_select_all ();
602         static void rb_deselect_all ();
603         static void rb_activate_all ();
604         static void rb_deactivate_all ();
605         static void rb_ab_plugins ();
606         static void rb_manage_pins ();
607         static void rb_set_disk_io_position (ARDOUR::DiskIOPoint);
608         static void rb_edit ();
609         static void rb_edit_generic ();
610
611         void route_property_changed (const PBD::PropertyChange&);
612         std::string generate_processor_title (boost::shared_ptr<ARDOUR::PluginInsert> pi);
613
614         //typedef std::list<ProcessorWindowProxy*> ProcessorWindowProxies;
615         //ProcessorWindowProxies _processor_window_info;
616
617         ProcessorWindowProxy* find_window_proxy (boost::shared_ptr<ARDOUR::Processor>) const;
618
619         void set_processor_ui (boost::shared_ptr<ARDOUR::Processor>, Gtk::Window *);
620         void maybe_add_processor_to_ui_list (boost::weak_ptr<ARDOUR::Processor>);
621         void maybe_add_processor_pin_mgr (boost::weak_ptr<ARDOUR::Processor>);
622
623         bool one_processor_can_be_edited ();
624         bool processor_can_be_edited (boost::shared_ptr<ARDOUR::Processor>);
625
626         void mixer_strip_delivery_changed (boost::weak_ptr<ARDOUR::Delivery>);
627
628         XMLNode* entry_gui_object_state (ProcessorEntry *);
629         PBD::ScopedConnection amp_config_connection;
630 };
631
632 #endif /* __ardour_gtk_processor_box__ */