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>
56 #include <gtkmm2ext/gtk_ui.h>
57 #include <gtkmm2ext/click_box.h>
58 #include <gtkmm2ext/stateful_button.h>
59 #include <gtkmm2ext/bindable_button.h>
61 #include "ardour/ardour.h"
62 #include "ardour/types.h"
63 #include "ardour/utils.h"
64 #include "ardour/plugin.h"
65 #include "ardour/session_handle.h"
66 #include "ardour/system_exec.h"
68 #include "video_timeline.h"
70 #include "add_route_dialog.h"
71 #include "ardour_button.h"
72 #include "ardour_dialog.h"
73 #include "ardour_window.h"
76 #include "visibility_group.h"
77 #include "window_manager.h"
81 #include "add_video_dialog.h"
82 #include "big_clock_window.h"
83 #include "bundle_manager.h"
84 #include "engine_dialog.h"
85 #include "export_video_dialog.h"
86 #include "global_port_matrix.h"
87 #include "keyeditor.h"
88 #include "location_ui.h"
89 #include "rc_option_editor.h"
90 #include "route_params_ui.h"
91 #include "session_option_editor.h"
92 #include "speaker_dialog.h"
100 class ExportVideoDialog;
102 class LocationUIWindow;
103 class RCOptionEditor;
104 class RouteParams_UI;
105 class SessionOptionEditor;
107 class GlobalPortMatrixWindow;
111 class ArdourKeyboard;
114 class ConnectionEditor;
115 class DuplicateRouteDialog;
118 class ArdourPrompter;
122 class SessionOptionEditor;
123 class ShuttleControl;
129 class LevelMeterHBox;
130 class GUIObjectState;
133 class ControlProtocolInfo;
142 namespace Gtkmm2ext {
150 class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
153 ARDOUR_UI (int *argcp, char **argvp[], const char* localedir);
156 bool run_startup (bool should_be_new, std::string load_template);
162 void launch_manual ();
163 void launch_reference ();
164 void launch_tracker ();
165 void launch_subscribe ();
166 void launch_cheat_sheet ();
167 void launch_website ();
168 void launch_website_dev ();
169 void launch_forums ();
170 void launch_howto_report ();
174 void load_from_application_api (const std::string& path);
177 int load_session (const std::string& path, const std::string& snapshot, std::string mix_template = std::string());
179 int build_session (const std::string& path, const std::string& snapshot, ARDOUR::BusProfile&);
180 bool session_is_new() const { return _session_is_new; }
182 ARDOUR::Session* the_session() { return _session; }
184 bool get_smart_mode () const;
186 int get_session_parameters (bool quit_on_cancel, bool should_be_new = false, std::string load_template = "");
187 int build_session_from_dialog (SessionDialog&, const std::string& session_name, const std::string& session_path);
188 bool ask_about_loading_existing_session (const std::string& session_path);
190 /// @return true if session was successfully unloaded.
191 int unload_session (bool hide_stuff = false);
192 void close_session();
194 int save_state_canfail (std::string state_name = "", bool switch_to_it = false);
195 void save_state (const std::string & state_name = "", bool switch_to_it = false);
197 static ARDOUR_UI *instance () { return theArdourUI; }
199 PublicEditor& the_editor() { return *editor;}
200 Mixer_UI* the_mixer() { return mixer; }
202 void new_midi_tracer_window ();
203 void toggle_editing_space();
204 void toggle_mixer_space();
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* editor_settings() const;
220 XMLNode* mixer_settings () const;
221 XMLNode* keyboard_settings () const;
222 XMLNode* tearoff_settings (const char*) const;
224 void save_ardour_state ();
225 gboolean configure_handler (GdkEventConfigure* conf);
227 void halt_on_xrun_message ();
228 void xrun_handler (framepos_t);
229 void create_xrun_marker (framepos_t);
231 GUIObjectState* gui_object_state;
233 MainClock* primary_clock;
234 MainClock* secondary_clock;
235 void focus_on_clock ();
236 AudioClock* big_clock;
238 TimeInfoBox* time_info_box;
240 VideoTimeLine *video_timeline;
242 void store_clock_modes ();
243 void restore_clock_modes ();
244 void reset_main_clocks ();
246 void synchronize_sync_source_and_video_pullup ();
248 void add_route (Gtk::Window* float_window);
249 void add_routes_part_two ();
250 void add_routes_thread ();
252 void start_duplicate_routes ();
254 void add_video (Gtk::Window* float_window);
255 void remove_video ();
256 void start_video_server_menu (Gtk::Window* float_window);
257 bool start_video_server (Gtk::Window* float_window, bool popup_msg);
258 void stop_video_server (bool ask_confirm=false);
259 void flush_videotimeline_cache (bool localcacheonly=false);
260 void export_video (bool range = false);
262 void session_add_audio_track (
264 int32_t output_channels,
265 ARDOUR::TrackMode mode,
266 ARDOUR::RouteGroup* route_group,
268 std::string const & name_template
271 session_add_audio_route (true, input_channels, output_channels, mode, route_group, how_many, name_template);
274 void session_add_audio_bus (int input_channels, int32_t output_channels, ARDOUR::RouteGroup* route_group,
275 uint32_t how_many, std::string const & name_template) {
276 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, route_group, how_many, name_template);
279 void session_add_midi_track (ARDOUR::RouteGroup* route_group, uint32_t how_many, std::string const & name_template,
280 ARDOUR::PluginInfoPtr instrument) {
281 session_add_midi_route (true, route_group, how_many, name_template, instrument);
284 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,
285 ARDOUR::PluginInfoPtr instrument);
287 /*void session_add_midi_bus () {
288 session_add_midi_route (false);
291 void attach_to_engine ();
294 gint exit_on_main_window_close (GdkEventAny *);
296 void maximise_editing_space ();
297 void restore_editing_space ();
299 void show_ui_prefs ();
301 bool check_audioengine(Gtk::Window&);
303 void update_tearoff_visibility ();
305 void setup_profile ();
306 void setup_tooltips ();
308 void set_shuttle_fract (double);
310 void get_process_buffers ();
311 void drop_process_buffers ();
313 void reset_peak_display ();
314 void reset_route_peak_display (ARDOUR::Route*);
315 void reset_group_peak_display (ARDOUR::RouteGroup*);
317 const std::string& announce_string() const { return _announce_string; }
319 void hide_application ();
322 friend class PublicEditor;
324 void toggle_auto_play ();
325 void toggle_auto_input ();
326 void toggle_punch ();
327 void unset_dual_punch ();
328 bool ignore_dual_punch;
329 void toggle_punch_in ();
330 void toggle_punch_out ();
331 void show_loop_punch_ruler_and_disallow_hide ();
332 void reenable_hide_loop_punch_ruler_if_appropriate ();
333 void toggle_auto_return ();
334 void toggle_click ();
335 void toggle_audio_midi_setup ();
336 void toggle_session_auto_loop ();
337 void toggle_rc_options_window ();
338 void toggle_session_options_window ();
341 PublicEditor* editor;
346 bool _initial_verbose_plugin_scan;
347 bool first_time_engine_run;
349 void goto_editor_window ();
350 void goto_mixer_window ();
351 void toggle_mixer_window ();
352 void toggle_meterbridge ();
353 void toggle_editor_mixer ();
355 int setup_windows ();
356 void setup_transport ();
359 static ARDOUR_UI *theArdourUI;
360 SessionDialog *_session_dialog;
364 int ask_about_saving_session (const std::vector<std::string>& actions);
366 void save_session_at_its_request (std::string);
367 /* periodic safety backup, to be precise */
368 gint autosave_session();
369 void update_autosave();
370 sigc::connection _autosave_connection;
372 void map_transport_state ();
373 int32_t do_engine_start ();
375 void engine_halted (const char* reason, bool free_reason);
376 void engine_stopped ();
377 void engine_running ();
381 void about_signal_response(int response);
383 Gtk::VBox top_packer;
385 sigc::connection clock_signal_connection;
386 void update_clocks ();
387 void start_clocking ();
388 void stop_clocking ();
390 bool main_window_state_event_handler (GdkEventWindowState*, bool window_was_editor);
392 void update_transport_clocks (framepos_t pos);
393 void record_state_changed ();
395 std::list<MidiTracer*> _midi_tracer_windows;
397 void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
398 void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
399 void reattach_all_tearoffs ();
401 /* Transport Control */
403 Gtkmm2ext::TearOff* transport_tearoff;
404 Gtk::Frame transport_frame;
405 Gtk::HBox transport_tearoff_hbox;
406 Gtk::HBox transport_hbox;
407 Gtk::Fixed transport_base;
408 Gtk::Fixed transport_button_base;
409 Gtk::Frame transport_button_frame;
410 Gtk::HBox transport_button_hbox;
411 Gtk::VBox transport_button_vbox;
412 Gtk::HBox transport_option_button_hbox;
413 Gtk::VBox transport_option_button_vbox;
414 Gtk::HBox transport_clock_hbox;
415 Gtk::VBox transport_clock_vbox;
416 Gtk::HBox primary_clock_hbox;
417 Gtk::HBox secondary_clock_hbox;
419 struct TransportControllable : public PBD::Controllable {
430 TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
431 void set_value (double);
432 double get_value (void) const;
438 boost::shared_ptr<TransportControllable> roll_controllable;
439 boost::shared_ptr<TransportControllable> stop_controllable;
440 boost::shared_ptr<TransportControllable> goto_start_controllable;
441 boost::shared_ptr<TransportControllable> goto_end_controllable;
442 boost::shared_ptr<TransportControllable> auto_loop_controllable;
443 boost::shared_ptr<TransportControllable> play_selection_controllable;
444 boost::shared_ptr<TransportControllable> rec_controllable;
446 void toggle_follow_edits ();
448 void set_transport_controllable_state (const XMLNode&);
449 XMLNode& get_transport_controllable_state ();
451 ArdourButton roll_button;
452 ArdourButton stop_button;
453 ArdourButton goto_start_button;
454 ArdourButton goto_end_button;
455 ArdourButton auto_loop_button;
456 ArdourButton play_selection_button;
457 ArdourButton rec_button;
459 void toggle_external_sync ();
460 void toggle_time_master ();
461 void toggle_video_sync ();
463 ShuttleControl* shuttle_box;
465 ArdourButton auto_return_button;
466 ArdourButton follow_edits_button;
467 ArdourButton auto_input_button;
468 ArdourButton click_button;
469 ArdourButton sync_button;
471 ArdourButton auditioning_alert_button;
472 ArdourButton solo_alert_button;
473 ArdourButton feedback_alert_button;
474 ArdourButton error_alert_button;
478 LevelMeterHBox * editor_meter;
479 float editor_meter_max_peak;
480 ArdourButton editor_meter_peak_display;
481 bool editor_meter_peak_button_release (GdkEventButton*);
483 void blink_handler (bool);
484 sigc::connection blink_connection;
487 void solo_blink (bool);
488 void sync_blink (bool);
489 void audition_blink (bool);
490 void feedback_blink (bool);
491 void error_blink (bool);
493 void set_flat_buttons();
495 void soloing_changed (bool);
496 void auditioning_changed (bool);
497 void _auditioning_changed (bool);
499 bool solo_alert_press (GdkEventButton* ev);
500 bool audition_alert_press (GdkEventButton* ev);
501 bool feedback_alert_press (GdkEventButton *);
502 bool error_alert_press (GdkEventButton *);
504 void big_clock_value_changed ();
505 void primary_clock_value_changed ();
506 void secondary_clock_value_changed ();
508 /* called by Blink signal */
510 void transport_rec_enable_blink (bool onoff);
512 Gtk::Menu* session_popup_menu;
514 /* menu bar and associated stuff */
516 Gtk::MenuBar* menu_bar;
517 Gtk::EventBox menu_bar_base;
520 void use_menubar_as_top_menubar ();
521 void build_menu_bar ();
523 Gtk::Label wall_clock_label;
524 gint update_wall_clock ();
526 Gtk::Label disk_space_label;
527 void update_disk_space ();
529 Gtk::Label timecode_format_label;
530 void update_timecode_format ();
532 Gtk::Label cpu_load_label;
533 void update_cpu_load ();
535 Gtk::Label xrun_label;
536 void update_xrun_count ();
538 Gtk::Label peak_thread_work_label;
539 void update_peak_thread_work ();
541 Gtk::Label buffer_load_label;
542 void update_buffer_load ();
544 Gtk::Label sample_rate_label;
545 void update_sample_rate (ARDOUR::framecnt_t);
547 Gtk::Label format_label;
548 void update_format ();
550 void every_second ();
551 void every_point_one_seconds ();
552 void every_point_zero_something_seconds ();
554 sigc::connection second_connection;
555 sigc::connection point_one_second_connection;
556 sigc::connection point_zero_something_second_connection;
557 sigc::connection fps_connection;
559 void set_fps_timeout_connection ();
561 void open_session ();
562 void open_recent_session ();
563 bool process_save_template_prompter (ArdourPrompter& prompter);
564 void save_template ();
566 void edit_metadata ();
567 void import_metadata ();
569 void session_add_audio_route (bool, int32_t, int32_t, ARDOUR::TrackMode, ARDOUR::RouteGroup *, uint32_t, std::string const &);
570 void session_add_midi_route (bool, ARDOUR::RouteGroup *, uint32_t, std::string const &, ARDOUR::PluginInfoPtr);
572 void set_transport_sensitivity (bool);
574 //stuff for ProTools-style numpad
575 void transport_numpad_event (int num);
576 void transport_numpad_decimal ();
577 bool _numpad_locate_happening;
578 int _pending_locate_num;
579 gint transport_numpad_timeout ();
580 sigc::connection _numpad_timeout_connection;
582 void transport_goto_nth_marker (int nth);
583 void transport_goto_zero ();
584 void transport_goto_start ();
585 void transport_goto_end ();
586 void transport_goto_wallclock ();
587 void transport_stop ();
588 void transport_record (bool roll);
589 void transport_roll ();
590 void transport_play_selection();
591 void transport_play_preroll();
592 void transport_forward (int option);
593 void transport_rewind (int option);
594 void transport_loop ();
595 void toggle_roll (bool with_abort, bool roll_out_of_bounded_mode);
596 bool trx_record_enable_all_tracks ();
598 bool _session_is_new;
599 void set_session (ARDOUR::Session *);
600 void connect_dependents_to_session (ARDOUR::Session *);
601 void we_have_dependents ();
603 void setup_session_options ();
605 guint32 last_key_press_time;
607 bool process_snapshot_session_prompter (ArdourPrompter& prompter, bool switch_to_it);
608 void snapshot_session (bool switch_to_it);
610 SaveAsDialog* save_as_dialog;
612 bool save_as_progress_update (float fraction, int64_t cnt, int64_t total, Gtk::Label* label, Gtk::ProgressBar* bar);
613 void save_session_as ();
614 void rename_session ();
615 void setup_order_hint (AddRouteDialog::InsertAt);
618 int create_editor ();
620 Meterbridge *meterbridge;
621 int create_meterbridge ();
622 /* Dialogs that can be created via new<T> */
624 WM::Proxy<SpeakerDialog> speaker_config_window;
625 WM::Proxy<KeyEditor> key_editor;
626 WM::Proxy<RCOptionEditor> rc_option_editor;
627 WM::Proxy<AddRouteDialog> add_route_dialog;
628 WM::Proxy<About> about;
629 WM::Proxy<LocationUIWindow> location_ui;
630 WM::Proxy<RouteParams_UI> route_params;
631 WM::Proxy<EngineControl> audio_midi_setup;
632 WM::Proxy<ExportVideoDialog> export_video_dialog;
634 /* Windows/Dialogs that require a creator method */
636 WM::ProxyWithConstructor<SessionOptionEditor> session_option_editor;
637 WM::ProxyWithConstructor<AddVideoDialog> add_video_dialog;
638 WM::ProxyWithConstructor<BundleManager> bundle_manager;
639 WM::ProxyWithConstructor<BigClockWindow> big_clock_window;
640 WM::ProxyWithConstructor<GlobalPortMatrixWindow> audio_port_matrix;
641 WM::ProxyWithConstructor<GlobalPortMatrixWindow> midi_port_matrix;
643 /* creator methods */
645 SessionOptionEditor* create_session_option_editor ();
646 BundleManager* create_bundle_manager ();
647 AddVideoDialog* create_add_video_dialog ();
648 BigClockWindow* create_big_clock_window();
649 GlobalPortMatrixWindow* create_global_port_matrix (ARDOUR::DataType);
651 ARDOUR::SystemExec *video_server_process;
653 void handle_locations_change (ARDOUR::Location*);
655 /* Keyboard Handling */
657 ArdourKeyboard* keyboard;
659 /* Keymap handling */
661 void install_actions ();
663 void toggle_record_enable (uint32_t);
665 uint32_t rec_enabled_streams;
666 void count_recenabled_streams (ARDOUR::Route&);
670 void pop_back_splash (Gtk::Window&);
674 Gtk::MenuItem *cleanup_item;
676 void display_cleanup_results (ARDOUR::CleanupReport& rep, const gchar* list_title, const bool msg_delete);
678 void cleanup_peakfiles ();
681 bool have_configure_timeout;
682 ARDOUR::microseconds_t last_configure_time;
683 gint configure_timeout ();
685 ARDOUR::microseconds_t last_peak_grab;
686 ARDOUR::microseconds_t last_shuttle_request;
688 bool have_disk_speed_dialog_displayed;
689 void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
690 void disk_overrun_handler ();
691 void disk_underrun_handler ();
692 void gui_idle_handler ();
694 void cancel_plugin_scan ();
695 void cancel_plugin_timeout ();
696 void plugin_scan_dialog (std::string type, std::string plugin, bool);
697 void plugin_scan_timeout (int);
699 void session_format_mismatch (std::string, std::string);
701 void session_dialog (std::string);
702 int pending_state_dialog ();
703 int sr_mismatch_dialog (ARDOUR::framecnt_t, ARDOUR::framecnt_t);
705 Gtk::MenuItem* jack_disconnect_item;
706 Gtk::MenuItem* jack_reconnect_item;
707 Gtk::Menu* jack_bufsize_menu;
709 Glib::RefPtr<Gtk::ActionGroup> common_actions;
711 void editor_realized ();
713 std::vector<std::string> positional_sync_strings;
715 void toggle_send_midi_feedback ();
716 void toggle_use_mmc ();
717 void toggle_send_mmc ();
718 void toggle_send_mtc ();
719 void toggle_send_midi_clock ();
721 void toggle_use_osc ();
723 void parameter_changed (std::string);
724 void session_parameter_changed (std::string);
728 void check_memory_locking ();
730 void audioengine_setup ();
732 void display_message (const char *prefix, gint prefix_len,
733 Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag,
735 Gtk::Label status_bar_label;
736 bool status_bar_button_press (GdkEventButton*);
738 void loading_message (const std::string& msg);
740 PBD::ScopedConnectionList forever_connections;
741 PBD::ScopedConnection halt_connection;
743 void step_edit_status_change (bool);
745 void platform_specific ();
746 void platform_setup ();
748 /* these are used only in response to a platform-specific "ShouldQuit" signal
751 void queue_finish ();
752 void fontconfig_dialog ();
754 int missing_file (ARDOUR::Session*s, std::string str, ARDOUR::DataType type);
755 int ambiguous_file (std::string file, std::vector<std::string> hits);
757 bool click_button_clicked (GdkEventButton *);
759 VisibilityGroup _status_bar_visibility;
761 /** A ProcessThread so that we have some thread-local buffers for use by
762 * PluginEqGui::impulse_analysis ().
764 ARDOUR::ProcessThread* _process_thread;
766 void feedback_detected ();
768 ArdourButton midi_panic_button;
771 void successful_graph_sort ();
772 bool _feedback_exists;
774 enum ArdourLogLevel {
781 ArdourLogLevel _log_not_acknowledged;
783 void resize_text_widgets ();
785 bool xrun_button_release (GdkEventButton* ev);
787 std::string _announce_string;
788 void check_announcements ();
790 int do_audio_midi_setup (uint32_t);
791 void audioengine_became_silent ();
793 DuplicateRouteDialog* duplicate_routes_dialog;
796 #endif /* __ardour_gui_h__ */