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