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