2 Copyright (C) 1999-2002 Paul Davis
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.
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.
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.
20 #ifndef __ardour_gui_h__
21 #define __ardour_gui_h__
23 /* need _BSD_SOURCE to get timersub macros */
37 #include <libgnomecanvasmm/canvas.h>
39 #include <pbd/xml++.h>
40 #include <gtkmm/box.h>
41 #include <gtkmm/frame.h>
42 #include <gtkmm/label.h>
43 #include <gtkmm/table.h>
44 #include <gtkmm/fixed.h>
45 #include <gtkmm/drawingarea.h>
46 #include <gtkmm/eventbox.h>
47 #include <gtkmm/menu.h>
48 #include <gtkmm/menuitem.h>
49 #include <gtkmm/button.h>
50 #include <gtkmm/togglebutton.h>
51 #include <gtkmm/treeview.h>
52 #include <gtkmm/menubar.h>
53 #include <gtkmm/textbuffer.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 <gtkmm2ext/bindable_button.h>
59 #include <ardour/ardour.h>
60 #include <ardour/session.h>
61 #include <ardour/configuration.h>
63 #include "audio_clock.h"
64 #include "ardour_dialog.h"
66 #include "ui_config.h"
74 class ConnectionEditor;
79 class NewSessionDialog;
93 class ControlProtocolInfo;
97 class MultiChannelDevice;
100 #define FRAME_NAME "BaseFrame"
102 extern sigc::signal<void> ColorsChanged;
103 extern sigc::signal<void> DPIReset;
105 class ARDOUR_UI : public Gtkmm2ext::UI
108 ARDOUR_UI (int *argcp, char **argvp[]);
112 bool shown() { return shown_flag; }
120 void idle_load (const Glib::ustring& path);
121 int load_session (const Glib::ustring& path, const Glib::ustring& snapshot, Glib::ustring mix_template = Glib::ustring());
123 int build_session (const Glib::ustring& path, const Glib::ustring& snapshot,
125 uint32_t master_chns,
126 ARDOUR::AutoConnectOption input_connect,
127 ARDOUR::AutoConnectOption output_connect,
130 nframes_t initial_length);
131 bool session_is_new() const { return _session_is_new; }
133 ARDOUR::Session* the_session() { return session; }
135 bool will_create_new_session_automatically() const {
136 return _will_create_new_session_automatically;
139 void set_will_create_new_session_automatically (bool yn) {
140 _will_create_new_session_automatically = yn;
143 bool get_session_parameters (bool have_engine = false, bool should_be_new = false);
144 void parse_cmdline_path (const Glib::ustring& cmdline_path, Glib::ustring& session_name, Glib::ustring& session_path, bool& existing_session);
145 int load_cmdline_session (const Glib::ustring& session_name, const Glib::ustring& session_path, bool& existing_session);
146 int build_session_from_nsd (const Glib::ustring& session_name, const Glib::ustring& session_path);
147 bool ask_about_loading_existing_session (const Glib::ustring& session_path);
149 /// @return true if session was successfully unloaded.
150 int unload_session (bool hide_stuff = false);
151 void close_session();
153 int save_state_canfail (string state_name = "");
154 void save_state (const string & state_name = "");
155 void restore_state (string state_name = "");
157 static double gain_to_slider_position (ARDOUR::gain_t g);
158 static ARDOUR::gain_t slider_position_to_gain (double pos);
160 static ARDOUR_UI *instance () { return theArdourUI; }
161 static UIConfiguration *config () { return ui_config; }
163 PublicEditor& the_editor(){return *editor;}
164 Mixer_UI* the_mixer() { return mixer; }
166 ARDOUR::AudioEngine& the_engine() const { return *engine; }
168 void toggle_key_editor ();
169 void toggle_location_window ();
170 void toggle_theme_manager ();
171 void toggle_bundle_manager ();
172 void toggle_big_clock_window ();
173 void toggle_connection_editor ();
174 void toggle_route_params_window ();
175 void toggle_editing_space();
177 Gtk::Tooltips& tooltips() { return _tooltips; }
179 static sigc::signal<void,bool> Blink;
180 static sigc::signal<void> RapidScreenUpdate;
181 static sigc::signal<void> SuperRapidScreenUpdate;
182 static sigc::signal<void,nframes_t, bool, nframes_t> Clock;
184 /* this is a helper function to centralize the (complex) logic for
185 blinking rec-enable buttons.
188 void rec_enable_button_blink (bool onoff, ARDOUR::AudioDiskstream *, Gtk::Widget *w);
190 void name_io_setup (ARDOUR::AudioEngine&, string&, ARDOUR::IO& io, bool in);
192 static gint hide_and_quit (GdkEventAny *ev, ArdourDialog *);
194 XMLNode* editor_settings() const;
195 XMLNode* mixer_settings () const;
196 XMLNode* keyboard_settings () const;
198 void save_ardour_state ();
199 gboolean configure_handler (GdkEventConfigure* conf);
201 void do_transport_locate (nframes_t position);
202 void halt_on_xrun_message ();
203 void xrun_handler (nframes_t);
204 void create_xrun_marker (nframes_t);
206 AudioClock primary_clock;
207 AudioClock secondary_clock;
208 AudioClock preroll_clock;
209 AudioClock postroll_clock;
211 void store_clock_modes ();
212 void restore_clock_modes ();
214 void add_route (Gtk::Window* float_window);
216 void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many) {
217 session_add_audio_route (true, input_channels, output_channels, mode, how_many);
220 void session_add_audio_bus (int input_channels, int32_t output_channels, uint32_t how_many) {
221 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, how_many);
224 void session_add_midi_track (uint32_t how_many) {
225 session_add_midi_route (true, how_many);
228 /*void session_add_midi_bus () {
229 session_add_midi_route (false);
232 int create_engine ();
235 gint exit_on_main_window_close (GdkEventAny *);
237 void maximise_editing_space ();
238 void restore_editing_space ();
240 void set_native_file_header_format (ARDOUR::HeaderFormat sf);
241 void set_native_file_data_format (ARDOUR::SampleFormat sf);
243 void setup_profile ();
246 void set_shuttle_fract (double);
249 friend class PublicEditor;
251 void toggle_clocking ();
252 void toggle_auto_play ();
253 void toggle_auto_input ();
254 void toggle_punch ();
255 void unset_dual_punch ();
256 bool ignore_dual_punch;
257 void toggle_punch_in ();
258 void toggle_punch_out ();
259 void toggle_auto_return ();
260 void toggle_click ();
262 void toggle_session_auto_loop ();
264 void toggle_options_window ();
267 struct GlobalClickBox : public Gtk::VBox {
268 Gtkmm2ext::ClickBox *box;
271 vector<string> &strings;
272 Gtk::Adjustment adjustment;
274 static void printer (char buf[32], Gtk::Adjustment &adj, void *arg);
276 GlobalClickBox (const string &str, vector<string> &vs)
278 adjustment (0, 0, vs.size() - 1, 1, 1, 0) {
279 box = new Gtkmm2ext::ClickBox (&adjustment, "ClickButton");
280 label.set_text (str);
281 label.set_name ("GlobalButtonLabel");
283 frame.set_shadow_type (Gtk::SHADOW_IN);
286 box->set_print_func (printer, this);
287 box->set_wrap (true);
291 ARDOUR::AudioEngine *engine;
292 ARDOUR::Session *session;
294 Gtk::Tooltips _tooltips;
296 void goto_editor_window ();
297 void goto_mixer_window ();
299 Gtk::Table adjuster_table;
300 Gtk::Frame adjuster_frame;
301 Gtk::Fixed adjuster_base;
303 GlobalClickBox *online_control_button;
304 vector<string> online_control_strings;
306 GlobalClickBox *crossfade_time_button;
307 vector<string> crossfade_time_strings;
309 Gtk::ToggleButton preroll_button;
310 Gtk::ToggleButton postroll_button;
312 Gtk::Table transport_table;
313 Gtk::Table option_table;
315 int setup_windows ();
316 void setup_transport ();
319 static ARDOUR_UI *theArdourUI;
321 void backend_audio_error (bool we_set_params, Gtk::Window* toplevel = 0);
326 int ask_about_saving_session (const string & why);
327 int save_the_session;
329 /* periodic safety backup, to be precise */
330 gint autosave_session();
331 void update_autosave();
332 sigc::connection _autosave_connection;
334 void queue_transport_change ();
335 void map_transport_state ();
336 int32_t do_engine_start ();
338 void engine_halted ();
339 void engine_stopped ();
340 void engine_running ();
344 static gint _blink (void *);
346 gint blink_timeout_tag;
348 void start_blinking ();
349 void stop_blinking ();
351 void about_signal_response(int response);
354 Gtk::VBox top_packer;
356 sigc::connection clock_signal_connection;
357 void update_clocks ();
358 void start_clocking ();
359 void stop_clocking ();
361 void manage_window (Gtk::Window&);
363 AudioClock big_clock;
364 Gtk::Frame big_clock_frame;
365 Gtk::Window* big_clock_window;
367 void update_transport_clocks (nframes_t pos);
368 void record_state_changed ();
370 /* Transport Control */
372 void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
373 void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
375 Gtkmm2ext::TearOff* transport_tearoff;
376 Gtk::Frame transport_frame;
377 Gtk::HBox transport_tearoff_hbox;
378 Gtk::HBox transport_hbox;
379 Gtk::Fixed transport_base;
380 Gtk::Fixed transport_button_base;
381 Gtk::Frame transport_button_frame;
382 Gtk::HBox transport_button_hbox;
383 Gtk::VBox transport_button_vbox;
384 Gtk::HBox transport_option_button_hbox;
385 Gtk::VBox transport_option_button_vbox;
386 Gtk::HBox transport_clock_hbox;
387 Gtk::VBox transport_clock_vbox;
388 Gtk::HBox primary_clock_hbox;
389 Gtk::HBox secondary_clock_hbox;
392 struct TransportControllable : public PBD::Controllable {
405 TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
406 void set_value (float);
407 float get_value (void) const;
409 void set_id (const std::string&);
415 TransportControllable roll_controllable;
416 TransportControllable stop_controllable;
417 TransportControllable goto_start_controllable;
418 TransportControllable goto_end_controllable;
419 TransportControllable auto_loop_controllable;
420 TransportControllable play_selection_controllable;
421 TransportControllable rec_controllable;
422 TransportControllable shuttle_controllable;
423 BindingProxy shuttle_controller_binding_proxy;
425 void set_transport_controllable_state (const XMLNode&);
426 XMLNode& get_transport_controllable_state ();
428 BindableButton roll_button;
429 BindableButton stop_button;
430 BindableButton goto_start_button;
431 BindableButton goto_end_button;
432 BindableButton auto_loop_button;
433 BindableButton play_selection_button;
434 BindableButton rec_button;
436 Gtk::ComboBoxText sync_option_combo;
438 void sync_option_changed ();
439 void toggle_time_master ();
440 void toggle_video_sync ();
442 Gtk::DrawingArea shuttle_box;
443 Gtk::EventBox speed_display_box;
444 Gtk::Label speed_display_label;
445 Gtk::Button shuttle_units_button;
446 Gtk::ComboBoxText shuttle_style_button;
447 Gtk::Menu* shuttle_unit_menu;
448 Gtk::Menu* shuttle_style_menu;
449 float shuttle_max_speed;
450 Gtk::Menu* shuttle_context_menu;
452 void build_shuttle_context_menu ();
453 void show_shuttle_context_menu ();
454 void shuttle_style_changed();
455 void shuttle_unit_clicked ();
456 void set_shuttle_max_speed (float);
457 void update_speed_display ();
458 float last_speed_displayed;
460 gint shuttle_box_button_press (GdkEventButton*);
461 gint shuttle_box_button_release (GdkEventButton*);
462 gint shuttle_box_scroll (GdkEventScroll*);
463 gint shuttle_box_motion (GdkEventMotion*);
464 gint shuttle_box_expose (GdkEventExpose*);
465 gint mouse_shuttle (double x, bool force);
466 void use_shuttle_fract (bool force);
468 bool shuttle_grabbed;
469 double shuttle_fract;
471 Gtkmm2ext::StatefulToggleButton punch_in_button;
472 Gtkmm2ext::StatefulToggleButton punch_out_button;
473 Gtkmm2ext::StatefulToggleButton auto_return_button;
474 Gtkmm2ext::StatefulToggleButton auto_play_button;
475 Gtkmm2ext::StatefulToggleButton auto_input_button;
476 Gtkmm2ext::StatefulToggleButton click_button;
477 Gtkmm2ext::StatefulToggleButton time_master_button;
479 Gtk::ToggleButton auditioning_alert_button;
480 Gtk::ToggleButton solo_alert_button;
482 Gtk::ToggleButton midi_panic_button;
486 void solo_blink (bool);
487 void audition_blink (bool);
489 void soloing_changed (bool);
490 void auditioning_changed (bool);
491 void _auditioning_changed (bool);
493 void solo_alert_toggle ();
494 void audition_alert_toggle ();
495 void midi_panic_toggle ();
497 void big_clock_value_changed ();
498 void primary_clock_value_changed ();
499 void secondary_clock_value_changed ();
501 /* called by Blink signal */
503 void transport_rec_enable_blink (bool onoff);
505 Gtk::Menu* session_popup_menu;
507 struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
508 RecentSessionModelColumns() {
512 Gtk::TreeModelColumn<Glib::ustring> visible_name;
513 Gtk::TreeModelColumn<Glib::ustring> fullpath;
516 RecentSessionModelColumns recent_session_columns;
517 Gtk::TreeView recent_session_display;
518 Glib::RefPtr<Gtk::TreeStore> recent_session_model;
520 ArdourDialog* session_selector_window;
521 Gtk::FileChooserDialog* open_session_selector;
523 void build_session_selector();
524 void redisplay_recent_sessions();
525 void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
527 struct RecentSessionsSorter {
528 bool operator() (std::pair<string,string> a, std::pair<string,string> b) const {
529 return cmp_nocase(a.first, b.first) == -1;
533 /* menu bar and associated stuff */
535 Gtk::MenuBar* menu_bar;
536 Gtk::EventBox menu_bar_base;
539 void use_menubar_as_top_menubar ();
540 void build_menu_bar ();
541 void build_control_surface_menu ();
543 Gtk::Label wall_clock_label;
544 Gtk::EventBox wall_clock_box;
545 gint update_wall_clock ();
547 Gtk::Label disk_space_label;
548 Gtk::EventBox disk_space_box;
549 void update_disk_space ();
551 Gtk::Label cpu_load_label;
552 Gtk::EventBox cpu_load_box;
553 void update_cpu_load ();
555 Gtk::Label buffer_load_label;
556 Gtk::EventBox buffer_load_box;
557 void update_buffer_load ();
559 Gtk::Label sample_rate_label;
560 Gtk::EventBox sample_rate_box;
561 void update_sample_rate (nframes_t);
563 gint every_second ();
564 gint every_point_one_seconds ();
565 gint every_point_zero_one_seconds ();
567 sigc::connection second_connection;
568 sigc::connection point_one_second_connection;
569 sigc::connection point_oh_five_second_connection;
570 sigc::connection point_zero_one_second_connection;
572 gint session_menu (GdkEventButton *);
574 bool _will_create_new_session_automatically;
576 NewSessionDialog* new_session_dialog;
578 void open_session ();
579 void open_recent_session ();
580 void save_template ();
582 void session_add_audio_route (bool disk, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many);
583 void session_add_midi_route (bool disk, uint32_t how_many);
585 void set_transport_sensitivity (bool);
587 void remove_last_capture ();
589 void transport_goto_zero ();
590 void transport_goto_start ();
591 void transport_goto_end ();
592 void transport_stop ();
593 void transport_stop_and_forget_capture ();
594 void transport_record (bool roll);
595 void transport_roll ();
596 void transport_play_selection();
597 void transport_forward (int option);
598 void transport_rewind (int option);
599 void transport_loop ();
601 void transport_rolling ();
602 void transport_rewinding ();
603 void transport_forwarding ();
604 void transport_stopped ();
606 bool _session_is_new;
607 void connect_to_session (ARDOUR::Session *);
608 void connect_dependents_to_session (ARDOUR::Session *);
609 void we_have_dependents ();
611 void setup_session_options ();
613 guint32 last_key_press_time;
615 void snapshot_session ();
620 PublicEditor *editor;
621 int create_editor ();
623 RouteParams_UI *route_params;
624 int create_route_params ();
626 BundleManager *bundle_manager;
627 void create_bundle_manager ();
629 ConnectionEditor *connection_editor;
630 int create_connection_editor ();
632 LocationUI *location_ui;
633 int create_location_ui ();
634 void handle_locations_change (ARDOUR::Location*);
636 static UIConfiguration *ui_config;
637 ThemeManager *theme_manager;
639 /* Key bindings editor */
641 KeyEditor *key_editor;
645 OptionEditor *option_editor;
649 AddRouteDialog *add_route_dialog;
651 /* Keyboard Handling */
655 /* Keymap handling */
657 void install_actions ();
659 void toggle_record_enable (uint32_t);
661 uint32_t rec_enabled_streams;
662 void count_recenabled_streams (ARDOUR::Route&);
666 void pop_back_splash ();
671 Gtk::MenuItem *cleanup_item;
673 void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const string & msg);
677 bool have_configure_timeout;
678 struct timeval last_configure_time;
679 gint configure_timeout ();
681 struct timeval last_peak_grab;
682 struct timeval last_shuttle_request;
684 bool have_disk_speed_dialog_displayed;
685 void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
686 void disk_overrun_handler ();
687 void disk_underrun_handler ();
689 void session_dialog (std::string);
690 int pending_state_dialog ();
691 int sr_mismatch_dialog (nframes_t, nframes_t);
693 void disconnect_from_jack ();
694 void reconnect_to_jack ();
695 void set_jack_buffer_size (nframes_t);
697 Gtk::MenuItem* jack_disconnect_item;
698 Gtk::MenuItem* jack_reconnect_item;
699 Gtk::Menu* jack_bufsize_menu;
701 int make_session_clean ();
702 bool filter_ardour_session_dirs (const Gtk::FileFilter::Info&);
704 Glib::RefPtr<Gtk::ActionGroup> common_actions;
706 void editor_realized ();
708 std::vector<std::string> positional_sync_strings;
710 void toggle_send_midi_feedback ();
711 void toggle_use_mmc ();
712 void toggle_send_mmc ();
713 void toggle_send_mtc ();
715 void toggle_use_osc ();
717 void toggle_denormal_protection ();
719 void set_input_auto_connect (ARDOUR::AutoConnectOption);
720 void set_output_auto_connect (ARDOUR::AutoConnectOption);
721 void set_solo_model (ARDOUR::SoloModel);
722 void set_monitor_model (ARDOUR::MonitorModel);
723 void set_remote_model (ARDOUR::RemoteModel);
724 void set_denormal_model (ARDOUR::DenormalModel);
726 void toggle_sync_order_keys ();
727 void toggle_StopPluginsWithTransport();
728 void toggle_DoNotRunPluginsWhileRecording();
729 void toggle_VerifyRemoveLastCapture();
730 void toggle_PeriodicSafetyBackups();
731 void toggle_StopRecordingOnXrun();
732 void toggle_CreateXrunMarker();
733 void toggle_StopTransportAtEndOfSession();
734 void toggle_GainReduceFastTransport();
735 void toggle_LatchedSolo();
736 void toggle_ShowSoloMutes();
737 void toggle_LatchedRecordEnable ();
738 void toggle_RegionEquivalentsOverlap ();
739 void toggle_PrimaryClockDeltaEditCursor ();
740 void toggle_SecondaryClockDeltaEditCursor ();
741 void toggle_ShowTrackMeters ();
742 void toggle_only_copy_imported_files ();
743 void toggle_use_narrow_ms();
744 void toggle_rubberbanding_snaps_to_grid ();
745 void toggle_auto_analyse_audio ();
746 void toggle_TapeMachineMode();
748 void mtc_port_changed ();
749 void map_solo_model ();
750 void map_monitor_model ();
751 void map_denormal_model ();
752 void map_denormal_protection ();
753 void map_remote_model ();
754 void map_file_header_format ();
755 void map_file_data_format ();
756 void map_input_auto_connect ();
757 void map_output_auto_connect ();
758 void map_only_copy_imported_files ();
759 void parameter_changed (const char*);
761 void set_meter_hold (ARDOUR::MeterHold);
762 void set_meter_falloff (ARDOUR::MeterFalloff);
763 void map_meter_hold ();
764 void map_meter_falloff ();
766 void toggle_control_protocol (ARDOUR::ControlProtocolInfo*);
767 void toggle_control_protocol_feedback (ARDOUR::ControlProtocolInfo*, const char* group_name, std::string action_name);
771 void no_memory_warning ();
772 void check_memory_locking ();
774 bool check_audioengine();
775 void audioengine_setup ();
777 void display_message (const char *prefix, gint prefix_len,
778 Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag, const char *msg);
779 Gtk::Label status_bar_label;
780 Gtk::ToggleButton error_log_button;
782 void loading_message (const std::string& msg);
783 void end_loading_messages ();
785 void platform_specific ();
786 void platform_setup ();
787 void fontconfig_dialog ();
790 #endif /* __ardour_gui_h__ */