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