Bit of a hack to make the port matrix for port inserts at least vaguely usable.
[ardour.git] / gtk2_ardour / io_selector.cc
1 /*
2     Copyright (C) 2002-2007 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 #include <gtkmm/messagedialog.h>
21 #include <glibmm/objectbase.h>
22
23 #include <gtkmm2ext/doi.h>
24
25 #include <ardour/port_insert.h>
26 #include "ardour/session.h"
27 #include "ardour/io.h"
28 #include "ardour/audioengine.h"
29 #include "ardour/track.h"
30 #include "ardour/audio_track.h"
31 #include "ardour/midi_track.h"
32 #include "ardour/data_type.h"
33 #include "ardour/port.h"
34 #include "ardour/bundle.h"
35
36 #include "io_selector.h"
37 #include "utils.h"
38 #include "gui_thread.h"
39 #include "i18n.h"
40
41 using namespace ARDOUR;
42 using namespace Gtk;
43
44 IOSelector::IOSelector (ARDOUR::Session& session, boost::shared_ptr<ARDOUR::IO> io, bool in)
45         : PortMatrix (session, io->default_type())
46         , _io (io)
47         , _find_inputs_for_io_outputs (in)
48 {
49         /* signal flow from 0 to 1 */
50         if (_find_inputs_for_io_outputs) {
51                 _other = 1;
52                 _ours = 0;
53         } else {
54                 _other = 0;
55                 _ours = 1;
56         }
57
58         _port_group = boost::shared_ptr<PortGroup> (new PortGroup (""));
59         _ports[_ours].add_group (_port_group);
60         
61         setup_all_ports ();
62 }
63
64 void
65 IOSelector::setup_ports (int dim)
66 {
67         _ports[dim].suspend_signals ();
68
69         if (dim == _other) {
70
71                 _ports[_other].gather (_session, _find_inputs_for_io_outputs);
72                 
73         } else {
74
75                 _port_group->clear ();
76                 _port_group->add_bundle (
77                         _find_inputs_for_io_outputs ? _io->bundle_for_outputs() : _io->bundle_for_inputs()
78                         );
79         }
80
81         _ports[dim].resume_signals ();
82 }
83
84 void
85 IOSelector::set_state (ARDOUR::BundleChannel c[2], bool s)
86 {
87         ARDOUR::Bundle::PortList const & our_ports = c[_ours].bundle->channel_ports (c[_ours].channel);
88         ARDOUR::Bundle::PortList const & other_ports = c[_other].bundle->channel_ports (c[_other].channel);
89
90         for (ARDOUR::Bundle::PortList::const_iterator i = our_ports.begin(); i != our_ports.end(); ++i) {
91                 for (ARDOUR::Bundle::PortList::const_iterator j = other_ports.begin(); j != other_ports.end(); ++j) {
92
93                         Port* f = _session.engine().get_port_by_name (*i);
94                         if (!f) {
95                                 return;
96                         }
97
98                         if (s) {
99                                 if (!_find_inputs_for_io_outputs) {
100                                         _io->connect_input (f, *j, 0);
101                                 } else {
102                                         _io->connect_output (f, *j, 0);
103                                 }
104                         } else {
105                                 if (!_find_inputs_for_io_outputs) {
106                                         _io->disconnect_input (f, *j, 0);
107                                 } else {
108                                         _io->disconnect_output (f, *j, 0);
109                                 }
110                         }
111                 }
112         }
113 }
114
115 PortMatrix::State
116 IOSelector::get_state (ARDOUR::BundleChannel c[2]) const
117 {
118         ARDOUR::Bundle::PortList const & our_ports = c[_ours].bundle->channel_ports (c[_ours].channel);
119         ARDOUR::Bundle::PortList const & other_ports = c[_other].bundle->channel_ports (c[_other].channel);
120
121         for (ARDOUR::Bundle::PortList::const_iterator i = our_ports.begin(); i != our_ports.end(); ++i) {
122                 for (ARDOUR::Bundle::PortList::const_iterator j = other_ports.begin(); j != other_ports.end(); ++j) {
123
124                         Port* f = _session.engine().get_port_by_name (*i);
125
126                         /* since we are talking about an IO, our ports should all have an associated Port *,
127                            so the above call should never fail */
128                         assert (f);
129                         
130                         if (!f->connected_to (*j)) {
131                                 /* if any one thing is not connected, all bets are off */
132                                 return NOT_ASSOCIATED;
133                         }
134                 }
135         }
136
137         return ASSOCIATED;
138 }
139
140 uint32_t
141 IOSelector::n_io_ports () const
142 {
143         if (!_find_inputs_for_io_outputs) {
144                 return _io->inputs().num_ports (_io->default_type());
145         } else {
146                 return _io->outputs().num_ports (_io->default_type());
147         }
148 }
149
150 uint32_t
151 IOSelector::maximum_io_ports () const
152 {
153         if (!_find_inputs_for_io_outputs) {
154                 return _io->input_maximum ().get (_io->default_type());
155         } else {
156                 return _io->output_maximum ().get (_io->default_type());
157         }
158 }
159
160
161 uint32_t
162 IOSelector::minimum_io_ports () const
163 {
164         if (!_find_inputs_for_io_outputs) {
165                 return _io->input_minimum ().get (_io->default_type());
166         } else {
167                 return _io->output_minimum ().get (_io->default_type());
168         }
169 }
170
171 void
172 IOSelector::add_channel (boost::shared_ptr<ARDOUR::Bundle> b)
173 {
174         /* we ignore the bundle parameter, as we know what it is that we're adding to */
175         
176         // The IO selector only works for single typed IOs
177         const ARDOUR::DataType t = _io->default_type ();
178
179         if (!_find_inputs_for_io_outputs) {
180
181                 try {
182                         _io->add_input_port ("", this);
183                 }
184
185                 catch (AudioEngine::PortRegistrationFailure& err) {
186                         MessageDialog msg (_("There are no more JACK ports available."));
187                         msg.run ();
188                 }
189
190         } else {
191
192                 try {
193                         _io->add_output_port ("", this);
194                 }
195
196                 catch (AudioEngine::PortRegistrationFailure& err) {
197                         MessageDialog msg (_("There are no more JACK ports available."));
198                         msg.run ();
199                 }
200         }
201 }
202
203 void
204 IOSelector::remove_channel (ARDOUR::BundleChannel bc)
205 {
206         Port* f = _session.engine().get_port_by_name (bc.bundle->channel_ports(bc.channel)[0]);
207         if (!f) {
208                 return;
209         }
210         
211         if (_find_inputs_for_io_outputs) {
212                 _io->remove_output_port (f, this);
213         } else {
214                 _io->remove_input_port (f, this);
215         }
216 }
217
218 bool
219 IOSelector::list_is_global (int dim) const
220 {
221         return (dim == _other);
222 }
223
224 IOSelectorWindow::IOSelectorWindow (ARDOUR::Session& session, boost::shared_ptr<ARDOUR::IO> io, bool for_input, bool can_cancel)
225         : ArdourDialog ("I/O selector")
226         , _selector (session, io, !for_input)
227         , add_button (_("Add Port"))
228         , disconnect_button (_("Disconnect All"))
229         , ok_button (can_cancel ? _("OK"): _("Close"))
230         , cancel_button (_("Cancel"))
231         , rescan_button (_("Rescan"))
232
233 {
234         /* XXX: what's this for? */
235         add_events (Gdk::KEY_PRESS_MASK | Gdk::KEY_RELEASE_MASK);
236         
237         set_name ("IOSelectorWindow2");
238
239         /* Disconnect All button */
240         disconnect_button.set_name ("IOSelectorButton");
241         disconnect_button.set_image (*Gtk::manage (new Gtk::Image (Gtk::Stock::DISCONNECT, Gtk::ICON_SIZE_BUTTON)));
242         disconnect_button.signal_clicked().connect (sigc::mem_fun (_selector, &IOSelector::disassociate_all));
243         get_action_area()->pack_start (disconnect_button, false, false);
244
245         /* Add Port button */
246         if (_selector.maximum_io_ports() > _selector.n_io_ports()) {
247                 add_button.set_name ("IOSelectorButton");
248                 add_button.set_image (*Gtk::manage (new Gtk::Image (Gtk::Stock::ADD, Gtk::ICON_SIZE_BUTTON)));
249                 get_action_area()->pack_start (add_button, false, false);
250                 add_button.signal_clicked().connect (sigc::bind (sigc::mem_fun (_selector, &IOSelector::add_channel), boost::shared_ptr<Bundle> ()));
251         } 
252
253         /* Rescan button */
254         rescan_button.set_name ("IOSelectorButton");
255         rescan_button.set_image (*Gtk::manage (new Gtk::Image (Gtk::Stock::REFRESH, Gtk::ICON_SIZE_BUTTON)));
256         rescan_button.signal_clicked().connect (sigc::mem_fun (*this, &IOSelectorWindow::rescan));
257         get_action_area()->pack_start (rescan_button, false, false);
258
259         io->PortCountChanged.connect (sigc::hide (mem_fun (*this, &IOSelectorWindow::ports_changed)));
260
261         /* Cancel button */
262         if (can_cancel) {
263                 cancel_button.set_name ("IOSelectorButton");
264                 cancel_button.set_image (*Gtk::manage (new Gtk::Image (Gtk::Stock::CANCEL, Gtk::ICON_SIZE_BUTTON)));
265                 get_action_area()->pack_start (cancel_button, false, false);
266         } else {
267                 cancel_button.hide();
268         }
269         cancel_button.signal_clicked().connect (mem_fun(*this, &IOSelectorWindow::cancel));
270
271         /* OK button */
272         ok_button.set_name ("IOSelectorButton");
273         if (!can_cancel) {
274                 ok_button.set_image (*Gtk::manage (new Gtk::Image (Gtk::Stock::CLOSE, Gtk::ICON_SIZE_BUTTON)));
275         }
276         ok_button.signal_clicked().connect (mem_fun(*this, &IOSelectorWindow::accept));
277         get_action_area()->pack_start (ok_button, false, false);
278
279         get_vbox()->set_spacing (8);
280
281         get_vbox()->pack_start (_selector, true, true);
282
283         set_position (Gtk::WIN_POS_MOUSE);
284
285         io_name_changed (this);
286         ports_changed ();
287
288         show_all ();
289
290         signal_delete_event().connect (bind (sigc::ptr_fun (just_hide_it), this));
291 }
292
293 void
294 IOSelectorWindow::ports_changed ()
295 {
296         if (_selector.maximum_io_ports() > _selector.n_io_ports()) {
297                 add_button.set_sensitive (true);
298         } else {
299                 add_button.set_sensitive (false);
300         }
301 }
302
303 void
304 IOSelectorWindow::rescan ()
305 {
306         _selector.setup_ports (_selector.other());
307 }
308
309 void
310 IOSelectorWindow::cancel ()
311 {
312         _selector.Finished (IOSelector::Cancelled);
313         hide ();
314 }
315
316 void
317 IOSelectorWindow::accept ()
318 {
319         _selector.Finished (IOSelector::Accepted);
320         hide ();
321 }
322
323 void
324 IOSelectorWindow::on_map ()
325 {
326         _selector.setup_all_ports ();
327         Window::on_map ();
328 }
329
330 void
331 IOSelectorWindow::io_name_changed (void* src)
332 {
333         ENSURE_GUI_THREAD(bind (mem_fun(*this, &IOSelectorWindow::io_name_changed), src));
334         
335         string title;
336
337         if (!_selector.find_inputs_for_io_outputs()) {
338                 title = string_compose(_("%1 input"), _selector.io()->name());
339         } else {
340                 title = string_compose(_("%1 output"), _selector.io()->name());
341         }
342
343         set_title (title);
344 }
345
346 PortInsertUI::PortInsertUI (ARDOUR::Session& sess, boost::shared_ptr<ARDOUR::PortInsert> pi)
347         : input_selector (sess, pi->io(), true),
348           output_selector (sess, pi->io(), false)
349 {
350         output_selector.set_min_height_divisor (2);
351         input_selector.set_min_height_divisor (2);
352         
353         pack_start (output_selector, true, true);
354         pack_start (input_selector, true, true);
355 }
356
357 void
358 PortInsertUI::redisplay ()
359 {
360         input_selector.setup_ports (input_selector.other());
361         output_selector.setup_ports (output_selector.other());
362 }
363
364 void
365 PortInsertUI::finished (IOSelector::Result r)
366 {
367         input_selector.Finished (r);
368         output_selector.Finished (r);
369 }
370
371
372 PortInsertWindow::PortInsertWindow (ARDOUR::Session& sess, boost::shared_ptr<ARDOUR::PortInsert> pi, bool can_cancel)
373         : ArdourDialog ("port insert dialog"),
374           _portinsertui (sess, pi),
375           ok_button (can_cancel ? _("OK"): _("Close")),
376           cancel_button (_("Cancel")),
377           rescan_button (_("Rescan"))
378 {
379
380         set_name ("IOSelectorWindow");
381         string title = _("ardour: ");
382         title += pi->name();
383         set_title (title);
384         
385         ok_button.set_name ("IOSelectorButton");
386         if (!can_cancel) {
387                 ok_button.set_image (*Gtk::manage (new Gtk::Image (Gtk::Stock::CLOSE, Gtk::ICON_SIZE_BUTTON)));
388         }
389         cancel_button.set_name ("IOSelectorButton");
390         rescan_button.set_name ("IOSelectorButton");
391         rescan_button.set_image (*Gtk::manage (new Gtk::Image (Gtk::Stock::REFRESH, Gtk::ICON_SIZE_BUTTON)));
392
393         get_action_area()->pack_start (rescan_button, false, false);
394         if (can_cancel) {
395                 cancel_button.set_image (*Gtk::manage (new Gtk::Image (Gtk::Stock::CANCEL, Gtk::ICON_SIZE_BUTTON)));
396                 get_action_area()->pack_start (cancel_button, false, false);
397         } else {
398                 cancel_button.hide();
399         }
400         get_action_area()->pack_start (ok_button, false, false);
401
402         get_vbox()->pack_start (_portinsertui);
403
404         ok_button.signal_clicked().connect (mem_fun (*this, &PortInsertWindow::accept));
405         cancel_button.signal_clicked().connect (mem_fun (*this, &PortInsertWindow::cancel));
406
407         signal_delete_event().connect (bind (sigc::ptr_fun (just_hide_it), reinterpret_cast<Window *> (this))); 
408
409         going_away_connection = pi->GoingAway.connect (mem_fun (*this, &PortInsertWindow::plugin_going_away));
410 }
411
412 void
413 PortInsertWindow::plugin_going_away ()
414 {
415         ENSURE_GUI_THREAD (mem_fun (*this, &PortInsertWindow::plugin_going_away));
416         
417         going_away_connection.disconnect ();
418         delete_when_idle (this);
419 }
420
421 void
422 PortInsertWindow::on_map ()
423 {
424         _portinsertui.redisplay ();
425         Window::on_map ();
426 }
427
428
429 void
430 PortInsertWindow::cancel ()
431 {
432         _portinsertui.finished (IOSelector::Cancelled);
433         hide ();
434 }
435
436 void
437 PortInsertWindow::accept ()
438 {
439         _portinsertui.finished (IOSelector::Accepted);
440         hide ();
441 }
442