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 (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
 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 PluginInsertProcessorEntry : public ProcessorEntry
 193 {
 194 public:
 195         PluginInsertProcessorEntry (boost::shared_ptr<ARDOUR::PluginInsert>, Width);
 196
 197         void hide_things ();
 198
 199 private:
 200         void setup_visuals ();
 201         void plugin_insert_splitting_changed ();
 202
 203         /* XXX: this seems a little ridiculous just for a simple scaleable icon */
 204         class SplittingIcon : public Gtk::DrawingArea {
 205         private:
 206                 bool on_expose_event (GdkEventExpose *);
 207         };
 208
 209         boost::shared_ptr<ARDOUR::PluginInsert> _plugin_insert;
 210         SplittingIcon _splitting_icon;
 211         PBD::ScopedConnection _splitting_connection;
 212 };
 213
 214 class ProcessorBox : public Gtk::HBox, public PluginInterestedObject, public ARDOUR::SessionHandlePtr
 215 {
 216   public:
 217         enum ProcessorOperation {
 218                 ProcessorsCut,
 219                 ProcessorsCopy,
 220                 ProcessorsPaste,
 221                 ProcessorsDelete,
 222                 ProcessorsSelectAll,
 223                 ProcessorsToggleActive,
 224                 ProcessorsAB,
 225         };
 226
 227         ProcessorBox (ARDOUR::Session*, boost::function<PluginSelector*()> get_plugin_selector,
 228                       RouteProcessorSelection&, MixerStrip* parent, bool owner_is_mixer = false);
 229         ~ProcessorBox ();
 230
 231         void set_route (boost::shared_ptr<ARDOUR::Route>);
 232         void set_width (Width);
 233
 234         void update();
 235
 236         void processor_operation (ProcessorOperation);
 237
 238         void select_all_processors ();
 239         void deselect_all_processors ();
 240         void select_all_plugins ();
 241         void select_all_inserts ();
 242         void select_all_sends ();
 243
 244         void hide_things ();
 245
 246         Gtk::Window* get_processor_ui (boost::shared_ptr<ARDOUR::Processor>) const;
 247         void toggle_edit_processor (boost::shared_ptr<ARDOUR::Processor>);
 248
 249         sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorSelected;
 250         sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorUnselected;
 251
 252         static void register_actions();
 253
 254   private:
 255
 256         /* prevent copy construction */
 257         ProcessorBox (ProcessorBox const &);
 258
 259         boost::shared_ptr<ARDOUR::Route>  _route;
 260         MixerStrip*         _parent_strip; // null if in RouteParamsUI
 261         bool                _owner_is_mixer;
 262         bool                 ab_direction;
 263         PBD::ScopedConnectionList _mixer_strip_connections;
 264         PBD::ScopedConnectionList _route_connections;
 265
 266         boost::function<PluginSelector*()> _get_plugin_selector;
 267
 268         boost::shared_ptr<ARDOUR::Processor> _processor_being_created;
 269
 270         /** Index at which to place a new plugin (based on where the menu was opened), or -1 to
 271          *  put at the end of the plugin list.
 272          */
 273         int _placement;
 274         uint32_t                  _visible_prefader_processors;
 275
 276         RouteProcessorSelection& _rr_selection;
 277
 278         void route_going_away ();
 279
 280         Gtkmm2ext::DnDVBox<ProcessorEntry> processor_display;
 281         Gtk::ScrolledWindow    processor_scroller;
 282
 283         void object_drop (Gtkmm2ext::DnDVBox<ProcessorEntry> *, ProcessorEntry *, Glib::RefPtr<Gdk::DragContext> const &);
 284
 285         Width _width;
 286
 287         Gtk::Menu *processor_menu;
 288         gint processor_menu_map_handler (GdkEventAny *ev);
 289         Gtk::Menu * build_processor_menu ();
 290         void show_processor_menu (int);
 291         Gtk::Menu* build_possible_aux_menu();
 292         Gtk::Menu* build_controls_menu (boost::shared_ptr<ARDOUR::Processor>);
 293
 294         void show_or_hide_all_controls (boost::weak_ptr<ARDOUR::Processor>, bool);
 295
 296         void choose_aux (boost::weak_ptr<ARDOUR::Route>);
 297         void choose_send ();
 298         void send_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
 299         void return_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
 300         void choose_insert ();
 301         void choose_plugin ();
 302         bool use_plugins (const SelectedPlugins&);
 303
 304         bool no_processor_redisplay;
 305
 306         bool enter_notify (GdkEventCrossing *ev);
 307         bool leave_notify (GdkEventCrossing *ev);
 308         bool processor_button_press_event (GdkEventButton *, ProcessorEntry *);
 309         bool processor_button_release_event (GdkEventButton *, ProcessorEntry *);
 310         void redisplay_processors ();
 311         void add_processor_to_display (boost::weak_ptr<ARDOUR::Processor>);
 312         void help_count_visible_prefader_processors (boost::weak_ptr<ARDOUR::Processor>, uint32_t*, bool*);
 313         void reordered ();
 314         void report_failed_reorder ();
 315         void route_processors_changed (ARDOUR::RouteProcessorChange);
 316         void processor_menu_unmapped ();
 317
 318         void processors_reordered (const Gtk::TreeModel::Path&, const Gtk::TreeModel::iterator&, int*);
 319         void compute_processor_sort_keys ();
 320
 321         void all_visible_processors_active(bool state);
 322         void ab_plugins ();
 323
 324         typedef std::vector<boost::shared_ptr<ARDOUR::Processor> > ProcSelection;
 325
 326         void cut_processors (const ProcSelection&);
 327         void copy_processors (const ProcSelection&);
 328         void delete_processors (const ProcSelection&);
 329         void paste_processors ();
 330         void paste_processors (boost::shared_ptr<ARDOUR::Processor> before);
 331         void processors_up ();
 332         void processors_down ();
 333
 334         void delete_dragged_processors (const std::list<boost::shared_ptr<ARDOUR::Processor> >&);
 335         void clear_processors ();
 336         void clear_processors (ARDOUR::Placement);
 337         void rename_processors ();
 338
 339         void for_selected_processors (void (ProcessorBox::*pmf)(boost::shared_ptr<ARDOUR::Processor>));
 340         void get_selected_processors (ProcSelection&) const;
 341
 342         bool can_cut() const;
 343
 344         static Glib::RefPtr<Gtk::Action> cut_action;
 345         static Glib::RefPtr<Gtk::Action> paste_action;
 346         static Glib::RefPtr<Gtk::Action> rename_action;
 347         static Glib::RefPtr<Gtk::Action> edit_action;
 348         static Glib::RefPtr<Gtk::Action> controls_action;
 349         void paste_processor_state (const XMLNodeList&, boost::shared_ptr<ARDOUR::Processor>);
 350
 351         void activate_processor (boost::shared_ptr<ARDOUR::Processor>);
 352         void deactivate_processor (boost::shared_ptr<ARDOUR::Processor>);
 353         void hide_processor_editor (boost::shared_ptr<ARDOUR::Processor>);
 354         void rename_processor (boost::shared_ptr<ARDOUR::Processor>);
 355
 356         gint idle_delete_processor (boost::weak_ptr<ARDOUR::Processor>);
 357
 358         void weird_plugin_dialog (ARDOUR::Plugin& p, ARDOUR::Route::ProcessorStreams streams);
 359         void on_size_allocate (Gtk::Allocation &);
 360
 361         void setup_entry_positions ();
 362
 363         static ProcessorBox* _current_processor_box;
 364
 365         static void rb_choose_aux (boost::weak_ptr<ARDOUR::Route>);
 366         static void rb_choose_plugin ();
 367         static void rb_choose_insert ();
 368         static void rb_choose_send ();
 369         static void rb_clear ();
 370         static void rb_clear_pre ();
 371         static void rb_clear_post ();
 372         static void rb_cut ();
 373         static void rb_copy ();
 374         static void rb_paste ();
 375         static void rb_delete ();
 376         static void rb_rename ();
 377         static void rb_select_all ();
 378         static void rb_deselect_all ();
 379         static void rb_activate_all ();
 380         static void rb_deactivate_all ();
 381         static void rb_ab_plugins ();
 382         static void rb_edit ();
 383
 384         void route_property_changed (const PBD::PropertyChange&);
 385         std::string generate_processor_title (boost::shared_ptr<ARDOUR::PluginInsert> pi);
 386
 387         std::list<ProcessorWindowProxy*> _processor_window_proxies;
 388         void set_processor_ui (boost::shared_ptr<ARDOUR::Processor>, Gtk::Window *);
 389         void maybe_add_processor_to_ui_list (boost::weak_ptr<ARDOUR::Processor>);
 390
 391         bool one_processor_can_be_edited ();
 392         bool processor_can_be_edited (boost::shared_ptr<ARDOUR::Processor>);
 393
 394         void mixer_strip_delivery_changed (boost::weak_ptr<ARDOUR::Delivery>);
 395
 396         void update_gui_object_state (ProcessorEntry *);
 397         XMLNode* entry_gui_object_state (ProcessorEntry *);
 398 };
 399
 400 #endif /* __ardour_gtk_processor_box__ */