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 */
38 #include <libgnomecanvasmm/canvas.h>
40 #include "pbd/xml++.h"
41 #include "pbd/controllable.h"
42 #include <gtkmm/box.h>
43 #include <gtkmm/frame.h>
44 #include <gtkmm/label.h>
45 #include <gtkmm/table.h>
46 #include <gtkmm/fixed.h>
47 #include <gtkmm/drawingarea.h>
48 #include <gtkmm/eventbox.h>
49 #include <gtkmm/menu.h>
50 #include <gtkmm/menuitem.h>
51 #include <gtkmm/button.h>
52 #include <gtkmm/togglebutton.h>
53 #include <gtkmm/treeview.h>
54 #include <gtkmm/menubar.h>
55 #include <gtkmm/textbuffer.h>
56 #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>
62 #include "ardour/ardour.h"
63 #include "ardour/types.h"
64 #include "ardour/utils.h"
65 #include "ardour/plugin.h"
66 #include "ardour/session_handle.h"
68 #include "video_timeline.h"
70 #include "ardour_button.h"
71 #include "ardour_dialog.h"
72 #include "ardour_window.h"
74 #include "meterbridge.h"
76 #include "ui_config.h"
78 #include "visibility_group.h"
79 #include "window_manager.h"
91 class ConnectionEditor;
94 class LocationUIWindow;
101 class SessionOptionEditor;
102 class ShuttleControl;
108 class LevelMeterHBox;
109 class GlobalPortMatrixWindow;
110 class GUIObjectState;
112 namespace Gtkmm2ext {
117 class ControlProtocolInfo;
126 class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
129 ARDOUR_UI (int *argcp, char **argvp[], const char* localedir);
132 bool run_startup (bool should_be_new, std::string load_template);
138 void launch_manual ();
139 void launch_reference ();
143 void idle_load (const std::string& path);
146 int load_session (const std::string& path, const std::string& snapshot, std::string mix_template = std::string());
148 int build_session (const std::string& path, const std::string& snapshot, ARDOUR::BusProfile&);
149 bool session_is_new() const { return _session_is_new; }
151 ARDOUR::Session* the_session() { return _session; }
153 bool get_smart_mode () const;
155 int get_session_parameters (bool quit_on_cancel, bool should_be_new = false, std::string load_template = "");
156 int build_session_from_dialog (SessionDialog&, const std::string& session_name, const std::string& session_path);
157 bool ask_about_loading_existing_session (const std::string& session_path);
159 /// @return true if session was successfully unloaded.
160 int unload_session (bool hide_stuff = false);
161 void close_session();
163 int save_state_canfail (std::string state_name = "", bool switch_to_it = false);
164 void save_state (const std::string & state_name = "", bool switch_to_it = false);
166 static ARDOUR_UI *instance () { return theArdourUI; }
167 static UIConfiguration *config () { return ui_config; }
169 PublicEditor& the_editor(){return *editor;}
170 Mixer_UI* the_mixer() { return mixer; }
172 void new_midi_tracer_window ();
173 void toggle_editing_space();
174 void toggle_keep_tearoffs();
176 Gtk::Tooltips& tooltips() { return _tooltips; }
178 Gtk::HBox& editor_transport_box() { return _editor_transport_box; }
180 static PublicEditor* _instance;
181 static sigc::signal<void,bool> Blink;
183 /** point_zero_one_seconds -- 10Hz ^= 100ms */
184 static sigc::signal<void> RapidScreenUpdate;
186 /** point_zero_something_seconds -- currently 25Hz ^= 40ms */
187 static sigc::signal<void> SuperRapidScreenUpdate;
189 /** Emitted frequently with the audible frame, false, and the edit point as
190 * parameters respectively.
192 * (either RapidScreenUpdate || SuperRapidScreenUpdate - user-config)
194 static sigc::signal<void, framepos_t, bool, framepos_t> Clock;
196 static void close_all_dialogs () { CloseAllDialogs(); }
197 static sigc::signal<void> CloseAllDialogs;
199 XMLNode* editor_settings() const;
200 XMLNode* mixer_settings () const;
201 XMLNode* keyboard_settings () const;
202 XMLNode* tearoff_settings (const char*) const;
204 void save_ardour_state ();
205 gboolean configure_handler (GdkEventConfigure* conf);
207 void halt_on_xrun_message ();
208 void xrun_handler (framepos_t);
209 void create_xrun_marker (framepos_t);
211 GUIObjectState* gui_object_state;
213 MainClock* primary_clock;
214 MainClock* secondary_clock;
215 void focus_on_clock ();
216 AudioClock* big_clock;
218 TimeInfoBox* time_info_box;
220 VideoTimeLine *video_timeline;
222 void store_clock_modes ();
223 void restore_clock_modes ();
224 void reset_main_clocks ();
226 void synchronize_sync_source_and_video_pullup ();
228 void add_route (Gtk::Window* float_window);
229 void add_routes_part_two ();
230 void add_routes_thread ();
232 void add_video (Gtk::Window* float_window);
233 void remove_video ();
234 void start_video_server_menu (Gtk::Window* float_window);
235 bool start_video_server (Gtk::Window* float_window, bool popup_msg);
236 void stop_video_server (bool ask_confirm=false);
237 void flush_videotimeline_cache (bool localcacheonly=false);
239 void session_add_audio_track (
241 int32_t output_channels,
242 ARDOUR::TrackMode mode,
243 ARDOUR::RouteGroup* route_group,
245 std::string const & name_template
248 session_add_audio_route (true, input_channels, output_channels, mode, route_group, how_many, name_template);
251 void session_add_audio_bus (int input_channels, int32_t output_channels, ARDOUR::RouteGroup* route_group,
252 uint32_t how_many, std::string const & name_template) {
253 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, route_group, how_many, name_template);
256 void session_add_midi_track (ARDOUR::RouteGroup* route_group, uint32_t how_many, std::string const & name_template,
257 ARDOUR::PluginInfoPtr instrument) {
258 session_add_midi_route (true, route_group, how_many, name_template, instrument);
261 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,
262 ARDOUR::PluginInfoPtr instrument);
264 /*void session_add_midi_bus () {
265 session_add_midi_route (false);
268 void attach_to_engine ();
271 gint exit_on_main_window_close (GdkEventAny *);
273 void maximise_editing_space ();
274 void restore_editing_space ();
276 void update_tearoff_visibility ();
278 void setup_profile ();
279 void setup_tooltips ();
281 void set_shuttle_fract (double);
283 void get_process_buffers ();
284 void drop_process_buffers ();
286 void reset_peak_display ();
287 void reset_route_peak_display (ARDOUR::Route*);
288 void reset_group_peak_display (ARDOUR::RouteGroup*);
290 const std::string& announce_string() const { return _announce_string; }
292 int disconnect_from_engine ();
293 int reconnect_to_engine ();
296 friend class PublicEditor;
298 void toggle_auto_play ();
299 void toggle_auto_input ();
300 void toggle_punch ();
301 void unset_dual_punch ();
302 bool ignore_dual_punch;
303 void toggle_punch_in ();
304 void toggle_punch_out ();
305 void show_loop_punch_ruler_and_disallow_hide ();
306 void reenable_hide_loop_punch_ruler_if_appropriate ();
307 void toggle_auto_return ();
308 void toggle_click ();
309 void toggle_audio_midi_setup ();
310 void toggle_session_auto_loop ();
311 void toggle_rc_options_window ();
312 void toggle_session_options_window ();
315 Gtk::Tooltips _tooltips;
319 bool first_time_engine_run;
321 void goto_editor_window ();
322 void goto_mixer_window ();
323 void toggle_mixer_window ();
324 void toggle_meterbridge ();
325 void toggle_editor_mixer ();
327 int setup_windows ();
328 void setup_transport ();
331 static ARDOUR_UI *theArdourUI;
336 int ask_about_saving_session (const std::vector<std::string>& actions);
338 /* periodic safety backup, to be precise */
339 gint autosave_session();
340 void update_autosave();
341 sigc::connection _autosave_connection;
343 void map_transport_state ();
344 int32_t do_engine_start ();
346 void engine_halted (const char* reason, bool free_reason);
347 void engine_stopped ();
348 void engine_running ();
352 static gint _blink (void *);
354 gint blink_timeout_tag;
356 void start_blinking ();
357 void stop_blinking ();
359 void about_signal_response(int response);
361 Gtk::VBox top_packer;
363 sigc::connection clock_signal_connection;
364 void update_clocks ();
365 void start_clocking ();
366 void stop_clocking ();
368 bool main_window_state_event_handler (GdkEventWindowState*, bool window_was_editor);
370 void update_transport_clocks (framepos_t pos);
371 void record_state_changed ();
373 std::list<MidiTracer*> _midi_tracer_windows;
375 /* Transport Control */
377 void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
378 void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
380 Gtkmm2ext::TearOff* transport_tearoff;
381 Gtk::Frame transport_frame;
382 Gtk::HBox transport_tearoff_hbox;
383 Gtk::HBox _editor_transport_box;
384 Gtk::HBox transport_hbox;
385 Gtk::Fixed transport_base;
386 Gtk::Fixed transport_button_base;
387 Gtk::Frame transport_button_frame;
388 Gtk::HBox transport_button_hbox;
389 Gtk::VBox transport_button_vbox;
390 Gtk::HBox transport_option_button_hbox;
391 Gtk::VBox transport_option_button_vbox;
392 Gtk::HBox transport_clock_hbox;
393 Gtk::VBox transport_clock_vbox;
394 Gtk::HBox primary_clock_hbox;
395 Gtk::HBox secondary_clock_hbox;
397 struct TransportControllable : public PBD::Controllable {
408 TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
409 void set_value (double);
410 double get_value (void) const;
416 boost::shared_ptr<TransportControllable> roll_controllable;
417 boost::shared_ptr<TransportControllable> stop_controllable;
418 boost::shared_ptr<TransportControllable> goto_start_controllable;
419 boost::shared_ptr<TransportControllable> goto_end_controllable;
420 boost::shared_ptr<TransportControllable> auto_loop_controllable;
421 boost::shared_ptr<TransportControllable> play_selection_controllable;
422 boost::shared_ptr<TransportControllable> rec_controllable;
424 void toggle_always_play_range ();
426 void set_transport_controllable_state (const XMLNode&);
427 XMLNode& get_transport_controllable_state ();
429 ArdourButton roll_button;
430 ArdourButton stop_button;
431 ArdourButton goto_start_button;
432 ArdourButton goto_end_button;
433 ArdourButton auto_loop_button;
434 ArdourButton play_selection_button;
435 ArdourButton rec_button;
437 void toggle_external_sync ();
438 void toggle_time_master ();
439 void toggle_video_sync ();
441 ShuttleControl* shuttle_box;
443 ArdourButton auto_return_button;
444 ArdourButton follow_edits_button;
445 ArdourButton auto_input_button;
446 ArdourButton click_button;
447 ArdourButton sync_button;
449 ArdourButton auditioning_alert_button;
450 ArdourButton solo_alert_button;
451 ArdourButton feedback_alert_button;
455 LevelMeterHBox * editor_meter;
456 float editor_meter_max_peak;
457 ArdourButton editor_meter_peak_display;
458 bool editor_meter_peak_button_release (GdkEventButton*);
460 void solo_blink (bool);
461 void sync_blink (bool);
462 void audition_blink (bool);
463 void feedback_blink (bool);
465 void soloing_changed (bool);
466 void auditioning_changed (bool);
467 void _auditioning_changed (bool);
469 bool solo_alert_press (GdkEventButton* ev);
470 bool audition_alert_press (GdkEventButton* ev);
471 bool feedback_alert_press (GdkEventButton *);
473 void big_clock_value_changed ();
474 void primary_clock_value_changed ();
475 void secondary_clock_value_changed ();
477 /* called by Blink signal */
479 void transport_rec_enable_blink (bool onoff);
481 Gtk::Menu* session_popup_menu;
483 struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
484 RecentSessionModelColumns() {
489 Gtk::TreeModelColumn<std::string> visible_name;
490 Gtk::TreeModelColumn<std::string> tip;
491 Gtk::TreeModelColumn<std::string> fullpath;
494 RecentSessionModelColumns recent_session_columns;
495 Gtk::TreeView recent_session_display;
496 Glib::RefPtr<Gtk::TreeStore> recent_session_model;
498 ArdourDialog* session_selector_window;
499 Gtk::FileChooserDialog* open_session_selector;
501 void build_session_selector();
502 void redisplay_recent_sessions();
503 void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
505 struct RecentSessionsSorter {
506 bool operator() (std::pair<std::string,std::string> a, std::pair<std::string,std::string> b) const {
507 return cmp_nocase(a.first, b.first) == -1;
511 /* menu bar and associated stuff */
513 Gtk::MenuBar* menu_bar;
514 Gtk::EventBox menu_bar_base;
517 void use_menubar_as_top_menubar ();
518 void build_menu_bar ();
520 Gtk::Label wall_clock_label;
521 gint update_wall_clock ();
523 Gtk::Label disk_space_label;
524 void update_disk_space ();
526 Gtk::Label timecode_format_label;
527 void update_timecode_format ();
529 Gtk::Label cpu_load_label;
530 void update_cpu_load ();
532 Gtk::Label buffer_load_label;
533 void update_buffer_load ();
535 Gtk::Label sample_rate_label;
536 void update_sample_rate (ARDOUR::framecnt_t);
538 Gtk::Label format_label;
539 void update_format ();
541 gint every_second ();
542 gint every_point_one_seconds ();
543 gint every_point_zero_something_seconds ();
545 sigc::connection second_connection;
546 sigc::connection point_one_second_connection;
547 sigc::connection point_zero_something_second_connection;
549 void open_session ();
550 void open_recent_session ();
551 void save_template ();
553 void edit_metadata ();
554 void import_metadata ();
556 void session_add_audio_route (bool, int32_t, int32_t, ARDOUR::TrackMode, ARDOUR::RouteGroup *, uint32_t, std::string const &);
557 void session_add_midi_route (bool, ARDOUR::RouteGroup *, uint32_t, std::string const &, ARDOUR::PluginInfoPtr);
559 void set_transport_sensitivity (bool);
561 void transport_goto_zero ();
562 void transport_goto_start ();
563 void transport_goto_end ();
564 void transport_goto_wallclock ();
565 void transport_stop ();
566 void transport_record (bool roll);
567 void transport_roll ();
568 void transport_play_selection();
569 void transport_play_preroll();
570 void transport_forward (int option);
571 void transport_rewind (int option);
572 void transport_loop ();
573 void toggle_roll (bool with_abort, bool roll_out_of_bounded_mode);
575 bool _session_is_new;
576 void set_session (ARDOUR::Session *);
577 void connect_dependents_to_session (ARDOUR::Session *);
578 void we_have_dependents ();
580 void setup_session_options ();
582 guint32 last_key_press_time;
584 void snapshot_session (bool switch_to_it);
585 void rename_session ();
590 PublicEditor *editor;
591 int create_editor ();
593 Meterbridge *meterbridge;
594 int create_meterbridge ();
595 /* Dialogs that can be created via new<T> */
597 WM::Proxy<SpeakerDialog> speaker_config_window;
598 WM::Proxy<ThemeManager> theme_manager;
599 WM::Proxy<KeyEditor> key_editor;
600 WM::Proxy<RCOptionEditor> rc_option_editor;
601 WM::Proxy<AddRouteDialog> add_route_dialog;
602 WM::Proxy<About> about;
603 WM::Proxy<LocationUIWindow> location_ui;
604 WM::Proxy<RouteParams_UI> route_params;
605 WM::Proxy<EngineControl> audio_midi_setup;
607 /* Windows/Dialogs that require a creator method */
609 WM::ProxyWithConstructor<SessionOptionEditor> session_option_editor;
610 WM::ProxyWithConstructor<AddVideoDialog> add_video_dialog;
611 WM::ProxyWithConstructor<BundleManager> bundle_manager;
612 WM::ProxyWithConstructor<BigClockWindow> big_clock_window;
613 WM::ProxyWithConstructor<GlobalPortMatrixWindow> audio_port_matrix;
614 WM::ProxyWithConstructor<GlobalPortMatrixWindow> midi_port_matrix;
616 /* creator methods */
618 SessionOptionEditor* create_session_option_editor ();
619 BundleManager* create_bundle_manager ();
620 AddVideoDialog* create_add_video_dialog ();
621 BigClockWindow* create_big_clock_window();
622 GlobalPortMatrixWindow* create_global_port_matrix (ARDOUR::DataType);
624 static UIConfiguration *ui_config;
626 SystemExec *video_server_process;
628 void handle_locations_change (ARDOUR::Location*);
630 /* Keyboard Handling */
632 ArdourKeyboard* keyboard;
634 /* Keymap handling */
636 void install_actions ();
638 void toggle_record_enable (uint32_t);
640 uint32_t rec_enabled_streams;
641 void count_recenabled_streams (ARDOUR::Route&);
645 void pop_back_splash (Gtk::Window&);
649 Gtk::MenuItem *cleanup_item;
651 void display_cleanup_results (ARDOUR::CleanupReport& rep, const gchar* list_title, const bool msg_delete);
655 bool have_configure_timeout;
656 ARDOUR::microseconds_t last_configure_time;
657 gint configure_timeout ();
659 ARDOUR::microseconds_t last_peak_grab;
660 ARDOUR::microseconds_t last_shuttle_request;
662 bool have_disk_speed_dialog_displayed;
663 void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
664 void disk_overrun_handler ();
665 void disk_underrun_handler ();
667 void session_format_mismatch (std::string, std::string);
669 void session_dialog (std::string);
670 int pending_state_dialog ();
671 int sr_mismatch_dialog (ARDOUR::framecnt_t, ARDOUR::framecnt_t);
673 Gtk::MenuItem* jack_disconnect_item;
674 Gtk::MenuItem* jack_reconnect_item;
675 Gtk::Menu* jack_bufsize_menu;
677 Glib::RefPtr<Gtk::ActionGroup> common_actions;
679 void editor_realized ();
681 std::vector<std::string> positional_sync_strings;
683 void toggle_send_midi_feedback ();
684 void toggle_use_mmc ();
685 void toggle_send_mmc ();
686 void toggle_send_mtc ();
687 void toggle_send_midi_clock ();
689 void toggle_use_osc ();
691 void parameter_changed (std::string);
692 void session_parameter_changed (std::string);
696 void no_memory_warning ();
697 void check_memory_locking ();
699 bool check_audioengine();
700 void audioengine_setup ();
702 void display_message (const char *prefix, gint prefix_len,
703 Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag,
705 Gtk::Label status_bar_label;
706 bool status_bar_button_press (GdkEventButton*);
707 Gtk::ToggleButton error_log_button;
709 void loading_message (const std::string& msg);
711 PBD::ScopedConnectionList forever_connections;
712 PBD::ScopedConnection halt_connection;
714 void step_edit_status_change (bool);
716 void platform_specific ();
717 void platform_setup ();
719 /* these are used only in response to a platform-specific "ShouldQuit" signal
722 void queue_finish ();
723 void fontconfig_dialog ();
725 int missing_file (ARDOUR::Session*s, std::string str, ARDOUR::DataType type);
726 int ambiguous_file (std::string file, std::string path, std::vector<std::string> hits);
728 bool click_button_clicked (GdkEventButton *);
730 VisibilityGroup _status_bar_visibility;
732 /** A ProcessThread so that we have some thread-local buffers for use by
733 * PluginEqGui::impulse_analysis ().
735 ARDOUR::ProcessThread* _process_thread;
737 void feedback_detected ();
739 ArdourButton midi_panic_button;
742 void successful_graph_sort ();
743 bool _feedback_exists;
745 void resize_text_widgets ();
747 std::string _announce_string;
748 void check_announcements ();
750 int do_audio_midi_setup (uint32_t);
753 #endif /* __ardour_gui_h__ */