gtk2_ardour/engine_dialog.h

   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 #ifndef __gtk2_ardour_engine_dialog_h__
  21 #define __gtk2_ardour_engine_dialog_h__
  22
  23 #include <map>
  24 #include <vector>
  25 #include <string>
  26
  27 #include <gtkmm/checkbutton.h>
  28 #include <gtkmm/spinbutton.h>
  29 #include <gtkmm/comboboxtext.h>
  30 #include <gtkmm/table.h>
  31 #include <gtkmm/expander.h>
  32 #include <gtkmm/box.h>
  33 #include <gtkmm/buttonbox.h>
  34 #include <gtkmm/button.h>
  35
  36 #include "pbd/signals.h"
  37
  38 #include "ardour_dialog.h"
  39 #include "ardour_button.h"
  40
  41 class EngineControl : public ArdourDialog, public PBD::ScopedConnectionList
  42 {
  43 public:
  44         EngineControl ();
  45         ~EngineControl ();
  46
  47         static bool need_setup ();
  48
  49         XMLNode& get_state ();
  50         bool set_state (const XMLNode&);
  51
  52         void set_desired_sample_rate (uint32_t);
  53         bool try_autostart ();
  54
  55 private:
  56         Gtk::Notebook notebook;
  57
  58         Gtk::Label engine_status;
  59
  60         /* core fields used by all backends */
  61
  62         Gtk::Table basic_packer;
  63         Gtk::HBox basic_hbox;
  64         Gtk::VBox basic_vbox;
  65
  66         Gtk::ComboBoxText backend_combo;
  67         Gtk::ComboBoxText driver_combo;
  68         Gtk::ComboBoxText device_combo;
  69         Gtk::ComboBoxText input_device_combo;
  70         Gtk::ComboBoxText output_device_combo;
  71         Gtk::ComboBoxText sample_rate_combo;
  72         Gtk::ComboBoxText midi_option_combo;
  73         Gtk::ComboBoxText buffer_size_combo;
  74         Gtk::Label        buffer_size_duration_label;
  75         Gtk::ComboBoxText nperiods_combo;
  76         Gtk::Adjustment input_latency_adjustment;
  77         Gtk::SpinButton input_latency;
  78         Gtk::Adjustment output_latency_adjustment;
  79         Gtk::SpinButton output_latency;
  80         Gtk::Adjustment input_channels_adjustment;
  81         Gtk::SpinButton input_channels;
  82         Gtk::Adjustment output_channels_adjustment;
  83         Gtk::SpinButton output_channels;
  84         Gtk::Adjustment ports_adjustment;
  85         Gtk::SpinButton ports_spinner;
  86
  87         Gtk::Label      have_control_text;
  88         ArdourButton    control_app_button;
  89         ArdourButton    midi_devices_button;
  90         ArdourButton    start_stop_button;
  91         ArdourButton    update_devices_button;
  92         ArdourButton    use_buffered_io_button;
  93
  94         Gtk::Button     connect_disconnect_button;
  95
  96         /* latency measurement */
  97
  98         Gtk::ComboBoxText lm_output_channel_combo;
  99         Gtk::ComboBoxText lm_input_channel_combo;
 100         Gtk::Label        lm_measure_label;
 101         Gtk::Button       lm_measure_button;
 102         Gtk::Button       lm_use_button;
 103         Gtk::Button       lm_back_button;
 104         ArdourButton      lm_button_audio;
 105         Gtk::Label        lm_title;
 106         Gtk::Label        lm_preamble;
 107         Gtk::Label        lm_results;
 108         Gtk::Table        lm_table;
 109         Gtk::VBox         lm_vbox;
 110         bool              have_lm_results;
 111         bool              lm_running;
 112
 113         /* MIDI Tab */
 114
 115         Gtk::VBox midi_vbox;
 116         Gtk::Button midi_back_button;
 117         Gtk::Table midi_device_table;
 118
 119         /* MIDI ... JACK */
 120
 121         Gtk::CheckButton aj_button;
 122
 123         uint32_t ignore_changes; // state save/load
 124         uint32_t ignore_device_changes; // AudioEngine::DeviceListChanged
 125         uint32_t _desired_sample_rate;
 126         bool     started_at_least_once;
 127         bool     queue_device_changed;
 128
 129         void driver_changed ();
 130         void backend_changed ();
 131         void sample_rate_changed ();
 132         void buffer_size_changed ();
 133         void nperiods_changed ();
 134         void parameter_changed ();
 135         void midi_option_changed ();
 136
 137         void setup_midi_tab_for_backend ();
 138         void setup_midi_tab_for_jack ();
 139         void refresh_midi_display (std::string focus = "");
 140
 141         void update_midi_options ();
 142
 143         std::string bufsize_as_string (uint32_t);
 144         std::string nperiods_as_string (uint32_t);
 145
 146         std::vector<float> get_default_sample_rates ();
 147         std::vector<uint32_t> get_default_buffer_sizes ();
 148
 149         std::vector<float> get_sample_rates_for_all_devices ();
 150         std::vector<uint32_t> get_buffer_sizes_for_all_devices ();
 151
 152         float get_rate() const;
 153         uint32_t get_buffer_size() const;
 154         uint32_t get_nperiods() const;
 155         uint32_t get_input_channels() const;
 156         uint32_t get_output_channels() const;
 157         uint32_t get_input_latency() const;
 158         uint32_t get_output_latency() const;
 159         std::string get_device_name() const;
 160         std::string get_input_device_name() const;
 161         std::string get_output_device_name() const;
 162         std::string get_driver() const;
 163         std::string get_backend() const;
 164         std::string get_midi_option () const;
 165         bool get_use_buffered_io () const;
 166
 167         std::string get_default_device (const std::string&,
 168                                         const std::vector<std::string>&);
 169
 170         void device_changed ();
 171         void input_device_changed ();
 172         void output_device_changed ();
 173         bool set_driver_popdown_strings ();
 174         bool set_device_popdown_strings ();
 175         bool set_input_device_popdown_strings ();
 176         bool set_output_device_popdown_strings ();
 177         void set_samplerate_popdown_strings ();
 178         void set_buffersize_popdown_strings ();
 179         void set_nperiods_popdown_strings ();
 180         void list_devices ();
 181         void show_buffer_duration ();
 182
 183         void configure_midi_devices ();
 184
 185         struct MidiDeviceSetting {
 186                 std::string name;
 187                 bool enabled;
 188                 uint32_t input_latency;
 189                 uint32_t output_latency;
 190
 191                 MidiDeviceSetting (std::string n, bool en = true, uint32_t inl = 0, uint32_t oul = 0)
 192                         : name (n)
 193                         , enabled (en)
 194                         , input_latency (inl)
 195                         , output_latency (oul)
 196                 {}
 197         };
 198
 199         typedef boost::shared_ptr<MidiDeviceSetting> MidiDeviceSettings;
 200         bool _can_set_midi_latencies;
 201         std::vector<MidiDeviceSettings> _midi_devices;
 202
 203         MidiDeviceSettings find_midi_device(std::string devicename) const {
 204                 for (std::vector<MidiDeviceSettings>::const_iterator p = _midi_devices.begin(); p != _midi_devices.end(); ++p) {
 205                         if ((*p)->name == devicename) {
 206                                 return *p;
 207                         }
 208                 }
 209                 return MidiDeviceSettings();
 210         }
 211
 212         struct StateStruct {
 213                 std::string backend;
 214                 std::string driver;
 215                 std::string device;
 216                 std::string input_device;
 217                 std::string output_device;
 218                 float sample_rate;
 219                 uint32_t buffer_size;
 220                 uint32_t n_periods;
 221                 uint32_t input_latency;
 222                 uint32_t output_latency;
 223                 uint32_t input_channels;
 224                 uint32_t output_channels;
 225                 bool active;
 226                 bool use_buffered_io;
 227                 std::string midi_option;
 228                 std::vector<MidiDeviceSettings> midi_devices;
 229                 time_t lru;
 230
 231                 StateStruct()
 232                         : sample_rate (48000)
 233                         , buffer_size (1024)
 234                         , input_latency (0)
 235                         , output_latency (0)
 236                         , input_channels (0)
 237                         , output_channels (0)
 238                         , active (false)
 239                         , use_buffered_io (false)
 240                         , lru (0)
 241                 {}
 242         };
 243
 244         typedef boost::shared_ptr<StateStruct> State;
 245         typedef std::list<State> StateList;
 246         static bool state_sort_cmp (const State &a, const State &b);
 247
 248         StateList states;
 249
 250         State get_matching_state (const std::string& backend);
 251         State get_matching_state (const std::string& backend,
 252                                   const std::string& driver,
 253                                   const std::string& device);
 254         State get_matching_state (const std::string& backend,
 255                                   const std::string& driver,
 256                                   const std::string& input_device,
 257                                   const std::string& output_device);
 258         State get_saved_state_for_currently_displayed_backend_and_device ();
 259         void maybe_display_saved_state ();
 260         State save_state ();
 261         void store_state (State);
 262         bool equivalent_states (const State&, const State&);
 263
 264         bool set_current_state (const State& state);
 265         void set_default_state ();
 266
 267         bool  _have_control;
 268
 269         static bool print_channel_count (Gtk::SpinButton*);
 270
 271         void build_notebook ();
 272         void build_full_control_notebook ();
 273         void build_no_control_notebook ();
 274
 275         void connect_changed_signals ();
 276         void block_changed_signals ();
 277         void unblock_changed_signals ();
 278
 279         class SignalBlocker
 280         {
 281         public:
 282                 SignalBlocker (EngineControl& engine_control, const std::string& reason);
 283
 284                 ~SignalBlocker ();
 285
 286         private:
 287                 EngineControl& ec;
 288                 std::string m_reason;
 289         };
 290
 291         uint32_t block_signals;
 292
 293         sigc::connection backend_combo_connection;
 294         sigc::connection driver_combo_connection;
 295         sigc::connection sample_rate_combo_connection;
 296         sigc::connection buffer_size_combo_connection;
 297         sigc::connection nperiods_combo_connection;
 298         sigc::connection device_combo_connection;
 299         sigc::connection input_device_combo_connection;
 300         sigc::connection output_device_combo_connection;
 301         sigc::connection midi_option_combo_connection;
 302         sigc::connection input_latency_connection;
 303         sigc::connection output_latency_connection;
 304         sigc::connection input_channels_connection;
 305         sigc::connection output_channels_connection;
 306
 307         void on_show ();
 308         void on_map ();
 309         void control_app_button_clicked ();
 310         void start_stop_button_clicked ();
 311         void update_devices_button_clicked ();
 312         void use_buffered_io_button_clicked ();
 313         void use_latency_button_clicked ();
 314         void manage_control_app_sensitivity ();
 315         int push_state_to_backend (bool start);
 316         void post_push ();
 317         void update_sensitivity ();
 318         bool start_engine ();
 319         bool stop_engine (bool for_latency = false);
 320
 321         /* latency measurement */
 322         void latency_button_clicked ();
 323         void latency_back_button_clicked ();
 324         bool check_audio_latency_measurement ();
 325         bool check_midi_latency_measurement ();
 326         sigc::connection latency_timeout;
 327         void enable_latency_tab ();
 328         void disable_latency_tab ();
 329         void start_latency_detection ();
 330         void end_latency_detection ();
 331
 332         void on_switch_page (GtkNotebookPage*, guint page_num);
 333         bool on_delete_event (GdkEventAny*);
 334
 335         void engine_running ();
 336         void engine_stopped ();
 337         void device_list_changed ();
 338
 339         PBD::ScopedConnection running_connection;
 340         PBD::ScopedConnectionList stopped_connection;
 341         PBD::ScopedConnection devicelist_connection;
 342
 343         void connect_disconnect_click ();
 344         void calibrate_audio_latency ();
 345         void calibrate_midi_latency (MidiDeviceSettings);
 346
 347         MidiDeviceSettings _measure_midi;
 348         void midi_latency_adjustment_changed(Gtk::Adjustment *, MidiDeviceSettings, bool);
 349         void midi_device_enabled_toggled(ArdourButton *, MidiDeviceSettings);
 350         sigc::connection lm_back_button_signal;
 351 };
 352
 353 #endif /* __gtk2_ardour_engine_dialog_h__ */