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