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>
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 #include "gtkmm2ext/persistent_tooltip.h"
39 #include "pbd/stateful.h"
40 #include "pbd/signals.h"
42 #include "ardour/types.h"
43 #include "ardour/ardour.h"
44 #include "ardour/plugin_insert.h"
45 #include "ardour/port_insert.h"
46 #include "ardour/processor.h"
47 #include "ardour/route.h"
48 #include "ardour/session_handle.h"
50 #include "pbd/fastlog.h"
52 #include "plugin_interest.h"
53 #include "io_selector.h"
56 #include "ardour_button.h"
57 #include "window_manager.h"
59 class MotionController;
62 class RouteProcessorSelection;
78 class ProcessorWindowProxy : public WM::ProxyBase
81 ProcessorWindowProxy (std::string const &, ProcessorBox *, boost::weak_ptr<ARDOUR::Processor>);
82 ~ProcessorWindowProxy();
84 Gtk::Window* get (bool create = false);
86 boost::weak_ptr<ARDOUR::Processor> processor () const {
90 ARDOUR::SessionHandlePtr* session_handle();
92 void set_custom_ui_mode(bool use_custom) { want_custom = use_custom; }
94 void set_state (const XMLNode&);
95 XMLNode& get_state () const;
98 ProcessorBox* _processor_box;
99 boost::weak_ptr<ARDOUR::Processor> _processor;
104 void processor_going_away ();
105 PBD::ScopedConnection going_away_connection;
108 class ProcessorEntry : public Gtkmm2ext::DnDVBoxChild, public sigc::trackable
111 ProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::Processor>, Width);
114 Gtk::EventBox& action_widget ();
115 Gtk::Widget& widget ();
116 std::string drag_text () const;
117 void set_visual_state (Gtkmm2ext::VisualState, bool);
119 bool is_selectable() const {return _selectable;}
120 void set_selectable(bool s) { _selectable = s; }
128 void set_position (Position, uint32_t);
129 bool unknown_processor () const { return _unknown_processor; } ;
130 boost::shared_ptr<ARDOUR::Processor> processor () const;
131 void set_enum_width (Width);
133 /** Hide any widgets that should be hidden */
134 virtual void hide_things ();
136 void show_all_controls ();
137 void hide_all_controls ();
138 void add_control_state (XMLNode *) const;
139 void set_control_state (XMLNode const *);
140 std::string state_id () const;
141 Gtk::Menu* build_controls_menu ();
142 Gtk::Menu* build_send_options_menu ();
145 ArdourButton _button;
148 uint32_t _position_num;
150 virtual void setup_visuals ();
154 bool _unknown_processor;
156 void processor_active_changed ();
157 void processor_property_changed (const PBD::PropertyChange&);
158 void processor_configuration_changed (const ARDOUR::ChanCount in, const ARDOUR::ChanCount out);
159 std::string name (Width) const;
160 void setup_tooltip ();
162 ProcessorBox* _parent;
163 boost::shared_ptr<ARDOUR::Processor> _processor;
165 PBD::ScopedConnection active_connection;
166 PBD::ScopedConnection name_connection;
167 PBD::ScopedConnection config_connection;
169 class Control : public sigc::trackable {
171 Control (boost::shared_ptr<ARDOUR::AutomationControl>, std::string const &);
174 void set_visible (bool);
175 void add_state (XMLNode *) const;
176 void set_state (XMLNode const *);
179 bool visible () const {
183 std::string name () const {
190 void slider_adjusted ();
191 void button_clicked ();
192 void control_changed ();
193 std::string state_id () const;
196 boost::weak_ptr<ARDOUR::AutomationControl> _control;
197 /* things for a slider */
198 Gtk::Adjustment _adjustment;
199 Gtkmm2ext::HSliderController _slider;
200 Gtkmm2ext::PersistentTooltip _slider_persistant_tooltip;
201 /* things for a button */
202 ArdourButton _button;
203 bool _ignore_ui_adjustment;
204 PBD::ScopedConnection _connection;
207 sigc::connection timer_connection;
210 std::list<Control*> _controls;
212 void toggle_control_visibility (Control *);
213 void toggle_panner_link ();
215 class PortIcon : public Gtk::DrawingArea {
217 PortIcon(bool input);
218 void set_ports(ARDOUR::ChanCount const ports) { _ports = ports; }
220 bool on_expose_event (GdkEventExpose *);
222 ARDOUR::ChanCount _ports;
225 class RoutingIcon : public Gtk::DrawingArea {
228 _sources = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
229 _sinks = ARDOUR::ChanCount(ARDOUR::DataType::AUDIO, 1);
231 set_size_request (-1, 4);
233 void set_sources(ARDOUR::ChanCount const sources) { _sources = sources; }
234 void set_sinks(ARDOUR::ChanCount const sinks) { _sinks = sinks; }
235 void set_splitting(const bool splitting) { _splitting = splitting; }
237 bool on_expose_event (GdkEventExpose *);
238 /* the wire icon sits on top of every processor if needed */
239 ARDOUR::ChanCount _sources; // signals available (valid outputs from prev. processor)
240 ARDOUR::ChanCount _sinks; // actual inputs of this processor
245 RoutingIcon _routing_icon;
246 PortIcon _input_icon;
247 PortIcon _output_icon;
250 class PluginInsertProcessorEntry : public ProcessorEntry
253 PluginInsertProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::PluginInsert>, Width);
258 void plugin_insert_splitting_changed ();
259 boost::shared_ptr<ARDOUR::PluginInsert> _plugin_insert;
261 PBD::ScopedConnection _splitting_connection;
264 class ProcessorBox : public Gtk::HBox, public PluginInterestedObject, public ARDOUR::SessionHandlePtr
267 enum ProcessorOperation {
273 ProcessorsSelectNone,
274 ProcessorsToggleActive,
278 ProcessorBox (ARDOUR::Session*, boost::function<PluginSelector*()> get_plugin_selector,
279 RouteProcessorSelection&, MixerStrip* parent, bool owner_is_mixer = false);
282 void set_route (boost::shared_ptr<ARDOUR::Route>);
283 void set_width (Width);
285 bool processor_operation (ProcessorOperation);
287 void select_all_processors ();
288 void deselect_all_processors ();
289 void select_all_plugins ();
290 void select_all_inserts ();
291 void select_all_sends ();
295 bool edit_aux_send(boost::shared_ptr<ARDOUR::Processor>);
297 /* Everything except a WindowProxy object should use this to get the window */
298 Gtk::Window* get_processor_ui (boost::shared_ptr<ARDOUR::Processor>) const;
300 /* a WindowProxy object can use this */
301 Gtk::Window* get_editor_window (boost::shared_ptr<ARDOUR::Processor>, bool);
302 Gtk::Window* get_generic_editor_window (boost::shared_ptr<ARDOUR::Processor>);
304 void edit_processor (boost::shared_ptr<ARDOUR::Processor>);
305 void generic_edit_processor (boost::shared_ptr<ARDOUR::Processor>);
307 void update_gui_object_state (ProcessorEntry *);
309 sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorSelected;
310 sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorUnselected;
312 static void register_actions();
316 /* prevent copy construction */
317 ProcessorBox (ProcessorBox const &);
319 boost::shared_ptr<ARDOUR::Route> _route;
320 MixerStrip* _parent_strip; // null if in RouteParamsUI
321 bool _owner_is_mixer;
323 PBD::ScopedConnectionList _mixer_strip_connections;
324 PBD::ScopedConnectionList _route_connections;
326 boost::function<PluginSelector*()> _get_plugin_selector;
328 boost::shared_ptr<ARDOUR::Processor> _processor_being_created;
330 /** Index at which to place a new plugin (based on where the menu was opened), or -1 to
331 * put at the end of the plugin list.
334 uint32_t _visible_prefader_processors;
336 RouteProcessorSelection& _rr_selection;
338 void route_going_away ();
340 bool is_editor_mixer_strip() const;
342 Gtkmm2ext::DnDVBox<ProcessorEntry> processor_display;
343 Gtk::ScrolledWindow processor_scroller;
345 void object_drop (Gtkmm2ext::DnDVBox<ProcessorEntry> *, ProcessorEntry *, Glib::RefPtr<Gdk::DragContext> const &);
348 bool _redisplay_pending;
350 Gtk::Menu *processor_menu;
351 gint processor_menu_map_handler (GdkEventAny *ev);
352 Gtk::Menu * build_processor_menu ();
353 void show_processor_menu (int);
354 Gtk::Menu* build_possible_aux_menu();
356 void choose_aux (boost::weak_ptr<ARDOUR::Route>);
358 void send_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
359 void return_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
360 void choose_insert ();
361 void choose_plugin ();
362 bool use_plugins (const SelectedPlugins&);
364 bool no_processor_redisplay;
366 bool enter_notify (GdkEventCrossing *ev);
367 bool leave_notify (GdkEventCrossing *ev);
368 bool processor_button_press_event (GdkEventButton *, ProcessorEntry *);
369 bool processor_button_release_event (GdkEventButton *, ProcessorEntry *);
370 void redisplay_processors ();
371 void add_processor_to_display (boost::weak_ptr<ARDOUR::Processor>);
372 void help_count_visible_prefader_processors (boost::weak_ptr<ARDOUR::Processor>, uint32_t*, bool*);
374 void report_failed_reorder ();
375 void route_processors_changed (ARDOUR::RouteProcessorChange);
376 void processor_menu_unmapped ();
378 void processors_reordered (const Gtk::TreeModel::Path&, const Gtk::TreeModel::iterator&, int*);
379 void compute_processor_sort_keys ();
381 void all_visible_processors_active(bool state);
384 typedef std::vector<boost::shared_ptr<ARDOUR::Processor> > ProcSelection;
386 void cut_processors (const ProcSelection&);
387 void copy_processors (const ProcSelection&);
388 void delete_processors (const ProcSelection&);
389 void paste_processors ();
390 void paste_processors (boost::shared_ptr<ARDOUR::Processor> before);
392 void delete_dragged_processors (const std::list<boost::shared_ptr<ARDOUR::Processor> >&);
393 void clear_processors ();
394 void clear_processors (ARDOUR::Placement);
395 void rename_processors ();
397 void for_selected_processors (void (ProcessorBox::*pmf)(boost::shared_ptr<ARDOUR::Processor>));
398 void get_selected_processors (ProcSelection&) const;
400 bool can_cut() const;
401 bool stub_processor_selected() const;
403 static Glib::RefPtr<Gtk::Action> cut_action;
404 static Glib::RefPtr<Gtk::Action> copy_action;
405 static Glib::RefPtr<Gtk::Action> paste_action;
406 static Glib::RefPtr<Gtk::Action> rename_action;
407 static Glib::RefPtr<Gtk::Action> delete_action;
408 static Glib::RefPtr<Gtk::Action> edit_action;
409 static Glib::RefPtr<Gtk::Action> edit_generic_action;
410 void paste_processor_state (const XMLNodeList&, boost::shared_ptr<ARDOUR::Processor>);
412 void hide_processor_editor (boost::shared_ptr<ARDOUR::Processor>);
413 void rename_processor (boost::shared_ptr<ARDOUR::Processor>);
415 gint idle_delete_processor (boost::weak_ptr<ARDOUR::Processor>);
417 void weird_plugin_dialog (ARDOUR::Plugin& p, ARDOUR::Route::ProcessorStreams streams);
419 void setup_entry_positions ();
421 static ProcessorBox* _current_processor_box;
423 static void rb_choose_aux (boost::weak_ptr<ARDOUR::Route>);
424 static void rb_choose_plugin ();
425 static void rb_choose_insert ();
426 static void rb_choose_send ();
427 static void rb_clear ();
428 static void rb_clear_pre ();
429 static void rb_clear_post ();
430 static void rb_cut ();
431 static void rb_copy ();
432 static void rb_paste ();
433 static void rb_delete ();
434 static void rb_rename ();
435 static void rb_select_all ();
436 static void rb_deselect_all ();
437 static void rb_activate_all ();
438 static void rb_deactivate_all ();
439 static void rb_ab_plugins ();
440 static void rb_edit ();
441 static void rb_edit_generic ();
443 void route_property_changed (const PBD::PropertyChange&);
444 std::string generate_processor_title (boost::shared_ptr<ARDOUR::PluginInsert> pi);
446 //typedef std::list<ProcessorWindowProxy*> ProcessorWindowProxies;
447 //ProcessorWindowProxies _processor_window_info;
449 ProcessorWindowProxy* find_window_proxy (boost::shared_ptr<ARDOUR::Processor>) const;
451 void set_processor_ui (boost::shared_ptr<ARDOUR::Processor>, Gtk::Window *);
452 void maybe_add_processor_to_ui_list (boost::weak_ptr<ARDOUR::Processor>);
454 bool one_processor_can_be_edited ();
455 bool processor_can_be_edited (boost::shared_ptr<ARDOUR::Processor>);
457 void mixer_strip_delivery_changed (boost::weak_ptr<ARDOUR::Delivery>);
459 XMLNode* entry_gui_object_state (ProcessorEntry *);
460 PBD::ScopedConnection amp_config_connection;
463 #endif /* __ardour_gtk_processor_box__ */