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