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
 656                  if (!drivers.empty()) {
 657                          {
 658                                  PBD::Unwinder<uint32_t> protect_ignore_changes (ignore_changes, ignore_changes + 1);
 659                                  set_popdown_strings (driver_combo, drivers);
 660                                  driver_combo.set_active_text (drivers.front());
 661                          }
 662
 663                          driver_changed ();
 664                  }
 665
 666          } else {
 667                  driver_combo.set_sensitive (false);
 668                  /* this will change the device text which will cause a call to
 669                   * device changed which will set up parameters
 670                   */
 671                  list_devices ();
 672          }
 673
 674          vector<string> midi_options = backend->enumerate_midi_options();
 675
 676          if (midi_options.size() == 1) {
 677                  /* only contains the "none" option */
 678                  midi_option_combo.set_sensitive (false);
 679          } else {
 680                  if (_have_control) {
 681                          set_popdown_strings (midi_option_combo, midi_options);
 682                          midi_option_combo.set_active_text (midi_options.front());
 683                          midi_option_combo.set_sensitive (true);
 684                  } else {
 685                          midi_option_combo.set_sensitive (false);
 686                  }
 687          }
 688
 689          maybe_display_saved_state ();
 690  }
 691
 692  bool
 693  EngineControl::print_channel_count (Gtk::SpinButton* sb)
 694  {
 695          uint32_t cnt = (uint32_t) sb->get_value();
 696          if (cnt == 0) {
 697                  sb->set_text (_("all available channels"));
 698          } else {
 699                  char buf[32];
 700                  snprintf (buf, sizeof (buf), "%d", cnt);
 701                  sb->set_text (buf);
 702          }
 703          return true;
 704  }
 705
 706  void
 707  EngineControl::list_devices ()
 708  {
 709          boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
 710          assert (backend);
 711
 712          /* now fill out devices, mark sample rates, buffer sizes insensitive */
 713
 714          vector<ARDOUR::AudioBackend::DeviceStatus> all_devices = backend->enumerate_devices ();
 715
 716          /* NOTE: Ardour currently does not display the "available" field of the
 717           * returned devices.
 718           *
 719           * Doing so would require a different GUI widget than the combo
 720           * box/popdown that we currently use, since it has no way to list
 721           * items that are not selectable. Something more like a popup menu,
 722           * which could have unselectable items, would be appropriate.
 723           */
 724
 725          vector<string> available_devices;
 726
 727          for (vector<ARDOUR::AudioBackend::DeviceStatus>::const_iterator i = all_devices.begin(); i != all_devices.end(); ++i) {
 728                  available_devices.push_back (i->name);
 729          }
 730
 731          if (!available_devices.empty()) {
 732
 733                  update_sensitivity ();
 734
 735                  {
 736                          PBD::Unwinder<uint32_t> protect_ignore_changes (ignore_changes, ignore_changes + 1);
 737                          set_popdown_strings (device_combo, available_devices);
 738                          device_combo.set_active_text (available_devices.front());
 739                  }
 740
 741                  device_changed ();
 742
 743                  ok_button->set_sensitive (true);
 744                  apply_button->set_sensitive (true);
 745
 746          } else {
 747                  sample_rate_combo.set_sensitive (false);
 748                  buffer_size_combo.set_sensitive (false);
 749                  input_latency.set_sensitive (false);
 750                  output_latency.set_sensitive (false);
 751                  input_channels.set_sensitive (false);
 752                  output_channels.set_sensitive (false);
 753                  ok_button->set_sensitive (false);
 754                  apply_button->set_sensitive (false);
 755          }
 756  }
 757
 758  void
 759  EngineControl::driver_changed ()
 760  {
 761          if (ignore_changes) {
 762                  return;
 763          }
 764
 765          boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
 766          assert (backend);
 767
 768          backend->set_driver (driver_combo.get_active_text());
 769          list_devices ();
 770
 771          maybe_display_saved_state ();
 772  }
 773
 774  void
 775  EngineControl::device_changed ()
 776  {
 777          if (ignore_changes) {
 778                  return;
 779          }
 780
 781          boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
 782          assert (backend);
 783          string device_name = device_combo.get_active_text ();
 784          vector<string> s;
 785
 786          {
 787                  PBD::Unwinder<uint32_t> protect_ignore_changes (ignore_changes, ignore_changes + 1);
 788
 789                  /* don't allow programmatic change to combos to cause a
 790                     recursive call to this method.
 791                  */
 792
 793                  /* sample rates */
 794
 795                  string desired;
 796
 797                  vector<float> sr;
 798
 799                  if (_have_control) {
 800                          sr = backend->available_sample_rates (device_name);
 801                  } else {
 802
 803                          sr.push_back (8000.0f);
 804                          sr.push_back (16000.0f);
 805                          sr.push_back (32000.0f);
 806                          sr.push_back (44100.0f);
 807                          sr.push_back (48000.0f);
 808                          sr.push_back (88200.0f);
 809                          sr.push_back (96000.0f);
 810                          sr.push_back (192000.0f);
 811                          sr.push_back (384000.0f);
 812                  }
 813
 814                  for (vector<float>::const_iterator x = sr.begin(); x != sr.end(); ++x) {
 815                          s.push_back (rate_as_string (*x));
 816                          if (*x == _desired_sample_rate) {
 817                                  desired = s.back();
 818                          }
 819                  }
 820
 821                  if (!s.empty()) {
 822                          sample_rate_combo.set_sensitive (true);
 823                          set_popdown_strings (sample_rate_combo, s);
 824
 825                          if (desired.empty()) {
 826                                  sample_rate_combo.set_active_text (rate_as_string (backend->default_sample_rate()));
 827                          } else {
 828                                  sample_rate_combo.set_active_text (desired);
 829                          }
 830
 831                  } else {
 832                          sample_rate_combo.set_sensitive (false);
 833                  }
 834
 835                  /* buffer sizes */
 836
 837                  vector<uint32_t> bs;
 838
 839                  if (_have_control) {
 840                          bs = backend->available_buffer_sizes(device_name);
 841                  } else if (backend->can_change_buffer_size_when_running()) {
 842                          bs.push_back (8);
 843                          bs.push_back (16);
 844                          bs.push_back (32);
 845                          bs.push_back (64);
 846                          bs.push_back (128);
 847                          bs.push_back (256);
 848                          bs.push_back (512);
 849                          bs.push_back (1024);
 850                          bs.push_back (2048);
 851                          bs.push_back (4096);
 852                          bs.push_back (8192);
 853                  }
 854                  s.clear ();
 855                  for (vector<uint32_t>::const_iterator x = bs.begin(); x != bs.end(); ++x) {
 856                          s.push_back (bufsize_as_string (*x));
 857                  }
 858
 859                  if (!s.empty()) {
 860                          buffer_size_combo.set_sensitive (true);
 861                          set_popdown_strings (buffer_size_combo, s);
 862
 863                          buffer_size_combo.set_active_text (bufsize_as_string (backend->default_buffer_size()));
 864                          show_buffer_duration ();
 865                  } else {
 866                          buffer_size_combo.set_sensitive (false);
 867                  }
 868
 869                  /* XXX theoretically need to set min + max channel counts here
 870                   */
 871
 872                  manage_control_app_sensitivity ();
 873          }
 874
 875          /* pick up any saved state for this device */
 876
 877          maybe_display_saved_state ();
 878  }
 879
 880  string
 881  EngineControl::bufsize_as_string (uint32_t sz)
 882  {
 883          /* Translators: "samples" is always plural here, so no
 884             need for plural+singular forms.
 885          */
 886          char buf[32];
 887          snprintf (buf, sizeof (buf), _("%u samples"), sz);
 888          return buf;
 889  }
 890
 891  void
 892  EngineControl::sample_rate_changed ()
 893  {
 894          if (ignore_changes) {
 895                  return;
 896          }
 897
 898          /* reset the strings for buffer size to show the correct msec value
 899             (reflecting the new sample rate).
 900          */
 901
 902          show_buffer_duration ();
 903          save_state ();
 904
 905  }
 906
 907  void
 908  EngineControl::buffer_size_changed ()
 909  {
 910          if (ignore_changes) {
 911                  return;
 912          }
 913
 914          show_buffer_duration ();
 915          save_state ();
 916  }
 917
 918  void
 919  EngineControl::show_buffer_duration ()
 920  {
 921
 922          /* buffer sizes  - convert from just samples to samples + msecs for
 923           * the displayed string
 924           */
 925
 926          string bs_text = buffer_size_combo.get_active_text ();
 927          uint32_t samples = atoi (bs_text); /* will ignore trailing text */
 928          uint32_t rate = get_rate();
 929
 930          /* Translators: "msecs" is ALWAYS plural here, so we do not
 931             need singular form as well.
 932          */
 933          /* Developers: note the hard-coding of a double buffered model
 934             in the (2 * samples) computation of latency. we always start
 935             the audiobackend in this configuration.
 936          */
 937          char buf[32];
 938          snprintf (buf, sizeof (buf), _("(%.1f msecs)"), (2 * samples) / (rate/1000.0));
 939          buffer_size_duration_label.set_text (buf);
 940  }
 941
 942  void
 943  EngineControl::midi_option_changed ()
 944  {
 945          if (!ignore_changes) {
 946                  save_state ();
 947          }
 948  }
 949
 950  void
 951  EngineControl::parameter_changed ()
 952  {
 953          if (!ignore_changes) {
 954                  save_state ();
 955          }
 956  }
 957
 958  EngineControl::State*
 959  EngineControl::get_matching_state (const string& backend,
 960                                     const string& driver,
 961                                     const string& device)
 962  {
 963          for (StateList::iterator i = states.begin(); i != states.end(); ++i) {
 964                  if ((*i).backend == backend &&
 965                      (*i).driver == driver &&
 966                      (*i).device == device) {
 967                          return &(*i);
 968                  }
 969          }
 970          return 0;
 971  }
 972
 973  EngineControl::State*
 974  EngineControl::get_saved_state_for_currently_displayed_backend_and_device ()
 975  {
 976          boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
 977
 978          if (backend) {
 979                  return get_matching_state (backend_combo.get_active_text(),
 980                                             (backend->requires_driver_selection() ? (std::string) driver_combo.get_active_text() : string()),
 981                                             device_combo.get_active_text());
 982          }
 983
 984
 985          return get_matching_state (backend_combo.get_active_text(),
 986                                     string(),
 987                                     device_combo.get_active_text());
 988  }
 989
 990  EngineControl::State*
 991  EngineControl::save_state ()
 992  {
 993          if (!_have_control) {
 994                  return 0;
 995          }
 996
 997          bool existing = true;
 998          State* state = get_saved_state_for_currently_displayed_backend_and_device ();
 999
1000          if (!state) {
1001                  existing = false;
1002                  state = new State;
1003          }
1004
1005          store_state (*state);
1006
1007          if (!existing) {
1008                  states.push_back (*state);
1009          }
1010
1011          return state;
1012  }
1013
1014  void
1015  EngineControl::store_state (State& state)
1016  {
1017          state.backend = get_backend ();
1018          state.driver = get_driver ();
1019          state.device = get_device_name ();
1020          state.sample_rate = get_rate ();
1021          state.buffer_size = get_buffer_size ();
1022          state.input_latency = get_input_latency ();
1023          state.output_latency = get_output_latency ();
1024          state.input_channels = get_input_channels ();
1025          state.output_channels = get_output_channels ();
1026          state.midi_option = get_midi_option ();
1027  }
1028
1029  void
1030  EngineControl::maybe_display_saved_state ()
1031  {
1032          if (!_have_control) {
1033                  return;
1034          }
1035
1036          State* state = get_saved_state_for_currently_displayed_backend_and_device ();
1037
1038          if (state) {
1039                  PBD::Unwinder<uint32_t> protect_ignore_changes (ignore_changes, ignore_changes + 1);
1040
1041                  if (!_desired_sample_rate) {
1042                          sample_rate_combo.set_active_text (rate_as_string (state->sample_rate));
1043                  }
1044                  buffer_size_combo.set_active_text (bufsize_as_string (state->buffer_size));
1045                  /* call this explicitly because we're ignoring changes to
1046                     the controls at this point.
1047                  */
1048                  show_buffer_duration ();
1049                  input_latency.set_value (state->input_latency);
1050                  output_latency.set_value (state->output_latency);
1051
1052                  if (!state->midi_option.empty()) {
1053                          midi_option_combo.set_active_text (state->midi_option);
1054                  }
1055          }
1056  }
1057
1058  XMLNode&
1059  EngineControl::get_state ()
1060  {
1061          XMLNode* root = new XMLNode ("AudioMIDISetup");
1062          std::string path;
1063
1064          if (!states.empty()) {
1065                  XMLNode* state_nodes = new XMLNode ("EngineStates");
1066
1067                  for (StateList::const_iterator i = states.begin(); i != states.end(); ++i) {
1068
1069                          XMLNode* node = new XMLNode ("State");
1070
1071                          node->add_property ("backend", (*i).backend);
1072                          node->add_property ("driver", (*i).driver);
1073                          node->add_property ("device", (*i).device);
1074                          node->add_property ("sample-rate", (*i).sample_rate);
1075                          node->add_property ("buffer-size", (*i).buffer_size);
1076                          node->add_property ("input-latency", (*i).input_latency);
1077                          node->add_property ("output-latency", (*i).output_latency);
1078                          node->add_property ("input-channels", (*i).input_channels);
1079                          node->add_property ("output-channels", (*i).output_channels);
1080                          node->add_property ("active", (*i).active ? "yes" : "no");
1081                          node->add_property ("midi-option", (*i).midi_option);
1082
1083                          state_nodes->add_child_nocopy (*node);
1084                  }
1085
1086                  root->add_child_nocopy (*state_nodes);
1087          }
1088
1089          return *root;
1090  }
1091
1092  void
1093  EngineControl::set_state (const XMLNode& root)
1094  {
1095          XMLNodeList          clist, cclist;
1096          XMLNodeConstIterator citer, cciter;
1097          XMLNode* child;
1098          XMLNode* grandchild;
1099          XMLProperty* prop = NULL;
1100
1101          if (root.name() != "AudioMIDISetup") {
1102                  return;
1103          }
1104
1105          clist = root.children();
1106
1107          states.clear ();
1108
1109          for (citer = clist.begin(); citer != clist.end(); ++citer) {
1110
1111                  child = *citer;
1112
1113                  if (child->name() != "EngineStates") {
1114                          continue;
1115                  }
1116
1117                  cclist = child->children();
1118
1119                  for (cciter = cclist.begin(); cciter != cclist.end(); ++cciter) {
1120                          State state;
1121
1122                          grandchild = *cciter;
1123
1124                          if (grandchild->name() != "State") {
1125                                  continue;
1126                          }
1127
1128                          if ((prop = grandchild->property ("backend")) == 0) {
1129                                  continue;
1130                          }
1131                          state.backend = prop->value ();
1132
1133                          if ((prop = grandchild->property ("driver")) == 0) {
1134                                  continue;
1135                          }
1136                          state.driver = prop->value ();
1137
1138                          if ((prop = grandchild->property ("device")) == 0) {
1139                                  continue;
1140                          }
1141                          state.device = prop->value ();
1142
1143                          if ((prop = grandchild->property ("sample-rate")) == 0) {
1144                                  continue;
1145                          }
1146                          state.sample_rate = atof (prop->value ());
1147
1148                          if ((prop = grandchild->property ("buffer-size")) == 0) {
1149                                  continue;
1150                          }
1151                          state.buffer_size = atoi (prop->value ());
1152
1153                          if ((prop = grandchild->property ("input-latency")) == 0) {
1154                                  continue;
1155                          }
1156                          state.input_latency = atoi (prop->value ());
1157
1158                          if ((prop = grandchild->property ("output-latency")) == 0) {
1159                                  continue;
1160                          }
1161                          state.output_latency = atoi (prop->value ());
1162
1163                          if ((prop = grandchild->property ("input-channels")) == 0) {
1164                                  continue;
1165                          }
1166                          state.input_channels = atoi (prop->value ());
1167
1168                          if ((prop = grandchild->property ("output-channels")) == 0) {
1169                                  continue;
1170                          }
1171                          state.output_channels = atoi (prop->value ());
1172
1173                          if ((prop = grandchild->property ("active")) == 0) {
1174                                  continue;
1175                          }
1176                          state.active = string_is_affirmative (prop->value ());
1177
1178                          if ((prop = grandchild->property ("midi-option")) == 0) {
1179                                  continue;
1180                          }
1181                          state.midi_option = prop->value ();
1182
1183                          states.push_back (state);
1184                  }
1185          }
1186
1187          /* now see if there was an active state and switch the setup to it */
1188
1189          for (StateList::const_iterator i = states.begin(); i != states.end(); ++i) {
1190
1191                  if ((*i).active) {
1192                          ignore_changes++;
1193                          backend_combo.set_active_text ((*i).backend);
1194                          driver_combo.set_active_text ((*i).driver);
1195                          device_combo.set_active_text ((*i).device);
1196                          sample_rate_combo.set_active_text (rate_as_string ((*i).sample_rate));
1197                          buffer_size_combo.set_active_text (bufsize_as_string ((*i).buffer_size));
1198                          input_latency.set_value ((*i).input_latency);
1199                          output_latency.set_value ((*i).output_latency);
1200                          midi_option_combo.set_active_text ((*i).midi_option);
1201                          ignore_changes--;
1202                          break;
1203                  }
1204          }
1205  }
1206
1207  int
1208  EngineControl::push_state_to_backend (bool start)
1209  {
1210          boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
1211
1212          if (!backend) {
1213                  return 0;
1214          }
1215
1216          /* figure out what is going to change */
1217
1218          bool restart_required = false;
1219          bool was_running = ARDOUR::AudioEngine::instance()->running();
1220          bool change_driver = false;
1221          bool change_device = false;
1222          bool change_rate = false;
1223          bool change_bufsize = false;
1224          bool change_latency = false;
1225          bool change_channels = false;
1226          bool change_midi = false;
1227
1228          uint32_t ochan = get_output_channels ();
1229          uint32_t ichan = get_input_channels ();
1230
1231          if (_have_control) {
1232
1233                  if (started_at_least_once) {
1234
1235                          /* we can control the backend */
1236
1237                          if (backend->requires_driver_selection()) {
1238                                  if (get_driver() != backend->driver_name()) {
1239                                          change_driver = true;
1240                                  }
1241                          }
1242
1243                          if (get_device_name() != backend->device_name()) {
1244                                  change_device = true;
1245                          }
1246
1247                          if (get_rate() != backend->sample_rate()) {
1248                                  change_rate = true;
1249                          }
1250
1251                          if (get_buffer_size() != backend->buffer_size()) {
1252                                  change_bufsize = true;
1253                          }
1254
1255                          if (get_midi_option() != backend->midi_option()) {
1256                                  change_midi = true;
1257                          }
1258
1259                          /* zero-requested channels means "all available" */
1260
1261                          if (ichan == 0) {
1262                                  ichan = backend->input_channels();
1263                          }
1264
1265                          if (ochan == 0) {
1266                                  ochan = backend->output_channels();
1267                          }
1268
1269                          if (ichan != backend->input_channels()) {
1270                                  change_channels = true;
1271                          }
1272
1273                          if (ochan != backend->output_channels()) {
1274                                  change_channels = true;
1275                          }
1276
1277                          if (get_input_latency() != backend->systemic_input_latency() ||
1278                              get_output_latency() != backend->systemic_output_latency()) {
1279                                  change_latency = true;
1280                          }
1281                  } else {
1282                          /* backend never started, so we have to force a group
1283                             of settings.
1284                          */
1285                          change_device = true;
1286                          if (backend->requires_driver_selection()) {
1287                                  change_driver = true;
1288                          }
1289                          change_rate = true;
1290                          change_bufsize = true;
1291                          change_channels = true;
1292                          change_latency = true;
1293                          change_midi = true;
1294                  }
1295
1296          } else {
1297
1298                  /* we have no control over the backend, meaning that we can
1299                   * only possibly change sample rate and buffer size.
1300                   */
1301
1302
1303                  if (get_rate() != backend->sample_rate()) {
1304                          change_bufsize = true;
1305                  }
1306
1307                  if (get_buffer_size() != backend->buffer_size()) {
1308                          change_bufsize = true;
1309                  }
1310          }
1311
1312          if (!_have_control) {
1313
1314                  /* We do not have control over the backend, so the best we can
1315                   * do is try to change the sample rate and/or bufsize and get
1316                   * out of here.
1317                   */
1318
1319                  if (change_rate && !backend->can_change_sample_rate_when_running()) {
1320                          return 1;
1321                  }
1322
1323                  if (change_bufsize && !backend->can_change_buffer_size_when_running()) {
1324                          return 1;
1325                  }
1326
1327                  if (change_rate) {
1328                          backend->set_sample_rate (get_rate());
1329                  }
1330
1331                  if (change_bufsize) {
1332                          backend->set_buffer_size (get_buffer_size());
1333                  }
1334
1335                  if (start) {
1336                          if (ARDOUR::AudioEngine::instance()->start ()) {
1337                                  error << string_compose (_("Could not start backend engine %1"), backend->name()) << endmsg;
1338                                  return -1;
1339                          }
1340                  }
1341
1342                  post_push ();
1343
1344                  return 0;
1345          }
1346
1347          /* determine if we need to stop the backend before changing parameters */
1348
1349          if (change_driver || change_device || change_channels || change_latency ||
1350              (change_rate && !backend->can_change_sample_rate_when_running()) ||
1351              change_midi ||
1352              (change_bufsize && !backend->can_change_buffer_size_when_running())) {
1353                  restart_required = true;
1354          } else {
1355                  restart_required = false;
1356          }
1357
1358          if (was_running) {
1359
1360                  if (!change_driver && !change_device && !change_channels && !change_latency && !change_midi) {
1361                          /* no changes in any parameters that absolutely require a
1362                           * restart, so check those that might be changeable without a
1363                           * restart
1364                           */
1365
1366                          if (change_rate && !backend->can_change_sample_rate_when_running()) {
1367                                  /* can't do this while running ... */
1368                                  restart_required = true;
1369                          }
1370
1371                          if (change_bufsize && !backend->can_change_buffer_size_when_running()) {
1372                                  /* can't do this while running ... */
1373                                  restart_required = true;
1374                          }
1375                  }
1376          }
1377
1378          if (was_running) {
1379                  if (restart_required) {
1380                          if (ARDOUR_UI::instance()->disconnect_from_engine ()) {
1381                                  return -1;
1382                          }
1383                  }
1384          }
1385
1386
1387          if (change_driver && backend->set_driver (get_driver())) {
1388                  error << string_compose (_("Cannot set driver to %1"), get_driver()) << endmsg;
1389                  return -1;
1390          }
1391          if (change_device && backend->set_device_name (get_device_name())) {
1392                  error << string_compose (_("Cannot set device name to %1"), get_device_name()) << endmsg;
1393                  return -1;
1394          }
1395          if (change_rate && backend->set_sample_rate (get_rate())) {
1396                  error << string_compose (_("Cannot set sample rate to %1"), get_rate()) << endmsg;
1397                  return -1;
1398          }
1399          if (change_bufsize && backend->set_buffer_size (get_buffer_size())) {
1400                  error << string_compose (_("Cannot set buffer size to %1"), get_buffer_size()) << endmsg;
1401                  return -1;
1402          }
1403
1404          if (change_channels || get_input_channels() == 0 || get_output_channels() == 0) {
1405                  if (backend->set_input_channels (get_input_channels())) {
1406                          error << string_compose (_("Cannot set input channels to %1"), get_input_channels()) << endmsg;
1407                          return -1;
1408                  }
1409                  if (backend->set_output_channels (get_output_channels())) {
1410                          error << string_compose (_("Cannot set output channels to %1"), get_output_channels()) << endmsg;
1411                          return -1;
1412                  }
1413          }
1414          if (change_latency) {
1415                  if (backend->set_systemic_input_latency (get_input_latency())) {
1416                          error << string_compose (_("Cannot set input latency to %1"), get_input_latency()) << endmsg;
1417                          return -1;
1418                  }
1419                  if (backend->set_systemic_output_latency (get_output_latency())) {
1420                          error << string_compose (_("Cannot set output latency to %1"), get_output_latency()) << endmsg;
1421                          return -1;
1422                  }
1423          }
1424
1425          if (change_midi) {
1426                  backend->set_midi_option (get_midi_option());
1427          }
1428
1429          if (start || (was_running && restart_required)) {
1430                  if (ARDOUR_UI::instance()->reconnect_to_engine()) {
1431                          return -1;
1432                  }
1433          }
1434
1435          post_push ();
1436
1437          return 0;
1438  }
1439
1440  void
1441  EngineControl::post_push ()
1442  {
1443          /* get a pointer to the current state object, creating one if
1444           * necessary
1445           */
1446
1447          if (_have_control) {
1448                  State* state = get_saved_state_for_currently_displayed_backend_and_device ();
1449
1450                  if (!state) {
1451                          state = save_state ();
1452                          assert (state);
1453                  }
1454
1455                  /* all off */
1456
1457                  for (StateList::iterator i = states.begin(); i != states.end(); ++i) {
1458                          (*i).active = false;
1459                  }
1460
1461                  /* mark this one active (to be used next time the dialog is
1462                   * shown)
1463                   */
1464
1465                  state->active = true;
1466
1467                  manage_control_app_sensitivity ();
1468          }
1469
1470          /* schedule a redisplay of MIDI ports */
1471
1472          Glib::signal_timeout().connect (sigc::bind_return (sigc::mem_fun (*this, &EngineControl::refresh_midi_display), false), 1000);
1473  }
1474
1475
1476  float
1477  EngineControl::get_rate () const
1478  {
1479          float r = atof (sample_rate_combo.get_active_text ());
1480          /* the string may have been translated with an abbreviation for
1481           * thousands, so use a crude heuristic to fix this.
1482           */
1483          if (r < 1000.0) {
1484                  r *= 1000.0;
1485          }
1486          return r;
1487  }
1488
1489
1490  uint32_t
1491  EngineControl::get_buffer_size () const
1492  {
1493          string txt = buffer_size_combo.get_active_text ();
1494          uint32_t samples;
1495
1496          if (sscanf (txt.c_str(), "%d", &samples) != 1) {
1497                  throw exception ();
1498          }
1499
1500          return samples;
1501  }
1502
1503  string
1504  EngineControl::get_midi_option () const
1505  {
1506          return midi_option_combo.get_active_text();
1507  }
1508
1509  uint32_t
1510  EngineControl::get_input_channels() const
1511  {
1512          return (uint32_t) input_channels_adjustment.get_value();
1513  }
1514
1515  uint32_t
1516  EngineControl::get_output_channels() const
1517  {
1518          return (uint32_t) output_channels_adjustment.get_value();
1519  }
1520
1521  uint32_t
1522  EngineControl::get_input_latency() const
1523  {
1524          return (uint32_t) input_latency_adjustment.get_value();
1525  }
1526
1527  uint32_t
1528  EngineControl::get_output_latency() const
1529  {
1530          return (uint32_t) output_latency_adjustment.get_value();
1531  }
1532
1533  string
1534  EngineControl::get_backend () const
1535  {
1536          return backend_combo.get_active_text ();
1537  }
1538
1539  string
1540  EngineControl::get_driver () const
1541  {
1542          return driver_combo.get_active_text ();
1543  }
1544
1545  string
1546  EngineControl::get_device_name () const
1547  {
1548          return device_combo.get_active_text ();
1549  }
1550
1551  void
1552  EngineControl::control_app_button_clicked ()
1553  {
1554          boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
1555
1556          if (!backend) {
1557                  return;
1558          }
1559
1560          backend->launch_control_app ();
1561  }
1562
1563  void
1564  EngineControl::manage_control_app_sensitivity ()
1565  {
1566          boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
1567
1568          if (!backend) {
1569                  return;
1570          }
1571
1572          string appname = backend->control_app_name();
1573
1574          if (appname.empty()) {
1575                  control_app_button.set_sensitive (false);
1576          } else {
1577                  control_app_button.set_sensitive (true);
1578          }
1579  }
1580
1581  void
1582  EngineControl::set_desired_sample_rate (uint32_t sr)
1583  {
1584          _desired_sample_rate = sr;
1585          device_changed ();
1586  }
1587
1588  void
1589  EngineControl::on_switch_page (GtkNotebookPage*, guint page_num)
1590  {
1591          if (page_num == 0) {
1592                  cancel_button->set_sensitive (true);
1593                  ok_button->set_sensitive (true);
1594                  apply_button->set_sensitive (true);
1595          } else {
1596                  cancel_button->set_sensitive (false);
1597                  ok_button->set_sensitive (false);
1598                  apply_button->set_sensitive (false);
1599          }
1600
1601          if (page_num == midi_tab) {
1602                  /* MIDI tab */
1603                  refresh_midi_display ();
1604          }
1605
1606          if (page_num == latency_tab) {
1607                  /* latency tab */
1608
1609                  if (!ARDOUR::AudioEngine::instance()->running()) {
1610
1611                          PBD::Unwinder<uint32_t> protect_ignore_changes (ignore_changes, ignore_changes + 1);
1612
1613                          /* save any existing latency values */
1614
1615                          uint32_t il = (uint32_t) input_latency.get_value ();
1616                          uint32_t ol = (uint32_t) input_latency.get_value ();
1617
1618                          /* reset to zero so that our new test instance
1619                             will be clean of any existing latency measures.
1620                          */
1621
1622                          input_latency.set_value (0);
1623                          output_latency.set_value (0);
1624
1625                          /* reset control */
1626
1627                          input_latency.set_value (il);
1628                          output_latency.set_value (ol);
1629
1630                  }
1631
1632                  if (ARDOUR::AudioEngine::instance()->prepare_for_latency_measurement()) {
1633                          disable_latency_tab ();
1634                  }
1635
1636                  enable_latency_tab ();
1637
1638          } else {
1639                  if (lm_running) {
1640                          ARDOUR::AudioEngine::instance()->stop_latency_detection();
1641                  }
1642          }
1643  }
1644
1645  /* latency measurement */
1646
1647  bool
1648  EngineControl::check_latency_measurement ()
1649  {
1650          MTDM* mtdm = ARDOUR::AudioEngine::instance()->mtdm ();
1651
1652          if (mtdm->resolve () < 0) {
1653                  lm_results.set_markup (string_compose (results_markup, _("No signal detected ")));
1654                  return true;
1655          }
1656
1657          if (mtdm->err () > 0.3) {
1658                  mtdm->invert ();
1659                  mtdm->resolve ();
1660          }
1661
1662          char buf[128];
1663          ARDOUR::framecnt_t const sample_rate = ARDOUR::AudioEngine::instance()->sample_rate();
1664
1665          if (sample_rate == 0) {
1666                  lm_results.set_markup (string_compose (results_markup, _("Disconnected from audio engine")));
1667                  ARDOUR::AudioEngine::instance()->stop_latency_detection ();
1668                  return false;
1669          }
1670
1671          uint32_t frames_total = mtdm->del();
1672          uint32_t extra = frames_total - ARDOUR::AudioEngine::instance()->latency_signal_delay();
1673
1674          snprintf (buf, sizeof (buf), "%u samples / %.3lf ms", extra, extra * 1000.0f/sample_rate);
1675
1676          bool solid = true;
1677
1678          if (mtdm->err () > 0.2) {
1679                  strcat (buf, " ");
1680                  strcat (buf, _("(signal detection error)"));
1681                  solid = false;
1682          }
1683
1684          if (mtdm->inv ()) {
1685                  strcat (buf, " ");
1686                  strcat (buf, _("(inverted - bad wiring)"));
1687                  solid = false;
1688          }
1689
1690          if (solid) {
1691                  end_latency_detection ();
1692                  lm_use_button.set_sensitive (true);
1693                  have_lm_results = true;
1694         }
1695
1696         lm_results.set_markup (string_compose (results_markup, string_compose (_("Detected roundtrip latency: %1"), buf)));
1697
1698         return true;
1699 }
1700
1701 void
1702 EngineControl::start_latency_detection ()
1703 {
1704         ARDOUR::AudioEngine::instance()->set_latency_input_port (lm_input_channel_combo.get_active_text());
1705         ARDOUR::AudioEngine::instance()->set_latency_output_port (lm_output_channel_combo.get_active_text());
1706
1707         if (ARDOUR::AudioEngine::instance()->start_latency_detection () == 0) {
1708                 lm_results.set_markup (string_compose (results_markup, _("Detecting ...")));
1709                 latency_timeout = Glib::signal_timeout().connect (mem_fun (*this, &EngineControl::check_latency_measurement), 100);
1710                 lm_measure_label.set_text (_("Cancel"));
1711                 have_lm_results = false;
1712                 lm_use_button.set_sensitive (false);
1713                 lm_input_channel_combo.set_sensitive (false);
1714                 lm_output_channel_combo.set_sensitive (false);
1715                 lm_running = true;
1716         }
1717 }
1718
1719 void
1720 EngineControl::end_latency_detection ()
1721 {
1722         latency_timeout.disconnect ();
1723         ARDOUR::AudioEngine::instance()->stop_latency_detection ();
1724         lm_measure_label.set_text (_("Measure"));
1725         if (!have_lm_results) {
1726                 lm_results.set_markup (string_compose (results_markup, _("No measurement results yet")));
1727         } else {
1728                 lm_use_button.set_sensitive (false);
1729         }
1730         lm_input_channel_combo.set_sensitive (true);
1731         lm_output_channel_combo.set_sensitive (true);
1732         lm_running = false;
1733 }
1734
1735 void
1736 EngineControl::latency_button_clicked ()
1737 {
1738         if (!lm_running) {
1739                 start_latency_detection ();
1740         } else {
1741                 end_latency_detection ();
1742         }
1743 }
1744
1745 void
1746 EngineControl::use_latency_button_clicked ()
1747 {
1748         MTDM* mtdm = ARDOUR::AudioEngine::instance()->mtdm ();
1749
1750         if (!mtdm) {
1751                 return;
1752         }
1753
1754         uint32_t frames_total = mtdm->del();
1755         uint32_t extra = frames_total - ARDOUR::AudioEngine::instance()->latency_signal_delay();
1756         uint32_t one_way = extra/2;
1757
1758         input_latency_adjustment.set_value (one_way);
1759         output_latency_adjustment.set_value (one_way);
1760
1761         /* back to settings page */
1762
1763         notebook.set_current_page (0);
1764 }
1765
1766 bool
1767 EngineControl::on_delete_event (GdkEventAny* ev)
1768 {
1769         if (notebook.get_current_page() == 2) {
1770                 /* currently on latency tab - be sure to clean up */
1771                 end_latency_detection ();
1772         }
1773         return ArdourDialog::on_delete_event (ev);
1774 }
1775
1776 void
1777 EngineControl::engine_running ()
1778 {
1779         boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
1780         assert (backend);
1781
1782         buffer_size_combo.set_active_text (bufsize_as_string (backend->buffer_size()));
1783         sample_rate_combo.set_active_text (rate_as_string (backend->sample_rate()));
1784
1785         buffer_size_combo.set_sensitive (true);
1786         sample_rate_combo.set_sensitive (true);
1787
1788         connect_disconnect_button.set_label (string_compose (_("Disconnect from %1"), backend->name()));
1789
1790         started_at_least_once = true;
1791 }
1792
1793 void
1794 EngineControl::engine_stopped ()
1795 {
1796         boost::shared_ptr<ARDOUR::AudioBackend> backend = ARDOUR::AudioEngine::instance()->current_backend();
1797         assert (backend);
1798
1799         buffer_size_combo.set_sensitive (false);
1800         connect_disconnect_button.set_label (string_compose (_("Connect to %1"), backend->name()));
1801
1802         sample_rate_combo.set_sensitive (true);
1803         buffer_size_combo.set_sensitive (true);
1804 }
1805
1806 void
1807 EngineControl::connect_disconnect_click()
1808 {
1809         if (ARDOUR::AudioEngine::instance()->running()) {
1810                 ARDOUR_UI::instance()->disconnect_from_engine ();
1811         } else {
1812                 ARDOUR_UI::instance()->reconnect_to_engine ();
1813         }
1814 }
1815
1816 void
1817 EngineControl::calibrate_latency ()
1818 {
1819         notebook.set_current_page (latency_tab);
1820 }
1821