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         bool _valid;
 106
 107         void processor_going_away ();
 108         PBD::ScopedConnection going_away_connection;
 109 };
 110
 111 class ProcessorEntry : public Gtkmm2ext::DnDVBoxChild, public sigc::trackable
 112 {
 113 public:
 114         ProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::Processor>, Width);
 115         ~ProcessorEntry ();
 116
 117         Gtk::EventBox& action_widget ();
 118         Gtk::Widget& widget ();
 119         std::string drag_text () const;
 120         void set_visual_state (Gtkmm2ext::VisualState, bool);
 121
 122         bool is_selectable() const {return _selectable;}
 123         void set_selectable(bool s) { _selectable = s; }
 124
 125         bool drag_data_get (Glib::RefPtr<Gdk::DragContext> const, Gtk::SelectionData &);
 126         bool can_copy_state (Gtkmm2ext::DnDVBoxChild*) const;
 127
 128         enum Position {
 129                 PreFader,
 130                 Fader,
 131                 PostFader
 132         };
 133
 134         void set_position (Position, uint32_t);
 135         bool unknown_processor () const { return _unknown_processor; } ;
 136         boost::shared_ptr<ARDOUR::Processor> processor () const;
 137         void set_enum_width (Width);
 138
 139         /** Hide any widgets that should be hidden */
 140         virtual void hide_things ();
 141
 142         void show_all_controls ();
 143         void hide_all_controls ();
 144         void add_control_state (XMLNode *) const;
 145         void set_control_state (XMLNode const *);
 146         std::string state_id () const;
 147         Gtk::Menu* build_controls_menu ();
 148         Gtk::Menu* build_send_options_menu ();
 149
 150 protected:
 151         ArdourButton _button;
 152         Gtk::VBox _vbox;
 153         Position _position;
 154         uint32_t _position_num;
 155
 156         virtual void setup_visuals ();
 157
 158 private:
 159         bool _selectable;
 160         bool _unknown_processor;
 161         void led_clicked(GdkEventButton *);
 162         void processor_active_changed ();
 163         void processor_property_changed (const PBD::PropertyChange&);
 164         void processor_configuration_changed (const ARDOUR::ChanCount in, const ARDOUR::ChanCount out);
 165         std::string name (Width) const;
 166         void setup_tooltip ();
 167
 168         ProcessorBox* _parent;
 169         boost::shared_ptr<ARDOUR::Processor> _processor;
 170         Width _width;
 171         PBD::ScopedConnection active_connection;
 172         PBD::ScopedConnection name_connection;
 173         PBD::ScopedConnection config_connection;
 174         ARDOUR::PluginPresetPtr _plugin_preset_pointer;
 175
 176         class Control : public sigc::trackable {
 177         public:
 178                 Control (boost::shared_ptr<ARDOUR::AutomationControl>, std::string const &);
 179                 ~Control ();
 180
 181                 void set_visible (bool);
 182                 void add_state (XMLNode *) const;
 183                 void set_state (XMLNode const *);
 184                 void hide_things ();
 185
 186                 bool visible () const {
 187                         return _visible;
 188                 }
 189
 190                 std::string name () const {
 191                         return _name;
 192                 }
 193
 194                 Gtk::Alignment box;
 195
 196         private:
 197                 void slider_adjusted ();
 198                 void button_clicked ();
 199                 void button_clicked_event (GdkEventButton *);
 200                 void control_changed ();
 201                 std::string state_id () const;
 202                 void set_tooltip ();
 203
 204                 boost::weak_ptr<ARDOUR::AutomationControl> _control;
 205                 /* things for a slider */
 206                 Gtk::Adjustment _adjustment;
 207                 Gtkmm2ext::HSliderController _slider;
 208                 Gtkmm2ext::PersistentTooltip _slider_persistant_tooltip;
 209                 /* things for a button */
 210                 ArdourButton _button;
 211                 bool _ignore_ui_adjustment;
 212                 PBD::ScopedConnection _connection;
 213                 bool _visible;
 214                 std::string _name;
 215                 sigc::connection timer_connection;
 216         };
 217
 218         std::list<Control*> _controls;
 219
 220         void toggle_inline_display_visibility ();
 221         void toggle_control_visibility (Control *);
 222         void toggle_panner_link ();
 223
 224         class PluginDisplay : public Gtk::DrawingArea {
 225         public:
 226                 PluginDisplay(boost::shared_ptr<ARDOUR::Plugin>, uint32_t max_height = 80);
 227                 ~PluginDisplay();
 228         protected:
 229                 bool on_expose_event (GdkEventExpose *);
 230                 void on_size_request (Gtk::Requisition* req);
 231
 232                 void update_height_alloc (uint32_t inline_height);
 233                 virtual uint32_t render_inline (cairo_t *, uint32_t width);
 234
 235                 boost::shared_ptr<ARDOUR::Plugin> _plug;
 236                 PBD::ScopedConnection _qdraw_connection;
 237                 cairo_surface_t* _surf;
 238                 uint32_t _max_height;
 239                 uint32_t _cur_height;
 240                 bool _scroll;
 241         };
 242
 243         class LuaPluginDisplay : public PluginDisplay {
 244         public:
 245                 LuaPluginDisplay(boost::shared_ptr<ARDOUR::LuaProc>, uint32_t max_height = 80);
 246                 ~LuaPluginDisplay();
 247         protected:
 248                 virtual uint32_t render_inline (cairo_t *, uint32_t width);
 249         private:
 250                 boost::shared_ptr<ARDOUR::LuaProc> _luaproc;
 251                 LuaState lua_gui;
 252                 luabridge::LuaRef * _lua_render_inline;
 253         };
 254
 255         class PortIcon : public Gtk::DrawingArea {
 256         public:
 257                 PortIcon(bool input);
 258                 void set_ports(ARDOUR::ChanCount const ports) { _ports = ports; }
 259         private:
 260                 bool on_expose_event (GdkEventExpose *);
 261                 bool _input;
 262                 ARDOUR::ChanCount _ports;
 263         };
 264
 265         class RoutingIcon : public Gtk::DrawingArea {
 266         public:
 267                 RoutingIcon() {
 268                         _sources = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
 269                         _sinks = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
 270                         _splitting = false;
 271                         set_size_request (-1, 4);
 272                 }
 273                 void set_sources(ARDOUR::ChanCount const sources) { _sources = sources; }
 274                 void set_sinks(ARDOUR::ChanCount const sinks) { _sinks = sinks; }
 275                 void set_splitting(const bool splitting) { _splitting = splitting; }
 276         private:
 277                 bool on_expose_event (GdkEventExpose *);
 278                 /* the wire icon sits on top of every processor if needed */
 279                 ARDOUR::ChanCount _sources; // signals available (valid outputs from prev. processor)
 280                 ARDOUR::ChanCount _sinks;   // actual inputs of this processor
 281                 bool _splitting;
 282         };
 283
 284 protected:
 285         RoutingIcon _routing_icon;
 286         PortIcon _input_icon;
 287         PortIcon _output_icon;
 288         PluginDisplay *_plugin_display ;
 289 };
 290
 291 class PluginInsertProcessorEntry : public ProcessorEntry
 292 {
 293 public:
 294         PluginInsertProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::PluginInsert>, Width);
 295
 296         void hide_things ();
 297
 298 private:
 299         void plugin_insert_splitting_changed ();
 300         boost::shared_ptr<ARDOUR::PluginInsert> _plugin_insert;
 301
 302         PBD::ScopedConnection _splitting_connection;
 303 };
 304
 305 class ProcessorBox : public Gtk::HBox, public PluginInterestedObject, public ARDOUR::SessionHandlePtr
 306 {
 307   public:
 308         enum ProcessorOperation {
 309                 ProcessorsCut,
 310                 ProcessorsCopy,
 311                 ProcessorsPaste,
 312                 ProcessorsDelete,
 313                 ProcessorsSelectAll,
 314                 ProcessorsSelectNone,
 315                 ProcessorsToggleActive,
 316                 ProcessorsAB,
 317         };
 318
 319         ProcessorBox (ARDOUR::Session*, boost::function<PluginSelector*()> get_plugin_selector,
 320                       RouteProcessorSelection&, MixerStrip* parent, bool owner_is_mixer = false);
 321         ~ProcessorBox ();
 322
 323         void set_route (boost::shared_ptr<ARDOUR::Route>);
 324         void set_width (Width);
 325
 326         bool processor_operation (ProcessorOperation);
 327
 328         void select_all_processors ();
 329         void deselect_all_processors ();
 330         void select_all_plugins ();
 331         void select_all_inserts ();
 332         void select_all_sends ();
 333
 334         void all_visible_processors_active(bool state);
 335
 336         void hide_things ();
 337
 338         bool edit_aux_send(boost::shared_ptr<ARDOUR::Processor>);
 339
 340         /* Everything except a WindowProxy object should use this to get the window */
 341         Gtk::Window* get_processor_ui (boost::shared_ptr<ARDOUR::Processor>) const;
 342
 343         /* a WindowProxy object can use this */
 344         Gtk::Window* get_editor_window (boost::shared_ptr<ARDOUR::Processor>, bool);
 345         Gtk::Window* get_generic_editor_window (boost::shared_ptr<ARDOUR::Processor>);
 346
 347         void edit_processor (boost::shared_ptr<ARDOUR::Processor>);
 348         void generic_edit_processor (boost::shared_ptr<ARDOUR::Processor>);
 349
 350         void update_gui_object_state (ProcessorEntry *);
 351
 352         sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorSelected;
 353         sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorUnselected;
 354
 355         static Glib::RefPtr<Gtk::ActionGroup> processor_box_actions;
 356         static Gtkmm2ext::Bindings* bindings;
 357         static void register_actions();
 358
 359 #ifndef NDEBUG
 360         static bool show_all_processors;
 361 #endif
 362
 363   private:
 364         /* prevent copy construction */
 365         ProcessorBox (ProcessorBox const &);
 366
 367         boost::shared_ptr<ARDOUR::Route>  _route;
 368         MixerStrip*         _parent_strip; // null if in RouteParamsUI
 369         bool                _owner_is_mixer;
 370         bool                 ab_direction;
 371         PBD::ScopedConnectionList _mixer_strip_connections;
 372         PBD::ScopedConnectionList _route_connections;
 373
 374         boost::function<PluginSelector*()> _get_plugin_selector;
 375
 376         boost::shared_ptr<ARDOUR::Processor> _processor_being_created;
 377
 378         /** Index at which to place a new plugin (based on where the menu was opened), or -1 to
 379          *  put at the end of the plugin list.
 380          */
 381         int _placement;
 382         uint32_t                  _visible_prefader_processors;
 383
 384         RouteProcessorSelection& _rr_selection;
 385         static Gtkmm2ext::ActionMap myactions;
 386
 387         static void load_bindings ();
 388
 389         void route_going_away ();
 390
 391         bool is_editor_mixer_strip() const;
 392
 393         Gtkmm2ext::DnDVBox<ProcessorEntry> processor_display;
 394         Gtk::ScrolledWindow    processor_scroller;
 395
 396         boost::shared_ptr<ARDOUR::Processor> find_drop_position (ProcessorEntry* position);
 397
 398         void _drop_plugin_preset (Gtk::SelectionData const &, ARDOUR::Route::ProcessorList &);
 399         void _drop_plugin (Gtk::SelectionData const &, ARDOUR::Route::ProcessorList &);
 400
 401         void plugin_drop (Gtk::SelectionData const &, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context);
 402         void object_drop (Gtkmm2ext::DnDVBox<ProcessorEntry> *, ProcessorEntry *, Glib::RefPtr<Gdk::DragContext> const &);
 403
 404         Width _width;
 405         bool  _redisplay_pending;
 406
 407         Gtk::Menu *processor_menu;
 408         gint processor_menu_map_handler (GdkEventAny *ev);
 409         Gtk::Menu * build_processor_menu ();
 410         void show_processor_menu (int);
 411         Gtk::Menu* build_possible_aux_menu();
 412
 413         void choose_aux (boost::weak_ptr<ARDOUR::Route>);
 414         void choose_send ();
 415         void send_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
 416         void return_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
 417         void choose_insert ();
 418         void choose_plugin ();
 419         bool choose_lua ();
 420         bool use_plugins (const SelectedPlugins&);
 421
 422         bool no_processor_redisplay;
 423
 424         bool enter_notify (GdkEventCrossing *ev);
 425         bool leave_notify (GdkEventCrossing *ev);
 426         bool processor_button_press_event (GdkEventButton *, ProcessorEntry *);
 427         bool processor_button_release_event (GdkEventButton *, ProcessorEntry *);
 428         void redisplay_processors ();
 429         void add_processor_to_display (boost::weak_ptr<ARDOUR::Processor>);
 430         void help_count_visible_prefader_processors (boost::weak_ptr<ARDOUR::Processor>, uint32_t*, bool*);
 431         void reordered ();
 432         void report_failed_reorder ();
 433         void route_processors_changed (ARDOUR::RouteProcessorChange);
 434         void processor_menu_unmapped ();
 435
 436         void processors_reordered (const Gtk::TreeModel::Path&, const Gtk::TreeModel::iterator&, int*);
 437         void compute_processor_sort_keys ();
 438
 439         void ab_plugins ();
 440
 441         typedef std::vector<boost::shared_ptr<ARDOUR::Processor> > ProcSelection;
 442
 443         void cut_processors (const ProcSelection&);
 444         void copy_processors (const ProcSelection&);
 445         void delete_processors (const ProcSelection&);
 446         void paste_processors ();
 447         void paste_processors (boost::shared_ptr<ARDOUR::Processor> before);
 448
 449         void delete_dragged_processors (const std::list<boost::shared_ptr<ARDOUR::Processor> >&);
 450         void clear_processors ();
 451         void clear_processors (ARDOUR::Placement);
 452         void rename_processors ();
 453
 454         void for_selected_processors (void (ProcessorBox::*pmf)(boost::shared_ptr<ARDOUR::Processor>));
 455         void get_selected_processors (ProcSelection&) const;
 456
 457         bool can_cut() const;
 458         bool stub_processor_selected() const;
 459
 460         static Glib::RefPtr<Gtk::Action> cut_action;
 461         static Glib::RefPtr<Gtk::Action> copy_action;
 462         static Glib::RefPtr<Gtk::Action> paste_action;
 463         static Glib::RefPtr<Gtk::Action> rename_action;
 464         static Glib::RefPtr<Gtk::Action> delete_action;
 465         static Glib::RefPtr<Gtk::Action> edit_action;
 466         static Glib::RefPtr<Gtk::Action> edit_generic_action;
 467         void paste_processor_state (const XMLNodeList&, boost::shared_ptr<ARDOUR::Processor>);
 468
 469         void hide_processor_editor (boost::shared_ptr<ARDOUR::Processor>);
 470         void rename_processor (boost::shared_ptr<ARDOUR::Processor>);
 471
 472         gint idle_delete_processor (boost::weak_ptr<ARDOUR::Processor>);
 473
 474         void weird_plugin_dialog (ARDOUR::Plugin& p, ARDOUR::Route::ProcessorStreams streams);
 475
 476         void setup_entry_positions ();
 477
 478         static ProcessorBox* _current_processor_box;
 479
 480         static void rb_choose_aux (boost::weak_ptr<ARDOUR::Route>);
 481         static void rb_choose_plugin ();
 482         static void rb_choose_insert ();
 483         static void rb_choose_lua ();
 484         static void rb_choose_send ();
 485         static void rb_clear ();
 486         static void rb_clear_pre ();
 487         static void rb_clear_post ();
 488         static void rb_cut ();
 489         static void rb_copy ();
 490         static void rb_paste ();
 491         static void rb_delete ();
 492         static void rb_rename ();
 493         static void rb_select_all ();
 494         static void rb_deselect_all ();
 495         static void rb_activate_all ();
 496         static void rb_deactivate_all ();
 497         static void rb_ab_plugins ();
 498         static void rb_edit ();
 499         static void rb_edit_generic ();
 500
 501         void route_property_changed (const PBD::PropertyChange&);
 502         std::string generate_processor_title (boost::shared_ptr<ARDOUR::PluginInsert> pi);
 503
 504         //typedef std::list<ProcessorWindowProxy*> ProcessorWindowProxies;
 505         //ProcessorWindowProxies _processor_window_info;
 506
 507         ProcessorWindowProxy* find_window_proxy (boost::shared_ptr<ARDOUR::Processor>) const;
 508
 509         void set_processor_ui (boost::shared_ptr<ARDOUR::Processor>, Gtk::Window *);
 510         void maybe_add_processor_to_ui_list (boost::weak_ptr<ARDOUR::Processor>);
 511
 512         bool one_processor_can_be_edited ();
 513         bool processor_can_be_edited (boost::shared_ptr<ARDOUR::Processor>);
 514
 515         void mixer_strip_delivery_changed (boost::weak_ptr<ARDOUR::Delivery>);
 516
 517         XMLNode* entry_gui_object_state (ProcessorEntry *);
 518         PBD::ScopedConnection amp_config_connection;
 519 };
 520
 521 #endif /* __ardour_gtk_processor_box__ */