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"
68 #include "ui_config.h"
69 #include "window_proxy.h"
77 class ConnectionEditor;
79 class LocationUIWindow;
84 class SessionOptionEditor;
91 class WindowProxyBase;
92 class GlobalPortMatrixWindow;
99 class ControlProtocolInfo;
107 class ARDOUR_UI : public Gtkmm2ext::UI, public ARDOUR::SessionHandlePtr
110 ARDOUR_UI (int *argcp, char **argvp[]);
113 bool run_startup (bool should_be_new, std::string load_template);
119 void launch_manual ();
120 void launch_reference ();
124 void idle_load (const std::string& path);
127 int load_session (const std::string& path, const std::string& snapshot, std::string mix_template = std::string());
129 int build_session (const std::string& path, const std::string& snapshot, ARDOUR::BusProfile&);
130 bool session_is_new() const { return _session_is_new; }
132 ARDOUR::Session* the_session() { return _session; }
134 bool will_create_new_session_automatically() const {
135 return _will_create_new_session_automatically;
138 void set_will_create_new_session_automatically (bool yn) {
139 _will_create_new_session_automatically = yn;
142 int get_session_parameters (bool quit_on_cancel, bool should_be_new = false, std::string load_template = "");
143 int build_session_from_nsd (const std::string& session_name, const std::string& session_path);
144 bool ask_about_loading_existing_session (const std::string& session_path);
146 /// @return true if session was successfully unloaded.
147 int unload_session (bool hide_stuff = false);
148 void close_session();
150 int save_state_canfail (std::string state_name = "", bool switch_to_it = false);
151 void save_state (const std::string & state_name = "", bool switch_to_it = false);
153 static ARDOUR_UI *instance () { return theArdourUI; }
154 static UIConfiguration *config () { return ui_config; }
156 PublicEditor& the_editor(){return *editor;}
157 Mixer_UI* the_mixer() { return mixer; }
159 void toggle_key_editor ();
160 void toggle_location_window ();
161 void toggle_theme_manager ();
162 void toggle_bundle_manager ();
163 void toggle_big_clock_window ();
164 void toggle_speaker_config_window ();
165 void new_midi_tracer_window ();
166 void toggle_route_params_window ();
167 void toggle_editing_space();
168 void toggle_keep_tearoffs();
170 Gtk::Tooltips& tooltips() { return _tooltips; }
172 Gtk::HBox& editor_transport_box() { return _editor_transport_box; }
174 static PublicEditor* _instance;
175 static sigc::signal<void,bool> Blink;
176 static sigc::signal<void> RapidScreenUpdate;
177 static sigc::signal<void> SuperRapidScreenUpdate;
178 /** Emitted frequently with the audible frame, false, and the edit point as
179 * parameters respectively.
181 static sigc::signal<void, framepos_t, bool, framepos_t> Clock;
183 XMLNode* editor_settings() const;
184 XMLNode* mixer_settings () const;
185 XMLNode* keyboard_settings () const;
186 XMLNode* tearoff_settings (const char*) const;
188 void save_ardour_state ();
189 gboolean configure_handler (GdkEventConfigure* conf);
191 void do_transport_locate (framepos_t, bool);
192 void halt_on_xrun_message ();
193 void xrun_handler (framepos_t);
194 void create_xrun_marker (framepos_t);
196 AudioClock* primary_clock;
197 AudioClock* secondary_clock;
198 AudioClock* preroll_clock;
199 AudioClock* postroll_clock;
201 TimeInfoBox* time_info_box;
203 void store_clock_modes ();
204 void restore_clock_modes ();
205 void reset_main_clocks ();
207 void synchronize_sync_source_and_video_pullup ();
209 void add_route (Gtk::Window* float_window);
211 void session_add_audio_track (
213 int32_t output_channels,
214 ARDOUR::TrackMode mode,
215 ARDOUR::RouteGroup* route_group,
217 std::string const & name_template
220 session_add_audio_route (true, input_channels, output_channels, mode, route_group, how_many, name_template);
223 void session_add_audio_bus (
225 int32_t output_channels,
226 ARDOUR::RouteGroup* route_group,
228 std::string const & name_template
231 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, route_group, how_many, name_template);
234 void session_add_midi_track (
235 ARDOUR::RouteGroup* route_group,
237 std::string const & name_template
240 session_add_midi_route (true, route_group, how_many, name_template);
243 /*void session_add_midi_bus () {
244 session_add_midi_route (false);
247 int create_engine ();
250 gint exit_on_main_window_close (GdkEventAny *);
252 void maximise_editing_space ();
253 void restore_editing_space ();
255 void setup_profile ();
257 void setup_tooltips ();
259 void set_shuttle_fract (double);
261 void add_window_proxy (WindowProxyBase *);
262 void remove_window_proxy (WindowProxyBase *);
265 friend class PublicEditor;
267 void toggle_clocking ();
268 void toggle_auto_play ();
269 void toggle_auto_input ();
270 void toggle_punch ();
271 void unset_dual_punch ();
272 bool ignore_dual_punch;
273 void toggle_punch_in ();
274 void toggle_punch_out ();
275 void show_loop_punch_ruler_and_disallow_hide ();
276 void reenable_hide_loop_punch_ruler_if_appropriate ();
277 void toggle_auto_return ();
278 void toggle_click ();
280 void toggle_session_auto_loop ();
282 void toggle_rc_options_window ();
283 void toggle_session_options_window ();
286 ArdourStartup* _startup;
287 ARDOUR::AudioEngine *engine;
288 Gtk::Tooltips _tooltips;
290 void goto_editor_window ();
291 void goto_mixer_window ();
292 void toggle_mixer_window ();
293 void toggle_mixer_on_top ();
295 Gtk::ToggleButton preroll_button;
296 Gtk::ToggleButton postroll_button;
298 int setup_windows ();
299 void setup_transport ();
302 static ARDOUR_UI *theArdourUI;
304 void backend_audio_error (bool we_set_params, Gtk::Window* toplevel = 0);
308 int ask_about_saving_session (const std::vector<std::string>& actions);
310 /* periodic safety backup, to be precise */
311 gint autosave_session();
312 void update_autosave();
313 sigc::connection _autosave_connection;
315 void map_transport_state ();
316 int32_t do_engine_start ();
318 void engine_halted (const char* reason, bool free_reason);
319 void engine_stopped ();
320 void engine_running ();
324 static gint _blink (void *);
326 gint blink_timeout_tag;
328 void start_blinking ();
329 void stop_blinking ();
331 void about_signal_response(int response);
333 Gtk::VBox top_packer;
335 sigc::connection clock_signal_connection;
336 void update_clocks ();
337 void start_clocking ();
338 void stop_clocking ();
340 void manage_window (Gtk::Window&);
342 AudioClock* big_clock;
343 ActionWindowProxy<Gtk::Window>* big_clock_window;
344 int original_big_clock_width;
345 int original_big_clock_height;
346 double original_big_clock_font_size;
348 void big_clock_size_allocate (Gtk::Allocation&);
349 bool idle_big_clock_text_resizer (int width, int height);
350 void big_clock_realized ();
351 bool big_clock_resize_in_progress;
352 int big_clock_height;
354 void float_big_clock (Gtk::Window* parent);
355 bool main_window_state_event_handler (GdkEventWindowState*, bool window_was_editor);
357 ActionWindowProxy<SpeakerDialog>* speaker_config_window;
359 void update_transport_clocks (framepos_t pos);
360 void record_state_changed ();
362 std::list<MidiTracer*> _midi_tracer_windows;
364 /* Transport Control */
366 void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
367 void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
369 Gtkmm2ext::TearOff* transport_tearoff;
370 Gtk::Frame transport_frame;
371 Gtk::HBox transport_tearoff_hbox;
372 Gtk::HBox _editor_transport_box;
373 Gtk::HBox transport_hbox;
374 Gtk::Fixed transport_base;
375 Gtk::Fixed transport_button_base;
376 Gtk::Frame transport_button_frame;
377 Gtk::HBox transport_button_hbox;
378 Gtk::VBox transport_button_vbox;
379 Gtk::HBox transport_option_button_hbox;
380 Gtk::VBox transport_option_button_vbox;
381 Gtk::HBox transport_clock_hbox;
382 Gtk::VBox transport_clock_vbox;
383 Gtk::HBox primary_clock_hbox;
384 Gtk::HBox secondary_clock_hbox;
386 struct TransportControllable : public PBD::Controllable {
397 TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
398 void set_value (double);
399 double get_value (void) const;
401 void set_id (const std::string&);
407 boost::shared_ptr<TransportControllable> roll_controllable;
408 boost::shared_ptr<TransportControllable> stop_controllable;
409 boost::shared_ptr<TransportControllable> goto_start_controllable;
410 boost::shared_ptr<TransportControllable> goto_end_controllable;
411 boost::shared_ptr<TransportControllable> auto_loop_controllable;
412 boost::shared_ptr<TransportControllable> play_selection_controllable;
413 boost::shared_ptr<TransportControllable> rec_controllable;
414 boost::shared_ptr<TransportControllable> shuttle_controllable;
415 boost::shared_ptr<TransportControllable> join_play_range_controllable;
417 void set_transport_controllable_state (const XMLNode&);
418 XMLNode& get_transport_controllable_state ();
420 BindableButton roll_button;
421 BindableButton stop_button;
422 BindableButton goto_start_button;
423 BindableButton goto_end_button;
424 BindableButton auto_loop_button;
425 BindableButton play_selection_button;
426 BindableButton rec_button;
427 BindableToggleButton join_play_range_button;
429 void toggle_external_sync ();
430 void toggle_time_master ();
431 void toggle_video_sync ();
433 ShuttleControl* shuttle_box;
435 Gtkmm2ext::StatefulToggleButton auto_return_button;
436 Gtkmm2ext::StatefulToggleButton auto_play_button;
437 Gtkmm2ext::StatefulToggleButton auto_input_button;
438 Gtkmm2ext::StatefulToggleButton click_button;
439 Gtkmm2ext::StatefulToggleButton time_master_button;
440 Gtkmm2ext::StatefulToggleButton sync_button;
442 Gtk::ToggleButton auditioning_alert_button;
443 Gtk::ToggleButton solo_alert_button;
447 void solo_blink (bool);
448 void sync_blink (bool);
449 void audition_blink (bool);
451 void soloing_changed (bool);
452 void auditioning_changed (bool);
453 void _auditioning_changed (bool);
455 bool solo_alert_press (GdkEventButton* ev);
456 bool audition_alert_press (GdkEventButton* ev);
458 void big_clock_value_changed ();
459 void primary_clock_value_changed ();
460 void secondary_clock_value_changed ();
462 /* called by Blink signal */
464 void transport_rec_enable_blink (bool onoff);
466 Gtk::Menu* session_popup_menu;
468 struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
469 RecentSessionModelColumns() {
473 Gtk::TreeModelColumn<std::string> visible_name;
474 Gtk::TreeModelColumn<std::string> fullpath;
477 RecentSessionModelColumns recent_session_columns;
478 Gtk::TreeView recent_session_display;
479 Glib::RefPtr<Gtk::TreeStore> recent_session_model;
481 ArdourDialog* session_selector_window;
482 Gtk::FileChooserDialog* open_session_selector;
484 void build_session_selector();
485 void redisplay_recent_sessions();
486 void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
488 struct RecentSessionsSorter {
489 bool operator() (std::pair<std::string,std::string> a, std::pair<std::string,std::string> b) const {
490 return cmp_nocase(a.first, b.first) == -1;
494 /* menu bar and associated stuff */
496 Gtk::MenuBar* menu_bar;
497 Gtk::EventBox menu_bar_base;
500 void use_menubar_as_top_menubar ();
501 void build_menu_bar ();
503 Gtk::Label wall_clock_label;
504 Gtk::EventBox wall_clock_box;
505 gint update_wall_clock ();
507 Gtk::Label disk_space_label;
508 Gtk::EventBox disk_space_box;
509 void update_disk_space ();
511 Gtk::Label cpu_load_label;
512 Gtk::EventBox cpu_load_box;
513 void update_cpu_load ();
515 Gtk::Label buffer_load_label;
516 Gtk::EventBox buffer_load_box;
517 void update_buffer_load ();
519 Gtk::Label sample_rate_label;
520 Gtk::EventBox sample_rate_box;
521 void update_sample_rate (ARDOUR::framecnt_t);
523 Gtk::Label format_label;
524 Gtk::EventBox format_box;
525 void update_format ();
527 gint every_second ();
528 gint every_point_one_seconds ();
529 gint every_point_zero_one_seconds ();
531 sigc::connection second_connection;
532 sigc::connection point_one_second_connection;
533 sigc::connection point_oh_five_second_connection;
534 sigc::connection point_zero_one_second_connection;
536 gint session_menu (GdkEventButton *);
538 bool _will_create_new_session_automatically;
540 void open_session ();
541 void open_recent_session ();
542 void save_template ();
544 void edit_metadata ();
545 void import_metadata ();
547 void session_add_audio_route (bool, int32_t, int32_t, ARDOUR::TrackMode, ARDOUR::RouteGroup *, uint32_t, std::string const &);
548 void session_add_midi_route (bool, ARDOUR::RouteGroup *, uint32_t, std::string const &);
550 void set_transport_sensitivity (bool);
552 void remove_last_capture ();
554 void transport_goto_zero ();
555 void transport_goto_start ();
556 void transport_goto_end ();
557 void transport_goto_wallclock ();
558 void transport_stop ();
559 void transport_stop_and_forget_capture ();
560 void transport_record (bool roll);
561 void transport_roll ();
562 void transport_play_selection();
563 void transport_forward (int option);
564 void transport_rewind (int option);
565 void transport_loop ();
566 void toggle_roll (bool with_abort, bool roll_out_of_bounded_mode);
568 bool _session_is_new;
569 void set_session (ARDOUR::Session *);
570 void connect_dependents_to_session (ARDOUR::Session *);
571 void we_have_dependents ();
573 void setup_session_options ();
575 guint32 last_key_press_time;
577 void snapshot_session (bool switch_to_it);
582 PublicEditor *editor;
583 int create_editor ();
585 RouteParams_UI *route_params;
586 int create_route_params ();
588 BundleManager *bundle_manager;
589 void create_bundle_manager ();
591 ActionWindowProxy<LocationUIWindow>* location_ui;
592 int create_location_ui ();
593 void handle_locations_change (ARDOUR::Location*);
595 ActionWindowProxy<GlobalPortMatrixWindow>* _global_port_matrix[ARDOUR::DataType::num_types];
596 void toggle_global_port_matrix (ARDOUR::DataType);
598 static UIConfiguration *ui_config;
599 ThemeManager *theme_manager;
601 /* Key bindings editor */
603 KeyEditor *key_editor;
605 /* RC Options window */
607 RCOptionEditor *rc_option_editor;
609 SessionOptionEditor *session_option_editor;
613 AddRouteDialog *add_route_dialog;
615 /* Keyboard Handling */
617 ArdourKeyboard* keyboard;
619 /* Keymap handling */
621 void install_actions ();
623 void toggle_record_enable (uint32_t);
625 uint32_t rec_enabled_streams;
626 void count_recenabled_streams (ARDOUR::Route&);
630 void pop_back_splash ();
634 Gtk::MenuItem *cleanup_item;
636 void display_cleanup_results (ARDOUR::CleanupReport& rep, const gchar* list_title,
637 const std::string& plural_msg, const std::string& singular_msg);
641 bool have_configure_timeout;
642 ARDOUR::microseconds_t last_configure_time;
643 gint configure_timeout ();
645 ARDOUR::microseconds_t last_peak_grab;
646 ARDOUR::microseconds_t last_shuttle_request;
648 bool have_disk_speed_dialog_displayed;
649 void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
650 void disk_overrun_handler ();
651 void disk_underrun_handler ();
653 void session_dialog (std::string);
654 int pending_state_dialog ();
655 int sr_mismatch_dialog (ARDOUR::framecnt_t, ARDOUR::framecnt_t);
657 void disconnect_from_jack ();
658 void reconnect_to_jack ();
659 void set_jack_buffer_size (ARDOUR::pframes_t);
661 Gtk::MenuItem* jack_disconnect_item;
662 Gtk::MenuItem* jack_reconnect_item;
663 Gtk::Menu* jack_bufsize_menu;
665 Glib::RefPtr<Gtk::ActionGroup> common_actions;
667 void editor_realized ();
669 std::vector<std::string> positional_sync_strings;
671 void toggle_send_midi_feedback ();
672 void toggle_use_mmc ();
673 void toggle_send_mmc ();
674 void toggle_send_mtc ();
675 void toggle_send_midi_clock ();
677 void toggle_use_osc ();
679 void parameter_changed (std::string);
680 void session_parameter_changed (std::string);
684 void no_memory_warning ();
685 void check_memory_locking ();
687 bool check_audioengine();
688 void audioengine_setup ();
690 void display_message (const char *prefix, gint prefix_len,
691 Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag,
693 Gtk::Label status_bar_label;
694 bool status_bar_button_press (GdkEventButton*);
695 Gtk::ToggleButton error_log_button;
697 void loading_message (const std::string& msg);
698 void end_loading_messages ();
700 void toggle_translations ();
702 PBD::ScopedConnectionList forever_connections;
704 void step_edit_status_change (bool);
706 /* these are used only in response to a platform-specific "ShouldQuit" signal
709 void queue_finish ();
711 std::list<WindowProxyBase*> _window_proxies;
713 int missing_file (ARDOUR::Session*s, std::string str, ARDOUR::DataType type);
714 int ambiguous_file (std::string file, std::string path, std::vector<std::string> hits);
716 bool click_button_clicked (GdkEventButton *);
719 #endif /* __ardour_gui_h__ */