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