gtk2_ardour/ardour_ui.h

   1 /*
   2     Copyright (C) 1999-2002 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     $Id$
  19 */
  20
  21 #ifndef __ardour_gui_h__
  22 #define __ardour_gui_h__
  23
  24 /* need _BSD_SOURCE to get timersub macros */
  25
  26 #ifdef _BSD_SOURCE
  27 #include <sys/time.h>
  28 #else
  29 #define _BSD_SOURCE
  30 #include <sys/time.h>
  31 #undef _BSD_SOURCE
  32 #endif
  33
  34 #include <list>
  35
  36 #include <cmath>
  37
  38 #include <libgnomecanvasmm/canvas.h>
  39
  40 #include <pbd/xml++.h>
  41 #include <gtkmm/box.h>
  42 #include <gtkmm/frame.h>
  43 #include <gtkmm/label.h>
  44 #include <gtkmm/table.h>
  45 #include <gtkmm/fixed.h>
  46 #include <gtkmm/drawingarea.h>
  47 #include <gtkmm/eventbox.h>
  48 #include <gtkmm/menu.h>
  49 #include <gtkmm/menuitem.h>
  50 #include <gtkmm/button.h>
  51 #include <gtkmm/togglebutton.h>
  52 #include <gtkmm/treeview.h>
  53 #include <gtkmm/menubar.h>
  54 #include <gtkmm/adjustment.h>
  55 #include <gtkmm2ext/gtk_ui.h>
  56 #include <gtkmm2ext/click_box.h>
  57 #include <gtkmm2ext/stateful_button.h>
  58 #include <ardour/ardour.h>
  59 #include <ardour/session.h>
  60
  61 #include "audio_clock.h"
  62 #include "ardour_dialog.h"
  63 #include "editing.h"
  64
  65 class AudioClock;
  66 class PublicEditor;
  67 class Keyboard;
  68 class MeterBridge;
  69 class OptionEditor;
  70 class Mixer_UI;
  71 class ConnectionEditor;
  72 class RouteParams_UI;
  73 class SoundFileBrowser;
  74 class About;
  75 class AddRouteDialog;
  76 class NewSessionDialog;
  77 class LocationUI;
  78 class ColorManager;
  79
  80 namespace Gtkmm2ext {
  81         class TearOff;
  82 }
  83
  84 namespace ARDOUR {
  85         class AudioEngine;
  86         class Route;
  87         class Port;
  88         class IO;
  89         class ControlProtocolInfo;
  90 }
  91
  92 namespace ALSA {
  93         class MultiChannelDevice;
  94 }
  95
  96 #define FRAME_NAME "BaseFrame"
  97
  98 class ARDOUR_UI : public Gtkmm2ext::UI
  99 {
 100   public:
 101         ARDOUR_UI (int *argcp, char **argvp[], string rcfile);
 102         ~ARDOUR_UI();
 103
 104         void show ();
 105         bool shown() { return shown_flag; }
 106
 107         void show_splash ();
 108         void hide_splash ();
 109
 110         int load_session (const string & path, const string & snapshot, string* mix_template = 0);
 111         bool session_loaded;
 112         int build_session (const string & path, const string & snapshot,
 113                            uint32_t ctl_chns,
 114                            uint32_t master_chns,
 115                            ARDOUR::AutoConnectOption input_connect,
 116                            ARDOUR::AutoConnectOption output_connect,
 117                            uint32_t nphysin,
 118                            uint32_t nphysout,
 119                            nframes_t initial_length);
 120         bool session_is_new() const { return _session_is_new; }
 121
 122         ARDOUR::Session* the_session() { return session; }
 123
 124         bool will_create_new_session_automatically() const {
 125                 return _will_create_new_session_automatically;
 126         }
 127
 128         void set_will_create_new_session_automatically (bool yn) {
 129                 _will_create_new_session_automatically = yn;
 130         }
 131
 132         void new_session(bool startup = false, std::string path = string());
 133         gint cmdline_new_session (string path);
 134         int  unload_session ();
 135         void close_session();
 136
 137         int  save_state_canfail (string state_name = "");
 138         void save_state (const string & state_name = "");
 139         void restore_state (string state_name = "");
 140
 141         static double gain_to_slider_position (ARDOUR::gain_t g);
 142         static ARDOUR::gain_t slider_position_to_gain (double pos);
 143
 144         static ARDOUR_UI *instance () { return theArdourUI; }
 145
 146         PublicEditor&     the_editor(){return *editor;}
 147         Mixer_UI* the_mixer() { return mixer; }
 148
 149         void toggle_location_window ();
 150         void toggle_color_manager ();
 151         void toggle_big_clock_window ();
 152         void toggle_connection_editor ();
 153         void toggle_route_params_window ();
 154         void toggle_editing_space();
 155
 156         Gtk::Tooltips& tooltips() { return _tooltips; }
 157
 158         static sigc::signal<void,bool> Blink;
 159         static sigc::signal<void>      RapidScreenUpdate;
 160         static sigc::signal<void>      SuperRapidScreenUpdate;
 161         static sigc::signal<void,nframes_t> Clock;
 162
 163         /* this is a helper function to centralize the (complex) logic for
 164            blinking rec-enable buttons.
 165         */
 166
 167         void rec_enable_button_blink (bool onoff, ARDOUR::AudioDiskstream *, Gtk::Widget *w);
 168
 169         void name_io_setup (ARDOUR::AudioEngine&, string&, ARDOUR::IO& io, bool in);
 170
 171         static gint hide_and_quit (GdkEventAny *ev, ArdourDialog *);
 172
 173         XMLNode* editor_settings() const;
 174         XMLNode* mixer_settings () const;
 175         XMLNode* keyboard_settings () const;
 176
 177         void save_ardour_state ();
 178         gboolean configure_handler (GdkEventConfigure* conf);
 179
 180         void do_transport_locate (nframes_t position);
 181         void halt_on_xrun_message ();
 182
 183         AudioClock primary_clock;
 184         AudioClock secondary_clock;
 185         AudioClock preroll_clock;
 186         AudioClock postroll_clock;
 187
 188         void add_route ();
 189
 190         void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many) {
 191                 session_add_audio_route (true, input_channels, output_channels, mode, how_many);
 192         }
 193
 194         void session_add_audio_bus (int input_channels, int32_t output_channels, uint32_t how_many) {
 195                 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, how_many);
 196         }
 197
 198         void session_add_midi_track (uint32_t how_many) {
 199                 session_add_midi_route (true, how_many);
 200         }
 201
 202         /*void session_add_midi_bus () {
 203                 session_add_midi_route (false);
 204         }*/
 205
 206         void set_engine (ARDOUR::AudioEngine&);
 207
 208         gint exit_on_main_window_close (GdkEventAny *);
 209
 210         void maximise_editing_space ();
 211         void restore_editing_space ();
 212
 213         void set_native_file_header_format (ARDOUR::HeaderFormat sf);
 214         void set_native_file_data_format (ARDOUR::SampleFormat sf);
 215
 216   protected:
 217         friend class PublicEditor;
 218
 219         void toggle_clocking ();
 220         void toggle_auto_play ();
 221         void toggle_auto_input ();
 222         void toggle_punch_in ();
 223         void toggle_punch_out ();
 224         void toggle_auto_return ();
 225         void toggle_click ();
 226
 227         void toggle_session_auto_loop ();
 228
 229         void toggle_options_window ();
 230
 231   private:
 232         struct GlobalClickBox : public Gtk::VBox {
 233             Gtkmm2ext::ClickBox  *box;
 234             Gtk::Frame      frame;
 235             Gtk::Label      label;
 236             vector<string> &strings;
 237             Gtk::Adjustment adjustment;
 238
 239             static void printer (char buf[32], Gtk::Adjustment &adj, void *arg);
 240
 241             GlobalClickBox (const string &str, vector<string> &vs)
 242                     : strings (vs),
 243                       adjustment (0, 0, vs.size() - 1, 1, 1, 0) {
 244                     box = new Gtkmm2ext::ClickBox (&adjustment, "ClickButton");
 245                     label.set_text (str);
 246                     label.set_name ("GlobalButtonLabel");
 247                     frame.add (*box);
 248                     frame.set_shadow_type (Gtk::SHADOW_IN);
 249                     pack_start (label);
 250                     pack_start (frame);
 251                     box->set_print_func (printer, this);
 252                     box->set_wrap (true);
 253             };
 254         };
 255
 256         ARDOUR::AudioEngine                 *engine;
 257         ARDOUR::Session                     *session;
 258
 259         Gtk::Tooltips          _tooltips;
 260
 261         void                     goto_editor_window ();
 262         void                     goto_mixer_window ();
 263
 264         Gtk::Table               adjuster_table;
 265         Gtk::Frame               adjuster_frame;
 266         Gtk::Fixed               adjuster_base;
 267
 268         GlobalClickBox     *online_control_button;
 269         vector<string>      online_control_strings;
 270
 271         GlobalClickBox    *crossfade_time_button;
 272         vector<string>     crossfade_time_strings;
 273
 274         GlobalClickBox    *mmc_id_button;
 275         vector<string>     mmc_id_strings;
 276
 277         Gtk::ToggleButton   preroll_button;
 278         Gtk::ToggleButton   postroll_button;
 279
 280         Gtk::Table          transport_table;
 281         Gtk::Table          option_table;
 282
 283         int  setup_windows ();
 284         void setup_transport ();
 285         void setup_clock ();
 286         void setup_adjustables ();
 287
 288         static ARDOUR_UI *theArdourUI;
 289
 290         void startup ();
 291         void shutdown ();
 292
 293         void finish();
 294         int  ask_about_saving_session (const string & why);
 295         int  save_the_session;
 296
 297         void queue_transport_change ();
 298         void map_transport_state ();
 299         int32_t do_engine_start ();
 300         gint start_engine ();
 301
 302         void engine_halted ();
 303         void engine_stopped ();
 304         void engine_running ();
 305
 306         void use_config ();
 307
 308         static gint _blink  (void *);
 309         void blink ();
 310         gint blink_timeout_tag;
 311         bool blink_on;
 312         void start_blinking ();
 313         void stop_blinking ();
 314
 315         void control_methods_adjusted ();
 316         void mmc_device_id_adjusted ();
 317
 318         void about_signal_response(int response);
 319
 320   private:
 321         Gtk::VBox     top_packer;
 322
 323         sigc::connection clock_signal_connection;
 324         void         update_clocks ();
 325         void         start_clocking ();
 326         void         stop_clocking ();
 327
 328         void manage_window (Gtk::Window&);
 329
 330         AudioClock   big_clock;
 331         Gtk::Frame   big_clock_frame;
 332         Gtk::Window* big_clock_window;
 333
 334         /* Transport Control */
 335
 336         void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
 337         void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
 338
 339         Gtkmm2ext::TearOff*      transport_tearoff;
 340         Gtk::Frame               transport_frame;
 341         Gtk::HBox                transport_tearoff_hbox;
 342         Gtk::HBox                transport_hbox;
 343         Gtk::Fixed               transport_base;
 344         Gtk::Fixed               transport_button_base;
 345         Gtk::Frame               transport_button_frame;
 346         Gtk::HBox                transport_button_hbox;
 347         Gtk::VBox                transport_button_vbox;
 348         Gtk::HBox                transport_option_button_hbox;
 349         Gtk::VBox                transport_option_button_vbox;
 350         Gtk::HBox                transport_clock_hbox;
 351         Gtk::VBox                transport_clock_vbox;
 352         Gtk::HBox                primary_clock_hbox;
 353         Gtk::HBox                secondary_clock_hbox;
 354
 355         Gtkmm2ext::StatefulButton roll_button;
 356         Gtkmm2ext::StatefulButton stop_button;
 357         Gtkmm2ext::StatefulButton rewind_button;
 358         Gtkmm2ext::StatefulButton forward_button;
 359         Gtkmm2ext::StatefulButton goto_start_button;
 360         Gtkmm2ext::StatefulButton goto_end_button;
 361         Gtkmm2ext::StatefulButton auto_loop_button;
 362         Gtkmm2ext::StatefulButton play_selection_button;
 363
 364         Gtkmm2ext::StatefulButton rec_button;
 365
 366         Gtk::ToggleButton time_master_button;
 367         Gtk::ComboBoxText sync_option_combo;
 368
 369         void sync_option_changed ();
 370         void toggle_time_master ();
 371         void toggle_video_sync ();
 372
 373         Gtk::DrawingArea  shuttle_box;
 374         Gtk::EventBox     speed_display_box;
 375         Gtk::Label        speed_display_label;
 376         Gtk::Button       shuttle_units_button;
 377         Gtk::ComboBoxText shuttle_style_button;
 378         Gtk::Menu*        shuttle_unit_menu;
 379         Gtk::Menu*        shuttle_style_menu;
 380         float             shuttle_max_speed;
 381         Gtk::Menu*        shuttle_context_menu;
 382
 383         void build_shuttle_context_menu ();
 384         void show_shuttle_context_menu ();
 385         void shuttle_style_changed();
 386         void shuttle_unit_clicked ();
 387         void set_shuttle_max_speed (float);
 388         void update_speed_display ();
 389         float last_speed_displayed;
 390
 391         gint shuttle_box_button_press (GdkEventButton*);
 392         gint shuttle_box_button_release (GdkEventButton*);
 393         gint shuttle_box_scroll (GdkEventScroll*);
 394         gint shuttle_box_motion (GdkEventMotion*);
 395         gint shuttle_box_expose (GdkEventExpose*);
 396         gint mouse_shuttle (double x, bool force);
 397         void use_shuttle_fract (bool force);
 398
 399         bool   shuttle_grabbed;
 400         double shuttle_fract;
 401
 402         Gtk::ToggleButton punch_in_button;
 403         Gtk::ToggleButton punch_out_button;
 404         Gtk::ToggleButton auto_return_button;
 405         Gtk::ToggleButton auto_play_button;
 406         Gtk::ToggleButton auto_input_button;
 407         Gtk::ToggleButton click_button;
 408         Gtk::ToggleButton auditioning_alert_button;
 409         Gtk::ToggleButton solo_alert_button;
 410
 411         Gtk::VBox alert_box;
 412
 413         void solo_blink (bool);
 414         void audition_blink (bool);
 415
 416         void soloing_changed (bool);
 417         void auditioning_changed (bool);
 418         void _auditioning_changed (bool);
 419
 420         void solo_alert_toggle ();
 421         void audition_alert_toggle ();
 422
 423         void primary_clock_value_changed ();
 424         void secondary_clock_value_changed ();
 425
 426         /* called by Blink signal */
 427
 428         void transport_rec_enable_blink (bool onoff);
 429
 430         /* These change where we accept control from:
 431            MMC, X (local) or both.
 432         */
 433
 434         void allow_mmc_only ();
 435         void allow_mmc_and_local ();
 436         void allow_local_only ();
 437
 438         Gtk::Menu*        session_popup_menu;
 439
 440         struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
 441             RecentSessionModelColumns() {
 442                     add (visible_name);
 443                     add (fullpath);
 444             }
 445             Gtk::TreeModelColumn<Glib::ustring> visible_name;
 446             Gtk::TreeModelColumn<Glib::ustring> fullpath;
 447         };
 448
 449         RecentSessionModelColumns    recent_session_columns;
 450         Gtk::TreeView                recent_session_display;
 451         Glib::RefPtr<Gtk::TreeStore> recent_session_model;
 452
 453         ArdourDialog*     session_selector_window;
 454         Gtk::FileChooserDialog* open_session_selector;
 455
 456         void build_session_selector();
 457         void redisplay_recent_sessions();
 458         void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
 459
 460         struct RecentSessionsSorter {
 461             bool operator() (std::pair<string,string> a, std::pair<string,string> b) const {
 462                     return cmp_nocase(a.first, b.first) == -1;
 463             }
 464         };
 465
 466         /* menu bar and associated stuff */
 467
 468         Gtk::MenuBar* menu_bar;
 469         Gtk::EventBox menu_bar_base;
 470         Gtk::HBox     menu_hbox;
 471
 472         void build_menu_bar ();
 473         void build_control_surface_menu ();
 474
 475         Gtk::Label   wall_clock_label;
 476         Gtk::EventBox wall_clock_box;
 477         gint update_wall_clock ();
 478
 479         Gtk::Label   disk_space_label;
 480         Gtk::EventBox disk_space_box;
 481         void update_disk_space ();
 482
 483         Gtk::Label   cpu_load_label;
 484         Gtk::EventBox cpu_load_box;
 485         void update_cpu_load ();
 486
 487         Gtk::Label   buffer_load_label;
 488         Gtk::EventBox buffer_load_box;
 489         void update_buffer_load ();
 490
 491         Gtk::Label   sample_rate_label;
 492         Gtk::EventBox sample_rate_box;
 493         void update_sample_rate (nframes_t);
 494
 495         gint every_second ();
 496         gint every_point_one_seconds ();
 497         gint every_point_zero_one_seconds ();
 498
 499         sigc::connection second_connection;
 500         sigc::connection point_one_second_connection;
 501         sigc::connection point_zero_one_second_connection;
 502
 503         gint session_menu (GdkEventButton *);
 504
 505         bool _will_create_new_session_automatically;
 506
 507         NewSessionDialog* new_session_dialog;
 508
 509         void open_session ();
 510         void open_recent_session ();
 511         void save_template ();
 512
 513         void session_add_audio_route (bool disk, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many);
 514         void session_add_midi_route (bool disk, uint32_t how_many);
 515
 516         void set_transport_sensitivity (bool);
 517
 518         void remove_last_capture ();
 519
 520         void transport_goto_zero ();
 521         void transport_goto_start ();
 522         void transport_goto_end ();
 523         void transport_stop ();
 524         void transport_stop_and_forget_capture ();
 525         void transport_record ();
 526         void transport_roll ();
 527         void transport_play_selection();
 528         void transport_forward (int option);
 529         void transport_rewind (int option);
 530         void transport_loop ();
 531
 532         void transport_rolling ();
 533         void transport_rewinding ();
 534         void transport_forwarding ();
 535         void transport_stopped ();
 536
 537         bool _session_is_new;
 538         void connect_to_session (ARDOUR::Session *);
 539         void connect_dependents_to_session (ARDOUR::Session *);
 540         void we_have_dependents ();
 541         void setup_keybindings ();
 542         void setup_session_options ();
 543
 544         guint32  last_key_press_time;
 545
 546         void snapshot_session ();
 547
 548         Mixer_UI   *mixer;
 549         int         create_mixer ();
 550
 551         PublicEditor     *editor;
 552         int         create_editor ();
 553
 554         RouteParams_UI *route_params;
 555         int             create_route_params ();
 556
 557         ConnectionEditor *connection_editor;
 558         int               create_connection_editor ();
 559
 560         LocationUI *location_ui;
 561         int         create_location_ui ();
 562         void        handle_locations_change (ARDOUR::Location*);
 563
 564         ColorManager* color_manager;
 565
 566         /* Options window */
 567
 568         OptionEditor *option_editor;
 569
 570         /* route dialog */
 571
 572         AddRouteDialog *add_route_dialog;
 573
 574         /* SoundFile Browser */
 575         SoundFileBrowser *sfdb;
 576         void toggle_sound_file_browser ();
 577         int create_sound_file_browser ();
 578
 579         /* Keyboard Handling */
 580
 581         Keyboard* keyboard;
 582
 583         /* Keymap handling */
 584
 585         void install_actions ();
 586         void start_keyboard_prefix();
 587
 588         void toggle_record_enable (uint32_t);
 589
 590         uint32_t rec_enabled_streams;
 591         void count_recenabled_streams (ARDOUR::Route&);
 592
 593         About* about;
 594         bool shown_flag;
 595         /* cleanup */
 596
 597         Gtk::MenuItem *cleanup_item;
 598
 599         void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const string & msg);
 600         void cleanup ();
 601         void flush_trash ();
 602
 603         bool have_configure_timeout;
 604         struct timeval last_configure_time;
 605         gint configure_timeout ();
 606
 607         struct timeval last_peak_grab;
 608         struct timeval last_shuttle_request;
 609
 610         bool have_disk_overrun_displayed;
 611         bool have_disk_underrun_displayed;
 612
 613         void disk_overrun_message_gone ();
 614         void disk_underrun_message_gone ();
 615         void disk_overrun_handler ();
 616         void disk_underrun_handler ();
 617
 618         int pending_state_dialog ();
 619
 620         void disconnect_from_jack ();
 621         void reconnect_to_jack ();
 622         void set_jack_buffer_size (nframes_t);
 623
 624         Gtk::MenuItem* jack_disconnect_item;
 625         Gtk::MenuItem* jack_reconnect_item;
 626         Gtk::Menu*     jack_bufsize_menu;
 627
 628         int make_session_clean ();
 629         bool filter_ardour_session_dirs (const Gtk::FileFilter::Info&);
 630
 631         Glib::RefPtr<Gtk::ActionGroup> common_actions;
 632
 633         void editor_realized ();
 634
 635         std::vector<std::string> positional_sync_strings;
 636
 637         void toggle_send_midi_feedback ();
 638         void toggle_use_mmc ();
 639         void toggle_send_mmc ();
 640         void toggle_use_midi_control();
 641         void toggle_send_mtc ();
 642
 643         void set_input_auto_connect (ARDOUR::AutoConnectOption);
 644         void set_output_auto_connect (ARDOUR::AutoConnectOption);
 645         void set_solo_model (ARDOUR::SoloModel);
 646         void set_monitor_model (ARDOUR::MonitorModel);
 647
 648         void toggle_StopPluginsWithTransport();
 649         void toggle_DoNotRunPluginsWhileRecording();
 650         void toggle_VerifyRemoveLastCapture();
 651         void toggle_StopRecordingOnXrun();
 652         void toggle_StopTransportAtEndOfSession();
 653         void toggle_GainReduceFastTransport();
 654         void toggle_LatchedSolo();
 655         void toggle_LatchedRecordEnable ();
 656
 657         void mtc_port_changed ();
 658         void map_solo_model ();
 659         void map_monitor_model ();
 660         void map_file_header_format ();
 661         void map_file_data_format ();
 662         void map_input_auto_connect ();
 663         void map_output_auto_connect ();
 664         void parameter_changed (const char*);
 665
 666         void set_meter_hold (ARDOUR::MeterHold);
 667         void set_meter_falloff (ARDOUR::MeterFalloff);
 668         void map_meter_hold ();
 669         void map_meter_falloff ();
 670
 671         void toggle_control_protocol (ARDOUR::ControlProtocolInfo*);
 672         void toggle_control_protocol_feedback (ARDOUR::ControlProtocolInfo*, const char* group_name, const char* action_name);
 673 };
 674
 675 #endif /* __ardour_gui_h__ */
 676