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