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