2 Copyright (C) 2004 Paul Davis
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.
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.
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.
20 #ifndef __ardour_gtk_processor_box__
21 #define __ardour_gtk_processor_box__
26 #include <boost/function.hpp>
28 #include <gtkmm/box.h>
29 #include <gtkmm/eventbox.h>
30 #include <gtkmm/menu.h>
31 #include <gtkmm/scrolledwindow.h>
33 #include "gtkmm2ext/auto_spin.h"
34 #include "gtkmm2ext/bindings.h"
35 #include "gtkmm2ext/click_box.h"
36 #include "gtkmm2ext/dndtreeview.h"
37 #include "gtkmm2ext/dndvbox.h"
38 #include "gtkmm2ext/pixfader.h"
39 #include "gtkmm2ext/persistent_tooltip.h"
41 #include "pbd/stateful.h"
42 #include "pbd/signals.h"
44 #include "ardour/types.h"
45 #include "ardour/ardour.h"
46 #include "ardour/plugin_insert.h"
47 #include "ardour/port_insert.h"
48 #include "ardour/processor.h"
49 #include "ardour/route.h"
50 #include "ardour/session_handle.h"
52 #include "pbd/fastlog.h"
54 #include "plugin_interest.h"
55 #include "io_selector.h"
58 #include "ardour_button.h"
59 #include "window_manager.h"
61 class MotionController;
64 class RouteProcessorSelection;
80 class ProcessorWindowProxy : public WM::ProxyBase
83 ProcessorWindowProxy (std::string const &, ProcessorBox *, boost::weak_ptr<ARDOUR::Processor>);
84 ~ProcessorWindowProxy();
86 Gtk::Window* get (bool create = false);
88 boost::weak_ptr<ARDOUR::Processor> processor () const {
92 ARDOUR::SessionHandlePtr* session_handle();
93 void show_the_right_window ();
94 void set_custom_ui_mode(bool use_custom) { want_custom = use_custom; }
96 int set_state (const XMLNode&, int);
97 XMLNode& get_state ();
100 ProcessorBox* _processor_box;
101 boost::weak_ptr<ARDOUR::Processor> _processor;
106 void processor_going_away ();
107 PBD::ScopedConnection going_away_connection;
110 class ProcessorEntry : public Gtkmm2ext::DnDVBoxChild, public sigc::trackable
113 ProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::Processor>, Width);
116 Gtk::EventBox& action_widget ();
117 Gtk::Widget& widget ();
118 std::string drag_text () const;
119 void set_visual_state (Gtkmm2ext::VisualState, bool);
121 bool is_selectable() const {return _selectable;}
122 void set_selectable(bool s) { _selectable = s; }
124 bool drag_data_get (Glib::RefPtr<Gdk::DragContext> const, Gtk::SelectionData &);
125 bool can_copy_state (Gtkmm2ext::DnDVBoxChild*) const;
133 void set_position (Position, uint32_t);
134 bool unknown_processor () const { return _unknown_processor; } ;
135 boost::shared_ptr<ARDOUR::Processor> processor () const;
136 void set_enum_width (Width);
138 /** Hide any widgets that should be hidden */
139 virtual void hide_things ();
141 void show_all_controls ();
142 void hide_all_controls ();
143 void add_control_state (XMLNode *) const;
144 void set_control_state (XMLNode const *);
145 std::string state_id () const;
146 Gtk::Menu* build_controls_menu ();
147 Gtk::Menu* build_send_options_menu ();
150 ArdourButton _button;
153 uint32_t _position_num;
155 virtual void setup_visuals ();
159 bool _unknown_processor;
160 void led_clicked(GdkEventButton *);
161 void processor_active_changed ();
162 void processor_property_changed (const PBD::PropertyChange&);
163 void processor_configuration_changed (const ARDOUR::ChanCount in, const ARDOUR::ChanCount out);
164 std::string name (Width) const;
165 void setup_tooltip ();
167 ProcessorBox* _parent;
168 boost::shared_ptr<ARDOUR::Processor> _processor;
170 PBD::ScopedConnection active_connection;
171 PBD::ScopedConnection name_connection;
172 PBD::ScopedConnection config_connection;
173 ARDOUR::PluginPresetPtr _plugin_preset_pointer;
175 class Control : public sigc::trackable {
177 Control (boost::shared_ptr<ARDOUR::AutomationControl>, std::string const &);
180 void set_visible (bool);
181 void add_state (XMLNode *) const;
182 void set_state (XMLNode const *);
185 bool visible () const {
189 std::string name () const {
196 void slider_adjusted ();
197 void button_clicked ();
198 void button_clicked_event (GdkEventButton *);
199 void control_changed ();
200 std::string state_id () const;
203 boost::weak_ptr<ARDOUR::AutomationControl> _control;
204 /* things for a slider */
205 Gtk::Adjustment _adjustment;
206 Gtkmm2ext::HSliderController _slider;
207 Gtkmm2ext::PersistentTooltip _slider_persistant_tooltip;
208 /* things for a button */
209 ArdourButton _button;
210 bool _ignore_ui_adjustment;
211 PBD::ScopedConnection _connection;
214 sigc::connection timer_connection;
217 std::list<Control*> _controls;
219 void toggle_inline_display_visibility ();
220 void toggle_control_visibility (Control *);
221 void toggle_panner_link ();
223 class PluginDisplay : public Gtk::DrawingArea {
225 PluginDisplay(boost::shared_ptr<ARDOUR::Plugin>, uint32_t max_height = 80);
228 bool on_expose_event (GdkEventExpose *);
229 void on_size_request (Gtk::Requisition* req);
230 boost::shared_ptr<ARDOUR::Plugin> _plug;
231 PBD::ScopedConnection _qdraw_connection;
232 cairo_surface_t* _surf;
233 uint32_t _max_height;
234 uint32_t _cur_height;
238 class PortIcon : public Gtk::DrawingArea {
240 PortIcon(bool input);
241 void set_ports(ARDOUR::ChanCount const ports) { _ports = ports; }
243 bool on_expose_event (GdkEventExpose *);
245 ARDOUR::ChanCount _ports;
248 class RoutingIcon : public Gtk::DrawingArea {
251 _sources = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
252 _sinks = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
254 set_size_request (-1, 4);
256 void set_sources(ARDOUR::ChanCount const sources) { _sources = sources; }
257 void set_sinks(ARDOUR::ChanCount const sinks) { _sinks = sinks; }
258 void set_splitting(const bool splitting) { _splitting = splitting; }
260 bool on_expose_event (GdkEventExpose *);
261 /* the wire icon sits on top of every processor if needed */
262 ARDOUR::ChanCount _sources; // signals available (valid outputs from prev. processor)
263 ARDOUR::ChanCount _sinks; // actual inputs of this processor
268 RoutingIcon _routing_icon;
269 PortIcon _input_icon;
270 PortIcon _output_icon;
271 PluginDisplay *_plugin_display ;
274 class PluginInsertProcessorEntry : public ProcessorEntry
277 PluginInsertProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::PluginInsert>, Width);
282 void plugin_insert_splitting_changed ();
283 boost::shared_ptr<ARDOUR::PluginInsert> _plugin_insert;
285 PBD::ScopedConnection _splitting_connection;
288 class ProcessorBox : public Gtk::HBox, public PluginInterestedObject, public ARDOUR::SessionHandlePtr
291 enum ProcessorOperation {
297 ProcessorsSelectNone,
298 ProcessorsToggleActive,
302 ProcessorBox (ARDOUR::Session*, boost::function<PluginSelector*()> get_plugin_selector,
303 RouteProcessorSelection&, MixerStrip* parent, bool owner_is_mixer = false);
306 void set_route (boost::shared_ptr<ARDOUR::Route>);
307 void set_width (Width);
309 bool processor_operation (ProcessorOperation);
311 void select_all_processors ();
312 void deselect_all_processors ();
313 void select_all_plugins ();
314 void select_all_inserts ();
315 void select_all_sends ();
317 void all_visible_processors_active(bool state);
321 bool edit_aux_send(boost::shared_ptr<ARDOUR::Processor>);
323 /* Everything except a WindowProxy object should use this to get the window */
324 Gtk::Window* get_processor_ui (boost::shared_ptr<ARDOUR::Processor>) const;
326 /* a WindowProxy object can use this */
327 Gtk::Window* get_editor_window (boost::shared_ptr<ARDOUR::Processor>, bool);
328 Gtk::Window* get_generic_editor_window (boost::shared_ptr<ARDOUR::Processor>);
330 void edit_processor (boost::shared_ptr<ARDOUR::Processor>);
331 void generic_edit_processor (boost::shared_ptr<ARDOUR::Processor>);
333 void update_gui_object_state (ProcessorEntry *);
335 sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorSelected;
336 sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorUnselected;
338 static Glib::RefPtr<Gtk::ActionGroup> processor_box_actions;
339 static Gtkmm2ext::Bindings* bindings;
340 static void register_actions();
343 static bool show_all_processors;
347 /* prevent copy construction */
348 ProcessorBox (ProcessorBox const &);
350 boost::shared_ptr<ARDOUR::Route> _route;
351 MixerStrip* _parent_strip; // null if in RouteParamsUI
352 bool _owner_is_mixer;
354 PBD::ScopedConnectionList _mixer_strip_connections;
355 PBD::ScopedConnectionList _route_connections;
357 boost::function<PluginSelector*()> _get_plugin_selector;
359 boost::shared_ptr<ARDOUR::Processor> _processor_being_created;
361 /** Index at which to place a new plugin (based on where the menu was opened), or -1 to
362 * put at the end of the plugin list.
365 uint32_t _visible_prefader_processors;
367 RouteProcessorSelection& _rr_selection;
368 static Gtkmm2ext::ActionMap myactions;
370 static void load_bindings ();
372 void route_going_away ();
374 bool is_editor_mixer_strip() const;
376 Gtkmm2ext::DnDVBox<ProcessorEntry> processor_display;
377 Gtk::ScrolledWindow processor_scroller;
379 boost::shared_ptr<ARDOUR::Processor> find_drop_position (ProcessorEntry* position);
381 void _drop_plugin_preset (Gtk::SelectionData const &, ARDOUR::Route::ProcessorList &);
382 void _drop_plugin (Gtk::SelectionData const &, ARDOUR::Route::ProcessorList &);
384 void plugin_drop (Gtk::SelectionData const &, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context);
385 void object_drop (Gtkmm2ext::DnDVBox<ProcessorEntry> *, ProcessorEntry *, Glib::RefPtr<Gdk::DragContext> const &);
388 bool _redisplay_pending;
390 Gtk::Menu *processor_menu;
391 gint processor_menu_map_handler (GdkEventAny *ev);
392 Gtk::Menu * build_processor_menu ();
393 void show_processor_menu (int);
394 Gtk::Menu* build_possible_aux_menu();
396 void choose_aux (boost::weak_ptr<ARDOUR::Route>);
398 void send_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
399 void return_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
400 void choose_insert ();
401 void choose_plugin ();
403 bool use_plugins (const SelectedPlugins&);
405 bool no_processor_redisplay;
407 bool enter_notify (GdkEventCrossing *ev);
408 bool leave_notify (GdkEventCrossing *ev);
409 bool processor_button_press_event (GdkEventButton *, ProcessorEntry *);
410 bool processor_button_release_event (GdkEventButton *, ProcessorEntry *);
411 void redisplay_processors ();
412 void add_processor_to_display (boost::weak_ptr<ARDOUR::Processor>);
413 void help_count_visible_prefader_processors (boost::weak_ptr<ARDOUR::Processor>, uint32_t*, bool*);
415 void report_failed_reorder ();
416 void route_processors_changed (ARDOUR::RouteProcessorChange);
417 void processor_menu_unmapped ();
419 void processors_reordered (const Gtk::TreeModel::Path&, const Gtk::TreeModel::iterator&, int*);
420 void compute_processor_sort_keys ();
424 typedef std::vector<boost::shared_ptr<ARDOUR::Processor> > ProcSelection;
426 void cut_processors (const ProcSelection&);
427 void copy_processors (const ProcSelection&);
428 void delete_processors (const ProcSelection&);
429 void paste_processors ();
430 void paste_processors (boost::shared_ptr<ARDOUR::Processor> before);
432 void delete_dragged_processors (const std::list<boost::shared_ptr<ARDOUR::Processor> >&);
433 void clear_processors ();
434 void clear_processors (ARDOUR::Placement);
435 void rename_processors ();
437 void for_selected_processors (void (ProcessorBox::*pmf)(boost::shared_ptr<ARDOUR::Processor>));
438 void get_selected_processors (ProcSelection&) const;
440 bool can_cut() const;
441 bool stub_processor_selected() const;
443 static Glib::RefPtr<Gtk::Action> cut_action;
444 static Glib::RefPtr<Gtk::Action> copy_action;
445 static Glib::RefPtr<Gtk::Action> paste_action;
446 static Glib::RefPtr<Gtk::Action> rename_action;
447 static Glib::RefPtr<Gtk::Action> delete_action;
448 static Glib::RefPtr<Gtk::Action> edit_action;
449 static Glib::RefPtr<Gtk::Action> edit_generic_action;
450 void paste_processor_state (const XMLNodeList&, boost::shared_ptr<ARDOUR::Processor>);
452 void hide_processor_editor (boost::shared_ptr<ARDOUR::Processor>);
453 void rename_processor (boost::shared_ptr<ARDOUR::Processor>);
455 gint idle_delete_processor (boost::weak_ptr<ARDOUR::Processor>);
457 void weird_plugin_dialog (ARDOUR::Plugin& p, ARDOUR::Route::ProcessorStreams streams);
459 void setup_entry_positions ();
461 static ProcessorBox* _current_processor_box;
463 static void rb_choose_aux (boost::weak_ptr<ARDOUR::Route>);
464 static void rb_choose_plugin ();
465 static void rb_choose_insert ();
466 static void rb_choose_lua ();
467 static void rb_choose_send ();
468 static void rb_clear ();
469 static void rb_clear_pre ();
470 static void rb_clear_post ();
471 static void rb_cut ();
472 static void rb_copy ();
473 static void rb_paste ();
474 static void rb_delete ();
475 static void rb_rename ();
476 static void rb_select_all ();
477 static void rb_deselect_all ();
478 static void rb_activate_all ();
479 static void rb_deactivate_all ();
480 static void rb_ab_plugins ();
481 static void rb_edit ();
482 static void rb_edit_generic ();
484 void route_property_changed (const PBD::PropertyChange&);
485 std::string generate_processor_title (boost::shared_ptr<ARDOUR::PluginInsert> pi);
487 //typedef std::list<ProcessorWindowProxy*> ProcessorWindowProxies;
488 //ProcessorWindowProxies _processor_window_info;
490 ProcessorWindowProxy* find_window_proxy (boost::shared_ptr<ARDOUR::Processor>) const;
492 void set_processor_ui (boost::shared_ptr<ARDOUR::Processor>, Gtk::Window *);
493 void maybe_add_processor_to_ui_list (boost::weak_ptr<ARDOUR::Processor>);
495 bool one_processor_can_be_edited ();
496 bool processor_can_be_edited (boost::shared_ptr<ARDOUR::Processor>);
498 void mixer_strip_delivery_changed (boost::weak_ptr<ARDOUR::Delivery>);
500 XMLNode* entry_gui_object_state (ProcessorEntry *);
501 PBD::ScopedConnection amp_config_connection;
504 #endif /* __ardour_gtk_processor_box__ */