Separate Ardour UI widgets into dedicated library
[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 "widgets/ardour_button.h"
56
57 #include "plugin_interest.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                 boost::weak_ptr<ARDOUR::AutomationControl> _control;
228                 /* things for a slider */
229                 Gtk::Adjustment _adjustment;
230                 Gtkmm2ext::HSliderController _slider;
231                 Gtkmm2ext::PersistentTooltip _slider_persistant_tooltip;
232                 /* things for a button */
233                 ArdourWidgets::ArdourButton _button;
234                 bool _ignore_ui_adjustment;
235                 PBD::ScopedConnectionList _connections;
236                 bool _visible;
237                 std::string _name;
238         };
239
240         std::list<Control*> _controls;
241
242         void toggle_control_visibility (Control *);
243         void toggle_panner_link ();
244         void toggle_allow_feedback ();
245
246         class PluginDisplay : public Gtk::DrawingArea {
247         public:
248                 PluginDisplay(ProcessorEntry&, boost::shared_ptr<ARDOUR::Plugin>, uint32_t max_height = 80);
249                 virtual ~PluginDisplay();
250         protected:
251                 bool on_expose_event (GdkEventExpose *);
252                 void on_size_request (Gtk::Requisition* req);
253                 bool on_button_press_event (GdkEventButton *ev);
254                 bool on_button_release_event (GdkEventButton *ev);
255
256                 void plugin_going_away () {
257                         _qdraw_connection.disconnect ();
258                 }
259
260                 void update_height_alloc (uint32_t inline_height);
261                 virtual uint32_t render_inline (cairo_t *, uint32_t width);
262
263                 ProcessorEntry& _entry;
264                 boost::shared_ptr<ARDOUR::Plugin> _plug;
265                 PBD::ScopedConnection _qdraw_connection;
266                 PBD::ScopedConnection _death_connection;
267                 cairo_surface_t* _surf;
268                 uint32_t _max_height;
269                 uint32_t _cur_height;
270                 bool _scroll;
271         };
272
273         class LuaPluginDisplay : public PluginDisplay {
274         public:
275                 LuaPluginDisplay(ProcessorEntry&, boost::shared_ptr<ARDOUR::LuaProc>, uint32_t max_height = 80);
276                 ~LuaPluginDisplay();
277         protected:
278                 virtual uint32_t render_inline (cairo_t *, uint32_t width);
279         private:
280                 boost::shared_ptr<ARDOUR::LuaProc> _luaproc;
281                 LuaState lua_gui;
282                 luabridge::LuaRef * _lua_render_inline;
283         };
284
285         class PortIcon : public Gtk::DrawingArea {
286         public:
287                 PortIcon(bool input);
288                 void set_ports(ARDOUR::ChanCount const ports) { _ports = ports; }
289         private:
290                 bool on_expose_event (GdkEventExpose *);
291                 bool _input;
292                 ARDOUR::ChanCount _ports;
293         };
294
295         class RoutingIcon : public Gtk::DrawingArea {
296         public:
297                 RoutingIcon(bool inputrouting = true);
298                 void set (
299                                 const ARDOUR::ChanCount&,
300                                 const ARDOUR::ChanCount&,
301                                 const ARDOUR::ChanCount&,
302                                 const ARDOUR::ChanCount&,
303                                 const ARDOUR::ChanMapping&,
304                                 const ARDOUR::ChanMapping&,
305                                 const ARDOUR::ChanMapping&);
306                 void set_fed_by (
307                                 const ARDOUR::ChanCount&,
308                                 const ARDOUR::ChanCount&,
309                                 const ARDOUR::ChanMapping&,
310                                 const ARDOUR::ChanMapping&);
311
312                 void set_feeding (
313                                 const ARDOUR::ChanCount&,
314                                 const ARDOUR::ChanCount&,
315                                 const ARDOUR::ChanMapping&,
316                                 const ARDOUR::ChanMapping&);
317
318                 void set_terminal (bool b);
319
320                 void copy_state (const RoutingIcon& other) {
321                         _in         = other._in;
322                         _out        = other._out;
323                         _sources    = other._sources;
324                         _sinks      = other._sinks;
325                         _in_map     = other._in_map;
326                         _out_map    = other._out_map;
327                         _thru_map   = other._thru_map;
328                         _f_out      = other._f_out;
329                         _f_out_map  = other._f_out_map;
330                         _f_thru_map = other._f_thru_map;
331                         _f_sources  = other._f_sources;
332                         _i_in       = other._i_in;
333                         _i_in_map   = other._i_in_map;
334                         _i_thru_map = other._i_thru_map;
335                         _i_sinks    = other._i_sinks;
336                         _fed_by     = other._fed_by;
337                         _feeding    = other._feeding;
338                 }
339
340                 void unset_fed_by () { _fed_by  = false ; }
341                 void unset_feeding () { _feeding  = false ; }
342                 bool in_identity () const;
343                 bool out_identity () const;
344                 bool can_coalesce () const;
345
346                 static double pin_x_pos (uint32_t, double, uint32_t, uint32_t, bool);
347                 static void draw_connection (cairo_t*, double, double, double, double, bool, bool dashed = false);
348                 static void draw_gnd (cairo_t*, double, double, double, bool);
349                 static void draw_sidechain (cairo_t*, double, double, double, bool);
350                 static void draw_thru_src (cairo_t*, double, double, double, bool);
351                 static void draw_thru_sink (cairo_t*, double, double, double, bool);
352
353         private:
354                 bool on_expose_event (GdkEventExpose *);
355                 void expose_input_map (cairo_t*, const double, const double);
356                 void expose_coalesced_input_map (cairo_t*, const double, const double);
357                 void expose_output_map (cairo_t*, const double, const double);
358
359                 ARDOUR::ChanCount   _in;
360                 ARDOUR::ChanCount   _out;
361                 ARDOUR::ChanCount   _sources;
362                 ARDOUR::ChanCount   _sinks;
363                 ARDOUR::ChanMapping _in_map;
364                 ARDOUR::ChanMapping _out_map;
365                 ARDOUR::ChanMapping _thru_map;
366                 ARDOUR::ChanCount   _f_out;
367                 ARDOUR::ChanMapping _f_out_map;
368                 ARDOUR::ChanMapping _f_thru_map;
369                 ARDOUR::ChanCount   _f_sources;
370                 ARDOUR::ChanCount   _i_in;
371                 ARDOUR::ChanMapping _i_in_map;
372                 ARDOUR::ChanMapping _i_thru_map;
373                 ARDOUR::ChanCount   _i_sinks;
374                 bool _fed_by;
375                 bool _feeding;
376                 bool _input;
377                 bool _terminal;
378         };
379
380 public:
381         PortIcon input_icon;
382         PortIcon output_icon;
383         RoutingIcon routing_icon; // sits on top of every processor (input routing)
384         RoutingIcon output_routing_icon; // only used by last processor in the chain
385
386 protected:
387         PluginDisplay *_plugin_display ;
388 };
389
390 class PluginInsertProcessorEntry : public ProcessorEntry
391 {
392 public:
393         PluginInsertProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::PluginInsert>, Width);
394
395         void hide_things ();
396
397 private:
398         void iomap_changed ();
399         boost::shared_ptr<ARDOUR::PluginInsert> _plugin_insert;
400
401         PBD::ScopedConnectionList _iomap_connection;
402 };
403
404 class ProcessorBox : public Gtk::HBox, public PluginInterestedObject, public ARDOUR::SessionHandlePtr
405 {
406 public:
407         enum ProcessorOperation {
408                 ProcessorsCut,
409                 ProcessorsCopy,
410                 ProcessorsPaste,
411                 ProcessorsDelete,
412                 ProcessorsSelectAll,
413                 ProcessorsSelectNone,
414                 ProcessorsToggleActive,
415                 ProcessorsAB,
416         };
417
418         ProcessorBox (ARDOUR::Session*, boost::function<PluginSelector*()> get_plugin_selector,
419                       ProcessorSelection&, MixerStrip* parent, bool owner_is_mixer = false);
420         ~ProcessorBox ();
421
422         void set_route (boost::shared_ptr<ARDOUR::Route>);
423         void set_width (Width);
424
425         bool processor_operation (ProcessorOperation);
426
427         void select_all_processors ();
428         void deselect_all_processors ();
429         void select_all_plugins ();
430         void select_all_inserts ();
431         void select_all_sends ();
432
433         void all_visible_processors_active(bool state);
434         void setup_routing_feeds ();
435
436         void hide_things ();
437
438         bool edit_aux_send(boost::shared_ptr<ARDOUR::Processor>);
439
440         /* Everything except a WindowProxy object should use this to get the window */
441         Gtk::Window* get_processor_ui (boost::shared_ptr<ARDOUR::Processor>) const;
442
443         /* a WindowProxy object can use this */
444         Gtk::Window* get_editor_window (boost::shared_ptr<ARDOUR::Processor>, bool);
445         Gtk::Window* get_generic_editor_window (boost::shared_ptr<ARDOUR::Processor>);
446
447         void manage_pins (boost::shared_ptr<ARDOUR::Processor>);
448         void edit_processor (boost::shared_ptr<ARDOUR::Processor>);
449         void generic_edit_processor (boost::shared_ptr<ARDOUR::Processor>);
450
451         void update_gui_object_state (ProcessorEntry *);
452
453         sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorSelected;
454         sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorUnselected;
455
456         static Glib::RefPtr<Gtk::ActionGroup> processor_box_actions;
457         static Gtkmm2ext::Bindings* bindings;
458         static void register_actions();
459
460         typedef std::vector<boost::shared_ptr<ARDOUR::Processor> > ProcSelection;
461
462         static ProcSelection current_processor_selection ()
463         {
464                 ProcSelection ps;
465                 if (_current_processor_box) {
466                         _current_processor_box->get_selected_processors (ps);
467                 }
468                 return ps;
469         }
470
471 #ifndef NDEBUG
472         static bool show_all_processors;
473 #endif
474
475 private:
476         /* prevent copy construction */
477         ProcessorBox (ProcessorBox const &);
478
479         boost::shared_ptr<ARDOUR::Route>  _route;
480         MixerStrip*         _parent_strip; // null if in RouteParamsUI
481         bool                _owner_is_mixer;
482         bool                 ab_direction;
483         PBD::ScopedConnectionList _mixer_strip_connections;
484         PBD::ScopedConnectionList _route_connections;
485
486         boost::function<PluginSelector*()> _get_plugin_selector;
487
488         boost::shared_ptr<ARDOUR::Processor> _processor_being_created;
489
490         /** Index at which to place a new plugin (based on where the menu was opened), or -1 to
491          *  put at the end of the plugin list.
492          */
493         int _placement;
494
495         ProcessorSelection& _p_selection;
496         static Gtkmm2ext::ActionMap myactions;
497
498         static void load_bindings ();
499
500         void route_going_away ();
501
502         bool is_editor_mixer_strip() const;
503
504         Gtkmm2ext::DnDVBox<ProcessorEntry> processor_display;
505         Gtk::ScrolledWindow    processor_scroller;
506
507         boost::shared_ptr<ARDOUR::Processor> find_drop_position (ProcessorEntry* position);
508
509         void _drop_plugin_preset (Gtk::SelectionData const &, ARDOUR::Route::ProcessorList &);
510         void _drop_plugin (Gtk::SelectionData const &, ARDOUR::Route::ProcessorList &);
511
512         void plugin_drop (Gtk::SelectionData const &, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context);
513         void object_drop (Gtkmm2ext::DnDVBox<ProcessorEntry> *, ProcessorEntry *, Glib::RefPtr<Gdk::DragContext> const &);
514
515         Width _width;
516         bool  _redisplay_pending;
517
518         Gtk::Menu *processor_menu;
519         gint processor_menu_map_handler (GdkEventAny *ev);
520         Gtk::Menu * build_processor_menu ();
521         void show_processor_menu (int);
522         Gtk::Menu* build_possible_aux_menu();
523
524         void choose_aux (boost::weak_ptr<ARDOUR::Route>);
525         void choose_send ();
526         void send_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
527         void return_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
528         void choose_insert ();
529         void choose_plugin ();
530         bool use_plugins (const SelectedPlugins&);
531
532         bool no_processor_redisplay;
533
534         bool enter_notify (GdkEventCrossing *ev);
535         bool leave_notify (GdkEventCrossing *ev);
536         bool processor_button_press_event (GdkEventButton *, ProcessorEntry *);
537         bool processor_button_release_event (GdkEventButton *, ProcessorEntry *);
538         void redisplay_processors ();
539         void add_processor_to_display (boost::weak_ptr<ARDOUR::Processor>);
540         void reordered ();
541         void report_failed_reorder ();
542         void route_processors_changed (ARDOUR::RouteProcessorChange);
543         void processor_menu_unmapped ();
544
545         void processors_reordered (const Gtk::TreeModel::Path&, const Gtk::TreeModel::iterator&, int*);
546         void compute_processor_sort_keys ();
547
548         void ab_plugins ();
549
550         void cut_processors (const ProcSelection&);
551         void copy_processors (const ProcSelection&);
552         void delete_processors (const ProcSelection&);
553         void paste_processors ();
554         void paste_processors (boost::shared_ptr<ARDOUR::Processor> before);
555
556         void delete_dragged_processors (const std::list<boost::shared_ptr<ARDOUR::Processor> >&);
557         void clear_processors ();
558         void clear_processors (ARDOUR::Placement);
559         void rename_processors ();
560
561         void for_selected_processors (void (ProcessorBox::*pmf)(boost::shared_ptr<ARDOUR::Processor>));
562         void get_selected_processors (ProcSelection&) const;
563
564         bool can_cut() const;
565         bool stub_processor_selected() const;
566
567         static Glib::RefPtr<Gtk::Action> cut_action;
568         static Glib::RefPtr<Gtk::Action> copy_action;
569         static Glib::RefPtr<Gtk::Action> paste_action;
570         static Glib::RefPtr<Gtk::Action> rename_action;
571         static Glib::RefPtr<Gtk::Action> delete_action;
572         static Glib::RefPtr<Gtk::Action> backspace_action;
573         static Glib::RefPtr<Gtk::Action> manage_pins_action;
574         static Glib::RefPtr<Gtk::Action> edit_action;
575         static Glib::RefPtr<Gtk::Action> edit_generic_action;
576         void paste_processor_state (const XMLNodeList&, boost::shared_ptr<ARDOUR::Processor>);
577
578         void hide_processor_editor (boost::shared_ptr<ARDOUR::Processor>);
579         void rename_processor (boost::shared_ptr<ARDOUR::Processor>);
580
581         gint idle_delete_processor (boost::weak_ptr<ARDOUR::Processor>);
582
583         void weird_plugin_dialog (ARDOUR::Plugin& p, ARDOUR::Route::ProcessorStreams streams);
584
585         void setup_entry_positions ();
586
587         static ProcessorBox* _current_processor_box;
588
589         static void rb_choose_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_edit ();
608         static void rb_edit_generic ();
609
610         void route_property_changed (const PBD::PropertyChange&);
611         std::string generate_processor_title (boost::shared_ptr<ARDOUR::PluginInsert> pi);
612
613         //typedef std::list<ProcessorWindowProxy*> ProcessorWindowProxies;
614         //ProcessorWindowProxies _processor_window_info;
615
616         ProcessorWindowProxy* find_window_proxy (boost::shared_ptr<ARDOUR::Processor>) const;
617
618         void set_processor_ui (boost::shared_ptr<ARDOUR::Processor>, Gtk::Window *);
619         void maybe_add_processor_to_ui_list (boost::weak_ptr<ARDOUR::Processor>);
620         void maybe_add_processor_pin_mgr (boost::weak_ptr<ARDOUR::Processor>);
621
622         bool one_processor_can_be_edited ();
623         bool processor_can_be_edited (boost::shared_ptr<ARDOUR::Processor>);
624
625         void mixer_strip_delivery_changed (boost::weak_ptr<ARDOUR::Delivery>);
626
627         XMLNode* entry_gui_object_state (ProcessorEntry *);
628         PBD::ScopedConnection amp_config_connection;
629 };
630
631 #endif /* __ardour_gtk_processor_box__ */