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