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"
65 #include "audio_clock.h"
66 #include "ardour_dialog.h"
68 #include "ui_config.h"
75 class ConnectionEditor;
78 class LocationUIWindow;
83 class SessionOptionEditor;
92 class ControlProtocolInfo;
100 extern sigc::signal<void> ColorsChanged;
101 extern sigc::signal<void> DPIReset;
103 class ARDOUR_UI : public Gtkmm2ext::UI
106 ARDOUR_UI (int *argcp, char **argvp[]);
109 bool run_startup (bool should_be_new);
112 bool shown() { return shown_flag; }
120 void idle_load (const Glib::ustring& path);
123 int load_session (const Glib::ustring& path, const Glib::ustring& snapshot, Glib::ustring mix_template = Glib::ustring());
125 int build_session (const Glib::ustring& path, const Glib::ustring& snapshot,
127 uint32_t master_chns,
128 ARDOUR::AutoConnectOption input_connect,
129 ARDOUR::AutoConnectOption output_connect,
132 nframes_t initial_length);
133 bool session_is_new() const { return _session_is_new; }
135 ARDOUR::Session* the_session() { return session; }
137 bool will_create_new_session_automatically() const {
138 return _will_create_new_session_automatically;
141 void set_will_create_new_session_automatically (bool yn) {
142 _will_create_new_session_automatically = yn;
145 int get_session_parameters (bool quit_on_cancel, bool should_be_new = false);
146 void parse_cmdline_path (const Glib::ustring& cmdline_path, Glib::ustring& session_name, Glib::ustring& session_path, bool& existing_session);
147 int load_cmdline_session (const Glib::ustring& session_name, const Glib::ustring& session_path, bool& existing_session);
148 int build_session_from_nsd (const Glib::ustring& session_name, const Glib::ustring& session_path);
149 bool ask_about_loading_existing_session (const Glib::ustring& 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 = "");
156 void save_state (const std::string & state_name = "");
158 static double gain_to_slider_position (ARDOUR::gain_t g);
159 static ARDOUR::gain_t slider_position_to_gain (double pos);
161 static ARDOUR_UI *instance () { return theArdourUI; }
162 static UIConfiguration *config () { return ui_config; }
164 PublicEditor& the_editor(){return *editor;}
165 Mixer_UI* the_mixer() { return mixer; }
167 void toggle_key_editor ();
168 void toggle_location_window ();
169 void toggle_theme_manager ();
170 void toggle_bundle_manager ();
171 void toggle_big_clock_window ();
172 void toggle_route_params_window ();
173 void toggle_editing_space();
175 Gtk::Tooltips& tooltips() { return _tooltips; }
177 static sigc::signal<void,bool> Blink;
178 static sigc::signal<void> RapidScreenUpdate;
179 static sigc::signal<void> SuperRapidScreenUpdate;
180 static sigc::signal<void,nframes_t, bool, nframes_t> Clock;
182 XMLNode* editor_settings() const;
183 XMLNode* mixer_settings () const;
184 XMLNode* keyboard_settings () const;
186 void save_ardour_state ();
187 gboolean configure_handler (GdkEventConfigure* conf);
189 void do_transport_locate (nframes_t position);
190 void halt_on_xrun_message ();
191 void xrun_handler (nframes_t);
192 void create_xrun_marker (nframes_t);
194 AudioClock primary_clock;
195 AudioClock secondary_clock;
196 AudioClock preroll_clock;
197 AudioClock postroll_clock;
199 void store_clock_modes ();
200 void restore_clock_modes ();
201 void reset_main_clocks ();
203 void add_route (Gtk::Window* float_window);
205 void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode, ARDOUR::RouteGroup* route_group, uint32_t how_many) {
206 session_add_audio_route (true, false, input_channels, output_channels, mode, route_group, how_many);
209 void session_add_audio_bus (bool aux, int input_channels, int32_t output_channels, ARDOUR::RouteGroup* route_group, uint32_t how_many) {
210 session_add_audio_route (false, aux, input_channels, output_channels, ARDOUR::Normal, route_group, how_many);
213 void session_add_midi_track (ARDOUR::RouteGroup* route_group, uint32_t how_many) {
214 session_add_midi_route (true, route_group, how_many);
217 /*void session_add_midi_bus () {
218 session_add_midi_route (false);
221 int create_engine ();
224 gint exit_on_main_window_close (GdkEventAny *);
226 void maximise_editing_space ();
227 void restore_editing_space ();
229 void setup_profile ();
232 void set_shuttle_fract (double);
235 friend class PublicEditor;
237 void toggle_clocking ();
238 void toggle_auto_play ();
239 void toggle_auto_input ();
240 void toggle_punch ();
241 void unset_dual_punch ();
242 bool ignore_dual_punch;
243 void toggle_punch_in ();
244 void toggle_punch_out ();
245 void show_loop_punch_ruler_and_disallow_hide ();
246 void reenable_hide_loop_punch_ruler_if_appropriate ();
247 void toggle_auto_return ();
248 void toggle_click ();
250 void toggle_session_auto_loop ();
252 void toggle_rc_options_window ();
253 void toggle_session_options_window ();
256 ArdourStartup* _startup;
257 ARDOUR::AudioEngine *engine;
258 ARDOUR::Session *session;
259 Gtk::Tooltips _tooltips;
261 void goto_editor_window ();
262 void goto_mixer_window ();
263 void toggle_editor_mixer_on_top ();
266 Gtk::ToggleButton preroll_button;
267 Gtk::ToggleButton postroll_button;
269 int setup_windows ();
270 void setup_transport ();
273 static ARDOUR_UI *theArdourUI;
275 void backend_audio_error (bool we_set_params, Gtk::Window* toplevel = 0);
279 int ask_about_saving_session (const std::string & why);
281 /* periodic safety backup, to be precise */
282 gint autosave_session();
283 void update_autosave();
284 sigc::connection _autosave_connection;
286 void map_transport_state ();
287 int32_t do_engine_start ();
289 void engine_halted ();
290 void engine_stopped ();
291 void engine_running ();
295 static gint _blink (void *);
297 gint blink_timeout_tag;
299 void start_blinking ();
300 void stop_blinking ();
302 void about_signal_response(int response);
305 Gtk::VBox top_packer;
307 sigc::connection clock_signal_connection;
308 void update_clocks ();
309 void start_clocking ();
310 void stop_clocking ();
312 void manage_window (Gtk::Window&);
314 AudioClock big_clock;
315 Gtk::Window* big_clock_window;
317 void float_big_clock (Gtk::Window* parent);
318 bool main_window_state_event_handler (GdkEventWindowState*, bool window_was_editor);
320 void update_transport_clocks (nframes_t pos);
321 void record_state_changed ();
323 /* Transport Control */
325 void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
326 void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
328 Gtkmm2ext::TearOff* transport_tearoff;
329 Gtk::Frame transport_frame;
330 Gtk::HBox transport_tearoff_hbox;
331 Gtk::HBox transport_hbox;
332 Gtk::Fixed transport_base;
333 Gtk::Fixed transport_button_base;
334 Gtk::Frame transport_button_frame;
335 Gtk::HBox transport_button_hbox;
336 Gtk::VBox transport_button_vbox;
337 Gtk::HBox transport_option_button_hbox;
338 Gtk::VBox transport_option_button_vbox;
339 Gtk::HBox transport_clock_hbox;
340 Gtk::VBox transport_clock_vbox;
341 Gtk::HBox primary_clock_hbox;
342 Gtk::HBox secondary_clock_hbox;
345 struct TransportControllable : public PBD::Controllable {
358 TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
359 void set_value (float);
360 float get_value (void) const;
362 void set_id (const std::string&);
368 boost::shared_ptr<TransportControllable> roll_controllable;
369 boost::shared_ptr<TransportControllable> stop_controllable;
370 boost::shared_ptr<TransportControllable> goto_start_controllable;
371 boost::shared_ptr<TransportControllable> goto_end_controllable;
372 boost::shared_ptr<TransportControllable> auto_loop_controllable;
373 boost::shared_ptr<TransportControllable> play_selection_controllable;
374 boost::shared_ptr<TransportControllable> rec_controllable;
375 boost::shared_ptr<TransportControllable> shuttle_controllable;
376 BindingProxy shuttle_controller_binding_proxy;
378 void set_transport_controllable_state (const XMLNode&);
379 XMLNode& get_transport_controllable_state ();
381 BindableButton roll_button;
382 BindableButton stop_button;
383 BindableButton goto_start_button;
384 BindableButton goto_end_button;
385 BindableButton auto_loop_button;
386 BindableButton play_selection_button;
387 BindableButton rec_button;
389 void toggle_external_sync ();
390 void toggle_time_master ();
391 void toggle_video_sync ();
393 Gtk::DrawingArea shuttle_box;
394 Gtk::EventBox speed_display_box;
395 Gtk::Label speed_display_label;
396 Gtk::Button shuttle_units_button;
397 Gtk::ComboBoxText shuttle_style_button;
398 Gtk::Menu* shuttle_unit_menu;
399 Gtk::Menu* shuttle_style_menu;
400 float shuttle_max_speed;
401 Gtk::Menu* shuttle_context_menu;
403 void build_shuttle_context_menu ();
404 void show_shuttle_context_menu ();
405 void shuttle_style_changed();
406 void shuttle_unit_clicked ();
407 void set_shuttle_max_speed (float);
408 void update_speed_display ();
409 float last_speed_displayed;
411 gint shuttle_box_button_press (GdkEventButton*);
412 gint shuttle_box_button_release (GdkEventButton*);
413 gint shuttle_box_scroll (GdkEventScroll*);
414 gint shuttle_box_motion (GdkEventMotion*);
415 gint shuttle_box_expose (GdkEventExpose*);
416 gint mouse_shuttle (double x, bool force);
417 void use_shuttle_fract (bool force);
419 bool shuttle_grabbed;
420 double shuttle_fract;
422 Gtkmm2ext::StatefulToggleButton punch_in_button;
423 Gtkmm2ext::StatefulToggleButton punch_out_button;
424 Gtkmm2ext::StatefulToggleButton auto_return_button;
425 Gtkmm2ext::StatefulToggleButton auto_play_button;
426 Gtkmm2ext::StatefulToggleButton auto_input_button;
427 Gtkmm2ext::StatefulToggleButton click_button;
428 Gtkmm2ext::StatefulToggleButton time_master_button;
429 Gtkmm2ext::StatefulToggleButton sync_button;
431 Gtk::ToggleButton auditioning_alert_button;
432 Gtk::ToggleButton solo_alert_button;
436 void solo_blink (bool);
437 void sync_blink (bool);
438 void audition_blink (bool);
440 void soloing_changed (bool);
441 void auditioning_changed (bool);
442 void _auditioning_changed (bool);
444 void solo_alert_toggle ();
445 void audition_alert_toggle ();
447 void big_clock_value_changed ();
448 void primary_clock_value_changed ();
449 void secondary_clock_value_changed ();
451 /* called by Blink signal */
453 void transport_rec_enable_blink (bool onoff);
455 Gtk::Menu* session_popup_menu;
457 struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
458 RecentSessionModelColumns() {
462 Gtk::TreeModelColumn<Glib::ustring> visible_name;
463 Gtk::TreeModelColumn<Glib::ustring> fullpath;
466 RecentSessionModelColumns recent_session_columns;
467 Gtk::TreeView recent_session_display;
468 Glib::RefPtr<Gtk::TreeStore> recent_session_model;
470 ArdourDialog* session_selector_window;
471 Gtk::FileChooserDialog* open_session_selector;
473 void build_session_selector();
474 void redisplay_recent_sessions();
475 void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
477 struct RecentSessionsSorter {
478 bool operator() (std::pair<std::string,std::string> a, std::pair<std::string,std::string> b) const {
479 return cmp_nocase(a.first, b.first) == -1;
483 /* menu bar and associated stuff */
485 Gtk::MenuBar* menu_bar;
486 Gtk::EventBox menu_bar_base;
489 void use_menubar_as_top_menubar ();
490 void build_menu_bar ();
492 Gtk::Label wall_clock_label;
493 Gtk::EventBox wall_clock_box;
494 gint update_wall_clock ();
496 Gtk::Label disk_space_label;
497 Gtk::EventBox disk_space_box;
498 void update_disk_space ();
500 Gtk::Label cpu_load_label;
501 Gtk::EventBox cpu_load_box;
502 void update_cpu_load ();
504 Gtk::Label buffer_load_label;
505 Gtk::EventBox buffer_load_box;
506 void update_buffer_load ();
508 Gtk::Label sample_rate_label;
509 Gtk::EventBox sample_rate_box;
510 void update_sample_rate (nframes_t);
512 gint every_second ();
513 gint every_point_one_seconds ();
514 gint every_point_zero_one_seconds ();
516 sigc::connection second_connection;
517 sigc::connection point_one_second_connection;
518 sigc::connection point_oh_five_second_connection;
519 sigc::connection point_zero_one_second_connection;
521 gint session_menu (GdkEventButton *);
523 bool _will_create_new_session_automatically;
525 void open_session ();
526 void open_recent_session ();
527 void save_template ();
529 void edit_metadata ();
530 void import_metadata ();
532 void session_add_audio_route (bool disk, bool aux, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode, ARDOUR::RouteGroup *, uint32_t how_many);
533 void session_add_midi_route (bool disk, ARDOUR::RouteGroup *, uint32_t how_many);
535 void set_transport_sensitivity (bool);
537 void remove_last_capture ();
539 void transport_goto_zero ();
540 void transport_goto_start ();
541 void transport_goto_end ();
542 void transport_goto_wallclock ();
543 void transport_stop ();
544 void transport_stop_and_forget_capture ();
545 void transport_record (bool roll);
546 void transport_roll ();
547 void transport_play_selection();
548 void transport_forward (int option);
549 void transport_rewind (int option);
550 void transport_loop ();
551 void toggle_roll (bool with_abort, bool roll_out_of_bounded_mode);
553 bool _session_is_new;
554 void connect_to_session (ARDOUR::Session *);
555 void connect_dependents_to_session (ARDOUR::Session *);
556 void we_have_dependents ();
558 void setup_session_options ();
560 guint32 last_key_press_time;
562 void snapshot_session ();
567 PublicEditor *editor;
568 int create_editor ();
570 RouteParams_UI *route_params;
571 int create_route_params ();
573 BundleManager *bundle_manager;
574 void create_bundle_manager ();
576 LocationUIWindow *location_ui;
577 int create_location_ui ();
578 void handle_locations_change (ARDOUR::Location*);
580 static UIConfiguration *ui_config;
581 ThemeManager *theme_manager;
583 /* Key bindings editor */
585 KeyEditor *key_editor;
587 /* RC Options window */
589 RCOptionEditor *rc_option_editor;
591 SessionOptionEditor *session_option_editor;
595 AddRouteDialog *add_route_dialog;
597 /* Keyboard Handling */
601 /* Keymap handling */
603 void install_actions ();
605 void toggle_record_enable (uint32_t);
607 uint32_t rec_enabled_streams;
608 void count_recenabled_streams (ARDOUR::Route&);
612 void pop_back_splash ();
617 Gtk::MenuItem *cleanup_item;
619 void display_cleanup_results (ARDOUR::CleanupReport& rep, const gchar* list_title,
620 const std::string& plural_msg, const std::string& singular_msg);
624 bool have_configure_timeout;
625 ARDOUR::microseconds_t last_configure_time;
626 gint configure_timeout ();
628 ARDOUR::microseconds_t last_peak_grab;
629 ARDOUR::microseconds_t last_shuttle_request;
631 struct DiskBufferStat {
636 DiskBufferStat (time_t w, uint32_t c, uint32_t p)
637 : when (w), capture (c), playback (p) {}
640 std::list<DiskBufferStat> disk_buffer_stats;
641 void push_buffer_stats (uint32_t, uint32_t);
642 void write_buffer_stats ();
644 bool have_disk_speed_dialog_displayed;
645 void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
646 void disk_overrun_handler ();
647 void disk_underrun_handler ();
649 void session_dialog (std::string);
650 int pending_state_dialog ();
651 int sr_mismatch_dialog (nframes_t, nframes_t);
653 void disconnect_from_jack ();
654 void reconnect_to_jack ();
655 void set_jack_buffer_size (nframes_t);
657 Gtk::MenuItem* jack_disconnect_item;
658 Gtk::MenuItem* jack_reconnect_item;
659 Gtk::Menu* jack_bufsize_menu;
661 Glib::RefPtr<Gtk::ActionGroup> common_actions;
663 void editor_realized ();
665 std::vector<std::string> positional_sync_strings;
667 void toggle_send_midi_feedback ();
668 void toggle_use_mmc ();
669 void toggle_send_mmc ();
670 void toggle_send_mtc ();
671 void toggle_send_midi_clock ();
673 void toggle_use_osc ();
675 void parameter_changed (std::string);
679 void no_memory_warning ();
680 void check_memory_locking ();
682 bool check_audioengine();
683 void audioengine_setup ();
685 void display_message (const char *prefix, gint prefix_len,
686 Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag,
688 Gtk::Label status_bar_label;
689 Gtk::ToggleButton error_log_button;
691 void loading_message (const std::string& msg);
692 void end_loading_messages ();
694 void platform_specific ();
695 void platform_setup ();
696 void fontconfig_dialog ();
699 #endif /* __ardour_gui_h__ */