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"
71 #include "ardour_button.h"
72 #include "ardour_dialog.h"
73 #include "ardour_window.h"
75 #include "engine_dialog.h"
76 #include "meterbridge.h"
77 #include "ui_config.h"
79 #include "visibility_group.h"
80 #include "window_manager.h"
82 #include "add_route_dialog.h"
83 #include "add_video_dialog.h"
84 #include "big_clock_window.h"
85 #include "bundle_manager.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"
98 class ConnectionEditor;
102 class RCOptionEditor;
103 class RouteParams_UI;
105 class SessionOptionEditor;
106 class ShuttleControl;
111 class LevelMeterHBox;
112 class GUIObjectState;
115 class ControlProtocolInfo;
124 namespace Gtkmm2ext {
128 class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
131 /* This must be the first data element because constructor ordering
134 UIConfiguration* ui_config;
137 ARDOUR_UI (int *argcp, char **argvp[], const char* localedir);
140 bool run_startup (bool should_be_new, std::string load_template);
146 void launch_manual ();
147 void launch_reference ();
148 void launch_tracker ();
149 void launch_cheat_sheet ();
150 void launch_website ();
151 void launch_website_dev ();
152 void launch_forums ();
153 void launch_howto_report ();
157 void load_from_application_api (const std::string& path);
160 int load_session (const std::string& path, const std::string& snapshot, std::string mix_template = std::string());
162 int build_session (const std::string& path, const std::string& snapshot, ARDOUR::BusProfile&);
163 bool session_is_new() const { return _session_is_new; }
165 ARDOUR::Session* the_session() { return _session; }
167 bool get_smart_mode () const;
169 int get_session_parameters (bool quit_on_cancel, bool should_be_new = false, std::string load_template = "");
170 int build_session_from_dialog (SessionDialog&, const std::string& session_name, const std::string& session_path);
171 bool ask_about_loading_existing_session (const std::string& session_path);
173 /// @return true if session was successfully unloaded.
174 int unload_session (bool hide_stuff = false);
175 void close_session();
177 int save_state_canfail (std::string state_name = "", bool switch_to_it = false);
178 void save_state (const std::string & state_name = "", bool switch_to_it = false);
180 static ARDOUR_UI *instance () { return theArdourUI; }
181 static UIConfiguration *config () { return theArdourUI->ui_config; }
183 PublicEditor& the_editor(){return *editor;}
184 Mixer_UI* the_mixer() { return mixer; }
186 void new_midi_tracer_window ();
187 void toggle_editing_space();
188 void toggle_mixer_space();
189 void toggle_keep_tearoffs();
191 Gtk::Tooltips& tooltips() { return _tooltips; }
193 Gtk::HBox& editor_transport_box() { return _editor_transport_box; }
195 static PublicEditor* _instance;
197 /** Emitted frequently with the audible frame, false, and the edit point as
198 * parameters respectively.
200 * (either RapidScreenUpdate || SuperRapidScreenUpdate - user-config)
202 static sigc::signal<void, framepos_t, bool, framepos_t> Clock;
204 static void close_all_dialogs () { CloseAllDialogs(); }
205 static sigc::signal<void> CloseAllDialogs;
207 XMLNode* editor_settings() const;
208 XMLNode* mixer_settings () const;
209 XMLNode* keyboard_settings () const;
210 XMLNode* tearoff_settings (const char*) const;
212 void save_ardour_state ();
213 gboolean configure_handler (GdkEventConfigure* conf);
215 void halt_on_xrun_message ();
216 void xrun_handler (framepos_t);
217 void create_xrun_marker (framepos_t);
219 GUIObjectState* gui_object_state;
221 MainClock* primary_clock;
222 MainClock* secondary_clock;
223 void focus_on_clock ();
224 AudioClock* big_clock;
226 TimeInfoBox* time_info_box;
228 VideoTimeLine *video_timeline;
230 void store_clock_modes ();
231 void restore_clock_modes ();
232 void reset_main_clocks ();
234 void synchronize_sync_source_and_video_pullup ();
236 void add_route (Gtk::Window* float_window);
237 void add_routes_part_two ();
238 void add_routes_thread ();
240 void add_video (Gtk::Window* float_window);
241 void remove_video ();
242 void start_video_server_menu (Gtk::Window* float_window);
243 bool start_video_server (Gtk::Window* float_window, bool popup_msg);
244 void stop_video_server (bool ask_confirm=false);
245 void flush_videotimeline_cache (bool localcacheonly=false);
247 void session_add_audio_track (
249 int32_t output_channels,
250 ARDOUR::TrackMode mode,
251 ARDOUR::RouteGroup* route_group,
253 std::string const & name_template
256 session_add_audio_route (true, input_channels, output_channels, mode, route_group, how_many, name_template);
259 void session_add_audio_bus (int input_channels, int32_t output_channels, ARDOUR::RouteGroup* route_group,
260 uint32_t how_many, std::string const & name_template) {
261 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, route_group, how_many, name_template);
264 void session_add_midi_track (ARDOUR::RouteGroup* route_group, uint32_t how_many, std::string const & name_template,
265 ARDOUR::PluginInfoPtr instrument) {
266 session_add_midi_route (true, route_group, how_many, name_template, instrument);
269 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,
270 ARDOUR::PluginInfoPtr instrument);
272 /*void session_add_midi_bus () {
273 session_add_midi_route (false);
276 void attach_to_engine ();
279 gint exit_on_main_window_close (GdkEventAny *);
281 void maximise_editing_space ();
282 void restore_editing_space ();
284 void show_ui_prefs ();
286 void update_tearoff_visibility ();
288 void setup_profile ();
289 void setup_tooltips ();
291 void set_shuttle_fract (double);
293 void get_process_buffers ();
294 void drop_process_buffers ();
296 void reset_peak_display ();
297 void reset_route_peak_display (ARDOUR::Route*);
298 void reset_group_peak_display (ARDOUR::RouteGroup*);
300 const std::string& announce_string() const { return _announce_string; }
302 int disconnect_from_engine ();
303 int reconnect_to_engine ();
306 friend class PublicEditor;
308 void toggle_auto_play ();
309 void toggle_auto_input ();
310 void toggle_punch ();
311 void unset_dual_punch ();
312 bool ignore_dual_punch;
313 void toggle_punch_in ();
314 void toggle_punch_out ();
315 void show_loop_punch_ruler_and_disallow_hide ();
316 void reenable_hide_loop_punch_ruler_if_appropriate ();
317 void toggle_auto_return ();
318 void toggle_click ();
319 void toggle_audio_midi_setup ();
320 void toggle_session_auto_loop ();
321 void toggle_rc_options_window ();
322 void toggle_session_options_window ();
325 PublicEditor* editor;
327 Gtk::Tooltips _tooltips;
331 bool first_time_engine_run;
333 void goto_editor_window ();
334 void goto_mixer_window ();
335 void toggle_mixer_window ();
336 void toggle_meterbridge ();
337 void toggle_editor_mixer ();
339 int setup_windows ();
340 void setup_transport ();
343 static ARDOUR_UI *theArdourUI;
347 int ask_about_saving_session (const std::vector<std::string>& actions);
349 void save_session_at_its_request (std::string);
350 /* periodic safety backup, to be precise */
351 gint autosave_session();
352 void update_autosave();
353 sigc::connection _autosave_connection;
355 void map_transport_state ();
356 int32_t do_engine_start ();
358 void engine_halted (const char* reason, bool free_reason);
359 void engine_stopped ();
360 void engine_running ();
364 void about_signal_response(int response);
366 Gtk::VBox top_packer;
368 sigc::connection clock_signal_connection;
369 void update_clocks ();
370 void start_clocking ();
371 void stop_clocking ();
373 bool main_window_state_event_handler (GdkEventWindowState*, bool window_was_editor);
375 void update_transport_clocks (framepos_t pos);
376 void record_state_changed ();
378 std::list<MidiTracer*> _midi_tracer_windows;
380 void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
381 void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
382 void reattach_all_tearoffs ();
384 /* Transport Control */
386 Gtkmm2ext::TearOff* transport_tearoff;
387 Gtk::Frame transport_frame;
388 Gtk::HBox transport_tearoff_hbox;
389 Gtk::HBox _editor_transport_box;
390 Gtk::HBox transport_hbox;
391 Gtk::Fixed transport_base;
392 Gtk::Fixed transport_button_base;
393 Gtk::Frame transport_button_frame;
394 Gtk::HBox transport_button_hbox;
395 Gtk::VBox transport_button_vbox;
396 Gtk::HBox transport_option_button_hbox;
397 Gtk::VBox transport_option_button_vbox;
398 Gtk::HBox transport_clock_hbox;
399 Gtk::VBox transport_clock_vbox;
400 Gtk::HBox primary_clock_hbox;
401 Gtk::HBox secondary_clock_hbox;
403 struct TransportControllable : public PBD::Controllable {
414 TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
415 void set_value (double);
416 double get_value (void) const;
422 boost::shared_ptr<TransportControllable> roll_controllable;
423 boost::shared_ptr<TransportControllable> stop_controllable;
424 boost::shared_ptr<TransportControllable> goto_start_controllable;
425 boost::shared_ptr<TransportControllable> goto_end_controllable;
426 boost::shared_ptr<TransportControllable> auto_loop_controllable;
427 boost::shared_ptr<TransportControllable> play_selection_controllable;
428 boost::shared_ptr<TransportControllable> rec_controllable;
430 void toggle_follow_edits ();
432 void set_transport_controllable_state (const XMLNode&);
433 XMLNode& get_transport_controllable_state ();
435 ArdourButton roll_button;
436 ArdourButton stop_button;
437 ArdourButton goto_start_button;
438 ArdourButton goto_end_button;
439 ArdourButton auto_loop_button;
440 ArdourButton play_selection_button;
441 ArdourButton rec_button;
443 void toggle_external_sync ();
444 void toggle_time_master ();
445 void toggle_video_sync ();
447 ShuttleControl* shuttle_box;
449 ArdourButton auto_return_button;
450 ArdourButton follow_edits_button;
451 ArdourButton auto_input_button;
452 ArdourButton click_button;
453 ArdourButton sync_button;
455 ArdourButton auditioning_alert_button;
456 ArdourButton solo_alert_button;
457 ArdourButton feedback_alert_button;
461 LevelMeterHBox * editor_meter;
462 float editor_meter_max_peak;
463 ArdourButton editor_meter_peak_display;
464 bool editor_meter_peak_button_release (GdkEventButton*);
466 void blink_handler (bool);
467 sigc::connection blink_connection;
469 void solo_blink (bool);
470 void sync_blink (bool);
471 void audition_blink (bool);
472 void feedback_blink (bool);
474 void set_flat_buttons();
476 void soloing_changed (bool);
477 void auditioning_changed (bool);
478 void _auditioning_changed (bool);
480 bool solo_alert_press (GdkEventButton* ev);
481 bool audition_alert_press (GdkEventButton* ev);
482 bool feedback_alert_press (GdkEventButton *);
484 void big_clock_value_changed ();
485 void primary_clock_value_changed ();
486 void secondary_clock_value_changed ();
488 /* called by Blink signal */
490 void transport_rec_enable_blink (bool onoff);
492 Gtk::Menu* session_popup_menu;
494 struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
495 RecentSessionModelColumns() {
500 Gtk::TreeModelColumn<std::string> visible_name;
501 Gtk::TreeModelColumn<std::string> tip;
502 Gtk::TreeModelColumn<std::string> fullpath;
505 RecentSessionModelColumns recent_session_columns;
506 Gtk::TreeView recent_session_display;
507 Glib::RefPtr<Gtk::TreeStore> recent_session_model;
509 ArdourDialog* session_selector_window;
510 Gtk::FileChooserDialog* open_session_selector;
512 void build_session_selector();
513 void redisplay_recent_sessions();
514 void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
516 struct RecentSessionsSorter {
517 bool operator() (std::pair<std::string,std::string> a, std::pair<std::string,std::string> b) const {
518 return ARDOUR::cmp_nocase(a.first, b.first) == -1;
522 /* menu bar and associated stuff */
524 Gtk::MenuBar* menu_bar;
525 Gtk::EventBox menu_bar_base;
528 void use_menubar_as_top_menubar ();
529 void build_menu_bar ();
531 Gtk::Label wall_clock_label;
532 gint update_wall_clock ();
534 Gtk::Label disk_space_label;
535 void update_disk_space ();
537 Gtk::Label timecode_format_label;
538 void update_timecode_format ();
540 Gtk::Label cpu_load_label;
541 void update_cpu_load ();
543 Gtk::Label buffer_load_label;
544 void update_buffer_load ();
546 Gtk::Label sample_rate_label;
547 void update_sample_rate (ARDOUR::framecnt_t);
549 Gtk::Label format_label;
550 void update_format ();
552 void every_second ();
553 void every_point_one_seconds ();
554 void every_point_zero_something_seconds ();
556 sigc::connection second_connection;
557 sigc::connection point_one_second_connection;
558 sigc::connection point_zero_something_second_connection;
559 sigc::connection fps_connection;
561 void set_fps_timeout_connection ();
563 void open_session ();
564 void open_recent_session ();
565 void save_template ();
567 void edit_metadata ();
568 void import_metadata ();
570 void session_add_audio_route (bool, int32_t, int32_t, ARDOUR::TrackMode, ARDOUR::RouteGroup *, uint32_t, std::string const &);
571 void session_add_midi_route (bool, ARDOUR::RouteGroup *, uint32_t, std::string const &, ARDOUR::PluginInfoPtr);
573 void set_transport_sensitivity (bool);
575 //stuff for ProTools-style numpad
576 void transport_numpad_event (int num);
577 void transport_numpad_decimal ();
578 bool _numpad_locate_happening;
579 int _pending_locate_num;
580 gint transport_numpad_timeout ();
581 sigc::connection _numpad_timeout_connection;
583 void transport_goto_nth_marker (int nth);
584 void transport_goto_zero ();
585 void transport_goto_start ();
586 void transport_goto_end ();
587 void transport_goto_wallclock ();
588 void transport_stop ();
589 void transport_record (bool roll);
590 void transport_roll ();
591 void transport_play_selection();
592 void transport_play_preroll();
593 void transport_forward (int option);
594 void transport_rewind (int option);
595 void transport_loop ();
596 void toggle_roll (bool with_abort, bool roll_out_of_bounded_mode);
597 bool trx_record_enable_all_tracks ();
599 bool _session_is_new;
600 void set_session (ARDOUR::Session *);
601 void connect_dependents_to_session (ARDOUR::Session *);
602 void we_have_dependents ();
604 void setup_session_options ();
606 guint32 last_key_press_time;
608 void snapshot_session (bool switch_to_it);
609 void rename_session ();
610 void setup_order_hint ();
613 int create_editor ();
615 Meterbridge *meterbridge;
616 int create_meterbridge ();
617 /* Dialogs that can be created via new<T> */
619 WM::Proxy<SpeakerDialog> speaker_config_window;
620 WM::Proxy<KeyEditor> key_editor;
621 WM::Proxy<RCOptionEditor> rc_option_editor;
622 WM::Proxy<AddRouteDialog> add_route_dialog;
623 WM::Proxy<About> about;
624 WM::Proxy<LocationUIWindow> location_ui;
625 WM::Proxy<RouteParams_UI> route_params;
626 WM::Proxy<EngineControl> audio_midi_setup;
628 /* Windows/Dialogs that require a creator method */
630 WM::ProxyWithConstructor<SessionOptionEditor> session_option_editor;
631 WM::ProxyWithConstructor<AddVideoDialog> add_video_dialog;
632 WM::ProxyWithConstructor<BundleManager> bundle_manager;
633 WM::ProxyWithConstructor<BigClockWindow> big_clock_window;
634 WM::ProxyWithConstructor<GlobalPortMatrixWindow> audio_port_matrix;
635 WM::ProxyWithConstructor<GlobalPortMatrixWindow> midi_port_matrix;
637 /* creator methods */
639 SessionOptionEditor* create_session_option_editor ();
640 BundleManager* create_bundle_manager ();
641 AddVideoDialog* create_add_video_dialog ();
642 BigClockWindow* create_big_clock_window();
643 GlobalPortMatrixWindow* create_global_port_matrix (ARDOUR::DataType);
645 ARDOUR::SystemExec *video_server_process;
647 void handle_locations_change (ARDOUR::Location*);
649 /* Keyboard Handling */
651 ArdourKeyboard* keyboard;
653 /* Keymap handling */
655 void install_actions ();
657 void toggle_record_enable (uint32_t);
659 uint32_t rec_enabled_streams;
660 void count_recenabled_streams (ARDOUR::Route&);
664 void pop_back_splash (Gtk::Window&);
668 Gtk::MenuItem *cleanup_item;
670 void display_cleanup_results (ARDOUR::CleanupReport& rep, const gchar* list_title, const bool msg_delete);
674 bool have_configure_timeout;
675 ARDOUR::microseconds_t last_configure_time;
676 gint configure_timeout ();
678 ARDOUR::microseconds_t last_peak_grab;
679 ARDOUR::microseconds_t last_shuttle_request;
681 bool have_disk_speed_dialog_displayed;
682 void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
683 void disk_overrun_handler ();
684 void disk_underrun_handler ();
685 void gui_idle_handler ();
687 void cancel_plugin_scan ();
688 void cancel_plugin_timeout ();
689 void plugin_scan_dialog (std::string type, std::string plugin, bool);
690 void plugin_scan_timeout (int);
692 void session_format_mismatch (std::string, std::string);
694 void session_dialog (std::string);
695 int pending_state_dialog ();
696 int sr_mismatch_dialog (ARDOUR::framecnt_t, ARDOUR::framecnt_t);
698 Gtk::MenuItem* jack_disconnect_item;
699 Gtk::MenuItem* jack_reconnect_item;
700 Gtk::Menu* jack_bufsize_menu;
702 Glib::RefPtr<Gtk::ActionGroup> common_actions;
704 void editor_realized ();
706 std::vector<std::string> positional_sync_strings;
708 void toggle_send_midi_feedback ();
709 void toggle_use_mmc ();
710 void toggle_send_mmc ();
711 void toggle_send_mtc ();
712 void toggle_send_midi_clock ();
714 void toggle_use_osc ();
716 void parameter_changed (std::string);
717 void session_parameter_changed (std::string);
721 void check_memory_locking ();
723 bool check_audioengine();
724 void audioengine_setup ();
726 void display_message (const char *prefix, gint prefix_len,
727 Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag,
729 Gtk::Label status_bar_label;
730 bool status_bar_button_press (GdkEventButton*);
731 Gtk::ToggleButton error_log_button;
733 void loading_message (const std::string& msg);
735 PBD::ScopedConnectionList forever_connections;
736 PBD::ScopedConnection halt_connection;
738 void step_edit_status_change (bool);
740 void platform_specific ();
741 void platform_setup ();
743 /* these are used only in response to a platform-specific "ShouldQuit" signal
746 void queue_finish ();
747 void fontconfig_dialog ();
749 int missing_file (ARDOUR::Session*s, std::string str, ARDOUR::DataType type);
750 int ambiguous_file (std::string file, std::vector<std::string> hits);
752 bool click_button_clicked (GdkEventButton *);
754 VisibilityGroup _status_bar_visibility;
756 /** A ProcessThread so that we have some thread-local buffers for use by
757 * PluginEqGui::impulse_analysis ().
759 ARDOUR::ProcessThread* _process_thread;
761 void feedback_detected ();
763 ArdourButton midi_panic_button;
766 void successful_graph_sort ();
767 bool _feedback_exists;
769 void resize_text_widgets ();
771 std::string _announce_string;
772 void check_announcements ();
774 int do_audio_midi_setup (uint32_t);
777 #endif /* __ardour_gui_h__ */