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