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 &);
132 void set_position (Position, uint32_t);
133 bool unknown_processor () const { return _unknown_processor; } ;
134 boost::shared_ptr<ARDOUR::Processor> processor () const;
135 void set_enum_width (Width);
137 /** Hide any widgets that should be hidden */
138 virtual void hide_things ();
140 void show_all_controls ();
141 void hide_all_controls ();
142 void add_control_state (XMLNode *) const;
143 void set_control_state (XMLNode const *);
144 std::string state_id () const;
145 Gtk::Menu* build_controls_menu ();
146 Gtk::Menu* build_send_options_menu ();
149 ArdourButton _button;
152 uint32_t _position_num;
154 virtual void setup_visuals ();
158 bool _unknown_processor;
159 void led_clicked(GdkEventButton *);
160 void processor_active_changed ();
161 void processor_property_changed (const PBD::PropertyChange&);
162 void processor_configuration_changed (const ARDOUR::ChanCount in, const ARDOUR::ChanCount out);
163 std::string name (Width) const;
164 void setup_tooltip ();
166 ProcessorBox* _parent;
167 boost::shared_ptr<ARDOUR::Processor> _processor;
169 PBD::ScopedConnection active_connection;
170 PBD::ScopedConnection name_connection;
171 PBD::ScopedConnection config_connection;
172 ARDOUR::PluginPresetPtr _plugin_preset_pointer;
174 class Control : public sigc::trackable {
176 Control (boost::shared_ptr<ARDOUR::AutomationControl>, std::string const &);
179 void set_visible (bool);
180 void add_state (XMLNode *) const;
181 void set_state (XMLNode const *);
184 bool visible () const {
188 std::string name () const {
195 void slider_adjusted ();
196 void button_clicked ();
197 void button_clicked_event (GdkEventButton *);
198 void control_changed ();
199 std::string state_id () const;
202 boost::weak_ptr<ARDOUR::AutomationControl> _control;
203 /* things for a slider */
204 Gtk::Adjustment _adjustment;
205 Gtkmm2ext::HSliderController _slider;
206 Gtkmm2ext::PersistentTooltip _slider_persistant_tooltip;
207 /* things for a button */
208 ArdourButton _button;
209 bool _ignore_ui_adjustment;
210 PBD::ScopedConnection _connection;
213 sigc::connection timer_connection;
216 std::list<Control*> _controls;
218 void toggle_control_visibility (Control *);
219 void toggle_panner_link ();
221 class PortIcon : public Gtk::DrawingArea {
223 PortIcon(bool input);
224 void set_ports(ARDOUR::ChanCount const ports) { _ports = ports; }
226 bool on_expose_event (GdkEventExpose *);
228 ARDOUR::ChanCount _ports;
231 class RoutingIcon : public Gtk::DrawingArea {
234 _sources = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
235 _sinks = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
237 set_size_request (-1, 4);
239 void set_sources(ARDOUR::ChanCount const sources) { _sources = sources; }
240 void set_sinks(ARDOUR::ChanCount const sinks) { _sinks = sinks; }
241 void set_splitting(const bool splitting) { _splitting = splitting; }
243 bool on_expose_event (GdkEventExpose *);
244 /* the wire icon sits on top of every processor if needed */
245 ARDOUR::ChanCount _sources; // signals available (valid outputs from prev. processor)
246 ARDOUR::ChanCount _sinks; // actual inputs of this processor
251 RoutingIcon _routing_icon;
252 PortIcon _input_icon;
253 PortIcon _output_icon;
256 class PluginInsertProcessorEntry : public ProcessorEntry
259 PluginInsertProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::PluginInsert>, Width);
264 void plugin_insert_splitting_changed ();
265 boost::shared_ptr<ARDOUR::PluginInsert> _plugin_insert;
267 PBD::ScopedConnection _splitting_connection;
270 class ProcessorBox : public Gtk::HBox, public PluginInterestedObject, public ARDOUR::SessionHandlePtr
273 enum ProcessorOperation {
279 ProcessorsSelectNone,
280 ProcessorsToggleActive,
284 ProcessorBox (ARDOUR::Session*, boost::function<PluginSelector*()> get_plugin_selector,
285 RouteProcessorSelection&, MixerStrip* parent, bool owner_is_mixer = false);
288 void set_route (boost::shared_ptr<ARDOUR::Route>);
289 void set_width (Width);
291 bool processor_operation (ProcessorOperation);
293 void select_all_processors ();
294 void deselect_all_processors ();
295 void select_all_plugins ();
296 void select_all_inserts ();
297 void select_all_sends ();
299 void all_visible_processors_active(bool state);
303 bool edit_aux_send(boost::shared_ptr<ARDOUR::Processor>);
305 /* Everything except a WindowProxy object should use this to get the window */
306 Gtk::Window* get_processor_ui (boost::shared_ptr<ARDOUR::Processor>) const;
308 /* a WindowProxy object can use this */
309 Gtk::Window* get_editor_window (boost::shared_ptr<ARDOUR::Processor>, bool);
310 Gtk::Window* get_generic_editor_window (boost::shared_ptr<ARDOUR::Processor>);
312 void edit_processor (boost::shared_ptr<ARDOUR::Processor>);
313 void generic_edit_processor (boost::shared_ptr<ARDOUR::Processor>);
315 void update_gui_object_state (ProcessorEntry *);
317 sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorSelected;
318 sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorUnselected;
320 static void register_actions();
322 static bool show_all_processors;
326 /* prevent copy construction */
327 ProcessorBox (ProcessorBox const &);
329 boost::shared_ptr<ARDOUR::Route> _route;
330 MixerStrip* _parent_strip; // null if in RouteParamsUI
331 bool _owner_is_mixer;
333 PBD::ScopedConnectionList _mixer_strip_connections;
334 PBD::ScopedConnectionList _route_connections;
336 boost::function<PluginSelector*()> _get_plugin_selector;
338 boost::shared_ptr<ARDOUR::Processor> _processor_being_created;
340 /** Index at which to place a new plugin (based on where the menu was opened), or -1 to
341 * put at the end of the plugin list.
344 uint32_t _visible_prefader_processors;
346 RouteProcessorSelection& _rr_selection;
348 void route_going_away ();
350 bool is_editor_mixer_strip() const;
352 Gtkmm2ext::DnDVBox<ProcessorEntry> processor_display;
353 Gtk::ScrolledWindow processor_scroller;
355 boost::shared_ptr<ARDOUR::Processor> find_drop_position (ProcessorEntry* position);
357 void _drop_plugin_preset (Gtk::SelectionData const &, ARDOUR::Route::ProcessorList &);
358 void _drop_plugin (Gtk::SelectionData const &, ARDOUR::Route::ProcessorList &);
360 void plugin_drop (Gtk::SelectionData const &, ProcessorEntry* position, Glib::RefPtr<Gdk::DragContext> const & context);
361 void object_drop (Gtkmm2ext::DnDVBox<ProcessorEntry> *, ProcessorEntry *, Glib::RefPtr<Gdk::DragContext> const &);
364 bool _redisplay_pending;
366 Gtk::Menu *processor_menu;
367 gint processor_menu_map_handler (GdkEventAny *ev);
368 Gtk::Menu * build_processor_menu ();
369 void show_processor_menu (int);
370 Gtk::Menu* build_possible_aux_menu();
372 void choose_aux (boost::weak_ptr<ARDOUR::Route>);
374 void send_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
375 void return_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
376 void choose_insert ();
377 void choose_plugin ();
378 bool use_plugins (const SelectedPlugins&);
380 bool no_processor_redisplay;
382 bool enter_notify (GdkEventCrossing *ev);
383 bool leave_notify (GdkEventCrossing *ev);
384 bool processor_button_press_event (GdkEventButton *, ProcessorEntry *);
385 bool processor_button_release_event (GdkEventButton *, ProcessorEntry *);
386 void redisplay_processors ();
387 void add_processor_to_display (boost::weak_ptr<ARDOUR::Processor>);
388 void help_count_visible_prefader_processors (boost::weak_ptr<ARDOUR::Processor>, uint32_t*, bool*);
390 void report_failed_reorder ();
391 void route_processors_changed (ARDOUR::RouteProcessorChange);
392 void processor_menu_unmapped ();
394 void processors_reordered (const Gtk::TreeModel::Path&, const Gtk::TreeModel::iterator&, int*);
395 void compute_processor_sort_keys ();
399 typedef std::vector<boost::shared_ptr<ARDOUR::Processor> > ProcSelection;
401 void cut_processors (const ProcSelection&);
402 void copy_processors (const ProcSelection&);
403 void delete_processors (const ProcSelection&);
404 void paste_processors ();
405 void paste_processors (boost::shared_ptr<ARDOUR::Processor> before);
407 void delete_dragged_processors (const std::list<boost::shared_ptr<ARDOUR::Processor> >&);
408 void clear_processors ();
409 void clear_processors (ARDOUR::Placement);
410 void rename_processors ();
412 void for_selected_processors (void (ProcessorBox::*pmf)(boost::shared_ptr<ARDOUR::Processor>));
413 void get_selected_processors (ProcSelection&) const;
415 bool can_cut() const;
416 bool stub_processor_selected() const;
418 static Glib::RefPtr<Gtk::Action> cut_action;
419 static Glib::RefPtr<Gtk::Action> copy_action;
420 static Glib::RefPtr<Gtk::Action> paste_action;
421 static Glib::RefPtr<Gtk::Action> rename_action;
422 static Glib::RefPtr<Gtk::Action> delete_action;
423 static Glib::RefPtr<Gtk::Action> edit_action;
424 static Glib::RefPtr<Gtk::Action> edit_generic_action;
425 void paste_processor_state (const XMLNodeList&, boost::shared_ptr<ARDOUR::Processor>);
427 void hide_processor_editor (boost::shared_ptr<ARDOUR::Processor>);
428 void rename_processor (boost::shared_ptr<ARDOUR::Processor>);
430 gint idle_delete_processor (boost::weak_ptr<ARDOUR::Processor>);
432 void weird_plugin_dialog (ARDOUR::Plugin& p, ARDOUR::Route::ProcessorStreams streams);
434 void setup_entry_positions ();
436 static ProcessorBox* _current_processor_box;
438 static void rb_choose_aux (boost::weak_ptr<ARDOUR::Route>);
439 static void rb_choose_plugin ();
440 static void rb_choose_insert ();
441 static void rb_choose_send ();
442 static void rb_clear ();
443 static void rb_clear_pre ();
444 static void rb_clear_post ();
445 static void rb_cut ();
446 static void rb_copy ();
447 static void rb_paste ();
448 static void rb_delete ();
449 static void rb_rename ();
450 static void rb_select_all ();
451 static void rb_deselect_all ();
452 static void rb_activate_all ();
453 static void rb_deactivate_all ();
454 static void rb_ab_plugins ();
455 static void rb_edit ();
456 static void rb_edit_generic ();
458 void route_property_changed (const PBD::PropertyChange&);
459 std::string generate_processor_title (boost::shared_ptr<ARDOUR::PluginInsert> pi);
461 //typedef std::list<ProcessorWindowProxy*> ProcessorWindowProxies;
462 //ProcessorWindowProxies _processor_window_info;
464 ProcessorWindowProxy* find_window_proxy (boost::shared_ptr<ARDOUR::Processor>) const;
466 void set_processor_ui (boost::shared_ptr<ARDOUR::Processor>, Gtk::Window *);
467 void maybe_add_processor_to_ui_list (boost::weak_ptr<ARDOUR::Processor>);
469 bool one_processor_can_be_edited ();
470 bool processor_can_be_edited (boost::shared_ptr<ARDOUR::Processor>);
472 void mixer_strip_delivery_changed (boost::weak_ptr<ARDOUR::Delivery>);
474 XMLNode* entry_gui_object_state (ProcessorEntry *);
475 PBD::ScopedConnection amp_config_connection;
477 static Gtkmm2ext::ActionMap processor_box_actions;
480 #endif /* __ardour_gtk_processor_box__ */