Put plugin inline display into a freely available class ...
[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         ProcessorBox* _processor_box;
124         boost::weak_ptr<ARDOUR::Processor> _processor;
125
126         void processor_going_away ();
127         PBD::ScopedConnection going_away_connection;
128 };
129
130
131
132 class ProcessorEntry : public Gtkmm2ext::DnDVBoxChild, public sigc::trackable
133 {
134 public:
135         ProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::Processor>, Width);
136         ~ProcessorEntry ();
137
138         Gtk::EventBox& action_widget ();
139         Gtk::Widget& widget ();
140         std::string drag_text () const;
141         void set_visual_state (Gtkmm2ext::VisualState, bool);
142
143         bool is_selectable() const {return _selectable;}
144         void set_selectable(bool s) { _selectable = s; }
145
146         bool drag_data_get (Glib::RefPtr<Gdk::DragContext> const, Gtk::SelectionData &);
147         bool can_copy_state (Gtkmm2ext::DnDVBoxChild*) const;
148
149         enum Position {
150                 PreFader,
151                 Fader,
152                 PostFader
153         };
154
155         void set_position (Position, uint32_t);
156         bool unknown_processor () const { return _unknown_processor; } ;
157         boost::shared_ptr<ARDOUR::Processor> processor () const;
158         void set_enum_width (Width);
159
160         /** Hide any widgets that should be hidden */
161         virtual void hide_things ();
162
163         void toggle_inline_display_visibility ();
164         void show_all_controls ();
165         void hide_all_controls ();
166         void add_control_state (XMLNode *) const;
167         void set_control_state (XMLNode const *);
168         std::string state_id () const;
169         Gtk::Menu* build_controls_menu ();
170         Gtk::Menu* build_send_options_menu ();
171
172 protected:
173         ArdourWidgets::ArdourButton _button;
174         Gtk::VBox _vbox;
175         Position _position;
176         uint32_t _position_num;
177         ProcessorBox* _parent;
178
179         virtual void setup_visuals ();
180
181 private:
182         bool _selectable;
183         bool _unknown_processor;
184         void led_clicked(GdkEventButton *);
185         void processor_active_changed ();
186         void processor_property_changed (const PBD::PropertyChange&);
187         void processor_configuration_changed (const ARDOUR::ChanCount in, const ARDOUR::ChanCount out);
188         std::string name (Width) const;
189         void setup_tooltip ();
190
191         boost::shared_ptr<ARDOUR::Processor> _processor;
192         Width _width;
193         PBD::ScopedConnection active_connection;
194         PBD::ScopedConnection name_connection;
195         PBD::ScopedConnection config_connection;
196         ARDOUR::PluginPresetPtr _plugin_preset_pointer;
197
198         class Control : public sigc::trackable {
199         public:
200                 Control (boost::shared_ptr<ARDOUR::AutomationControl>, std::string const &);
201                 ~Control ();
202
203                 void set_visible (bool);
204                 void add_state (XMLNode *) const;
205                 void set_state (XMLNode const *);
206                 void hide_things ();
207
208                 bool visible () const {
209                         return _visible;
210                 }
211
212                 std::string name () const {
213                         return _name;
214                 }
215
216                 Gtk::Alignment box;
217
218         private:
219                 void slider_adjusted ();
220                 void button_clicked ();
221                 void button_clicked_event (GdkEventButton *);
222                 void control_changed ();
223                 void control_automation_state_changed ();
224                 std::string state_id () const;
225                 void set_tooltip ();
226
227                 void start_touch ();
228                 void end_touch ();
229
230                 boost::weak_ptr<ARDOUR::AutomationControl> _control;
231                 /* things for a slider */
232                 Gtk::Adjustment _adjustment;
233                 ArdourWidgets::HSliderController _slider;
234                 Gtkmm2ext::PersistentTooltip _slider_persistant_tooltip;
235                 /* things for a button */
236                 ArdourWidgets::ArdourButton _button;
237                 bool _ignore_ui_adjustment;
238                 PBD::ScopedConnectionList _connections;
239                 bool _visible;
240                 std::string _name;
241         };
242
243         std::list<Control*> _controls;
244
245         void toggle_control_visibility (Control *);
246         void toggle_panner_link ();
247         void toggle_allow_feedback ();
248
249         class PluginInlineDisplay : public PluginDisplay {
250         public:
251                 PluginInlineDisplay(ProcessorEntry&, boost::shared_ptr<ARDOUR::Plugin>, uint32_t max_height = 80);
252                 ~PluginInlineDisplay() {}
253         protected:
254                 void on_size_request (Gtk::Requisition* req);
255                 bool on_button_press_event (GdkEventButton *ev);
256                 void update_height_alloc (uint32_t inline_height);
257
258                 ProcessorEntry& _entry;
259                 bool _scroll;
260         };
261
262         class LuaPluginDisplay : public PluginInlineDisplay {
263         public:
264                 LuaPluginDisplay(ProcessorEntry&, boost::shared_ptr<ARDOUR::LuaProc>, uint32_t max_height = 80);
265                 ~LuaPluginDisplay();
266         protected:
267                 virtual uint32_t render_inline (cairo_t *, uint32_t width);
268         private:
269                 boost::shared_ptr<ARDOUR::LuaProc> _luaproc;
270                 LuaState lua_gui;
271                 luabridge::LuaRef * _lua_render_inline;
272         };
273
274         class PortIcon : public Gtk::DrawingArea {
275         public:
276                 PortIcon(bool input);
277                 void set_ports(ARDOUR::ChanCount const ports) { _ports = ports; }
278         private:
279                 bool on_expose_event (GdkEventExpose *);
280                 bool _input;
281                 ARDOUR::ChanCount _ports;
282         };
283
284         class RoutingIcon : public Gtk::DrawingArea {
285         public:
286                 RoutingIcon(bool inputrouting = true);
287                 void set (
288                                 const ARDOUR::ChanCount&,
289                                 const ARDOUR::ChanCount&,
290                                 const ARDOUR::ChanCount&,
291                                 const ARDOUR::ChanCount&,
292                                 const ARDOUR::ChanMapping&,
293                                 const ARDOUR::ChanMapping&,
294                                 const ARDOUR::ChanMapping&);
295                 void set_fed_by (
296                                 const ARDOUR::ChanCount&,
297                                 const ARDOUR::ChanCount&,
298                                 const ARDOUR::ChanMapping&,
299                                 const ARDOUR::ChanMapping&);
300
301                 void set_feeding (
302                                 const ARDOUR::ChanCount&,
303                                 const ARDOUR::ChanCount&,
304                                 const ARDOUR::ChanMapping&,
305                                 const ARDOUR::ChanMapping&);
306
307                 void set_terminal (bool b);
308
309                 void copy_state (const RoutingIcon& other) {
310                         _in         = other._in;
311                         _out        = other._out;
312                         _sources    = other._sources;
313                         _sinks      = other._sinks;
314                         _in_map     = other._in_map;
315                         _out_map    = other._out_map;
316                         _thru_map   = other._thru_map;
317                         _f_out      = other._f_out;
318                         _f_out_map  = other._f_out_map;
319                         _f_thru_map = other._f_thru_map;
320                         _f_sources  = other._f_sources;
321                         _i_in       = other._i_in;
322                         _i_in_map   = other._i_in_map;
323                         _i_thru_map = other._i_thru_map;
324                         _i_sinks    = other._i_sinks;
325                         _fed_by     = other._fed_by;
326                         _feeding    = other._feeding;
327                 }
328
329                 void unset_fed_by () { _fed_by  = false ; }
330                 void unset_feeding () { _feeding  = false ; }
331                 bool in_identity () const;
332                 bool out_identity () const;
333                 bool can_coalesce () const;
334
335                 static double pin_x_pos (uint32_t, double, uint32_t, uint32_t, bool);
336                 static void draw_connection (cairo_t*, double, double, double, double, bool, bool dashed = false);
337                 static void draw_gnd (cairo_t*, double, double, double, bool);
338                 static void draw_sidechain (cairo_t*, double, double, double, bool);
339                 static void draw_thru_src (cairo_t*, double, double, double, bool);
340                 static void draw_thru_sink (cairo_t*, double, double, double, bool);
341
342         private:
343                 bool on_expose_event (GdkEventExpose *);
344                 void expose_input_map (cairo_t*, const double, const double);
345                 void expose_coalesced_input_map (cairo_t*, const double, const double);
346                 void expose_output_map (cairo_t*, const double, const double);
347
348                 ARDOUR::ChanCount   _in;
349                 ARDOUR::ChanCount   _out;
350                 ARDOUR::ChanCount   _sources;
351                 ARDOUR::ChanCount   _sinks;
352                 ARDOUR::ChanMapping _in_map;
353                 ARDOUR::ChanMapping _out_map;
354                 ARDOUR::ChanMapping _thru_map;
355                 ARDOUR::ChanCount   _f_out;
356                 ARDOUR::ChanMapping _f_out_map;
357                 ARDOUR::ChanMapping _f_thru_map;
358                 ARDOUR::ChanCount   _f_sources;
359                 ARDOUR::ChanCount   _i_in;
360                 ARDOUR::ChanMapping _i_in_map;
361                 ARDOUR::ChanMapping _i_thru_map;
362                 ARDOUR::ChanCount   _i_sinks;
363                 bool _fed_by;
364                 bool _feeding;
365                 bool _input;
366                 bool _terminal;
367         };
368
369 public:
370         PortIcon input_icon;
371         PortIcon output_icon;
372         RoutingIcon routing_icon; // sits on top of every processor (input routing)
373         RoutingIcon output_routing_icon; // only used by last processor in the chain
374
375 protected:
376         PluginDisplay *_plugin_display ;
377 };
378
379 class PluginInsertProcessorEntry : public ProcessorEntry
380 {
381 public:
382         PluginInsertProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::PluginInsert>, Width);
383
384         void hide_things ();
385
386 private:
387         void iomap_changed ();
388         boost::shared_ptr<ARDOUR::PluginInsert> _plugin_insert;
389
390         PBD::ScopedConnectionList _iomap_connection;
391 };
392
393 class ProcessorBox : public Gtk::HBox, public PluginInterestedObject, public ARDOUR::SessionHandlePtr
394 {
395 public:
396         enum ProcessorOperation {
397                 ProcessorsCut,
398                 ProcessorsCopy,
399                 ProcessorsPaste,
400                 ProcessorsDelete,
401                 ProcessorsSelectAll,
402                 ProcessorsSelectNone,
403                 ProcessorsToggleActive,
404                 ProcessorsAB,
405         };
406
407         ProcessorBox (ARDOUR::Session*, boost::function<PluginSelector*()> get_plugin_selector,
408                       ProcessorSelection&, MixerStrip* parent, bool owner_is_mixer = false);
409         ~ProcessorBox ();
410
411         void set_route (boost::shared_ptr<ARDOUR::Route>);
412         void set_width (Width);
413
414         bool processor_operation (ProcessorOperation);
415
416         void select_all_processors ();
417         void deselect_all_processors ();
418         void select_all_plugins ();
419         void select_all_inserts ();
420         void select_all_sends ();
421
422         void all_visible_processors_active(bool state);
423         void setup_routing_feeds ();
424
425         void hide_things ();
426
427         bool edit_aux_send(boost::shared_ptr<ARDOUR::Processor>);
428
429         /* Everything except a WindowProxy object should use this to get the window */
430         Gtk::Window* get_processor_ui (boost::shared_ptr<ARDOUR::Processor>) const;
431
432         /* a WindowProxy object can use this */
433         Gtk::Window* get_editor_window (boost::shared_ptr<ARDOUR::Processor>, bool);
434         Gtk::Window* get_generic_editor_window (boost::shared_ptr<ARDOUR::Processor>);
435
436         void manage_pins (boost::shared_ptr<ARDOUR::Processor>);
437         void edit_processor (boost::shared_ptr<ARDOUR::Processor>);
438         void generic_edit_processor (boost::shared_ptr<ARDOUR::Processor>);
439
440         void update_gui_object_state (ProcessorEntry *);
441
442         sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorSelected;
443         sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorUnselected;
444
445         static Glib::RefPtr<Gtk::ActionGroup> processor_box_actions;
446         static Gtkmm2ext::Bindings* bindings;
447         static void register_actions();
448
449         typedef std::vector<boost::shared_ptr<ARDOUR::Processor> > ProcSelection;
450
451         static ProcSelection current_processor_selection ()
452         {
453                 ProcSelection ps;
454                 if (_current_processor_box) {
455                         _current_processor_box->get_selected_processors (ps);
456                 }
457                 return ps;
458         }
459
460 #ifndef NDEBUG
461         static bool show_all_processors;
462 #endif
463
464 private:
465         /* prevent copy construction */
466         ProcessorBox (ProcessorBox const &);
467
468         boost::shared_ptr<ARDOUR::Route>  _route;
469         MixerStrip*         _parent_strip; // null if in RouteParamsUI
470         bool                _owner_is_mixer;
471         bool                 ab_direction;
472         PBD::ScopedConnectionList _mixer_strip_connections;
473         PBD::ScopedConnectionList _route_connections;
474
475         boost::function<PluginSelector*()> _get_plugin_selector;
476
477         boost::shared_ptr<ARDOUR::Processor> _processor_being_created;
478
479         /** Index at which to place a new plugin (based on where the menu was opened), or -1 to
480          *  put at the end of the plugin list.
481          */
482         int _placement;
483
484         ProcessorSelection& _p_selection;
485         static Gtkmm2ext::ActionMap myactions;
486
487         static void load_bindings ();
488
489         void route_going_away ();
490
491         bool is_editor_mixer_strip() const;
492
493         Gtkmm2ext::DnDVBox<ProcessorEntry> processor_display;
494         Gtk::ScrolledWindow    processor_scroller;
495
496         boost::shared_ptr<ARDOUR::Processor> find_drop_position (ProcessorEntry* position);
497
498         void _drop_plugin_preset (Gtk::SelectionData const &, ARDOUR::Route::ProcessorList &);
499         void _drop_plugin (Gtk::SelectionData const &, ARDOUR::Route::ProcessorList &);
500
501         void plugin_drop (Gtk::SelectionData const &, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context);
502         void object_drop (Gtkmm2ext::DnDVBox<ProcessorEntry> *, ProcessorEntry *, Glib::RefPtr<Gdk::DragContext> const &);
503
504         Width _width;
505         bool  _redisplay_pending;
506
507         Gtk::Menu *processor_menu;
508         gint processor_menu_map_handler (GdkEventAny *ev);
509         Gtk::Menu * build_processor_menu ();
510         void show_processor_menu (int);
511         Gtk::Menu* build_possible_aux_menu();
512
513         void choose_aux (boost::weak_ptr<ARDOUR::Route>);
514         void choose_send ();
515         void send_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
516         void return_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
517         void choose_insert ();
518         void choose_plugin ();
519         bool use_plugins (const SelectedPlugins&);
520
521         bool no_processor_redisplay;
522
523         bool enter_notify (GdkEventCrossing *ev);
524         bool leave_notify (GdkEventCrossing *ev);
525         bool processor_button_press_event (GdkEventButton *, ProcessorEntry *);
526         bool processor_button_release_event (GdkEventButton *, ProcessorEntry *);
527         void redisplay_processors ();
528         void add_processor_to_display (boost::weak_ptr<ARDOUR::Processor>);
529         void reordered ();
530         void report_failed_reorder ();
531         void route_processors_changed (ARDOUR::RouteProcessorChange);
532         void processor_menu_unmapped ();
533
534         void processors_reordered (const Gtk::TreeModel::Path&, const Gtk::TreeModel::iterator&, int*);
535         void compute_processor_sort_keys ();
536
537         void ab_plugins ();
538
539         void cut_processors (const ProcSelection&);
540         void copy_processors (const ProcSelection&);
541         void delete_processors (const ProcSelection&);
542         void paste_processors ();
543         void paste_processors (boost::shared_ptr<ARDOUR::Processor> before);
544
545         void delete_dragged_processors (const std::list<boost::shared_ptr<ARDOUR::Processor> >&);
546         void clear_processors ();
547         void clear_processors (ARDOUR::Placement);
548         void rename_processors ();
549
550         void for_selected_processors (void (ProcessorBox::*pmf)(boost::shared_ptr<ARDOUR::Processor>));
551         void get_selected_processors (ProcSelection&) const;
552
553         bool can_cut() const;
554         bool stub_processor_selected() const;
555
556         static Glib::RefPtr<Gtk::Action> cut_action;
557         static Glib::RefPtr<Gtk::Action> copy_action;
558         static Glib::RefPtr<Gtk::Action> paste_action;
559         static Glib::RefPtr<Gtk::Action> rename_action;
560         static Glib::RefPtr<Gtk::Action> delete_action;
561         static Glib::RefPtr<Gtk::Action> backspace_action;
562         static Glib::RefPtr<Gtk::Action> manage_pins_action;
563         static Glib::RefPtr<Gtk::Action> edit_action;
564         static Glib::RefPtr<Gtk::Action> edit_generic_action;
565         void paste_processor_state (const XMLNodeList&, boost::shared_ptr<ARDOUR::Processor>);
566
567         void hide_processor_editor (boost::shared_ptr<ARDOUR::Processor>);
568         void rename_processor (boost::shared_ptr<ARDOUR::Processor>);
569
570         gint idle_delete_processor (boost::weak_ptr<ARDOUR::Processor>);
571
572         void weird_plugin_dialog (ARDOUR::Plugin& p, ARDOUR::Route::ProcessorStreams streams);
573
574         void setup_entry_positions ();
575
576         static ProcessorBox* _current_processor_box;
577
578         static void rb_choose_aux (boost::weak_ptr<ARDOUR::Route>);
579         static void rb_choose_plugin ();
580         static void rb_choose_insert ();
581         static void rb_choose_send ();
582         static void rb_clear ();
583         static void rb_clear_pre ();
584         static void rb_clear_post ();
585         static void rb_cut ();
586         static void rb_copy ();
587         static void rb_paste ();
588         static void rb_delete ();
589         static void rb_rename ();
590         static void rb_select_all ();
591         static void rb_deselect_all ();
592         static void rb_activate_all ();
593         static void rb_deactivate_all ();
594         static void rb_ab_plugins ();
595         static void rb_manage_pins ();
596         static void rb_edit ();
597         static void rb_edit_generic ();
598
599         void route_property_changed (const PBD::PropertyChange&);
600         std::string generate_processor_title (boost::shared_ptr<ARDOUR::PluginInsert> pi);
601
602         //typedef std::list<ProcessorWindowProxy*> ProcessorWindowProxies;
603         //ProcessorWindowProxies _processor_window_info;
604
605         ProcessorWindowProxy* find_window_proxy (boost::shared_ptr<ARDOUR::Processor>) const;
606
607         void set_processor_ui (boost::shared_ptr<ARDOUR::Processor>, Gtk::Window *);
608         void maybe_add_processor_to_ui_list (boost::weak_ptr<ARDOUR::Processor>);
609         void maybe_add_processor_pin_mgr (boost::weak_ptr<ARDOUR::Processor>);
610
611         bool one_processor_can_be_edited ();
612         bool processor_can_be_edited (boost::shared_ptr<ARDOUR::Processor>);
613
614         void mixer_strip_delivery_changed (boost::weak_ptr<ARDOUR::Delivery>);
615
616         XMLNode* entry_gui_object_state (ProcessorEntry *);
617         PBD::ScopedConnection amp_config_connection;
618 };
619
620 #endif /* __ardour_gtk_processor_box__ */