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 Session;
  73 }
  74
  75 class ProcessorBox;
  76
  77 /** A WindowProxy for Processor UI windows; it knows how to ask a ProcessorBox
  78  *  to create a UI window for a particular processor.
  79  */
  80 class ProcessorWindowProxy : public WindowProxy<Gtk::Window>
  81 {
  82 public:
  83         ProcessorWindowProxy (std::string const &, XMLNode const *, ProcessorBox *, boost::weak_ptr<ARDOUR::Processor>);
  84
  85         void show ();
  86         bool rc_configured () const {
  87                 return false;
  88         }
  89
  90         boost::weak_ptr<ARDOUR::Processor> processor () const {
  91                 return _processor;
  92         }
  93
  94         bool marked;
  95
  96 private:
  97         ProcessorBox* _processor_box;
  98         boost::weak_ptr<ARDOUR::Processor> _processor;
  99 };
 100
 101 class ProcessorEntry : public Gtkmm2ext::DnDVBoxChild, public sigc::trackable
 102 {
 103 public:
 104         ProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::Processor>, Width);
 105         ~ProcessorEntry ();
 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         Gtk::Menu* build_controls_menu ();
 132
 133         static void setup_slider_pix ();
 134
 135 protected:
 136         ArdourButton _button;
 137         Gtk::VBox _vbox;
 138         Position _position;
 139
 140         virtual void setup_visuals ();
 141
 142         static Glib::RefPtr<Gdk::Pixbuf> _slider_pixbuf;
 143         static Glib::RefPtr<Gdk::Pixbuf> _slider_pixbuf_desensitised;
 144
 145 private:
 146         void led_clicked();
 147         void processor_active_changed ();
 148         void processor_property_changed (const PBD::PropertyChange&);
 149         std::string name (Width) const;
 150         void setup_tooltip ();
 151
 152         ProcessorBox* _parent;
 153         boost::shared_ptr<ARDOUR::Processor> _processor;
 154         Width _width;
 155         Gtk::StateType _visual_state;
 156         PBD::ScopedConnection active_connection;
 157         PBD::ScopedConnection name_connection;
 158
 159         class Control : public sigc::trackable {
 160         public:
 161                 Control (Glib::RefPtr<Gdk::Pixbuf>, Glib::RefPtr<Gdk::Pixbuf>, boost::shared_ptr<ARDOUR::AutomationControl>, std::string const &);
 162
 163                 void set_pixel_width (int);
 164                 void set_visible (bool);
 165                 void add_state (XMLNode *) const;
 166                 void set_state (XMLNode const *);
 167                 void hide_things ();
 168                 void hide_label ();
 169
 170                 bool visible () const {
 171                         return _visible;
 172                 }
 173
 174                 std::string name () const {
 175                         return _name;
 176                 }
 177
 178                 Gtk::VBox box;
 179
 180         private:
 181                 void slider_adjusted ();
 182                 void button_clicked ();
 183                 void control_changed ();
 184                 std::string state_id () const;
 185                 void set_tooltip ();
 186
 187                 boost::weak_ptr<ARDOUR::AutomationControl> _control;
 188                 /* things for a slider */
 189                 Gtk::Adjustment _adjustment;
 190                 Gtkmm2ext::HSliderController _slider;
 191                 Gtk::Label _label;
 192                 /* things for a button */
 193                 ArdourButton _button;
 194                 bool _ignore_ui_adjustment;
 195                 PBD::ScopedConnection _connection;
 196                 bool _visible;
 197                 std::string _name;
 198         };
 199
 200         std::list<Control*> _controls;
 201
 202         void toggle_control_visibility (Control *);
 203 };
 204
 205 class BlankProcessorEntry : public ProcessorEntry
 206 {
 207   public:
 208         BlankProcessorEntry (ProcessorBox *, Width w);
 209 };
 210
 211 class PluginInsertProcessorEntry : public ProcessorEntry
 212 {
 213 public:
 214         PluginInsertProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::PluginInsert>, Width);
 215
 216         void hide_things ();
 217
 218 private:
 219         void setup_visuals ();
 220         void plugin_insert_splitting_changed ();
 221
 222         /* XXX: this seems a little ridiculous just for a simple scaleable icon */
 223         class SplittingIcon : public Gtk::DrawingArea {
 224         private:
 225                 bool on_expose_event (GdkEventExpose *);
 226         };
 227
 228         boost::shared_ptr<ARDOUR::PluginInsert> _plugin_insert;
 229         SplittingIcon _splitting_icon;
 230         PBD::ScopedConnection _splitting_connection;
 231 };
 232
 233 class ProcessorBox : public Gtk::HBox, public PluginInterestedObject, public ARDOUR::SessionHandlePtr
 234 {
 235   public:
 236         enum ProcessorOperation {
 237                 ProcessorsCut,
 238                 ProcessorsCopy,
 239                 ProcessorsPaste,
 240                 ProcessorsDelete,
 241                 ProcessorsSelectAll,
 242                 ProcessorsToggleActive,
 243                 ProcessorsAB,
 244         };
 245
 246         ProcessorBox (ARDOUR::Session*, boost::function<PluginSelector*()> get_plugin_selector,
 247                       RouteProcessorSelection&, MixerStrip* parent, bool owner_is_mixer = false);
 248         ~ProcessorBox ();
 249
 250         void set_route (boost::shared_ptr<ARDOUR::Route>);
 251         void set_width (Width);
 252
 253         void processor_operation (ProcessorOperation);
 254
 255         void select_all_processors ();
 256         void deselect_all_processors ();
 257         void select_all_plugins ();
 258         void select_all_inserts ();
 259         void select_all_sends ();
 260
 261         void hide_things ();
 262
 263         Gtk::Window* get_processor_ui (boost::shared_ptr<ARDOUR::Processor>) const;
 264         void toggle_edit_processor (boost::shared_ptr<ARDOUR::Processor>);
 265         void toggle_edit_generic_processor (boost::shared_ptr<ARDOUR::Processor>);
 266
 267         void update_gui_object_state (ProcessorEntry *);
 268
 269         sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorSelected;
 270         sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorUnselected;
 271
 272         static void register_actions();
 273
 274   private:
 275
 276         /* prevent copy construction */
 277         ProcessorBox (ProcessorBox const &);
 278
 279         boost::shared_ptr<ARDOUR::Route>  _route;
 280         MixerStrip*         _parent_strip; // null if in RouteParamsUI
 281         bool                _owner_is_mixer;
 282         bool                 ab_direction;
 283         PBD::ScopedConnectionList _mixer_strip_connections;
 284         PBD::ScopedConnectionList _route_connections;
 285
 286         boost::function<PluginSelector*()> _get_plugin_selector;
 287
 288         boost::shared_ptr<ARDOUR::Processor> _processor_being_created;
 289
 290         /** Index at which to place a new plugin (based on where the menu was opened), or -1 to
 291          *  put at the end of the plugin list.
 292          */
 293         int _placement;
 294         uint32_t                  _visible_prefader_processors;
 295
 296         RouteProcessorSelection& _rr_selection;
 297
 298         void route_going_away ();
 299
 300         Gtkmm2ext::DnDVBox<ProcessorEntry> processor_display;
 301         Gtk::ScrolledWindow    processor_scroller;
 302
 303         void object_drop (Gtkmm2ext::DnDVBox<ProcessorEntry> *, ProcessorEntry *, Glib::RefPtr<Gdk::DragContext> const &);
 304
 305         Width _width;
 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         void on_size_allocate (Gtk::Allocation &);
 373
 374         void setup_entry_positions ();
 375
 376         static ProcessorBox* _current_processor_box;
 377
 378         static void rb_choose_aux (boost::weak_ptr<ARDOUR::Route>);
 379         static void rb_choose_plugin ();
 380         static void rb_choose_insert ();
 381         static void rb_choose_send ();
 382         static void rb_clear ();
 383         static void rb_clear_pre ();
 384         static void rb_clear_post ();
 385         static void rb_cut ();
 386         static void rb_copy ();
 387         static void rb_paste ();
 388         static void rb_delete ();
 389         static void rb_rename ();
 390         static void rb_select_all ();
 391         static void rb_deselect_all ();
 392         static void rb_activate_all ();
 393         static void rb_deactivate_all ();
 394         static void rb_ab_plugins ();
 395         static void rb_edit ();
 396         static void rb_edit_generic ();
 397
 398         void route_property_changed (const PBD::PropertyChange&);
 399         std::string generate_processor_title (boost::shared_ptr<ARDOUR::PluginInsert> pi);
 400
 401         std::list<ProcessorWindowProxy*> _processor_window_proxies;
 402         void set_processor_ui (boost::shared_ptr<ARDOUR::Processor>, Gtk::Window *);
 403         void maybe_add_processor_to_ui_list (boost::weak_ptr<ARDOUR::Processor>);
 404
 405         bool one_processor_can_be_edited ();
 406         bool processor_can_be_edited (boost::shared_ptr<ARDOUR::Processor>);
 407
 408         void mixer_strip_delivery_changed (boost::weak_ptr<ARDOUR::Delivery>);
 409
 410         XMLNode* entry_gui_object_state (ProcessorEntry *);
 411 };
 412
 413 #endif /* __ardour_gtk_processor_box__ */