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