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