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