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         PBD::ScopedConnection active_connection;
 167         PBD::ScopedConnection name_connection;
 168         PBD::ScopedConnection config_connection;
 169
 170         class Control : public sigc::trackable {
 171         public:
 172                 Control (boost::shared_ptr<ARDOUR::AutomationControl>, std::string const &);
 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         };
 208
 209         std::list<Control*> _controls;
 210
 211         void toggle_control_visibility (Control *);
 212         void toggle_panner_link ();
 213
 214         class PortIcon : public Gtk::DrawingArea {
 215         public:
 216                 PortIcon(bool input) {
 217                         _input = input;
 218                         _ports = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
 219                         set_size_request (-1, 2);
 220                 }
 221                 void set_ports(ARDOUR::ChanCount const ports) { _ports = ports; }
 222         private:
 223                 bool on_expose_event (GdkEventExpose *);
 224                 bool _input;
 225                 ARDOUR::ChanCount _ports;
 226         };
 227
 228         class RoutingIcon : public Gtk::DrawingArea {
 229         public:
 230                 RoutingIcon() {
 231                         _sources = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
 232                         _sinks = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
 233                         _splitting = false;
 234                         set_size_request (-1, 4);
 235                 }
 236                 void set_sources(ARDOUR::ChanCount const sources) { _sources = sources; }
 237                 void set_sinks(ARDOUR::ChanCount const sinks) { _sinks = sinks; }
 238                 void set_splitting(const bool splitting) { _splitting = splitting; }
 239         private:
 240                 bool on_expose_event (GdkEventExpose *);
 241                 ARDOUR::ChanCount _sources; // signals available to feed into the processor(s)
 242                 ARDOUR::ChanCount _sinks;   // combined number of outputs of the processor
 243                 bool _splitting;
 244         };
 245
 246 protected:
 247         RoutingIcon _routing_icon;
 248         PortIcon _input_icon;
 249         PortIcon _output_icon;
 250 };
 251
 252 class PluginInsertProcessorEntry : public ProcessorEntry
 253 {
 254 public:
 255         PluginInsertProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::PluginInsert>, Width);
 256
 257         void hide_things ();
 258
 259 private:
 260         void plugin_insert_splitting_changed ();
 261         boost::shared_ptr<ARDOUR::PluginInsert> _plugin_insert;
 262
 263         PBD::ScopedConnection _splitting_connection;
 264 };
 265
 266 class ProcessorBox : public Gtk::HBox, public PluginInterestedObject, public ARDOUR::SessionHandlePtr
 267 {
 268   public:
 269         enum ProcessorOperation {
 270                 ProcessorsCut,
 271                 ProcessorsCopy,
 272                 ProcessorsPaste,
 273                 ProcessorsDelete,
 274                 ProcessorsSelectAll,
 275                 ProcessorsSelectNone,
 276                 ProcessorsToggleActive,
 277                 ProcessorsAB,
 278         };
 279
 280         ProcessorBox (ARDOUR::Session*, boost::function<PluginSelector*()> get_plugin_selector,
 281                       RouteProcessorSelection&, MixerStrip* parent, bool owner_is_mixer = false);
 282         ~ProcessorBox ();
 283
 284         void set_route (boost::shared_ptr<ARDOUR::Route>);
 285         void set_width (Width);
 286
 287         bool processor_operation (ProcessorOperation);
 288
 289         void select_all_processors ();
 290         void deselect_all_processors ();
 291         void select_all_plugins ();
 292         void select_all_inserts ();
 293         void select_all_sends ();
 294
 295         void hide_things ();
 296
 297         bool edit_aux_send(boost::shared_ptr<ARDOUR::Processor>);
 298
 299         /* Everything except a WindowProxy object should use this to get the window */
 300         Gtk::Window* get_processor_ui (boost::shared_ptr<ARDOUR::Processor>) const;
 301
 302         /* a WindowProxy object can use this */
 303         Gtk::Window* get_editor_window (boost::shared_ptr<ARDOUR::Processor>, bool);
 304         Gtk::Window* get_generic_editor_window (boost::shared_ptr<ARDOUR::Processor>);
 305
 306         void edit_processor (boost::shared_ptr<ARDOUR::Processor>);
 307         void generic_edit_processor (boost::shared_ptr<ARDOUR::Processor>);
 308
 309         void update_gui_object_state (ProcessorEntry *);
 310
 311         sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorSelected;
 312         sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorUnselected;
 313
 314         static void register_actions();
 315
 316   private:
 317
 318         /* prevent copy construction */
 319         ProcessorBox (ProcessorBox const &);
 320
 321         boost::shared_ptr<ARDOUR::Route>  _route;
 322         MixerStrip*         _parent_strip; // null if in RouteParamsUI
 323         bool                _owner_is_mixer;
 324         bool                 ab_direction;
 325         PBD::ScopedConnectionList _mixer_strip_connections;
 326         PBD::ScopedConnectionList _route_connections;
 327
 328         boost::function<PluginSelector*()> _get_plugin_selector;
 329
 330         boost::shared_ptr<ARDOUR::Processor> _processor_being_created;
 331
 332         /** Index at which to place a new plugin (based on where the menu was opened), or -1 to
 333          *  put at the end of the plugin list.
 334          */
 335         int _placement;
 336         uint32_t                  _visible_prefader_processors;
 337
 338         RouteProcessorSelection& _rr_selection;
 339
 340         void route_going_away ();
 341
 342         bool is_editor_mixer_strip() const;
 343
 344         Gtkmm2ext::DnDVBox<ProcessorEntry> processor_display;
 345         Gtk::ScrolledWindow    processor_scroller;
 346
 347         void object_drop (Gtkmm2ext::DnDVBox<ProcessorEntry> *, ProcessorEntry *, Glib::RefPtr<Gdk::DragContext> const &);
 348
 349         Width _width;
 350         bool  _redisplay_pending;
 351
 352         Gtk::Menu *processor_menu;
 353         gint processor_menu_map_handler (GdkEventAny *ev);
 354         Gtk::Menu * build_processor_menu ();
 355         void show_processor_menu (int);
 356         Gtk::Menu* build_possible_aux_menu();
 357
 358         void choose_aux (boost::weak_ptr<ARDOUR::Route>);
 359         void choose_send ();
 360         void send_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
 361         void return_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
 362         void choose_insert ();
 363         void choose_plugin ();
 364         bool use_plugins (const SelectedPlugins&);
 365
 366         bool no_processor_redisplay;
 367
 368         bool enter_notify (GdkEventCrossing *ev);
 369         bool leave_notify (GdkEventCrossing *ev);
 370         bool processor_button_press_event (GdkEventButton *, ProcessorEntry *);
 371         bool processor_button_release_event (GdkEventButton *, ProcessorEntry *);
 372         void redisplay_processors ();
 373         void add_processor_to_display (boost::weak_ptr<ARDOUR::Processor>);
 374         void help_count_visible_prefader_processors (boost::weak_ptr<ARDOUR::Processor>, uint32_t*, bool*);
 375         void reordered ();
 376         void report_failed_reorder ();
 377         void route_processors_changed (ARDOUR::RouteProcessorChange);
 378         void processor_menu_unmapped ();
 379
 380         void processors_reordered (const Gtk::TreeModel::Path&, const Gtk::TreeModel::iterator&, int*);
 381         void compute_processor_sort_keys ();
 382
 383         void all_visible_processors_active(bool state);
 384         void ab_plugins ();
 385
 386         typedef std::vector<boost::shared_ptr<ARDOUR::Processor> > ProcSelection;
 387
 388         void cut_processors (const ProcSelection&);
 389         void copy_processors (const ProcSelection&);
 390         void delete_processors (const ProcSelection&);
 391         void paste_processors ();
 392         void paste_processors (boost::shared_ptr<ARDOUR::Processor> before);
 393
 394         void delete_dragged_processors (const std::list<boost::shared_ptr<ARDOUR::Processor> >&);
 395         void clear_processors ();
 396         void clear_processors (ARDOUR::Placement);
 397         void rename_processors ();
 398
 399         void for_selected_processors (void (ProcessorBox::*pmf)(boost::shared_ptr<ARDOUR::Processor>));
 400         void get_selected_processors (ProcSelection&) const;
 401
 402         bool can_cut() const;
 403
 404         static Glib::RefPtr<Gtk::Action> cut_action;
 405         static Glib::RefPtr<Gtk::Action> paste_action;
 406         static Glib::RefPtr<Gtk::Action> rename_action;
 407         static Glib::RefPtr<Gtk::Action> edit_action;
 408         static Glib::RefPtr<Gtk::Action> edit_generic_action;
 409         void paste_processor_state (const XMLNodeList&, boost::shared_ptr<ARDOUR::Processor>);
 410
 411         void hide_processor_editor (boost::shared_ptr<ARDOUR::Processor>);
 412         void rename_processor (boost::shared_ptr<ARDOUR::Processor>);
 413
 414         gint idle_delete_processor (boost::weak_ptr<ARDOUR::Processor>);
 415
 416         void weird_plugin_dialog (ARDOUR::Plugin& p, ARDOUR::Route::ProcessorStreams streams);
 417
 418         void setup_entry_positions ();
 419
 420         static ProcessorBox* _current_processor_box;
 421
 422         static void rb_choose_aux (boost::weak_ptr<ARDOUR::Route>);
 423         static void rb_choose_plugin ();
 424         static void rb_choose_insert ();
 425         static void rb_choose_send ();
 426         static void rb_clear ();
 427         static void rb_clear_pre ();
 428         static void rb_clear_post ();
 429         static void rb_cut ();
 430         static void rb_copy ();
 431         static void rb_paste ();
 432         static void rb_delete ();
 433         static void rb_rename ();
 434         static void rb_select_all ();
 435         static void rb_deselect_all ();
 436         static void rb_activate_all ();
 437         static void rb_deactivate_all ();
 438         static void rb_ab_plugins ();
 439         static void rb_edit ();
 440         static void rb_edit_generic ();
 441
 442         void route_property_changed (const PBD::PropertyChange&);
 443         std::string generate_processor_title (boost::shared_ptr<ARDOUR::PluginInsert> pi);
 444
 445         typedef std::list<ProcessorWindowProxy*> ProcessorWindowProxies;
 446         ProcessorWindowProxies _processor_window_info;
 447
 448         ProcessorWindowProxy* find_window_proxy (boost::shared_ptr<ARDOUR::Processor>) const;
 449
 450         void set_processor_ui (boost::shared_ptr<ARDOUR::Processor>, Gtk::Window *);
 451         void maybe_add_processor_to_ui_list (boost::weak_ptr<ARDOUR::Processor>);
 452
 453         bool one_processor_can_be_edited ();
 454         bool processor_can_be_edited (boost::shared_ptr<ARDOUR::Processor>);
 455
 456         void mixer_strip_delivery_changed (boost::weak_ptr<ARDOUR::Delivery>);
 457
 458         XMLNode* entry_gui_object_state (ProcessorEntry *);
 459         PBD::ScopedConnection amp_config_connection;
 460 };
 461
 462 #endif /* __ardour_gtk_processor_box__ */