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
  38 #include "pbd/stateful.h"
  39 #include "pbd/signals.h"
  40
  41 #include "ardour/types.h"
  42 #include "ardour/ardour.h"
  43 #include "ardour/plugin_insert.h"
  44 #include "ardour/port_insert.h"
  45 #include "ardour/processor.h"
  46 #include "ardour/route.h"
  47 #include "ardour/session_handle.h"
  48
  49 #include "pbd/fastlog.h"
  50
  51 #include "plugin_interest.h"
  52 #include "io_selector.h"
  53 #include "send_ui.h"
  54 #include "enums.h"
  55 #include "window_proxy.h"
  56 #include "ardour_button.h"
  57
  58 class MotionController;
  59 class PluginSelector;
  60 class PluginUIWindow;
  61 class RouteProcessorSelection;
  62 class MixerStrip;
  63
  64 namespace ARDOUR {
  65         class Connection;
  66         class IO;
  67         class Insert;
  68         class Plugin;
  69         class PluginInsert;
  70         class PortInsert;
  71         class Route;
  72         class Send;
  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 (boost::shared_ptr<ARDOUR::Processor>, Width);
 106
 107         Gtk::EventBox& action_widget ();
 108         Gtk::Widget& widget ();
 109         std::string drag_text () const;
 110         void set_visual_state (Gtkmm2ext::VisualState, bool);
 111
 112         enum Position {
 113                 PreFader,
 114                 Fader,
 115                 PostFader
 116         };
 117
 118         void set_position (Position);
 119         boost::shared_ptr<ARDOUR::Processor> processor () const;
 120         void set_enum_width (Width);
 121         virtual void set_pixel_width (int);
 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
 132         static void setup_slider_pix ();
 133
 134 protected:
 135         ArdourButton _button;
 136         Gtk::VBox _vbox;
 137         Position _position;
 138
 139         virtual void setup_visuals ();
 140
 141         static Glib::RefPtr<Gdk::Pixbuf> _slider_pixbuf;
 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         boost::shared_ptr<ARDOUR::Processor> _processor;
 151         Width _width;
 152         Gtk::StateType _visual_state;
 153         PBD::ScopedConnection active_connection;
 154         PBD::ScopedConnection name_connection;
 155
 156         class Control {
 157         public:
 158                 Control (Glib::RefPtr<Gdk::Pixbuf>, boost::shared_ptr<ARDOUR::AutomationControl>, std::string const &);
 159
 160                 void set_pixel_width (int);
 161                 void show ();
 162                 void hide ();
 163                 void add_state (XMLNode *) const;
 164                 void set_state (XMLNode const *);
 165                 void hide_things ();
 166
 167                 Gtk::VBox box;
 168
 169         private:
 170                 void slider_adjusted ();
 171                 void control_changed ();
 172                 std::string state_id () const;
 173
 174                 boost::weak_ptr<ARDOUR::AutomationControl> _control;
 175                 Gtk::Adjustment _adjustment;
 176                 Gtkmm2ext::HSliderController _slider;
 177                 Gtk::Label _label;
 178                 bool _ignore_slider_adjustment;
 179                 PBD::ScopedConnection _connection;
 180                 bool _visible;
 181         };
 182
 183         std::list<Control*> _controls;
 184 };
 185
 186 class BlankProcessorEntry : public ProcessorEntry
 187 {
 188   public:
 189         BlankProcessorEntry (Width w);
 190 };
 191
 192 class SendProcessorEntry : public ProcessorEntry
 193 {
 194 public:
 195         SendProcessorEntry (boost::shared_ptr<ARDOUR::Send>, Width);
 196
 197         void set_enum_width (Width, int);
 198         void set_pixel_width (int);
 199
 200 private:
 201         void show_gain ();
 202         void gain_adjusted ();
 203         void setup_gain_adjustment ();
 204
 205         boost::shared_ptr<ARDOUR::Send> _send;
 206         Gtk::Adjustment _adjustment;
 207         Gtkmm2ext::HSliderController _fader;
 208         bool _ignore_gain_change;
 209         PBD::ScopedConnectionList _send_connections;
 210         ARDOUR::DataType _data_type;
 211 };
 212
 213 class PluginInsertProcessorEntry : public ProcessorEntry
 214 {
 215 public:
 216         PluginInsertProcessorEntry (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 update();
 256
 257         void processor_operation (ProcessorOperation);
 258
 259         void select_all_processors ();
 260         void deselect_all_processors ();
 261         void select_all_plugins ();
 262         void select_all_inserts ();
 263         void select_all_sends ();
 264
 265         void hide_things ();
 266
 267         Gtk::Window* get_processor_ui (boost::shared_ptr<ARDOUR::Processor>) const;
 268         void toggle_edit_processor (boost::shared_ptr<ARDOUR::Processor>);
 269
 270         sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorSelected;
 271         sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorUnselected;
 272
 273         static void register_actions();
 274
 275   private:
 276
 277         /* prevent copy construction */
 278         ProcessorBox (ProcessorBox const &);
 279
 280         boost::shared_ptr<ARDOUR::Route>  _route;
 281         MixerStrip*         _parent_strip; // null if in RouteParamsUI
 282         bool                _owner_is_mixer;
 283         bool                 ab_direction;
 284         PBD::ScopedConnectionList _mixer_strip_connections;
 285         PBD::ScopedConnectionList _route_connections;
 286
 287         boost::function<PluginSelector*()> _get_plugin_selector;
 288
 289         boost::shared_ptr<ARDOUR::Processor> _processor_being_created;
 290
 291         /** Index at which to place a new plugin (based on where the menu was opened), or -1 to
 292          *  put at the end of the plugin list.
 293          */
 294         int _placement;
 295         uint32_t                  _visible_prefader_processors;
 296
 297         RouteProcessorSelection& _rr_selection;
 298
 299         void route_going_away ();
 300
 301         Gtkmm2ext::DnDVBox<ProcessorEntry> processor_display;
 302         Gtk::ScrolledWindow    processor_scroller;
 303
 304         void object_drop (Gtkmm2ext::DnDVBox<ProcessorEntry> *, ProcessorEntry *, Glib::RefPtr<Gdk::DragContext> const &);
 305
 306         Width _width;
 307
 308         Gtk::Menu *processor_menu;
 309         gint processor_menu_map_handler (GdkEventAny *ev);
 310         Gtk::Menu * build_processor_menu ();
 311         void show_processor_menu (int);
 312         Gtk::Menu* build_possible_aux_menu();
 313         Gtk::Menu* build_controls_menu (boost::shared_ptr<ARDOUR::Processor>);
 314
 315         void show_or_hide_all_controls (boost::weak_ptr<ARDOUR::Processor>, bool);
 316
 317         void choose_aux (boost::weak_ptr<ARDOUR::Route>);
 318         void choose_send ();
 319         void send_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
 320         void return_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
 321         void choose_insert ();
 322         void choose_plugin ();
 323         bool use_plugins (const SelectedPlugins&);
 324
 325         bool no_processor_redisplay;
 326
 327         bool enter_notify (GdkEventCrossing *ev);
 328         bool leave_notify (GdkEventCrossing *ev);
 329         bool processor_button_press_event (GdkEventButton *, ProcessorEntry *);
 330         bool processor_button_release_event (GdkEventButton *, ProcessorEntry *);
 331         void redisplay_processors ();
 332         void add_processor_to_display (boost::weak_ptr<ARDOUR::Processor>);
 333         void help_count_visible_prefader_processors (boost::weak_ptr<ARDOUR::Processor>, uint32_t*, bool*);
 334         void reordered ();
 335         void report_failed_reorder ();
 336         void route_processors_changed (ARDOUR::RouteProcessorChange);
 337         void processor_menu_unmapped ();
 338
 339         void processors_reordered (const Gtk::TreeModel::Path&, const Gtk::TreeModel::iterator&, int*);
 340         void compute_processor_sort_keys ();
 341
 342         void all_visible_processors_active(bool state);
 343         void ab_plugins ();
 344
 345         typedef std::vector<boost::shared_ptr<ARDOUR::Processor> > ProcSelection;
 346
 347         void cut_processors (const ProcSelection&);
 348         void copy_processors (const ProcSelection&);
 349         void delete_processors (const ProcSelection&);
 350         void paste_processors ();
 351         void paste_processors (boost::shared_ptr<ARDOUR::Processor> before);
 352         void processors_up ();
 353         void processors_down ();
 354
 355         void delete_dragged_processors (const std::list<boost::shared_ptr<ARDOUR::Processor> >&);
 356         void clear_processors ();
 357         void clear_processors (ARDOUR::Placement);
 358         void rename_processors ();
 359
 360         void for_selected_processors (void (ProcessorBox::*pmf)(boost::shared_ptr<ARDOUR::Processor>));
 361         void get_selected_processors (ProcSelection&) const;
 362
 363         bool can_cut() const;
 364
 365         static Glib::RefPtr<Gtk::Action> cut_action;
 366         static Glib::RefPtr<Gtk::Action> paste_action;
 367         static Glib::RefPtr<Gtk::Action> rename_action;
 368         static Glib::RefPtr<Gtk::Action> edit_action;
 369         static Glib::RefPtr<Gtk::Action> controls_action;
 370         void paste_processor_state (const XMLNodeList&, boost::shared_ptr<ARDOUR::Processor>);
 371
 372         void activate_processor (boost::shared_ptr<ARDOUR::Processor>);
 373         void deactivate_processor (boost::shared_ptr<ARDOUR::Processor>);
 374         void hide_processor_editor (boost::shared_ptr<ARDOUR::Processor>);
 375         void rename_processor (boost::shared_ptr<ARDOUR::Processor>);
 376
 377         gint idle_delete_processor (boost::weak_ptr<ARDOUR::Processor>);
 378
 379         void weird_plugin_dialog (ARDOUR::Plugin& p, ARDOUR::Route::ProcessorStreams streams);
 380         void on_size_allocate (Gtk::Allocation &);
 381
 382         void setup_entry_positions ();
 383
 384         static ProcessorBox* _current_processor_box;
 385
 386         static void rb_choose_aux (boost::weak_ptr<ARDOUR::Route>);
 387         static void rb_choose_plugin ();
 388         static void rb_choose_insert ();
 389         static void rb_choose_send ();
 390         static void rb_clear ();
 391         static void rb_clear_pre ();
 392         static void rb_clear_post ();
 393         static void rb_cut ();
 394         static void rb_copy ();
 395         static void rb_paste ();
 396         static void rb_delete ();
 397         static void rb_rename ();
 398         static void rb_select_all ();
 399         static void rb_deselect_all ();
 400         static void rb_activate_all ();
 401         static void rb_deactivate_all ();
 402         static void rb_ab_plugins ();
 403         static void rb_edit ();
 404
 405         void route_property_changed (const PBD::PropertyChange&);
 406         std::string generate_processor_title (boost::shared_ptr<ARDOUR::PluginInsert> pi);
 407
 408         std::list<ProcessorWindowProxy*> _processor_window_proxies;
 409         void set_processor_ui (boost::shared_ptr<ARDOUR::Processor>, Gtk::Window *);
 410         void maybe_add_processor_to_ui_list (boost::weak_ptr<ARDOUR::Processor>);
 411
 412         bool one_processor_can_be_edited ();
 413         bool processor_can_be_edited (boost::shared_ptr<ARDOUR::Processor>);
 414
 415         void mixer_strip_delivery_changed (boost::weak_ptr<ARDOUR::Delivery>);
 416
 417         void update_gui_object_state (ProcessorEntry *);
 418         XMLNode* entry_gui_object_state (ProcessorEntry *);
 419 };
 420
 421 #endif /* __ardour_gtk_processor_box__ */