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