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                 ~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                 void set_feed (
 295                                 const ARDOUR::ChanCount&,
 296                                 const ARDOUR::ChanCount&,
 297                                 const ARDOUR::ChanMapping&);
 298
 299                 void copy_state (const RoutingIcon& other) {
 300                         _in        = other._in;
 301                         _out       = other._out;
 302                         _sources   = other._sources;
 303                         _sinks     = other._sinks;
 304                         _in_map    = other._in_map;
 305                         _out_map   = other._out_map;
 306                         _f_out     = other._f_out;
 307                         _f_out_map = other._f_out_map;
 308                         _f_sources = other._f_sources;
 309                         _feed      = other._feed;
 310                 }
 311
 312                 void unset_feed () { _feed  = false ; }
 313                 bool identity () const;
 314                 bool out_identity () const;
 315
 316                 static double pin_x_pos (uint32_t, double, uint32_t, uint32_t, bool);
 317                 static void draw_connection (cairo_t*, double, double, double, double, bool, bool dashed = false);
 318                 static void draw_gnd (cairo_t*, double, double, bool);
 319                 static void draw_X (cairo_t*, double, double, bool);
 320                 static void draw_sidechain (cairo_t*, double, double, bool);
 321
 322         private:
 323                 bool on_expose_event (GdkEventExpose *);
 324                 void expose_input_map (cairo_t*, const double, const double);
 325                 void expose_output_map (cairo_t*, const double, const double);
 326
 327                 ARDOUR::ChanCount   _in;
 328                 ARDOUR::ChanCount   _out;
 329                 ARDOUR::ChanCount   _sources;
 330                 ARDOUR::ChanCount   _sinks;
 331                 ARDOUR::ChanMapping _in_map;
 332                 ARDOUR::ChanMapping _out_map;
 333                 ARDOUR::ChanCount   _f_out;
 334                 ARDOUR::ChanMapping _f_out_map;
 335                 ARDOUR::ChanCount   _f_sources;
 336                 bool _feed;
 337                 bool _input;
 338         };
 339
 340 public:
 341         PortIcon input_icon;
 342         PortIcon output_icon;
 343         RoutingIcon routing_icon; // sits on top of every processor (input routing)
 344         RoutingIcon output_routing_icon; // only used by last processor in the chain
 345
 346 protected:
 347         PluginDisplay *_plugin_display ;
 348 };
 349
 350 class PluginInsertProcessorEntry : public ProcessorEntry
 351 {
 352 public:
 353         PluginInsertProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::PluginInsert>, Width);
 354
 355         void hide_things ();
 356
 357 private:
 358         void iomap_changed ();
 359         boost::shared_ptr<ARDOUR::PluginInsert> _plugin_insert;
 360
 361         PBD::ScopedConnectionList _iomap_connection;
 362 };
 363
 364 class ProcessorBox : public Gtk::HBox, public PluginInterestedObject, public ARDOUR::SessionHandlePtr
 365 {
 366   public:
 367         enum ProcessorOperation {
 368                 ProcessorsCut,
 369                 ProcessorsCopy,
 370                 ProcessorsPaste,
 371                 ProcessorsDelete,
 372                 ProcessorsSelectAll,
 373                 ProcessorsSelectNone,
 374                 ProcessorsToggleActive,
 375                 ProcessorsAB,
 376         };
 377
 378         ProcessorBox (ARDOUR::Session*, boost::function<PluginSelector*()> get_plugin_selector,
 379                       RouteProcessorSelection&, MixerStrip* parent, bool owner_is_mixer = false);
 380         ~ProcessorBox ();
 381
 382         void set_route (boost::shared_ptr<ARDOUR::Route>);
 383         void set_width (Width);
 384
 385         bool processor_operation (ProcessorOperation);
 386
 387         void select_all_processors ();
 388         void deselect_all_processors ();
 389         void select_all_plugins ();
 390         void select_all_inserts ();
 391         void select_all_sends ();
 392
 393         void all_visible_processors_active(bool state);
 394         void setup_routing_feeds ();
 395
 396         void hide_things ();
 397
 398         bool edit_aux_send(boost::shared_ptr<ARDOUR::Processor>);
 399
 400         /* Everything except a WindowProxy object should use this to get the window */
 401         Gtk::Window* get_processor_ui (boost::shared_ptr<ARDOUR::Processor>) const;
 402
 403         /* a WindowProxy object can use this */
 404         Gtk::Window* get_editor_window (boost::shared_ptr<ARDOUR::Processor>, bool);
 405         Gtk::Window* get_generic_editor_window (boost::shared_ptr<ARDOUR::Processor>);
 406
 407         void manage_pins (boost::shared_ptr<ARDOUR::Processor>);
 408         void edit_processor (boost::shared_ptr<ARDOUR::Processor>);
 409         void generic_edit_processor (boost::shared_ptr<ARDOUR::Processor>);
 410
 411         void update_gui_object_state (ProcessorEntry *);
 412
 413         sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorSelected;
 414         sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorUnselected;
 415
 416         static Glib::RefPtr<Gtk::ActionGroup> processor_box_actions;
 417         static Gtkmm2ext::Bindings* bindings;
 418         static void register_actions();
 419
 420 #ifndef NDEBUG
 421         static bool show_all_processors;
 422 #endif
 423
 424   private:
 425         /* prevent copy construction */
 426         ProcessorBox (ProcessorBox const &);
 427
 428         boost::shared_ptr<ARDOUR::Route>  _route;
 429         MixerStrip*         _parent_strip; // null if in RouteParamsUI
 430         bool                _owner_is_mixer;
 431         bool                 ab_direction;
 432         PBD::ScopedConnectionList _mixer_strip_connections;
 433         PBD::ScopedConnectionList _route_connections;
 434
 435         boost::function<PluginSelector*()> _get_plugin_selector;
 436
 437         boost::shared_ptr<ARDOUR::Processor> _processor_being_created;
 438
 439         /** Index at which to place a new plugin (based on where the menu was opened), or -1 to
 440          *  put at the end of the plugin list.
 441          */
 442         int _placement;
 443         uint32_t                  _visible_prefader_processors;
 444
 445         RouteProcessorSelection& _rr_selection;
 446         static Gtkmm2ext::ActionMap myactions;
 447
 448         static void load_bindings ();
 449
 450         void route_going_away ();
 451
 452         bool is_editor_mixer_strip() const;
 453
 454         Gtkmm2ext::DnDVBox<ProcessorEntry> processor_display;
 455         Gtk::ScrolledWindow    processor_scroller;
 456
 457         boost::shared_ptr<ARDOUR::Processor> find_drop_position (ProcessorEntry* position);
 458
 459         void _drop_plugin_preset (Gtk::SelectionData const &, ARDOUR::Route::ProcessorList &);
 460         void _drop_plugin (Gtk::SelectionData const &, ARDOUR::Route::ProcessorList &);
 461
 462         void plugin_drop (Gtk::SelectionData const &, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context);
 463         void object_drop (Gtkmm2ext::DnDVBox<ProcessorEntry> *, ProcessorEntry *, Glib::RefPtr<Gdk::DragContext> const &);
 464
 465         Width _width;
 466         bool  _redisplay_pending;
 467
 468         Gtk::Menu *processor_menu;
 469         gint processor_menu_map_handler (GdkEventAny *ev);
 470         Gtk::Menu * build_processor_menu ();
 471         void show_processor_menu (int);
 472         Gtk::Menu* build_possible_aux_menu();
 473
 474         void choose_aux (boost::weak_ptr<ARDOUR::Route>);
 475         void choose_send ();
 476         void send_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
 477         void return_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
 478         void choose_insert ();
 479         void choose_plugin ();
 480         bool choose_lua ();
 481         bool use_plugins (const SelectedPlugins&);
 482
 483         bool no_processor_redisplay;
 484
 485         bool enter_notify (GdkEventCrossing *ev);
 486         bool leave_notify (GdkEventCrossing *ev);
 487         bool processor_button_press_event (GdkEventButton *, ProcessorEntry *);
 488         bool processor_button_release_event (GdkEventButton *, ProcessorEntry *);
 489         void redisplay_processors ();
 490         void add_processor_to_display (boost::weak_ptr<ARDOUR::Processor>);
 491         void help_count_visible_prefader_processors (boost::weak_ptr<ARDOUR::Processor>, uint32_t*, bool*);
 492         void reordered ();
 493         void report_failed_reorder ();
 494         void route_processors_changed (ARDOUR::RouteProcessorChange);
 495         void processor_menu_unmapped ();
 496
 497         void processors_reordered (const Gtk::TreeModel::Path&, const Gtk::TreeModel::iterator&, int*);
 498         void compute_processor_sort_keys ();
 499
 500         void ab_plugins ();
 501
 502         typedef std::vector<boost::shared_ptr<ARDOUR::Processor> > ProcSelection;
 503
 504         void cut_processors (const ProcSelection&);
 505         void copy_processors (const ProcSelection&);
 506         void delete_processors (const ProcSelection&);
 507         void paste_processors ();
 508         void paste_processors (boost::shared_ptr<ARDOUR::Processor> before);
 509
 510         void delete_dragged_processors (const std::list<boost::shared_ptr<ARDOUR::Processor> >&);
 511         void clear_processors ();
 512         void clear_processors (ARDOUR::Placement);
 513         void rename_processors ();
 514
 515         void for_selected_processors (void (ProcessorBox::*pmf)(boost::shared_ptr<ARDOUR::Processor>));
 516         void get_selected_processors (ProcSelection&) const;
 517
 518         bool can_cut() const;
 519         bool stub_processor_selected() const;
 520
 521         static Glib::RefPtr<Gtk::Action> cut_action;
 522         static Glib::RefPtr<Gtk::Action> copy_action;
 523         static Glib::RefPtr<Gtk::Action> paste_action;
 524         static Glib::RefPtr<Gtk::Action> rename_action;
 525         static Glib::RefPtr<Gtk::Action> delete_action;
 526         static Glib::RefPtr<Gtk::Action> manage_pins_action;
 527         static Glib::RefPtr<Gtk::Action> edit_action;
 528         static Glib::RefPtr<Gtk::Action> edit_generic_action;
 529         void paste_processor_state (const XMLNodeList&, boost::shared_ptr<ARDOUR::Processor>);
 530
 531         void hide_processor_editor (boost::shared_ptr<ARDOUR::Processor>);
 532         void rename_processor (boost::shared_ptr<ARDOUR::Processor>);
 533
 534         gint idle_delete_processor (boost::weak_ptr<ARDOUR::Processor>);
 535
 536         void weird_plugin_dialog (ARDOUR::Plugin& p, ARDOUR::Route::ProcessorStreams streams);
 537
 538         void setup_entry_positions ();
 539
 540         static ProcessorBox* _current_processor_box;
 541
 542         static void rb_choose_aux (boost::weak_ptr<ARDOUR::Route>);
 543         static void rb_choose_plugin ();
 544         static void rb_choose_insert ();
 545         static void rb_choose_lua ();
 546         static void rb_choose_send ();
 547         static void rb_clear ();
 548         static void rb_clear_pre ();
 549         static void rb_clear_post ();
 550         static void rb_cut ();
 551         static void rb_copy ();
 552         static void rb_paste ();
 553         static void rb_delete ();
 554         static void rb_rename ();
 555         static void rb_select_all ();
 556         static void rb_deselect_all ();
 557         static void rb_activate_all ();
 558         static void rb_deactivate_all ();
 559         static void rb_ab_plugins ();
 560         static void rb_manage_pins ();
 561         static void rb_edit ();
 562         static void rb_edit_generic ();
 563
 564         void route_property_changed (const PBD::PropertyChange&);
 565         std::string generate_processor_title (boost::shared_ptr<ARDOUR::PluginInsert> pi);
 566
 567         //typedef std::list<ProcessorWindowProxy*> ProcessorWindowProxies;
 568         //ProcessorWindowProxies _processor_window_info;
 569
 570         ProcessorWindowProxy* find_window_proxy (boost::shared_ptr<ARDOUR::Processor>) const;
 571
 572         void set_processor_ui (boost::shared_ptr<ARDOUR::Processor>, Gtk::Window *);
 573         void maybe_add_processor_to_ui_list (boost::weak_ptr<ARDOUR::Processor>);
 574         void maybe_add_processor_pin_mgr (boost::weak_ptr<ARDOUR::Processor>);
 575
 576         bool one_processor_can_be_edited ();
 577         bool processor_can_be_edited (boost::shared_ptr<ARDOUR::Processor>);
 578
 579         void mixer_strip_delivery_changed (boost::weak_ptr<ARDOUR::Delivery>);
 580
 581         XMLNode* entry_gui_object_state (ProcessorEntry *);
 582         PBD::ScopedConnection amp_config_connection;
 583 };
 584
 585 #endif /* __ardour_gtk_processor_box__ */