use running_from_source_tree()
[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/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"
40
41 #include "pbd/stateful.h"
42 #include "pbd/signals.h"
43
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"
52
53 #include "pbd/fastlog.h"
54
55 #include "plugin_interest.h"
56 #include "io_selector.h"
57 #include "send_ui.h"
58 #include "enums.h"
59 #include "ardour_button.h"
60 #include "window_manager.h"
61
62 class MotionController;
63 class PluginSelector;
64 class PluginUIWindow;
65 class RouteProcessorSelection;
66 class MixerStrip;
67
68 namespace ARDOUR {
69         class Connection;
70         class IO;
71         class Insert;
72         class Plugin;
73         class PluginInsert;
74         class PortInsert;
75         class Route;
76         class Session;
77 }
78
79 class ProcessorBox;
80
81 class ProcessorWindowProxy : public WM::ProxyBase
82 {
83   public:
84         ProcessorWindowProxy (std::string const &, ProcessorBox *, boost::weak_ptr<ARDOUR::Processor>);
85         ~ProcessorWindowProxy();
86
87         Gtk::Window* get (bool create = false);
88
89         boost::weak_ptr<ARDOUR::Processor> processor () const {
90                 return _processor;
91         }
92
93         ARDOUR::SessionHandlePtr* session_handle();
94         void show_the_right_window ();
95         void set_custom_ui_mode(bool use_custom) { want_custom = use_custom; }
96
97         int set_state (const XMLNode&, int);
98         XMLNode& get_state ();
99
100   private:
101         ProcessorBox* _processor_box;
102         boost::weak_ptr<ARDOUR::Processor> _processor;
103         bool is_custom;
104         bool want_custom;
105
106         void processor_going_away ();
107         PBD::ScopedConnection going_away_connection;
108 };
109
110
111 class PluginPinWindowProxy : public WM::ProxyBase
112 {
113   public:
114         PluginPinWindowProxy (std::string const &, boost::weak_ptr<ARDOUR::Processor>);
115         ~PluginPinWindowProxy();
116
117         Gtk::Window* get (bool create = false);
118         ARDOUR::SessionHandlePtr* session_handle();
119
120   private:
121         ProcessorBox* _processor_box;
122         boost::weak_ptr<ARDOUR::Processor> _processor;
123
124         void processor_going_away ();
125         PBD::ScopedConnection going_away_connection;
126 };
127
128
129
130 class ProcessorEntry : public Gtkmm2ext::DnDVBoxChild, public sigc::trackable
131 {
132 public:
133         ProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::Processor>, Width);
134         ~ProcessorEntry ();
135
136         Gtk::EventBox& action_widget ();
137         Gtk::Widget& widget ();
138         std::string drag_text () const;
139         void set_visual_state (Gtkmm2ext::VisualState, bool);
140
141         bool is_selectable() const {return _selectable;}
142         void set_selectable(bool s) { _selectable = s; }
143
144         bool drag_data_get (Glib::RefPtr<Gdk::DragContext> const, Gtk::SelectionData &);
145         bool can_copy_state (Gtkmm2ext::DnDVBoxChild*) const;
146
147         enum Position {
148                 PreFader,
149                 Fader,
150                 PostFader
151         };
152
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);
157
158         /** Hide any widgets that should be hidden */
159         virtual void hide_things ();
160
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 ();
168
169 protected:
170         ArdourButton _button;
171         Gtk::VBox _vbox;
172         Position _position;
173         uint32_t _position_num;
174         ProcessorBox* _parent;
175
176         virtual void setup_visuals ();
177
178 private:
179         bool _selectable;
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 ();
187
188         boost::shared_ptr<ARDOUR::Processor> _processor;
189         Width _width;
190         PBD::ScopedConnection active_connection;
191         PBD::ScopedConnection name_connection;
192         PBD::ScopedConnection config_connection;
193         ARDOUR::PluginPresetPtr _plugin_preset_pointer;
194
195         class Control : public sigc::trackable {
196         public:
197                 Control (boost::shared_ptr<ARDOUR::AutomationControl>, std::string const &);
198                 ~Control ();
199
200                 void set_visible (bool);
201                 void add_state (XMLNode *) const;
202                 void set_state (XMLNode const *);
203                 void hide_things ();
204
205                 bool visible () const {
206                         return _visible;
207                 }
208
209                 std::string name () const {
210                         return _name;
211                 }
212
213                 Gtk::Alignment box;
214
215         private:
216                 void slider_adjusted ();
217                 void button_clicked ();
218                 void button_clicked_event (GdkEventButton *);
219                 void control_changed ();
220                 std::string state_id () const;
221                 void set_tooltip ();
222
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;
232                 bool _visible;
233                 std::string _name;
234                 sigc::connection timer_connection;
235         };
236
237         std::list<Control*> _controls;
238
239         void toggle_inline_display_visibility ();
240         void toggle_control_visibility (Control *);
241         void toggle_panner_link ();
242
243         class PluginDisplay : public Gtk::DrawingArea {
244         public:
245                 PluginDisplay(boost::shared_ptr<ARDOUR::Plugin>, uint32_t max_height = 80);
246                 virtual ~PluginDisplay();
247         protected:
248                 bool on_expose_event (GdkEventExpose *);
249                 void on_size_request (Gtk::Requisition* req);
250
251                 void update_height_alloc (uint32_t inline_height);
252                 virtual uint32_t render_inline (cairo_t *, uint32_t width);
253
254                 boost::shared_ptr<ARDOUR::Plugin> _plug;
255                 PBD::ScopedConnection _qdraw_connection;
256                 cairo_surface_t* _surf;
257                 uint32_t _max_height;
258                 uint32_t _cur_height;
259                 bool _scroll;
260         };
261
262         class LuaPluginDisplay : public PluginDisplay {
263         public:
264                 LuaPluginDisplay(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                       RouteProcessorSelection&, 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 #ifndef NDEBUG
450         static bool show_all_processors;
451 #endif
452
453   private:
454         /* prevent copy construction */
455         ProcessorBox (ProcessorBox const &);
456
457         boost::shared_ptr<ARDOUR::Route>  _route;
458         MixerStrip*         _parent_strip; // null if in RouteParamsUI
459         bool                _owner_is_mixer;
460         bool                 ab_direction;
461         PBD::ScopedConnectionList _mixer_strip_connections;
462         PBD::ScopedConnectionList _route_connections;
463
464         boost::function<PluginSelector*()> _get_plugin_selector;
465
466         boost::shared_ptr<ARDOUR::Processor> _processor_being_created;
467
468         /** Index at which to place a new plugin (based on where the menu was opened), or -1 to
469          *  put at the end of the plugin list.
470          */
471         int _placement;
472         uint32_t                  _visible_prefader_processors;
473
474         RouteProcessorSelection& _rr_selection;
475         static Gtkmm2ext::ActionMap myactions;
476
477         static void load_bindings ();
478
479         void route_going_away ();
480
481         bool is_editor_mixer_strip() const;
482
483         Gtkmm2ext::DnDVBox<ProcessorEntry> processor_display;
484         Gtk::ScrolledWindow    processor_scroller;
485
486         boost::shared_ptr<ARDOUR::Processor> find_drop_position (ProcessorEntry* position);
487
488         void _drop_plugin_preset (Gtk::SelectionData const &, ARDOUR::Route::ProcessorList &);
489         void _drop_plugin (Gtk::SelectionData const &, ARDOUR::Route::ProcessorList &);
490
491         void plugin_drop (Gtk::SelectionData const &, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context);
492         void object_drop (Gtkmm2ext::DnDVBox<ProcessorEntry> *, ProcessorEntry *, Glib::RefPtr<Gdk::DragContext> const &);
493
494         Width _width;
495         bool  _redisplay_pending;
496
497         Gtk::Menu *processor_menu;
498         gint processor_menu_map_handler (GdkEventAny *ev);
499         Gtk::Menu * build_processor_menu ();
500         void show_processor_menu (int);
501         Gtk::Menu* build_possible_aux_menu();
502
503         void choose_aux (boost::weak_ptr<ARDOUR::Route>);
504         void choose_send ();
505         void send_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
506         void return_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
507         void choose_insert ();
508         void choose_plugin ();
509         bool use_plugins (const SelectedPlugins&);
510
511         bool no_processor_redisplay;
512
513         bool enter_notify (GdkEventCrossing *ev);
514         bool leave_notify (GdkEventCrossing *ev);
515         bool processor_button_press_event (GdkEventButton *, ProcessorEntry *);
516         bool processor_button_release_event (GdkEventButton *, ProcessorEntry *);
517         void redisplay_processors ();
518         void add_processor_to_display (boost::weak_ptr<ARDOUR::Processor>);
519         void help_count_visible_prefader_processors (boost::weak_ptr<ARDOUR::Processor>, uint32_t*, bool*);
520         void reordered ();
521         void report_failed_reorder ();
522         void route_processors_changed (ARDOUR::RouteProcessorChange);
523         void processor_menu_unmapped ();
524
525         void processors_reordered (const Gtk::TreeModel::Path&, const Gtk::TreeModel::iterator&, int*);
526         void compute_processor_sort_keys ();
527
528         void ab_plugins ();
529
530         typedef std::vector<boost::shared_ptr<ARDOUR::Processor> > ProcSelection;
531
532         void cut_processors (const ProcSelection&);
533         void copy_processors (const ProcSelection&);
534         void delete_processors (const ProcSelection&);
535         void paste_processors ();
536         void paste_processors (boost::shared_ptr<ARDOUR::Processor> before);
537
538         void delete_dragged_processors (const std::list<boost::shared_ptr<ARDOUR::Processor> >&);
539         void clear_processors ();
540         void clear_processors (ARDOUR::Placement);
541         void rename_processors ();
542
543         void for_selected_processors (void (ProcessorBox::*pmf)(boost::shared_ptr<ARDOUR::Processor>));
544         void get_selected_processors (ProcSelection&) const;
545
546         bool can_cut() const;
547         bool stub_processor_selected() const;
548
549         static Glib::RefPtr<Gtk::Action> cut_action;
550         static Glib::RefPtr<Gtk::Action> copy_action;
551         static Glib::RefPtr<Gtk::Action> paste_action;
552         static Glib::RefPtr<Gtk::Action> rename_action;
553         static Glib::RefPtr<Gtk::Action> delete_action;
554         static Glib::RefPtr<Gtk::Action> backspace_action;
555         static Glib::RefPtr<Gtk::Action> manage_pins_action;
556         static Glib::RefPtr<Gtk::Action> edit_action;
557         static Glib::RefPtr<Gtk::Action> edit_generic_action;
558         void paste_processor_state (const XMLNodeList&, boost::shared_ptr<ARDOUR::Processor>);
559
560         void hide_processor_editor (boost::shared_ptr<ARDOUR::Processor>);
561         void rename_processor (boost::shared_ptr<ARDOUR::Processor>);
562
563         gint idle_delete_processor (boost::weak_ptr<ARDOUR::Processor>);
564
565         void weird_plugin_dialog (ARDOUR::Plugin& p, ARDOUR::Route::ProcessorStreams streams);
566
567         void setup_entry_positions ();
568
569         static ProcessorBox* _current_processor_box;
570
571         static void rb_choose_aux (boost::weak_ptr<ARDOUR::Route>);
572         static void rb_choose_plugin ();
573         static void rb_choose_insert ();
574         static void rb_choose_send ();
575         static void rb_clear ();
576         static void rb_clear_pre ();
577         static void rb_clear_post ();
578         static void rb_cut ();
579         static void rb_copy ();
580         static void rb_paste ();
581         static void rb_delete ();
582         static void rb_rename ();
583         static void rb_select_all ();
584         static void rb_deselect_all ();
585         static void rb_activate_all ();
586         static void rb_deactivate_all ();
587         static void rb_ab_plugins ();
588         static void rb_manage_pins ();
589         static void rb_edit ();
590         static void rb_edit_generic ();
591
592         void route_property_changed (const PBD::PropertyChange&);
593         std::string generate_processor_title (boost::shared_ptr<ARDOUR::PluginInsert> pi);
594
595         //typedef std::list<ProcessorWindowProxy*> ProcessorWindowProxies;
596         //ProcessorWindowProxies _processor_window_info;
597
598         ProcessorWindowProxy* find_window_proxy (boost::shared_ptr<ARDOUR::Processor>) const;
599
600         void set_processor_ui (boost::shared_ptr<ARDOUR::Processor>, Gtk::Window *);
601         void maybe_add_processor_to_ui_list (boost::weak_ptr<ARDOUR::Processor>);
602         void maybe_add_processor_pin_mgr (boost::weak_ptr<ARDOUR::Processor>);
603
604         bool one_processor_can_be_edited ();
605         bool processor_can_be_edited (boost::shared_ptr<ARDOUR::Processor>);
606
607         void mixer_strip_delivery_changed (boost::weak_ptr<ARDOUR::Delivery>);
608
609         XMLNode* entry_gui_object_state (ProcessorEntry *);
610         PBD::ScopedConnection amp_config_connection;
611 };
612
613 #endif /* __ardour_gtk_processor_box__ */