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     bool marked;
  95     bool valid () const;
  96
  97     void set_state (const XMLNode&);
  98     XMLNode& get_state () const;
  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         enum Position {
 126                 PreFader,
 127                 Fader,
 128                 PostFader
 129         };
 130
 131         void set_position (Position, uint32_t);
 132         boost::shared_ptr<ARDOUR::Processor> processor () const;
 133         void set_enum_width (Width);
 134
 135         /** Hide any widgets that should be hidden */
 136         virtual void hide_things ();
 137
 138         void show_all_controls ();
 139         void hide_all_controls ();
 140         void add_control_state (XMLNode *) const;
 141         void set_control_state (XMLNode const *);
 142         std::string state_id () const;
 143         Gtk::Menu* build_controls_menu ();
 144         Gtk::Menu* build_send_options_menu ();
 145
 146 protected:
 147         ArdourButton _button;
 148         Gtk::VBox _vbox;
 149         Position _position;
 150         uint32_t _position_num;
 151
 152         virtual void setup_visuals ();
 153
 154 private:
 155         bool _selectable;
 156         void led_clicked();
 157         void processor_active_changed ();
 158         void processor_property_changed (const PBD::PropertyChange&);
 159         void processor_configuration_changed (const ARDOUR::ChanCount in, const ARDOUR::ChanCount out);
 160         std::string name (Width) const;
 161         void setup_tooltip ();
 162
 163         ProcessorBox* _parent;
 164         boost::shared_ptr<ARDOUR::Processor> _processor;
 165         Width _width;
 166         Gtk::StateType _visual_state;
 167         PBD::ScopedConnection active_connection;
 168         PBD::ScopedConnection name_connection;
 169         PBD::ScopedConnection config_connection;
 170
 171         class Control : public sigc::trackable {
 172         public:
 173                 Control (boost::shared_ptr<ARDOUR::AutomationControl>, std::string const &);
 174
 175                 void set_visible (bool);
 176                 void add_state (XMLNode *) const;
 177                 void set_state (XMLNode const *);
 178                 void hide_things ();
 179
 180                 bool visible () const {
 181                         return _visible;
 182                 }
 183
 184                 std::string name () const {
 185                         return _name;
 186                 }
 187
 188                 Gtk::Alignment box;
 189
 190         private:
 191                 void slider_adjusted ();
 192                 void button_clicked ();
 193                 void control_changed ();
 194                 std::string state_id () const;
 195                 void set_tooltip ();
 196
 197                 boost::weak_ptr<ARDOUR::AutomationControl> _control;
 198                 /* things for a slider */
 199                 Gtk::Adjustment _adjustment;
 200                 Gtkmm2ext::HSliderController _slider;
 201                 Gtkmm2ext::PersistentTooltip _slider_persistant_tooltip;
 202                 /* things for a button */
 203                 ArdourButton _button;
 204                 bool _ignore_ui_adjustment;
 205                 PBD::ScopedConnection _connection;
 206                 bool _visible;
 207                 std::string _name;
 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                         _input = input;
 219                         _ports = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
 220                         set_size_request (-1, 2);
 221                 }
 222                 void set_ports(ARDOUR::ChanCount const ports) { _ports = ports; }
 223         private:
 224                 bool on_expose_event (GdkEventExpose *);
 225                 bool _input;
 226                 ARDOUR::ChanCount _ports;
 227         };
 228
 229         class RoutingIcon : public Gtk::DrawingArea {
 230         public:
 231                 RoutingIcon() {
 232                         _sources = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
 233                         _sinks = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
 234                         _splitting = false;
 235                         set_size_request (-1, 4);
 236                 }
 237                 void set_sources(ARDOUR::ChanCount const sources) { _sources = sources; }
 238                 void set_sinks(ARDOUR::ChanCount const sinks) { _sinks = sinks; }
 239                 void set_splitting(const bool splitting) { _splitting = splitting; }
 240         private:
 241                 bool on_expose_event (GdkEventExpose *);
 242                 ARDOUR::ChanCount _sources; // signals available to feed into the processor(s)
 243                 ARDOUR::ChanCount _sinks;   // combined number of outputs of the processor
 244                 bool _splitting;
 245         };
 246
 247 protected:
 248         RoutingIcon _routing_icon;
 249         PortIcon _input_icon;
 250         PortIcon _output_icon;
 251 };
 252
 253 class PluginInsertProcessorEntry : public ProcessorEntry
 254 {
 255 public:
 256         PluginInsertProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::PluginInsert>, Width);
 257
 258         void hide_things ();
 259
 260 private:
 261         void plugin_insert_splitting_changed ();
 262         boost::shared_ptr<ARDOUR::PluginInsert> _plugin_insert;
 263
 264         PBD::ScopedConnection _splitting_connection;
 265 };
 266
 267 class ProcessorBox : public Gtk::HBox, public PluginInterestedObject, public ARDOUR::SessionHandlePtr
 268 {
 269   public:
 270         enum ProcessorOperation {
 271                 ProcessorsCut,
 272                 ProcessorsCopy,
 273                 ProcessorsPaste,
 274                 ProcessorsDelete,
 275                 ProcessorsSelectAll,
 276                 ProcessorsSelectNone,
 277                 ProcessorsToggleActive,
 278                 ProcessorsAB,
 279         };
 280
 281         ProcessorBox (ARDOUR::Session*, boost::function<PluginSelector*()> get_plugin_selector,
 282                       RouteProcessorSelection&, MixerStrip* parent, bool owner_is_mixer = false);
 283         ~ProcessorBox ();
 284
 285         void set_route (boost::shared_ptr<ARDOUR::Route>);
 286         void set_width (Width);
 287
 288         bool processor_operation (ProcessorOperation);
 289
 290         void select_all_processors ();
 291         void deselect_all_processors ();
 292         void select_all_plugins ();
 293         void select_all_inserts ();
 294         void select_all_sends ();
 295
 296         void hide_things ();
 297
 298         bool edit_aux_send(boost::shared_ptr<ARDOUR::Processor>);
 299
 300         /* Everything except a WindowProxy object should use this to get the window */
 301         Gtk::Window* get_processor_ui (boost::shared_ptr<ARDOUR::Processor>) const;
 302
 303         /* a WindowProxy object can use this */
 304         Gtk::Window* get_editor_window (boost::shared_ptr<ARDOUR::Processor>, bool);
 305         Gtk::Window* get_generic_editor_window (boost::shared_ptr<ARDOUR::Processor>);
 306
 307         void edit_processor (boost::shared_ptr<ARDOUR::Processor>);
 308         void generic_edit_processor (boost::shared_ptr<ARDOUR::Processor>);
 309
 310         void update_gui_object_state (ProcessorEntry *);
 311
 312         sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorSelected;
 313         sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorUnselected;
 314
 315         static void register_actions();
 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
 405         static Glib::RefPtr<Gtk::Action> cut_action;
 406         static Glib::RefPtr<Gtk::Action> paste_action;
 407         static Glib::RefPtr<Gtk::Action> rename_action;
 408         static Glib::RefPtr<Gtk::Action> edit_action;
 409         static Glib::RefPtr<Gtk::Action> edit_generic_action;
 410         void paste_processor_state (const XMLNodeList&, boost::shared_ptr<ARDOUR::Processor>);
 411
 412         void hide_processor_editor (boost::shared_ptr<ARDOUR::Processor>);
 413         void rename_processor (boost::shared_ptr<ARDOUR::Processor>);
 414
 415         gint idle_delete_processor (boost::weak_ptr<ARDOUR::Processor>);
 416
 417         void weird_plugin_dialog (ARDOUR::Plugin& p, ARDOUR::Route::ProcessorStreams streams);
 418
 419         void setup_entry_positions ();
 420
 421         static ProcessorBox* _current_processor_box;
 422
 423         static void rb_choose_aux (boost::weak_ptr<ARDOUR::Route>);
 424         static void rb_choose_plugin ();
 425         static void rb_choose_insert ();
 426         static void rb_choose_send ();
 427         static void rb_clear ();
 428         static void rb_clear_pre ();
 429         static void rb_clear_post ();
 430         static void rb_cut ();
 431         static void rb_copy ();
 432         static void rb_paste ();
 433         static void rb_delete ();
 434         static void rb_rename ();
 435         static void rb_select_all ();
 436         static void rb_deselect_all ();
 437         static void rb_activate_all ();
 438         static void rb_deactivate_all ();
 439         static void rb_ab_plugins ();
 440         static void rb_edit ();
 441         static void rb_edit_generic ();
 442
 443         void route_property_changed (const PBD::PropertyChange&);
 444         std::string generate_processor_title (boost::shared_ptr<ARDOUR::PluginInsert> pi);
 445
 446         typedef std::list<ProcessorWindowProxy*> ProcessorWindowProxies;
 447         ProcessorWindowProxies _processor_window_info;
 448
 449         ProcessorWindowProxy* find_window_proxy (boost::shared_ptr<ARDOUR::Processor>) const;
 450
 451         void set_processor_ui (boost::shared_ptr<ARDOUR::Processor>, Gtk::Window *);
 452         void maybe_add_processor_to_ui_list (boost::weak_ptr<ARDOUR::Processor>);
 453
 454         bool one_processor_can_be_edited ();
 455         bool processor_can_be_edited (boost::shared_ptr<ARDOUR::Processor>);
 456
 457         void mixer_strip_delivery_changed (boost::weak_ptr<ARDOUR::Delivery>);
 458
 459         XMLNode* entry_gui_object_state (ProcessorEntry *);
 460         PBD::ScopedConnection amp_config_connection;
 461 };
 462
 463 #endif /* __ardour_gtk_processor_box__ */