2 Copyright (C) 2008 Paul Davis
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include "export_channel_selector.h"
25 #include "pbd/convert.h"
27 #include "ardour/audio_track.h"
28 #include "ardour/audioregion.h"
29 #include "ardour/export_channel_configuration.h"
30 #include "ardour/io.h"
31 #include "ardour/route.h"
32 #include "ardour/session.h"
40 using namespace ARDOUR;
43 struct EditorOrderRouteSorter {
44 bool operator() (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b) {
45 return a->order_key () < b->order_key ();
49 PortExportChannelSelector::PortExportChannelSelector (ARDOUR::Session * session, ProfileManagerPtr manager) :
50 ExportChannelSelector (session, manager),
51 channels_label (_("Channels:"), Gtk::ALIGN_LEFT),
52 split_checkbox (_("Split to mono files")),
54 channel_view (max_channels)
56 channels_hbox.pack_start (channels_label, false, false, 0);
57 channels_hbox.pack_end (channels_spinbutton, false, false, 0);
59 channels_vbox.pack_start (channels_hbox, false, false, 0);
60 channels_vbox.pack_start (split_checkbox, false, false, 6);
62 channel_alignment.add (channel_scroller);
63 channel_alignment.set_padding (0, 0, 12, 0);
64 channel_scroller.add (channel_view);
65 channel_scroller.set_size_request (-1, 130);
66 channel_scroller.set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
68 pack_start (channels_vbox, false, false, 0);
69 pack_start (channel_alignment, true, true, 0);
71 /* Channels spinbutton */
73 channels_spinbutton.set_digits (0);
74 channels_spinbutton.set_increments (1, 2);
75 channels_spinbutton.set_range (1, max_channels);
76 channels_spinbutton.set_value (2);
78 channels_spinbutton.signal_value_changed().connect (sigc::mem_fun (*this, &PortExportChannelSelector::update_channel_count));
82 split_checkbox.signal_toggled().connect (sigc::mem_fun (*this, &PortExportChannelSelector::update_split_state));
83 channel_view.CriticalSelectionChanged.connect (CriticalSelectionChanged.make_slot());
92 PortExportChannelSelector::~PortExportChannelSelector ()
95 // session->add_instant_xml (get_state(), false);
100 PortExportChannelSelector::sync_with_manager ()
102 state = manager->get_channel_configs().front();
104 split_checkbox.set_active (state->config->get_split());
105 channels_spinbutton.set_value (state->config->get_n_chans());
108 channel_view.set_config (state->config);
112 PortExportChannelSelector::fill_route_list ()
114 channel_view.clear_routes ();
115 RouteList routes = *_session->get_routes();
117 /* Add master bus and then everything else */
119 if (_session->master_out()) {
120 ARDOUR::IO* master = _session->master_out()->output().get();
121 channel_view.add_route (master);
124 routes.sort (EditorOrderRouteSorter ());
126 for (RouteList::iterator it = routes.begin(); it != routes.end(); ++it) {
127 if ((*it)->is_master () || (*it)->is_monitor ()) {
130 channel_view.add_route ((*it)->output().get());
133 update_channel_count ();
137 PortExportChannelSelector::update_channel_count ()
139 uint32_t chans = static_cast<uint32_t> (channels_spinbutton.get_value());
140 channel_view.set_channel_count (chans);
141 CriticalSelectionChanged();
145 PortExportChannelSelector::update_split_state ()
147 state->config->set_split (split_checkbox.get_active());
148 CriticalSelectionChanged();
152 PortExportChannelSelector::RouteCols::add_channels (uint32_t chans)
155 channels.push_back (Channel (*this));
161 PortExportChannelSelector::RouteCols::Channel &
162 PortExportChannelSelector::RouteCols::get_channel (uint32_t channel)
164 if (channel > n_channels) {
165 std::cout << "Invalid channel count for get_channel!" << std::endl;
168 std::list<Channel>::iterator it = channels.begin();
170 while (channel > 1) { // Channel count starts from one!
178 PortExportChannelSelector::ChannelTreeView::ChannelTreeView (uint32_t max_channels) :
183 route_cols.add_channels (max_channels);
185 route_list = Gtk::ListStore::create(route_cols);
186 set_model (route_list);
188 /* Add column with toggle and text */
190 append_column_editable (_("Export"), route_cols.selected);
192 Gtk::CellRendererText* text_renderer = Gtk::manage (new Gtk::CellRendererText);
193 text_renderer->property_editable() = false;
194 text_renderer->set_alignment (0.0, 0.5);
196 Gtk::TreeView::Column* column = Gtk::manage (new Gtk::TreeView::Column);
197 column->set_title (_("Bus or Track"));
198 column->pack_start (*text_renderer);
199 column->set_expand (true);
200 column->add_attribute (text_renderer->property_text(), route_cols.name);
201 append_column (*column);
203 Gtk::CellRendererToggle *toggle = dynamic_cast<Gtk::CellRendererToggle *>(get_column_cell_renderer (0));
204 toggle->set_alignment (0.0, 0.5);
205 toggle->signal_toggled().connect (sigc::mem_fun (*this, &PortExportChannelSelector::ChannelTreeView::update_toggle_selection));
207 static_columns = get_columns().size();
211 PortExportChannelSelector::ChannelTreeView::set_config (ChannelConfigPtr c)
213 /* TODO Without the following line, the state might get reset.
214 * Pointing to the same address does not mean the state of the configuration hasn't changed.
215 * In the current code this is safe, but the actual cause of the problem would be good to fix
218 if (config == c) { return; }
222 ExportChannelConfiguration::ChannelList chan_list = config->get_channels();
223 for (ExportChannelConfiguration::ChannelList::iterator c_it = chan_list.begin(); c_it != chan_list.end(); ++c_it) {
225 for (Gtk::ListStore::Children::iterator r_it = route_list->children().begin(); r_it != route_list->children().end(); ++r_it) {
227 ARDOUR::PortExportChannel * pec;
228 if (!(pec = dynamic_cast<ARDOUR::PortExportChannel *> (c_it->get()))) {
232 Glib::RefPtr<Gtk::ListStore> port_list = r_it->get_value (route_cols.port_list_col);
233 std::set<boost::weak_ptr<AudioPort> > route_ports;
234 std::set<boost::weak_ptr<AudioPort> > intersection;
235 std::map<boost::weak_ptr<AudioPort>, string> port_labels;
237 for (Gtk::ListStore::Children::const_iterator p_it = port_list->children().begin(); p_it != port_list->children().end(); ++p_it) {
238 route_ports.insert ((*p_it)->get_value (route_cols.port_cols.port));
239 port_labels.insert (make_pair ((*p_it)->get_value (route_cols.port_cols.port),
240 (*p_it)->get_value (route_cols.port_cols.label)));
243 std::set_intersection (pec->get_ports().begin(), pec->get_ports().end(),
244 route_ports.begin(), route_ports.end(),
245 std::insert_iterator<std::set<boost::weak_ptr<AudioPort> > > (intersection, intersection.begin()));
247 intersection.erase (boost::weak_ptr<AudioPort> ()); // Remove "none" selection
249 if (intersection.empty()) {
253 if (!r_it->get_value (route_cols.selected)) {
254 r_it->set_value (route_cols.selected, true);
256 /* Set previous channels (if any) to none */
258 for (uint32_t chn = 1; chn < i; ++chn) {
259 r_it->set_value (route_cols.get_channel (chn).port, boost::weak_ptr<AudioPort> ());
260 r_it->set_value (route_cols.get_channel (chn).label, string ("(none)"));
264 boost::weak_ptr<AudioPort> port = *intersection.begin();
265 std::map<boost::weak_ptr<AudioPort>, string>::iterator label_it = port_labels.find (port);
266 string label = label_it != port_labels.end() ? label_it->second : "error";
268 r_it->set_value (route_cols.get_channel (i).port, port);
269 r_it->set_value (route_cols.get_channel (i).label, label);
277 PortExportChannelSelector::ChannelTreeView::add_route (ARDOUR::IO * io)
279 Gtk::TreeModel::iterator iter = route_list->append();
280 Gtk::TreeModel::Row row = *iter;
282 row[route_cols.selected] = false;
283 row[route_cols.name] = io->name();
284 row[route_cols.io] = io;
286 /* Initialize port list */
288 Glib::RefPtr<Gtk::ListStore> port_list = Gtk::ListStore::create (route_cols.port_cols);
289 row[route_cols.port_list_col] = port_list;
291 uint32_t outs = io->n_ports().n_audio();
292 for (uint32_t i = 0; i < outs; ++i) {
293 iter = port_list->append();
296 row[route_cols.port_cols.selected] = false;
297 row[route_cols.port_cols.port] = io->audio (i);
299 std::ostringstream oss;
300 oss << "Out-" << (i + 1);
302 row[route_cols.port_cols.label] = oss.str();
305 iter = port_list->append();
308 row[route_cols.port_cols.selected] = false;
309 row[route_cols.port_cols.port] = boost::weak_ptr<AudioPort> ();
310 row[route_cols.port_cols.label] = "(none)";
315 PortExportChannelSelector::ChannelTreeView::set_channel_count (uint32_t channels)
317 int offset = channels - n_channels;
322 std::ostringstream oss;
327 Gtk::TreeView::Column* column = Gtk::manage (new Gtk::TreeView::Column (oss.str()));
329 Gtk::CellRendererCombo* combo_renderer = Gtk::manage (new Gtk::CellRendererCombo);
330 combo_renderer->property_text_column() = 2;
331 combo_renderer->property_has_entry() = false;
332 column->pack_start (*combo_renderer);
334 append_column (*column);
336 column->add_attribute (combo_renderer->property_text(), route_cols.get_channel(n_channels).label);
337 column->add_attribute (combo_renderer->property_model(), route_cols.port_list_col);
338 column->add_attribute (combo_renderer->property_editable(), route_cols.selected);
340 combo_renderer->signal_edited().connect (sigc::bind (sigc::mem_fun (*this, &PortExportChannelSelector::ChannelTreeView::update_selection_text), n_channels));
342 /* put data into view */
344 for (Gtk::ListStore::Children::iterator it = route_list->children().begin(); it != route_list->children().end(); ++it) {
345 std::string label = it->get_value(route_cols.selected) ? "(none)" : "";
346 it->set_value (route_cols.get_channel (n_channels).label, label);
347 it->set_value (route_cols.get_channel (n_channels).port, boost::weak_ptr<AudioPort> ());
350 /* set column width */
352 get_column (static_columns + n_channels - 1)->set_min_width (80);
360 remove_column (*get_column (n_channels + static_columns));
369 PortExportChannelSelector::ChannelTreeView::update_config ()
371 if (!config) { return; }
373 config->clear_channels();
375 for (uint32_t i = 1; i <= n_channels; ++i) {
377 ExportChannelPtr channel (new PortExportChannel ());
378 PortExportChannel * pec = static_cast<PortExportChannel *> (channel.get());
380 for (Gtk::ListStore::Children::iterator it = route_list->children().begin(); it != route_list->children().end(); ++it) {
381 Gtk::TreeModel::Row row = *it;
383 if (!row[route_cols.selected]) {
387 boost::weak_ptr<AudioPort> weak_port = row[route_cols.get_channel (i).port];
388 boost::shared_ptr<AudioPort> port = weak_port.lock ();
390 pec->add_port (port);
394 config->register_channel (channel);
397 CriticalSelectionChanged ();
401 PortExportChannelSelector::ChannelTreeView::update_toggle_selection (std::string const & path)
403 Gtk::TreeModel::iterator iter = get_model ()->get_iter (path);
404 bool selected = iter->get_value (route_cols.selected);
406 for (uint32_t i = 1; i <= n_channels; ++i) {
409 iter->set_value (route_cols.get_channel (i).label, std::string (""));
413 iter->set_value (route_cols.get_channel (i).label, std::string("(none)"));
414 iter->set_value (route_cols.get_channel (i).port, boost::weak_ptr<AudioPort> ());
416 Glib::RefPtr<Gtk::ListStore> port_list = iter->get_value (route_cols.port_list_col);
417 Gtk::ListStore::Children::iterator port_it;
418 uint32_t port_number = 1;
420 for (port_it = port_list->children().begin(); port_it != port_list->children().end(); ++port_it) {
421 if (port_number == i) {
422 iter->set_value (route_cols.get_channel (i).label, (std::string) (*port_it)->get_value (route_cols.port_cols.label));
423 iter->set_value (route_cols.get_channel (i).port, (*port_it)->get_value (route_cols.port_cols.port));
434 PortExportChannelSelector::ChannelTreeView::update_selection_text (std::string const & path, std::string const & new_text, uint32_t channel)
436 Gtk::TreeModel::iterator iter = get_model ()->get_iter (path);
437 iter->set_value (route_cols.get_channel (channel).label, new_text);
439 Glib::RefPtr<Gtk::ListStore> port_list = iter->get_value (route_cols.port_list_col);
440 Gtk::ListStore::Children::iterator port_it;
442 for (port_it = port_list->children().begin(); port_it != port_list->children().end(); ++port_it) {
443 std::string label = port_it->get_value (route_cols.port_cols.label);
444 if (label == new_text) {
445 boost::weak_ptr<AudioPort> w = (*port_it)[route_cols.port_cols.port];
446 iter->set_value (route_cols.get_channel (channel).port, w);
453 RegionExportChannelSelector::RegionExportChannelSelector (ARDOUR::Session * _session,
454 ProfileManagerPtr manager,
455 ARDOUR::AudioRegion const & region,
456 ARDOUR::AudioTrack & track) :
457 ExportChannelSelector (_session, manager),
460 region_chans (region.n_channels()),
461 track_chans (track.n_outputs().n_audio()),
463 raw_button (type_group),
464 fades_button (type_group),
465 processed_button (type_group)
469 /* make fades+region gain be the default */
471 fades_button.set_active ();
473 raw_button.set_label (string_compose (_("Region contents without fades nor region gain (channels: %1)"), region_chans));
474 raw_button.signal_toggled ().connect (sigc::mem_fun (*this, &RegionExportChannelSelector::handle_selection));
475 vbox.pack_start (raw_button, false, false);
477 fades_button.set_label (string_compose (_("Region contents with fades and region gain (channels: %1)"), region_chans));
478 fades_button.signal_toggled ().connect (sigc::mem_fun (*this, &RegionExportChannelSelector::handle_selection));
479 vbox.pack_start (fades_button, false, false);
481 processed_button.set_label (string_compose (_("Track output (channels: %1)"), track_chans));
482 processed_button.signal_toggled ().connect (sigc::mem_fun (*this, &RegionExportChannelSelector::handle_selection));
483 vbox.pack_start (processed_button, false, false);
486 vbox.show_all_children ();
487 show_all_children ();
491 RegionExportChannelSelector::sync_with_manager ()
493 state = manager->get_channel_configs().front();
495 if (!state) { return; }
497 switch (state->config->region_processing_type()) {
498 case RegionExportChannelFactory::None:
501 case RegionExportChannelFactory::Raw:
502 raw_button.set_active (true);
504 case RegionExportChannelFactory::Fades:
505 fades_button.set_active (true);
507 case RegionExportChannelFactory::Processed:
508 processed_button.set_active (true);
516 RegionExportChannelSelector::handle_selection ()
522 state->config->clear_channels ();
524 RegionExportChannelFactory::Type type = RegionExportChannelFactory::None;
525 if (raw_button.get_active ()) {
526 type = RegionExportChannelFactory::Raw;
527 } else if (fades_button.get_active ()) {
528 type = RegionExportChannelFactory::Fades;
529 } else if (processed_button.get_active ()) {
530 type = RegionExportChannelFactory::Processed;
532 CriticalSelectionChanged ();
536 factory.reset (new RegionExportChannelFactory (_session, region, track, type));
537 state->config->set_region_processing_type (type);
539 for (size_t chan = 0; chan < region_chans; ++chan) {
540 state->config->register_channel (factory->create (chan));
543 CriticalSelectionChanged ();
546 /* Track export channel selector */
548 TrackExportChannelSelector::TrackExportChannelSelector (ARDOUR::Session * session, ProfileManagerPtr manager)
549 : ExportChannelSelector(session, manager)
550 , track_output_button(_("Apply track/bus processing"))
551 , select_tracks_button (_("Select all tracks"))
552 , select_busses_button (_("Select all busses"))
553 , select_none_button (_("Deselect all"))
555 pack_start(main_layout);
558 options_box.pack_start(track_output_button);
559 options_box.pack_start (select_tracks_button);
560 options_box.pack_start (select_busses_button);
561 options_box.pack_start (select_none_button);
562 main_layout.pack_start(options_box, false, false);
565 track_scroller.add (track_view);
566 track_scroller.set_size_request (-1, 130);
567 track_scroller.set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
568 main_layout.pack_start(track_scroller);
571 track_list = Gtk::ListStore::create (track_cols);
572 track_list->set_sort_column (track_cols.order_key, Gtk::SORT_ASCENDING);
573 track_view.set_model (track_list);
574 track_view.set_headers_visible (true);
576 track_view.append_column_editable (_("Export"), track_cols.selected);
577 Gtk::CellRendererToggle *toggle = dynamic_cast<Gtk::CellRendererToggle *>(track_view.get_column_cell_renderer (0));
578 toggle->set_alignment (0.0, 0.5);
580 toggle->signal_toggled().connect (sigc::hide (sigc::mem_fun (*this, &TrackExportChannelSelector::update_config)));
582 Gtk::CellRendererText* text_renderer = Gtk::manage (new Gtk::CellRendererText);
583 text_renderer->property_editable() = false;
584 text_renderer->set_alignment (0.0, 0.5);
586 Gtk::TreeView::Column* column = Gtk::manage (new Gtk::TreeView::Column);
587 column->set_title (_("Track name"));
589 track_view.append_column (*column);
590 column->pack_start (*text_renderer, false);
591 column->add_attribute (text_renderer->property_text(), track_cols.label);
593 select_tracks_button.signal_clicked().connect (sigc::mem_fun (*this, &TrackExportChannelSelector::select_tracks));
594 select_busses_button.signal_clicked().connect (sigc::mem_fun (*this, &TrackExportChannelSelector::select_busses));
595 select_none_button.signal_clicked().connect (sigc::mem_fun (*this, &TrackExportChannelSelector::select_none));
597 track_output_button.signal_clicked().connect (sigc::mem_fun (*this, &TrackExportChannelSelector::track_outputs_selected));
601 show_all_children ();
605 TrackExportChannelSelector::sync_with_manager ()
607 // TODO implement properly
612 TrackExportChannelSelector::select_tracks ()
614 for (Gtk::ListStore::Children::iterator it = track_list->children().begin(); it != track_list->children().end(); ++it) {
615 Gtk::TreeModel::Row row = *it;
616 boost::shared_ptr<Route> route = row[track_cols.route];
617 if (boost::dynamic_pointer_cast<Track> (route)) {
619 row[track_cols.selected] = true;
626 TrackExportChannelSelector::select_busses ()
628 for (Gtk::ListStore::Children::iterator it = track_list->children().begin(); it != track_list->children().end(); ++it) {
629 Gtk::TreeModel::Row row = *it;
630 boost::shared_ptr<Route> route = row[track_cols.route];
631 if (!boost::dynamic_pointer_cast<Track> (route)) {
632 // it's not a track, must be a bus
633 row[track_cols.selected] = true;
640 TrackExportChannelSelector::select_none ()
642 for (Gtk::ListStore::Children::iterator it = track_list->children().begin(); it != track_list->children().end(); ++it) {
643 Gtk::TreeModel::Row row = *it;
644 row[track_cols.selected] = false;
650 TrackExportChannelSelector::track_outputs_selected ()
656 TrackExportChannelSelector::fill_list()
659 RouteList routes = *_session->get_routes();
661 for (RouteList::iterator it = routes.begin(); it != routes.end(); ++it) {
662 if (!boost::dynamic_pointer_cast<Track>(*it)) {
663 // not a track, must be a bus
664 if ((*it)->is_master () || (*it)->is_monitor ()) {
667 if (!(*it)->active ()) {
668 // don't include inactive busses
672 // not monitor or master bus
676 for (RouteList::iterator it = routes.begin(); it != routes.end(); ++it) {
677 if (boost::dynamic_pointer_cast<AudioTrack>(*it)) {
678 if (!(*it)->active ()) {
679 // don't include inactive tracks
688 TrackExportChannelSelector::add_track (boost::shared_ptr<Route> route)
690 Gtk::TreeModel::iterator iter = track_list->append();
691 Gtk::TreeModel::Row row = *iter;
693 row[track_cols.selected] = false;
694 row[track_cols.label] = route->name();
695 row[track_cols.route] = route;
696 row[track_cols.order_key] = route->order_key();
700 TrackExportChannelSelector::update_config()
702 manager->clear_channel_configs();
704 for (Gtk::ListStore::Children::iterator it = track_list->children().begin(); it != track_list->children().end(); ++it) {
705 Gtk::TreeModel::Row row = *it;
707 if (!row[track_cols.selected]) {
711 ExportProfileManager::ChannelConfigStatePtr state = manager->add_channel_config();
713 boost::shared_ptr<Route> route = row[track_cols.route];
715 if (track_output_button.get_active()) {
716 uint32_t outs = route->n_outputs().n_audio();
717 for (uint32_t i = 0; i < outs; ++i) {
718 boost::shared_ptr<AudioPort> port = route->output()->audio (i);
720 ExportChannelPtr channel (new PortExportChannel ());
721 PortExportChannel * pec = static_cast<PortExportChannel *> (channel.get());
723 state->config->register_channel(channel);
727 std::list<ExportChannelPtr> list;
728 RouteExportChannel::create_from_route (list, route);
729 state->config->register_channels (list);
732 state->config->set_name (route->name());
736 CriticalSelectionChanged ();