gtk2_ardour/engine_dialog.cc

   1 /*
   2     Copyright (C) 2010 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 <exception>
  21 #include <vector>
  22 #include <cmath>
  23 #include <fstream>
  24 #include <map>
  25
  26 #include <boost/scoped_ptr.hpp>
  27
  28 #include <gtkmm/messagedialog.h>
  29
  30 #include "pbd/error.h"
  31 #include "pbd/xml++.h"
  32 #include "pbd/unwind.h"
  33 #include "pbd/failed_constructor.h"
  34
  35 #include <gtkmm/alignment.h>
  36 #include <gtkmm/stock.h>
  37 #include <gtkmm/notebook.h>
  38 #include <gtkmm2ext/utils.h>
  39
  40 #include "ardour/audio_backend.h"
  41 #include "ardour/audioengine.h"
  42 #include "ardour/mtdm.h"
  43 #include "ardour/rc_configuration.h"
  44 #include "ardour/types.h"
  45
  46 #include "pbd/convert.h"
  47 #include "pbd/error.h"
  48
  49 #include "ardour_ui.h"
  50 #include "engine_dialog.h"
  51 #include "gui_thread.h"
  52 #include "utils.h"
  53 #include "i18n.h"
  54
  55 using namespace std;
  56 using namespace Gtk;
  57 using namespace Gtkmm2ext;
  58 using namespace PBD;
  59 using namespace Glib;
  60
  61 static const unsigned int midi_tab = -1; /* not currently in use */
  62 static const unsigned int latency_tab = 1; /* zero-based, page zero is the main setup page */
  63
  64 static const char* results_markup = X_("<span foreground=\"red\" style=\"italic\" size=\"larger\">%1</span>");
  65
  66 EngineControl::EngineControl ()
  67         : ArdourDialog (_("Audio/MIDI Setup"))
  68         , basic_packer (9, 4)
  69         , input_latency_adjustment (0, 0, 99999, 1)
  70         , input_latency (input_latency_adjustment)
  71         , output_latency_adjustment (0, 0, 99999, 1)
  72         , output_latency (output_latency_adjustment)
  73         , input_channels_adjustment (0, 0, 256, 1)
  74         , input_channels (input_channels_adjustment)
  75         , output_channels_adjustment (0, 0, 256, 1)
  76         , output_channels (output_channels_adjustment)
  77         , ports_adjustment (128, 8, 1024, 1, 16)
  78         , ports_spinner (ports_adjustment)
  79         , control_app_button (_("Device Control Panel"))
  80         , lm_measure_label (_("Measure"))
  81         , lm_use_button (_("Use results"))
  82         , lm_back_button (_("Back to settings ... (ignore results)"))
  83         , lm_button (_("Calibrate..."))
  84         , lm_table (12, 3)
  85         , have_lm_results (false)
  86         , lm_running (false)
  87         , midi_refresh_button (_("Refresh list"))
  88         , ignore_changes (0)
  89         , _desired_sample_rate (0)
  90         , started_at_least_once (false)
  91 {
  92         using namespace Notebook_Helpers;
  93         vector<string> strings;
  94         Label* label;
  95         AttachOptions xopt = AttachOptions (FILL|EXPAND);
  96         int row;
  97
  98         set_name (X_("AudioMIDISetup"));
  99
 100         /* the backend combo is the one thing that is ALWAYS visible
 101          */
 102
 103         vector<const ARDOUR::AudioBackendInfo*> backends = ARDOUR::AudioEngine::instance()->available_backends();
 104
 105         if (backends.empty()) {
 106                 MessageDialog msg (string_compose (_("No audio/MIDI backends detected. %1 cannot run\n\n(This is a build/packaging/system error. It should never happen.)"), PROGRAM_NAME));
 107                 msg.run ();
 108                 throw failed_constructor ();
 109         }
 110
 111         for (vector<const ARDOUR::AudioBackendInfo*>::const_iterator b = backends.begin(); b != backends.end(); ++b) {
 112                 strings.push_back ((*b)->name);
 113         }
 114
 115         set_popdown_strings (backend_combo, strings);
 116         backend_combo.set_active_text (strings.front());
 117         backend_combo.signal_changed().connect (sigc::mem_fun (*this, &EngineControl::backend_changed));
 118
 119         /* setup basic packing characteristics for the table used on the main
 120          * tab of the notebook
 121          */
 122
 123         basic_packer.set_spacings (6);
 124         basic_packer.set_border_width (12);
 125         basic_packer.set_homogeneous (false);
 126
 127         /* pack it in */
 128
 129         basic_hbox.pack_start (basic_packer, false, false);
 130
 131         /* latency tab */
 132
 133         /* latency measurement tab */
 134
 135         lm_title.set_markup (string_compose ("<span size=\"large\" weight=\"bold\">%1</span>", _("Latency Measurement Tool")));
 136
 137         row = 0;
 138         lm_table.set_row_spacings (12);
 139         lm_table.set_col_spacings (6);
 140         lm_table.set_homogeneous (false);
 141
 142         lm_table.attach (lm_title, 0, 3, row, row+1, xopt, (AttachOptions) 0);
 143         row++;
 144
 145         Gtk::Label* preamble;
 146
 147         preamble = manage (new Label);
 148         preamble->set_width_chars (60);
 149         preamble->set_line_wrap (true);
 150         preamble->set_markup (_("<span weight=\"bold\">Turn down the volume on your audio equipment to a very low level.</span>"));
 151
 152         lm_table.attach (*preamble, 0, 3, row, row+1, AttachOptions(FILL|EXPAND), (AttachOptions) 0);
 153         row++;
 154
 155         preamble = manage (new Label);
 156         preamble->set_width_chars (60);
 157         preamble->set_line_wrap (true);
 158         preamble->set_markup (_("Select two channels below and connect them using a cable."));
 159
 160         lm_table.attach (*preamble, 0, 3, row, row+1, AttachOptions(FILL|EXPAND), (AttachOptions) 0);
 161         row++;
 162
 163         label = manage (new Label (_("Output channel")));
 164         lm_table.attach (*label, 0, 1, row, row+1, xopt, (AttachOptions) 0);
 165
 166         Gtk::Alignment* misc_align = manage (new Alignment (0.0, 0.5));
 167         misc_align->add (lm_output_channel_combo);
 168         lm_table.attach (*misc_align, 1, 3, row, row+1, xopt, (AttachOptions) 0);
 169         ++row;
 170
 171         label = manage (new Label (_("Input channel")));
 172         lm_table.attach (*label, 0, 1, row, row+1, xopt, (AttachOptions) 0);
 173
 174         misc_align = manage (new Alignment (0.0, 0.5));
 175         misc_align->add (lm_input_channel_combo);
 176         lm_table.attach (*misc_align, 1, 3, row, row+1, FILL, (AttachOptions) 0);
 177         ++row;
 178
 179         xopt = AttachOptions(0);
 180
 181         lm_measure_label.set_padding (10, 10);
 182         lm_measure_button.add (lm_measure_label);
 183         lm_measure_button.signal_clicked().connect (sigc::mem_fun (*this, &EngineControl::latency_button_clicked));
 184         lm_use_button.signal_clicked().connect (sigc::mem_fun (*this, &EngineControl::use_latency_button_clicked));
 185         lm_back_button.signal_clicked().connect (sigc::bind (sigc::mem_fun (notebook, &Gtk::Notebook::set_current_page), 0));
 186
 187         lm_use_button.set_sensitive (false);
 188
 189         /* Increase the default spacing around the labels of these three
 190          * buttons
 191          */
 192
 193         Gtk::Misc* l;
 194
 195         if ((l = dynamic_cast<Gtk::Misc*>(lm_use_button.get_child())) != 0) {
 196                 l->set_padding (10, 10);
 197         }
 198
 199         if ((l = dynamic_cast<Gtk::Misc*>(lm_back_button.get_child())) != 0) {
 200                 l->set_padding (10, 10);
 201         }
 202
 203         preamble = manage (new Label);
 204         preamble->set_width_chars (60);
 205         preamble->set_line_wrap (true);
 206         preamble->set_markup (_("Once the channels are connected, click the \"Measure\" button."));
 207         lm_table.attach (*preamble, 0, 3, row, row+1, AttachOptions(FILL|EXPAND), (AttachOptions) 0);
 208         row++;
 209
 210         preamble = manage (new Label);
 211         preamble->set_width_chars (60);
 212         preamble->set_line_wrap (true);
 213         preamble->set_markup (_("When satisfied with the results, click the \"Use results\" button."));
 214         lm_table.attach (*preamble, 0, 3, row, row+1, AttachOptions(FILL|EXPAND), (AttachOptions) 0);
 215
 216         ++row; // skip a row in the table
 217         ++row; // skip a row in the table
 218
 219         lm_table.attach (lm_results, 0, 3, row, row+1, AttachOptions(FILL|EXPAND), (AttachOptions) 0);
 220
 221         ++row; // skip a row in the table
 222         ++row; // skip a row in the table
 223
 224         lm_table.attach (lm_measure_button, 0, 1, row, row+1, AttachOptions(FILL|EXPAND), (AttachOptions) 0);
 225         lm_table.attach (lm_use_button, 1, 2, row, row+1, AttachOptions(FILL|EXPAND), (AttachOptions) 0);
 226         lm_table.attach (lm_back_button, 2, 3, row, row+1, AttachOptions(FILL|EXPAND), (AttachOptions) 0);
 227
 228         lm_results.set_markup (string_compose (results_markup, _("No measurement results yet")));
 229
 230         lm_vbox.set_border_width (12);
 231         lm_vbox.pack_start (lm_table, false, false);
 232
 233         /* pack it all up */
 234
 235         notebook.pages().push_back (TabElem (basic_vbox, _("Audio")));
 236         // notebook.pages().push_back (TabElem (midi_vbox, _("MIDI")));
 237         notebook.pages().push_back (TabElem (lm_vbox, _("Latency")));
 238         notebook.set_border_width (12);
 239
 240         notebook.set_show_tabs (false);
 241         notebook.show_all ();
 242
 243         notebook.set_name ("SettingsNotebook");
 244
 245         /* packup the notebook */
 246
 247         get_vbox()->set_border_width (12);
 248         get_vbox()->pack_start (notebook);
 249
 250         /* need a special function to print "all available channels" when the
 251          * channel counts hit zero.
 252          */
 253
 254         input_channels.signal_output().connect (sigc::bind (sigc::ptr_fun (&EngineControl::print_channel_count), &input_channels));
 255         output_channels.signal_output().connect (sigc::bind (sigc::ptr_fun (&EngineControl::print_channel_count), &output_channels));
 256
 257         control_app_button.signal_clicked().connect (mem_fun (*this, &EngineControl::control_app_button_clicked));
 258         manage_control_app_sensitivity ();
 259
 260         cancel_button = add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
 261         ok_button = add_button (Gtk::Stock::OK, Gtk::RESPONSE_OK);
 262         apply_button = add_button (Gtk::Stock::APPLY, Gtk::RESPONSE_APPLY);
 263
 264         /* Pick up any existing audio setup configuration, if appropriate */
 265
 266         XMLNode* audio_setup = ARDOUR::Config->extra_xml ("AudioMIDISetup");
 267
 268         ARDOUR::AudioEngine::instance()->Running.connect (running_connection, MISSING_INVALIDATOR, boost::bind (&EngineControl::engine_running, this), gui_context());
 269         ARDOUR::AudioEngine::instance()->Stopped.connect (stopped_connection, MISSING_INVALIDATOR, boost::bind (&EngineControl::engine_stopped, this), gui_context());
 270         ARDOUR::AudioEngine::instance()->Halted.connect (stopped_connection, MISSING_INVALIDATOR, boost::bind (&EngineControl::engine_stopped, this), gui_context());
 271
 272         backend_changed ();
 273
 274         if (audio_setup) {
 275                 set_state (*audio_setup);
 276         }
 277
 278         /* Connect to signals */
 279
 280         driver_combo.signal_changed().connect (sigc::mem_fun (*this, &EngineControl::driver_changed));
 281         sample_rate_combo.signal_changed().connect (sigc::mem_fun (*this, &EngineControl::sample_rate_changed));
 282         buffer_size_combo.signal_changed().connect (sigc::mem_fun (*this, &EngineControl::buffer_size_changed));
 283         device_combo.signal_changed().connect (sigc::mem_fun (*this, &EngineControl::device_changed));
 284         midi_option_combo.signal_changed().connect (sigc::mem_fun (*this, &EngineControl::midi_option_changed));
 285
 286         input_latency.signal_changed().connect (sigc::mem_fun (*this, &EngineControl::parameter_changed));
 287         output_latency.signal_changed().connect (sigc::mem_fun (*this, &EngineControl::parameter_changed));
 288         input_channels.signal_changed().connect (sigc::mem_fun (*this, &EngineControl::parameter_changed));
 289         output_channels.signal_changed().connect (sigc::mem_fun (*this, &EngineControl::parameter_changed));
 290
 291         notebook.signal_switch_page().connect (sigc::mem_fun (*this, &EngineControl::on_switch_page));
 292  }
 293
 294  void
 295  EngineControl::on_response (int response_id)
 296  {
 297          ArdourDialog::on_response (response_id);
 298
 299          switch (response_id) {
 300          case RESPONSE_APPLY:
 301                  push_state_to_backend (true);
 302                  break;
 303          case RESPONSE_OK:
 304                  push_state_to_backend (true);
 305                  hide ();
 306                  break;
 307          case RESPONSE_DELETE_EVENT: {
 308                  GdkEventButton ev;
 309                  ev.type = GDK_BUTTON_PRESS;
 310                  ev.button = 1;
 311                  on_delete_event ((GdkEventAny*) &ev);
 312                  break;
 313          }
 314          default:
 315                  hide ();
 316          }
 317  }
 318
 319  void
 320  EngineControl::build_notebook ()
 321  {
 322          Label* label;
 323          AttachOptions xopt = AttachOptions (FILL|EXPAND);
 324
 325          /* clear the table */
 326
 327          Gtkmm2ext::container_clear (basic_vbox);
 328          Gtkmm2ext::container_clear (basic_packer);
 329
 330          if (control_app_button.get_parent()) {
 331                  control_app_button.get_parent()->remove (control_app_button);
 332          }
 333
 334          label = manage (left_aligned_label (_("Audio System:")));
 335          basic_packer.attach (*label, 0, 1, 0, 1, xopt, (AttachOptions) 0);
 336          basic_packer.attach (backend_combo, 1, 2, 0, 1, xopt, (AttachOptions) 0);
 337
 338          lm_button.signal_clicked.connect (sigc::mem_fun (*this, &EngineControl::calibrate_latency));
 339          lm_button.set_name ("generic button");
 340          if (_have_control) {
 341                  build_full_control_notebook ();
 342          } else {
 343                  build_no_control_notebook ();
 344          }
 345
 346          basic_vbox.pack_start (basic_hbox, false, false);
 347
 348          if (_have_control) {
 349                  Gtk::HBox* hpacker = manage (new HBox);
 350                  hpacker->set_border_width (12);
 351                  hpacker->pack_start (control_app_button, false, false);
 352                  hpacker->show ();
 353                  control_app_button.show();
 354                  basic_vbox.pack_start (*hpacker);
 355          }
 356
 357          basic_vbox.show_all ();
 358  }
 359
 360  void
 361  EngineControl::build_full_control_notebook ()
 362  {
 363          boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
 364          assert (backend);
 365
 366          using namespace Notebook_Helpers;
 367          Label* label;
 368          vector<string> strings;
 369          AttachOptions xopt = AttachOptions (FILL|EXPAND);
 370          int row = 1; // row zero == backend combo
 371
 372          /* start packing it up */
 373
 374          if (backend->requires_driver_selection()) {
 375                  label = manage (left_aligned_label (_("Driver:")));
 376                  basic_packer.attach (*label, 0, 1, row, row + 1, xopt, (AttachOptions) 0);
 377                  basic_packer.attach (driver_combo, 1, 2, row, row + 1, xopt, (AttachOptions) 0);
 378                  row++;
 379          }
 380
 381          label = manage (left_aligned_label (_("Device:")));
 382          basic_packer.attach (*label, 0, 1, row, row + 1, xopt, (AttachOptions) 0);
 383          basic_packer.attach (device_combo, 1, 2, row, row + 1, xopt, (AttachOptions) 0);
 384          row++;
 385
 386          label = manage (left_aligned_label (_("Sample rate:")));
 387          basic_packer.attach (*label, 0, 1, row, row + 1, xopt, (AttachOptions) 0);
 388          basic_packer.attach (sample_rate_combo, 1, 2, row, row + 1, xopt, (AttachOptions) 0);
 389          row++;
 390
 391
 392          label = manage (left_aligned_label (_("Buffer size:")));
 393          basic_packer.attach (*label, 0, 1, row, row + 1, xopt, (AttachOptions) 0);
 394          basic_packer.attach (buffer_size_combo, 1, 2, row, row + 1, xopt, (AttachOptions) 0);
 395          buffer_size_duration_label.set_alignment (0.0); /* left-align */
 396          basic_packer.attach (buffer_size_duration_label, 2, 3, row, row+1, SHRINK, (AttachOptions) 0);
 397          row++;
 398
 399          input_channels.set_name ("InputChannels");
 400          input_channels.set_flags(Gtk::CAN_FOCUS);
 401          input_channels.set_digits(0);
 402          input_channels.set_wrap(false);
 403          output_channels.set_editable (true);
 404
 405          label = manage (left_aligned_label (_("Input Channels:")));
 406          basic_packer.attach (*label, 0, 1, row, row+1, xopt, (AttachOptions) 0);
 407          basic_packer.attach (input_channels, 1, 2, row, row+1, xopt, (AttachOptions) 0);
 408          ++row;
 409
 410          output_channels.set_name ("OutputChannels");
 411          output_channels.set_flags(Gtk::CAN_FOCUS);
 412          output_channels.set_digits(0);
 413          output_channels.set_wrap(false);
 414          output_channels.set_editable (true);
 415
 416          label = manage (left_aligned_label (_("Output Channels:")));
 417          basic_packer.attach (*label, 0, 1, row, row+1, xopt, (AttachOptions) 0);
 418          basic_packer.attach (output_channels, 1, 2, row, row+1, xopt, (AttachOptions) 0);
 419          ++row;
 420
 421          input_latency.set_name ("InputLatency");
 422          input_latency.set_flags(Gtk::CAN_FOCUS);
 423          input_latency.set_digits(0);
 424          input_latency.set_wrap(false);
 425          input_latency.set_editable (true);
 426
 427          label = manage (left_aligned_label (_("Hardware input latency:")));
 428          basic_packer.attach (*label, 0, 1, row, row+1, xopt, (AttachOptions) 0);
 429          basic_packer.attach (input_latency, 1, 2, row, row+1, xopt, (AttachOptions) 0);
 430          label = manage (left_aligned_label (_("samples")));
 431          basic_packer.attach (*label, 2, 3, row, row+1, SHRINK, (AttachOptions) 0);
 432          ++row;
 433
 434          output_latency.set_name ("OutputLatency");
 435          output_latency.set_flags(Gtk::CAN_FOCUS);
 436          output_latency.set_digits(0);
 437          output_latency.set_wrap(false);
 438          output_latency.set_editable (true);
 439
 440          label = manage (left_aligned_label (_("Hardware output latency:")));
 441          basic_packer.attach (*label, 0, 1, row, row+1, xopt, (AttachOptions) 0);
 442          basic_packer.attach (output_latency, 1, 2, row, row+1, xopt, (AttachOptions) 0);
 443          label = manage (left_aligned_label (_("samples")));
 444          basic_packer.attach (*label, 2, 3, row, row+1, SHRINK, (AttachOptions) 0);
 445
 446          /* button spans 2 rows */
 447
 448          basic_packer.attach (lm_button, 3, 4, row-1, row+1, xopt, xopt);
 449          ++row;
 450
 451          label = manage (left_aligned_label (_("MIDI System")));
 452          basic_packer.attach (*label, 0, 1, row, row + 1, xopt, (AttachOptions) 0);
 453          basic_packer.attach (midi_option_combo, 1, 2, row, row + 1, SHRINK, (AttachOptions) 0);
 454          row++;
 455  }
 456
 457  void
 458  EngineControl::build_no_control_notebook ()
 459  {
 460          boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
 461          assert (backend);
 462
 463          using namespace Notebook_Helpers;
 464          Label* label;
 465          vector<string> strings;
 466          AttachOptions xopt = AttachOptions (FILL|EXPAND);
 467          int row = 1; // row zero == backend combo
 468          const string msg = string_compose (_("The %1 audio backend was configured and started externally.\nThis limits your control over it."), backend->name());
 469
 470          label = manage (new Label);
 471          label->set_markup (string_compose ("<span weight=\"bold\" foreground=\"red\">%1</span>", msg));
 472          basic_packer.attach (*label, 0, 2, row, row + 1, xopt, (AttachOptions) 0);
 473          row++;
 474
 475          if (backend->can_change_sample_rate_when_running()) {
 476                  label = manage (left_aligned_label (_("Sample rate:")));
 477                  basic_packer.attach (*label, 0, 1, row, row + 1, xopt, (AttachOptions) 0);
 478                  basic_packer.attach (sample_rate_combo, 1, 2, row, row + 1, xopt, (AttachOptions) 0);
 479                  row++;
 480          }
 481
 482          if (backend->can_change_buffer_size_when_running()) {
 483                  label = manage (left_aligned_label (_("Buffer size:")));
 484                  basic_packer.attach (*label, 0, 1, row, row + 1, xopt, (AttachOptions) 0);
 485                  basic_packer.attach (buffer_size_combo, 1, 2, row, row + 1, xopt, (AttachOptions) 0);
 486                  buffer_size_duration_label.set_alignment (0.0); /* left-align */
 487                  basic_packer.attach (buffer_size_duration_label, 2, 3, row, row+1, xopt, (AttachOptions) 0);
 488                  row++;
 489          }
 490
 491          connect_disconnect_button.signal_clicked().connect (sigc::mem_fun (*this, &EngineControl::connect_disconnect_click));
 492
 493          basic_packer.attach (connect_disconnect_button, 0, 2, row, row+1, FILL, AttachOptions (0));
 494          row++;
 495  }
 496
 497  EngineControl::~EngineControl ()
 498  {
 499          ignore_changes = true;
 500  }
 501
 502  void
 503  EngineControl::disable_latency_tab ()
 504  {
 505          vector<string> empty;
 506          set_popdown_strings (lm_output_channel_combo, empty);
 507          set_popdown_strings (lm_input_channel_combo, empty);
 508          lm_measure_button.set_sensitive (false);
 509          lm_use_button.set_sensitive (false);
 510  }
 511
 512  void
 513  EngineControl::enable_latency_tab ()
 514  {
 515          vector<string> outputs;
 516          vector<string> inputs;
 517
 518          ARDOUR::AudioEngine::instance()->get_physical_outputs (ARDOUR::DataType::AUDIO, outputs);
 519          ARDOUR::AudioEngine::instance()->get_physical_inputs (ARDOUR::DataType::AUDIO, inputs);
 520
 521          if (inputs.empty() || outputs.empty()) {
 522                  MessageDialog msg (_("Your selected audio configuration is playback- or capture-only.\n\nLatency calibration requires playback and capture"));
 523                  lm_measure_button.set_sensitive (false);
 524                  notebook.set_current_page (0);
 525                  msg.run ();
 526                  return;
 527          }
 528
 529          if (!outputs.empty()) {
 530                  set_popdown_strings (lm_output_channel_combo, outputs);
 531                  lm_output_channel_combo.set_active_text (outputs.front());
 532                  lm_output_channel_combo.set_sensitive (true);
 533          } else {
 534                  lm_output_channel_combo.set_sensitive (false);
 535          }
 536
 537          if (!inputs.empty()) {
 538                  set_popdown_strings (lm_input_channel_combo, inputs);
 539                  lm_input_channel_combo.set_active_text (inputs.front());
 540                  lm_input_channel_combo.set_sensitive (true);
 541          } else {
 542                  lm_input_channel_combo.set_sensitive (false);
 543          }
 544
 545          lm_measure_button.set_sensitive (true);
 546  }
 547
 548  void
 549  EngineControl::setup_midi_tab_for_backend ()
 550  {
 551          string backend = backend_combo.get_active_text ();
 552
 553          Gtkmm2ext::container_clear (midi_vbox);
 554
 555          midi_vbox.set_border_width (12);
 556          midi_device_table.set_border_width (12);
 557
 558          if (backend == "JACK") {
 559                  setup_midi_tab_for_jack ();
 560          }
 561
 562          midi_vbox.pack_start (midi_device_table, true, true);
 563          midi_vbox.pack_start (midi_refresh_button, false, false);
 564          midi_vbox.show_all ();
 565
 566          midi_refresh_button.signal_clicked().connect (sigc::mem_fun (*this, &EngineControl::refresh_midi_display));
 567  }
 568
 569  void
 570  EngineControl::setup_midi_tab_for_jack ()
 571  {
 572  }
 573
 574  void
 575  EngineControl::refresh_midi_display ()
 576  {
 577          boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
 578          assert (backend);
 579
 580          vector<string> midi_inputs;
 581          vector<string> midi_outputs;
 582          int row  = 0;
 583          AttachOptions xopt = AttachOptions (FILL|EXPAND);
 584          Gtk::Label* l;
 585
 586          Gtkmm2ext::container_clear (midi_device_table);
 587
 588          backend->get_physical_inputs (ARDOUR::DataType::MIDI, midi_inputs);
 589          backend->get_physical_outputs (ARDOUR::DataType::MIDI, midi_outputs);
 590
 591          midi_device_table.set_spacings (6);
 592          midi_device_table.set_homogeneous (true);
 593          midi_device_table.resize (midi_inputs.size() + midi_outputs.size() + 3, 1);
 594
 595          l = manage (new Label);
 596          l->set_markup (string_compose ("<span size=\"large\" weight=\"bold\">%1</span>", _("MIDI Inputs")));
 597          midi_device_table.attach (*l, 0, 1, row, row + 1, xopt, AttachOptions (0));
 598          l->set_alignment (0, 0.5);
 599          row++;
 600          l->show ();
 601
 602          for (vector<string>::iterator p = midi_inputs.begin(); p != midi_inputs.end(); ++p) {
 603                  l = manage (new Label ((*p).substr ((*p).find_last_of (':') + 1)));
 604                  l->set_alignment (0, 0.5);
 605                  midi_device_table.attach (*l, 0, 1, row, row + 1, xopt, AttachOptions (0));
 606                  l->show ();
 607                  row++;
 608          }
 609
 610          row++; // extra row of spacing
 611
 612          l = manage (new Label);
 613          l->set_markup (string_compose ("<span size=\"large\" weight=\"bold\">%1</span>", _("MIDI Outputs")));
 614          midi_device_table.attach (*l, 0, 1, row, row + 1, xopt, AttachOptions (0));
 615          l->set_alignment (0, 0.5);
 616          row++;
 617          l->show ();
 618
 619          for (vector<string>::iterator p = midi_outputs.begin(); p != midi_outputs.end(); ++p) {
 620                  l = manage (new Label ((*p).substr ((*p).find_last_of (':') + 1)));
 621                  l->set_alignment (0, 0.5);
 622                  midi_device_table.attach (*l, 0, 1, row, row + 1, xopt, AttachOptions (0));
 623                  l->show ();
 624                  row++;
 625          }
 626  }
 627
 628  void
 629  EngineControl::update_sensitivity ()
 630  {
 631  }
 632
 633  void
 634  EngineControl::backend_changed ()
 635  {
 636          if (ignore_changes) {
 637                  return;
 638          }
 639
 640          string backend_name = backend_combo.get_active_text();
 641          boost::shared_ptr<ARDOUR::AudioBackend> backend;
 642
 643          if (!(backend = ARDOUR::AudioEngine::instance()->set_backend (backend_name, "ardour", ""))) {
 644                  /* eh? setting the backend failed... how ? */
 645                  return;
 646          }
 647
 648          _have_control = ARDOUR::AudioEngine::instance()->setup_required ();
 649
 650          build_notebook ();
 651          setup_midi_tab_for_backend ();
 652
 653          if (backend->requires_driver_selection()) {
 654                  vector<string> drivers = backend->enumerate_drivers();
 655                  driver_combo.set_sensitive (true);
 656
 657                  if (!drivers.empty()) {
 658                          {
 659                                  PBD::Unwinder<uint32_t> protect_ignore_changes (ignore_changes, ignore_changes + 1);
 660                                  set_popdown_strings (driver_combo, drivers);
 661                                  driver_combo.set_active_text (drivers.front());
 662                          }
 663
 664                          driver_changed ();
 665                  }
 666
 667          } else {
 668                  driver_combo.set_sensitive (false);
 669                  /* this will change the device text which will cause a call to
 670                   * device changed which will set up parameters
 671                   */
 672                  list_devices ();
 673          }
 674
 675          vector<string> midi_options = backend->enumerate_midi_options();
 676
 677          if (midi_options.size() == 1) {
 678                  /* only contains the "none" option */
 679                  midi_option_combo.set_sensitive (false);
 680          } else {
 681                  if (_have_control) {
 682                          set_popdown_strings (midi_option_combo, midi_options);
 683                          midi_option_combo.set_active_text (midi_options.front());
 684                          midi_option_combo.set_sensitive (true);
 685                  } else {
 686                          midi_option_combo.set_sensitive (false);
 687                  }
 688          }
 689
 690          maybe_display_saved_state ();
 691  }
 692
 693  bool
 694  EngineControl::print_channel_count (Gtk::SpinButton* sb)
 695  {
 696          uint32_t cnt = (uint32_t) sb->get_value();
 697          if (cnt == 0) {
 698                  sb->set_text (_("all available channels"));
 699          } else {
 700                  char buf[32];
 701                  snprintf (buf, sizeof (buf), "%d", cnt);
 702                  sb->set_text (buf);
 703          }
 704          return true;
 705  }
 706
 707  void
 708  EngineControl::list_devices ()
 709  {
 710          boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
 711          assert (backend);
 712
 713          /* now fill out devices, mark sample rates, buffer sizes insensitive */
 714
 715          vector<ARDOUR::AudioBackend::DeviceStatus> all_devices = backend->enumerate_devices ();
 716
 717          /* NOTE: Ardour currently does not display the "available" field of the
 718           * returned devices.
 719           *
 720           * Doing so would require a different GUI widget than the combo
 721           * box/popdown that we currently use, since it has no way to list
 722           * items that are not selectable. Something more like a popup menu,
 723           * which could have unselectable items, would be appropriate.
 724           */
 725
 726          vector<string> available_devices;
 727
 728          for (vector<ARDOUR::AudioBackend::DeviceStatus>::const_iterator i = all_devices.begin(); i != all_devices.end(); ++i) {
 729                  available_devices.push_back (i->name);
 730          }
 731
 732          if (!available_devices.empty()) {
 733
 734                  update_sensitivity ();
 735
 736                  {
 737                          PBD::Unwinder<uint32_t> protect_ignore_changes (ignore_changes, ignore_changes + 1);
 738                          set_popdown_strings (device_combo, available_devices);
 739                          device_combo.set_active_text (available_devices.front());
 740                  }
 741
 742                  device_changed ();
 743
 744                  ok_button->set_sensitive (true);
 745                  apply_button->set_sensitive (true);
 746
 747          } else {
 748                  sample_rate_combo.set_sensitive (false);
 749                  buffer_size_combo.set_sensitive (false);
 750                  input_latency.set_sensitive (false);
 751                  output_latency.set_sensitive (false);
 752                  input_channels.set_sensitive (false);
 753                  output_channels.set_sensitive (false);
 754                  ok_button->set_sensitive (false);
 755                  apply_button->set_sensitive (false);
 756          }
 757  }
 758
 759  void
 760  EngineControl::driver_changed ()
 761  {
 762          if (ignore_changes) {
 763                  return;
 764          }
 765
 766          boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
 767          assert (backend);
 768
 769          backend->set_driver (driver_combo.get_active_text());
 770          list_devices ();
 771
 772          maybe_display_saved_state ();
 773  }
 774
 775  void
 776  EngineControl::device_changed ()
 777  {
 778          if (ignore_changes) {
 779                  return;
 780          }
 781
 782          boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
 783          assert (backend);
 784          string device_name = device_combo.get_active_text ();
 785          vector<string> s;
 786
 787          {
 788                  PBD::Unwinder<uint32_t> protect_ignore_changes (ignore_changes, ignore_changes + 1);
 789
 790                  /* don't allow programmatic change to combos to cause a
 791                     recursive call to this method.
 792                  */
 793
 794                  /* sample rates */
 795
 796                  string desired;
 797
 798                  vector<float> sr;
 799
 800                  if (_have_control) {
 801                          sr = backend->available_sample_rates (device_name);
 802                  } else {
 803
 804                          sr.push_back (8000.0f);
 805                          sr.push_back (16000.0f);
 806                          sr.push_back (32000.0f);
 807                          sr.push_back (44100.0f);
 808                          sr.push_back (48000.0f);
 809                          sr.push_back (88200.0f);
 810                          sr.push_back (96000.0f);
 811                          sr.push_back (192000.0f);
 812                          sr.push_back (384000.0f);
 813                  }
 814
 815                  for (vector<float>::const_iterator x = sr.begin(); x != sr.end(); ++x) {
 816                          s.push_back (rate_as_string (*x));
 817                          if (*x == _desired_sample_rate) {
 818                                  desired = s.back();
 819                          }
 820                  }
 821
 822                  if (!s.empty()) {
 823                          sample_rate_combo.set_sensitive (true);
 824                          set_popdown_strings (sample_rate_combo, s);
 825
 826                          if (desired.empty()) {
 827                                  sample_rate_combo.set_active_text (rate_as_string (backend->default_sample_rate()));
 828                          } else {
 829                                  sample_rate_combo.set_active_text (desired);
 830                          }
 831
 832                  } else {
 833                          sample_rate_combo.set_sensitive (false);
 834                  }
 835
 836                  /* buffer sizes */
 837
 838                  vector<uint32_t> bs;
 839
 840                  if (_have_control) {
 841                          bs = backend->available_buffer_sizes(device_name);
 842                  } else if (backend->can_change_buffer_size_when_running()) {
 843                          bs.push_back (8);
 844                          bs.push_back (16);
 845                          bs.push_back (32);
 846                          bs.push_back (64);
 847                          bs.push_back (128);
 848                          bs.push_back (256);
 849                          bs.push_back (512);
 850                          bs.push_back (1024);
 851                          bs.push_back (2048);
 852                          bs.push_back (4096);
 853                          bs.push_back (8192);
 854                  }
 855                  s.clear ();
 856                  for (vector<uint32_t>::const_iterator x = bs.begin(); x != bs.end(); ++x) {
 857                          s.push_back (bufsize_as_string (*x));
 858                  }
 859
 860                  if (!s.empty()) {
 861                          buffer_size_combo.set_sensitive (true);
 862                          set_popdown_strings (buffer_size_combo, s);
 863
 864                          buffer_size_combo.set_active_text (bufsize_as_string (backend->default_buffer_size()));
 865                          show_buffer_duration ();
 866                  } else {
 867                          buffer_size_combo.set_sensitive (false);
 868                  }
 869
 870                  /* XXX theoretically need to set min + max channel counts here
 871                   */
 872
 873                  manage_control_app_sensitivity ();
 874          }
 875
 876          /* pick up any saved state for this device */
 877
 878          maybe_display_saved_state ();
 879  }
 880
 881  string
 882  EngineControl::bufsize_as_string (uint32_t sz)
 883  {
 884          /* Translators: "samples" is always plural here, so no
 885             need for plural+singular forms.
 886          */
 887          char buf[32];
 888          snprintf (buf, sizeof (buf), _("%u samples"), sz);
 889          return buf;
 890  }
 891
 892  void
 893  EngineControl::sample_rate_changed ()
 894  {
 895          if (ignore_changes) {
 896                  return;
 897          }
 898
 899          /* reset the strings for buffer size to show the correct msec value
 900             (reflecting the new sample rate).
 901          */
 902
 903          show_buffer_duration ();
 904          save_state ();
 905
 906  }
 907
 908  void
 909  EngineControl::buffer_size_changed ()
 910  {
 911          if (ignore_changes) {
 912                  return;
 913          }
 914
 915          show_buffer_duration ();
 916          save_state ();
 917  }
 918
 919  void
 920  EngineControl::show_buffer_duration ()
 921  {
 922
 923          /* buffer sizes  - convert from just samples to samples + msecs for
 924           * the displayed string
 925           */
 926
 927          string bs_text = buffer_size_combo.get_active_text ();
 928          uint32_t samples = atoi (bs_text); /* will ignore trailing text */
 929          uint32_t rate = get_rate();
 930
 931          /* Translators: "msecs" is ALWAYS plural here, so we do not
 932             need singular form as well.
 933          */
 934          /* Developers: note the hard-coding of a double buffered model
 935             in the (2 * samples) computation of latency. we always start
 936             the audiobackend in this configuration.
 937          */
 938          char buf[32];
 939          snprintf (buf, sizeof (buf), _("(%.1f msecs)"), (2 * samples) / (rate/1000.0));
 940          buffer_size_duration_label.set_text (buf);
 941  }
 942
 943  void
 944  EngineControl::midi_option_changed ()
 945  {
 946          if (!ignore_changes) {
 947                  save_state ();
 948          }
 949  }
 950
 951  void
 952  EngineControl::parameter_changed ()
 953  {
 954          if (!ignore_changes) {
 955                  save_state ();
 956          }
 957  }
 958
 959  EngineControl::State*
 960  EngineControl::get_matching_state (const string& backend,
 961                                     const string& driver,
 962                                     const string& device)
 963  {
 964          for (StateList::iterator i = states.begin(); i != states.end(); ++i) {
 965                  if ((*i).backend == backend &&
 966                      (*i).driver == driver &&
 967                      (*i).device == device) {
 968                          return &(*i);
 969                  }
 970          }
 971          return 0;
 972  }
 973
 974  EngineControl::State*
 975  EngineControl::get_saved_state_for_currently_displayed_backend_and_device ()
 976  {
 977          boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
 978
 979          if (backend) {
 980                  return get_matching_state (backend_combo.get_active_text(),
 981                                             (backend->requires_driver_selection() ? (std::string) driver_combo.get_active_text() : string()),
 982                                             device_combo.get_active_text());
 983          }
 984
 985
 986          return get_matching_state (backend_combo.get_active_text(),
 987                                     string(),
 988                                     device_combo.get_active_text());
 989  }
 990
 991  EngineControl::State*
 992  EngineControl::save_state ()
 993  {
 994          if (!_have_control) {
 995                  return 0;
 996          }
 997
 998          bool existing = true;
 999          State* state = get_saved_state_for_currently_displayed_backend_and_device ();
1000
1001          if (!state) {
1002                  existing = false;
1003                  state = new State;
1004          }
1005
1006          store_state (*state);
1007
1008          if (!existing) {
1009                  states.push_back (*state);
1010          }
1011
1012          return state;
1013  }
1014
1015  void
1016  EngineControl::store_state (State& state)
1017  {
1018          state.backend = get_backend ();
1019          state.driver = get_driver ();
1020          state.device = get_device_name ();
1021          state.sample_rate = get_rate ();
1022          state.buffer_size = get_buffer_size ();
1023          state.input_latency = get_input_latency ();
1024          state.output_latency = get_output_latency ();
1025          state.input_channels = get_input_channels ();
1026          state.output_channels = get_output_channels ();
1027          state.midi_option = get_midi_option ();
1028  }
1029
1030  void
1031  EngineControl::maybe_display_saved_state ()
1032  {
1033          if (!_have_control) {
1034                  return;
1035          }
1036
1037          State* state = get_saved_state_for_currently_displayed_backend_and_device ();
1038
1039          if (state) {
1040                  PBD::Unwinder<uint32_t> protect_ignore_changes (ignore_changes, ignore_changes + 1);
1041
1042                  if (!_desired_sample_rate) {
1043                          sample_rate_combo.set_active_text (rate_as_string (state->sample_rate));
1044                  }
1045                  buffer_size_combo.set_active_text (bufsize_as_string (state->buffer_size));
1046                  /* call this explicitly because we're ignoring changes to
1047                     the controls at this point.
1048                  */
1049                  show_buffer_duration ();
1050                  input_latency.set_value (state->input_latency);
1051                  output_latency.set_value (state->output_latency);
1052
1053                  if (!state->midi_option.empty()) {
1054                          midi_option_combo.set_active_text (state->midi_option);
1055                  }
1056          }
1057  }
1058
1059  XMLNode&
1060  EngineControl::get_state ()
1061  {
1062          XMLNode* root = new XMLNode ("AudioMIDISetup");
1063          std::string path;
1064
1065          if (!states.empty()) {
1066                  XMLNode* state_nodes = new XMLNode ("EngineStates");
1067
1068                  for (StateList::const_iterator i = states.begin(); i != states.end(); ++i) {
1069
1070                          XMLNode* node = new XMLNode ("State");
1071
1072                          node->add_property ("backend", (*i).backend);
1073                          node->add_property ("driver", (*i).driver);
1074                          node->add_property ("device", (*i).device);
1075                          node->add_property ("sample-rate", (*i).sample_rate);
1076                          node->add_property ("buffer-size", (*i).buffer_size);
1077                          node->add_property ("input-latency", (*i).input_latency);
1078                          node->add_property ("output-latency", (*i).output_latency);
1079                          node->add_property ("input-channels", (*i).input_channels);
1080                          node->add_property ("output-channels", (*i).output_channels);
1081                          node->add_property ("active", (*i).active ? "yes" : "no");
1082                          node->add_property ("midi-option", (*i).midi_option);
1083
1084                          state_nodes->add_child_nocopy (*node);
1085                  }
1086
1087                  root->add_child_nocopy (*state_nodes);
1088          }
1089
1090          return *root;
1091  }
1092
1093  void
1094  EngineControl::set_state (const XMLNode& root)
1095  {
1096          XMLNodeList          clist, cclist;
1097          XMLNodeConstIterator citer, cciter;
1098          XMLNode* child;
1099          XMLNode* grandchild;
1100          XMLProperty* prop = NULL;
1101
1102          if (root.name() != "AudioMIDISetup") {
1103                  return;
1104          }
1105
1106          clist = root.children();
1107
1108          states.clear ();
1109
1110          for (citer = clist.begin(); citer != clist.end(); ++citer) {
1111
1112                  child = *citer;
1113
1114                  if (child->name() != "EngineStates") {
1115                          continue;
1116                  }
1117
1118                  cclist = child->children();
1119
1120                  for (cciter = cclist.begin(); cciter != cclist.end(); ++cciter) {
1121                          State state;
1122
1123                          grandchild = *cciter;
1124
1125                          if (grandchild->name() != "State") {
1126                                  continue;
1127                          }
1128
1129                          if ((prop = grandchild->property ("backend")) == 0) {
1130                                  continue;
1131                          }
1132                          state.backend = prop->value ();
1133
1134                          if ((prop = grandchild->property ("driver")) == 0) {
1135                                  continue;
1136                          }
1137                          state.driver = prop->value ();
1138
1139                          if ((prop = grandchild->property ("device")) == 0) {
1140                                  continue;
1141                          }
1142                          state.device = prop->value ();
1143
1144                          if ((prop = grandchild->property ("sample-rate")) == 0) {
1145                                  continue;
1146                          }
1147                          state.sample_rate = atof (prop->value ());
1148
1149                          if ((prop = grandchild->property ("buffer-size")) == 0) {
1150                                  continue;
1151                          }
1152                          state.buffer_size = atoi (prop->value ());
1153
1154                          if ((prop = grandchild->property ("input-latency")) == 0) {
1155                                  continue;
1156                          }
1157                          state.input_latency = atoi (prop->value ());
1158
1159                          if ((prop = grandchild->property ("output-latency")) == 0) {
1160                                  continue;
1161                          }
1162                          state.output_latency = atoi (prop->value ());
1163
1164                          if ((prop = grandchild->property ("input-channels")) == 0) {
1165                                  continue;
1166                          }
1167                          state.input_channels = atoi (prop->value ());
1168
1169                          if ((prop = grandchild->property ("output-channels")) == 0) {
1170                                  continue;
1171                          }
1172                          state.output_channels = atoi (prop->value ());
1173
1174                          if ((prop = grandchild->property ("active")) == 0) {
1175                                  continue;
1176                          }
1177                          state.active = string_is_affirmative (prop->value ());
1178
1179                          if ((prop = grandchild->property ("midi-option")) == 0) {
1180                                  continue;
1181                          }
1182                          state.midi_option = prop->value ();
1183
1184                          states.push_back (state);
1185                  }
1186          }
1187
1188          /* now see if there was an active state and switch the setup to it */
1189
1190          for (StateList::const_iterator i = states.begin(); i != states.end(); ++i) {
1191
1192                  if ((*i).active) {
1193                          ignore_changes++;
1194                          backend_combo.set_active_text ((*i).backend);
1195                          driver_combo.set_active_text ((*i).driver);
1196                          device_combo.set_active_text ((*i).device);
1197                          sample_rate_combo.set_active_text (rate_as_string ((*i).sample_rate));
1198                          buffer_size_combo.set_active_text (bufsize_as_string ((*i).buffer_size));
1199                          input_latency.set_value ((*i).input_latency);
1200                          output_latency.set_value ((*i).output_latency);
1201                          midi_option_combo.set_active_text ((*i).midi_option);
1202                          ignore_changes--;
1203                          break;
1204                  }
1205          }
1206  }
1207
1208  int
1209  EngineControl::push_state_to_backend (bool start)
1210  {
1211          boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
1212
1213          if (!backend) {
1214                  return 0;
1215          }
1216
1217          /* figure out what is going to change */
1218
1219          bool restart_required = false;
1220          bool was_running = ARDOUR::AudioEngine::instance()->running();
1221          bool change_driver = false;
1222          bool change_device = false;
1223          bool change_rate = false;
1224          bool change_bufsize = false;
1225          bool change_latency = false;
1226          bool change_channels = false;
1227          bool change_midi = false;
1228
1229          uint32_t ochan = get_output_channels ();
1230          uint32_t ichan = get_input_channels ();
1231
1232          if (_have_control) {
1233
1234                  if (started_at_least_once) {
1235
1236                          /* we can control the backend */
1237
1238                          if (backend->requires_driver_selection()) {
1239                                  if (get_driver() != backend->driver_name()) {
1240                                          change_driver = true;
1241                                  }
1242                          }
1243
1244                          if (get_device_name() != backend->device_name()) {
1245                                  change_device = true;
1246                          }
1247
1248                          if (get_rate() != backend->sample_rate()) {
1249                                  change_rate = true;
1250                          }
1251
1252                          if (get_buffer_size() != backend->buffer_size()) {
1253                                  change_bufsize = true;
1254                          }
1255
1256                          if (get_midi_option() != backend->midi_option()) {
1257                                  change_midi = true;
1258                          }
1259
1260                          /* zero-requested channels means "all available" */
1261
1262                          if (ichan == 0) {
1263                                  ichan = backend->input_channels();
1264                          }
1265
1266                          if (ochan == 0) {
1267                                  ochan = backend->output_channels();
1268                          }
1269
1270                          if (ichan != backend->input_channels()) {
1271                                  change_channels = true;
1272                          }
1273
1274                          if (ochan != backend->output_channels()) {
1275                                  change_channels = true;
1276                          }
1277
1278                          if (get_input_latency() != backend->systemic_input_latency() ||
1279                              get_output_latency() != backend->systemic_output_latency()) {
1280                                  change_latency = true;
1281                          }
1282                  } else {
1283                          /* backend never started, so we have to force a group
1284                             of settings.
1285                          */
1286                          change_device = true;
1287                          if (backend->requires_driver_selection()) {
1288                                  change_driver = true;
1289                          }
1290                          change_rate = true;
1291                          change_bufsize = true;
1292                          change_channels = true;
1293                          change_latency = true;
1294                          change_midi = true;
1295                  }
1296
1297          } else {
1298
1299                  /* we have no control over the backend, meaning that we can
1300                   * only possibly change sample rate and buffer size.
1301                   */
1302
1303
1304                  if (get_rate() != backend->sample_rate()) {
1305                          change_bufsize = true;
1306                  }
1307
1308                  if (get_buffer_size() != backend->buffer_size()) {
1309                          change_bufsize = true;
1310                  }
1311          }
1312
1313          if (!_have_control) {
1314
1315                  /* We do not have control over the backend, so the best we can
1316                   * do is try to change the sample rate and/or bufsize and get
1317                   * out of here.
1318                   */
1319
1320                  if (change_rate && !backend->can_change_sample_rate_when_running()) {
1321                          return 1;
1322                  }
1323
1324                  if (change_bufsize && !backend->can_change_buffer_size_when_running()) {
1325                          return 1;
1326                  }
1327
1328                  if (change_rate) {
1329                          backend->set_sample_rate (get_rate());
1330                  }
1331
1332                  if (change_bufsize) {
1333                          backend->set_buffer_size (get_buffer_size());
1334                  }
1335
1336                  if (start) {
1337                          if (ARDOUR::AudioEngine::instance()->start ()) {
1338                                  error << string_compose (_("Could not start backend engine %1"), backend->name()) << endmsg;
1339                                  return -1;
1340                          }
1341                  }
1342
1343                  post_push ();
1344
1345                  return 0;
1346          }
1347
1348          /* determine if we need to stop the backend before changing parameters */
1349
1350          if (change_driver || change_device || change_channels || change_latency ||
1351              (change_rate && !backend->can_change_sample_rate_when_running()) ||
1352              change_midi ||
1353              (change_bufsize && !backend->can_change_buffer_size_when_running())) {
1354                  restart_required = true;
1355          } else {
1356                  restart_required = false;
1357          }
1358
1359          if (was_running) {
1360
1361                  if (!change_driver && !change_device && !change_channels && !change_latency && !change_midi) {
1362                          /* no changes in any parameters that absolutely require a
1363                           * restart, so check those that might be changeable without a
1364                           * restart
1365                           */
1366
1367                          if (change_rate && !backend->can_change_sample_rate_when_running()) {
1368                                  /* can't do this while running ... */
1369                                  restart_required = true;
1370                          }
1371
1372                          if (change_bufsize && !backend->can_change_buffer_size_when_running()) {
1373                                  /* can't do this while running ... */
1374                                  restart_required = true;
1375                          }
1376                  }
1377          }
1378
1379          if (was_running) {
1380                  if (restart_required) {
1381                          if (ARDOUR_UI::instance()->disconnect_from_engine ()) {
1382                                  return -1;
1383                          }
1384                  }
1385          }
1386
1387
1388          if (change_driver && backend->set_driver (get_driver())) {
1389                  error << string_compose (_("Cannot set driver to %1"), get_driver()) << endmsg;
1390                  return -1;
1391          }
1392          if (change_device && backend->set_device_name (get_device_name())) {
1393                  error << string_compose (_("Cannot set device name to %1"), get_device_name()) << endmsg;
1394                  return -1;
1395          }
1396          if (change_rate && backend->set_sample_rate (get_rate())) {
1397                  error << string_compose (_("Cannot set sample rate to %1"), get_rate()) << endmsg;
1398                  return -1;
1399          }
1400          if (change_bufsize && backend->set_buffer_size (get_buffer_size())) {
1401                  error << string_compose (_("Cannot set buffer size to %1"), get_buffer_size()) << endmsg;
1402                  return -1;
1403          }
1404
1405          if (change_channels || get_input_channels() == 0 || get_output_channels() == 0) {
1406                  if (backend->set_input_channels (get_input_channels())) {
1407                          error << string_compose (_("Cannot set input channels to %1"), get_input_channels()) << endmsg;
1408                          return -1;
1409                  }
1410                  if (backend->set_output_channels (get_output_channels())) {
1411                          error << string_compose (_("Cannot set output channels to %1"), get_output_channels()) << endmsg;
1412                          return -1;
1413                  }
1414          }
1415          if (change_latency) {
1416                  if (backend->set_systemic_input_latency (get_input_latency())) {
1417                          error << string_compose (_("Cannot set input latency to %1"), get_input_latency()) << endmsg;
1418                          return -1;
1419                  }
1420                  if (backend->set_systemic_output_latency (get_output_latency())) {
1421                          error << string_compose (_("Cannot set output latency to %1"), get_output_latency()) << endmsg;
1422                          return -1;
1423                  }
1424          }
1425
1426          if (change_midi) {
1427                  backend->set_midi_option (get_midi_option());
1428          }
1429
1430          if (start || (was_running && restart_required)) {
1431                  if (ARDOUR_UI::instance()->reconnect_to_engine()) {
1432                          return -1;
1433                  }
1434          }
1435
1436          post_push ();
1437
1438          return 0;
1439  }
1440
1441  void
1442  EngineControl::post_push ()
1443  {
1444          /* get a pointer to the current state object, creating one if
1445           * necessary
1446           */
1447
1448          if (_have_control) {
1449                  State* state = get_saved_state_for_currently_displayed_backend_and_device ();
1450
1451                  if (!state) {
1452                          state = save_state ();
1453                          assert (state);
1454                  }
1455
1456                  /* all off */
1457
1458                  for (StateList::iterator i = states.begin(); i != states.end(); ++i) {
1459                          (*i).active = false;
1460                  }
1461
1462                  /* mark this one active (to be used next time the dialog is
1463                   * shown)
1464                   */
1465
1466                  state->active = true;
1467
1468                  manage_control_app_sensitivity ();
1469          }
1470
1471          /* schedule a redisplay of MIDI ports */
1472
1473          Glib::signal_timeout().connect (sigc::bind_return (sigc::mem_fun (*this, &EngineControl::refresh_midi_display), false), 1000);
1474  }
1475
1476
1477  float
1478  EngineControl::get_rate () const
1479  {
1480          float r = atof (sample_rate_combo.get_active_text ());
1481          /* the string may have been translated with an abbreviation for
1482           * thousands, so use a crude heuristic to fix this.
1483           */
1484          if (r < 1000.0) {
1485                  r *= 1000.0;
1486          }
1487          return r;
1488  }
1489
1490
1491  uint32_t
1492  EngineControl::get_buffer_size () const
1493  {
1494          string txt = buffer_size_combo.get_active_text ();
1495          uint32_t samples;
1496
1497          if (sscanf (txt.c_str(), "%d", &samples) != 1) {
1498                  throw exception ();
1499          }
1500
1501          return samples;
1502  }
1503
1504  string
1505  EngineControl::get_midi_option () const
1506  {
1507          return midi_option_combo.get_active_text();
1508  }
1509
1510  uint32_t
1511  EngineControl::get_input_channels() const
1512  {
1513          return (uint32_t) input_channels_adjustment.get_value();
1514  }
1515
1516  uint32_t
1517  EngineControl::get_output_channels() const
1518  {
1519          return (uint32_t) output_channels_adjustment.get_value();
1520  }
1521
1522  uint32_t
1523  EngineControl::get_input_latency() const
1524  {
1525          return (uint32_t) input_latency_adjustment.get_value();
1526  }
1527
1528  uint32_t
1529  EngineControl::get_output_latency() const
1530  {
1531          return (uint32_t) output_latency_adjustment.get_value();
1532  }
1533
1534  string
1535  EngineControl::get_backend () const
1536  {
1537          return backend_combo.get_active_text ();
1538  }
1539
1540  string
1541  EngineControl::get_driver () const
1542  {
1543          return driver_combo.get_active_text ();
1544  }
1545
1546  string
1547  EngineControl::get_device_name () const
1548  {
1549          return device_combo.get_active_text ();
1550  }
1551
1552  void
1553  EngineControl::control_app_button_clicked ()
1554  {
1555          boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
1556
1557          if (!backend) {
1558                  return;
1559          }
1560
1561          backend->launch_control_app ();
1562  }
1563
1564  void
1565  EngineControl::manage_control_app_sensitivity ()
1566  {
1567          boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
1568
1569          if (!backend) {
1570                  return;
1571          }
1572
1573          string appname = backend->control_app_name();
1574
1575          if (appname.empty()) {
1576                  control_app_button.set_sensitive (false);
1577          } else {
1578                  control_app_button.set_sensitive (true);
1579          }
1580  }
1581
1582  void
1583  EngineControl::set_desired_sample_rate (uint32_t sr)
1584  {
1585          _desired_sample_rate = sr;
1586          device_changed ();
1587  }
1588
1589  void
1590  EngineControl::on_switch_page (GtkNotebookPage*, guint page_num)
1591  {
1592          if (page_num == 0) {
1593                  cancel_button->set_sensitive (true);
1594                  ok_button->set_sensitive (true);
1595                  apply_button->set_sensitive (true);
1596          } else {
1597                  cancel_button->set_sensitive (false);
1598                  ok_button->set_sensitive (false);
1599                  apply_button->set_sensitive (false);
1600          }
1601
1602          if (page_num == midi_tab) {
1603                  /* MIDI tab */
1604                  refresh_midi_display ();
1605          }
1606
1607          if (page_num == latency_tab) {
1608                  /* latency tab */
1609
1610                  if (!ARDOUR::AudioEngine::instance()->running()) {
1611
1612                          PBD::Unwinder<uint32_t> protect_ignore_changes (ignore_changes, ignore_changes + 1);
1613
1614                          /* save any existing latency values */
1615
1616                          uint32_t il = (uint32_t) input_latency.get_value ();
1617                          uint32_t ol = (uint32_t) input_latency.get_value ();
1618
1619                          /* reset to zero so that our new test instance
1620                             will be clean of any existing latency measures.
1621                          */
1622
1623                          input_latency.set_value (0);
1624                          output_latency.set_value (0);
1625
1626                          /* reset control */
1627
1628                          input_latency.set_value (il);
1629                          output_latency.set_value (ol);
1630
1631                  }
1632
1633                  if (ARDOUR::AudioEngine::instance()->prepare_for_latency_measurement()) {
1634                          disable_latency_tab ();
1635                  }
1636
1637                  enable_latency_tab ();
1638
1639          } else {
1640                  if (lm_running) {
1641                          ARDOUR::AudioEngine::instance()->stop_latency_detection();
1642                  }
1643          }
1644  }
1645
1646  /* latency measurement */
1647
1648  bool
1649  EngineControl::check_latency_measurement ()
1650  {
1651          MTDM* mtdm = ARDOUR::AudioEngine::instance()->mtdm ();
1652
1653          if (mtdm->resolve () < 0) {
1654                  lm_results.set_markup (string_compose (results_markup, _("No signal detected ")));
1655                  return true;
1656          }
1657
1658          if (mtdm->err () > 0.3) {
1659                  mtdm->invert ();
1660                  mtdm->resolve ();
1661          }
1662
1663          char buf[128];
1664          ARDOUR::framecnt_t const sample_rate = ARDOUR::AudioEngine::instance()->sample_rate();
1665
1666          if (sample_rate == 0) {
1667                  lm_results.set_markup (string_compose (results_markup, _("Disconnected from audio engine")));
1668                  ARDOUR::AudioEngine::instance()->stop_latency_detection ();
1669                  return false;
1670          }
1671
1672          uint32_t frames_total = mtdm->del();
1673          uint32_t extra = frames_total - ARDOUR::AudioEngine::instance()->latency_signal_delay();
1674
1675          snprintf (buf, sizeof (buf), "%u samples / %.3lf ms", extra, extra * 1000.0f/sample_rate);
1676
1677          bool solid = true;
1678
1679          if (mtdm->err () > 0.2) {
1680                  strcat (buf, " ");
1681                  strcat (buf, _("(signal detection error)"));
1682                  solid = false;
1683          }
1684
1685          if (mtdm->inv ()) {
1686                  strcat (buf, " ");
1687                  strcat (buf, _("(inverted - bad wiring)"));
1688                  solid = false;
1689          }
1690
1691          if (solid) {
1692                  end_latency_detection ();
1693                  lm_use_button.set_sensitive (true);
1694                  have_lm_results = true;
1695         }
1696
1697         lm_results.set_markup (string_compose (results_markup, string_compose (_("Detected roundtrip latency: %1"), buf)));
1698
1699         return true;
1700 }
1701
1702 void
1703 EngineControl::start_latency_detection ()
1704 {
1705         ARDOUR::AudioEngine::instance()->set_latency_input_port (lm_input_channel_combo.get_active_text());
1706         ARDOUR::AudioEngine::instance()->set_latency_output_port (lm_output_channel_combo.get_active_text());
1707
1708         if (ARDOUR::AudioEngine::instance()->start_latency_detection () == 0) {
1709                 lm_results.set_markup (string_compose (results_markup, _("Detecting ...")));
1710                 latency_timeout = Glib::signal_timeout().connect (mem_fun (*this, &EngineControl::check_latency_measurement), 100);
1711                 lm_measure_label.set_text (_("Cancel"));
1712                 have_lm_results = false;
1713                 lm_use_button.set_sensitive (false);
1714                 lm_input_channel_combo.set_sensitive (false);
1715                 lm_output_channel_combo.set_sensitive (false);
1716                 lm_running = true;
1717         }
1718 }
1719
1720 void
1721 EngineControl::end_latency_detection ()
1722 {
1723         latency_timeout.disconnect ();
1724         ARDOUR::AudioEngine::instance()->stop_latency_detection ();
1725         lm_measure_label.set_text (_("Measure"));
1726         if (!have_lm_results) {
1727                 lm_results.set_markup (string_compose (results_markup, _("No measurement results yet")));
1728         } else {
1729                 lm_use_button.set_sensitive (false);
1730         }
1731         lm_input_channel_combo.set_sensitive (true);
1732         lm_output_channel_combo.set_sensitive (true);
1733         lm_running = false;
1734 }
1735
1736 void
1737 EngineControl::latency_button_clicked ()
1738 {
1739         if (!lm_running) {
1740                 start_latency_detection ();
1741         } else {
1742                 end_latency_detection ();
1743         }
1744 }
1745
1746 void
1747 EngineControl::use_latency_button_clicked ()
1748 {
1749         MTDM* mtdm = ARDOUR::AudioEngine::instance()->mtdm ();
1750
1751         if (!mtdm) {
1752                 return;
1753         }
1754
1755         uint32_t frames_total = mtdm->del();
1756         uint32_t extra = frames_total - ARDOUR::AudioEngine::instance()->latency_signal_delay();
1757         uint32_t one_way = extra/2;
1758
1759         input_latency_adjustment.set_value (one_way);
1760         output_latency_adjustment.set_value (one_way);
1761
1762         /* back to settings page */
1763
1764         notebook.set_current_page (0);
1765 }
1766
1767 bool
1768 EngineControl::on_delete_event (GdkEventAny* ev)
1769 {
1770         if (notebook.get_current_page() == 2) {
1771                 /* currently on latency tab - be sure to clean up */
1772                 end_latency_detection ();
1773         }
1774         return ArdourDialog::on_delete_event (ev);
1775 }
1776
1777 void
1778 EngineControl::engine_running ()
1779 {
1780         boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
1781         assert (backend);
1782
1783         buffer_size_combo.set_active_text (bufsize_as_string (backend->buffer_size()));
1784         sample_rate_combo.set_active_text (rate_as_string (backend->sample_rate()));
1785
1786         buffer_size_combo.set_sensitive (true);
1787         sample_rate_combo.set_sensitive (true);
1788
1789         connect_disconnect_button.set_label (string_compose (_("Disconnect from %1"), backend->name()));
1790
1791         started_at_least_once = true;
1792 }
1793
1794 void
1795 EngineControl::engine_stopped ()
1796 {
1797         boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
1798         assert (backend);
1799
1800         buffer_size_combo.set_sensitive (false);
1801         connect_disconnect_button.set_label (string_compose (_("Connect to %1"), backend->name()));
1802
1803         sample_rate_combo.set_sensitive (true);
1804         buffer_size_combo.set_sensitive (true);
1805 }
1806
1807 void
1808 EngineControl::connect_disconnect_click()
1809 {
1810         if (ARDOUR::AudioEngine::instance()->running()) {
1811                 ARDOUR_UI::instance()->disconnect_from_engine ();
1812         } else {
1813                 ARDOUR_UI::instance()->reconnect_to_engine ();
1814         }
1815 }
1816
1817 void
1818 EngineControl::calibrate_latency ()
1819 {
1820         notebook.set_current_page (latency_tab);
1821 }
1822