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>
61 #include "ardour/ardour.h"
62 #include "ardour/types.h"
63 #include "ardour/utils.h"
64 #include "ardour/session_handle.h"
66 #include "ardour_dialog.h"
67 #include "ardour_button.h"
69 #include "ui_config.h"
70 #include "window_proxy.h"
72 #include "visibility_group.h"
80 class ConnectionEditor;
82 class LocationUIWindow;
87 class SessionOptionEditor;
94 class WindowProxyBase;
95 class GlobalPortMatrixWindow;
103 class ControlProtocolInfo;
112 class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
115 ARDOUR_UI (int *argcp, char **argvp[]);
118 bool run_startup (bool should_be_new, std::string load_template);
124 void launch_manual ();
125 void launch_reference ();
129 void idle_load (const std::string& path);
132 int load_session (const std::string& path, const std::string& snapshot, std::string mix_template = std::string());
134 int build_session (const std::string& path, const std::string& snapshot, ARDOUR::BusProfile&);
135 bool session_is_new() const { return _session_is_new; }
137 ARDOUR::Session* the_session() { return _session; }
139 bool will_create_new_session_automatically() const {
140 return _will_create_new_session_automatically;
143 void set_will_create_new_session_automatically (bool yn) {
144 _will_create_new_session_automatically = yn;
147 int get_session_parameters (bool quit_on_cancel, bool should_be_new = false, std::string load_template = "");
148 int build_session_from_nsd (const std::string& session_name, const std::string& session_path);
149 bool ask_about_loading_existing_session (const std::string& session_path);
151 /// @return true if session was successfully unloaded.
152 int unload_session (bool hide_stuff = false);
153 void close_session();
155 int save_state_canfail (std::string state_name = "", bool switch_to_it = false);
156 void save_state (const std::string & state_name = "", bool switch_to_it = false);
158 static ARDOUR_UI *instance () { return theArdourUI; }
159 static UIConfiguration *config () { return ui_config; }
161 PublicEditor& the_editor(){return *editor;}
162 Mixer_UI* the_mixer() { return mixer; }
164 void toggle_key_editor ();
165 void toggle_location_window ();
166 void toggle_theme_manager ();
167 void toggle_bundle_manager ();
168 void toggle_big_clock_window ();
169 void toggle_speaker_config_window ();
170 void new_midi_tracer_window ();
171 void toggle_route_params_window ();
172 void toggle_editing_space();
173 void toggle_keep_tearoffs();
175 Gtk::Tooltips& tooltips() { return _tooltips; }
177 Gtk::HBox& editor_transport_box() { return _editor_transport_box; }
179 static PublicEditor* _instance;
180 static sigc::signal<void,bool> Blink;
181 static sigc::signal<void> RapidScreenUpdate;
182 static sigc::signal<void> SuperRapidScreenUpdate;
183 /** Emitted frequently with the audible frame, false, and the edit point as
184 * parameters respectively.
186 static sigc::signal<void, framepos_t, bool, framepos_t> Clock;
188 XMLNode* editor_settings() const;
189 XMLNode* mixer_settings () const;
190 XMLNode* keyboard_settings () const;
191 XMLNode* tearoff_settings (const char*) const;
193 void save_ardour_state ();
194 gboolean configure_handler (GdkEventConfigure* conf);
196 void do_transport_locate (framepos_t, bool);
197 void halt_on_xrun_message ();
198 void xrun_handler (framepos_t);
199 void create_xrun_marker (framepos_t);
201 GUIObjectState* gui_object_state;
203 AudioClock* primary_clock;
204 AudioClock* secondary_clock;
206 TimeInfoBox* time_info_box;
208 void store_clock_modes ();
209 void restore_clock_modes ();
210 void reset_main_clocks ();
212 void synchronize_sync_source_and_video_pullup ();
214 void add_route (Gtk::Window* float_window);
216 void session_add_audio_track (
218 int32_t output_channels,
219 ARDOUR::TrackMode mode,
220 ARDOUR::RouteGroup* route_group,
222 std::string const & name_template
225 session_add_audio_route (true, input_channels, output_channels, mode, route_group, how_many, name_template);
228 void session_add_audio_bus (
230 int32_t output_channels,
231 ARDOUR::RouteGroup* route_group,
233 std::string const & name_template
236 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, route_group, how_many, name_template);
239 void session_add_midi_track (
240 ARDOUR::RouteGroup* route_group,
242 std::string const & name_template
245 session_add_midi_route (true, route_group, how_many, name_template);
248 /*void session_add_midi_bus () {
249 session_add_midi_route (false);
252 int create_engine ();
255 gint exit_on_main_window_close (GdkEventAny *);
257 void maximise_editing_space ();
258 void restore_editing_space ();
260 void setup_profile ();
262 void setup_tooltips ();
264 void set_shuttle_fract (double);
266 void add_window_proxy (WindowProxyBase *);
267 void remove_window_proxy (WindowProxyBase *);
269 void get_process_buffers ();
270 void drop_process_buffers ();
273 friend class PublicEditor;
275 void toggle_clocking ();
276 void toggle_auto_play ();
277 void toggle_auto_input ();
278 void toggle_punch ();
279 void unset_dual_punch ();
280 bool ignore_dual_punch;
281 void toggle_punch_in ();
282 void toggle_punch_out ();
283 void show_loop_punch_ruler_and_disallow_hide ();
284 void reenable_hide_loop_punch_ruler_if_appropriate ();
285 void toggle_auto_return ();
286 void toggle_click ();
288 void toggle_session_auto_loop ();
290 void toggle_rc_options_window ();
291 void toggle_session_options_window ();
294 ArdourStartup* _startup;
295 ARDOUR::AudioEngine *engine;
296 Gtk::Tooltips _tooltips;
298 void goto_editor_window ();
299 void goto_mixer_window ();
300 void toggle_mixer_window ();
301 void toggle_mixer_on_top ();
303 int setup_windows ();
304 void setup_transport ();
307 static ARDOUR_UI *theArdourUI;
309 void backend_audio_error (bool we_set_params, Gtk::Window* toplevel = 0);
313 int ask_about_saving_session (const std::vector<std::string>& actions);
315 /* periodic safety backup, to be precise */
316 gint autosave_session();
317 void update_autosave();
318 sigc::connection _autosave_connection;
320 void map_transport_state ();
321 int32_t do_engine_start ();
323 void engine_halted (const char* reason, bool free_reason);
324 void engine_stopped ();
325 void engine_running ();
329 static gint _blink (void *);
331 gint blink_timeout_tag;
333 void start_blinking ();
334 void stop_blinking ();
336 void about_signal_response(int response);
338 Gtk::VBox top_packer;
340 sigc::connection clock_signal_connection;
341 void update_clocks ();
342 void start_clocking ();
343 void stop_clocking ();
345 void manage_window (Gtk::Window&);
347 AudioClock* big_clock;
348 ActionWindowProxy<Gtk::Window>* big_clock_window;
349 int original_big_clock_width;
350 int original_big_clock_height;
351 double original_big_clock_font_size;
353 void big_clock_size_allocate (Gtk::Allocation&);
354 bool idle_big_clock_text_resizer (int width, int height);
355 void big_clock_realized ();
356 bool big_clock_resize_in_progress;
357 int big_clock_height;
358 void big_clock_catch_focus ();
359 void big_clock_reset_aspect_ratio ();
361 void float_big_clock (Gtk::Window* parent);
362 bool main_window_state_event_handler (GdkEventWindowState*, bool window_was_editor);
364 ActionWindowProxy<SpeakerDialog>* speaker_config_window;
366 void update_transport_clocks (framepos_t pos);
367 void record_state_changed ();
369 std::list<MidiTracer*> _midi_tracer_windows;
371 /* Transport Control */
373 void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
374 void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
376 Gtkmm2ext::TearOff* transport_tearoff;
377 Gtk::Frame transport_frame;
378 Gtk::HBox transport_tearoff_hbox;
379 Gtk::HBox _editor_transport_box;
380 Gtk::HBox transport_hbox;
381 Gtk::Fixed transport_base;
382 Gtk::Fixed transport_button_base;
383 Gtk::Frame transport_button_frame;
384 Gtk::HBox transport_button_hbox;
385 Gtk::VBox transport_button_vbox;
386 Gtk::HBox transport_option_button_hbox;
387 Gtk::VBox transport_option_button_vbox;
388 Gtk::HBox transport_clock_hbox;
389 Gtk::VBox transport_clock_vbox;
390 Gtk::HBox primary_clock_hbox;
391 Gtk::HBox secondary_clock_hbox;
393 struct TransportControllable : public PBD::Controllable {
404 TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
405 void set_value (double);
406 double get_value (void) const;
412 boost::shared_ptr<TransportControllable> roll_controllable;
413 boost::shared_ptr<TransportControllable> stop_controllable;
414 boost::shared_ptr<TransportControllable> goto_start_controllable;
415 boost::shared_ptr<TransportControllable> goto_end_controllable;
416 boost::shared_ptr<TransportControllable> auto_loop_controllable;
417 boost::shared_ptr<TransportControllable> play_selection_controllable;
418 boost::shared_ptr<TransportControllable> rec_controllable;
419 boost::shared_ptr<TransportControllable> shuttle_controllable;
420 boost::shared_ptr<TransportControllable> join_play_range_controllable;
422 void set_transport_controllable_state (const XMLNode&);
423 XMLNode& get_transport_controllable_state ();
425 ArdourButton roll_button;
426 ArdourButton stop_button;
427 ArdourButton goto_start_button;
428 ArdourButton goto_end_button;
429 ArdourButton auto_loop_button;
430 ArdourButton play_selection_button;
431 ArdourButton rec_button;
432 ArdourButton join_play_range_button;
434 void toggle_external_sync ();
435 void toggle_time_master ();
436 void toggle_video_sync ();
438 ShuttleControl* shuttle_box;
440 ArdourButton auto_return_button;
441 ArdourButton auto_play_button;
442 ArdourButton auto_input_button;
443 ArdourButton click_button;
444 ArdourButton sync_button;
446 ArdourButton auditioning_alert_button;
447 ArdourButton solo_alert_button;
448 ArdourButton feedback_alert_button;
452 void solo_blink (bool);
453 void sync_blink (bool);
454 void audition_blink (bool);
455 void feedback_blink (bool);
457 void soloing_changed (bool);
458 void auditioning_changed (bool);
459 void _auditioning_changed (bool);
461 bool solo_alert_press (GdkEventButton* ev);
462 bool audition_alert_press (GdkEventButton* ev);
463 bool feedback_alert_press (GdkEventButton *);
465 void big_clock_value_changed ();
466 void primary_clock_value_changed ();
467 void secondary_clock_value_changed ();
469 /* called by Blink signal */
471 void transport_rec_enable_blink (bool onoff);
473 Gtk::Menu* session_popup_menu;
475 struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
476 RecentSessionModelColumns() {
480 Gtk::TreeModelColumn<std::string> visible_name;
481 Gtk::TreeModelColumn<std::string> fullpath;
484 RecentSessionModelColumns recent_session_columns;
485 Gtk::TreeView recent_session_display;
486 Glib::RefPtr<Gtk::TreeStore> recent_session_model;
488 ArdourDialog* session_selector_window;
489 Gtk::FileChooserDialog* open_session_selector;
491 void build_session_selector();
492 void redisplay_recent_sessions();
493 void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
495 struct RecentSessionsSorter {
496 bool operator() (std::pair<std::string,std::string> a, std::pair<std::string,std::string> b) const {
497 return cmp_nocase(a.first, b.first) == -1;
501 /* menu bar and associated stuff */
503 Gtk::MenuBar* menu_bar;
504 Gtk::EventBox menu_bar_base;
507 void use_menubar_as_top_menubar ();
508 void build_menu_bar ();
510 Gtk::Label wall_clock_label;
511 Gtk::EventBox wall_clock_box;
512 gint update_wall_clock ();
514 Gtk::Label disk_space_label;
515 Gtk::EventBox disk_space_box;
516 void update_disk_space ();
518 Gtk::Label cpu_load_label;
519 Gtk::EventBox cpu_load_box;
520 void update_cpu_load ();
522 Gtk::Label buffer_load_label;
523 Gtk::EventBox buffer_load_box;
524 void update_buffer_load ();
526 Gtk::Label sample_rate_label;
527 Gtk::EventBox sample_rate_box;
528 void update_sample_rate (ARDOUR::framecnt_t);
530 Gtk::Label format_label;
531 Gtk::EventBox format_box;
532 void update_format ();
534 gint every_second ();
535 gint every_point_one_seconds ();
536 gint every_point_zero_one_seconds ();
538 sigc::connection second_connection;
539 sigc::connection point_one_second_connection;
540 sigc::connection point_oh_five_second_connection;
541 sigc::connection point_zero_one_second_connection;
543 gint session_menu (GdkEventButton *);
545 bool _will_create_new_session_automatically;
547 void open_session ();
548 void open_recent_session ();
549 void save_template ();
551 void edit_metadata ();
552 void import_metadata ();
554 void session_add_audio_route (bool, int32_t, int32_t, ARDOUR::TrackMode, ARDOUR::RouteGroup *, uint32_t, std::string const &);
555 void session_add_midi_route (bool, ARDOUR::RouteGroup *, uint32_t, std::string const &);
557 void set_transport_sensitivity (bool);
559 void remove_last_capture ();
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_stop_and_forget_capture ();
567 void transport_record (bool roll);
568 void transport_roll ();
569 void transport_play_selection();
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 RouteParams_UI *route_params;
594 int create_route_params ();
596 BundleManager *bundle_manager;
597 void create_bundle_manager ();
599 ActionWindowProxy<LocationUIWindow>* location_ui;
600 int create_location_ui ();
601 void handle_locations_change (ARDOUR::Location*);
603 ActionWindowProxy<GlobalPortMatrixWindow>* _global_port_matrix[ARDOUR::DataType::num_types];
604 void toggle_global_port_matrix (ARDOUR::DataType);
606 static UIConfiguration *ui_config;
607 ThemeManager *theme_manager;
609 /* Key bindings editor */
611 KeyEditor *key_editor;
613 /* RC Options window */
615 RCOptionEditor *rc_option_editor;
617 SessionOptionEditor *session_option_editor;
621 AddRouteDialog *add_route_dialog;
623 /* Keyboard Handling */
625 ArdourKeyboard* keyboard;
627 /* Keymap handling */
629 void install_actions ();
631 void toggle_record_enable (uint32_t);
633 uint32_t rec_enabled_streams;
634 void count_recenabled_streams (ARDOUR::Route&);
638 void pop_back_splash ();
642 Gtk::MenuItem *cleanup_item;
644 void display_cleanup_results (ARDOUR::CleanupReport& rep, const gchar* list_title,
645 const std::string& plural_msg, const std::string& singular_msg);
649 bool have_configure_timeout;
650 ARDOUR::microseconds_t last_configure_time;
651 gint configure_timeout ();
653 ARDOUR::microseconds_t last_peak_grab;
654 ARDOUR::microseconds_t last_shuttle_request;
656 bool have_disk_speed_dialog_displayed;
657 void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
658 void disk_overrun_handler ();
659 void disk_underrun_handler ();
661 void session_dialog (std::string);
662 int pending_state_dialog ();
663 int sr_mismatch_dialog (ARDOUR::framecnt_t, ARDOUR::framecnt_t);
665 void disconnect_from_jack ();
666 void reconnect_to_jack ();
667 void set_jack_buffer_size (ARDOUR::pframes_t);
669 Gtk::MenuItem* jack_disconnect_item;
670 Gtk::MenuItem* jack_reconnect_item;
671 Gtk::Menu* jack_bufsize_menu;
673 Glib::RefPtr<Gtk::ActionGroup> common_actions;
675 void editor_realized ();
677 std::vector<std::string> positional_sync_strings;
679 void toggle_send_midi_feedback ();
680 void toggle_use_mmc ();
681 void toggle_send_mmc ();
682 void toggle_send_mtc ();
683 void toggle_send_midi_clock ();
685 void toggle_use_osc ();
687 void parameter_changed (std::string);
688 void session_parameter_changed (std::string);
692 void no_memory_warning ();
693 void check_memory_locking ();
695 bool check_audioengine();
696 void audioengine_setup ();
698 void display_message (const char *prefix, gint prefix_len,
699 Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag,
701 Gtk::Label status_bar_label;
702 bool status_bar_button_press (GdkEventButton*);
703 Gtk::ToggleButton error_log_button;
705 void loading_message (const std::string& msg);
706 void end_loading_messages ();
708 void toggle_translations ();
710 PBD::ScopedConnectionList forever_connections;
712 void step_edit_status_change (bool);
714 void platform_specific ();
715 void platform_setup ();
717 /* these are used only in response to a platform-specific "ShouldQuit" signal
720 void queue_finish ();
721 void fontconfig_dialog ();
723 std::list<WindowProxyBase*> _window_proxies;
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 ();
748 #endif /* __ardour_gui_h__ */