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"
38 #include "pbd/stateful.h"
39 #include "pbd/signals.h"
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"
49 #include "pbd/fastlog.h"
51 #include "plugin_interest.h"
52 #include "io_selector.h"
55 #include "window_proxy.h"
56 #include "ardour_button.h"
58 class MotionController;
61 class RouteProcessorSelection;
77 /** A WindowProxy for Processor UI windows; it knows how to ask a ProcessorBox
78 * to create a UI window for a particular processor.
80 class ProcessorWindowProxy : public WindowProxy<Gtk::Window>
83 ProcessorWindowProxy (std::string const &, XMLNode const *, ProcessorBox *, boost::weak_ptr<ARDOUR::Processor>);
86 bool rc_configured () const {
90 boost::weak_ptr<ARDOUR::Processor> processor () const {
97 ProcessorBox* _processor_box;
98 boost::weak_ptr<ARDOUR::Processor> _processor;
101 class ProcessorEntry : public Gtkmm2ext::DnDVBoxChild, public sigc::trackable
104 ProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::Processor>, Width);
107 Gtk::EventBox& action_widget ();
108 Gtk::Widget& widget ();
109 std::string drag_text () const;
110 void set_visual_state (Gtkmm2ext::VisualState, bool);
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);
123 /** Hide any widgets that should be hidden */
124 virtual void hide_things ();
126 void show_all_controls ();
127 void hide_all_controls ();
128 void add_control_state (XMLNode *) const;
129 void set_control_state (XMLNode const *);
130 std::string state_id () const;
131 Gtk::Menu* build_controls_menu ();
133 static void setup_slider_pix ();
136 ArdourButton _button;
140 virtual void setup_visuals ();
142 static Glib::RefPtr<Gdk::Pixbuf> _slider_pixbuf;
146 void processor_active_changed ();
147 void processor_property_changed (const PBD::PropertyChange&);
148 std::string name (Width) const;
149 void setup_tooltip ();
151 ProcessorBox* _parent;
152 boost::shared_ptr<ARDOUR::Processor> _processor;
154 Gtk::StateType _visual_state;
155 PBD::ScopedConnection active_connection;
156 PBD::ScopedConnection name_connection;
160 Control (Glib::RefPtr<Gdk::Pixbuf>, boost::shared_ptr<ARDOUR::AutomationControl>, std::string const &);
162 void set_pixel_width (int);
163 void set_visible (bool);
164 void add_state (XMLNode *) const;
165 void set_state (XMLNode const *);
169 bool visible () const {
173 std::string name () const {
180 void slider_adjusted ();
181 void button_clicked ();
182 void control_changed ();
183 std::string state_id () const;
186 boost::weak_ptr<ARDOUR::AutomationControl> _control;
187 /* things for a slider */
188 Gtk::Adjustment _adjustment;
189 Gtkmm2ext::HSliderController _slider;
191 /* things for a button */
192 ArdourButton _button;
193 bool _ignore_ui_adjustment;
194 PBD::ScopedConnection _connection;
199 std::list<Control*> _controls;
201 void toggle_control_visibility (Control *);
204 class BlankProcessorEntry : public ProcessorEntry
207 BlankProcessorEntry (ProcessorBox *, Width w);
210 class PluginInsertProcessorEntry : public ProcessorEntry
213 PluginInsertProcessorEntry (ProcessorBox *, boost::shared_ptr<ARDOUR::PluginInsert>, Width);
218 void setup_visuals ();
219 void plugin_insert_splitting_changed ();
221 /* XXX: this seems a little ridiculous just for a simple scaleable icon */
222 class SplittingIcon : public Gtk::DrawingArea {
224 bool on_expose_event (GdkEventExpose *);
227 boost::shared_ptr<ARDOUR::PluginInsert> _plugin_insert;
228 SplittingIcon _splitting_icon;
229 PBD::ScopedConnection _splitting_connection;
232 class ProcessorBox : public Gtk::HBox, public PluginInterestedObject, public ARDOUR::SessionHandlePtr
235 enum ProcessorOperation {
241 ProcessorsToggleActive,
245 ProcessorBox (ARDOUR::Session*, boost::function<PluginSelector*()> get_plugin_selector,
246 RouteProcessorSelection&, MixerStrip* parent, bool owner_is_mixer = false);
249 void set_route (boost::shared_ptr<ARDOUR::Route>);
250 void set_width (Width);
252 void processor_operation (ProcessorOperation);
254 void select_all_processors ();
255 void deselect_all_processors ();
256 void select_all_plugins ();
257 void select_all_inserts ();
258 void select_all_sends ();
262 Gtk::Window* get_processor_ui (boost::shared_ptr<ARDOUR::Processor>) const;
263 void toggle_edit_processor (boost::shared_ptr<ARDOUR::Processor>);
264 void toggle_edit_generic_processor (boost::shared_ptr<ARDOUR::Processor>);
266 void update_gui_object_state (ProcessorEntry *);
268 sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorSelected;
269 sigc::signal<void,boost::shared_ptr<ARDOUR::Processor> > ProcessorUnselected;
271 static void register_actions();
275 /* prevent copy construction */
276 ProcessorBox (ProcessorBox const &);
278 boost::shared_ptr<ARDOUR::Route> _route;
279 MixerStrip* _parent_strip; // null if in RouteParamsUI
280 bool _owner_is_mixer;
282 PBD::ScopedConnectionList _mixer_strip_connections;
283 PBD::ScopedConnectionList _route_connections;
285 boost::function<PluginSelector*()> _get_plugin_selector;
287 boost::shared_ptr<ARDOUR::Processor> _processor_being_created;
289 /** Index at which to place a new plugin (based on where the menu was opened), or -1 to
290 * put at the end of the plugin list.
293 uint32_t _visible_prefader_processors;
295 RouteProcessorSelection& _rr_selection;
297 void route_going_away ();
299 Gtkmm2ext::DnDVBox<ProcessorEntry> processor_display;
300 Gtk::ScrolledWindow processor_scroller;
302 void object_drop (Gtkmm2ext::DnDVBox<ProcessorEntry> *, ProcessorEntry *, Glib::RefPtr<Gdk::DragContext> const &);
306 Gtk::Menu *processor_menu;
307 gint processor_menu_map_handler (GdkEventAny *ev);
308 Gtk::Menu * build_processor_menu ();
309 void show_processor_menu (int);
310 Gtk::Menu* build_possible_aux_menu();
312 void choose_aux (boost::weak_ptr<ARDOUR::Route>);
314 void send_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
315 void return_io_finished (IOSelector::Result, boost::weak_ptr<ARDOUR::Processor>, IOSelectorWindow*);
316 void choose_insert ();
317 void choose_plugin ();
318 bool use_plugins (const SelectedPlugins&);
320 bool no_processor_redisplay;
322 bool enter_notify (GdkEventCrossing *ev);
323 bool leave_notify (GdkEventCrossing *ev);
324 bool processor_button_press_event (GdkEventButton *, ProcessorEntry *);
325 bool processor_button_release_event (GdkEventButton *, ProcessorEntry *);
326 void redisplay_processors ();
327 void add_processor_to_display (boost::weak_ptr<ARDOUR::Processor>);
328 void help_count_visible_prefader_processors (boost::weak_ptr<ARDOUR::Processor>, uint32_t*, bool*);
330 void report_failed_reorder ();
331 void route_processors_changed (ARDOUR::RouteProcessorChange);
332 void processor_menu_unmapped ();
334 void processors_reordered (const Gtk::TreeModel::Path&, const Gtk::TreeModel::iterator&, int*);
335 void compute_processor_sort_keys ();
337 void all_visible_processors_active(bool state);
340 typedef std::vector<boost::shared_ptr<ARDOUR::Processor> > ProcSelection;
342 void cut_processors (const ProcSelection&);
343 void copy_processors (const ProcSelection&);
344 void delete_processors (const ProcSelection&);
345 void paste_processors ();
346 void paste_processors (boost::shared_ptr<ARDOUR::Processor> before);
348 void delete_dragged_processors (const std::list<boost::shared_ptr<ARDOUR::Processor> >&);
349 void clear_processors ();
350 void clear_processors (ARDOUR::Placement);
351 void rename_processors ();
353 void for_selected_processors (void (ProcessorBox::*pmf)(boost::shared_ptr<ARDOUR::Processor>));
354 void get_selected_processors (ProcSelection&) const;
356 bool can_cut() const;
358 static Glib::RefPtr<Gtk::Action> cut_action;
359 static Glib::RefPtr<Gtk::Action> paste_action;
360 static Glib::RefPtr<Gtk::Action> rename_action;
361 static Glib::RefPtr<Gtk::Action> edit_action;
362 static Glib::RefPtr<Gtk::Action> edit_generic_action;
363 void paste_processor_state (const XMLNodeList&, boost::shared_ptr<ARDOUR::Processor>);
365 void hide_processor_editor (boost::shared_ptr<ARDOUR::Processor>);
366 void rename_processor (boost::shared_ptr<ARDOUR::Processor>);
368 gint idle_delete_processor (boost::weak_ptr<ARDOUR::Processor>);
370 void weird_plugin_dialog (ARDOUR::Plugin& p, ARDOUR::Route::ProcessorStreams streams);
371 void on_size_allocate (Gtk::Allocation &);
373 void setup_entry_positions ();
375 static ProcessorBox* _current_processor_box;
377 static void rb_choose_aux (boost::weak_ptr<ARDOUR::Route>);
378 static void rb_choose_plugin ();
379 static void rb_choose_insert ();
380 static void rb_choose_send ();
381 static void rb_clear ();
382 static void rb_clear_pre ();
383 static void rb_clear_post ();
384 static void rb_cut ();
385 static void rb_copy ();
386 static void rb_paste ();
387 static void rb_delete ();
388 static void rb_rename ();
389 static void rb_select_all ();
390 static void rb_deselect_all ();
391 static void rb_activate_all ();
392 static void rb_deactivate_all ();
393 static void rb_ab_plugins ();
394 static void rb_edit ();
395 static void rb_edit_generic ();
397 void route_property_changed (const PBD::PropertyChange&);
398 std::string generate_processor_title (boost::shared_ptr<ARDOUR::PluginInsert> pi);
400 std::list<ProcessorWindowProxy*> _processor_window_proxies;
401 void set_processor_ui (boost::shared_ptr<ARDOUR::Processor>, Gtk::Window *);
402 void maybe_add_processor_to_ui_list (boost::weak_ptr<ARDOUR::Processor>);
404 bool one_processor_can_be_edited ();
405 bool processor_can_be_edited (boost::shared_ptr<ARDOUR::Processor>);
407 void mixer_strip_delivery_changed (boost::weak_ptr<ARDOUR::Delivery>);
409 XMLNode* entry_gui_object_state (ProcessorEntry *);
412 #endif /* __ardour_gtk_processor_box__ */