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         boost::shared_ptr<ARDOUR::Processor> processor () const;
 130         void set_enum_width (Width);
 131
 132         /** Hide any widgets that should be hidden */
 133         virtual void hide_things ();
 134
 135         void show_all_controls ();
 136         void hide_all_controls ();
 137         void add_control_state (XMLNode *) const;
 138         void set_control_state (XMLNode const *);
 139         std::string state_id () const;
 140         Gtk::Menu* build_controls_menu ();
 141         Gtk::Menu* build_send_options_menu ();
 142
 143 protected:
 144         ArdourButton _button;
 145         Gtk::VBox _vbox;
 146         Position _position;
 147         uint32_t _position_num;
 148
 149         virtual void setup_visuals ();
 150
 151 private:
 152         bool _selectable;
 153         void led_clicked();
 154         void processor_active_changed ();
 155         void processor_property_changed (const PBD::PropertyChange&);
 156         void processor_configuration_changed (const ARDOUR::ChanCount in, const ARDOUR::ChanCount out);
 157         std::string name (Width) const;
 158         void setup_tooltip ();
 159
 160         ProcessorBox* _parent;
 161         boost::shared_ptr<ARDOUR::Processor> _processor;
 162         Width _width;
 163         PBD::ScopedConnection active_connection;
 164         PBD::ScopedConnection name_connection;
 165         PBD::ScopedConnection config_connection;
 166
 167         class Control : public sigc::trackable {
 168         public:
 169                 Control (boost::shared_ptr<ARDOUR::AutomationControl>, std::string const &);
 170
 171                 void set_visible (bool);
 172                 void add_state (XMLNode *) const;
 173                 void set_state (XMLNode const *);
 174                 void hide_things ();
 175
 176                 bool visible () const {
 177                         return _visible;
 178                 }
 179
 180                 std::string name () const {
 181                         return _name;
 182                 }
 183
 184                 Gtk::Alignment box;
 185
 186         private:
 187                 void slider_adjusted ();
 188                 void button_clicked ();
 189                 void control_changed ();
 190                 std::string state_id () const;
 191                 void set_tooltip ();
 192
 193                 boost::weak_ptr<ARDOUR::AutomationControl> _control;
 194                 /* things for a slider */
 195                 Gtk::Adjustment _adjustment;
 196                 Gtkmm2ext::HSliderController _slider;
 197                 Gtkmm2ext::PersistentTooltip _slider_persistant_tooltip;
 198                 /* things for a button */
 199                 ArdourButton _button;
 200                 bool _ignore_ui_adjustment;
 201                 PBD::ScopedConnection _connection;
 202                 bool _visible;
 203                 std::string _name;
 204         };
 205
 206         std::list<Control*> _controls;
 207
 208         void toggle_control_visibility (Control *);
 209         void toggle_panner_link ();
 210
 211         class PortIcon : public Gtk::DrawingArea {
 212         public:
 213                 PortIcon(bool input) {
 214                         _input = input;
 215                         _ports = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
 216                         set_size_request (-1, 2);
 217                 }
 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                 ARDOUR::ChanCount _sources; // signals available to feed into the processor(s)
 239                 ARDOUR::ChanCount _sinks;   // combined number of outputs of the processor
 240                 bool _splitting;
 241         };
 242
 243 protected:
 244         RoutingIcon _routing_icon;
 245         PortIcon _input_icon;
 246         PortIcon _output_icon;
 247 };
 248
 249 class PluginInsertProcessorEntry : public ProcessorEntry
 250 {
 251 public:
 252         PluginInsertProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::PluginInsert>, Width);
 253
 254         void hide_things ();
 255
 256 private:
 257         void plugin_insert_splitting_changed ();
 258         boost::shared_ptr<ARDOUR::PluginInsert> _plugin_insert;
 259
 260         PBD::ScopedConnection _splitting_connection;
 261 };
 262
 263 class ProcessorBox : public Gtk::HBox, public PluginInterestedObject, public ARDOUR::SessionHandlePtr
 264 {
 265   public:
 266         enum ProcessorOperation {
 267                 ProcessorsCut,
 268                 ProcessorsCopy,
 269                 ProcessorsPaste,
 270                 ProcessorsDelete,
 271                 ProcessorsSelectAll,
 272                 ProcessorsSelectNone,
 273                 ProcessorsToggleActive,
 274                 ProcessorsAB,
 275         };
 276
 277         ProcessorBox (ARDOUR::Session*, boost::function<PluginSelector*()> get_plugin_selector,
 278                       RouteProcessorSelection&, MixerStrip* parent, bool owner_is_mixer = false);
 279         ~ProcessorBox ();
 280
 281         void set_route (boost::shared_ptr<ARDOUR::Route>);
 282         void set_width (Width);
 283
 284         bool processor_operation (ProcessorOperation);
 285
 286         void select_all_processors ();
 287         void deselect_all_processors ();
 288         void select_all_plugins ();
 289         void select_all_inserts ();
 290         void select_all_sends ();
 291
 292         void hide_things ();
 293
 294         bool edit_aux_send(boost::shared_ptr<ARDOUR::Processor>);
 295
 296         /* Everything except a WindowProxy object should use this to get the window */
 297         Gtk::Window* get_processor_ui (boost::shared_ptr<ARDOUR::Processor>) const;
 298
 299         /* a WindowProxy object can use this */
 300         Gtk::Window* get_editor_window (boost::shared_ptr<ARDOUR::Processor>, bool);
 301         Gtk::Window* get_generic_editor_window (boost::shared_ptr<ARDOUR::Processor>);
 302
 303         void edit_processor (boost::shared_ptr<ARDOUR::Processor>);
 304         void generic_edit_processor (boost::shared_ptr<ARDOUR::Processor>);
 305
 306         void update_gui_object_state (ProcessorEntry *);
 307
 308         sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorSelected;
 309         sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorUnselected;
 310
 311         static void register_actions();
 312
 313   private:
 314
 315         /* prevent copy construction */
 316         ProcessorBox (ProcessorBox const &);
 317
 318         boost::shared_ptr<ARDOUR::Route>  _route;
 319         MixerStrip*         _parent_strip; // null if in RouteParamsUI
 320         bool                _owner_is_mixer;
 321         bool                 ab_direction;
 322         PBD::ScopedConnectionList _mixer_strip_connections;
 323         PBD::ScopedConnectionList _route_connections;
 324
 325         boost::function<PluginSelector*()> _get_plugin_selector;
 326
 327         boost::shared_ptr<ARDOUR::Processor> _processor_being_created;
 328
 329         /** Index at which to place a new plugin (based on where the menu was opened), or -1 to
 330          *  put at the end of the plugin list.
 331          */
 332         int _placement;
 333         uint32_t                  _visible_prefader_processors;
 334
 335         RouteProcessorSelection& _rr_selection;
 336
 337         void route_going_away ();
 338
 339         bool is_editor_mixer_strip() const;
 340
 341         Gtkmm2ext::DnDVBox<ProcessorEntry> processor_display;
 342         Gtk::ScrolledWindow    processor_scroller;
 343
 344         void object_drop (Gtkmm2ext::DnDVBox<ProcessorEntry> *, ProcessorEntry *, Glib::RefPtr<Gdk::DragContext> const &);
 345
 346         Width _width;
 347         bool  _redisplay_pending;
 348
 349         Gtk::Menu *processor_menu;
 350         gint processor_menu_map_handler (GdkEventAny *ev);
 351         Gtk::Menu * build_processor_menu ();
 352         void show_processor_menu (int);
 353         Gtk::Menu* build_possible_aux_menu();
 354
 355         void choose_aux (boost::weak_ptr<ARDOUR::Route>);
 356         void choose_send ();
 357         void send_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
 358         void return_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
 359         void choose_insert ();
 360         void choose_plugin ();
 361         bool use_plugins (const SelectedPlugins&);
 362
 363         bool no_processor_redisplay;
 364
 365         bool enter_notify (GdkEventCrossing *ev);
 366         bool leave_notify (GdkEventCrossing *ev);
 367         bool processor_button_press_event (GdkEventButton *, ProcessorEntry *);
 368         bool processor_button_release_event (GdkEventButton *, ProcessorEntry *);
 369         void redisplay_processors ();
 370         void add_processor_to_display (boost::weak_ptr<ARDOUR::Processor>);
 371         void help_count_visible_prefader_processors (boost::weak_ptr<ARDOUR::Processor>, uint32_t*, bool*);
 372         void reordered ();
 373         void report_failed_reorder ();
 374         void route_processors_changed (ARDOUR::RouteProcessorChange);
 375         void processor_menu_unmapped ();
 376
 377         void processors_reordered (const Gtk::TreeModel::Path&, const Gtk::TreeModel::iterator&, int*);
 378         void compute_processor_sort_keys ();
 379
 380         void all_visible_processors_active(bool state);
 381         void ab_plugins ();
 382
 383         typedef std::vector<boost::shared_ptr<ARDOUR::Processor> > ProcSelection;
 384
 385         void cut_processors (const ProcSelection&);
 386         void copy_processors (const ProcSelection&);
 387         void delete_processors (const ProcSelection&);
 388         void paste_processors ();
 389         void paste_processors (boost::shared_ptr<ARDOUR::Processor> before);
 390
 391         void delete_dragged_processors (const std::list<boost::shared_ptr<ARDOUR::Processor> >&);
 392         void clear_processors ();
 393         void clear_processors (ARDOUR::Placement);
 394         void rename_processors ();
 395
 396         void for_selected_processors (void (ProcessorBox::*pmf)(boost::shared_ptr<ARDOUR::Processor>));
 397         void get_selected_processors (ProcSelection&) const;
 398
 399         bool can_cut() const;
 400
 401         static Glib::RefPtr<Gtk::Action> cut_action;
 402         static Glib::RefPtr<Gtk::Action> paste_action;
 403         static Glib::RefPtr<Gtk::Action> rename_action;
 404         static Glib::RefPtr<Gtk::Action> edit_action;
 405         static Glib::RefPtr<Gtk::Action> edit_generic_action;
 406         void paste_processor_state (const XMLNodeList&, boost::shared_ptr<ARDOUR::Processor>);
 407
 408         void hide_processor_editor (boost::shared_ptr<ARDOUR::Processor>);
 409         void rename_processor (boost::shared_ptr<ARDOUR::Processor>);
 410
 411         gint idle_delete_processor (boost::weak_ptr<ARDOUR::Processor>);
 412
 413         void weird_plugin_dialog (ARDOUR::Plugin& p, ARDOUR::Route::ProcessorStreams streams);
 414
 415         void setup_entry_positions ();
 416
 417         static ProcessorBox* _current_processor_box;
 418
 419         static void rb_choose_aux (boost::weak_ptr<ARDOUR::Route>);
 420         static void rb_choose_plugin ();
 421         static void rb_choose_insert ();
 422         static void rb_choose_send ();
 423         static void rb_clear ();
 424         static void rb_clear_pre ();
 425         static void rb_clear_post ();
 426         static void rb_cut ();
 427         static void rb_copy ();
 428         static void rb_paste ();
 429         static void rb_delete ();
 430         static void rb_rename ();
 431         static void rb_select_all ();
 432         static void rb_deselect_all ();
 433         static void rb_activate_all ();
 434         static void rb_deactivate_all ();
 435         static void rb_ab_plugins ();
 436         static void rb_edit ();
 437         static void rb_edit_generic ();
 438
 439         void route_property_changed (const PBD::PropertyChange&);
 440         std::string generate_processor_title (boost::shared_ptr<ARDOUR::PluginInsert> pi);
 441
 442         //typedef std::list<ProcessorWindowProxy*> ProcessorWindowProxies;
 443         //ProcessorWindowProxies _processor_window_info;
 444
 445         ProcessorWindowProxy* find_window_proxy (boost::shared_ptr<ARDOUR::Processor>) const;
 446
 447         void set_processor_ui (boost::shared_ptr<ARDOUR::Processor>, Gtk::Window *);
 448         void maybe_add_processor_to_ui_list (boost::weak_ptr<ARDOUR::Processor>);
 449
 450         bool one_processor_can_be_edited ();
 451         bool processor_can_be_edited (boost::shared_ptr<ARDOUR::Processor>);
 452
 453         void mixer_strip_delivery_changed (boost::weak_ptr<ARDOUR::Delivery>);
 454
 455         XMLNode* entry_gui_object_state (ProcessorEntry *);
 456         PBD::ScopedConnection amp_config_connection;
 457 };
 458
 459 #endif /* __ardour_gtk_processor_box__ */