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