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__
25 /* need _BSD_SOURCE to get timersub macros */
39 #include "pbd/xml++.h"
40 #include "pbd/controllable.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/textbuffer.h>
55 #include <gtkmm/adjustment.h>
57 #include "gtkmm2ext/gtk_ui.h"
58 #include "gtkmm2ext/click_box.h"
59 #include "gtkmm2ext/stateful_button.h"
60 #include "gtkmm2ext/bindable_button.h"
61 #include "gtkmm2ext/bindings.h"
63 #include "ardour/ardour.h"
64 #include "ardour/types.h"
65 #include "ardour/utils.h"
66 #include "ardour/plugin.h"
67 #include "ardour/session_handle.h"
68 #include "ardour/system_exec.h"
70 #include "video_timeline.h"
72 #include "add_route_dialog.h"
73 #include "ardour_button.h"
74 #include "ardour_dialog.h"
75 #include "ardour_window.h"
78 #include "visibility_group.h"
79 #include "window_manager.h"
83 #include "add_video_dialog.h"
84 #include "big_clock_window.h"
85 #include "bundle_manager.h"
86 #include "engine_dialog.h"
87 #include "export_video_dialog.h"
88 #include "global_port_matrix.h"
89 #include "keyeditor.h"
90 #include "location_ui.h"
91 #include "rc_option_editor.h"
92 #include "route_params_ui.h"
93 #include "session_option_editor.h"
94 #include "speaker_dialog.h"
102 class ExportVideoDialog;
104 class LocationUIWindow;
105 class RCOptionEditor;
106 class RouteParams_UI;
107 class SessionOptionEditor;
109 class GlobalPortMatrixWindow;
113 class ArdourKeyboard;
116 class ConnectionEditor;
117 class DuplicateRouteDialog;
120 class ArdourPrompter;
124 class SessionOptionEditor;
125 class ShuttleControl;
131 class LevelMeterHBox;
132 class GUIObjectState;
135 class ControlProtocolInfo;
148 class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
151 ARDOUR_UI (int *argcp, char **argvp[], const char* localedir);
154 bool run_startup (bool should_be_new, std::string load_template);
160 void launch_manual ();
161 void launch_reference ();
162 void launch_tracker ();
163 void launch_subscribe ();
164 void launch_cheat_sheet ();
165 void launch_website ();
166 void launch_website_dev ();
167 void launch_forums ();
168 void launch_howto_report ();
172 void load_from_application_api (const std::string& path);
175 int load_session (const std::string& path, const std::string& snapshot, std::string mix_template = std::string());
177 int build_session (const std::string& path, const std::string& snapshot, ARDOUR::BusProfile&);
178 bool session_is_new() const { return _session_is_new; }
180 ARDOUR::Session* the_session() { return _session; }
182 bool get_smart_mode () const;
184 int get_session_parameters (bool quit_on_cancel, bool should_be_new = false, std::string load_template = "");
185 int build_session_from_dialog (SessionDialog&, const std::string& session_name, const std::string& session_path);
186 bool ask_about_loading_existing_session (const std::string& session_path);
188 /// @return true if session was successfully unloaded.
189 int unload_session (bool hide_stuff = false);
190 void close_session();
192 int save_state_canfail (std::string state_name = "", bool switch_to_it = false);
193 void save_state (const std::string & state_name = "", bool switch_to_it = false);
195 static ARDOUR_UI *instance () { return theArdourUI; }
197 PublicEditor& the_editor() { return *editor;}
198 Mixer_UI* the_mixer() { return mixer; }
200 void new_midi_tracer_window ();
201 void toggle_editing_space();
202 void toggle_mixer_space();
203 void toggle_mixer_list();
204 void toggle_monitor_section_visibility ();
205 void toggle_keep_tearoffs();
207 static PublicEditor* _instance;
209 /** Emitted frequently with the audible frame, false, and the edit point as
210 * parameters respectively.
212 * (either RapidScreenUpdate || SuperRapidScreenUpdate - user-config)
214 static sigc::signal<void, framepos_t, bool, framepos_t> Clock;
216 static void close_all_dialogs () { CloseAllDialogs(); }
217 static sigc::signal<void> CloseAllDialogs;
219 XMLNode* main_window_settings() const;
220 XMLNode* editor_settings() const;
221 XMLNode* mixer_settings () const;
222 XMLNode* keyboard_settings () const;
223 XMLNode* tearoff_settings (const char*) const;
225 void save_ardour_state ();
226 gboolean configure_handler (GdkEventConfigure* conf);
228 void halt_on_xrun_message ();
229 void xrun_handler (framepos_t);
230 void create_xrun_marker (framepos_t);
232 GUIObjectState* gui_object_state;
234 MainClock* primary_clock;
235 MainClock* secondary_clock;
236 void focus_on_clock ();
237 AudioClock* big_clock;
239 TimeInfoBox* time_info_box;
241 VideoTimeLine *video_timeline;
243 void store_clock_modes ();
244 void restore_clock_modes ();
245 void reset_main_clocks ();
247 void synchronize_sync_source_and_video_pullup ();
249 void add_route (Gtk::Window* float_window);
250 void add_routes_part_two ();
251 void add_routes_thread ();
253 void start_duplicate_routes ();
255 void add_video (Gtk::Window* float_window);
256 void remove_video ();
257 void start_video_server_menu (Gtk::Window* float_window);
258 bool start_video_server (Gtk::Window* float_window, bool popup_msg);
259 void stop_video_server (bool ask_confirm=false);
260 void flush_videotimeline_cache (bool localcacheonly=false);
261 void export_video (bool range = false);
263 void session_add_audio_track (
265 int32_t output_channels,
266 ARDOUR::TrackMode mode,
267 ARDOUR::RouteGroup* route_group,
269 std::string const & name_template
272 session_add_audio_route (true, input_channels, output_channels, mode, route_group, how_many, name_template);
275 void session_add_audio_bus (int input_channels, int32_t output_channels, ARDOUR::RouteGroup* route_group,
276 uint32_t how_many, std::string const & name_template) {
277 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, route_group, how_many, name_template);
280 void session_add_midi_track (ARDOUR::RouteGroup* route_group, uint32_t how_many, std::string const & name_template,
281 ARDOUR::PluginInfoPtr instrument) {
282 session_add_midi_route (true, route_group, how_many, name_template, instrument);
285 void session_add_mixed_track (const ARDOUR::ChanCount& input, const ARDOUR::ChanCount& output, ARDOUR::RouteGroup* route_group, uint32_t how_many, std::string const & name_template,
286 ARDOUR::PluginInfoPtr instrument);
288 /*void session_add_midi_bus () {
289 session_add_midi_route (false);
292 void attach_to_engine ();
295 gint exit_on_main_window_close (GdkEventAny *);
297 void maximise_editing_space ();
298 void restore_editing_space ();
300 void show_ui_prefs ();
302 bool check_audioengine(Gtk::Window&);
304 void setup_profile ();
305 void setup_tooltips ();
307 void set_shuttle_fract (double);
309 void get_process_buffers ();
310 void drop_process_buffers ();
312 void reset_peak_display ();
313 void reset_route_peak_display (ARDOUR::Route*);
314 void reset_group_peak_display (ARDOUR::RouteGroup*);
316 const std::string& announce_string() const { return _announce_string; }
318 void hide_application ();
320 Gtk::Notebook& tabs();
321 Gtk::Window& main_window () { return _main_window; }
323 void setup_toplevel_window (Gtk::Window&, const std::string& name, void* owner);
325 /* called from a static C function */
327 GtkNotebook* tab_window_root_drop (GtkNotebook* src,
333 bool tabbed_window_state_event_handler (GdkEventWindowState*, void* object);
334 bool key_event_handler (GdkEventKey*, Gtk::Window* window);
336 Gtkmm2ext::ActionMap global_actions;
339 friend class PublicEditor;
341 void toggle_auto_play ();
342 void toggle_auto_input ();
343 void toggle_punch ();
344 void unset_dual_punch ();
345 bool ignore_dual_punch;
346 void toggle_punch_in ();
347 void toggle_punch_out ();
348 void show_loop_punch_ruler_and_disallow_hide ();
349 void reenable_hide_loop_punch_ruler_if_appropriate ();
350 void toggle_auto_return ();
351 void toggle_click ();
352 void toggle_audio_midi_setup ();
353 void toggle_session_auto_loop ();
354 void toggle_rc_options_window ();
355 void toggle_session_options_window ();
358 Gtk::Window _main_window;
359 Gtk::VBox main_vpacker;
360 Gtk::HBox status_bar_hpacker;
362 PublicEditor* editor;
364 Gtk::Tooltips _tooltips;
368 bool _initial_verbose_plugin_scan;
369 bool first_time_engine_run;
371 bool tabs_button_event (GdkEventButton* ev);
373 void show_tabbable (Gtkmm2ext::Tabbable*);
374 void hide_tabbable (Gtkmm2ext::Tabbable*);
375 void detach_tabbable (Gtkmm2ext::Tabbable*);
376 void attach_tabbable (Gtkmm2ext::Tabbable*);
378 void tabbable_state_change (Gtkmm2ext::Tabbable&);
380 void toggle_meterbridge ();
382 int setup_windows ();
383 void setup_transport ();
386 static ARDOUR_UI *theArdourUI;
387 SessionDialog *_session_dialog;
391 int ask_about_saving_session (const std::vector<std::string>& actions);
393 void save_session_at_its_request (std::string);
394 /* periodic safety backup, to be precise */
395 gint autosave_session();
396 void update_autosave();
397 sigc::connection _autosave_connection;
399 void session_dirty_changed ();
400 void update_title ();
402 void map_transport_state ();
403 int32_t do_engine_start ();
405 void engine_halted (const char* reason, bool free_reason);
406 void engine_stopped ();
407 void engine_running ();
411 void about_signal_response(int response);
413 Gtk::VBox top_packer;
415 sigc::connection clock_signal_connection;
416 void update_clocks ();
417 void start_clocking ();
418 void stop_clocking ();
420 void update_transport_clocks (framepos_t pos);
421 void record_state_changed ();
423 std::list<MidiTracer*> _midi_tracer_windows;
425 /* Transport Control */
427 Gtk::Frame transport_frame;
428 Gtk::HBox transport_hbox;
429 Gtk::Fixed transport_base;
430 Gtk::Fixed transport_button_base;
431 Gtk::Frame transport_button_frame;
432 Gtk::HBox transport_button_hbox;
433 Gtk::VBox transport_button_vbox;
434 Gtk::HBox transport_option_button_hbox;
435 Gtk::VBox transport_option_button_vbox;
436 Gtk::HBox transport_clock_hbox;
437 Gtk::VBox transport_clock_vbox;
438 Gtk::HBox primary_clock_hbox;
439 Gtk::HBox secondary_clock_hbox;
441 struct TransportControllable : public PBD::Controllable {
452 TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
453 void set_value (double, PBD::Controllable::GroupControlDisposition group_override);
454 double get_value (void) const;
460 boost::shared_ptr<TransportControllable> roll_controllable;
461 boost::shared_ptr<TransportControllable> stop_controllable;
462 boost::shared_ptr<TransportControllable> goto_start_controllable;
463 boost::shared_ptr<TransportControllable> goto_end_controllable;
464 boost::shared_ptr<TransportControllable> auto_loop_controllable;
465 boost::shared_ptr<TransportControllable> play_selection_controllable;
466 boost::shared_ptr<TransportControllable> rec_controllable;
468 void toggle_follow_edits ();
470 void set_transport_controllable_state (const XMLNode&);
471 XMLNode& get_transport_controllable_state ();
473 ArdourButton roll_button;
474 ArdourButton stop_button;
475 ArdourButton goto_start_button;
476 ArdourButton goto_end_button;
477 ArdourButton auto_loop_button;
478 ArdourButton play_selection_button;
479 ArdourButton rec_button;
481 void toggle_external_sync ();
482 void toggle_time_master ();
483 void toggle_video_sync ();
485 ShuttleControl* shuttle_box;
487 ArdourButton auto_return_button;
488 ArdourButton follow_edits_button;
489 ArdourButton auto_input_button;
490 ArdourButton click_button;
491 ArdourButton sync_button;
493 ArdourButton auditioning_alert_button;
494 ArdourButton solo_alert_button;
495 ArdourButton feedback_alert_button;
496 ArdourButton error_alert_button;
500 LevelMeterHBox * editor_meter;
501 float editor_meter_max_peak;
502 ArdourButton editor_meter_peak_display;
503 bool editor_meter_peak_button_release (GdkEventButton*);
505 void blink_handler (bool);
506 sigc::connection blink_connection;
509 void solo_blink (bool);
510 void sync_blink (bool);
511 void audition_blink (bool);
512 void feedback_blink (bool);
513 void error_blink (bool);
515 void set_flat_buttons();
517 void soloing_changed (bool);
518 void auditioning_changed (bool);
519 void _auditioning_changed (bool);
521 bool solo_alert_press (GdkEventButton* ev);
522 bool audition_alert_press (GdkEventButton* ev);
523 bool feedback_alert_press (GdkEventButton *);
524 bool error_alert_press (GdkEventButton *);
526 void big_clock_value_changed ();
527 void primary_clock_value_changed ();
528 void secondary_clock_value_changed ();
530 /* called by Blink signal */
532 void transport_rec_enable_blink (bool onoff);
534 Gtk::Menu* session_popup_menu;
536 /* menu bar and associated stuff */
538 Gtk::MenuBar* menu_bar;
539 Gtk::EventBox menu_bar_base;
542 void use_menubar_as_top_menubar ();
543 void build_menu_bar ();
545 Gtk::Label wall_clock_label;
546 gint update_wall_clock ();
548 Gtk::Label disk_space_label;
549 void update_disk_space ();
551 Gtk::Label timecode_format_label;
552 void update_timecode_format ();
554 Gtk::Label cpu_load_label;
555 void update_cpu_load ();
557 Gtk::Label xrun_label;
558 void update_xrun_count ();
560 Gtk::Label peak_thread_work_label;
561 void update_peak_thread_work ();
563 Gtk::Label buffer_load_label;
564 void update_buffer_load ();
566 Gtk::Label sample_rate_label;
567 void update_sample_rate (ARDOUR::framecnt_t);
569 Gtk::Label format_label;
570 void update_format ();
572 void every_second ();
573 void every_point_one_seconds ();
574 void every_point_zero_something_seconds ();
576 sigc::connection second_connection;
577 sigc::connection point_one_second_connection;
578 sigc::connection point_zero_something_second_connection;
579 sigc::connection fps_connection;
581 void set_fps_timeout_connection ();
583 void open_session ();
584 void open_recent_session ();
585 bool process_save_template_prompter (ArdourPrompter& prompter);
586 void save_template ();
588 void edit_metadata ();
589 void import_metadata ();
591 void session_add_audio_route (bool, int32_t, int32_t, ARDOUR::TrackMode, ARDOUR::RouteGroup *, uint32_t, std::string const &);
592 void session_add_midi_route (bool, ARDOUR::RouteGroup *, uint32_t, std::string const &, ARDOUR::PluginInfoPtr);
594 void set_transport_sensitivity (bool);
596 //stuff for ProTools-style numpad
597 void transport_numpad_event (int num);
598 void transport_numpad_decimal ();
599 bool _numpad_locate_happening;
600 int _pending_locate_num;
601 gint transport_numpad_timeout ();
602 sigc::connection _numpad_timeout_connection;
604 void transport_goto_nth_marker (int nth);
605 void transport_goto_zero ();
606 void transport_goto_start ();
607 void transport_goto_end ();
608 void transport_goto_wallclock ();
609 void transport_stop ();
610 void transport_record (bool roll);
611 void transport_roll ();
612 void transport_play_selection();
613 void transport_play_preroll();
614 void transport_forward (int option);
615 void transport_rewind (int option);
616 void transport_loop ();
617 void toggle_roll (bool with_abort, bool roll_out_of_bounded_mode);
618 bool trx_record_enable_all_tracks ();
620 bool _session_is_new;
621 void set_session (ARDOUR::Session *);
622 void connect_dependents_to_session (ARDOUR::Session *);
623 void we_have_dependents ();
625 void setup_session_options ();
627 guint32 last_key_press_time;
629 bool process_snapshot_session_prompter (ArdourPrompter& prompter, bool switch_to_it);
630 void snapshot_session (bool switch_to_it);
632 void quick_snapshot_session (bool switch_to_it); //does not promtp for name, just makes a timestamped file
634 SaveAsDialog* save_as_dialog;
636 bool save_as_progress_update (float fraction, int64_t cnt, int64_t total, Gtk::Label* label, Gtk::ProgressBar* bar);
637 void save_session_as ();
638 void rename_session ();
639 void setup_order_hint (AddRouteDialog::InsertAt);
642 int create_editor ();
644 Meterbridge *meterbridge;
645 int create_meterbridge ();
647 /* Dialogs that can be created via new<T> */
649 RCOptionEditor* rc_option_editor;
650 Gtk::HBox rc_option_editor_placeholder;
652 WM::Proxy<SpeakerDialog> speaker_config_window;
653 WM::Proxy<AddRouteDialog> add_route_dialog;
654 WM::Proxy<About> about;
655 WM::Proxy<LocationUIWindow> location_ui;
656 WM::Proxy<RouteParams_UI> route_params;
657 WM::Proxy<EngineControl> audio_midi_setup;
658 WM::Proxy<ExportVideoDialog> export_video_dialog;
660 /* Windows/Dialogs that require a creator method */
662 WM::ProxyWithConstructor<SessionOptionEditor> session_option_editor;
663 WM::ProxyWithConstructor<AddVideoDialog> add_video_dialog;
664 WM::ProxyWithConstructor<BundleManager> bundle_manager;
665 WM::ProxyWithConstructor<BigClockWindow> big_clock_window;
666 WM::ProxyWithConstructor<GlobalPortMatrixWindow> audio_port_matrix;
667 WM::ProxyWithConstructor<GlobalPortMatrixWindow> midi_port_matrix;
668 WM::ProxyWithConstructor<KeyEditor> key_editor;
670 /* creator methods */
672 SessionOptionEditor* create_session_option_editor ();
673 BundleManager* create_bundle_manager ();
674 AddVideoDialog* create_add_video_dialog ();
675 BigClockWindow* create_big_clock_window();
676 GlobalPortMatrixWindow* create_global_port_matrix (ARDOUR::DataType);
677 KeyEditor* create_key_editor ();
679 ARDOUR::SystemExec *video_server_process;
681 void handle_locations_change (ARDOUR::Location*);
683 /* Keyboard Handling */
685 ArdourKeyboard* keyboard;
687 /* Keymap handling */
689 void install_actions ();
691 void toggle_record_enable (uint32_t);
693 uint32_t rec_enabled_streams;
694 void count_recenabled_streams (ARDOUR::Route&);
698 void pop_back_splash (Gtk::Window&);
702 Gtk::MenuItem *cleanup_item;
704 void display_cleanup_results (ARDOUR::CleanupReport& rep, const gchar* list_title, const bool msg_delete);
706 void cleanup_peakfiles ();
709 bool have_configure_timeout;
710 ARDOUR::microseconds_t last_configure_time;
711 gint configure_timeout ();
713 ARDOUR::microseconds_t last_peak_grab;
714 ARDOUR::microseconds_t last_shuttle_request;
716 bool have_disk_speed_dialog_displayed;
717 void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
718 void disk_overrun_handler ();
719 void disk_underrun_handler ();
720 void gui_idle_handler ();
722 void cancel_plugin_scan ();
723 void cancel_plugin_timeout ();
724 void plugin_scan_dialog (std::string type, std::string plugin, bool);
725 void plugin_scan_timeout (int);
727 void session_format_mismatch (std::string, std::string);
729 void session_dialog (std::string);
730 int pending_state_dialog ();
731 int sr_mismatch_dialog (ARDOUR::framecnt_t, ARDOUR::framecnt_t);
733 Gtk::MenuItem* jack_disconnect_item;
734 Gtk::MenuItem* jack_reconnect_item;
735 Gtk::Menu* jack_bufsize_menu;
737 Glib::RefPtr<Gtk::ActionGroup> common_actions;
739 void editor_realized ();
741 std::vector<std::string> positional_sync_strings;
743 void toggle_send_midi_feedback ();
744 void toggle_use_mmc ();
745 void toggle_send_mmc ();
746 void toggle_send_mtc ();
747 void toggle_send_midi_clock ();
749 void toggle_use_osc ();
751 void parameter_changed (std::string);
752 void session_parameter_changed (std::string);
756 void check_memory_locking ();
758 void audioengine_setup ();
760 void display_message (const char *prefix, gint prefix_len,
761 Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag,
763 Gtk::Label status_bar_label;
764 bool status_bar_button_press (GdkEventButton*);
766 void loading_message (const std::string& msg);
768 PBD::ScopedConnectionList forever_connections;
769 PBD::ScopedConnection halt_connection;
771 void step_edit_status_change (bool);
773 void platform_specific ();
774 void platform_setup ();
776 /* these are used only in response to a platform-specific "ShouldQuit" signal
779 void queue_finish ();
780 void fontconfig_dialog ();
782 int missing_file (ARDOUR::Session*s, std::string str, ARDOUR::DataType type);
783 int ambiguous_file (std::string file, std::vector<std::string> hits);
785 bool click_button_clicked (GdkEventButton *);
787 VisibilityGroup _status_bar_visibility;
789 /** A ProcessThread so that we have some thread-local buffers for use by
790 * PluginEqGui::impulse_analysis ().
792 ARDOUR::ProcessThread* _process_thread;
794 void feedback_detected ();
796 ArdourButton midi_panic_button;
799 void successful_graph_sort ();
800 bool _feedback_exists;
802 enum ArdourLogLevel {
809 ArdourLogLevel _log_not_acknowledged;
811 void resize_text_widgets ();
813 bool xrun_button_release (GdkEventButton* ev);
815 std::string _announce_string;
816 void check_announcements ();
818 int do_audio_midi_setup (uint32_t);
819 void audioengine_became_silent ();
821 DuplicateRouteDialog* duplicate_routes_dialog;
823 void grab_focus_after_dialog ();
825 void tabs_switch (GtkNotebookPage*, guint page_number);
826 void tabs_page_added (Gtk::Widget*, guint page_number);
827 void tabs_page_removed (Gtk::Widget*, guint page_number);
828 bool key_press_focus_accelerator_handler (Gtk::Window& window, GdkEventKey* ev, Gtkmm2ext::Bindings*);
829 bool try_gtk_accel_binding (GtkWindow* win, GdkEventKey* ev, bool translate, GdkModifierType modifier);
831 bool main_window_delete_event (GdkEventAny*);
832 bool idle_ask_about_quit ();
834 void load_bindings ();
837 #endif /* __ardour_gui_h__ */