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