gtk2_ardour/export_channel_selector.cc

   1 /*
   2     Copyright (C) 2008 Paul Davis
   3     Author: Sakari Bergen
   4
   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.
   9
  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.
  14
  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.
  18
  19 */
  20
  21 #include "export_channel_selector.h"
  22
  23 #include <algorithm>
  24
  25 #include <pbd/convert.h>
  26
  27 #include <ardour/audio_port.h>
  28 #include <ardour/audio_track.h>
  29 #include <ardour/audioengine.h>
  30 #include <ardour/export_channel_configuration.h>
  31 #include <ardour/export_handler.h>
  32 #include <ardour/io.h>
  33 #include <ardour/route.h>
  34 #include <ardour/session.h>
  35
  36 #include <sstream>
  37
  38 #include "i18n.h"
  39
  40 using namespace ARDOUR;
  41 using namespace PBD;
  42
  43 PortExportChannelSelector::PortExportChannelSelector () :
  44   channels_label (_("Channels:"), Gtk::ALIGN_LEFT),
  45   split_checkbox (_("Split to mono files")),
  46   max_channels (20),
  47   channel_view (max_channels)
  48 {
  49
  50         channels_hbox.pack_start (channels_label, false, false, 0);
  51         channels_hbox.pack_end (channels_spinbutton, false, false, 0);
  52
  53         channels_vbox.pack_start (channels_hbox, false, false, 0);
  54         channels_vbox.pack_start (split_checkbox, false, false, 6);
  55
  56         channel_alignment.add (channel_scroller);
  57         channel_alignment.set_padding (0, 0, 12, 0);
  58         channel_scroller.add (channel_view);
  59         channel_scroller.set_size_request (-1, 130);
  60         channel_scroller.set_policy (Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
  61
  62         pack_start (channels_vbox, false, false, 0);
  63         pack_start (channel_alignment, true, true, 0);
  64
  65         /* Channels spinbutton */
  66
  67         channels_spinbutton.set_digits (0);
  68         channels_spinbutton.set_increments (1, 2);
  69         channels_spinbutton.set_range (1, max_channels);
  70         channels_spinbutton.set_value (2);
  71
  72         channels_spinbutton.signal_value_changed().connect (sigc::mem_fun (*this, &PortExportChannelSelector::update_channel_count));
  73
  74         /* Other signals */
  75
  76         split_checkbox.signal_toggled().connect (sigc::mem_fun (*this, &PortExportChannelSelector::update_split_state));
  77         channel_view.CriticalSelectionChanged.connect (CriticalSelectionChanged.make_slot());
  78
  79         /* Finalize */
  80
  81         show_all_children ();
  82
  83 }
  84
  85 PortExportChannelSelector::~PortExportChannelSelector ()
  86 {
  87 //      if (session) {
  88 //              session->add_instant_xml (get_state(), false);
  89 //      }
  90 }
  91
  92 void
  93 PortExportChannelSelector::set_state (ARDOUR::ExportProfileManager::ChannelConfigStatePtr const state_, ARDOUR::Session * session_)
  94 {
  95         state = state_;
  96         session = session_;
  97
  98         split_checkbox.set_active (state->config->get_split());
  99         channels_spinbutton.set_value (state->config->get_n_chans());
 100
 101         fill_route_list ();
 102         channel_view.set_config (state->config);
 103 }
 104
 105 void
 106 PortExportChannelSelector::fill_route_list ()
 107 {
 108         channel_view.clear_routes ();
 109         RouteList routes = *session->get_routes();
 110
 111         /* Add master bus and then everything else */
 112
 113         ARDOUR::IO * master = session->master_out().get();
 114         channel_view.add_route (master);
 115
 116         for (RouteList::iterator it = routes.begin(); it != routes.end(); ++it) {
 117                 if (it->get() == master) {
 118                         continue;
 119                 }
 120                 channel_view.add_route (it->get());
 121         }
 122
 123         update_channel_count ();
 124 }
 125
 126 void
 127 PortExportChannelSelector::update_channel_count ()
 128 {
 129         uint32_t chans = static_cast<uint32_t> (channels_spinbutton.get_value());
 130         channel_view.set_channel_count (chans);
 131         CriticalSelectionChanged();
 132 }
 133
 134 void
 135 PortExportChannelSelector::update_split_state ()
 136 {
 137         state->config->set_split (split_checkbox.get_active());
 138         CriticalSelectionChanged();
 139 }
 140
 141 void
 142 PortExportChannelSelector::RouteCols::add_channels (uint32_t chans)
 143 {
 144         while (chans > 0) {
 145                 channels.push_back (Channel (*this));
 146                 ++n_channels;
 147                 --chans;
 148         }
 149 }
 150
 151 PortExportChannelSelector::RouteCols::Channel &
 152 PortExportChannelSelector::RouteCols::get_channel (uint32_t channel)
 153 {
 154         if (channel > n_channels) {
 155                 std::cout << "Invalid channel cout for get_channel!" << std::endl;
 156         }
 157
 158         std::list<Channel>::iterator it = channels.begin();
 159
 160         while (channel > 1) { // Channel count starts from one!
 161                 ++it;
 162                 --channel;
 163         }
 164
 165         return *it;
 166 }
 167
 168 PortExportChannelSelector::ChannelTreeView::ChannelTreeView (uint32_t max_channels) :
 169   n_channels (0)
 170 {
 171         /* Main columns */
 172
 173         route_cols.add_channels (max_channels);
 174
 175         route_list = Gtk::ListStore::create(route_cols);
 176         set_model (route_list);
 177
 178         /* Add column with toggle and text */
 179
 180         append_column_editable (_("Bus or Track"), route_cols.selected);
 181
 182         Gtk::CellRendererText* text_renderer = Gtk::manage (new Gtk::CellRendererText);
 183         text_renderer->property_editable() = false;
 184
 185         Gtk::TreeView::Column* column = get_column (0);
 186         column->pack_start (*text_renderer);
 187         column->add_attribute (text_renderer->property_text(), route_cols.name);
 188
 189         Gtk::CellRendererToggle *toggle = dynamic_cast<Gtk::CellRendererToggle *>(get_column_cell_renderer (0));
 190         toggle->signal_toggled().connect (mem_fun (*this, &PortExportChannelSelector::ChannelTreeView::update_toggle_selection));
 191
 192         static_columns = get_columns().size();
 193 }
 194
 195 void
 196 PortExportChannelSelector::ChannelTreeView::set_config (ChannelConfigPtr c)
 197 {
 198         /* TODO Without the following line, the state might get reset.
 199          * Pointing to the same address does not mean the state of the configuration hasn't changed.
 200          * In the current code this is safe, but the actual cause of the problem would be good to fix
 201          */
 202
 203         if (config == c) { return; }
 204         config = c;
 205
 206         uint32_t i = 1;
 207         ExportChannelConfiguration::ChannelList chan_list = config->get_channels();
 208         for (ExportChannelConfiguration::ChannelList::iterator c_it = chan_list.begin(); c_it != chan_list.end(); ++c_it) {
 209
 210                 for (Gtk::ListStore::Children::iterator r_it = route_list->children().begin(); r_it != route_list->children().end(); ++r_it) {
 211
 212                         ARDOUR::PortExportChannel * pec;
 213                         if (!(pec = dynamic_cast<ARDOUR::PortExportChannel *> (c_it->get()))) {
 214                                 continue;
 215                         }
 216
 217                         Glib::RefPtr<Gtk::ListStore> port_list = r_it->get_value (route_cols.port_list_col);
 218                         std::set<AudioPort *> route_ports;
 219                         std::set<AudioPort *> intersection;
 220                         std::map<AudioPort *, ustring> port_labels;
 221
 222                         for (Gtk::ListStore::Children::const_iterator p_it = port_list->children().begin(); p_it != port_list->children().end(); ++p_it) {
 223                                 route_ports.insert ((*p_it)->get_value (route_cols.port_cols.port));
 224                                 port_labels.insert (std::pair<AudioPort*, ustring> ((*p_it)->get_value (route_cols.port_cols.port),
 225                                                                                     (*p_it)->get_value (route_cols.port_cols.label)));
 226                         }
 227
 228                         std::set_intersection (pec->get_ports().begin(), pec->get_ports().end(),
 229                                                route_ports.begin(), route_ports.end(),
 230                                                std::insert_iterator<std::set<AudioPort *> > (intersection, intersection.begin()));
 231
 232                         intersection.erase (0); // Remove "none" selection
 233
 234                         if (intersection.empty()) {
 235                                 continue;
 236                         }
 237
 238                         if (!r_it->get_value (route_cols.selected)) {
 239                                 r_it->set_value (route_cols.selected, true);
 240
 241                                 /* Set previous channels (if any) to none */
 242
 243                                 for (uint32_t chn = 1; chn < i; ++chn) {
 244                                         r_it->set_value (route_cols.get_channel (chn).port, (AudioPort *) 0);
 245                                         r_it->set_value (route_cols.get_channel (chn).label, ustring ("(none)"));
 246                                 }
 247                         }
 248
 249                         AudioPort * port = *intersection.begin();
 250                         std::map<AudioPort *, ustring>::iterator label_it = port_labels.find (port);
 251                         ustring label = label_it != port_labels.end() ? label_it->second : "error";
 252
 253                         r_it->set_value (route_cols.get_channel (i).port, port);
 254                         r_it->set_value (route_cols.get_channel (i).label, label);
 255                 }
 256
 257                 ++i;
 258         }
 259 }
 260
 261 void
 262 PortExportChannelSelector::ChannelTreeView::add_route (ARDOUR::IO * route)
 263 {
 264         Gtk::TreeModel::iterator iter = route_list->append();
 265         Gtk::TreeModel::Row row = *iter;
 266
 267         row[route_cols.selected] = false;
 268         row[route_cols.name] = route->name();
 269         row[route_cols.io] = route;
 270
 271         /* Initialize port list */
 272
 273         Glib::RefPtr<Gtk::ListStore> port_list = Gtk::ListStore::create (route_cols.port_cols);
 274         row[route_cols.port_list_col] = port_list;
 275
 276         uint32_t outs = route->n_outputs().n_audio();
 277         for (uint32_t i = 0; i < outs; ++i) {
 278                 iter = port_list->append();
 279                 row = *iter;
 280
 281                 row[route_cols.port_cols.selected] = false;
 282                 row[route_cols.port_cols.port] = route->audio_output (i);
 283
 284                 std::ostringstream oss;
 285                 oss << "Out-" << (i + 1);
 286
 287                 row[route_cols.port_cols.label] = oss.str();
 288         }
 289
 290         iter = port_list->append();
 291         row = *iter;
 292
 293         row[route_cols.port_cols.selected] = false;
 294         row[route_cols.port_cols.port] = 0;
 295         row[route_cols.port_cols.label] = "(none)";
 296
 297 }
 298
 299 void
 300 PortExportChannelSelector::ChannelTreeView::set_channel_count (uint32_t channels)
 301 {
 302         int offset = channels - n_channels;
 303
 304         while (offset > 0) {
 305                 ++n_channels;
 306
 307                 std::ostringstream oss;
 308                 oss << n_channels;
 309
 310                 /* New column */
 311
 312                 Gtk::TreeView::Column* column = Gtk::manage (new Gtk::TreeView::Column (oss.str()));
 313
 314                 Gtk::CellRendererCombo* combo_renderer = Gtk::manage (new Gtk::CellRendererCombo);
 315                 combo_renderer->property_text_column() = 2;
 316                 column->pack_start (*combo_renderer);
 317
 318                 append_column (*column);
 319
 320                 column->add_attribute (combo_renderer->property_text(), route_cols.get_channel(n_channels).label);
 321                 column->add_attribute (combo_renderer->property_model(), route_cols.port_list_col);
 322                 column->add_attribute (combo_renderer->property_editable(), route_cols.selected);
 323
 324                 combo_renderer->signal_edited().connect (sigc::bind (sigc::mem_fun (*this, &PortExportChannelSelector::ChannelTreeView::update_selection_text), n_channels));
 325
 326                 /* put data into view */
 327
 328                 for (Gtk::ListStore::Children::iterator it = route_list->children().begin(); it != route_list->children().end(); ++it) {
 329                         Glib::ustring label = it->get_value(route_cols.selected) ? "(none)" : "";
 330                         it->set_value (route_cols.get_channel (n_channels).label, label);
 331                         it->set_value (route_cols.get_channel (n_channels).port, (AudioPort *) 0);
 332                 }
 333
 334                 /* set column width */
 335
 336                 get_column (static_columns + n_channels - 1)->set_min_width (80);
 337
 338                 --offset;
 339         }
 340
 341         while (offset < 0) {
 342                 --n_channels;
 343
 344                 remove_column (*get_column (n_channels + static_columns));
 345
 346                 ++offset;
 347         }
 348
 349         update_config ();
 350 }
 351
 352 void
 353 PortExportChannelSelector::ChannelTreeView::update_config ()
 354 {
 355
 356         if (!config) { return; }
 357
 358         config->clear_channels();
 359
 360         for (uint32_t i = 1; i <= n_channels; ++i) {
 361
 362                 ExportChannelPtr channel (new PortExportChannel ());
 363                 PortExportChannel * pec = static_cast<PortExportChannel *> (channel.get());
 364
 365                 for (Gtk::ListStore::Children::iterator it = route_list->children().begin(); it != route_list->children().end(); ++it) {
 366                         Gtk::TreeModel::Row row = *it;
 367
 368                         if (!row[route_cols.selected]) {
 369                                 continue;
 370                         }
 371
 372                         AudioPort * port = row[route_cols.get_channel (i).port];
 373                         if (port) {
 374                                 pec->add_port (port);
 375                         }
 376                 }
 377
 378                 config->register_channel (channel);
 379         }
 380
 381         CriticalSelectionChanged ();
 382 }
 383
 384 void
 385 PortExportChannelSelector::ChannelTreeView::update_toggle_selection (Glib::ustring const & path)
 386 {
 387         Gtk::TreeModel::iterator iter = get_model ()->get_iter (path);
 388         bool selected = iter->get_value (route_cols.selected);
 389
 390         for (uint32_t i = 1; i <= n_channels; ++i) {
 391
 392                 if (!selected) {
 393                         iter->set_value (route_cols.get_channel (i).label, Glib::ustring (""));
 394                         continue;
 395                 }
 396
 397                 iter->set_value (route_cols.get_channel (i).label, Glib::ustring("(none)"));
 398                 iter->set_value (route_cols.get_channel (i).port, (AudioPort *) 0);
 399
 400                 Glib::RefPtr<Gtk::ListStore> port_list = iter->get_value (route_cols.port_list_col);
 401                 Gtk::ListStore::Children::iterator port_it;
 402                 uint32_t port_number = 1;
 403
 404                 for (port_it = port_list->children().begin(); port_it != port_list->children().end(); ++port_it) {
 405                         if (port_number == i) {
 406                                 iter->set_value (route_cols.get_channel (i).label, (Glib::ustring) (*port_it)->get_value (route_cols.port_cols.label));
 407                                 iter->set_value (route_cols.get_channel (i).port, (AudioPort *) (*port_it)->get_value (route_cols.port_cols.port));
 408                         }
 409
 410                         ++port_number;
 411                 }
 412         }
 413
 414         update_config ();
 415 }
 416
 417 void
 418 PortExportChannelSelector::ChannelTreeView::update_selection_text (Glib::ustring const & path, Glib::ustring const & new_text, uint32_t channel)
 419 {
 420         Gtk::TreeModel::iterator iter = get_model ()->get_iter (path);
 421         iter->set_value (route_cols.get_channel (channel).label, new_text);
 422
 423         Glib::RefPtr<Gtk::ListStore> port_list = iter->get_value (route_cols.port_list_col);
 424         Gtk::ListStore::Children::iterator port_it;
 425
 426         for (port_it = port_list->children().begin(); port_it != port_list->children().end(); ++port_it) {
 427                 Glib::ustring label = port_it->get_value (route_cols.port_cols.label);
 428                 if (label == new_text) {
 429                         iter->set_value (route_cols.get_channel (channel).port, (AudioPort *) (*port_it)[route_cols.port_cols.port]);
 430                 }
 431         }
 432
 433         update_config ();
 434 }
 435
 436 RegionExportChannelSelector::RegionExportChannelSelector (ARDOUR::AudioRegion const & region, ARDOUR::AudioTrack & track) :
 437   session (0),
 438   region (region),
 439   track (track),
 440   region_chans (region.n_channels()),
 441   track_chans (track.n_outputs().n_audio()),
 442
 443   raw_button (type_group),
 444   fades_button (type_group),
 445   processed_button (type_group)
 446 {
 447         pack_start (vbox);
 448
 449         raw_button.set_label (string_compose (_("Region contents without fades (channels: %1)"), region_chans));
 450         raw_button.signal_toggled ().connect (sigc::mem_fun (*this, &RegionExportChannelSelector::handle_selection));
 451         vbox.pack_start (raw_button);
 452
 453         fades_button.set_label (string_compose (_("Region contents with fades (channels: %1)"), region_chans));
 454         fades_button.signal_toggled ().connect (sigc::mem_fun (*this, &RegionExportChannelSelector::handle_selection));
 455         vbox.pack_start (fades_button);
 456
 457         processed_button.set_label (string_compose (_("Track output (channels: %1)"), track_chans));
 458         processed_button.signal_toggled ().connect (sigc::mem_fun (*this, &RegionExportChannelSelector::handle_selection));
 459         vbox.pack_start (processed_button);
 460
 461         vbox.show_all_children ();
 462         show_all_children ();
 463 }
 464
 465 void
 466 RegionExportChannelSelector::set_state (ARDOUR::ExportProfileManager::ChannelConfigStatePtr const state_, ARDOUR::Session * session_)
 467 {
 468         state = state_;
 469         session = session_;
 470
 471         handle_selection ();
 472 }
 473
 474 void
 475 RegionExportChannelSelector::handle_selection ()
 476 {
 477         if (!state) {
 478                 return;
 479         }
 480
 481         state->config->clear_channels ();
 482
 483         if (raw_button.get_active ()) {
 484                 factory.reset (new RegionExportChannelFactory (session, region, track, RegionExportChannelFactory::Raw));
 485         } else if (fades_button.get_active ()) {
 486                 factory.reset (new RegionExportChannelFactory (session, region, track, RegionExportChannelFactory::Fades));
 487         } else if (processed_button.get_active ()) {
 488                 factory.reset (new RegionExportChannelFactory(session, region, track, RegionExportChannelFactory::Processed));
 489         } else {
 490                 CriticalSelectionChanged ();
 491                 return;
 492         }
 493
 494         for (size_t chan = 0; chan < region_chans; ++chan) {
 495                 state->config->register_channel (factory->create (chan));
 496         }
 497
 498         CriticalSelectionChanged ();
 499 }